@mparticle/web-sdk 2.20.3 → 2.21.1

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@mparticle/web-sdk",
-    "version": "2.20.3",
+    "version": "2.21.1",
     "description": "mParticle core SDK for web applications",
     "license": "Apache-2.0",
     "keywords": [
@@ -29,18 +29,23 @@
         "build:stub": "cross-env ENVIRONMENT=prod BUILD=stub rollup --config rollup.config.js",
         "build:snippet": "uglifyjs snippet.js -nm -o snippet.min.js",
         "build:test-bundle": "cross-env TESTTYPE=main ENVIRONMENT=prod rollup --config rollup.test.config.js",
-        "build:browserify:cjs": "browserify test/integrations/cjs/browserify/index.js -o test/integrations/cjs/dist/browserify-output.js  && npm run test:karma:browserify:cjs",
-        "build:rollup:cjs": "rollup --config test/integrations/cjs/rollup/rollup.config.js  && npm run test:karma:rollup:cjs",
-        "build:webpack:cjs": "webpack --config test/integrations/cjs/webpack/webpack.config.js && npm run test:karma:webpack:cjs",
-        "build:rollup:module": "rollup --config test/integrations/module/rollup/rollup.config.js  && npm run test:karma:rollup:module",
-        "build:webpack:module": "webpack --config test/integrations/module/webpack/webpack.config.js && npm run test:karma:webpack:module",
+        "build:browserify:cjs": "browserify test/integrations/cjs/browserify/index.js -o test/integrations/cjs/dist/browserify-output.js",
+        "build:rollup:cjs": "rollup --config test/integrations/cjs/rollup/rollup.config.js",
+        "build:webpack:cjs": "webpack --config test/integrations/cjs/webpack/webpack.config.js",
+        "build:rollup:module": "rollup --config test/integrations/module/rollup/rollup.config.js",
+        "build:webpack:module": "webpack --config test/integrations/module/webpack/webpack.config.js",
         "build:ts": "tsc -p .",
         "test": "npm run build && npm run build:test-bundle && cross-env DEBUG=false karma start test/karma.config.js",
         "test:debug": "cross-env DEBUG=true karma start test/karma.config.js",
         "test:stub": "cross-env TESTTYPE=stub ENVIRONMENT=prod rollup --config rollup.test.config.js && karma start test/stub/karma.stub.config.js",
         "test:integrations": "npm run test:requirejs && npm run test:integrations:cjs && npm run test:integrations:module",
-        "test:integrations:cjs": "npm run build:browserify:cjs && npm run build:webpack:cjs && npm run build:rollup:cjs",
-        "test:integrations:module": "npm run build:webpack:module && npm run build:rollup:module",
+        "test:integrations:cjs": "npm run test:integrations:cjs:browserfy && npm run test:integrations:cjs:webpack && npm run test:integrations:cjs:rollup",
+        "test:integrations:cjs:browserfy": "npm run build:browserify:cjs && npm run test:karma:browserify:cjs",
+        "test:integrations:cjs:webpack": "npm run build:webpack:cjs && npm run test:karma:webpack:cjs",
+        "test:integrations:cjs:rollup": "npm run build:rollup:cjs && npm run test:karma:rollup:cjs",
+        "test:integrations:module": "npm run test:integrations:module:webpack && npm run test:integrations:module:rollup",
+        "test:integrations:module:webpack": "npm run build:webpack:module && npm run test:karma:webpack:module",
+        "test:integrations:module:rollup": "npm run build:rollup:module && npm run test:karma:rollup:module",
         "test:requirejs": "npm run test:requirejs:before && npm run test:requirejs:after",
         "test:requirejs:before": "cross-env FILE_ORDER=before_mp karma start test/integrations/requirejs/karma.requirejs.config.js",
         "test:requirejs:after": "cross-env FILE_ORDER=after_mp karma start test/integrations/requirejs/karma.requirejs.config.js",
@@ -49,6 +54,8 @@
         "test:karma:rollup:cjs": "cross-env BUNDLER=rollup karma start test/integrations/cjs/karma.rollup.config.js",
         "test:karma:webpack:module": "cross-env BUNDLER=webpack karma start test/integrations/module/karma.webpack.config.js",
         "test:karma:rollup:module": "cross-env BUNDLER=rollup karma start test/integrations/module/karma.rollup.config.js",
+        "test:jest": "jest --config jest.config.js",
+        "test:jest:watch": "jest --config jest.config.js --watch",
         "watch": "cross-env ENVIRONMENT=dev BUILD=iife rollup --config rollup.config.js -w",
         "watch:all": "cross-env ENVIRONMENT=prod BUILDALL=true rollup --config rollup.config.js -w",
         "watch:tests": "cross-env ENVIRONMENT=dev TESTTYPE=main rollup --config rollup.test.config.js -w",
@@ -76,15 +83,17 @@
         "@babel/preset-typescript": "^7.6.0",
         "@mparticle/data-planning-models": "^0.1.0",
         "@mparticle/event-models": "^1.1.6",
-        "@rollup/plugin-json": "^4.1.0",
-        "@rollup/plugin-typescript": "^8.3.3",
         "@rollup/plugin-babel": "6.0.3",
         "@rollup/plugin-commonjs": "22.0.2",
+        "@rollup/plugin-json": "^4.1.0",
         "@rollup/plugin-node-resolve": "13.3.0",
+        "@rollup/plugin-typescript": "^8.3.3",
         "@semantic-release/changelog": "^5.0.1",
         "@semantic-release/exec": "^5.0.0",
         "@semantic-release/git": "^9.0.0",
         "@types/chai": "^4.2.3",
+        "@types/jest": "^29.5.1",
+        "@types/jest-expect-message": "^1.1.0",
         "@types/mocha": "^9.0.0",
         "@types/mparticle__web-sdk": "^2.16.1",
         "@types/node": "^18.7.11",
@@ -98,6 +107,7 @@
         "eslint-plugin-prettier": "3.4.1",
         "fetch-mock": "^7.5.1",
         "gts": "^3.1.0",
+        "jest": "^29.5.0",
         "karma": "^6.3.2",
         "karma-chai": "^0.1.0",
         "karma-chrome-launcher": "^3.1.0",
@@ -115,6 +125,7 @@
         "shelljs": "^0.8.4",
         "should": "^7.1.0",
         "sinon": "^11.0.0",
+        "ts-jest": "^29.1.0",
         "tslib": "^2.1.0",
         "typescript": "^5.0.2",
         "uglify-js": "^3.4.9",

package/src/batchUploader.ts

@@ -1,4 +1,5 @@
 import { Batch } from '@mparticle/event-models';
+import Constants from './constants';
 import {
     SDKEvent,
     MParticleUser,
@@ -7,12 +8,17 @@ import {
 } from './sdkRuntimeModels';
 import { convertEvents } from './sdkToEventsApiConverter';
 import Types from './types';
-import { isEmpty } from './utils';
+import { getRampNumber, isEmpty } from './utils';
+import { SessionStorageVault, LocalStorageVault } from './vault';
 
 /**
- * BatchUploader contains all the logic to upload batches to mParticle.
- * It queues events as they come in and at set intervals turns them into batches.
- * It then attempts to upload them to mParticle.
+ * BatchUploader contains all the logic to store/retrieve events and batches
+ * to/from persistence, and upload batches to mParticle.
+ * It queues events as they come in, storing them in persistence, then at set
+ * intervals turns them into batches and transfers between event and batch
+ * persistence.
+ * It then attempts to upload them to mParticle, purging batch persistence if
+ * the upload is successful
  *
  * These uploads happen on an interval basis using window.fetch or XHR
  * requests, depending on what is available in the browser.
@@ -31,6 +37,9 @@ export class BatchUploader {
     mpInstance: MParticleWebSDK;
     uploadUrl: string;
     batchingEnabled: boolean;
+    private eventVault: SessionStorageVault<SDKEvent[]>;
+    private batchVault: LocalStorageVault<Batch[]>;
+    private offlineStorageEnabled: boolean = false;
     private uploader: AsyncUploader;
 
     /**
@@ -46,9 +55,38 @@ export class BatchUploader {
         if (this.uploadIntervalMillis < BatchUploader.MINIMUM_INTERVAL_MILLIS) {
             this.uploadIntervalMillis = BatchUploader.MINIMUM_INTERVAL_MILLIS;
         }
+
+        // Events will be queued during `queueEvents` method
         this.eventsQueuedForProcessing = [];
+
+        // Batch queue should start empty and will be populated during
+        // `prepareAndUpload` method, either via Local Storage or after
+        // new batches are created.
         this.batchesQueuedForProcessing = [];
 
+        // Cache Offline Storage Availability boolean
+        // so that we don't have to check it every time
+        this.offlineStorageEnabled = this.isOfflineStorageAvailable();
+
+        if (this.offlineStorageEnabled) {
+            this.eventVault = new SessionStorageVault<SDKEvent[]>(
+                `${mpInstance._Store.storageName}-events`,
+                {
+                    logger: mpInstance.Logger,
+                }
+            );
+
+            this.batchVault = new LocalStorageVault<Batch[]>(
+                `${mpInstance._Store.storageName}-batches`,
+                {
+                    logger: mpInstance.Logger,
+                }
+            );
+
+            // Load Events from Session Storage in case we have any in storage
+            this.eventsQueuedForProcessing.push(...this.eventVault.retrieve());
+        }
+
         const { SDKConfig, devToken } = this.mpInstance._Store;
         const baseUrl = this.mpInstance._Helpers.createServiceUrl(
             SDKConfig.v3SecureServiceUrl,
@@ -64,6 +102,29 @@ export class BatchUploader {
         this.addEventListeners();
     }
 
+    private isOfflineStorageAvailable(): boolean {
+        const {
+            _Helpers: { getFeatureFlag },
+            _Store: { deviceId },
+        } = this.mpInstance;
+
+        const offlineStorageFeatureFlagValue = getFeatureFlag(
+            Constants.FeatureFlags.OfflineStorage
+        );
+
+        const offlineStoragePercentage = parseInt(
+            offlineStorageFeatureFlagValue,
+            10
+        );
+
+        const rampNumber = getRampNumber(deviceId);
+
+        // TODO: Handle cases where Local Storage is unavailable
+        //       Potentially shared between Vault and Persistence as well
+        //       https://go.mparticle.com/work/SQDSDKS-5022
+        return offlineStoragePercentage >= rampNumber;
+    }
+
     // Adds listeners to be used trigger Navigator.sendBeacon if the browser
     // loses focus for any reason, such as closing browser tab or minimizing window
     private addEventListeners() {
@@ -102,9 +163,12 @@ export class BatchUploader {
      * This method will queue a single Event which will eventually be processed into a Batch
      * @param event event that should be queued
      */
-    queueEvent(event: SDKEvent): void {
+    public queueEvent(event: SDKEvent): void {
         if (!isEmpty(event)) {
             this.eventsQueuedForProcessing.push(event);
+            if (this.offlineStorageEnabled && this.eventVault) {
+                this.eventVault.store(this.eventsQueuedForProcessing);
+            }
             this.mpInstance.Logger.verbose(
                 `Queuing event: ${JSON.stringify(event)}`
             );
@@ -214,14 +278,32 @@ export class BatchUploader {
         // Fetch current user so that events can be grouped by MPID
         const currentUser = this.mpInstance.Identity.getCurrentUser();
 
-        const currentEvents = this.eventsQueuedForProcessing;
+        const currentEvents: SDKEvent[] = this.eventsQueuedForProcessing;
+
         this.eventsQueuedForProcessing = [];
+        if (this.offlineStorageEnabled && this.eventVault) {
+            this.eventVault.store([]);
+        }
 
-        const newBatches = BatchUploader.createNewBatches(
-            currentEvents,
-            currentUser,
-            this.mpInstance
-        );
+        let newBatches: Batch[] = [];
+        if (!isEmpty(currentEvents)) {
+            newBatches = BatchUploader.createNewBatches(
+                currentEvents,
+                currentUser,
+                this.mpInstance
+            );
+        }
+
+        // Top Load any older Batches from Offline Storage so they go out first
+        if (this.offlineStorageEnabled && this.batchVault) {
+            this.batchesQueuedForProcessing.unshift(
+                ...this.batchVault.retrieve()
+            );
+
+            // Remove batches from local storage before transmit to
+            // prevent duplication
+            this.batchVault.purge();
+        }
 
         if (!isEmpty(newBatches)) {
             this.batchesQueuedForProcessing.push(...newBatches);
@@ -231,6 +313,13 @@ export class BatchUploader {
         const batchesToUpload = this.batchesQueuedForProcessing;
         this.batchesQueuedForProcessing = [];
 
+        // If `useBeacon` is true, the browser has been closed suddently
+        // so we should save `batchesToUpload` to Offline Storage before
+        // an upload is attempted.
+        if (useBeacon && this.offlineStorageEnabled && this.batchVault) {
+            this.batchVault.store(batchesToUpload);
+        }
+
         const batchesThatDidNotUpload = await this.uploadBatches(
             this.mpInstance.Logger,
             batchesToUpload,
@@ -245,6 +334,19 @@ export class BatchUploader {
             this.batchesQueuedForProcessing.unshift(...batchesThatDidNotUpload);
         }
 
+        // Update Offline Storage with current state of batch queue
+        if (!useBeacon && this.offlineStorageEnabled && this.batchVault) {
+            // Note: since beacon is "Fire and forget" it will empty `batchesThatDidNotUplod`
+            // regardless of whether the batches were successfully uploaded or not. We should
+            // therefore NOT overwrite Offline Storage when beacon returns, so that we can retry
+            // uploading saved batches at a later time. Batches should only be removed from
+            // Local Storage once we can confirm they are successfully uploaded.
+            this.batchVault.store(this.batchesQueuedForProcessing);
+
+            // Clear batch queue since everything should be in Offline Storage
+            this.batchesQueuedForProcessing = [];
+        }
+
         if (triggerFuture) {
             this.triggerUploadInterval(triggerFuture, false);
         }

package/src/constants.ts

@@ -161,6 +161,7 @@ const Constants = {
         ReportBatching: 'reportBatching',
         EventsV3: 'eventsV3',
         EventBatchingIntervalMillis: 'eventBatchingIntervalMillis',
+        OfflineStorage: 'offlineStorage',
     },
     DefaultInstance: 'default_instance',
 } as const;

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

@@ -4,8 +4,9 @@ import ServerModel from './serverModel';
 import { SDKEvent, BaseEvent, MParticleWebSDK } from './sdkRuntimeModels';
 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 {
@@ -13,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,
@@ -49,7 +50,6 @@ export default class _BatchValidator {
                 consentState: null,
                 clientId: null,
                 deviceId: null,
-                migrationData: {},
                 serverSettings: {},
                 dateLastEventSent: null,
                 sessionStartDate: null,
@@ -63,7 +63,6 @@ export default class _BatchValidator {
                 context: null,
                 configurationLoaded: false,
                 identityCallInFlight: false,
-                migratingToIDSyncCookies: false,
                 nonCurrentUserMPIDs: {},
                 identifyCalled: false,
                 isLoggedIn: false,
@@ -119,16 +118,19 @@ export default class _BatchValidator {
         } as MParticleWebSDK;
     }
 
-    returnBatch(event: BaseEvent) {
+    private createSDKEventFunction(event): SDKEvent {
+        return new ServerModel(this.getMPInstance()).createEventObject(event);
+    }
+
+    public returnBatch(events: BaseEvent | BaseEvent[]): Batch | null {
         const mpInstance = this.getMPInstance();
-        const sdkEvent: SDKEvent = new ServerModel(
-            mpInstance
-        ).createEventObject(event);
-        const batch: EventsApi.Batch | null = convertEvents(
-            '0',
-            [sdkEvent],
-            mpInstance as any
-        );
+
+        const sdkEvents: SDKEvent[] = Array.isArray(events)
+            ? events.map(event => this.createSDKEventFunction(event))
+            : [this.createSDKEventFunction(events)];
+
+        const batch: Batch = convertEvents('0', sdkEvents, mpInstance as any);
+
         return batch;
     }
 }

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;
         }
@@ -444,5 +439,12 @@ export default function Store(
         ) {
             this.SDKConfig.flags[Constants.FeatureFlags.ReportBatching] = false;
         }
+        if (
+            !this.SDKConfig.flags.hasOwnProperty(
+                Constants.FeatureFlags.OfflineStorage
+            )
+        ) {
+            this.SDKConfig.flags[Constants.FeatureFlags.OfflineStorage] = 0;
+        }
     }
 }

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,