@mparticle/web-sdk 3.13.0 → 3.15.0

package/dist/types/src/integrationCapture.d.ts

@@ -20,6 +20,7 @@ interface IntegrationMappingItem {
 interface IntegrationIdMapping {
     [key: string]: IntegrationMappingItem;
 }
+export declare function isIntegrationCaptureEnabled(getFeatureFlag: (feature: string) => unknown): boolean;
 export default class IntegrationCapture {
     clickIds: Dictionary<string>;
     readonly initialTimestamp: number;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@mparticle/web-sdk",
-    "version": "3.13.0",
+    "version": "3.15.0",
     "description": "mParticle core SDK for web applications",
     "license": "Apache-2.0",
     "keywords": [

package/src/batchUploader.ts

@@ -15,6 +15,7 @@ import { IMParticleUser } from './identity-user-interfaces';
 import { IMParticleWebSDKInstance } from './mp-instance';
 import { appendUserInfo } from './user-utils';
 import { IntegrationAttributes } from './store';
+import { isIntegrationCaptureEnabled } from './integrationCapture';
 /**
  * BatchUploader contains all the logic to store/retrieve events and batches
  * to/from persistence, and upload batches to mParticle.
@@ -205,12 +206,9 @@ export class BatchUploader {
 
         let customFlags: SDKEventCustomFlags = {...event.CustomFlags};
         let integrationAttributes: IntegrationAttributes = _Store.integrationAttributes;
-        const integrationSpecificIds = getFeatureFlag(Constants.FeatureFlags.CaptureIntegrationSpecificIds) as boolean;
-        const integrationSpecificIdsV2 = getFeatureFlag(Constants.FeatureFlags.CaptureIntegrationSpecificIdsV2) as string || '';
-        const isIntegrationCaptureEnabled = (integrationSpecificIdsV2 && integrationSpecificIdsV2 !== Constants.CaptureIntegrationSpecificIdsV2Modes.None) || integrationSpecificIds === true;
 
         // https://go.mparticle.com/work/SQDSDKS-5053
-        if (isIntegrationCaptureEnabled) {
+        if (isIntegrationCaptureEnabled(getFeatureFlag)) {
 
             // Attempt to recapture click IDs in case a third party integration
             // has added or updated  new click IDs since the last event was sent.

package/src/integrationCapture.ts

@@ -160,6 +160,26 @@ const integrationMappingRokt: IntegrationIdMapping = {
     },
 };
 
+export function isIntegrationCaptureEnabled(
+    getFeatureFlag: (feature: string) => unknown
+): boolean {
+    if (!getFeatureFlag) {
+        return false;
+    }
+    const integrationSpecificIds = getFeatureFlag(
+        Constants.FeatureFlags.CaptureIntegrationSpecificIds
+    );
+    const integrationSpecificIdsV2 = getFeatureFlag(
+        Constants.FeatureFlags.CaptureIntegrationSpecificIdsV2
+    );
+    return (
+        (!!integrationSpecificIdsV2 &&
+            integrationSpecificIdsV2 !==
+                Constants.CaptureIntegrationSpecificIdsV2Modes.None) ||
+        integrationSpecificIds === true
+    );
+}
+
 export default class IntegrationCapture {
     public clickIds: Dictionary<string>;
     public readonly initialTimestamp: number;

package/src/kitBlocking.ts

@@ -390,10 +390,14 @@ export default class KitBlocker {
                 return clonedEvent;
             }
             if (matchedEvent) {
-                for (const key of Object.keys(clonedEvent.EventAttributes ?? {})) {
-                    if (!matchedEvent[key]) {
-                        delete clonedEvent.EventAttributes[key];
+                if (clonedEvent.EventAttributes) {
+                    const plannedEventAttributes = {};
+                    for (const key of Object.keys(clonedEvent.EventAttributes)) {
+                        if (matchedEvent[key] === true) {
+                            plannedEventAttributes[key] = clonedEvent.EventAttributes[key];
+                        }
                     }
+                    clonedEvent.EventAttributes = plannedEventAttributes;
                 }
                 return clonedEvent;
             } else {

package/src/mp-instance.ts

@@ -42,7 +42,7 @@ import IdentityAPIClient, { IIdentityApiClient } from './identityApiClient';
 import { isFunction, parseConfig, valueof, generateDeprecationMessage, extend } from './utils';
 import { DisabledVault, LocalStorageVault } from './vault';
 import { removeExpiredIdentityCacheDates, hasExplicitIdentifier } from './identity-utils';
-import IntegrationCapture from './integrationCapture';
+import IntegrationCapture, { isIntegrationCaptureEnabled } from './integrationCapture';
 import { IPreInit, processReadyQueue } from './pre-init-utils';
 import { BaseEvent, MParticleWebSDK, SDKHelpersApi } from './sdkRuntimeModels';
 import { Dictionary, SDKEventAttrs } from '@mparticle/web-sdk';
@@ -1389,11 +1389,9 @@ function completeSDKInitialization(apiKey, config, mpInstance) {
             mpInstance._ForwardingStatsUploader.startForwardingStatsTimer();
         }
         // https://go.mparticle.com/work/SQDSDKS-7639
-        const integrationSpecificIds = getFeatureFlag(CaptureIntegrationSpecificIds) as boolean;
-        const integrationSpecificIdsV2 = getFeatureFlag(CaptureIntegrationSpecificIdsV2) as string;
-        
-        const isIntegrationCaptureEnabled = (integrationSpecificIdsV2 && integrationSpecificIdsV2 !== CaptureIntegrationSpecificIdsV2Modes.None) || integrationSpecificIds === true;
-        if (isIntegrationCaptureEnabled) {
+        if (isIntegrationCaptureEnabled(getFeatureFlag)) {
+            const integrationSpecificIds = getFeatureFlag(CaptureIntegrationSpecificIds) as boolean;
+            const integrationSpecificIdsV2 = getFeatureFlag(CaptureIntegrationSpecificIdsV2) as string;
             let captureMode: valueof<typeof CaptureIntegrationSpecificIdsV2Modes> | undefined;
             if (integrationSpecificIds || integrationSpecificIdsV2 === CaptureIntegrationSpecificIdsV2Modes.All) {
                 captureMode = 'all';

package/src/persistence.ts

@@ -362,36 +362,28 @@ export default function _Persistence(
         return data;
     }
 
-    this.getLocalStorage = function(): IPersistenceMinified | null {
-        if (!mpInstance._Store.isLocalStorageAvailable) {
+    function parsePersistenceRecord(
+        raw: string | null
+    ): IPersistenceMinified | null {
+        const decoded = self.decodePersistence(raw);
+        if (!decoded) {
             return null;
         }
+        const record = JSON.parse(decoded);
+        return mpInstance._Helpers.isObject(record) &&
+            Object.keys(record).length
+            ? (record as IPersistenceMinified)
+            : null;
+    }
 
-        const key = mpInstance._Store.storageName;
-        const decodedPersistence = self.decodePersistence(
-            window.localStorage.getItem(key)
-        );
-
-        if (!decodedPersistence) {
+    this.getLocalStorage = function(): IPersistenceMinified | null {
+        if (!mpInstance._Store.isLocalStorageAvailable) {
             return null;
         }
 
-        const parsedPersistence = JSON.parse(
-            decodedPersistence
-        ) as IPersistenceMinified;
-        const obj: IPersistenceMinified = {} as IPersistenceMinified;
-
-        for (const key in parsedPersistence) {
-            if (parsedPersistence.hasOwnProperty(key)) {
-                obj[key] = parsedPersistence[key];
-            }
-        }
-
-        if (Object.keys(obj).length) {
-            return obj;
-        }
-
-        return null;
+        return parsePersistenceRecord(
+            window.localStorage.getItem(mpInstance._Store.storageName)
+        );
     };
 
     this.expireCookies = function(cookieName: string): void {
@@ -443,14 +435,11 @@ export default function _Persistence(
             }
 
             if (key && key === name) {
-                const decodedPersistence = self.decodePersistence(
+                const persistence = parsePersistenceRecord(
                     (mpInstance._Helpers as Dictionary).converted(cookie)
                 );
-                const persistence = decodedPersistence
-                    ? JSON.parse(decodedPersistence)
-                    : null;
 
-                if (mpInstance._Helpers.isObject(persistence)) {
+                if (persistence) {
                     mpInstance.Logger.verbose(
                         Messages.InformationMessages.CookieFound
                     );

package/src/sdkToEventsApiConverter.ts

@@ -15,14 +15,8 @@ import Types, { getEventCategoryFromCustomEventType } from './types';
 import { Dictionary, isEmpty } from './utils';
 import { ISDKUserIdentity } from './identity-user-interfaces';
 import { SDKIdentityTypeEnum } from './identity.interfaces';
-import Constants from './constants';
 import { IMParticleWebSDKInstance } from './mp-instance';
-
-const { FeatureFlags } = Constants;
-const {
-    CaptureIntegrationSpecificIds, 
-    CaptureIntegrationSpecificIdsV2,
-} = FeatureFlags;
+import { isIntegrationCaptureEnabled } from './integrationCapture';
 
 type PartnerIdentities = Dictionary<string>;
 
@@ -127,12 +121,7 @@ export function convertEvents(
         };
     }
     // https://go.mparticle.com/work/SQDSDKS-7639
-    const integrationSpecificIds = getFeatureFlag && Boolean(getFeatureFlag(CaptureIntegrationSpecificIds));
-    const integrationSpecificIdsV2 = getFeatureFlag && (getFeatureFlag(CaptureIntegrationSpecificIdsV2) as string);
-        
-    const isIntegrationCaptureEnabled = (integrationSpecificIdsV2 && integrationSpecificIdsV2 !== Constants.CaptureIntegrationSpecificIdsV2Modes.None) || integrationSpecificIds === true;
-
-    if (isIntegrationCaptureEnabled) {
+    if (isIntegrationCaptureEnabled(getFeatureFlag)) {
         _IntegrationCapture?.capture();
         const capturedPartnerIdentities: PartnerIdentities = _IntegrationCapture?.getClickIdsAsPartnerIdentities();
         if (!isEmpty(capturedPartnerIdentities)) {

package/src/serverModel.ts

@@ -30,6 +30,7 @@ import {
 import { IMParticleUser, ISDKUserIdentity } from './identity-user-interfaces';
 import { IMParticleWebSDKInstance } from './mp-instance';
 import { appendUserInfo } from './user-utils';
+import { isIntegrationCaptureEnabled } from './integrationCapture';
 
 const MessageType = Types.MessageType;
 const ApplicationTransitionType = Types.ApplicationTransitionType;
@@ -281,10 +282,7 @@ export default function ServerModel(
             const { getFeatureFlag } = mpInstance._Helpers;
             // https://go.mparticle.com/work/SQDSDKS-5053
             // https://go.mparticle.com/work/SQDSDKS-7639
-            const integrationSpecificIds = getFeatureFlag && (getFeatureFlag(Constants.FeatureFlags.CaptureIntegrationSpecificIds) as boolean);
-            const integrationSpecificIdsV2 = getFeatureFlag && ((getFeatureFlag(Constants.FeatureFlags.CaptureIntegrationSpecificIdsV2) as string) || '');
-            const isIntegrationCaptureEnabled = (integrationSpecificIdsV2 && integrationSpecificIdsV2 !== Constants.CaptureIntegrationSpecificIdsV2Modes.None) || integrationSpecificIds === true;     
-            if (isIntegrationCaptureEnabled) {
+            if (isIntegrationCaptureEnabled(getFeatureFlag)) {
                 // Attempt to recapture click IDs in case a third party integration
                 // has added or updated  new click IDs since the last event was sent.
                 mpInstance._IntegrationCapture.capture();