@mparticle/web-sdk 2.26.2 → 2.26.3

package/package.json

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

package/src/identity.js

@@ -6,27 +6,32 @@ import {
     tryCacheIdentity,
 } from './identity-utils';
 import AudienceManager from './audienceManager';
-const { Messages, HTTPCodes, FeatureFlags, IdentityMethods } = Constants;
+
+const { Messages, HTTPCodes, FeatureFlags } = Constants;
 const { ErrorMessages } = Messages;
-const { CacheIdentity } = FeatureFlags;
-const { Identify, Modify, Login, Logout } = IdentityMethods;
-import {
-    generateDeprecationMessage,
-    isEmpty,
-    isFunction,
-    isObject,
-} from './utils';
-import { didUserChange } from './user-utils';
-import { getNewIdentitiesByName } from './type-utils';
 
-export default function Identity(mpInstance) {
-    const { getFeatureFlag, extend } = mpInstance._Helpers;
+const { Identify, Modify, Login, Logout } = Constants.IdentityMethods;
 
+export default function Identity(mpInstance) {
     var self = this;
     this.idCache = null;
     this.audienceManager = null;
 
-    // https://go.mparticle.com/work/SQDSDKS-6353
+    this.checkIdentitySwap = function(
+        previousMPID,
+        currentMPID,
+        currentSessionMPIDs
+    ) {
+        if (previousMPID && currentMPID && previousMPID !== currentMPID) {
+            var persistence = mpInstance._Persistence.getPersistence();
+            if (persistence) {
+                persistence.cu = currentMPID;
+                persistence.gs.csm = currentSessionMPIDs;
+                mpInstance._Persistence.savePersistence(persistence);
+            }
+        }
+    };
+
     this.IdentityRequest = {
         preProcessIdentityRequest: function(identityApiData, callback, method) {
             mpInstance.Logger.verbose(
@@ -130,9 +135,9 @@ export default function Identity(mpInstance) {
             var key;
             if (
                 newIdentities &&
-                isObject(newIdentities) &&
+                mpInstance._Helpers.isObject(newIdentities) &&
                 previousIdentities &&
-                isObject(previousIdentities)
+                mpInstance._Helpers.isObject(previousIdentities)
             ) {
                 for (key in newIdentities) {
                     identityChanges.push({
@@ -149,7 +154,11 @@ export default function Identity(mpInstance) {
         // takes 2 UI objects keyed by name, combines them, returns them keyed by type
         combineUserIdentities: function(previousUIByName, newUIByName) {
             var combinedUIByType = {};
-            var combinedUIByName = extend({}, previousUIByName, newUIByName);
+
+            var combinedUIByName = mpInstance._Helpers.extend(
+                previousUIByName,
+                newUIByName
+            );
 
             for (var key in combinedUIByName) {
                 var type = Types.IdentityType.getIdentityType(key);
@@ -223,7 +232,6 @@ export default function Identity(mpInstance) {
          * @param {Function} [callback] A callback function that is called when the identify request completes
          */
         identify: function(identityApiData, callback) {
-            // https://go.mparticle.com/work/SQDSDKS-6337
             var mpid,
                 currentUser = mpInstance.Identity.getCurrentUser(),
                 preProcessResult = mpInstance._Identity.IdentityRequest.preProcessIdentityRequest(
@@ -317,7 +325,6 @@ export default function Identity(mpInstance) {
          * @param {Function} [callback] A callback function that is called when the logout request completes
          */
         logout: function(identityApiData, callback) {
-            // https://go.mparticle.com/work/SQDSDKS-6337
             var mpid,
                 currentUser = mpInstance.Identity.getCurrentUser(),
                 preProcessResult = mpInstance._Identity.IdentityRequest.preProcessIdentityRequest(
@@ -407,7 +414,6 @@ export default function Identity(mpInstance) {
          * @param {Function} [callback] A callback function that is called when the login request completes
          */
         login: function(identityApiData, callback) {
-            // https://go.mparticle.com/work/SQDSDKS-6337
             var mpid,
                 currentUser = mpInstance.Identity.getCurrentUser(),
                 preProcessResult = mpInstance._Identity.IdentityRequest.preProcessIdentityRequest(
@@ -503,7 +509,6 @@ export default function Identity(mpInstance) {
          * @param {Function} [callback] A callback function that is called when the modify request completes
          */
         modify: function(identityApiData, callback) {
-            // https://go.mparticle.com/work/SQDSDKS-6337
             var mpid,
                 currentUser = mpInstance.Identity.getCurrentUser(),
                 preProcessResult = mpInstance._Identity.IdentityRequest.preProcessIdentityRequest(
@@ -791,7 +796,6 @@ export default function Identity(mpInstance) {
         },
     };
 
-    // https://go.mparticle.com/work/SQDSDKS-6354
     /**
      * Invoke these methods on the mParticle.Identity.getCurrentUser() object.
      * Example: mParticle.Identity.getCurrentUser().getAllUserAttributes()
@@ -951,7 +955,7 @@ export default function Identity(mpInstance) {
              */
             setUserAttributes: function(userAttributes) {
                 mpInstance._SessionManager.resetSessionTimer();
-                if (isObject(userAttributes)) {
+                if (mpInstance._Helpers.isObject(userAttributes)) {
                     if (mpInstance._Helpers.canLog()) {
                         for (var key in userAttributes) {
                             if (userAttributes.hasOwnProperty(key)) {
@@ -1476,7 +1480,6 @@ export default function Identity(mpInstance) {
         };
     };
 
-    // https://go.mparticle.com/work/SQDSDKS-6355
     this.parseIdentityResponse = function(
         xhr,
         previousMPID,
@@ -1486,46 +1489,64 @@ export default function Identity(mpInstance) {
         knownIdentities,
         parsingCachedResponse
     ) {
-        const prevUser = mpInstance.Identity.getUser(previousMPID);
-        const prevUserMPID = prevUser ? prevUser.getMPID() : null;
-        const previousUIByName = prevUser
-            ? prevUser.getUserIdentities().userIdentities
-            : {};
-
-        let identityApiResult;
-
-        let newUser;
-        let newIdentitiesByType = {};
-
+        var prevUser = mpInstance.Identity.getUser(previousMPID),
+            newUser,
+            mpidIsNotInCookies,
+            identityApiResult,
+            indexOfMPID,
+            newIdentitiesByType = {},
+            previousUIByName = prevUser
+                ? prevUser.getUserIdentities().userIdentities
+                : {},
+            previousUIByNameCopy = mpInstance._Helpers.extend(
+                {},
+                previousUIByName
+            );
         mpInstance._Store.identityCallInFlight = false;
 
         try {
             mpInstance.Logger.verbose(
                 'Parsing "' + method + '" identity response from server'
             );
+            if (xhr.responseText) {
+                identityApiResult = JSON.parse(xhr.responseText);
 
-            identityApiResult = xhr.responseText
-                ? JSON.parse(xhr.responseText)
-                : null;
-
-            mpInstance._Store.isLoggedIn =
-                identityApiResult?.is_logged_in || false;
-            mpInstance._Store.mpid = identityApiResult.mpid;
-
-            if (prevUser) {
-                // https://go.mparticle.com/work/SQDSDKS-6329
-                mpInstance._Persistence.setLastSeenTime(previousMPID);
+                if (identityApiResult.hasOwnProperty('is_logged_in')) {
+                    mpInstance._Store.isLoggedIn =
+                        identityApiResult.is_logged_in;
+                }
             }
 
-            const mpidIsNotInCookies = !mpInstance._Persistence.getFirstSeenTime(
-                identityApiResult.mpid
-            );
+            // set currentUser
+            if (
+                !prevUser ||
+                (prevUser.getMPID() &&
+                    identityApiResult.mpid &&
+                    identityApiResult.mpid !== prevUser.getMPID())
+            ) {
+                mpInstance._Store.mpid = identityApiResult.mpid;
 
-            // https://go.mparticle.com/work/SQDSDKS-6329
-            mpInstance._Persistence.setFirstSeenTime(identityApiResult.mpid);
+                if (prevUser) {
+                    mpInstance._Persistence.setLastSeenTime(previousMPID);
+                }
+
+                if (
+                    !mpInstance._Persistence.getFirstSeenTime(
+                        identityApiResult.mpid
+                    )
+                )
+                    mpidIsNotInCookies = true;
+                mpInstance._Persistence.setFirstSeenTime(
+                    identityApiResult.mpid
+                );
+            }
 
             if (xhr.status === 200) {
-                if (getFeatureFlag(CacheIdentity)) {
+                if (
+                    mpInstance._Helpers.getFeatureFlag(
+                        Constants.FeatureFlags.CacheIdentity
+                    )
+                ) {
                     cacheOrClearIdCache(
                         method,
                         knownIdentities,
@@ -1535,14 +1556,6 @@ export default function Identity(mpInstance) {
                     );
                 }
 
-                const incomingUser = self.IdentityAPI.getUser(
-                    identityApiResult.mpid
-                );
-
-                const incomingMpidUIByName = incomingUser
-                    ? incomingUser.getUserIdentities().userIdentities
-                    : {};
-
                 if (method === Modify) {
                     newIdentitiesByType = mpInstance._Identity.IdentityRequest.combineUserIdentities(
                         previousUIByName,
@@ -1554,32 +1567,71 @@ export default function Identity(mpInstance) {
                         newIdentitiesByType
                     );
                 } else {
-                    // https://go.mparticle.com/work/SQDSDKS-6356
+                    var incomingUser = self.IdentityAPI.getUser(
+                        identityApiResult.mpid
+                    );
+
+                    var incomingMpidUIByName = incomingUser
+                        ? incomingUser.getUserIdentities().userIdentities
+                        : {};
+
+                    var incomingMpidUIByNameCopy = mpInstance._Helpers.extend(
+                        {},
+                        incomingMpidUIByName
+                    );
+                    mpInstance.Logger.verbose(
+                        'Successfully parsed Identity Response'
+                    );
+
                     //this covers an edge case where, users stored before "firstSeenTime" was introduced
                     //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 &&
                         prevUser &&
-                        identityApiResult.mpid === prevUserMPID
+                        identityApiResult.mpid === prevUser.getMPID()
                     ) {
                         mpInstance._Persistence.setFirstSeenTime(
                             identityApiResult.mpid
                         );
                     }
 
-                    mpInstance._Store.addMpidToSessionHistory(
-                        identityApiResult.mpid,
-                        previousMPID
+                    indexOfMPID = mpInstance._Store.currentSessionMPIDs.indexOf(
+                        identityApiResult.mpid
                     );
 
+                    if (
+                        mpInstance._Store.sessionId &&
+                        identityApiResult.mpid &&
+                        previousMPID !== identityApiResult.mpid &&
+                        indexOfMPID < 0
+                    ) {
+                        mpInstance._Store.currentSessionMPIDs.push(
+                            identityApiResult.mpid
+                        );
+                    }
+
+                    if (indexOfMPID > -1) {
+                        mpInstance._Store.currentSessionMPIDs = mpInstance._Store.currentSessionMPIDs
+                            .slice(0, indexOfMPID)
+                            .concat(
+                                mpInstance._Store.currentSessionMPIDs.slice(
+                                    indexOfMPID + 1,
+                                    mpInstance._Store.currentSessionMPIDs.length
+                                )
+                            );
+                        mpInstance._Store.currentSessionMPIDs.push(
+                            identityApiResult.mpid
+                        );
+                    }
+
                     mpInstance._CookieSyncManager.attemptCookieSync(
                         previousMPID,
                         identityApiResult.mpid,
                         mpidIsNotInCookies
                     );
 
-                    mpInstance._Persistence.swapCurrentUser(
+                    self.checkIdentitySwap(
                         previousMPID,
                         identityApiResult.mpid,
                         mpInstance._Store.currentSessionMPIDs
@@ -1587,7 +1639,8 @@ export default function Identity(mpInstance) {
 
                     if (
                         identityApiData &&
-                        !isEmpty(identityApiData.userIdentities)
+                        identityApiData.userIdentities &&
+                        Object.keys(identityApiData.userIdentities).length
                     ) {
                         newIdentitiesByType = self.IdentityRequest.combineUserIdentities(
                             incomingMpidUIByName,
@@ -1606,71 +1659,112 @@ export default function Identity(mpInstance) {
                         identityApiData
                     );
 
-                    // https://go.mparticle.com/work/SQDSDKS-6357
                     mpInstance._Store.context =
                         identityApiResult.context || mpInstance._Store.context;
                 }
 
                 newUser = mpInstance.Identity.getCurrentUser();
 
-                // https://go.mparticle.com/work/SQDSDKS-6359
-                tryOnUserAlias(
-                    prevUser,
-                    newUser,
-                    identityApiData,
-                    mpInstance.Logger
-                );
-
-                const persistence = mpInstance._Persistence.getPersistence();
+                if (
+                    identityApiData &&
+                    identityApiData.onUserAlias &&
+                    mpInstance._Helpers.Validators.isFunction(
+                        identityApiData.onUserAlias
+                    )
+                ) {
+                    try {
+                        mpInstance.Logger.warning(
+                            'Deprecated function onUserAlias will be removed in future releases'
+                        );
+                        identityApiData.onUserAlias(prevUser, newUser);
+                    } catch (e) {
+                        mpInstance.Logger.error(
+                            'There was an error with your onUserAlias function - ' +
+                                e
+                        );
+                    }
+                }
+                var persistence = mpInstance._Persistence.getPersistence();
 
                 if (newUser) {
                     mpInstance._Persistence.storeDataInMemory(
                         persistence,
                         newUser.getMPID()
                     );
+                    if (
+                        !prevUser ||
+                        newUser.getMPID() !== prevUser.getMPID() ||
+                        prevUser.isLoggedIn() !== newUser.isLoggedIn()
+                    ) {
+                        mpInstance._Forwarders.initForwarders(
+                            newUser.getUserIdentities().userIdentities,
+                            mpInstance._APIClient.prepareForwardingStats
+                        );
+                    }
 
-                    self.reinitForwardersOnUserChange(prevUser, newUser);
-                    self.setForwarderCallbacks(newUser, method);
+                    // TODO: https://go.mparticle.com/work/SQDSDKS-6036
+                    mpInstance._Forwarders.setForwarderUserIdentities(
+                        newUser.getUserIdentities().userIdentities
+                    );
+                    mpInstance._Forwarders.setForwarderOnIdentityComplete(
+                        newUser,
+                        method
+                    );
+                    mpInstance._Forwarders.setForwarderOnUserIdentified(
+                        newUser
+                    );
                 }
+                var newIdentitiesByName = {};
 
-                const newIdentitiesByName = getNewIdentitiesByName(
-                    newIdentitiesByType
-                );
-
-                const uiByName =
-                    method === Modify ? previousUIByName : incomingMpidUIByName;
+                for (var key in newIdentitiesByType) {
+                    newIdentitiesByName[
+                        Types.IdentityType.getIdentityName(
+                            mpInstance._Helpers.parseNumber(key)
+                        )
+                    ] = newIdentitiesByType[key];
+                }
 
                 self.sendUserIdentityChangeEvent(
                     newIdentitiesByName,
+                    method,
                     identityApiResult.mpid,
-                    uiByName
+                    method === Modify
+                        ? previousUIByNameCopy
+                        : incomingMpidUIByNameCopy
                 );
             }
 
             if (callback) {
-                const callbackCode =
-                    xhr.status === 0 ? HTTPCodes.noHttpCoverage : xhr.status;
-
-                mpInstance._Helpers.invokeCallback(
-                    callback,
-                    callbackCode,
-                    identityApiResult || null,
-                    newUser
-                );
-            } else if (
-                identityApiResult &&
-                !isEmpty(identityApiResult.errors)
-            ) {
-                mpInstance.Logger.error(
-                    'Received HTTP response code of ' +
-                        xhr.status +
-                        ' - ' +
-                        identityApiResult.errors[0].message
-                );
+                if (xhr.status === 0) {
+                    mpInstance._Helpers.invokeCallback(
+                        callback,
+                        HTTPCodes.noHttpCoverage,
+                        identityApiResult || null,
+                        newUser
+                    );
+                } else {
+                    mpInstance._Helpers.invokeCallback(
+                        callback,
+                        xhr.status,
+                        identityApiResult || null,
+                        newUser
+                    );
+                }
+            } else {
+                if (
+                    identityApiResult &&
+                    identityApiResult.errors &&
+                    identityApiResult.errors.length
+                ) {
+                    mpInstance.Logger.error(
+                        'Received HTTP response code of ' +
+                            xhr.status +
+                            ' - ' +
+                            identityApiResult.errors[0].message
+                    );
+                }
             }
 
-            mpInstance.Logger.verbose('Successfully parsed Identity Response');
-
             mpInstance._APIClient.processQueuedEvents();
         } catch (e) {
             if (callback) {
@@ -1692,28 +1786,30 @@ export default function Identity(mpInstance) {
 
     this.sendUserIdentityChangeEvent = function(
         newUserIdentities,
+        method,
         mpid,
-        currentUserIdentities
+        prevUserIdentities
     ) {
-        // https://go.mparticle.com/work/SQDSDKS-6354
-        const currentUserInMemory = this.IdentityAPI.getUser(mpid);
+        var currentUserInMemory, userIdentityChangeEvent;
+
+        if (!mpid) {
+            if (method !== Modify) {
+                return;
+            }
+        }
+
+        currentUserInMemory = this.IdentityAPI.getUser(mpid);
 
         for (var identityType in newUserIdentities) {
-            // Verifies a change actually happened
             if (
-                currentUserIdentities[identityType] !==
+                prevUserIdentities[identityType] !==
                 newUserIdentities[identityType]
             ) {
-                // If a new identity type was introduced when the identity changes
-                // we need to notify the server so that it will associate the new
-                // identity type with subsequent events
-                const isNewUserIdentityType = !currentUserIdentities[
-                    identityType
-                ];
-                const userIdentityChangeEvent = self.createUserIdentityChange(
+                var isNewUserIdentityType = !prevUserIdentities[identityType];
+                userIdentityChangeEvent = self.createUserIdentityChange(
                     identityType,
                     newUserIdentities[identityType],
-                    currentUserIdentities[identityType],
+                    prevUserIdentities[identityType],
                     isNewUserIdentityType,
                     currentUserInMemory
                 );
@@ -1728,7 +1824,7 @@ export default function Identity(mpInstance) {
         identityType,
         newIdentity,
         oldIdentity,
-        isIdentityTypeNewToBatch,
+        newCreatedThisBatch,
         userInMemory
     ) {
         var userIdentityChangeEvent;
@@ -1739,7 +1835,7 @@ export default function Identity(mpInstance) {
                 New: {
                     IdentityType: identityType,
                     Identity: newIdentity,
-                    CreatedThisBatch: isIdentityTypeNewToBatch,
+                    CreatedThisBatch: newCreatedThisBatch,
                 },
                 Old: {
                     IdentityType: identityType,
@@ -1803,40 +1899,4 @@ export default function Identity(mpInstance) {
         }
         return userAttributeChangeEvent;
     };
-
-    this.reinitForwardersOnUserChange = function(prevUser, newUser) {
-        if (didUserChange(prevUser, newUser)) {
-            mpInstance._Forwarders.initForwarders(
-                newUser.getUserIdentities().userIdentities,
-                mpInstance._APIClient.prepareForwardingStats
-            );
-        }
-    };
-
-    this.setForwarderCallbacks = function(user, method) {
-        // https://go.mparticle.com/work/SQDSDKS-6036
-        mpInstance._Forwarders.setForwarderUserIdentities(
-            user.getUserIdentities().userIdentities
-        );
-        mpInstance._Forwarders.setForwarderOnIdentityComplete(user, method);
-        mpInstance._Forwarders.setForwarderOnUserIdentified(user);
-    };
-}
-
-// https://go.mparticle.com/work/SQDSDKS-6359
-function tryOnUserAlias(previousUser, newUser, identityApiData, logger) {
-    if (
-        identityApiData &&
-        identityApiData.onUserAlias &&
-        isFunction(identityApiData.onUserAlias)
-    ) {
-        try {
-            logger.warning(generateDeprecationMessage('onUserAlias'));
-            identityApiData.onUserAlias(previousUser, newUser);
-        } catch (e) {
-            logger.error(
-                'There was an error with your onUserAlias function - ' + e
-            );
-        }
-    }
 }

package/src/identityApiClient.js

@@ -10,7 +10,6 @@ export default function IdentityAPIClient(mpInstance) {
         var xhr,
             xhrCallback = function() {
                 if (xhr.readyState === 4) {
-                    // https://go.mparticle.com/work/SQDSDKS-6368
                     mpInstance.Logger.verbose(
                         'Received ' + xhr.statusText + ' from server'
                     );
@@ -74,7 +73,6 @@ export default function IdentityAPIClient(mpInstance) {
             previousMPID,
             xhrCallback = function() {
                 if (xhr.readyState === 4) {
-                    // https://go.mparticle.com/work/SQDSDKS-6368
                     mpInstance.Logger.verbose(
                         'Received ' + xhr.statusText + ' from server'
                     );

package/src/persistence.interfaces.ts

@@ -22,7 +22,8 @@ export interface iForwardingStatsBatches {
     forwardingStatsEventQueue: ForwardingStatsData[];
 }
 
-// https://go.mparticle.com/work/SQDSDKS-5196
+// TODO: Migrate this to @types/mparticle__web-sdk
+//       https://go.mparticle.com/work/SQDSDKS-5196
 export type UserAttributes = AllUserAttributes;
 
 export interface IGlobalStoreV2MinifiedKeys {

package/src/persistence.js

@@ -1012,21 +1012,6 @@ export default function _Persistence(mpInstance) {
         }
     };
 
-    this.swapCurrentUser = function(
-        previousMPID,
-        currentMPID,
-        currentSessionMPIDs
-    ) {
-        if (previousMPID && currentMPID && previousMPID !== currentMPID) {
-            var persistence = self.getPersistence();
-            if (persistence) {
-                persistence.cu = currentMPID;
-                persistence.gs.csm = currentSessionMPIDs;
-                self.savePersistence(persistence);
-            }
-        }
-    };
-
     // https://go.mparticle.com/work/SQDSDKS-6021
     this.savePersistence = function(persistence) {
         var encodedPersistence = self.encodePersistence(
@@ -1112,7 +1097,6 @@ export default function _Persistence(mpInstance) {
         if (!mpid) {
             return;
         }
-        // https://go.mparticle.com/work/SQDSDKS-6329
         if (!time) {
             time = new Date().getTime();
         }
@@ -1153,7 +1137,6 @@ export default function _Persistence(mpInstance) {
         if (!mpid) {
             return;
         }
-        // https://go.mparticle.com/work/SQDSDKS-6329
         if (!time) {
             time = new Date().getTime();
         }