Merge pull request #591 from queen-raae/feat/tracked-analytics-#590

feat: add option to configure tracked analytics

Author: cloudinary-pkoniu

lib-es5/utils/index.js

@@ -899,8 +899,16 @@ function url(public_id) {
   var urlAnalytics = ensureOption(options, 'urlAnalytics', false);
 
   if (urlAnalytics === true) {
-    var sdkVersions = getSDKVersions();
-    var analyticsOptions = getAnalyticsOptions(Object.assign({}, options, sdkVersions));
+    var { sdkCode, sdkSemver, techVersion } = getSDKVersions();
+    var sdkVersions = {
+      sdkCode: ensureOption(options, 'sdkCode', sdkCode),
+      sdkSemver: ensureOption(options, 'sdkSemver', sdkSemver),
+      techVersion: ensureOption(options, 'techVersion', techVersion)
+    };
+
+    var analyticsOptions = getAnalyticsOptions(
+      Object.assign({}, options, sdkVersions)
+    );
 
     var sdkAnalyticsSignature = getSDKAnalyticsSignature(analyticsOptions);
 
@@ -909,7 +917,7 @@ function url(public_id) {
     if (resultUrl.indexOf('?') >= 0) {
       appender = '&';
     }
-    resultUrl = `${resultUrl}${appender}_s=${sdkAnalyticsSignature}`;
+    resultUrl = `${resultUrl}${appender}_a=${sdkAnalyticsSignature}`;
   }
 
   return resultUrl;

lib/utils/index.js

@@ -829,8 +829,16 @@ function url(public_id, options = {}) {
   let urlAnalytics = ensureOption(options, 'urlAnalytics', false);
 
   if (urlAnalytics === true) {
-    let sdkVersions = getSDKVersions();
-    let analyticsOptions = getAnalyticsOptions(Object.assign({}, options, sdkVersions));
+    let { sdkCode, sdkSemver, techVersion } = getSDKVersions();
+    let sdkVersions = {
+      sdkCode: ensureOption(options, 'sdkCode', sdkCode),
+      sdkSemver: ensureOption(options, 'sdkSemver', sdkSemver),
+      techVersion: ensureOption(options, 'techVersion', techVersion)
+    };
+
+    let analyticsOptions = getAnalyticsOptions(
+      Object.assign({}, options, sdkVersions)
+    );
 
     let sdkAnalyticsSignature = getSDKAnalyticsSignature(analyticsOptions);
 
@@ -839,7 +847,7 @@ function url(public_id, options = {}) {
     if (resultUrl.indexOf('?') >= 0) {
       appender = '&';
     }
-    resultUrl = `${resultUrl}${appender}_s=${sdkAnalyticsSignature}`;
+    resultUrl = `${resultUrl}${appender}_a=${sdkAnalyticsSignature}`;
   }
 
   return resultUrl;

test/unit/sdkAnalytics/imageTagWithAnalytics.spec.js

@@ -49,7 +49,7 @@ describe('Tests for sdk analytics through image tag', function () {
       urlAnalytics: true
     });
 
-    expect(imgStr).to.contain(`src='http://res.cloudinary.com/${TEST_CLOUD_NAME}/image/upload/hello.png?_s=AMAlhAM0`);
+    expect(imgStr).to.contain(`src='http://res.cloudinary.com/${TEST_CLOUD_NAME}/image/upload/hello.png?_a=AMAlhAM0`);
   });
 
   it('Reads from process.versions and package.json (Mocked) - Responsive', () => {
@@ -63,6 +63,23 @@ describe('Tests for sdk analytics through image tag', function () {
       urlAnalytics: true
     });
 
-    expect(imgStr).to.contain(`src='http://res.cloudinary.com/${TEST_CLOUD_NAME}/image/upload/hello.png?_s=AMAlhAMA`);
+    expect(imgStr).to.contain(`src='http://res.cloudinary.com/${TEST_CLOUD_NAME}/image/upload/hello.png?_a=AMAlhAMA`);
+  });
+
+  it('Reads from tracked analytics configuration', () => {
+    process.versions = {
+      node: '12.0.0'
+    };
+
+    let imgStr = cloudinary.image("hello", {
+      format: "png",
+      urlAnalytics: true,
+      sdkCode: "X",
+      sdkSemver: "7.3.0",
+      techVersion: "3.4.7"
+      
+    });
+
+    expect(imgStr).to.contain(`src='http://res.cloudinary.com/${TEST_CLOUD_NAME}/image/upload/hello.png?_a=AXAEzGT0`);
   });
 });