castled-js-sdk 0.0.1 → 0.0.3

package/sanity-suite/src/testBookSuites/track.js

@@ -0,0 +1,451 @@
+import track1ExpectedData from '../../__mocks__/track1.json';
+import track2ExpectedData from '../../__mocks__/track2.json';
+import track4ExpectedData from '../../__mocks__/track4.json';
+import track5ExpectedData from '../../__mocks__/track5.json';
+import track6ExpectedData from '../../__mocks__/track6.json';
+import track7ExpectedData from '../../__mocks__/track7.json';
+
+const trackMethodSuite = {
+  id: 'trackMethod',
+  name: 'Track',
+  description:
+    'Track Method: hightouchevents.track(event, [properties], [apiOptions], [callback]);',
+  testCases: [
+    {
+      id: 'track1',
+      description: 'Call with all arguments and all primitives in properties and apiOptions',
+      inputData: [
+        [
+          'customUserID',
+          {
+            name: 'John Doe',
+            title: 'CEO',
+            email: 'name.surname@domain.com',
+            company: 'Company123',
+            phone: '123-456-7890',
+            rating: 'Hot',
+            dob: new Date(Date.UTC(1990, 0, 12)),
+            address: [
+              {
+                city: 'Austin',
+                postalCode: 12345,
+                country: 'US',
+                street: 'Sample Address',
+                state: 'TX',
+                label: 'Home',
+                defaultAddress: true,
+              },
+              {
+                city: 'Houston',
+                postalCode: 345678,
+                country: 'US',
+                street: 'Sample Address 2',
+                state: 'TX',
+                label: 'Office',
+                defaultAddress: false,
+              },
+              {
+                city: 'Dallas',
+                postalCode: 987654,
+                country: 'US',
+                street: 'Sample Address 3',
+                state: 'TX',
+                label: 'Toms place',
+                defaultAddress: false,
+              },
+            ],
+          },
+          null,
+        ],
+        [
+          'Order Completed',
+          {
+            revenue: 30,
+            currency: 'USD',
+            user_actual_id: 12345,
+            productId: '234567-sdfghj-345tygh-567890dfghj',
+            productCategory: 'clothing',
+            paid: true,
+            paymentMode: 4,
+            paymentModeName: 'online',
+            productSizes: ['XS', 'S', 'M', 'L', 'XL', 'XXL'],
+            sampleObj: {
+              sampleObj1: {
+                newKey: 'sample text',
+              },
+              newKey1: 3456789009876543,
+            },
+          },
+          {
+            key1: [1, 2, 3, 4],
+            key2: 'sample text',
+            key3: false,
+            key4: 9087654,
+            key5: {
+              key6: 'sample text 2',
+              key7: [
+                {
+                  color: '#3456789',
+                  name: null,
+                },
+                {
+                  color: '#3456767',
+                  name: 'Red',
+                },
+              ],
+            },
+            key8: null,
+            key9: undefined,
+            device: {
+              id: 'sdfghj567-cghj5678-fghjvbn888',
+            },
+            library: {
+              name: 'Random JavaScript SDK',
+              version: '2.22.0',
+            },
+            context: {
+              metaData: {
+                appVersion: '2.8.0',
+                appId: '1hKOmRA4GRlm',
+                release_stage: 'Production',
+              },
+            },
+            integrations: {
+              All: false,
+              'Google Analytics': true,
+              Amplitude: true,
+            },
+            anonymousId: 'sample anonymousId',
+            originalTimestamp: '2023-01-13T08:13:58.548Z',
+            channel: 'random',
+            traits: {
+              subscribed: true,
+              plan: 'Gold',
+              endDate: '2023-04-13T08:13:58.548Z',
+              startDate: '2023-01-13T08:13:58.548Z',
+            },
+          },
+        ],
+      ],
+      expectedResult: track1ExpectedData,
+      triggerHandler: ['identify', 'track'],
+    },
+    {
+      id: 'track2',
+      description: 'Call with event name, properties as arguments with all possible data types',
+      inputData: [
+        [
+          'customUserID',
+          {
+            name: 'John Doe',
+            title: 'CEO',
+            email: 'name.surname@domain.com',
+            company: 'Company123',
+            phone: '123-456-7890',
+            rating: 'Hot',
+            dob: new Date(Date.UTC(1990, 0, 12)),
+            address: [
+              {
+                city: 'Austin',
+                postalCode: 12345,
+                country: 'US',
+                street: 'Sample Address',
+                state: 'TX',
+                label: 'Home',
+                defaultAddress: true,
+              },
+              {
+                city: 'Houston',
+                postalCode: 345678,
+                country: 'US',
+                street: 'Sample Address 2',
+                state: 'TX',
+                label: 'Office',
+                defaultAddress: false,
+              },
+              {
+                city: 'Dallas',
+                postalCode: 987654,
+                country: 'US',
+                street: 'Sample Address 3',
+                state: 'TX',
+                label: 'Toms place',
+                defaultAddress: false,
+              },
+            ],
+          },
+          null,
+        ],
+        [
+          'Order Completed',
+          {
+            revenue: 30,
+            currency: 'USD',
+            user_actual_id: 12345,
+            productId: '234567-sdfghj-345tygh-567890dfghj',
+            productCategory: 'clothing',
+            paid: true,
+            paymentMode: 4,
+            paymentModeName: 'online',
+            productSizes: ['XS', 'S', 'M', 'L', 'XL', 'XXL'],
+            sampleObj: {
+              sampleObj1: {
+                newKey: 'sample text',
+              },
+              newKey1: 3456789009876543,
+            },
+          },
+        ],
+      ],
+      expectedResult: track2ExpectedData,
+      triggerHandler: ['identify', 'track'],
+    },
+    {
+      id: 'track3',
+      description:
+        'Call with event name, properties and null apiOptions as arguments with all possible data types',
+      inputData: [
+        [
+          'customUserID',
+          {
+            name: 'John Doe',
+            title: 'CEO',
+            email: 'name.surname@domain.com',
+            company: 'Company123',
+            phone: '123-456-7890',
+            rating: 'Hot',
+            dob: new Date(Date.UTC(1990, 0, 12)),
+            address: [
+              {
+                city: 'Austin',
+                postalCode: 12345,
+                country: 'US',
+                street: 'Sample Address',
+                state: 'TX',
+                label: 'Home',
+                defaultAddress: true,
+              },
+              {
+                city: 'Houston',
+                postalCode: 345678,
+                country: 'US',
+                street: 'Sample Address 2',
+                state: 'TX',
+                label: 'Office',
+                defaultAddress: false,
+              },
+              {
+                city: 'Dallas',
+                postalCode: 987654,
+                country: 'US',
+                street: 'Sample Address 3',
+                state: 'TX',
+                label: 'Toms place',
+                defaultAddress: false,
+              },
+            ],
+          },
+          null,
+        ],
+        [
+          'Order Completed',
+          {
+            revenue: 30,
+            currency: 'USD',
+            user_actual_id: 12345,
+            productId: '234567-sdfghj-345tygh-567890dfghj',
+            productCategory: 'clothing',
+            paid: true,
+            paymentMode: 4,
+            paymentModeName: 'online',
+            productSizes: ['XS', 'S', 'M', 'L', 'XL', 'XXL'],
+            sampleObj: {
+              sampleObj1: {
+                newKey: 'sample text',
+              },
+              newKey1: 3456789009876543,
+            },
+          },
+          null,
+        ],
+      ],
+      expectedResult: track2ExpectedData,
+      triggerHandler: ['identify', 'track'],
+    },
+    {
+      id: 'track4',
+      description:
+        'Call with event name, null properties and apiOptions as arguments with all possible data types',
+      inputData: [
+        [
+          'customUserID',
+          {
+            name: 'John Doe',
+            title: 'CEO',
+            email: 'name.surname@domain.com',
+            company: 'Company123',
+            phone: '123-456-7890',
+            rating: 'Hot',
+            dob: new Date(Date.UTC(1990, 0, 12)),
+            address: [
+              {
+                city: 'Austin',
+                postalCode: 12345,
+                country: 'US',
+                street: 'Sample Address',
+                state: 'TX',
+                label: 'Home',
+                defaultAddress: true,
+              },
+              {
+                city: 'Houston',
+                postalCode: 345678,
+                country: 'US',
+                street: 'Sample Address 2',
+                state: 'TX',
+                label: 'Office',
+                defaultAddress: false,
+              },
+              {
+                city: 'Dallas',
+                postalCode: 987654,
+                country: 'US',
+                street: 'Sample Address 3',
+                state: 'TX',
+                label: 'Toms place',
+                defaultAddress: false,
+              },
+            ],
+          },
+          null,
+        ],
+        [
+          'Order Completed',
+          null,
+          {
+            key1: [1, 2, 3, 4],
+            key2: 'sample text',
+            key3: false,
+            key4: 9087654,
+            key5: {
+              key6: 'sample text 2',
+              key7: [
+                {
+                  color: '#3456789',
+                  name: null,
+                },
+                {
+                  color: '#3456767',
+                  name: 'Red',
+                },
+              ],
+            },
+            key8: null,
+            key9: undefined,
+            device: {
+              id: 'sdfghj567-cghj5678-fghjvbn888',
+            },
+            library: {
+              name: 'Random JavaScript SDK',
+              version: '2.22.0',
+            },
+            context: {
+              metaData: {
+                appVersion: '2.8.0',
+                appId: '1hKOmRA4GRlm',
+                release_stage: 'Production',
+              },
+            },
+            integrations: {
+              All: false,
+              'Google Analytics': true,
+              Amplitude: true,
+            },
+            anonymousId: 'sample anonymousId',
+            originalTimestamp: '2023-01-13T08:13:58.548Z',
+            channel: 'random',
+            traits: {
+              subscribed: true,
+              plan: 'Gold',
+              endDate: '2023-04-13T08:13:58.548Z',
+              startDate: '2023-01-13T08:13:58.548Z',
+            },
+          },
+        ],
+      ],
+      expectedResult: track4ExpectedData,
+      triggerHandler: ['identify', 'track'],
+    },
+    {
+      id: 'track5',
+      description: 'Call with only event name as argument',
+      inputData: ['Order Completed'],
+      expectedResult: track5ExpectedData,
+      triggerHandler: 'track',
+    },
+    {
+      id: 'track6',
+      description: 'Scenarios where no identify is called before track',
+      inputData: [
+        [true],
+        [
+          'Order Completed',
+          {
+            revenue: 30,
+            currency: 'USD',
+            user_actual_id: 12345,
+            productId: '234567-sdfghj-345tygh-567890dfghj',
+            productCategory: 'clothing',
+            paid: true,
+            paymentMode: 4,
+            paymentModeName: 'online',
+            productSizes: ['XS', 'S', 'M', 'L', 'XL', 'XXL'],
+            sampleObj: {
+              sampleObj1: {
+                newKey: 'sample text',
+              },
+              newKey1: 3456789009876543,
+            },
+          },
+        ],
+      ],
+      expectedResult: track6ExpectedData,
+      triggerHandler: ['reset', 'track'],
+    },
+    {
+      id: 'track7',
+      description: 'Consent denied category Ids are attached to context object of track',
+      inputData: [
+        [true],
+        [
+          'Order Completed',
+          {
+            revenue: 30,
+            currency: 'USD',
+            user_actual_id: 12345,
+            productId: '234567-sdfghj-345tygh-567890dfghj',
+            productCategory: 'clothing',
+            paid: true,
+            paymentMode: 4,
+            paymentModeName: 'online',
+            productSizes: ['XS', 'S', 'M', 'L', 'XL', 'XXL'],
+            sampleObj: {
+              sampleObj1: {
+                newKey: 'sample text',
+              },
+              newKey1: 3456789009876543,
+            },
+          },
+        ],
+      ],
+      expectedResult: track7ExpectedData,
+      triggerHandler: ['reset', 'track'],
+      // resetWindow: () => {
+      //   window.OneTrust = undefined;
+      //   window.OnetrustActiveGroups = undefined;
+      // },
+    },
+  ],
+};
+
+export { trackMethodSuite };

