@mparticle/web-sdk 2.32.0 → 2.32.2

package/src/store.ts

@@ -37,6 +37,7 @@ import {
     IGlobalStoreV2MinifiedKeys,
     IPersistenceMinified,
 } from './persistence.interfaces';
+import { CookieSyncDates, IPixelConfiguration } from './cookieSyncManager';
 
 // This represents the runtime configuration of the SDK AFTER
 // initialization has been complete and all settings and
@@ -118,7 +119,6 @@ function createSDKConfig(config: SDKInitConfig): SDKConfig {
 
 // TODO: Placeholder Types to be filled in as we migrate more modules
 //       to TypeScript
-export type PixelConfiguration = Dictionary;
 export type ServerSettings = Dictionary;
 export type SessionAttributes = Dictionary;
 export type IntegrationAttributes = Dictionary<Dictionary<string>>;
@@ -168,7 +168,7 @@ export interface IStore {
     identifyCalled: boolean;
     isLoggedIn: boolean;
     sideloadedKitsCount?: number;
-    cookieSyncDates: Dictionary<number>;
+    cookieSyncDates: CookieSyncDates;
     integrationAttributes: IntegrationAttributes;
     requireDelay: boolean;
     isLocalStorageAvailable: boolean | null;
@@ -178,7 +178,7 @@ export interface IStore {
     kits: Dictionary<MPForwarder>;
     sideloadedKits: MPForwarder[];
     configuredForwarders: MPForwarder[];
-    pixelConfigurations: PixelConfiguration[];
+    pixelConfigurations: IPixelConfiguration[];
     integrationDelayTimeoutStart: number; // UNIX Timestamp
     webviewBridgeEnabled?: boolean;
     wrapperSDKInfo: WrapperSDKInfo;

package/src/uploaders.ts

@@ -1,6 +1,6 @@
 type HTTPMethod = 'get' | 'post';
 
-export interface fetchPayload {
+export interface IFetchPayload {
     method: string;
     headers: {
         Accept: string;
@@ -12,7 +12,7 @@ export interface fetchPayload {
 export abstract class AsyncUploader {
     url: string;
     public abstract upload(
-        fetchPayload: fetchPayload,
+        fetchPayload: IFetchPayload,
         url?: string
     ): Promise<Response>;
 
@@ -23,7 +23,7 @@ export abstract class AsyncUploader {
 
 export class FetchUploader extends AsyncUploader {
     public async upload(
-        fetchPayload: fetchPayload,
+        fetchPayload: IFetchPayload,
         _url?: string
     ): Promise<Response> {
         const url = _url || this.url;
@@ -32,7 +32,7 @@ export class FetchUploader extends AsyncUploader {
 }
 
 export class XHRUploader extends AsyncUploader {
-    public async upload(fetchPayload: fetchPayload): Promise<Response> {
+    public async upload(fetchPayload: IFetchPayload): Promise<Response> {
         const response: Response = await this.makeRequest(
             this.url,
             fetchPayload.body,

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/aliasRequestApiClient.ts

@@ -1,89 +0,0 @@
-import { IAliasRequest, IAliasCallback } from "./identity.interfaces";
-import { MParticleWebSDK } from "./sdkRuntimeModels";
-import Constants from './constants';
-import { FetchUploader, XHRUploader } from './uploaders';
-import { HTTP_ACCEPTED, HTTP_OK } from "./constants";
-
-
-const { HTTPCodes, Messages } = Constants;
-
-interface IAliasResponseBody {
-    message?: string
-}
-
-export async function sendAliasRequest (mpInstance: MParticleWebSDK, aliasRequest: IAliasRequest, aliasCallback: IAliasCallback) {
-        const { verbose, error } = mpInstance.Logger;
-        const { invokeAliasCallback } = mpInstance._Helpers;
-        const { aliasUrl } = mpInstance._Store.SDKConfig;
-        const { devToken: apiKey } = mpInstance._Store;
-
-        verbose(Messages.InformationMessages.SendAliasHttp);
-
-        // https://go.mparticle.com/work/SQDSDKS-6750
-        const uploadUrl = `https://${aliasUrl}${apiKey}/Alias`;
-        const uploader = window.fetch
-        ? new FetchUploader(uploadUrl)
-        : new XHRUploader(uploadUrl);
-        
-        
-        // https://go.mparticle.com/work/SQDSDKS-6568
-        const uploadPayload = {
-            method: 'post',
-            headers: {
-                Accept: 'text/plain;charset=UTF-8',
-                'Content-Type': 'application/json',
-            },
-            body: JSON.stringify(aliasRequest),
-        };
-
-        try {
-            const response = await uploader.upload(uploadPayload);
-
-            let message: string;
-            let aliasResponseBody: IAliasResponseBody;
-
-            // FetchUploader returns the response as a JSON object that we have to await
-            if (response.json) {
-                // HTTP responses of 202, 200, and 403 do not have a response.  response.json will always exist on a fetch, but can only be await-ed when the response is not empty, otherwise it will throw an error.
-                try {
-                    aliasResponseBody = await response.json();
-                } catch (e) {
-                    verbose('The request has no response body');
-                }
-            } else {
-                // https://go.mparticle.com/work/SQDSDKS-6568
-                // XHRUploader returns the response as a string that we need to parse
-                const xhrResponse = response as unknown as XMLHttpRequest;
-
-                aliasResponseBody = xhrResponse.responseText
-                    ? JSON.parse(xhrResponse.responseText)
-                    : '';
-            }
-
-            let errorMessage: string;
-
-            switch (response.status) {
-                case HTTP_OK:
-                case HTTP_ACCEPTED:
-                    // https://go.mparticle.com/work/SQDSDKS-6670
-                    message =
-                        'Successfully sent forwarding stats to mParticle Servers';
-                    break;
-                default:
-                    // 400 has an error message, but 403 doesn't
-                    if (aliasResponseBody?.message) {
-                        errorMessage = aliasResponseBody.message;
-                    }
-                    message =
-                        'Issue with sending Alias Request to mParticle Servers, received HTTP Code of ' +
-                        response.status;
-            }
-
-            verbose(message);
-            invokeAliasCallback(aliasCallback, response.status, errorMessage);
-        } catch (e) {
-            const err = e as Error;
-            error('Error sending alias request to mParticle servers. ' + err);
-            invokeAliasCallback(aliasCallback, HTTPCodes.noHttpCoverage, (err.message));
-        }
-    };

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

package/src/identityApiClient.js

@@ -1,131 +0,0 @@
-import Constants from './constants';
-import { sendAliasRequest } from './aliasRequestApiClient';
-import { FetchUploader, XHRUploader } from './uploaders';
-import { CACHE_HEADER } from './identity-utils';
-import { parseNumber } from './utils';
-
-var HTTPCodes = Constants.HTTPCodes,
-    Messages = Constants.Messages;
-
-const { Modify } = Constants.IdentityMethods;
-
-export default function IdentityAPIClient(mpInstance) {
-    this.sendAliasRequest = async function(aliasRequest, callback) {
-        await sendAliasRequest(mpInstance, aliasRequest, callback);
-    };
-
-    this.sendIdentityRequest = async function(
-        identityApiRequest,
-        method,
-        callback,
-        originalIdentityApiData,
-        parseIdentityResponse,
-        mpid,
-        knownIdentities
-    ) {
-        const { verbose, error } = mpInstance.Logger;
-        const { invokeCallback } = mpInstance._Helpers;
-
-        verbose(Messages.InformationMessages.SendIdentityBegin);
-        if (!identityApiRequest) {
-            error(Messages.ErrorMessages.APIRequestEmpty);
-            return;
-        }
-        verbose(Messages.InformationMessages.SendIdentityHttp);
-
-        if (mpInstance._Store.identityCallInFlight) {
-            invokeCallback(
-                callback,
-                HTTPCodes.activeIdentityRequest,
-                'There is currently an Identity request processing. Please wait for this to return before requesting again'
-            );
-            return;
-        }
-
-        const previousMPID = mpid || null;
-        const uploadUrl = this.getUploadUrl(method, mpid);
-
-        const uploader = window.fetch
-            ? new FetchUploader(uploadUrl)
-            : new XHRUploader(uploadUrl);
-
-        const fetchPayload = {
-            method: 'post',
-            headers: {
-                Accept: 'text/plain;charset=UTF-8',
-                'Content-Type': 'application/json',
-                'x-mp-key': mpInstance._Store.devToken,
-            },
-            body: JSON.stringify(identityApiRequest),
-        };
-
-        try {
-            mpInstance._Store.identityCallInFlight = true;
-            const response = await uploader.upload(fetchPayload);
-
-            let identityResponse;
-
-            if (response.json) {
-                // https://go.mparticle.com/work/SQDSDKS-6568
-                // FetchUploader returns the response as a JSON object that we have to await
-                const responseBody = await response.json();
-                identityResponse = this.getIdentityResponseFromFetch(
-                    response,
-                    responseBody
-                );
-            } else {
-                identityResponse = this.getIdentityResponseFromXHR(response);
-            }
-
-            verbose(
-                'Received Identity Response from server: ' +
-                    JSON.stringify(identityResponse.responseText)
-            );
-
-            parseIdentityResponse(
-                identityResponse,
-                previousMPID,
-                callback,
-                originalIdentityApiData,
-                method,
-                knownIdentities,
-                false
-            );
-        } catch (err) {
-            mpInstance._Store.identityCallInFlight = false;
-            invokeCallback(callback, HTTPCodes.noHttpCoverage, err);
-            error('Error sending identity request to servers' + ' - ' + err);
-        }
-    };
-
-    this.getUploadUrl = (method, mpid) => {
-        const uploadServiceUrl = mpInstance._Helpers.createServiceUrl(
-            mpInstance._Store.SDKConfig.identityUrl
-        );
-
-        const uploadUrl =
-            method === Modify
-                ? uploadServiceUrl + mpid + '/' + method
-                : uploadServiceUrl + method;
-
-        return uploadUrl;
-    };
-
-    this.getIdentityResponseFromFetch = (response, responseBody) => ({
-        status: response.status,
-        responseText: responseBody,
-        cacheMaxAge: parseInt(response.headers.get(CACHE_HEADER)) || 0,
-        expireTimestamp: 0,
-    });
-
-    this.getIdentityResponseFromXHR = response => ({
-        status: response.status,
-        responseText: response.responseText
-            ? JSON.parse(response.responseText)
-            : {},
-        cacheMaxAge: parseNumber(
-            response.getResponseHeader(CACHE_HEADER) || ''
-        ),
-        expireTimestamp: 0,
-    });
-}