feat: Add performance timing for SDK start measurement (#1101)

* Add EventTimingService to capture event timestamps

* Update jest configuration to include fetch-mock in transformIgnorePatterns and clean up test setup

* refactor: Simplify EventTimingService by removing unnecessary self reference and updating test cases with consistent API keys

* test: Update mParticle instance manager test to set requestConfig to true

* build: Update jest test command to include build step before execution

* fix(tests): Update mParticle instance manager tests to use globalThis for compatibility

* refactor: Update EventTimingService to use EventTimingName type and improve consistency in mParticle instance manager

* fix(tests): Replace global.fetch with globalThis.fetch in mParticle instance manager tests for improved compatibility

* fix(tests): Update mParticle instance manager tests to use globalThis.fetch for better compatibility across environments

* refactor: Remove EventTimingService and related tests; update jest configuration and introduce performance metrics tracking

* refactor: Remove isSelfHosted method from IMParticleInstanceManager interface for cleaner API

* Minor

* feat: Add getLauncherInstanceGuid method to IMParticleWebSDKInstance and IMParticleInstanceManager for unique identifier generation

* feat: Update mParticle instance manager to set Rokt launcher instance GUID and capture performance timings

* chore: Remove unnecessary blank line in mParticle instance manager for cleaner code

* chore: Remove unused variable in mParticle instance manager for improved code clarity

* feat: Introduce PerformanceMarkType for capturing performance metrics and update related methods in mParticle instance manager

* feat: Update mParticle instance manager to use Constants for Rokt launcher instance GUID and enhance related tests for improved functionality

* fix(tests): Update mParticle instance manager tests to reference globalThis instead of window for improved compatibility

* feat: Add captureTiming method to MParticleWebSDK interface and update tests to include PerformanceMarkType for performance metrics tracking

* chore: Remove unused PerformanceMarkType import from mParticle instance manager for improved code clarity

* chore: Remove all references to PerformanceMarkType across the codebase for improved clarity and maintainability

* refactor: Use Constants for accessing Rokt launcher instance GUID in setLauncherInstanceGuid method for improved code clarity

---------

Co-authored-by: Guillermo Tamanaha <[email protected]>

Author: gtamanaha

jest.config.js

@@ -2,7 +2,7 @@ module.exports = {
     preset: 'ts-jest',
     testEnvironment: 'jsdom',
     // The built mParticle.js file needs to exist for integration tests
-    setupFiles: ['./dist/mparticle.js'],
+    setupFiles: ['./test/jest/setup.ts', './dist/mparticle.js'],
     setupFilesAfterEnv: ['jest-expect-message'],
     transform: {
         '^.+\\.(js)$': 'ts-jest',

package.json

@@ -61,7 +61,7 @@
         "test:karma:rollup:cjs": "cross-env BUNDLER=rollup karma start test/integrations/cjs/karma.rollup.config.js",
         "test:karma:webpack:module": "cross-env BUNDLER=webpack karma start test/integrations/module/karma.webpack.config.js",
         "test:karma:rollup:module": "cross-env BUNDLER=rollup karma start test/integrations/module/karma.rollup.config.js",
-        "test:jest": "jest --config jest.config.js",
+        "test:jest": "npm run build && jest --config jest.config.js",
         "test:jest:watch": "jest --config jest.config.js --watch",
         "watch": "cross-env ENVIRONMENT=dev BUILD=iife rollup --config rollup.config.js -w",
         "watch:all": "cross-env ENVIRONMENT=prod BUILDALL=true rollup --config rollup.config.js -w",

src/constants.ts

@@ -214,6 +214,9 @@ const Constants = {
         None: 'none',
         RoktOnly: 'roktonly',
     },
+    Rokt: {
+        LauncherInstanceGuidKey: '__rokt_li_guid__',
+    },
 } as const;
 
 export default Constants;

src/mp-instance.ts

@@ -89,6 +89,8 @@ export interface IMParticleWebSDKInstance extends MParticleWebSDK {
     _instanceName: string;
     _preInit: IPreInit;
     _timeOnSiteTimer: ForegroundTimer; 
+    setLauncherInstanceGuid: () => void;
+    captureTiming(metricName: string);
 }
 
 const { Messages, HTTPCodes, FeatureFlags, CaptureIntegrationSpecificIdsV2Modes } = Constants;
@@ -1341,6 +1343,20 @@ export default function mParticleInstance(this: IMParticleWebSDKInstance, instan
             };
         }
     };
+    
+    const launcherInstanceGuidKey = Constants.Rokt.LauncherInstanceGuidKey;
+    this.setLauncherInstanceGuid = function() {
+        if (!window[launcherInstanceGuidKey] 
+            || typeof window[launcherInstanceGuidKey] !== 'string') {
+            window[launcherInstanceGuidKey] = self._Helpers.generateUniqueId();
+        }
+    };
+
+    this.captureTiming = function(metricsName) {
+        if (typeof window !== 'undefined' && window.performance?.mark) {
+            window.performance.mark(metricsName);
+        }
+    }
 }
 
 // Some (server) config settings need to be returned before they are set on SDKConfig in a self hosted environment

