Merge branch 'development' into fix/SDKE-846-identity-select-placements

Author: alexs-mparticle

src/mp-instance.ts

@@ -1438,7 +1438,8 @@ function completeSDKInitialization(apiKey, config, mpInstance) {
                 mpInstance.Identity,
                 mpInstance._Store,
                 mpInstance.Logger,
-                roktOptions
+                roktOptions,
+                mpInstance.captureTiming
             );
         }
 

src/roktManager.ts

@@ -14,7 +14,7 @@ import { SDKIdentityApi } from "./identity.interfaces";
 import { SDKLoggerApi } from "./sdkRuntimeModels";
 import { IStore, LocalSessionAttributes } from "./store";
 import { UserIdentities } from "@mparticle/web-sdk";
-import { IdentityType } from "./types";
+import { IdentityType, PerformanceMarkType } from "./types";
 
 // https://docs.rokt.com/developers/integration-guides/web/library/attributes
 export type RoktAttributeValueArray = Array<string | number | boolean>;
@@ -101,7 +101,7 @@ export default class RoktManager {
     private logger: SDKLoggerApi;
     private domain?: string;
     private mappedEmailShaIdentityType?: string | null;
-    
+    private captureTiming?: (metricsName: string) => void;
     /**
      * Initializes the RoktManager with configuration settings and user data.
      * 
@@ -110,6 +110,7 @@ export default class RoktManager {
      * @param {SDKIdentityApi} identityService - The mParticle Identity instance
      * @param {SDKLoggerApi} logger - The mParticle Logger instance
      * @param {IRoktOptions} options - Options for the RoktManager
+     * @param {Function} captureTiming - Function to capture performance timing marks
      * 
      * @throws Logs error to console if placementAttributesMapping parsing fails
      */
@@ -119,7 +120,8 @@ export default class RoktManager {
         identityService: SDKIdentityApi,
         store: IStore,
         logger?: SDKLoggerApi,
-        options?: IRoktOptions
+        options?: IRoktOptions,
+        captureTiming?: (metricsName: string) => void
     ): void {
         const { userAttributeFilters, settings } = roktConfig || {};
         const { placementAttributesMapping, hashedEmailUserIdentityType } = settings || {};
@@ -128,6 +130,7 @@ export default class RoktManager {
         this.identityService = identityService;
         this.store = store;
         this.logger = logger;
+        this.captureTiming = captureTiming;
 
         this.filters = {
             userAttributeFilters,
@@ -177,6 +180,10 @@ export default class RoktManager {
      * });
      */
     public async selectPlacements(options: IRoktSelectPlacementsOptions): Promise<IRoktSelection> {
+        if (this.captureTiming) {
+            this.captureTiming(PerformanceMarkType.JointSdkSelectPlacements);
+        }
+        
         // Queue if kit isn't ready OR if identity is in flight
         if (!this.isReady() || this.store?.identityCallInFlight) {
             return this.deferredCall<IRoktSelection>('selectPlacements', options);
@@ -556,4 +563,4 @@ export default class RoktManager {
 
         return false; // Values are the same
     }
-}
+}

src/types.ts

@@ -393,6 +393,7 @@ export const ApplicationTransitionType = {
 
 export const PerformanceMarkType = {
     SdkStart: 'mp:sdkStart' as const,
+    JointSdkSelectPlacements: 'mp:jointSdkSelectPlacements' as const,
 }
 
 export default {

test/jest/roktManager.spec.ts

@@ -5,6 +5,7 @@ import { IMParticleWebSDKInstance } from "../../src/mp-instance";
 import RoktManager, { IRoktKit, IRoktSelectPlacementsOptions } from "../../src/roktManager";
 import { IStore } from "../../src/store";
 import { testMPID } from '../src/config/constants';
+import { PerformanceMarkType } from "../../src/types";
 
 const resolvePromise = () => new Promise(resolve => setTimeout(resolve, 0));
 
@@ -802,6 +803,66 @@ describe('RoktManager', () => {
             jest.clearAllMocks();
         });
 
+        it('should capture jointSdkSelectPlacements timing when selectPlacements is called', () => {
+            const mockCaptureTiming = jest.fn();
+            roktManager.init(
+                {} as IKitConfigs,
+                {} as IMParticleUser,
+                mockMPInstance.Identity,
+                mockMPInstance._Store,
+                mockMPInstance.Logger,
+                undefined,
+                mockCaptureTiming
+            );
+ 
+            const kit: IRoktKit = {
+                launcher: {
+                    selectPlacements: jest.fn(),
+                    hashAttributes: jest.fn(),
+                    use: jest.fn(),
+                },
+                filters: undefined,
+                filteredUser: undefined,
+                userAttributes: undefined,
+                selectPlacements: jest.fn(),
+                hashAttributes: jest.fn(),
+                setExtensionData: jest.fn(),
+                use: jest.fn(),
+            };
+ 
+            roktManager.attachKit(kit);
+ 
+            const options = {
+                attributes: {}
+            } as IRoktSelectPlacementsOptions;
+ 
+            roktManager.selectPlacements(options);
+            expect(mockCaptureTiming).toHaveBeenCalledWith(PerformanceMarkType.JointSdkSelectPlacements);
+            expect(mockCaptureTiming).toHaveBeenCalledTimes(1);
+        });
+ 
+        it('should capture jointSdkSelectPlacements timing even when kit is not ready (deferred call)', () => {
+            const mockCaptureTiming = jest.fn();
+            roktManager.init(
+                {} as IKitConfigs,
+                {} as IMParticleUser,
+                mockMPInstance.Identity,
+                mockMPInstance._Store,
+                mockMPInstance.Logger,
+                undefined,
+                mockCaptureTiming
+            );
+ 
+            const options = {
+                attributes: {}
+            } as IRoktSelectPlacementsOptions;
+ 
+            roktManager.selectPlacements(options);
+            expect(mockCaptureTiming).toHaveBeenCalledWith(PerformanceMarkType.JointSdkSelectPlacements);
+            expect(mockCaptureTiming).toHaveBeenCalledTimes(1);
+        });
+ 
+
         it('should call kit.selectPlacements with empty attributes', () => {
             const kit: IRoktKit = {
                 launcher: {