package/scripts/integrationBuildScript.js

@@ -0,0 +1,77 @@
+/* eslint-disable no-console */
+import { exec } from 'child_process';
+import { configToIntNames } from '../src/utils/config_to_integration_names';
+
+const intgNamesArr = Object.values(configToIntNames);
+const totalIntgCount = intgNamesArr.length;
+let passCount = 0;
+let curInt = 0;
+const numCPUs = require('os').cpus().length;
+
+let numRunning = 0;
+let index = 0;
+
+// At any given time, create only processes for
+// max CPUs available
+// Intentionally using 1 less CPU and all cpus in github runner
+let maxAtOnce = numCPUs > 1 ? numCPUs - 1 : 1;
+
+console.log(`Environment is CI: ${process.env.CI}`);
+if(process.env.CI) {
+  maxAtOnce = numCPUs;
+}
+
+console.log(`Total CPUs to use: ${maxAtOnce}`);
+console.log(`Total integrations to build: ${totalIntgCount}`);
+console.log(`Maximum number of concurrent processes: ${maxAtOnce}`);
+
+function buildIntegrations() {
+  // if there are more waiting, run them
+  while (numRunning < maxAtOnce && index < totalIntgCount) {
+    numRunning += 1;
+    const intgName = intgNamesArr[index];
+    index += 1;
+
+    let cmd = `npm run build:integration:cli --intg=${intgName}`;
+
+    if (process.env.VISUALIZER === 'true') {
+      cmd = `npm run build:integration:bundle-size:cli --intg=${intgName}`;
+    }
+
+    // eslint-disable-next-line no-loop-func
+    exec(cmd, (error, stdout, stderr) => {
+      curInt += 1;
+      console.log(
+        `\nCompleted building integration: ${intgName} (${curInt} out of ${totalIntgCount})`,
+      );
+      console.log(stdout);
+      console.log(stderr);
+      if (error) {
+        console.log(`${intgName} build failed!!!`);
+        console.log('ERROR: ', error);
+      } else {
+        passCount += 1;
+      }
+      numRunning -= 1;
+
+      // Trigger more builds
+      buildIntegrations();
+    });
+  }
+
+  if (numRunning === 0) {
+    // All the integrations are built
+    console.log(`Final Status: ${passCount !== totalIntgCount ? 'FAILURE' : 'SUCCESS'}`);
+    console.log(
+      `Summary: ${passCount} out of ${totalIntgCount} integration builds were successful`,
+    );
+
+    if (passCount !== totalIntgCount) {
+      // Force exit to indicate failure
+      process.exit(1);
+    }
+  }
+}
+
+// Kickoff the builds
+buildIntegrations();

package/scripts/run_tests.sh

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+
+nohup python3 -m http.server 8000 &
+npm run buildDevBrowser
+cp dist/browser.js tests/html/browser.js
+open -a "Google Chrome" http://localhost:8000/tests/html/script-test.html