@mparticle/web-sdk 2.23.6 → 2.23.8

package/src/forwarders.js

@@ -2,6 +2,9 @@ import Types from './types';
 import filteredMparticleUser from './filteredMparticleUser';
 import { isEmpty } from './utils';
 import KitFilterHelper from './kitFilterHelper';
+import Constants from './constants';
+
+const { Modify, Identify, Login, Logout } = Constants.IdentityMethods;
 
 export default function Forwarders(mpInstance, kitBlocker) {
     var self = this;
@@ -440,6 +443,7 @@ export default function Forwarders(mpInstance, kitBlocker) {
         });
     };
 
+    // TODO: https://go.mparticle.com/work/SQDSDKS-6036
     this.setForwarderUserIdentities = function(userIdentities) {
         mpInstance._Store.activeForwarders.forEach(function(forwarder) {
             var filteredUserIdentities = mpInstance._Helpers.filterUserIdentities(
@@ -487,30 +491,45 @@ export default function Forwarders(mpInstance, kitBlocker) {
                 mpInstance,
                 kitBlocker
             );
-            if (identityMethod === 'identify') {
+
+            const filteredUserIdentities = filteredUser.getUserIdentities();
+
+            if (identityMethod === Identify) {
                 if (forwarder.onIdentifyComplete) {
-                    result = forwarder.onIdentifyComplete(filteredUser);
+                    result = forwarder.onIdentifyComplete(
+                        filteredUser,
+                        filteredUserIdentities
+                    );
                     if (result) {
                         mpInstance.Logger.verbose(result);
                     }
                 }
-            } else if (identityMethod === 'login') {
+            } else if (identityMethod === Login) {
                 if (forwarder.onLoginComplete) {
-                    result = forwarder.onLoginComplete(filteredUser);
+                    result = forwarder.onLoginComplete(
+                        filteredUser,
+                        filteredUserIdentities
+                    );
                     if (result) {
                         mpInstance.Logger.verbose(result);
                     }
                 }
-            } else if (identityMethod === 'logout') {
+            } else if (identityMethod === Logout) {
                 if (forwarder.onLogoutComplete) {
-                    result = forwarder.onLogoutComplete(filteredUser);
+                    result = forwarder.onLogoutComplete(
+                        filteredUser,
+                        filteredUserIdentities
+                    );
                     if (result) {
                         mpInstance.Logger.verbose(result);
                     }
                 }
-            } else if (identityMethod === 'modify') {
+            } else if (identityMethod === Modify) {
                 if (forwarder.onModifyComplete) {
-                    result = forwarder.onModifyComplete(filteredUser);
+                    result = forwarder.onModifyComplete(
+                        filteredUser,
+                        filteredUserIdentities
+                    );
                     if (result) {
                         mpInstance.Logger.verbose(result);
                     }
@@ -629,43 +648,49 @@ export default function Forwarders(mpInstance, kitBlocker) {
         }
     };
 
-    // Sideloaded kits are not configured in the UI and do not have kit configurations
-    // They are automatically added to active forwarders.
+    // Unlike UI enabled kits, sideloaded kits are always added to active forwarders.
 
-    // TODO: Sideloading kits currently requires the use of a register method
+    // TODO: Sideloading kits currently require the use of a register method
     // which requires an object on which to be registered.
-    // In the future, when all kits are moved to the config rather than
+    // In the future, when all kits are moved to the mpConfig rather than
     // there being a separate process for MP configured kits and
     // sideloaded kits, this will need to be refactored.
-    this.processSideloadedKits = function(config) {
+    this.processSideloadedKits = function(mpConfig) {
         try {
-            if (Array.isArray(config.sideloadedKits)) {
-                const sideloadedKits = { kits: {} };
-                // First register each kit's constructor onto sideloadedKits,
-                // which is typed { kits: Dictionary<constructor> }.
-                // The constructors are keyed by the name of the kit.
-                config.sideloadedKits.forEach(function(sideloadedKit) {
+            if (Array.isArray(mpConfig.sideloadedKits)) {
+                const registeredSideloadedKits = { kits: {} };
+                const unregisteredSideloadedKits = mpConfig.sideloadedKits;
+
+                unregisteredSideloadedKits.forEach(function(unregisteredKit) {
                     try {
-                        sideloadedKit.kitInstance.register(sideloadedKits);
+                        // Register each sideloaded kit, which adds a key of the sideloaded kit name
+                        // and a value of the sideloaded kit constructor.
+                        unregisteredKit.kitInstance.register(
+                            registeredSideloadedKits
+                        );
+                        const kitName = unregisteredKit.kitInstance.name;
+                        // Then add the kit filters to each registered kit.
+                        registeredSideloadedKits.kits[kitName].filters =
+                            unregisteredKit.filterDictionary;
                     } catch (e) {
                         console.error(
                             'Error registering sideloaded kit ' +
-                                sideloadedKit.kitInstance.name
+                                unregisteredKit.kitInstance.name
                         );
                     }
                 });
 
-                // Then configure each kit
-                for (const registeredKitKey in sideloadedKits.kits) {
-                    const kitConstructor =
-                        sideloadedKits.kits[registeredKitKey];
-                    self.configureSideloadedKit(kitConstructor);
+                // Then configure each registered kit
+                for (const registeredKitKey in registeredSideloadedKits.kits) {
+                    const registeredKit =
+                        registeredSideloadedKits.kits[registeredKitKey];
+                    self.configureSideloadedKit(registeredKit);
                 }
 
                 // If Sideloaded Kits are successfully registered,
                 // record this in the Store.
-                if (!isEmpty(sideloadedKits.kits)) {
-                    const kitKeys = Object.keys(sideloadedKits.kits);
+                if (!isEmpty(registeredSideloadedKits.kits)) {
+                    const kitKeys = Object.keys(registeredSideloadedKits.kits);
                     mpInstance._Store.sideloadedKitsCount = kitKeys.length;
                 }
             }
@@ -680,7 +705,7 @@ export default function Forwarders(mpInstance, kitBlocker) {
     // kits can be included via mParticle UI, or via sideloaded kit config API
     this.configureSideloadedKit = function(kitConstructor) {
         mpInstance._Store.configuredForwarders.push(
-            this.returnConfiguredKit(kitConstructor)
+            this.returnConfiguredKit(kitConstructor, kitConstructor.filters)
         );
     };
 

package/src/helpers.js

@@ -99,6 +99,7 @@ export default function Helpers(mpInstance) {
         }
     };
 
+    // https://go.mparticle.com/work/SQDSDKS-6047
     // Standalone version of jQuery.extend, from https://github.com/dansdom/extend
     this.extend = function() {
         var options,

package/src/identity.js

@@ -4,6 +4,8 @@ import Types from './types';
 var Messages = Constants.Messages,
     HTTPCodes = Constants.HTTPCodes;
 
+const { Identify, Modify } = Constants.IdentityMethods;
+
 export default function Identity(mpInstance) {
     var self = this;
     this.checkIdentitySwap = function(
@@ -1476,7 +1478,7 @@ export default function Identity(mpInstance) {
             }
 
             if (xhr.status === 200) {
-                if (method === 'modify') {
+                if (method === Modify) {
                     newIdentitiesByType = mpInstance._Identity.IdentityRequest.combineUserIdentities(
                         previousUIByName,
                         identityApiData.userIdentities
@@ -1507,7 +1509,7 @@ export default function Identity(mpInstance) {
                     //will not have a value for "fst" until the current MPID changes, and in some cases,
                     //the current MPID will never change
                     if (
-                        method === 'identify' &&
+                        method === Identify &&
                         prevUser &&
                         identityApiResult.mpid === prevUser.getMPID()
                     ) {
@@ -1568,6 +1570,7 @@ export default function Identity(mpInstance) {
                         );
                     }
 
+                    // https://go.mparticle.com/work/SQDSDKS-6041
                     mpInstance._Persistence.saveUserIdentitiesToPersistence(
                         identityApiResult.mpid,
                         newIdentitiesByType
@@ -1620,6 +1623,8 @@ export default function Identity(mpInstance) {
                             mpInstance._APIClient.prepareForwardingStats
                         );
                     }
+
+                    // TODO: https://go.mparticle.com/work/SQDSDKS-6036
                     mpInstance._Forwarders.setForwarderUserIdentities(
                         newUser.getUserIdentities().userIdentities
                     );
@@ -1628,8 +1633,7 @@ export default function Identity(mpInstance) {
                         method
                     );
                     mpInstance._Forwarders.setForwarderOnUserIdentified(
-                        newUser,
-                        method
+                        newUser
                     );
                 }
                 var newIdentitiesByName = {};
@@ -1646,7 +1650,7 @@ export default function Identity(mpInstance) {
                     newIdentitiesByName,
                     method,
                     identityApiResult.mpid,
-                    method === 'modify'
+                    method === Modify
                         ? previousUIByNameCopy
                         : incomingMpidUIByNameCopy
                 );

package/src/identityApiClient.js

@@ -3,6 +3,8 @@ import Constants from './constants';
 var HTTPCodes = Constants.HTTPCodes,
     Messages = Constants.Messages;
 
+const { Modify } = Constants.IdentityMethods;
+
 export default function IdentityAPIClient(mpInstance) {
     this.sendAliasRequest = function(aliasRequest, callback) {
         var xhr,
@@ -107,7 +109,7 @@ export default function IdentityAPIClient(mpInstance) {
                     );
                 } else {
                     previousMPID = mpid || null;
-                    if (method === 'modify') {
+                    if (method === Modify) {
                         xhr.open(
                             'post',
                             mpInstance._Helpers.createServiceUrl(

package/src/mp-instance.js

@@ -1330,6 +1330,7 @@ function completeSDKInitialization(apiKey, config, mpInstance) {
 
     mpInstance._Store.configurationLoaded = true;
 
+    // https://go.mparticle.com/work/SQDSDKS-6044
     if (!mpInstance._Store.webviewBridgeEnabled) {
         // Load any settings/identities/attributes from cookie or localStorage
         mpInstance._Persistence.initializeStorage();
@@ -1401,6 +1402,7 @@ function completeSDKInitialization(apiKey, config, mpInstance) {
         mpInstance._Events.logAST();
 
         // Call mParticle._Store.SDKConfig.identityCallback when identify was not called due to a reload or a sessionId already existing
+        // Any identity callback should always be ran regardless if an identity call is made
         if (
             !mpInstance._Store.identifyCalled &&
             mpInstance._Store.SDKConfig.identityCallback &&
@@ -1455,6 +1457,7 @@ function completeSDKInitialization(apiKey, config, mpInstance) {
         mpInstance._preInit.readyQueue = [];
     }
 
+    // https://go.mparticle.com/work/SQDSDKS-6040
     if (mpInstance._Store.isFirstRun) {
         mpInstance._Store.isFirstRun = false;
     }

package/src/persistence.js

@@ -10,6 +10,8 @@ var Base64 = Polyfill.Base64,
 
 export default function _Persistence(mpInstance) {
     var self = this;
+
+    // https://go.mparticle.com/work/SQDSDKS-5022
     this.useLocalStorage = function() {
         return (
             !mpInstance._Store.SDKConfig.useCookieStorage &&
@@ -24,6 +26,7 @@ export default function _Persistence(mpInstance) {
                 cookies = self.getCookie(),
                 allData;
 
+            // https://go.mparticle.com/work/SQDSDKS-6045
             // Determine if there is any data in cookies or localStorage to figure out if it is the first time the browser is loading mParticle
             if (!localStorageData && !cookies) {
                 mpInstance._Store.isFirstRun = true;
@@ -32,10 +35,12 @@ export default function _Persistence(mpInstance) {
                 mpInstance._Store.isFirstRun = false;
             }
 
+            // https://go.mparticle.com/work/SQDSDKS-6045
             if (!mpInstance._Store.isLocalStorageAvailable) {
                 mpInstance._Store.SDKConfig.useCookieStorage = true;
             }
 
+            // https://go.mparticle.com/work/SQDSDKS-6046
             if (mpInstance._Store.isLocalStorageAvailable) {
                 storage = window.localStorage;
                 if (mpInstance._Store.SDKConfig.useCookieStorage) {
@@ -43,6 +48,7 @@ export default function _Persistence(mpInstance) {
                     // no mParticle cookie exists yet and there is localStorage. Get the localStorage, set them to cookies, then delete the localStorage item.
                     if (localStorageData) {
                         if (cookies) {
+                            // https://go.mparticle.com/work/SQDSDKS-6047
                             allData = mpInstance._Helpers.extend(
                                 false,
                                 localStorageData,
@@ -61,6 +67,7 @@ export default function _Persistence(mpInstance) {
                     // no mParticle localStorage exists yet and there are cookies. Get the cookies, set them to localStorage, then delete the cookies.
                     if (cookies) {
                         if (localStorageData) {
+                            // https://go.mparticle.com/work/SQDSDKS-6047
                             allData = mpInstance._Helpers.extend(
                                 false,
                                 localStorageData,
@@ -79,6 +86,7 @@ export default function _Persistence(mpInstance) {
                 self.storeDataInMemory(cookies);
             }
 
+            // https://go.mparticle.com/work/SQDSDKS-6048
             try {
                 if (mpInstance._Store.isLocalStorageAvailable) {
                     var encodedProducts = localStorage.getItem(
@@ -107,6 +115,8 @@ export default function _Persistence(mpInstance) {
                 );
             }
 
+            // https://go.mparticle.com/work/SQDSDKS-6046
+            // Stores all non-current user MPID information into the store
             for (var key in allData) {
                 if (allData.hasOwnProperty(key)) {
                     if (!SDKv2NonMPIDCookieKeys[key]) {
@@ -117,6 +127,8 @@ export default function _Persistence(mpInstance) {
             }
             self.update();
         } catch (e) {
+            // If cookies or local storage is corrupt, we want to remove it
+            // so that in the future, initializeStorage will work
             if (
                 self.useLocalStorage() &&
                 mpInstance._Store.isLocalStorageAvailable
@@ -154,6 +166,7 @@ export default function _Persistence(mpInstance) {
         }
     };
 
+    // https://go.mparticle.com/work/SQDSDKS-6045
     this.storeDataInMemory = function(obj, currentMPID) {
         try {
             if (!obj) {
@@ -235,6 +248,7 @@ export default function _Persistence(mpInstance) {
         }
     };
 
+    // https://go.mparticle.com/work/SQDSDKS-5022
     this.determineLocalStorageAvailability = function(storage) {
         var result;
 
@@ -310,6 +324,7 @@ export default function _Persistence(mpInstance) {
         return parsedDecodedProducts;
     };
 
+    // https://go.mparticle.com/work/SQDSDKS-6021
     this.setLocalStorage = function() {
         if (!mpInstance._Store.isLocalStorageAvailable) {
             return;
@@ -492,7 +507,8 @@ export default function _Persistence(mpInstance) {
         }
     };
 
-    // only used in persistence
+    // https://go.mparticle.com/work/SQDSDKS-5022
+    // https://go.mparticle.com/work/SQDSDKS-6021
     this.setCookie = function() {
         var mpid,
             currentUser = mpInstance.Identity.getCurrentUser();
@@ -996,6 +1012,7 @@ export default function _Persistence(mpInstance) {
         }
     };
 
+    // https://go.mparticle.com/work/SQDSDKS-6021
     this.savePersistence = function(persistence) {
         var encodedPersistence = self.encodePersistence(
                 JSON.stringify(persistence)
@@ -1168,6 +1185,7 @@ export default function _Persistence(mpInstance) {
         }
     };
 
+    // https://go.mparticle.com/work/SQDSDKS-6045
     // Forwarder Batching Code
     this.forwardingStatsBatches = {
         uploadsTable: {},

package/src/sdkRuntimeModels.ts

@@ -10,6 +10,7 @@ import { SDKConsentApi, SDKConsentState } from './consent';
 import { IPersistence } from './persistence.interfaces';
 import { IMPSideloadedKit } from './sideloadedKit';
 import { ISessionManager } from './sessionManager';
+import { Kit, MPForwarder } from './forwarders.interfaces';
 
 // TODO: Resolve this with version in @mparticle/web-sdk
 export type SDKEventCustomFlags = Dictionary<any>;
@@ -184,10 +185,6 @@ export type BooleanStringTitleCase = 'False' | 'True';
 
 export type LogLevelType = 'none' | 'verbose' | 'warning' | 'error';
 
-// TODO: Create true types for Kits and Kit Configs
-export type Kit = Dictionary;
-export type MPForwarder = Dictionary;
-
 // TODO: This should eventually be moved into wherever init logic lives
 // TODO: Replace/Merge this with MPConfiguration in @types/mparticle__web-sdk
 // SDK Init Config represents the config that is passed into mParticle.init when

package/src/serverModel.ts

@@ -13,7 +13,12 @@ import {
     SDKProduct,
     SDKUserIdentity,
 } from './sdkRuntimeModels';
-import { parseNumber, parseStringOrNumber, Dictionary } from './utils';
+import {
+    parseNumber,
+    parseStringOrNumber,
+    Dictionary,
+    isValidCustomFlagProperty,
+} from './utils';
 import { ServerSettings } from './store';
 import { MPID } from '@mparticle/web-sdk';
 import {
@@ -145,22 +150,12 @@ function convertCustomFlags(event: SDKEvent, dto: IServerV2DTO) {
 
         if (event.CustomFlags.hasOwnProperty(prop)) {
             if (Array.isArray(event.CustomFlags[prop])) {
-                event.CustomFlags[prop].forEach(function(customFlagProperty) {
-                    // TODO: Can we use our utility functions here?
-                    if (
-                        typeof customFlagProperty === 'number' ||
-                        typeof customFlagProperty === 'string' ||
-                        typeof customFlagProperty === 'boolean'
-                    ) {
+                event.CustomFlags[prop].forEach(customFlagProperty => {
+                    if (isValidCustomFlagProperty(customFlagProperty)) {
                         valueArray.push(customFlagProperty.toString());
                     }
                 });
-            } else if (
-                // TODO: Can we use our utility functions here?
-                typeof event.CustomFlags[prop] === 'number' ||
-                typeof event.CustomFlags[prop] === 'string' ||
-                typeof event.CustomFlags[prop] === 'boolean'
-            ) {
+            } else if (isValidCustomFlagProperty(event.CustomFlags[prop])) {
                 valueArray.push(event.CustomFlags[prop].toString());
             }
 

package/src/sessionManager.ts

@@ -44,6 +44,7 @@ export default function SessionManager(
                 self.endSession();
                 self.startNewSession();
             } else {
+                // https://go.mparticle.com/work/SQDSDKS-6045
                 const persistence: IPersistenceMinified = mpInstance._Persistence.getPersistence();
                 if (persistence && !persistence.cu) {
                     mpInstance.Identity.identify(

package/src/store.ts

@@ -11,11 +11,9 @@ import { IKitConfigs } from './configAPIClient';
 import Constants from './constants';
 import {
     DataPlanResult,
-    Kit,
     KitBlockerOptions,
     LogLevelType,
     MParticleWebSDK,
-    MPForwarder,
     SDKDataPlan,
     SDKEvent,
     SDKGeoLocation,
@@ -24,6 +22,7 @@ import {
 } from './sdkRuntimeModels';
 import { isNumber, isDataPlanSlug, Dictionary } from './utils';
 import { SDKConsentState } from './consent';
+import { Kit, MPForwarder } from './forwarders.interfaces';
 
 // This represents the runtime configuration of the SDK AFTER
 // initialization has been complete and all settings and

package/src/types.js

@@ -17,7 +17,6 @@ var MessageType = {
 // trigger an immediate upload.
 var TriggerUploadType = {
     [MessageType.Commerce]: 1,
-    [MessageType.UserAttributeChange]: 1,
     [MessageType.UserIdentityChange]: 1,
 };
 

package/src/utils.ts

@@ -201,7 +201,10 @@ const converted = (s: string): string => {
 
 const isString = (value: any): boolean => typeof value === 'string';
 const isNumber = (value: any): boolean => typeof value === 'number';
+const isBoolean = (value: any): boolean => typeof value === 'boolean';
 const isFunction = (fn: any): boolean => typeof fn === 'function';
+const isValidCustomFlagProperty = (value: any): boolean =>
+    isNumber(value) || isString(value) || isBoolean(value);
 
 const toDataPlanSlug = (value: any): string =>
     // Make sure we are only acting on strings or numbers
@@ -247,4 +250,5 @@ export {
     isFunction,
     isDataPlanSlug,
     isEmpty,
+    isValidCustomFlagProperty,
 };

package/src/validators.ts

@@ -1,5 +1,11 @@
 import Types from './types';
-import { isFunction, isNumber, isObject, isStringOrNumber, valueof } from './utils';
+import {
+    isFunction,
+    isNumber,
+    isObject,
+    isStringOrNumber,
+    valueof,
+} from './utils';
 import Constants from './constants';
 import { IdentityApiData } from '@mparticle/web-sdk';
 
@@ -10,6 +16,8 @@ type ValidationIdentitiesReturn = {
     error?: valueof<typeof Constants.Messages.ValidationMessages>;
 };
 
+const { Modify } = Constants.IdentityMethods;
+
 const Validators = {
     // From ./utils
     // Utility Functions for backwards compatability
@@ -43,7 +51,7 @@ const Validators = {
             copyUserAttributes: 1,
         };
         if (identityApiData) {
-            if (method === 'modify') {
+            if (method === Modify) {
                 if (
                     (isObject(identityApiData.userIdentities) &&
                         !Object.keys(identityApiData.userIdentities).length) ||