feat: onboard new destination ninetailed

packages/analytics-js-common/src/constants/destDisplayNamesToFileNamesMap.ts

@@ -154,6 +154,8 @@ import {
   SpotifyPixelDirectoryName,
   CommandBarDisplayName,
   CommandBarDirectoryName,
+  NinetailedDisplayName,
+  NinetailedDirectoryName,
 } from './destinationNames';
 
 // The destination directory name is used as the destination SDK file name in CDN
@@ -235,6 +237,7 @@ const destDisplayNamesToFileNamesMap: Record<string, string> = {
   [SprigDisplayName]: SprigDirectoryName,
   [SpotifyPixelDisplayName]: SpotifyPixelDirectoryName,
   [CommandBarDisplayName]: CommandBarDirectoryName,
+  [NinetailedDisplayName]: NinetailedDirectoryName,
 };
 
 export { destDisplayNamesToFileNamesMap };

packages/analytics-js-common/src/constants/destinationNames.ts

@@ -306,3 +306,7 @@ export {
   DISPLAY_NAME as CommandBarDisplayName,
   DIR_NAME as CommandBarDirectoryName,
 } from './integrations/CommandBar/constants';
+export {
+  DISPLAY_NAME as NinetailedDisplayName,
+  DIR_NAME as NinetailedDirectoryName,
+} from './integrations/Ninetailed/constants';

packages/analytics-js-common/src/constants/integrations/Ninetailed/constants.ts

@@ -0,0 +1,13 @@
+const DIR_NAME = 'Ninetailed';
+const NAME = 'NINETAILED';
+const DISPLAY_NAME = 'Ninetailed';
+
+const DISPLAY_NAME_TO_DIR_NAME_MAP = { [DISPLAY_NAME]: DIR_NAME };
+const CNameMapping = {
+  [NAME]: NAME,
+  Ninetailed: NAME,
+  ninetailed: NAME,
+  NineTailed: NAME,
+};
+
+export { NAME, CNameMapping, DISPLAY_NAME_TO_DIR_NAME_MAP, DISPLAY_NAME, DIR_NAME };

packages/analytics-js-common/src/v1.1/utils/client_server_name.js

@@ -74,8 +74,9 @@ const clientToServerNames = {
   TIKTOK_ADS: 'TikTok Ads',
   ACTIVE_CAMPAIGN: 'ActiveCampaign',
   SPRIG: 'Sprig',
-  SPOTIFYPIXEL:'Spotify Pixel',
-  COMMANDBAR:'CommandBar',
+  SPOTIFYPIXEL: 'Spotify Pixel',
+  COMMANDBAR: 'CommandBar',
+  NINETAILED: 'Ninetailed',
 };
 
 export { clientToServerNames };

packages/analytics-js-common/src/v1.1/utils/config_to_integration_names.js

@@ -77,6 +77,7 @@ const configToIntNames = {
   SPRIG: 'Sprig',
   SPOTIFYPIXEL: 'SpotifyPixel',
   COMMANDBAR: 'CommandBar',
+  NINETAILED: 'Ninetailed',
 };
 
 export { configToIntNames };

packages/analytics-js-common/src/v1.1/utils/integration_cname.js

@@ -75,6 +75,8 @@ import { CNameMapping as ActiveCampaign } from '../../constants/integrations/Act
 import { CNameMapping as Sprig } from '../../constants/integrations/Sprig/constants';
 import { CNameMapping as SpotifyPixel } from '../../constants/integrations/SpotifyPixel/constants';
 import { CNameMapping as CommandBar } from '../../constants/integrations/CommandBar/constants';
