@mparticle/web-sdk 2.21.0 → 2.21.1

package/src/identity.js

@@ -1563,29 +1563,15 @@ export default function Identity(mpInstance) {
                         mpInstance._Store.currentSessionMPIDs
                     );
 
-                    //if there is any previous migration data
-                    if (Object.keys(mpInstance._Store.migrationData).length) {
-                        newIdentitiesByType =
-                            mpInstance._Store.migrationData.userIdentities ||
-                            {};
-                        var userAttributes =
-                            mpInstance._Store.migrationData.userAttributes ||
-                            {};
-                        mpInstance._Persistence.saveUserAttributesToPersistence(
-                            identityApiResult.mpid,
-                            userAttributes
+                    if (
+                        identityApiData &&
+                        identityApiData.userIdentities &&
+                        Object.keys(identityApiData.userIdentities).length
+                    ) {
+                        newIdentitiesByType = self.IdentityRequest.combineUserIdentities(
+                            incomingMpidUIByName,
+                            identityApiData.userIdentities
                         );
-                    } else {
-                        if (
-                            identityApiData &&
-                            identityApiData.userIdentities &&
-                            Object.keys(identityApiData.userIdentities).length
-                        ) {
-                            newIdentitiesByType = self.IdentityRequest.combineUserIdentities(
-                                incomingMpidUIByName,
-                                identityApiData.userIdentities
-                            );
-                        }
                     }
 
                     mpInstance._Persistence.saveUserIdentitiesToPersistence(

package/src/mockBatchCreator.ts

@@ -6,7 +6,7 @@ import { convertEvents } from './sdkToEventsApiConverter';
 import * as EventsApi from '@mparticle/event-models';
 import { Batch } from '@mparticle/event-models';
 
-const mockFunction = function () {
+const mockFunction = function() {
     return null;
 };
 export default class _BatchValidator {
@@ -14,12 +14,12 @@ export default class _BatchValidator {
         return {
             // Certain Helper, Store, and Identity properties need to be mocked to be used in the `returnBatch` method
             _Helpers: {
-                sanitizeAttributes:
-                    window.mParticle.getInstance()._Helpers.sanitizeAttributes,
-                generateHash: function () {
+                sanitizeAttributes: window.mParticle.getInstance()._Helpers
+                    .sanitizeAttributes,
+                generateHash: function() {
                     return 'mockHash';
                 },
-                generateUniqueId: function () {
+                generateUniqueId: function() {
                     return 'mockId';
                 },
                 extend: window.mParticle.getInstance()._Helpers.extend,
@@ -50,7 +50,6 @@ export default class _BatchValidator {
                 consentState: null,
                 clientId: null,
                 deviceId: null,
-                migrationData: {},
                 serverSettings: {},
                 dateLastEventSent: null,
                 sessionStartDate: null,
@@ -64,7 +63,6 @@ export default class _BatchValidator {
                 context: null,
                 configurationLoaded: false,
                 identityCallInFlight: false,
-                migratingToIDSyncCookies: false,
                 nonCurrentUserMPIDs: {},
                 identifyCalled: false,
                 isLoggedIn: false,
@@ -128,7 +126,7 @@ export default class _BatchValidator {
         const mpInstance = this.getMPInstance();
 
         const sdkEvents: SDKEvent[] = Array.isArray(events)
-            ? events.map((event) => this.createSDKEventFunction(event))
+            ? events.map(event => this.createSDKEventFunction(event))
             : [this.createSDKEventFunction(events)];
 
         const batch: Batch = convertEvents('0', sdkEvents, mpInstance as any);

package/src/mp-instance.js

@@ -28,7 +28,6 @@ import Store from './store';
 import Logger from './logger';
 import Persistence from './persistence';
 import Events from './events';
-import Migrations from './migrations';
 import Forwarders from './forwarders';
 import ServerModel from './serverModel';
 import ForwardingStatsUploader from './forwardingStatsUploader';
@@ -59,7 +58,6 @@ export default function mParticleInstance(instanceName) {
     // These classes are for internal use only. Not documented for public consumption
     this._instanceName = instanceName;
     this._NativeSdkHelpers = new NativeSdkHelpers(this);
-    this._Migrations = new Migrations(this);
     this._SessionManager = new SessionManager(this);
     this._Persistence = new Persistence(this);
     this._Helpers = new Helpers(this);
@@ -1345,9 +1343,6 @@ function completeSDKInitialization(apiKey, config, mpInstance) {
     mpInstance._Store.configurationLoaded = true;
 
     if (!mpInstance._Store.webviewBridgeEnabled) {
-        // Migrate any cookies from previous versions to current cookie version
-        mpInstance._Migrations.migrate();
-
         // Load any settings/identities/attributes from cookie or localStorage
         mpInstance._Persistence.initializeStorage();
     }
@@ -1398,15 +1393,6 @@ function completeSDKInitialization(apiKey, config, mpInstance) {
             };
         }
 
-        // If migrating from pre-IDSync to IDSync, a sessionID will exist and an identify request will not have been fired, so we need this check
-        if (mpInstance._Store.migratingToIDSyncCookies) {
-            mpInstance.Identity.identify(
-                mpInstance._Store.SDKConfig.identifyRequest,
-                mpInstance._Store.SDKConfig.identityCallback
-            );
-            mpInstance._Store.migratingToIDSyncCookies = false;
-        }
-
         currentUser = mpInstance.Identity.getCurrentUser();
 
         if (
@@ -1556,7 +1542,9 @@ function runPreConfigFetchInitialization(mpInstance, apiKey, config) {
         Messages.InformationMessages.StartingInitialization
     );
 
-    //check to see if localStorage is available for migrating purposes
+    // Check to see if localStorage is available before main configuration runs
+    // since we will need this for the current implementation of user persistence
+    // TODO: Refactor this when we refactor User Identity Persistence
     try {
         mpInstance._Store.isLocalStorageAvailable = mpInstance._Persistence.determineLocalStorageAvailability(
             window.localStorage

package/src/persistence.interfaces.ts

@@ -98,16 +98,10 @@ export interface IPersistence {
         expires: string,
         domain: string,
         maxCookieSize: number
-    ): void;
+    ): string;
     findPrevCookiesBasedOnUI(identityApiData: IdentityApiData): void;
-    encodePersistence(persistance: IPersistenceMinified): string;
-    decodePersistence(persistance: IPersistenceMinified): string;
-    replaceCommasWithPipes(string: string): string;
-    replacePipesWithCommas(string: string): string;
-    replaceApostrophesWithQuotes(string: string): string;
-    replaceQuotesWithApostrophes(string: string): string;
-    createCookieString(string: string): string;
-    revertCookieString(string: string): string;
+    encodePersistence(persistence: IPersistenceMinified): string;
+    decodePersistence(persistenceString: string): string;
     getCookieDomain(): string;
     getDomain(doc: string, locationHostname: string): string;
     getUserIdentities(mpid: MPID): UserIdentities;

package/src/persistence.js

@@ -1,5 +1,6 @@
 import Constants from './constants';
 import Polyfill from './polyfill';
+import * as Utils from './utils';
 
 var Base64 = Polyfill.Base64,
     Messages = Constants.Messages,
@@ -760,13 +761,15 @@ export default function _Persistence(mpInstance) {
             }
         }
 
-        return self.createCookieString(JSON.stringify(persistence));
+        return Utils.createCookieString(JSON.stringify(persistence));
     };
 
+    // TODO: This should actually be decodePersistenceString or
+    //       we should refactor this to take a string and return an object
     this.decodePersistence = function(persistence) {
         try {
             if (persistence) {
-                persistence = JSON.parse(self.revertCookieString(persistence));
+                persistence = JSON.parse(Utils.revertCookieString(persistence));
                 if (
                     mpInstance._Helpers.isObject(persistence) &&
                     Object.keys(persistence).length
@@ -817,34 +820,6 @@ export default function _Persistence(mpInstance) {
         }
     };
 
-    this.replaceCommasWithPipes = function(string) {
-        return string.replace(/,/g, '|');
-    };
-
-    this.replacePipesWithCommas = function(string) {
-        return string.replace(/\|/g, ',');
-    };
-
-    this.replaceApostrophesWithQuotes = function(string) {
-        return string.replace(/\'/g, '"');
-    };
-
-    this.replaceQuotesWithApostrophes = function(string) {
-        return string.replace(/\"/g, "'");
-    };
-
-    this.createCookieString = function(string) {
-        return self.replaceCommasWithPipes(
-            self.replaceQuotesWithApostrophes(string)
-        );
-    };
-
-    this.revertCookieString = function(string) {
-        return self.replacePipesWithCommas(
-            self.replaceApostrophesWithQuotes(string)
-        );
-    };
-
     this.getCookieDomain = function() {
         if (mpInstance._Store.SDKConfig.cookieDomain) {
             return mpInstance._Store.SDKConfig.cookieDomain;

package/src/sdkRuntimeModels.ts

@@ -142,7 +142,11 @@ export interface MParticleWebSDK {
     _NativeSdkHelpers: any; // TODO: Set up API
     _Persistence: IPersistence;
     _preInit: any; // TODO: Set up API
-    _resetForTests(MPConfig?: SDKInitConfig): void;
+    _resetForTests(
+        MPConfig?: SDKInitConfig,
+        keepPersistence?: boolean,
+        instance?: MParticleWebSDK
+    ): void;
     init(apiKey: string, config: SDKInitConfig, instanceName?: string): void;
     getAppName(): string;
     getAppVersion(): string;

package/src/store.ts

@@ -97,9 +97,9 @@ function createSDKConfig(config: SDKInitConfig): SDKConfig {
     return sdkConfig;
 }
 
-// TODO: Placeholder Types, MigrationData is temporary and will be removed in the future to reduce SDK size
+// TODO: Placeholder Types to be filled in as we migrate more modules
+//       to TypeScript
 export type PixelConfiguration = Dictionary;
-export type MigrationData = Dictionary;
 export type ServerSettings = Dictionary;
 export type SessionAttributes = Dictionary;
 export type IntegrationAttributes = Dictionary<Dictionary<string>>;
@@ -122,7 +122,6 @@ export interface IStore {
     clientId: string;
     deviceId: string;
     devToken: string | null;
-    migrationData: MigrationData;
     serverSettings: ServerSettings;
     dateLastEventSent: Date;
     sessionStartDate: Date;
@@ -137,7 +136,6 @@ export interface IStore {
     configurationLoaded: boolean;
     identityCallInFlight: boolean;
     SDKConfig: Partial<SDKConfig>;
-    migratingToIDSyncCookies: boolean; // TODO: Remove when we archive Web SDK v1
     nonCurrentUserMPIDs: Record<MPID, Dictionary>;
     identifyCalled: boolean;
     isLoggedIn: boolean;
@@ -173,7 +171,6 @@ export default function Store(
         clientId: null,
         deviceId: null,
         devToken: null,
-        migrationData: {},
         serverSettings: {},
         dateLastEventSent: null,
         sessionStartDate: null,
@@ -188,7 +185,6 @@ export default function Store(
         configurationLoaded: false,
         identityCallInFlight: false,
         SDKConfig: {},
-        migratingToIDSyncCookies: false,
         nonCurrentUserMPIDs: {},
         identifyCalled: false,
         isLoggedIn: false,
@@ -223,10 +219,9 @@ export default function Store(
             this.deviceId = config.deviceId;
         }
         if (config.hasOwnProperty('isDevelopmentMode')) {
-            this.SDKConfig.isDevelopmentMode =
-                mpInstance._Helpers.returnConvertedBoolean(
-                    config.isDevelopmentMode
-                );
+            this.SDKConfig.isDevelopmentMode = mpInstance._Helpers.returnConvertedBoolean(
+                config.isDevelopmentMode
+            );
         } else {
             this.SDKConfig.isDevelopmentMode = false;
         }

package/src/utils.ts

@@ -5,6 +5,12 @@ type valueof<T> = T[keyof T];
 // Placeholder for Dictionary-like Types
 export type Dictionary<V = any> = Record<string, V>;
 
+const createCookieString = (value: string): string =>
+    replaceCommasWithPipes(replaceQuotesWithApostrophes(value));
+
+const revertCookieString = (value: string): string =>
+    replacePipesWithCommas(replaceApostrophesWithQuotes(value));
+
 const inArray = (items: any[], name: string): boolean => {
     let i = 0;
 
@@ -134,6 +140,16 @@ const parseStringOrNumber = (
     }
 };
 
+const replaceCommasWithPipes = (value: string): string => value.replace(/,/g, '|');
+
+const replacePipesWithCommas = (value: string): string => value.replace(/\|/g, ',');
+
+const replaceApostrophesWithQuotes = (value: string): string =>
+    value.replace(/\'/g, '"');
+
+const replaceQuotesWithApostrophes = (value: string): string =>
+    value.replace(/\"/g, "'");
+
 // FIXME: REFACTOR for V3
 // only used in store.js to sanitize server-side formatting of
 // booleans when checking for `isDevelopmentMode`
@@ -172,6 +188,8 @@ const isEmpty = (value: Dictionary<any> | null | undefined): boolean =>
     value == null || !(Object.keys(value) || value).length;
 
 export {
+    createCookieString,
+    revertCookieString,
     valueof,
     converted,
     decoded,
@@ -184,6 +202,10 @@ export {
     isStringOrNumber,
     parseNumber,
     parseStringOrNumber,
+    replaceCommasWithPipes,
+    replacePipesWithCommas,
+    replaceApostrophesWithQuotes,
+    replaceQuotesWithApostrophes,
     returnConvertedBoolean,
     isString,
     isNumber,

package/src/migrations.js

@@ -1,279 +0,0 @@
-import Constants from './constants';
-import Polyfill from './polyfill';
-
-var StorageNames = Constants.StorageNames,
-    Base64 = Polyfill.Base64,
-    CookiesGlobalSettingsKeys = {
-        das: 1,
-    },
-    MPIDKeys = {
-        ui: 1,
-    };
-
-export default function Migrations(mpInstance) {
-    var self = this;
-    //  if there is a cookie or localStorage:
-    //  1. determine which version it is ('mprtcl-api', 'mprtcl-v2', 'mprtcl-v3', 'mprtcl-v4')
-    //  2. return if 'mprtcl-v4', otherwise migrate to mprtclv4 schema
-    // 3. if 'mprtcl-api', could be JSSDKv2 or JSSDKv1. JSSDKv2 cookie has a 'globalSettings' key on it
-    this.migrate = function() {
-        try {
-            migrateCookies();
-        } catch (e) {
-            mpInstance._Persistence.expireCookies(StorageNames.cookieNameV3);
-            mpInstance._Persistence.expireCookies(StorageNames.cookieNameV4);
-            mpInstance.Logger.error('Error migrating cookie: ' + e);
-        }
-
-        if (mpInstance._Store.isLocalStorageAvailable) {
-            try {
-                migrateLocalStorage();
-            } catch (e) {
-                localStorage.removeItem(StorageNames.localStorageNameV3);
-                localStorage.removeItem(StorageNames.localStorageNameV4);
-                mpInstance.Logger.error('Error migrating localStorage: ' + e);
-            }
-        }
-    };
-
-    function migrateCookies() {
-        var cookies = window.document.cookie.split('; '),
-            foundCookie,
-            i,
-            l,
-            parts,
-            name,
-            cookie;
-
-        mpInstance.Logger.verbose(
-            Constants.Messages.InformationMessages.CookieSearch
-        );
-
-        for (i = 0, l = cookies.length; i < l; i++) {
-            try {
-                parts = cookies[i].split('=');
-                name = mpInstance._Helpers.decoded(parts.shift());
-                cookie = mpInstance._Helpers.decoded(parts.join('='));
-            } catch (e) {
-                mpInstance.Logger.verbose(
-                    'Unable to parse cookie: ' + name + '. Skipping.'
-                );
-            }
-
-            //most recent version needs no migration
-            if (name === mpInstance._Store.storageName) {
-                return;
-            }
-            if (name === StorageNames.cookieNameV4) {
-                // adds cookies to new namespace, removes previous cookie
-                finishCookieMigration(cookie, StorageNames.cookieNameV4);
-                if (mpInstance._Store.isLocalStorageAvailable) {
-                    migrateProductsToNameSpace();
-                }
-                return;
-                // migration path for SDKv1CookiesV3, doesn't need to be encoded
-            }
-            if (name === StorageNames.cookieNameV3) {
-                foundCookie = self.convertSDKv1CookiesV3ToSDKv2CookiesV4(
-                    cookie
-                );
-                finishCookieMigration(foundCookie, StorageNames.cookieNameV3);
-                break;
-            }
-        }
-    }
-
-    function finishCookieMigration(cookie, cookieName) {
-        var date = new Date(),
-            cookieDomain = mpInstance._Persistence.getCookieDomain(),
-            expires,
-            domain;
-
-        expires = new Date(
-            date.getTime() + StorageNames.CookieExpiration * 24 * 60 * 60 * 1000
-        ).toGMTString();
-
-        if (cookieDomain === '') {
-            domain = '';
-        } else {
-            domain = ';domain=' + cookieDomain;
-        }
-
-        mpInstance.Logger.verbose(
-            Constants.Messages.InformationMessages.CookieSet
-        );
-
-        window.document.cookie =
-            encodeURIComponent(mpInstance._Store.storageName) +
-            '=' +
-            cookie +
-            ';expires=' +
-            expires +
-            ';path=/' +
-            domain;
-
-        mpInstance._Persistence.expireCookies(cookieName);
-        mpInstance._Store.migratingToIDSyncCookies = true;
-    }
-
-    this.convertSDKv1CookiesV3ToSDKv2CookiesV4 = function(SDKv1CookiesV3) {
-        SDKv1CookiesV3 = mpInstance._Persistence.replacePipesWithCommas(
-            mpInstance._Persistence.replaceApostrophesWithQuotes(SDKv1CookiesV3)
-        );
-        var parsedSDKv1CookiesV3 = JSON.parse(SDKv1CookiesV3);
-        var parsedCookiesV4 = JSON.parse(restructureToV4Cookie(SDKv1CookiesV3));
-
-        if (parsedSDKv1CookiesV3.mpid) {
-            parsedCookiesV4.gs.csm.push(parsedSDKv1CookiesV3.mpid);
-            // all other values are already encoded, so we have to encode any new values
-            parsedCookiesV4.gs.csm = Base64.encode(
-                JSON.stringify(parsedCookiesV4.gs.csm)
-            );
-            migrateProductsFromSDKv1ToSDKv2CookiesV4(
-                parsedSDKv1CookiesV3,
-                parsedSDKv1CookiesV3.mpid
-            );
-        }
-
-        return JSON.stringify(parsedCookiesV4);
-    };
-
-    function restructureToV4Cookie(cookies) {
-        try {
-            var cookiesV4Schema = { gs: { csm: [] } };
-            cookies = JSON.parse(cookies);
-
-            for (var key in cookies) {
-                if (cookies.hasOwnProperty(key)) {
-                    if (CookiesGlobalSettingsKeys[key]) {
-                        cookiesV4Schema.gs[key] = cookies[key];
-                    } else if (key === 'mpid') {
-                        cookiesV4Schema.cu = cookies[key];
-                    } else if (cookies.mpid) {
-                        cookiesV4Schema[cookies.mpid] =
-                            cookiesV4Schema[cookies.mpid] || {};
-                        if (MPIDKeys[key]) {
-                            cookiesV4Schema[cookies.mpid][key] = cookies[key];
-                        }
-                    }
-                }
-            }
-            return JSON.stringify(cookiesV4Schema);
-        } catch (e) {
-            mpInstance.Logger.error(
-                'Failed to restructure previous cookie into most current cookie schema'
-            );
-        }
-    }
-
-    function migrateProductsToNameSpace() {
-        var lsProdV4Name = StorageNames.localStorageProductsV4;
-        var products = localStorage.getItem(
-            StorageNames.localStorageProductsV4
-        );
-        localStorage.setItem(mpInstance._Store.prodStorageName, products);
-        localStorage.removeItem(lsProdV4Name);
-    }
-
-    function migrateProductsFromSDKv1ToSDKv2CookiesV4(cookies, mpid) {
-        if (!mpInstance._Store.isLocalStorageAvailable) {
-            return;
-        }
-
-        var localStorageProducts = {};
-        localStorageProducts[mpid] = {};
-        if (cookies.cp) {
-            try {
-                localStorageProducts[mpid].cp = JSON.parse(
-                    Base64.decode(cookies.cp)
-                );
-            } catch (e) {
-                localStorageProducts[mpid].cp = cookies.cp;
-            }
-
-            if (!Array.isArray(localStorageProducts[mpid].cp)) {
-                localStorageProducts[mpid].cp = [];
-            }
-        }
-
-        localStorage.setItem(
-            mpInstance._Store.prodStorageName,
-            Base64.encode(JSON.stringify(localStorageProducts))
-        );
-    }
-
-    function migrateLocalStorage() {
-        var cookies,
-            v3LSName = StorageNames.localStorageNameV3,
-            v4LSName = StorageNames.localStorageNameV4,
-            currentVersionLSData = window.localStorage.getItem(
-                mpInstance._Store.storageName
-            ),
-            v4LSData,
-            v3LSData,
-            v3LSDataStringCopy;
-
-        if (currentVersionLSData) {
-            return;
-        }
-
-        v4LSData = window.localStorage.getItem(v4LSName);
-        if (v4LSData) {
-            finishLSMigration(v4LSData, v4LSName);
-            migrateProductsToNameSpace();
-            return;
-        }
-
-        v3LSData = window.localStorage.getItem(v3LSName);
-        if (v3LSData) {
-            mpInstance._Store.migratingToIDSyncCookies = true;
-            v3LSDataStringCopy = v3LSData.slice();
-            v3LSData = JSON.parse(
-                mpInstance._Persistence.replacePipesWithCommas(
-                    mpInstance._Persistence.replaceApostrophesWithQuotes(
-                        v3LSData
-                    )
-                )
-            );
-            // localStorage may contain only products, or the full persistence
-            // when there is an MPID on the cookie, it is the full persistence
-            if (v3LSData.mpid) {
-                v3LSData = JSON.parse(
-                    self.convertSDKv1CookiesV3ToSDKv2CookiesV4(
-                        v3LSDataStringCopy
-                    )
-                );
-                finishLSMigration(JSON.stringify(v3LSData), v3LSName);
-                return;
-                // if no MPID, it is only the products
-            } else if ((v3LSData.cp || v3LSData.pb) && !v3LSData.mpid) {
-                cookies = mpInstance._Persistence.getCookie();
-                if (cookies) {
-                    migrateProductsFromSDKv1ToSDKv2CookiesV4(
-                        v3LSData,
-                        cookies.cu
-                    );
-                    localStorage.removeItem(StorageNames.localStorageNameV3);
-                    return;
-                } else {
-                    localStorage.removeItem(StorageNames.localStorageNameV3);
-                    return;
-                }
-            }
-        }
-
-        function finishLSMigration(data, lsName) {
-            try {
-                window.localStorage.setItem(
-                    encodeURIComponent(mpInstance._Store.storageName),
-                    data
-                );
-            } catch (e) {
-                mpInstance.Logger.error(
-                    'Error with setting localStorage item.'
-                );
-            }
-            window.localStorage.removeItem(encodeURIComponent(lsName));
-        }
-    }
-}