@mparticle/web-sdk 2.26.6 → 2.26.7

package/package.json

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

package/src/identity.js

@@ -6,13 +6,22 @@ import {
     tryCacheIdentity,
 } from './identity-utils';
 import AudienceManager from './audienceManager';
-
-const { Messages, HTTPCodes, FeatureFlags } = Constants;
+const { Messages, HTTPCodes, FeatureFlags, IdentityMethods } = Constants;
 const { ErrorMessages } = Messages;
-
-const { Identify, Modify, Login, Logout } = Constants.IdentityMethods;
+const { CacheIdentity } = FeatureFlags;
+const { Identify, Modify, Login, Logout } = IdentityMethods;
+import {
+    generateDeprecationMessage,
+    isEmpty,
+    isFunction,
+    isObject,
+} from './utils';
+import { hasMPIDAndUserLoginChanged, hasMPIDChanged } from './user-utils';
+import { getNewIdentitiesByName } from './type-utils';
 
 export default function Identity(mpInstance) {
+    const { getFeatureFlag, extend } = mpInstance._Helpers;
+
     var self = this;
     this.idCache = null;
     this.audienceManager = null;
@@ -121,9 +130,9 @@ export default function Identity(mpInstance) {
             var key;
             if (
                 newIdentities &&
-                mpInstance._Helpers.isObject(newIdentities) &&
+                isObject(newIdentities) &&
                 previousIdentities &&
-                mpInstance._Helpers.isObject(previousIdentities)
+                isObject(previousIdentities)
             ) {
                 for (key in newIdentities) {
                     identityChanges.push({
@@ -140,11 +149,7 @@ 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 = mpInstance._Helpers.extend(
-                previousUIByName,
-                newUIByName
-            );
+            var combinedUIByName = extend({}, previousUIByName, newUIByName);
 
             for (var key in combinedUIByName) {
                 var type = Types.IdentityType.getIdentityType(key);
@@ -946,7 +951,7 @@ export default function Identity(mpInstance) {
              */
             setUserAttributes: function(userAttributes) {
                 mpInstance._SessionManager.resetSessionTimer();
-                if (mpInstance._Helpers.isObject(userAttributes)) {
+                if (isObject(userAttributes)) {
                     if (mpInstance._Helpers.canLog()) {
                         for (var key in userAttributes) {
                             if (userAttributes.hasOwnProperty(key)) {
@@ -1482,41 +1487,34 @@ export default function Identity(mpInstance) {
         knownIdentities,
         parsingCachedResponse
     ) {
-        var prevUser = mpInstance.Identity.getUser(previousMPID),
-            newUser,
-            mpidIsNotInCookies,
-            identityApiResult,
-            indexOfMPID,
-            newIdentitiesByType = {},
-            previousUIByName = prevUser
-                ? prevUser.getUserIdentities().userIdentities
-                : {},
-            previousUIByNameCopy = mpInstance._Helpers.extend(
-                {},
-                previousUIByName
-            );
+        const prevUser = mpInstance.Identity.getUser(previousMPID);
+        const prevUserMPID = prevUser ? prevUser.getMPID() : null;
+        const previousUIByName = prevUser
+            ? prevUser.getUserIdentities().userIdentities
+            : {};
+        let mpidIsNotInCookies;
+        let identityApiResult;
+
+        let newUser;
+        let newIdentitiesByType = {};
+
         mpInstance._Store.identityCallInFlight = false;
 
         try {
             mpInstance.Logger.verbose(
                 'Parsing "' + method + '" identity response from server'
             );
-            if (xhr.responseText) {
-                identityApiResult = JSON.parse(xhr.responseText);
 
-                if (identityApiResult.hasOwnProperty('is_logged_in')) {
-                    mpInstance._Store.isLoggedIn =
-                        identityApiResult.is_logged_in;
-                }
-            }
+            identityApiResult = xhr.responseText
+                ? JSON.parse(xhr.responseText)
+                : null;
 
+            mpInstance._Store.isLoggedIn =
+                identityApiResult?.is_logged_in || false;
+
+            // https://go.mparticle.com/work/SQDSDKS-6504
             // set currentUser
-            if (
-                !prevUser ||
-                (prevUser.getMPID() &&
-                    identityApiResult.mpid &&
-                    identityApiResult.mpid !== prevUser.getMPID())
-            ) {
+            if (hasMPIDChanged(prevUser, identityApiResult)) {
                 mpInstance._Store.mpid = identityApiResult.mpid;
 
                 if (prevUser) {
@@ -1524,23 +1522,18 @@ export default function Identity(mpInstance) {
                     mpInstance._Persistence.setLastSeenTime(previousMPID);
                 }
 
-                if (
-                    !mpInstance._Persistence.getFirstSeenTime(
-                        identityApiResult.mpid
-                    )
-                )
-                    mpidIsNotInCookies = true;
+                mpidIsNotInCookies = !mpInstance._Persistence.getFirstSeenTime(
+                    identityApiResult.mpid
+                );
+
+                // https://go.mparticle.com/work/SQDSDKS-6329
                 mpInstance._Persistence.setFirstSeenTime(
                     identityApiResult.mpid
                 );
             }
 
             if (xhr.status === 200) {
-                if (
-                    mpInstance._Helpers.getFeatureFlag(
-                        Constants.FeatureFlags.CacheIdentity
-                    )
-                ) {
+                if (getFeatureFlag(CacheIdentity)) {
                     cacheOrClearIdCache(
                         method,
                         knownIdentities,
@@ -1550,6 +1543,14 @@ export default function Identity(mpInstance) {
                     );
                 }
 
+                const incomingUser = self.IdentityAPI.getUser(
+                    identityApiResult.mpid
+                );
+
+                const incomingUIByName = incomingUser
+                    ? incomingUser.getUserIdentities().userIdentities
+                    : {};
+
                 if (method === Modify) {
                     newIdentitiesByType = mpInstance._Identity.IdentityRequest.combineUserIdentities(
                         previousUIByName,
@@ -1561,22 +1562,6 @@ export default function Identity(mpInstance) {
                         newIdentitiesByType
                     );
                 } else {
-                    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'
-                    );
-
                     // https://go.mparticle.com/work/SQDSDKS-6356
                     //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,
@@ -1584,7 +1569,7 @@ export default function Identity(mpInstance) {
                     if (
                         method === Identify &&
                         prevUser &&
-                        identityApiResult.mpid === prevUser.getMPID()
+                        identityApiResult.mpid === prevUserMPID
                     ) {
                         // https://go.mparticle.com/work/SQDSDKS-6329
                         mpInstance._Persistence.setFirstSeenTime(
@@ -1592,35 +1577,11 @@ export default function Identity(mpInstance) {
                         );
                     }
 
-                    indexOfMPID = mpInstance._Store.currentSessionMPIDs.indexOf(
-                        identityApiResult.mpid
+                    mpInstance._Store.addMpidToSessionHistory(
+                        identityApiResult.mpid,
+                        previousMPID
                     );
 
-                    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,
@@ -1635,11 +1596,10 @@ export default function Identity(mpInstance) {
 
                     if (
                         identityApiData &&
-                        identityApiData.userIdentities &&
-                        Object.keys(identityApiData.userIdentities).length
+                        !isEmpty(identityApiData.userIdentities)
                     ) {
                         newIdentitiesByType = self.IdentityRequest.combineUserIdentities(
-                            incomingMpidUIByName,
+                            incomingUIByName,
                             identityApiData.userIdentities
                         );
                     }
@@ -1663,106 +1623,66 @@ export default function Identity(mpInstance) {
                 newUser = mpInstance.Identity.getCurrentUser();
 
                 // https://go.mparticle.com/work/SQDSDKS-6359
-                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();
+                tryOnUserAlias(
+                    prevUser,
+                    newUser,
+                    identityApiData,
+                    mpInstance.Logger
+                );
+
+                const 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
-                        );
-                    }
 
-                    // TODO: https://go.mparticle.com/work/SQDSDKS-6036
-                    mpInstance._Forwarders.setForwarderUserIdentities(
-                        newUser.getUserIdentities().userIdentities
-                    );
-                    mpInstance._Forwarders.setForwarderOnIdentityComplete(
-                        newUser,
-                        method
-                    );
-                    mpInstance._Forwarders.setForwarderOnUserIdentified(
-                        newUser
-                    );
+                    self.reinitForwardersOnUserChange(prevUser, newUser);
+                    self.setForwarderCallbacks(newUser, method);
                 }
-                var newIdentitiesByName = {};
 
-                for (var key in newIdentitiesByType) {
-                    newIdentitiesByName[
-                        Types.IdentityType.getIdentityName(
-                            mpInstance._Helpers.parseNumber(key)
-                        )
-                    ] = newIdentitiesByType[key];
-                }
+                const newIdentitiesByName = getNewIdentitiesByName(
+                    newIdentitiesByType
+                );
+
+                const uiByName =
+                    method === Modify ? previousUIByName : incomingUIByName;
 
+                // https://go.mparticle.com/work/SQDSDKS-6501
                 self.sendUserIdentityChangeEvent(
                     newIdentitiesByName,
                     method,
                     identityApiResult.mpid,
-                    method === Modify
-                        ? previousUIByNameCopy
-                        : incomingMpidUIByNameCopy
+                    uiByName
                 );
             }
 
             if (callback) {
-                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
-                    );
-                }
+                const callbackCode =
+                    xhr.status === 0 ? HTTPCodes.noHttpCoverage : xhr.status;
+
+                mpInstance._Helpers.invokeCallback(
+                    callback,
+                    callbackCode,
+                    identityApiResult || null,
+                    newUser
+                );
+            } else if (
+                identityApiResult &&
+                !isEmpty(identityApiResult.errors)
+            ) {
+                // https://go.mparticle.com/work/SQDSDKS-6500
+                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) {
@@ -1781,31 +1701,33 @@ export default function Identity(mpInstance) {
     // send a user identity change request on identify, login, logout, modify when any values change.
     // compare what identities exist vs what is previously was for the specific user if they were in memory before.
     // if it's the first time the user is logging in, send a user identity change request with
-
     this.sendUserIdentityChangeEvent = function(
         newUserIdentities,
         method,
         mpid,
         prevUserIdentities
     ) {
-        var currentUserInMemory, userIdentityChangeEvent;
-
         if (!mpid) {
+            // https://go.mparticle.com/work/SQDSDKS-6501
             if (method !== Modify) {
                 return;
             }
         }
 
         // https://go.mparticle.com/work/SQDSDKS-6354
-        currentUserInMemory = this.IdentityAPI.getUser(mpid);
+        const currentUserInMemory = this.IdentityAPI.getUser(mpid);
 
         for (var identityType in newUserIdentities) {
+            // Verifies a change actually happened
             if (
                 prevUserIdentities[identityType] !==
                 newUserIdentities[identityType]
             ) {
-                var isNewUserIdentityType = !prevUserIdentities[identityType];
-                userIdentityChangeEvent = self.createUserIdentityChange(
+                // If a new identity type was introduced when the identity changes
+                // we need to notify the server so that the user profile is updated in
+                // the mParticle UI.
+                const isNewUserIdentityType = !prevUserIdentities[identityType];
+                const userIdentityChangeEvent = self.createUserIdentityChange(
                     identityType,
                     newUserIdentities[identityType],
                     prevUserIdentities[identityType],
@@ -1823,7 +1745,7 @@ export default function Identity(mpInstance) {
         identityType,
         newIdentity,
         oldIdentity,
-        newCreatedThisBatch,
+        isIdentityTypeNewToBatch,
         userInMemory
     ) {
         var userIdentityChangeEvent;
@@ -1835,7 +1757,7 @@ export default function Identity(mpInstance) {
                 New: {
                     IdentityType: identityType,
                     Identity: newIdentity,
-                    CreatedThisBatch: newCreatedThisBatch,
+                    CreatedThisBatch: isIdentityTypeNewToBatch,
                 },
                 Old: {
                     IdentityType: identityType,
@@ -1900,4 +1822,40 @@ export default function Identity(mpInstance) {
         }
         return userAttributeChangeEvent;
     };
+
+    this.reinitForwardersOnUserChange = function(prevUser, newUser) {
+        if (hasMPIDAndUserLoginChanged(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/store.ts

@@ -25,6 +25,7 @@ import {
     isEmpty,
     isNumber,
     isObject,
+    moveElementToEnd,
     parseNumber,
     returnConvertedBoolean,
 } from './utils';
@@ -186,6 +187,7 @@ export interface IStore {
     getLastSeenTime?(mpid: MPID): number;
     setLastSeenTime?(mpid: MPID, time?: number): void;
 
+    addMpidToSessionHistory?(mpid: MPID, previousMpid?: MPID): void;
     hasInvalidIdentifyRequest?: () => boolean;
     nullifySession?: () => void;
     processConfig(config: SDKInitConfig): void;
@@ -494,6 +496,22 @@ export default function Store(
         mpInstance._Persistence.update();
     };
 
+    this.addMpidToSessionHistory = (mpid: MPID, previousMPID?: MPID): void => {
+        const indexOfMPID = this.currentSessionMPIDs.indexOf(mpid);
+
+        if (mpid && previousMPID !== mpid && indexOfMPID < 0) {
+            this.currentSessionMPIDs.push(mpid);
+            return;
+        }
+
+        if (indexOfMPID >= 0) {
+            this.currentSessionMPIDs = moveElementToEnd(
+                this.currentSessionMPIDs,
+                indexOfMPID
+            );
+        }
+    };
+
     this.getFirstSeenTime = (mpid: MPID) => {
         if (!mpid) {
             return null;

package/src/type-utils.ts

@@ -0,0 +1,66 @@
+import { IdentityType } from './types.interfaces';
+import { parseNumber } from './utils';
+
+export interface IIdentitiesByType {
+    [key: number]: string;
+}
+
+export function getNewIdentitiesByName(newIdentitiesByType: IIdentitiesByType) {
+    const newIdentitiesByName = {};
+
+    for (var key in newIdentitiesByType) {
+        const identityNameKey = getIdentityName(parseNumber(key));
+        newIdentitiesByName[identityNameKey] = newIdentitiesByType[key];
+    }
+
+    return newIdentitiesByName;
+}
+
+export function getIdentityName(identityType: IdentityType): string | null {
+    switch (identityType) {
+        case IdentityType.Other:
+            return 'other';
+        case IdentityType.CustomerId:
+            return 'customerid';
+        case IdentityType.Facebook:
+            return 'facebook';
+        case IdentityType.Twitter:
+            return 'twitter';
+        case IdentityType.Google:
+            return 'google';
+        case IdentityType.Microsoft:
+            return 'microsoft';
+        case IdentityType.Yahoo:
+            return 'yahoo';
+        case IdentityType.Email:
+            return 'email';
+        case IdentityType.FacebookCustomAudienceId:
+            return 'facebookcustomaudienceid';
+        case IdentityType.Other2:
+            return 'other2';
+        case IdentityType.Other3:
+            return 'other3';
+        case IdentityType.Other4:
+            return 'other4';
+        case IdentityType.Other5:
+            return 'other5';
+        case IdentityType.Other6:
+            return 'other6';
+        case IdentityType.Other7:
+            return 'other7';
+        case IdentityType.Other8:
+            return 'other8';
+        case IdentityType.Other9:
+            return 'other9';
+        case IdentityType.Other10:
+            return 'other10';
+        case IdentityType.MobileNumber:
+            return 'mobile_number';
+        case IdentityType.PhoneNumber2:
+            return 'phone_number_2';
+        case IdentityType.PhoneNumber3:
+            return 'phone_number_3';
+        default:
+            return null;
+    }
+}

package/src/types.js

@@ -1,3 +1,5 @@
+import { getIdentityName } from './type-utils';
+
 var MessageType = {
     SessionStart: 1,
     SessionEnd: 2,
@@ -209,50 +211,7 @@ IdentityType.getIdentityType = function(identityName) {
 };
 
 IdentityType.getIdentityName = function(identityType) {
-    switch (identityType) {
-        case IdentityType.Other:
-            return 'other';
-        case IdentityType.CustomerId:
-            return 'customerid';
-        case IdentityType.Facebook:
-            return 'facebook';
-        case IdentityType.Twitter:
-            return 'twitter';
-        case IdentityType.Google:
-            return 'google';
-        case IdentityType.Microsoft:
-            return 'microsoft';
-        case IdentityType.Yahoo:
-            return 'yahoo';
-        case IdentityType.Email:
-            return 'email';
-        case IdentityType.FacebookCustomAudienceId:
-            return 'facebookcustomaudienceid';
-        case IdentityType.Other2:
-            return 'other2';
-        case IdentityType.Other3:
-            return 'other3';
-        case IdentityType.Other4:
-            return 'other4';
-        case IdentityType.Other5:
-            return 'other5';
-        case IdentityType.Other6:
-            return 'other6';
-        case IdentityType.Other7:
-            return 'other7';
-        case IdentityType.Other8:
-            return 'other8';
-        case IdentityType.Other9:
-            return 'other9';
-        case IdentityType.Other10:
-            return 'other10';
-        case IdentityType.MobileNumber:
-            return 'mobile_number';
-        case IdentityType.PhoneNumber2:
-            return 'phone_number_2';
-        case IdentityType.PhoneNumber3:
-            return 'phone_number_3';
-    }
+    return getIdentityName(identityType);
 };
 
 var ProductActionType = {