@mparticle/web-sdk 2.32.0 → 2.32.1

package/src/utils.ts

@@ -1,3 +1,4 @@
+import { MPID } from '@mparticle/web-sdk';
 import Constants from './constants';
 
 const { Messages } = Constants;
@@ -175,6 +176,27 @@ const replaceApostrophesWithQuotes = (value: string): string =>
 const replaceQuotesWithApostrophes = (value: string): string =>
     value.replace(/\"/g, "'");
 
+const replaceMPID = (value: string, mpid: MPID): string => value.replace('%%mpid%%', mpid);
+
+const replaceAmpWithAmpersand = (value: string): string => value.replace(/&/g, '&');
+
+const createCookieSyncUrl = (
+    mpid: MPID,
+    pixelUrl: string,
+    redirectUrl?: string
+): string => {
+    const modifiedPixelUrl = replaceAmpWithAmpersand(pixelUrl);
+    const modifiedDirectUrl = redirectUrl
+        ? replaceAmpWithAmpersand(redirectUrl)
+        : null;
+
+    const url = replaceMPID(modifiedPixelUrl, mpid);
+    const redirect = modifiedDirectUrl
+        ? replaceMPID(modifiedDirectUrl, mpid)
+        : '';
+    return url + encodeURIComponent(redirect);
+};
+
 // FIXME: REFACTOR for V3
 // only used in store.js to sanitize server-side formatting of
 // booleans when checking for `isDevelopmentMode`
@@ -336,6 +358,7 @@ const getHref = (): string => {
 export {
     createCookieString,
     revertCookieString,
+    createCookieSyncUrl,
     valueof,
     converted,
     decoded,
@@ -366,4 +389,6 @@ export {
     queryStringParser,
     getCookies,
     getHref,
+    replaceMPID,
+    replaceAmpWithAmpersand,
 };

package/src/cookieSyncManager.js

@@ -1,197 +0,0 @@
-import Constants from './constants';
-
-var Messages = Constants.Messages;
-
-export default function cookieSyncManager(mpInstance) {
-    var self = this;
-
-    // Public
-    this.attemptCookieSync = function(previousMPID, mpid, mpidIsNotInCookies) {
-        // TODO: These should move inside the for loop
-        var pixelConfig,
-            lastSyncDateForModule,
-            url,
-            redirect,
-            urlWithRedirect,
-            requiresConsent;
-
-        // TODO: Make this exit quicker instead of nested
-        if (mpid && !mpInstance._Store.webviewBridgeEnabled) {
-            mpInstance._Store.pixelConfigurations.forEach(function(
-                pixelSettings
-            ) {
-                // set requiresConsent to false to start each additional pixel configuration
-                // set to true only if filteringConsenRuleValues.values.length exists
-                requiresConsent = false;
-
-                // TODO: Replace with isEmpty
-                if (
-                    pixelSettings.filteringConsentRuleValues &&
-                    pixelSettings.filteringConsentRuleValues.values &&
-                    pixelSettings.filteringConsentRuleValues.values.length
-                ) {
-                    requiresConsent = true;
-                }
-
-                pixelConfig = {
-                    // Kit Module ID
-                    moduleId: pixelSettings.moduleId,
-
-                    // Tells you how often we should do a cookie sync (in days)
-                    frequencyCap: pixelSettings.frequencyCap,
-
-                    // Url for cookie sync pixel
-                    pixelUrl: self.replaceAmp(pixelSettings.pixelUrl),
-
-                    // TODO: Document requirements for redirectUrl
-                    redirectUrl: pixelSettings.redirectUrl
-                        ? self.replaceAmp(pixelSettings.redirectUrl)
-                        : null,
-
-                    // Filtering rules as defined in UI
-                    filteringConsentRuleValues:
-                        pixelSettings.filteringConsentRuleValues,
-                };
-
-                // TODO: combine replaceMPID and replaceAmp into sanitizeUrl function
-                url = self.replaceMPID(pixelConfig.pixelUrl, mpid);
-                redirect = pixelConfig.redirectUrl
-                    ? self.replaceMPID(pixelConfig.redirectUrl, mpid)
-                    : '';
-                urlWithRedirect = url + encodeURIComponent(redirect);
-
-                // TODO: Refactor so that Persistence is only called once
-                //       outside of the loop
-                var persistence = mpInstance._Persistence.getPersistence();
-
-                // TODO: Is there a historic reason for checking for previousMPID?
-                //       it does not appear to be passed in anywhere
-                if (previousMPID && previousMPID !== mpid) {
-                    if (persistence && persistence[mpid]) {
-                        if (!persistence[mpid].csd) {
-                            persistence[mpid].csd = {};
-                        }
-                        self.performCookieSync(
-                            urlWithRedirect,
-                            pixelConfig.moduleId,
-                            mpid,
-                            persistence[mpid].csd,
-                            pixelConfig.filteringConsentRuleValues,
-                            mpidIsNotInCookies,
-                            requiresConsent
-                        );
-                    }
-                    return;
-                } else {
-                    // TODO: Refactor to check for the inverse and exit early
-                    //       rather than nesting
-                    if (persistence[mpid]) {
-                        if (!persistence[mpid].csd) {
-                            persistence[mpid].csd = {};
-                        }
-                        lastSyncDateForModule = persistence[mpid].csd[
-                            pixelConfig.moduleId.toString()
-                        ]
-                            ? persistence[mpid].csd[
-                                  pixelConfig.moduleId.toString()
-                              ]
-                            : null;
-
-                        if (lastSyncDateForModule) {
-                            // Check to see if we need to refresh cookieSync
-                            if (
-                                // TODO: Turn this into a convenience method for readability?
-                                //       We use similar comparisons elsewhere in the SDK,
-                                //       so perhaps we can make a time comparison convenience method
-                                new Date().getTime() >
-                                new Date(lastSyncDateForModule).getTime() +
-                                    pixelConfig.frequencyCap *
-                                        // TODO: Turn these numbers into a constant so
-                                        //       we can remember what this number is for
-                                        60 *
-                                        1000 *
-                                        60 *
-                                        24
-                            ) {
-                                self.performCookieSync(
-                                    urlWithRedirect,
-                                    pixelConfig.moduleId,
-                                    mpid,
-                                    persistence[mpid].csd,
-                                    pixelConfig.filteringConsentRuleValues,
-                                    mpidIsNotInCookies,
-                                    requiresConsent
-                                );
-                            }
-                        } else {
-                            self.performCookieSync(
-                                urlWithRedirect,
-                                pixelConfig.moduleId,
-                                mpid,
-                                persistence[mpid].csd,
-                                pixelConfig.filteringConsentRuleValues,
-                                mpidIsNotInCookies,
-                                requiresConsent
-                            );
-                        }
-                    }
-                }
-            });
-        }
-    };
-
-    // Private
-    this.replaceMPID = function(string, mpid) {
-        return string.replace('%%mpid%%', mpid);
-    };
-
-    // Private
-    // TODO: Rename function to replaceAmpWithAmpersand
-    this.replaceAmp = function(string) {
-        return string.replace(/&/g, '&');
-    };
-
-    // Private
-    this.performCookieSync = function(
-        url,
-        moduleId,
-        mpid,
-        cookieSyncDates,
-        filteringConsentRuleValues,
-        mpidIsNotInCookies,
-        requiresConsent
-    ) {
-        // if MPID is new to cookies, we should not try to perform the cookie sync
-        // because a cookie sync can only occur once a user either consents or doesn't
-        // we should not check if its enabled if the user has a blank consent
-        // TODO: We should do this check outside of this function
-        if (requiresConsent && mpidIsNotInCookies) {
-            return;
-        }
-
-        // TODO: Refactor so that check is made outside of the function.
-        //       Cache or store the boolean so that it only gets called once per
-        //       cookie sync attempt per module.
-        //       Currently, attemptCookieSync is called as a loop and therefore this
-        //       function polls the user object and consent multiple times.
-        if (
-            mpInstance._Consent.isEnabledForUserConsent(
-                filteringConsentRuleValues,
-                mpInstance.Identity.getCurrentUser()
-            )
-        ) {
-            var img = document.createElement('img');
-
-            mpInstance.Logger.verbose(Messages.InformationMessages.CookieSync);
-            img.onload = function() {
-                // TODO: Break this out into a convenience method so we can unit test
-                cookieSyncDates[moduleId.toString()] = new Date().getTime();
-                mpInstance._Persistence.saveUserCookieSyncDatesToPersistence(
-                    mpid,
-                    cookieSyncDates
-                );
-            };
-            img.src = url;
-        }
-    };
-}