Merge pull request #563 from cloudinary/change-analytics-algo-letter

change algo letter in analytics

Author: lbendavid-cloudinary

__TESTS__/unit/analytics/analytics.browser.test.ts

@@ -14,10 +14,10 @@ describe('Add analytics to a URL from the browser', () => {
       }
     });
 
-    // ATAAB{NODE_VERSION}0
-    // ATAAB{AA}0 -> we expect nodeVersion to be 0.0.0 in browser (Since it's missing)
-    // expect ATAABAA0
-    expect(url).toContain('sample?_a=ATAABAA0'); // we shouldn't have a query param at all
+    // BATAAB{NODE_VERSION}0
+    // BATAAB{AA}0 -> we expect nodeVersion to be 0.0.0 in browser (Since it's missing)
+    // expect BATAABAA0
+    expect(url).toContain('sample?_a=BATAABAA0'); // we shouldn't have a query param at all
   });
 
   it('Uses default techVersion 0.0.0 when in browser for image with file extension', () => {
@@ -28,10 +28,10 @@ describe('Add analytics to a URL from the browser', () => {
       }
     });
 
-    // ATAAB{NODE_VERSION}0
-    // ATAAB{AA}0 -> we expect nodeVersion to be 0.0.0 in browser (Since it's missing)
-    // expect ATAABAA0
-    expect(url).toContain('sample.jpg?_a=ATAABAA0'); // we shouldn't have a query param at all
+    // BATAAB{NODE_VERSION}0
+    // BATAAB{AA}0 -> we expect nodeVersion to be 0.0.0 in browser (Since it's missing)
+    // expect BATAABAA0
+    expect(url).toContain('sample.jpg?_a=BATAABAA0'); // we shouldn't have a query param at all
   });
 
   it('Uses default techVersion 0.0.0 when in browser for video', () => {
@@ -42,10 +42,10 @@ describe('Add analytics to a URL from the browser', () => {
       }
     });
 
-    // ATAAB{NODE_VERSION}0
-    // ATAAB{AA}0 -> we expect nodeVersion to be 0.0.0 in browser (Since it's missing)
-    // expect ATAABAA0
-    expect(url).toContain('sample?_a=ATAABAA0'); // we shouldn't have a query param at all
+    // BATAAB{NODE_VERSION}0
+    // BATAAB{AA}0 -> we expect nodeVersion to be 0.0.0 in browser (Since it's missing)
+    // expect BATAABAA0
+    expect(url).toContain('sample?_a=BATAABAA0'); // we shouldn't have a query param at all
   });
 
 
@@ -57,9 +57,9 @@ describe('Add analytics to a URL from the browser', () => {
       }
     });
 
-    // ATAAB{NODE_VERSION}0
-    // ATAAB{AA}0 -> we expect nodeVersion to be 0.0.0 in browser (Since it's missing)
-    // expect ATAABAA0
-    expect(url).toContain('sample.webm?_a=ATAABAA0'); // we shouldn't have a query param at all
+    // BATAAB{NODE_VERSION}0
+    // BATAAB{AA}0 -> we expect nodeVersion to be 0.0.0 in browser (Since it's missing)
+    // expect BATAABAA0
+    expect(url).toContain('sample.webm?_a=BATAABAA0'); // we shouldn't have a query param at all
   });
 });

__TESTS__/unit/analytics/analytics.node.test.ts

