@mparticle/web-sdk 2.20.3 → 2.21.1

package/src/vault.ts

@@ -1,25 +1,30 @@
 import { Logger } from '@mparticle/web-sdk';
-import { Dictionary, isEmpty } from './utils';
+import { isEmpty } from './utils';
 
-interface IVaultOptions {
+export interface IVaultOptions {
     logger?: Logger;
     offlineStorageEnabled?: boolean;
 }
 
-export default class Vault<StorableItem> {
+export abstract class BaseVault<StorableItem> {
     public contents: StorableItem;
-    private readonly _storageKey: string;
-    private logger?: Logger;
+    protected readonly _storageKey: string;
+    protected logger?: Logger;
+    protected storageObject: Storage;
 
     /**
      *
      * @param {string} storageKey the local storage key string
-     * @param {string} itemKey an element within your StorableItem to use as a key
+     * @param {Storage} Web API Storage object that is being used
      * @param {IVaultOptions} options A Dictionary of IVaultOptions
      */
-    constructor(storageKey: string, options?: IVaultOptions) {
+    constructor(
+        storageKey: string,
+        storageObject: Storage,
+        options?: IVaultOptions
+    ) {
         this._storageKey = storageKey;
-        this.contents = this.getFromLocalStorage();
+        this.storageObject = storageObject;
 
         // Add a fake logger in case one is not provided or needed
         this.logger = options?.logger || {
@@ -27,62 +32,69 @@ export default class Vault<StorableItem> {
             warning: () => {},
             error: () => {},
         };
+
+        this.contents = this.retrieve();
     }
 
     /**
-     * Stores a StorableItem to Local Storage
-     * @method storeItem
+     * Stores a StorableItem to Storage
+     * @method store
      * @param item {StorableItem}
      */
     public store(item: StorableItem): void {
         this.contents = item;
 
-        this.logger.verbose(`Saved to local storage: ${item}`);
+        const stringifiedItem = !isEmpty(item) ? JSON.stringify(item) : '';
+
+        try {
+            this.storageObject.setItem(this._storageKey, stringifiedItem);
 
-        this.saveToLocalStorage(this.contents);
+            this.logger.verbose(`Saving item to Storage: ${stringifiedItem}`);
+        } catch (error) {
+            this.logger.error(
+                `Cannot Save items to Storage: ${stringifiedItem}`
+            );
+            this.logger.error(error as string);
+        }
     }
 
     /**
-     * Retrieves all StorableItems from local storage as an array
-     * @method retrieveItems
-     * @returns {StorableItem[]} an array of Items
+     * Retrieve StorableItem from Storage
+     * @method retrieve
+     * @returns {StorableItem}
      */
-    public retrieve(): StorableItem {
-        this.contents = this.getFromLocalStorage();
+    public retrieve(): StorableItem | null {
+        // TODO: Handle cases where Local Storage is unavailable
+        // https://go.mparticle.com/work/SQDSDKS-5022
+        const item: string = this.storageObject.getItem(this._storageKey);
+
+        this.contents = item ? JSON.parse(item) : null;
+
+        this.logger.verbose(`Retrieving item from Storage: ${item}`);
 
         return this.contents;
     }
 
     /**
-     * Removes all persisted data from local storage based on this vault's `key`
+     * Removes all persisted data from Storage based on this vault's `key`
+     * Will remove storage key from Storage as well
      * @method purge
      */
     public purge(): void {
+        this.logger.verbose('Purging Storage');
         this.contents = null;
-        this.removeFromLocalStorage();
-    }
-
-    private saveToLocalStorage(items: StorableItem): void {
-        try {
-            window.localStorage.setItem(
-                this._storageKey,
-                !isEmpty(items) ? JSON.stringify(items) : ''
-            );
-        } catch (error) {
-            this.logger.error(`Cannot Save items to Local Storage: ${items}`);
-            this.logger.error(error as string);
-        }
+        this.storageObject.removeItem(this._storageKey);
     }
+}
 
-    private getFromLocalStorage(): StorableItem | null {
-        // TODO: Handle cases where Local Storage is unavailable
-        // https://go.mparticle.com/work/SQDSDKS-5022
-        const item: string = window.localStorage.getItem(this._storageKey);
-
-        return item ? JSON.parse(item) : null;
+export class LocalStorageVault<StorableItem> extends BaseVault<StorableItem> {
+    constructor(storageKey: string, options?: IVaultOptions) {
+        super(storageKey, window.localStorage, options);
     }
+}
 
-    private removeFromLocalStorage(): void {
-        window.localStorage.removeItem(this._storageKey);
+export class SessionStorageVault<StorableItem> extends BaseVault<StorableItem> {
+    constructor(storageKey: string, options?: IVaultOptions) {
+        super(storageKey, window.sessionStorage, options);
     }
 }

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));
-        }
-    }
-}