src/mparticle-instance-manager.ts

@@ -1,5 +1,5 @@
 import Polyfill from './polyfill';
-import { CommerceEventType, EventType, IdentityType, ProductActionType, PromotionActionType } from './types';
+import { CommerceEventType, EventType, IdentityType, PerformanceMarkType, ProductActionType, PromotionActionType } from './types';
 import Constants from './constants';
 import mParticleInstance, { IMParticleWebSDKInstance } from './mp-instance.js';
 import _BatchValidator from './mockBatchCreator';
@@ -77,9 +77,15 @@ function mParticleInstanceManager(this: IMParticleInstanceManager) {
             self._instances[instanceName] = client;
         }
 
+        client.captureTiming(PerformanceMarkType.SdkStart);
+        client.setLauncherInstanceGuid();
         client.init(apiKey, config, instanceName);
     };
 
+    this.captureTiming = function(metricsName) {
+        self.getInstance().captureTiming(metricsName);
+    }
+
     this.getInstance = function getInstance(instanceName) {
         let client: IMParticleWebSDKInstance;
         if (!instanceName) {

src/sdkRuntimeModels.ts

@@ -228,6 +228,7 @@ export interface MParticleWebSDK {
     generateHash(value: string): string;
     setIntegrationAttribute(integrationModuleId: number, attrs: IntegrationAttribute): void;
     getIntegrationAttributes(integrationModuleId: number): IntegrationAttribute;
+    captureTiming(metricName: string): void;
 }
 
 // https://go.mparticle.com/work/SQDSDKS-4805

src/types.ts

@@ -391,6 +391,10 @@ export const ApplicationTransitionType = {
     AppInit: 1 as const,
 };
 
+export const PerformanceMarkType = {
+    SdkStart: 'mp:sdkStart' as const,
+}
+
 export default {
     MessageType,
     EventType,

test/jest/mparticle-instance-manager.test.ts

@@ -0,0 +1,38 @@
+import Constants from '../../src/constants';
+import { PerformanceMarkType } from '../../src/types';
+import { IMParticleInstanceManager } from '../../src/sdkRuntimeModels';
+
+const mockPerformanceMark = (globalThis as any).__mockPerformanceMark;
+const mParticle = (globalThis as any).mParticle as IMParticleInstanceManager;
+
+describe('mParticle instance manager', () => {
+    beforeEach(() => {
+        mockPerformanceMark.mockClear();
+        delete (globalThis as any)[Constants.Rokt.LauncherInstanceGuidKey];
+    });     
+
+    it('sets sdkStart event timing', async () => {
+        mParticle.init("testApiKey", {});
+        expect(mockPerformanceMark).toHaveBeenCalledWith(PerformanceMarkType.SdkStart);
+    });
+
+    it('does not capture timing if window.performance.mark is not available', () => {
+        (globalThis as any).performance.mark = undefined;
+        mParticle.init("testApiKey", {});
+        expect(mockPerformanceMark).not.toHaveBeenCalled();
+    });
+
+    it('sets rokt launcher instance guid', async () => {
+        mParticle.init("testApiKey", {});
+        expect(globalThis).toHaveProperty(Constants.Rokt.LauncherInstanceGuidKey);
+        expect(typeof globalThis[Constants.Rokt.LauncherInstanceGuidKey]).toBe('string');
+    });
+
+    it('does not set rokt launcher instance guid if it already exists', () => {
+        globalThis[Constants.Rokt.LauncherInstanceGuidKey] = 'testGuid';
+        mParticle.init("testApiKey", {});
+        expect(globalThis).toHaveProperty(Constants.Rokt.LauncherInstanceGuidKey);
+        expect(typeof globalThis[Constants.Rokt.LauncherInstanceGuidKey]).toBe('string');
+        expect(globalThis[Constants.Rokt.LauncherInstanceGuidKey]).toBe('testGuid');
+    });
+});

test/jest/setup.ts

@@ -0,0 +1,14 @@
+// Jest setup file to mock performance API before mParticle loads
+const mockPerformanceMark = jest.fn();
+
+// Extend jsdom's performance object with mark function
+if (globalThis.performance) {
+    globalThis.performance.mark = mockPerformanceMark;
+} else {
+    globalThis.performance = {
+        mark: mockPerformanceMark,
+    } as any;
+}
+
+// Make the mock available globally for tests
+globalThis.__mockPerformanceMark = mockPerformanceMark;

test/src/tests-mparticle-instance-manager.ts

@@ -215,6 +215,7 @@ describe('mParticle instance manager', () => {
             'getEnvironment',
             'upload',
             'Rokt',
+            'captureTiming',
         ]);
     });