+import { CNameMapping as Ninetailed } from '../../constants/integrations/Ninetailed/constants';
+
 // for sdk side native integration identification
 // add a mapping from common names to index.js exported key names as identified by Rudder
 const commonNames = {
@@ -113,6 +115,7 @@ const commonNames = {
   ...Lytics,
   ...Mixpanel,
   ...MoEngage,
+  ...Ninetailed,
   ...Optimizely,
   ...Pendo,
   ...PinterestTag,

packages/analytics-js-integrations/__tests__/integrations/Ninetailed/browser.test.js

@@ -0,0 +1,148 @@
+import Ninetailed from '../../../src/integrations/Ninetailed/browser';
+
+const destinationInfo = {
+  areTransformationsConnected: false,
+  destinationId: 'sample-destination-id',
+};
+
+describe('Ninetailed Intialization', () => {
+  let nt;
+  beforeEach(() => {
+    nt = new Ninetailed({}, { loglevel: 'DEBUG' }, destinationInfo);
+  });
+  afterEach(() => {
+    jest.restoreAllMocks();
+    window.ninetailed = undefined;
+  });
+  describe(' Is Loaded test Cases', () => {
+    // when ninetailed is not loaded from webapp
+    test('isLoaded should return False', () => {
+      expect(nt.isLoaded()).toBe(false);
+    });
+    // when ninetailed is loaded from webapp
+    test('isLoaded should return True', () => {
+      // since init call does not have any body so we are intialising the ninetailed object
+      window.ninetailed = {};
+      expect(nt.isLoaded()).toBeTruthy();
+    });
+  });
+  describe(' Is Ready test Cases', () => {
+    // when ninetailed is not loaded from webapp
+    test('isReady should return False', () => {
+      expect(nt.isReady()).toBe(false);
+    });
+    // when ninetailed is loaded from webapp
+    test('isReady should return True', () => {
+      // since init call does not have any body so we are intialising the ninetailed object
+      window.ninetailed = {};
+      expect(nt.isReady()).toBeTruthy();
+    });
+  });
+});
+describe('Ninetailed Event APIs', () => {
+  beforeEach(() => {
+    window.ninetailed = {};
+  });
+  describe('Page', () => {
+    let nt;
+    beforeEach(() => {
+      nt = new Ninetailed({}, { loglevel: 'DEBUG' }, destinationInfo);
+      window.ninetailed.page = jest.fn();
+    });
+    afterAll(() => {
+      jest.restoreAllMocks();
+    });
+    test('send pageview with properties', () => {
+      const properties = {
+        category: 'test cat',
+        path: '/test',
+        url: 'http://localhost:8080',
+        referrer: '',
+        title: 'test page',
+        testDimension: 'abc',
+        isRudderEvents: true,
+      };
+
+      nt.page({
+        message: {
+          context: {},
+          properties,
+        },
+      });
+      expect(window.ninetailed.page.mock.calls[0][0]).toEqual(properties);
+    });
+    test('send pageview without properties', () => {
+      nt.page({
+        message: {
+          context: {},
+        },
+      });
+      expect(window.ninetailed.page.mock.calls[0][0]).toEqual(undefined);
+    });
+  });
+  describe('Track', () => {
+    let nt;
+    beforeEach(() => {
+      nt = new Ninetailed({}, { loglevel: 'DEBUG' }, destinationInfo);
+      window.ninetailed.track = jest.fn();
+    });
+    afterAll(() => {
+      jest.restoreAllMocks();
+    });
+    test('Testing Track Event with event', () => {
+      const properties = {
+        customProp: 'testProp',
+        checkout_id: 'what is checkout id here??',
+        event_id: 'purchaseId',
+        order_id: 'transactionId',
+        value: 35.0,
+        shipping: 4.0,
+        isRudderEvents: true,
+      };
+      nt.track({
+        message: {
+          context: {},
+          event: 'Custom',
+          properties,
+        },
+      });
+      expect(window.ninetailed.track.mock.calls[0][0]).toEqual('Custom');
+      expect(window.ninetailed.track.mock.calls[0][1]).toEqual(properties);
+    });
+    test('Testing Track Event without event', () => {
+      nt.track({
+        message: {
+          context: {},
+          properties: {},
+        },
+      });
+      expect(window.ninetailed.track).not.toHaveBeenCalledWith();
+    });
+  });
+  describe('Identify', () => {
+    let nt;
+    beforeEach(() => {
+      nt = new Ninetailed({}, { loglevel: 'DEBUG' }, destinationInfo);
+      window.ninetailed.identify = jest.fn();
+    });
+    afterAll(() => {
+      jest.restoreAllMocks();
+    });
+    test('Testing Identify Custom Events', () => {
+      const traits = {
+        email: '[email protected]',
+        isRudderEvents: true,
+      };
+      nt.identify({
+        message: {
+          userId: 'rudder01',
+          context: {
+            traits,
+          },
+        },
+      });
+      expect(window.ninetailed.identify.mock.calls[0][0]).toEqual('rudder01');
+      expect(window.ninetailed.identify.mock.calls[0][1]).toEqual(traits);
+    });
+  });
+});

packages/analytics-js-integrations/src/integrations/Ninetailed/browser.js

@@ -0,0 +1,65 @@
+/* eslint-disable no-underscore-dangle */
+/* eslint-disable class-methods-use-this */
+import {
+  NAME,
+  DISPLAY_NAME,
+} from '@rudderstack/analytics-js-common/constants/integrations/Ninetailed/constants';
+import Logger from '../../utils/logger';
+
+const logger = new Logger(DISPLAY_NAME);
+class Ninetailed {
+  constructor(config, analytics, destinationInfo) {
+    if (analytics.logLevel) {
+      logger.setLogLevel(analytics.logLevel);
+    }
+    this.analytics = analytics;
+    this.name = NAME;
+    ({
+      shouldApplyDeviceModeTransformation: this.shouldApplyDeviceModeTransformation,
+      propagateEventsUntransformedOnError: this.propagateEventsUntransformedOnError,
+      destinationId: this.destinationId,
+    } = destinationInfo ?? {});
+  }
+
+  init() {
+    // We expect the customer to load the SDK through NPM package
+    // Docs: https://docs.ninetailed.io/for-developers/experience-sdk/getting-started
+  }
+
+  isLoaded() {
+    return !!window.ninetailed;
+  }
+
+  isReady() {
+    return this.isLoaded();
+  }
+
+  identify(rudderElement) {
+    const { message } = rudderElement;
+    const { userId, traits, context } = message;
+    const userTraits = { ...traits, ...context?.traits };
+    // for userId: until we don't pass the id to ninetailed, it will not make server identify call but is accepting the data
+    window.ninetailed.identify(userId, userTraits);
+  }
+  track(rudderElement) {
+    const { message } = rudderElement;
+    const { properties, event } = message;
+    if (!event) {
+      logger.error('Event name is required');
+      return;
+    }
+    window.ninetailed.track(event, properties);
+  }
+  page(rudderElement) {
+    const { message } = rudderElement;
+    const { properties } = message;
+    if (properties) {
+      properties.url = window.location.href;
+      window.ninetailed.page(properties);
+      return;
+    }
+    window.ninetailed.page();
+  }
+}
+
+export default Ninetailed;

packages/analytics-js-integrations/src/integrations/Ninetailed/index.js

@@ -0,0 +1 @@
+export { default as Ninetailed } from './browser';

packages/analytics-js-integrations/src/integrations/Ninetailed/sample-app/.gitignore

@@ -0,0 +1,23 @@
+# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
+
+# dependencies
+/node_modules
+/.pnp
+.pnp.js
+
+# testing
+/coverage
+
+# production
+/build
+
+# misc
+.DS_Store
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*

packages/analytics-js-integrations/src/integrations/Ninetailed/sample-app/README.md

@@ -0,0 +1,70 @@
+# Getting Started with Create React App
+
+This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
+
+## Available Scripts
+
+In the project directory, you can run:
+
+### `npm start`
+
+Runs the app in the development mode.\
+Open [http://localhost:3000](http://localhost:3000) to view it in your browser.
+
+The page will reload when you make changes.\
+You may also see any lint errors in the console.
+
+### `npm test`
+
+Launches the test runner in the interactive watch mode.\
+See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
+
+### `npm run build`
+
+Builds the app for production to the `build` folder.\
+It correctly bundles React in production mode and optimizes the build for the best performance.
+
+The build is minified and the filenames include the hashes.\
+Your app is ready to be deployed!
+
+See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
+
+### `npm run eject`
+
+**Note: this is a one-way operation. Once you `eject`, you can't go back!**
+
+If you aren't satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.
+
+Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you're on your own.
+
+You don't have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn't feel obligated to use this feature. However we understand that this tool wouldn't be useful if you couldn't customize it when you are ready for it.
+
+## Learn More
+
+You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).
+
+To learn React, check out the [React documentation](https://reactjs.org/).
+
+### Code Splitting
+
+This section has moved here: [https://facebook.github.io/create-react-app/docs/code-splitting](https://facebook.github.io/create-react-app/docs/code-splitting)
+
+### Analyzing the Bundle Size
+
+This section has moved here: [https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size](https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size)
+
+### Making a Progressive Web App
+
+This section has moved here: [https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app](https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app)
+
+### Advanced Configuration
+
+This section has moved here: [https://facebook.github.io/create-react-app/docs/advanced-configuration](https://facebook.github.io/create-react-app/docs/advanced-configuration)
+
+### Deployment
+
+This section has moved here: [https://facebook.github.io/create-react-app/docs/deployment](https://facebook.github.io/create-react-app/docs/deployment)
+
+### `npm run build` fails to minify
+
+This section has moved here: [https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify](https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify)