feat: move data plane events processing to core

.eslintrc.json

@@ -27,7 +27,6 @@
       "CustomEvent",
       "requestAnimationFrame",
       "cancelAnimationFrame",
-      "navigator.sendBeacon",
       "Uint8Array",
       "Set",
       "atob"

jest/jest.polyfills.js

@@ -14,5 +14,3 @@ global.Math.random = () => 0.5;
 // Suppress Console output from tested code to terminal
 console.warn = jest.fn();
 console.error = jest.fn();
-// Mock browsers sendBeacon utility
-navigator.sendBeacon = jest.fn();

packages/analytics-js-common/__mocks__/HttpClient.ts

@@ -1,17 +1,14 @@
-import type { IErrorHandler } from '@rudderstack/analytics-js-common/types/ErrorHandler';
 import type { IHttpClient } from '@rudderstack/analytics-js-common/types/HttpClient';
 import type { ILogger } from '@rudderstack/analytics-js-common/types/Logger';
 import { defaultLogger } from './Logger';
 
 class HttpClient implements IHttpClient {
-  errorHandler?: IErrorHandler;
   logger: ILogger = defaultLogger;
   hasErrorHandler = false;
-  getData = jest.fn();
+  request = jest.fn();
   getAsyncData = jest.fn();
   setAuthHeader = jest.fn();
   resetAuthHeader = jest.fn();
-  init = jest.fn();
 }
 
 const defaultHttpClient = new HttpClient();

packages/analytics-js-common/__mocks__/Store.ts

@@ -4,6 +4,7 @@ import { defaultInMemoryStorage, defaultLocalStorage } from './Storage';
 import { defaultPluginsManager } from './PluginsManager';
 import { defaultLogger } from './Logger';
 import { defaultErrorHandler } from './ErrorHandler';
+import type { Nullable } from '@rudderstack/analytics-js-common/types/Nullable';
 
 // Mock all the methods of the Store class
 
