Feature/add analytics to cld base (#351)

Add analytics support.

Author: patrick-tolosa

__TESTS__/TestUtils/createCloudinaryFile.ts

@@ -6,9 +6,10 @@ import {CloudinaryFile} from "../../src";
  *
  */
 function createNewFile(publicID?: string, cloudConfig?: ICloudConfig, urlConfig?:IURLConfig): CloudinaryFile {
-  return new CloudinaryFile(publicID, Object.assign({
-    cloudName: 'demo'
-  }, cloudConfig), urlConfig);
+  const newCloudConfig = { cloudName: 'demo', ...cloudConfig};
+  const newUrlConfig = { analytics: false, ...urlConfig};
+
+  return new CloudinaryFile(publicID, newCloudConfig, newUrlConfig);
 }
 
 export {createNewFile};

__TESTS__/TestUtils/createCloudinaryImage.ts

@@ -6,9 +6,10 @@ import IURLConfig from "../../src/config/interfaces/Config/IURLConfig";
  *
  */
 function createNewImage(publicID?: string, cloudConfig?: ICloudConfig, urlConfig?:IURLConfig): CloudinaryImage {
-  return new CloudinaryImage(publicID, Object.assign({
-    cloudName: 'demo'
-  }, cloudConfig), urlConfig);
+  const newCloudConfig = { cloudName: 'demo', ...cloudConfig};
+  const newUrlConfig = { analytics: false, ...urlConfig};
+
+  return new CloudinaryImage(publicID, newCloudConfig, newUrlConfig);
 }
 
 export {createNewImage};

__TESTS__/TestUtils/createCloudinaryVideo.ts

@@ -1,12 +1,15 @@
 import {CloudinaryVideo} from "../../src/assets/CloudinaryVideo";
+import ICloudConfig from "../../src/config/interfaces/Config/ICloudConfig";
+import IURLConfig from "../../src/config/interfaces/Config/IURLConfig";
 
 /**
  *
  */
-function createNewVideo(publicID = 'sample'): CloudinaryVideo {
-  return new CloudinaryVideo(publicID, {
-    cloudName: 'demo'
-  });
+function createNewVideo(publicID = 'sample', cloudConfig?: ICloudConfig, urlConfig?:IURLConfig): CloudinaryVideo {
+  const newCloudConfig = { cloudName: 'demo', ...cloudConfig};
+  const newUrlConfig = { analytics: false, ...urlConfig};
+
+  return new CloudinaryVideo(publicID, newCloudConfig, newUrlConfig);
 }
 
 export {createNewVideo};

__TESTS__/unit/Instance/Cloudinary.test.ts

@@ -7,6 +7,9 @@ describe('Tests for Cloudinary instance', () => {
     const cloudinary = new Cloudinary(new CloudinaryConfig({
       cloud: {
         cloudName:'demoInInstance'
+      },
+      url: {
+        analytics: false
       }
     }));
     const tImage = cloudinary.image('sample');
@@ -23,6 +26,9 @@ describe('Tests for Cloudinary instance', () => {
     cloudinary.setConfig(new CloudinaryConfig({
       cloud: {
         cloudName:'demoInInstance'
+      },
+      url: {
+        analytics: false
       }
     }));
 

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

@@ -0,0 +1,23 @@
+/**
+ * @jest-environment jsdom
+ */
+
+
+
+import {createNewImageWithAnalytics} from "./testUtils/createNewImageWithAnalytics";
+
+
+describe('Add analytics to a URL from the browser', () => {
+  it('Uses default techVersion 0.0.0 when in browser', () => {
+    const cldImage = createNewImageWithAnalytics('sample');
+
+    // ATAAB{NODE_VERSION}0
+    // ATAAB{AA}0 -> we expect nodeVersion to be 0.0.0 in browser (Since it's missing)
+    // expect ATAABAA0
+    expect(cldImage.toURL({
+      trackedAnalytics: {
+        sdkSemver: '1.0.0'
+      }
+    })).toContain('ATAABAA0'); // we shouldn't have a query param at all
+  });
+});

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

@@ -0,0 +1,136 @@
+/**
+ * @jest-environment node
+ */
+
+
+import pkg from '../../../src/package.json';
+import {createNewImageWithAnalytics} from "./testUtils/createNewImageWithAnalytics";
+
+describe('Add analytics to a regular URL', () => {
+  it('Works with default values', () => {
+    const cldImage = createNewImageWithAnalytics('sample');
+
+    // Generate a URL without any special configuration
+    const sigFromDefaultValues = cldImage.toURL().split('?')[1];
+    // Generate a URL with provided sdkSemver and techVersion, but we're using the values that should be given by default
+    const sigFromExplicitPackageVersion = cldImage.toURL({
+      trackedAnalytics: {
+        sdkSemver: pkg.version.split('-')[0], // remove -beta, -alpha or other tagged versions from the version string
+        techVersion: process.versions.node
+      }
+    }).split('?')[1];
+
+    // AT AAB WE 0
+    expect(sigFromDefaultValues).not.toBeUndefined();
+    expect(sigFromDefaultValues).toBe(sigFromExplicitPackageVersion);
+  });
+
+
+  it('Can overwrite default values', () => {
+    const cldImage = createNewImageWithAnalytics('sample');
+    // AZ -> Algo A, SDK Code is Z
+    // Alh -> 1.24.0 from package.json
+    // AM -> 12.0.0 Underlying tech
+    // D -> Accessibility
+    expect(cldImage.toURL({
+      trackedAnalytics: {
+        sdkCode: 'Z', // arbitrary, just show we can overwrite it
+        sdkSemver: '1.24.0', // If not specified, this is taken from package.json
+        techVersion: '12.0.0',
+        accessibility: true
+      }
+    })).toContain('?_a=AZAlhAMD');
+  });
+
+  it('Test lazyload feature value', () => {
+    const cldImage = createNewImageWithAnalytics('sample');
+    // AZ -> Algo A, SDK Code is Z
+    // Alh -> 1.24.0 from package.json
+    // AM -> 12.0.0 Underlying tech
+    // C -> lazyload
+    expect(cldImage.toURL({
+      trackedAnalytics: {
+        sdkCode: 'Z',
+        sdkSemver: '1.24.0',
+        techVersion: '12.0.0',
+        lazyload: true
+      }
+    })).toContain('?_a=AZAlhAMC');
+  });
+
+  it('Test responsive feature value', () => {
+    const cldImage = createNewImageWithAnalytics('sample');
+    // AZ -> Algo A, SDK Code is Z
+    // Alh -> 1.24.0 from package.json
+    // AM -> 12.0.0 Underlying tech
+    // A -> responsive
+    expect(cldImage.toURL({
+      trackedAnalytics: {
+        sdkCode: 'Z',
+        sdkSemver: '1.24.0',
+        techVersion: '12.0.0',
+        responsive: true
+      }
+    })).toContain('?_a=AZAlhAMA');
+  });
+
+  it('Test placeholder feature value', () => {
+    const cldImage = createNewImageWithAnalytics('sample');
+    // AZ -> Algo A, SDK Code is Z
+    // Alh -> 1.24.0 from package.json
+    // AM -> 12.0.0 Underlying tech
+    // B -> placeholder
+    expect(cldImage.toURL({
+      trackedAnalytics: {
+        sdkCode: 'Z',
+        sdkSemver: '1.24.0',
+        techVersion: '12.0.0',
+        placeholder: true
+      }
+    })).toContain('?_a=AZAlhAMB');
+  });
+
+  it('Can be turned off', () => {
+    const cldImage = createNewImageWithAnalytics('sample', {}, {
+      analytics: false
+    });
+
+    expect(cldImage.toURL({
+      trackedAnalytics: {
+        sdkCode: 'M',
+        sdkSemver: '1.24.0', // If not specified, this is taken from package.json
+        techVersion: '12.0.0'
+      }
+    })).not.toContain('?'); // we shouldn't have a query param at all
+  });
+
+
+  it('Expect to error for very large versions', () => {
+    const cldImage = createNewImageWithAnalytics('sample');
+
+    expect(cldImage.toURL({
+      trackedAnalytics: {
+        sdkSemver: '50.50.50' // If not specified, this is taken from package.json
+      }
+    })).toContain('?_a=E');
+  });
+
+  it('Expect to error for invalid versions', () => {
+    const cldImage = createNewImageWithAnalytics('sample');
+    // All these cases should error the analytics function
+    ['abc', '1', 'foo.bar', '-55'].forEach((version) => {
+      // Try catch to provide a a meaningful error message
+      // This will fail the test and print what case failed exactly
+      try {
+        expect(cldImage.toURL({
+          trackedAnalytics: {
+            sdkSemver: version // If not specified, this is taken from package.json
+          }
+        })).toContain('?_a=E');
+      } catch (e) {
+        e.message = `Error for {{${version}}} ${e.message}`;
+        throw e;
+      }
+    });
+  });
+});

__TESTS__/unit/analytics/testUtils/createNewImageWithAnalytics.ts

@@ -0,0 +1,11 @@
+import ICloudConfig from "../../../../src/config/interfaces/Config/ICloudConfig";
+import IURLConfig from "../../../../src/config/interfaces/Config/IURLConfig";
+import {CloudinaryImage} from "../../../../src";
+import {createNewImage} from "../../../TestUtils/createCloudinaryImage";
+
+/**
+ * Create a new CloudinaryImage with analytics turned on by default
+ */
+export function createNewImageWithAnalytics(publicID: string, cloudConfig?: ICloudConfig, urlConfig?: IURLConfig): CloudinaryImage {
+  return createNewImage(publicID, {cloudName: 'demo'}, {analytics: true, ...urlConfig});
+}

__TESTS__/unit/asset/CloudinaryFile.test.ts

@@ -3,7 +3,7 @@ import {CloudinaryFile} from "../../../src/assets/CloudinaryFile";
 describe('Tests for CloudinaryFile', () => {
   let cloudinaryFile: CloudinaryFile = null;
   beforeEach(() => {
-    cloudinaryFile = new CloudinaryFile('sample', {cloudName:'demo'});
+    cloudinaryFile = new CloudinaryFile('sample', {cloudName:'demo'}, {analytics:false});
   });
 
   it('Instantiates a cloudinaryFile', () => {

__TESTS__/unit/scripts/createEntryPoints.test.ts

@@ -14,7 +14,7 @@ describe('Tests for createEntryPoints', () => {
   });
 
   it ('Creates the main entrypoint to the project', () => {
-    createEntryPoints.createMainEntryPoint();
+    createEntryPoints.copyPackageJson();
     const mainPackageJson = JSON.parse(fs.readFileSync('./dist/package.json', 'utf-8'));
 
     // Expect the right main entrypoint

__TESTS__/unit/url/url.test.ts

@@ -85,7 +85,7 @@ describe('Tests for URL configuration', () => {
   });
 
   it('Should support an external signature', () => {
-    const image = new CloudinaryImage('sample', {cloudName: 'demo'}, {});
+    const image = createNewImage('sample');
     const signature = "some-signature";
 
     image.setSignature(signature);