@@ -43,7 +43,7 @@ describe('Add analytics to a regular URL', () => {
         techVersion: '12.0.0',
         accessibility: true
       }
-    })).toContain('?_a=AZAlhAMD');
+    })).toContain('?_a=BAZAlhAMD');
   });
 
   it('Test lazyload feature value', () => {
@@ -59,7 +59,7 @@ describe('Add analytics to a regular URL', () => {
         techVersion: '12.0.0',
         lazyload: true
       }
-    })).toContain('?_a=AZAlhAMC');
+    })).toContain('?_a=BAZAlhAMC');
   });
 
   it('Test responsive feature value', () => {
@@ -75,7 +75,7 @@ describe('Add analytics to a regular URL', () => {
         techVersion: '12.0.0',
         responsive: true
       }
-    })).toContain('?_a=AZAlhAMA');
+    })).toContain('?_a=BAZAlhAMA');
   });
 
   it('Test placeholder feature value', () => {
@@ -91,7 +91,19 @@ describe('Add analytics to a regular URL', () => {
         techVersion: '12.0.0',
         placeholder: true
       }
-    })).toContain('?_a=AZAlhAMB');
+    })).toContain('?_a=BAZAlhAMB');
+  });
+
+  it('Test product letter', () => {
+    const cldImage = createNewImageWithAnalytics('sample');
+    expect(cldImage.toURL({
+      trackedAnalytics: {
+        sdkCode: 'Z',
+        sdkSemver: '1.24.0',
+        techVersion: '12.0.0',
+        product: 'B'
+      }
+    })).toContain('?_a=BBZAlhAM0');
   });
 
   it('Can be turned off', () => {

__TESTS__/unit/url/url.test.ts

@@ -109,6 +109,6 @@ describe('Tests for URL configuration', () => {
       sdkSemver: '1.0.0'
     };
     const url = image.toURL({trackedAnalytics: analyticsOptions});
-    expect(url).toEqual(`https://res.cloudinary.com/demo/image/upload/sample?_i=abcde&_a=ATAABAQ0`);
+    expect(url).toEqual(`https://res.cloudinary.com/demo/image/upload/sample?_i=abcde&_a=BATAABAQ0`);
   });
 });

src/sdkAnalytics/getAnalyticsOptions.ts

@@ -12,7 +12,8 @@ export function getAnalyticsOptions(options: ITrackedPropertiesThroughAnalytics)
     sdkSemver: options.sdkSemver,
     techVersion: options.techVersion,
     sdkCode: options.sdkCode,
-    feature: '0'
+    product: options.product,
+    feature: '0',
   };
 
   if (options.accessibility) {

src/sdkAnalytics/getSDKAnalyticsSignature.ts

@@ -30,6 +30,7 @@ function ensureShapeOfTrackedProperties(trackedAnalytics?: Partial<ITrackedPrope
     techVersion: getNodeVersion(),
     sdkCode: 'T', // Base code
     sdkSemver : packageVersion.split('-')[0], // remove -beta, -alpha or other tagged versions from the version string
+    product: 'A',
     responsive: false,
     placeholder: false,
     lazyload: false,
@@ -71,10 +72,11 @@ export function getSDKAnalyticsSignature(_trackedAnalytics?: Partial<ITrackedPro
 
     const featureCode = analyticsOptions.feature;
     const SDKCode = analyticsOptions.sdkCode;
-    const algoVersion = 'A'; // The algo version is determined here, it should not be an argument
+    const product = analyticsOptions.product;
+    const algoVersion = 'B'; // The algo version is determined here, it should not be an argument
 
 
-    return `${algoVersion}${SDKCode}${encodedSDKVersion}${encodedTechVersion}${featureCode}`;
+    return `${algoVersion}${product}${SDKCode}${encodedSDKVersion}${encodedTechVersion}${featureCode}`;
   } catch (e) {
     // Either SDK or Node versions were unparsable
     return 'E';

src/sdkAnalytics/interfaces/IAnalyticsOptions.ts

@@ -5,5 +5,6 @@ export interface IAnalyticsOptions {
   sdkSemver: string,
   techVersion: string,
   sdkCode: string,
-  feature: string
+  feature: string,
+  product: string,
 }

src/sdkAnalytics/interfaces/ITrackedPropertiesThroughAnalytics.ts

@@ -8,6 +8,7 @@ export interface ITrackedPropertiesThroughAnalytics {
   sdkSemver: string; // Base Semver
   techVersion: string; // Node Version or 1.0.0 by default
   sdkCode: string; // Constant for Base?
+  product?: string; // Product code, 'A' for classic, 'B' for integrations
   accessibility?: boolean; // Was accessibility used
   lazyload?: boolean; // Was lazy-load used
   responsive?: boolean; // Was responsive used