@@ -12,7 +13,7 @@ class Store implements IStore {
     this.id = config.id;
     this.name = config.name;
     this.isEncrypted = config.isEncrypted ?? false;
-    this.validKeys = config.validKeys ?? {};
+    this.validKeys = config.validKeys ?? [];
     this.engine = engine ?? defaultLocalStorage;
     this.originalEngine = this.engine;
     this.errorHandler = config.errorHandler;
@@ -22,7 +23,7 @@ class Store implements IStore {
   id = 'test';
   name = 'test';
   isEncrypted = false;
-  validKeys: Record<string, string>;
+  validKeys: string[];
   engine: IStorage = defaultLocalStorage;
   originalEngine: IStorage = defaultLocalStorage;
   errorHandler;
@@ -43,7 +44,7 @@ class Store implements IStore {
     const validKey = this.createValidKey(key);
     this.engine.setItem(validKey, value);
   };
-  get = (key: string) => {
+  get = <T = string>(key: string): Nullable<T> => {
     const validKey = this.createValidKey(key);
     return this.engine.getItem(validKey);
   };

packages/analytics-js-common/__mocks__/StoreManager.ts

@@ -1,4 +1,6 @@
 import type { IStoreConfig, IStoreManager } from '../src/types/Store';
+import { defaultErrorHandler } from './ErrorHandler';
+import { defaultLogger } from './Logger';
 import { defaultPluginsManager } from './PluginsManager';
 import { defaultCookieStorage, defaultInMemoryStorage, defaultLocalStorage } from './Storage';
 import { defaultStore, Store } from './Store';
@@ -25,6 +27,8 @@ class StoreManager implements IStoreManager {
     return new Store(config, storageEngine, defaultPluginsManager);
   };
   getStore = jest.fn(() => defaultStore);
+  errorHandler = defaultErrorHandler;
+  logger = defaultLogger;
   initializeStorageState = jest.fn();
 }
 

packages/analytics-js-plugins/__tests__/utilities/retryQueue/RetryQueue.test.ts → packages/analytics-js-common/__tests__/utilities/retryQueue/RetryQueue.test.ts

@@ -1,15 +1,18 @@
 /* eslint-disable import/no-extraneous-dependencies */
-import { QueueStatuses } from '@rudderstack/analytics-js-common/constants/QueueStatuses';
-import { defaultStoreManager } from '@rudderstack/analytics-js-common/__mocks__/StoreManager';
-import { defaultLocalStorage } from '@rudderstack/analytics-js-common/__mocks__/Storage';
-import { Store } from '@rudderstack/analytics-js-common/__mocks__/Store';
+import { QueueStatuses } from '../../../src/utilities/retryQueue/constants';
+import { defaultStoreManager } from '../../../__mocks__/StoreManager';
+import { defaultLocalStorage } from '../../../__mocks__/Storage';
+import { Store } from '../../../__mocks__/Store';
 import { Schedule } from '../../../src/utilities/retryQueue/Schedule';
 import { RetryQueue } from '../../../src/utilities/retryQueue/RetryQueue';
-import type { QueueItem, QueueItemData } from '../../../src/types/plugins';
+import type { QueueItem, QueueItemData } from '../../../src/utilities/retryQueue/types';
+import { defaultPluginsManager } from '../../../__mocks__/PluginsManager';
+import { defaultErrorHandler } from '../../../__mocks__/ErrorHandler';
+import { defaultLogger } from '../../../__mocks__/Logger';
 
 const size = (queue: RetryQueue): { queue: number; inProgress: number } => ({
-  queue: queue.store.get(QueueStatuses.QUEUE).length,
-  inProgress: Object.keys(queue.store.get(QueueStatuses.IN_PROGRESS) || {}).length,
+  queue: queue.store.get('queue').length,
+  inProgress: Object.keys(queue.store.get('inProgress') || {}).length,
 });
 
 describe('Queue', () => {
@@ -296,7 +299,7 @@ describe('Queue', () => {
       queue.addItem(i);
     }
 
-    const storedQueue = queue.store.get(QueueStatuses.QUEUE);
+    const storedQueue = queue.store.get('queue');
     expect(storedQueue.length).toEqual(100);
     expect(storedQueue[0].item).toEqual(5);
     expect(storedQueue[99].item).toEqual(104);
@@ -309,11 +312,14 @@ describe('Queue', () => {
         name: 'test',
         id: 'fake-id',
         validKeys: QueueStatuses,
+        errorHandler: defaultErrorHandler,
+        logger: defaultLogger,
       },
       defaultLocalStorage,
+      defaultPluginsManager,
     );
-    foundQueue.set(foundQueue.validKeys.ACK as string, 0); // fake timers starts at time 0
-    foundQueue.set(foundQueue.validKeys.QUEUE as string, [
+    foundQueue.set('ack' as string, 0); // fake timers starts at time 0
+    foundQueue.set('queue' as string, [
       {
         item: 'a',
         time: 0,
@@ -388,11 +394,14 @@ describe('Queue', () => {
         name: 'test',
         id: 'fake-id',
         validKeys: QueueStatuses,
+        errorHandler: defaultErrorHandler,
+        logger: defaultLogger,
       },
       defaultLocalStorage,
+      defaultPluginsManager,
     );
-    foundQueue.set(foundQueue.validKeys.ACK as string, -15000);
-    foundQueue.set(foundQueue.validKeys.IN_PROGRESS as string, {
+    foundQueue.set('ack' as string, -15000);
+    foundQueue.set('inProgress' as string, {
       'task-id-1': {
         item: 'a',
         time: 0,
@@ -474,11 +483,14 @@ describe('Queue', () => {
         name: 'test',
         id: 'fake-id',
         validKeys: QueueStatuses,
+        errorHandler: defaultErrorHandler,
+        logger: defaultLogger,
       },
       defaultLocalStorage,
+      defaultPluginsManager,
     );
-    foundQueue.set(foundQueue.validKeys.ACK as string, 0); // fake timers starts at time 0
-    foundQueue.set(foundQueue.validKeys.BATCH_QUEUE as string, [
+    foundQueue.set('ack' as string, 0); // fake timers starts at time 0
+    foundQueue.set('batchQueue' as string, [
       {
         item: 'a',
         time: 0,
@@ -518,11 +530,14 @@ describe('Queue', () => {
         name: 'test',
         id: 'fake-id',
         validKeys: QueueStatuses,
+        errorHandler: defaultErrorHandler,
+        logger: defaultLogger,
       },
       defaultLocalStorage,
+      defaultPluginsManager,
     );
-    foundQueue.set(foundQueue.validKeys.ACK as string, 0); // fake timers starts at time 0
-    foundQueue.set(foundQueue.validKeys.BATCH_QUEUE as string, [
+    foundQueue.set('ack' as string, 0); // fake timers starts at time 0
+    foundQueue.set('batchQueue' as string, [
       {
         item: 'a',
         time: 0,
@@ -569,11 +584,14 @@ describe('Queue', () => {
         name: 'test',
         id: 'fake-id',
         validKeys: QueueStatuses,
+        errorHandler: defaultErrorHandler,
+        logger: defaultLogger,
       },
       defaultLocalStorage,
+      defaultPluginsManager,
     );
-    foundQueue.set(foundQueue.validKeys.ACK as string, -15000);
-    foundQueue.set(foundQueue.validKeys.QUEUE as string, [
+    foundQueue.set('ack' as string, -15000);
+    foundQueue.set('queue' as string, [
       {
         item: 'a',
         time: 0,
@@ -607,11 +625,14 @@ describe('Queue', () => {
         name: 'test',
         id: 'fake-id',
         validKeys: QueueStatuses,
+        errorHandler: defaultErrorHandler,
+        logger: defaultLogger,
       },
       defaultLocalStorage,
+      defaultPluginsManager,
     );
-    foundQueue.set(foundQueue.validKeys.ACK as string, -15000);
-    foundQueue.set(foundQueue.validKeys.IN_PROGRESS as string, {
+    foundQueue.set('ack' as string, -15000);
+    foundQueue.set('inProgress' as string, {
       'task-id-0': {
         item: 'a',
         time: 0,
@@ -645,11 +666,14 @@ describe('Queue', () => {
         name: 'test',
         id: 'fake-id',
         validKeys: QueueStatuses,
+        errorHandler: defaultErrorHandler,
+        logger: defaultLogger,
       },
       defaultLocalStorage,
+      defaultPluginsManager,
     );
-    foundQueue.set(foundQueue.validKeys.ACK as string, -15000);
-    foundQueue.set(foundQueue.validKeys.BATCH_QUEUE as string, [
+    foundQueue.set('ack' as string, -15000);
+    foundQueue.set('batchQueue' as string, [
       {
         item: 'a',
         time: 0,
@@ -683,11 +707,14 @@ describe('Queue', () => {
         name: 'test',
         id: 'fake-id',
         validKeys: QueueStatuses,
+        errorHandler: defaultErrorHandler,
+        logger: defaultLogger,
       },
       defaultLocalStorage,
+      defaultPluginsManager,
     );
-    foundQueue.set(foundQueue.validKeys.ACK as string, -15000);
-    foundQueue.set(foundQueue.validKeys.IN_PROGRESS as string, {
+    foundQueue.set('ack' as string, -15000);
+    foundQueue.set('inProgress' as string, {
       'task-id-0': {
         item: 'a',
         time: 0,
@@ -702,7 +729,7 @@ describe('Queue', () => {
       },
     });
 
-    foundQueue.set(foundQueue.validKeys.QUEUE as string, [
+    foundQueue.set('queue' as string, [
       {
         item: 'a',
         time: 0,
@@ -717,7 +744,7 @@ describe('Queue', () => {
       },
     ]);
 
-    foundQueue.set(foundQueue.validKeys.BATCH_QUEUE as string, [
+    foundQueue.set('batchQueue' as string, [
       {
         item: 'c',
         time: 0,
@@ -753,11 +780,14 @@ describe('Queue', () => {
         name: 'test',
         id: 'fake-id',
         validKeys: QueueStatuses,
+        errorHandler: defaultErrorHandler,
+        logger: defaultLogger,
       },
       defaultLocalStorage,
+      defaultPluginsManager,
     );
-    foundQueue.set(foundQueue.validKeys.ACK as string, -15000);
-    foundQueue.set(foundQueue.validKeys.IN_PROGRESS as string, {
+    foundQueue.set('ack' as string, -15000);
+    foundQueue.set('inProgress' as string, {
       'task-id-0': {
         item: 'a',
         time: 0,
@@ -770,7 +800,7 @@ describe('Queue', () => {
       },
     });
 
-    foundQueue.set(foundQueue.validKeys.QUEUE as string, [
+    foundQueue.set('queue' as string, [
       {
         item: 'a',
         time: 0,
@@ -802,25 +832,28 @@ describe('Queue', () => {
         name: 'test',
         id: 'fake-id',
         validKeys: QueueStatuses,
+        errorHandler: defaultErrorHandler,
+        logger: defaultLogger,
       },
       defaultLocalStorage,
+      defaultPluginsManager,
     );
-    foundQueue.set(foundQueue.validKeys.ACK as string, -15000);
-    foundQueue.set(foundQueue.validKeys.QUEUE as string, [
+    foundQueue.set('ack' as string, -15000);
+    foundQueue.set('queue' as string, [
       {
         item: 'a',
         time: 0,
         attemptNumber: 0,
       },
     ]);
-    foundQueue.set(foundQueue.validKeys.IN_PROGRESS as string, {
+    foundQueue.set('inProgress' as string, {
       'task-id': {
         item: 'b',
         time: 1,
         attemptNumber: 0,
       },
     });
-    foundQueue.set(foundQueue.validKeys.BATCH_QUEUE as string, {
+    foundQueue.set('batchQueue' as string, {
       'task-id2': {
         item: 'c',
         time: 1,
@@ -854,11 +887,14 @@ describe('Queue', () => {
           name: 'test',
           id: 'fake-id',
           validKeys: QueueStatuses,
+          errorHandler: defaultErrorHandler,
+          logger: defaultLogger,
         },
         defaultLocalStorage,
+        defaultPluginsManager,
       );
-      foundQueue.set(foundQueue.validKeys.ACK as string, 0); // fake timers starts at time 0
-      foundQueue.set(foundQueue.validKeys.QUEUE as string, [
+      foundQueue.set('ack' as string, 0); // fake timers starts at time 0
+      foundQueue.set('queue' as string, [
         {
           item: 'a',
           time: 0,
@@ -891,11 +927,14 @@ describe('Queue', () => {
           name: 'test',
           id: 'fake-id',
           validKeys: QueueStatuses,
+          errorHandler: defaultErrorHandler,
+          logger: defaultLogger,
         },
         defaultLocalStorage,
+        defaultPluginsManager,
       );
-      foundQueue.set(foundQueue.validKeys.ACK as string, -15000);
-      foundQueue.set(foundQueue.validKeys.IN_PROGRESS as string, {
+      foundQueue.set('ack' as string, -15000);
+      foundQueue.set('inProgress' as string, {
         'task-id': {
           item: 'a',
           time: 0,
@@ -928,18 +967,21 @@ describe('Queue', () => {
           name: 'test',
           id: 'fake-id',
           validKeys: QueueStatuses,
+          errorHandler: defaultErrorHandler,
+          logger: defaultLogger,
         },
         defaultLocalStorage,
+        defaultPluginsManager,
       );
-      foundQueue.set(foundQueue.validKeys.ACK as string, -15000);
-      foundQueue.set(foundQueue.validKeys.QUEUE as string, [
+      foundQueue.set('ack' as string, -15000);
+      foundQueue.set('queue' as string, [
         {
           item: 'a',
           time: 0,
           attemptNumber: 0,
         },
       ]);
-      foundQueue.set(foundQueue.validKeys.IN_PROGRESS as string, {
+      foundQueue.set('inProgress' as string, {
         'task-id': {
           item: 'b',
           time: 1,

packages/analytics-js-common/__tests__/utilities/url.test.ts

@@ -27,7 +27,7 @@ describe('utilities - url', () => {
       [false, undefined],
       [
         true,
-        'https://polyfill-fastly.io/v3/polyfill.min.js?version=3.111.0&features=URL%2CPromise%2CNumber.isNaN%2CNumber.isInteger%2CArray.from%2CArray.prototype.find%2CArray.prototype.includes%2CString.prototype.endsWith%2CString.prototype.startsWith%2CString.prototype.includes%2CString.prototype.replaceAll%2CString.fromCodePoint%2CObject.entries%2CObject.values%2CObject.assign%2CObject.fromEntries%2CElement.prototype.dataset%2CTextEncoder%2CrequestAnimationFrame%2CCustomEvent%2Cnavigator.sendBeacon%2CArrayBuffer%2CSet',
+        'https://polyfill-fastly.io/v3/polyfill.min.js?version=3.111.0&features=URL%2CPromise%2CNumber.isNaN%2CNumber.isInteger%2CArray.from%2CArray.prototype.find%2CArray.prototype.includes%2CString.prototype.endsWith%2CString.prototype.startsWith%2CString.prototype.includes%2CString.prototype.replaceAll%2CString.fromCodePoint%2CObject.entries%2CObject.values%2CObject.assign%2CObject.fromEntries%2CElement.prototype.dataset%2CTextEncoder%2CrequestAnimationFrame%2CCustomEvent%2CArrayBuffer%2CSet',
       ],
     ];