@mparticle/web-sdk 2.28.0 → 2.28.2

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@mparticle/web-sdk",
-    "version": "2.28.0",
+    "version": "2.28.2",
     "description": "mParticle core SDK for web applications",
     "license": "Apache-2.0",
     "keywords": [

package/src/apiClient.ts

@@ -1,14 +1,13 @@
 import Constants from './constants';
 import Types from './types';
 import { BatchUploader } from './batchUploader';
-import { MParticleWebSDK, SDKEvent } from './sdkRuntimeModels';
+import { MParticleWebSDK, SDKEvent, SDKDataPlan } from './sdkRuntimeModels';
 import KitBlocker from './kitBlocking';
 import { Dictionary, getRampNumber, isEmpty, parseNumber } from './utils';
 import { IUploadObject } from './serverModel';
 import { MPForwarder } from './forwarders.interfaces';
-import { IMParticleUser } from './identity-user-interfaces';
-
-export type ForwardingStatsData = Dictionary<any>;
+import { IMParticleUser, ISDKUserAttributes } from './identity-user-interfaces';
+import { AsyncUploader, FetchUploader, XHRUploader } from './uploaders';
 
 export interface IAPIClient {
     uploader: BatchUploader | null;
@@ -18,18 +17,30 @@ export interface IAPIClient {
     sendEventToServer: (event: SDKEvent, _options?: Dictionary<any>) => void;
     sendSingleEventToServer: (event: SDKEvent) => void;
     sendBatchForwardingStatsToServer: (
-        forwardingStatsData: ForwardingStatsData,
+        forwardingStatsData: IForwardingStatsData,
         xhr: XMLHttpRequest
     ) => void;
-    sendSingleForwardingStatsToServer: (
-        forwardingStatsData: ForwardingStatsData
-    ) => void;
+    initializeForwarderStatsUploader: () => AsyncUploader;
     prepareForwardingStats: (
         forwarder: MPForwarder,
         event: IUploadObject
     ) => void;
 }
 
+export interface IForwardingStatsData {
+    mid: number; // Module Id
+    esid: number; // Event Subscription Id
+    n: string; // Event Name
+    attrs: ISDKUserAttributes; // User Attributes
+    sdk: string; // SDK Version
+    dt: number; // Data Type
+    et: number; // Event Type
+    dbg: boolean; // Development Mode (for debugging in Live Stream)
+    ct: number; // Current Timestamp
+    eec: number; // Expanded Event Count
+    dp: SDKDataPlan; // Data Plan
+}
+
 export default function APIClient(
     this: IAPIClient,
     mpInstance: MParticleWebSDK,
@@ -161,41 +172,26 @@ export default function APIClient(
         }
     };
 
-    this.sendSingleForwardingStatsToServer = function(forwardingStatsData) {
-        let url;
-        let data;
-        try {
-            const xhrCallback = function() {
-                if (xhr.readyState === 4) {
-                    if (xhr.status === 202) {
-                        mpInstance.Logger.verbose(
-                            'Successfully sent  ' +
-                                xhr.statusText +
-                                ' from server'
-                        );
-                    }
-                }
-            };
-            const xhr = mpInstance._Helpers.createXHR(xhrCallback);
-            url = mpInstance._Helpers.createServiceUrl(
-                mpInstance._Store.SDKConfig.v1SecureServiceUrl,
-                mpInstance._Store.devToken
-            );
-            data = forwardingStatsData;
+    this.initializeForwarderStatsUploader = (): AsyncUploader => {
+        const {
+            v1SecureServiceUrl: forwardingDomain,
+        } = mpInstance._Store.SDKConfig;
+        const { devToken } = mpInstance._Store;
 
-            if (xhr) {
-                xhr.open('post', url + '/Forwarding');
-                xhr.send(JSON.stringify(data));
-            }
-        } catch (e) {
-            mpInstance.Logger.error(
-                'Error sending forwarding stats to mParticle servers.'
-            );
-        }
+        const uploadUrl: string = `https://${forwardingDomain}${devToken}/Forwarding`;
+
+        const uploader: AsyncUploader = window.fetch
+            ? new FetchUploader(uploadUrl)
+            : new XHRUploader(uploadUrl);
+
+        return uploader;
     };
 
-    this.prepareForwardingStats = function(forwarder, event) {
-        let forwardingStatsData;
+    this.prepareForwardingStats = function(
+        forwarder: MPForwarder,
+        event:SDKEvent,
+    ) : void {
+        let forwardingStatsData: IForwardingStatsData;
         const queue = mpInstance._Forwarders.getForwarderStatsQueue();
 
         if (forwarder && forwarder.isVisible) {
@@ -212,6 +208,11 @@ export default function APIClient(
                 eec: event.ExpandedEventCount,
                 dp: event.DataPlan,
             };
+            
+            const {
+                sendSingleForwardingStatsToServer,
+                setForwarderStatsQueue,
+            } = mpInstance._Forwarders;
 
             if (
                 mpInstance._Helpers.getFeatureFlag(
@@ -219,9 +220,9 @@ export default function APIClient(
                 )
             ) {
                 queue.push(forwardingStatsData);
-                mpInstance._Forwarders.setForwarderStatsQueue(queue);
+                setForwarderStatsQueue(queue);
             } else {
-                self.sendSingleForwardingStatsToServer(forwardingStatsData);
+                sendSingleForwardingStatsToServer(forwardingStatsData);
             }
         }
     };

package/src/forwarders.js

@@ -3,11 +3,16 @@ import filteredMparticleUser from './filteredMparticleUser';
 import { isEmpty } from './utils';
 import KitFilterHelper from './kitFilterHelper';
 import Constants from './constants';
+import APIClient from './apiClient';
 
 const { Modify, Identify, Login, Logout } = Constants.IdentityMethods;
 
 export default function Forwarders(mpInstance, kitBlocker) {
     var self = this;
+    this.forwarderStatsUploader = new APIClient(
+        mpInstance,
+        kitBlocker
+    ).initializeForwarderStatsUploader();
 
     const UserAttributeActionTypes = {
         setUserAttribute: 'setUserAttribute',
@@ -771,4 +776,31 @@ export default function Forwarders(mpInstance, kitBlocker) {
             );
         }
     };
+
+    this.sendSingleForwardingStatsToServer = async forwardingStatsData => {
+        // https://go.mparticle.com/work/SQDSDKS-6568
+        const fetchPayload = {
+            method: 'post',
+            body: JSON.stringify(forwardingStatsData),
+            headers: {
+                Accept: 'text/plain;charset=UTF-8',
+                'Content-Type': 'text/plain;charset=UTF-8',
+            },
+        };
+
+        const response = await this.forwarderStatsUploader.upload(fetchPayload);
+
+        let message;
+        // This is a fire and forget, so we only need to log the response based on the code, and not return any response body
+        if (response.status === 202) {
+            // https://go.mparticle.com/work/SQDSDKS-6670
+            message = 'Successfully sent forwarding stats to mParticle Servers';
+        } else {
+            message =
+                'Issue with forwarding stats to mParticle Servers, received HTTP Code of ' +
+                response.statusText;
+        }
+
+        mpInstance?.Logger?.verbose(message);
+    };
 }

package/src/identity-user-interfaces.ts

@@ -84,6 +84,14 @@ export interface IdentityCallback {
     (result: IdentityResult): void;
 }
 
+export interface IIdentityResponse {
+    // https://go.mparticle.com/work/SQDSDKS-6672
+    responseText: IdentityResultBody;
+    status: number;
+    cacheMaxAge?: number; // Default: 86400
+    expireTimestamp?: number;
+}
+
 export interface IdentityResult {
     httpCode: typeof HTTPCodes;
     getPreviousUser(): User;

package/src/identity-utils.ts

@@ -2,62 +2,95 @@ import Constants, { ONE_DAY_IN_SECONDS, MILLIS_IN_ONE_SEC } from './constants';
 import { Dictionary, parseNumber, isObject, generateHash } from './utils';
 import { BaseVault } from './vault';
 import Types from './types';
-import { IdentityApiData, UserIdentities, IdentityCallback } from '@mparticle/web-sdk';
+import {
+    IdentityApiData,
+    UserIdentities,
+    IdentityCallback,
+} from '@mparticle/web-sdk';
 import { IdentityAPIMethod } from './identity.interfaces';
+import {
+    IdentityResultBody,
+    IIdentityResponse,
+} from './identity-user-interfaces';
 
 const { Identify, Modify, Login, Logout } = Constants.IdentityMethods;
+const CACHE_HEADER = 'x-mp-max-age' as const;
 
 export type IdentityCache = BaseVault<Dictionary<ICachedIdentityCall>>;
 
+// https://go.mparticle.com/work/SQDSDKS-6675
 export type IParseCachedIdentityResponse = (
-    cachedIdentity: ICachedIdentityCall,
+    cachedIdentity: IIdentityResponse,
     mpid: string,
     callback: IdentityCallback,
     identityApiData: IdentityApiData,
     identityMethod: string,
     knownIdentities: IKnownIdentities,
     fromCachedIdentity: boolean
-) => void
+) => void;
 
 export interface IKnownIdentities extends UserIdentities {
     device_application_stamp?: string;
 }
 
 export interface ICachedIdentityCall {
+    // https://go.mparticle.com/work/SQDSDKS-6672
     responseText: string;
     status: number;
     expireTimestamp: number;
 }
 
+// https://go.mparticle.com/work/SQDSDKS-6568
+// Temporary adapter to convert the XMLHttpRequest response to the IIdentityResponse interface
+export const xhrIdentityResponseAdapter = (
+    possiblyXhr: XMLHttpRequest | IIdentityResponse
+): IIdentityResponse => {
+    if (possiblyXhr.hasOwnProperty('expireTimestamp')) {
+        // If there is an `expireTimestamp`, it is an IIdentityResponse object, so just return it.  This indicates it was a previously cached value.
+        return possiblyXhr as IIdentityResponse;
+    } else {
+        // If there is no `expireTimestamp`, then it is an XHR object and needs to be parsed.
+        return {
+            status: possiblyXhr.status,
+
+            // Sometimes responseText can be an empty string, such as a 404 response
+            responseText: (possiblyXhr as XMLHttpRequest).responseText
+                ? JSON.parse((possiblyXhr as XMLHttpRequest).responseText)
+                : {},
+            cacheMaxAge: parseNumber(
+                (possiblyXhr as XMLHttpRequest)?.getResponseHeader(
+                    CACHE_HEADER
+                ) || ''
+            ),
+            expireTimestamp: 0,
+        };
+    }
+};
+
 export const cacheOrClearIdCache = (
     method: string,
     knownIdentities: IKnownIdentities,
     idCache: BaseVault<Dictionary<ICachedIdentityCall>>,
-    xhr: XMLHttpRequest,
-    parsingCachedResponse: boolean,
+    identityResponse: IIdentityResponse,
+    parsingCachedResponse: boolean
 ): void => {
     // when parsing a response that has already been cached, simply return instead of attempting another cache
-    if (parsingCachedResponse) { return; }
-
-    const CACHE_HEADER = 'x-mp-max-age';
+    if (parsingCachedResponse) {
+        return;
+    }
 
     // default the expire timestamp to one day in milliseconds unless a header comes back
-    let now = new Date().getTime();
-    let expireTimestamp = now + ONE_DAY_IN_SECONDS * MILLIS_IN_ONE_SEC;
-    if (xhr.getAllResponseHeaders().includes(CACHE_HEADER)) {
-        expireTimestamp =
-            now + (parseNumber(xhr.getResponseHeader(CACHE_HEADER)) * MILLIS_IN_ONE_SEC);
-    }
+    const expireTimestamp = getExpireTimestamp(identityResponse?.cacheMaxAge);
 
     switch (method) {
-        case Login: 
-        case Identify: 
+        case Login:
+        case Identify:
             cacheIdentityRequest(
                 method,
                 knownIdentities,
                 expireTimestamp,
                 idCache,
-                xhr 
+                identityResponse
             );
             break;
         case Modify:
@@ -65,26 +98,32 @@ export const cacheOrClearIdCache = (
             idCache.purge();
             break;
     }
-}
+};
 
 export const cacheIdentityRequest = (
     method: IdentityAPIMethod,
     identities: IKnownIdentities,
     expireTimestamp: number,
     idCache: IdentityCache,
-    xhr: XMLHttpRequest
+    identityResponse: IIdentityResponse
 ): void => {
-    const cache: Dictionary<ICachedIdentityCall> = idCache.retrieve() || ({} as Dictionary<ICachedIdentityCall>);
+    const { responseText, status } = identityResponse;
+    const cache: Dictionary<ICachedIdentityCall> =
+        idCache.retrieve() || ({} as Dictionary<ICachedIdentityCall>);
     const cacheKey = concatenateIdentities(method, identities);
     const hashedKey = generateHash(cacheKey);
 
-    const { mpid, is_logged_in } = JSON.parse(xhr.responseText);
-    const cachedResponseText = {
+    const { mpid, is_logged_in } = responseText;
+    const cachedResponseBody = {
         mpid,
         is_logged_in,
     };
 
-    cache[hashedKey] = { responseText: JSON.stringify(cachedResponseText), status: xhr.status, expireTimestamp};
+    cache[hashedKey] = {
+        responseText: JSON.stringify(cachedResponseBody),
+        status,
+        expireTimestamp,
+    };
     idCache.store(cache);
 };
 
@@ -115,7 +154,8 @@ export const concatenateIdentities = (
 
         concatenatedIdentities = userIDArray.reduce(
             (prevValue: string, currentValue: string, index: number) => {
-                const idName: string = Types.IdentityType.getIdentityName(index);
+                const idName: string =
+                    Types.IdentityType.getIdentityName(index);
                 return `${prevValue}${idName}=${currentValue};`;
             },
             cacheKey
@@ -128,12 +168,12 @@ export const concatenateIdentities = (
 export const hasValidCachedIdentity = (
     method: IdentityAPIMethod,
     proposedUserIdentities: IKnownIdentities,
-    idCache?: IdentityCache,
+    idCache?: IdentityCache
 ): boolean => {
-    // There is an edge case where multiple identity calls are taking place 
-    // before identify fires, so there may not be a cache.  See what happens when 
+    // There is an edge case where multiple identity calls are taking place
+    // before identify fires, so there may not be a cache.  See what happens when
     // the ? in idCache is removed to the following test
-    // "queued events contain login mpid instead of identify mpid when calling 
+    // "queued events contain login mpid instead of identify mpid when calling
     // login immediately after mParticle initializes"
     const cache = idCache?.retrieve();
 
@@ -152,12 +192,12 @@ export const hasValidCachedIdentity = (
     if (!cache.hasOwnProperty(hashedKey)) {
         return false;
     }
-    
+
     // If there is a valid cache key, compare the expireTimestamp to the current time.
     // If the current time is greater than the expireTimestamp, it is not a valid
     // cached identity.
     const expireTimestamp = cache[hashedKey].expireTimestamp;
-    
+
     if (expireTimestamp < new Date().getTime()) {
         return false;
     } else {
@@ -168,8 +208,8 @@ export const hasValidCachedIdentity = (
 export const getCachedIdentity = (
     method: IdentityAPIMethod,
     proposedUserIdentities: IKnownIdentities,
-    idCache: IdentityCache,
-): ICachedIdentityCall | null => {
+    idCache: IdentityCache
+): IIdentityResponse | null => {
     const cacheKey: string = concatenateIdentities(
         method,
         proposedUserIdentities
@@ -179,7 +219,11 @@ export const getCachedIdentity = (
     const cache = idCache.retrieve();
     const cachedIdentity = cache ? cache[hashedKey] : null;
 
-    return cachedIdentity;
+    return {
+        responseText: parseIdentityResponse(cachedIdentity.responseText),
+        expireTimestamp: cachedIdentity.expireTimestamp,
+        status: cachedIdentity.status,
+    };
 };
 
 // https://go.mparticle.com/work/SQDSDKS-6079
@@ -200,9 +244,12 @@ export const createKnownIdentities = (
     return identitiesResult;
 };
 
-export const removeExpiredIdentityCacheDates = (idCache: BaseVault<Dictionary<ICachedIdentityCall>>) => {
-    const cache: Dictionary<ICachedIdentityCall> = idCache.retrieve() || {} as Dictionary<ICachedIdentityCall>;
-    
+export const removeExpiredIdentityCacheDates = (
+    idCache: BaseVault<Dictionary<ICachedIdentityCall>>
+) => {
+    const cache: Dictionary<ICachedIdentityCall> =
+        idCache.retrieve() || ({} as Dictionary<ICachedIdentityCall>);
+
     const currentTime: number = new Date().getTime();
 
     // Iterate over the cache and remove any key/value pairs that are expired
@@ -210,10 +257,10 @@ export const removeExpiredIdentityCacheDates = (idCache: BaseVault<Dictionary<IC
         if (cache[key].expireTimestamp < currentTime) {
             delete cache[key];
         }
-    };
+    }
 
     idCache.store(cache);
-}
+};
 
 export const tryCacheIdentity = (
     knownIdentities: IKnownIdentities,
@@ -223,7 +270,7 @@ export const tryCacheIdentity = (
     callback: IdentityCallback,
     identityApiData: IdentityApiData,
     identityMethod: IdentityAPIMethod
-): boolean =>  {
+): boolean => {
     // https://go.mparticle.com/work/SQDSDKS-6095
     const shouldReturnCachedIdentity = hasValidCachedIdentity(
         identityMethod,
@@ -252,4 +299,10 @@ export const tryCacheIdentity = (
         return true;
     }
     return false;
-}
+};
+
+const getExpireTimestamp = (maxAge: number = ONE_DAY_IN_SECONDS): number =>
+    new Date().getTime() + maxAge * MILLIS_IN_ONE_SEC;
+
+const parseIdentityResponse = (responseText: string): IdentityResultBody =>
+    responseText ? JSON.parse(responseText) : ({} as IdentityResultBody);

package/src/identity.interfaces.ts

@@ -10,6 +10,7 @@ import {
     IUserIdentityChangeEvent,
     IMParticleUser,
     mParticleUserCart,
+    IIdentityResponse,
 } from './identity-user-interfaces';
 const { platform, sdkVendor, sdkVersion, HTTPCodes } = Constants;
 
@@ -170,7 +171,7 @@ export interface IIdentity {
         userInMemory: IMParticleUser
     ): IUserIdentityChangeEvent;
     parseIdentityResponse(
-        xhr: XMLHttpRequest,
+        identityResponse: IIdentityResponse,
         previousMPID: MPID,
         callback: IdentityCallback,
         identityApiData: IdentityApiData,

package/src/identity.js

@@ -4,6 +4,7 @@ import {
     cacheOrClearIdCache,
     createKnownIdentities,
     tryCacheIdentity,
+    xhrIdentityResponseAdapter,
 } from './identity-utils';
 import AudienceManager from './audienceManager';
 const { Messages, HTTPCodes, FeatureFlags, IdentityMethods } = Constants;
@@ -12,6 +13,7 @@ const { CacheIdentity } = FeatureFlags;
 const { Identify, Modify, Login, Logout } = IdentityMethods;
 import {
     generateDeprecationMessage,
+    HTTP_SUCCESS,
     isEmpty,
     isFunction,
     isObject,
@@ -1460,7 +1462,7 @@ export default function Identity(mpInstance) {
 
     // https://go.mparticle.com/work/SQDSDKS-6355
     this.parseIdentityResponse = function(
-        xhr,
+        identityResponse,
         previousMPID,
         callback,
         identityApiData,
@@ -1486,9 +1488,7 @@ export default function Identity(mpInstance) {
                 'Parsing "' + method + '" identity response from server'
             );
 
-            identityApiResult = xhr.responseText
-                ? JSON.parse(xhr.responseText)
-                : null;
+            identityApiResult = identityResponse.responseText ?? null;
 
             mpInstance._Store.isLoggedIn =
                 identityApiResult?.is_logged_in || false;
@@ -1513,13 +1513,16 @@ export default function Identity(mpInstance) {
                 );
             }
 
-            if (xhr.status === 200) {
+            if (identityResponse.status === HTTP_SUCCESS) {
                 if (getFeatureFlag(CacheIdentity)) {
+                    const identityResponseForCache = xhrIdentityResponseAdapter(
+                        identityResponse
+                    );
                     cacheOrClearIdCache(
                         method,
                         knownIdentities,
                         self.idCache,
-                        xhr,
+                        identityResponseForCache,
                         parsingCachedResponse
                     );
                 }
@@ -1642,7 +1645,9 @@ export default function Identity(mpInstance) {
 
             if (callback) {
                 const callbackCode =
-                    xhr.status === 0 ? HTTPCodes.noHttpCoverage : xhr.status;
+                    identityResponse.status === 0
+                        ? HTTPCodes.noHttpCoverage
+                        : identityResponse.status;
 
                 mpInstance._Helpers.invokeCallback(
                     callback,
@@ -1657,7 +1662,7 @@ export default function Identity(mpInstance) {
                 // https://go.mparticle.com/work/SQDSDKS-6500
                 mpInstance.Logger.error(
                     'Received HTTP response code of ' +
-                        xhr.status +
+                        identityResponse.status +
                         ' - ' +
                         identityApiResult.errors[0].message
                 );
@@ -1671,7 +1676,7 @@ export default function Identity(mpInstance) {
             if (callback) {
                 mpInstance._Helpers.invokeCallback(
                     callback,
-                    xhr.status,
+                    identityResponse.status,
                     identityApiResult || null
                 );
             }

package/src/identityApiClient.js

@@ -1,4 +1,5 @@
 import Constants from './constants';
+import { xhrIdentityResponseAdapter } from './identity-utils';
 
 var HTTPCodes = Constants.HTTPCodes,
     Messages = Constants.Messages;
@@ -78,8 +79,11 @@ export default function IdentityAPIClient(mpInstance) {
                     mpInstance.Logger.verbose(
                         'Received ' + xhr.statusText + ' from server'
                     );
+
+                    // https://go.mparticle.com/work/SQDSDKS-6565
+                    const identityResponse = xhrIdentityResponseAdapter(xhr);
                     parseIdentityResponse(
-                        xhr,
+                        identityResponse,
                         previousMPID,
                         callback,
                         originalIdentityApiData,

package/src/persistence.interfaces.ts

@@ -5,7 +5,7 @@ import {
     Product,
     UserIdentities,
 } from '@mparticle/web-sdk';
-import { ForwardingStatsData } from './apiClient';
+import { IForwardingStatsData } from './apiClient';
 import {
     IntegrationAttributes,
     ServerSettings,
@@ -18,7 +18,7 @@ import { UserAttributes } from './identity-user-interfaces';
 export type UploadsTable = Dictionary<any>;
 export interface iForwardingStatsBatches {
     uploadsTable: UploadsTable;
-    forwardingStatsEventQueue: ForwardingStatsData[];
+    forwardingStatsEventQueue: IForwardingStatsData[];
 }
 
 export interface IGlobalStoreV2MinifiedKeys {

package/src/sdkRuntimeModels.ts

@@ -65,6 +65,7 @@ export interface SDKEvent {
     CurrencyCode: string;
     DataPlan?: SDKDataPlan;
     LaunchReferral?: string;
+    ExpandedEventCount: number;
 }
 export interface SDKGeoLocation {
     lat: number | string;

package/src/utils.ts

@@ -9,6 +9,8 @@ export type Dictionary<V = any> = Record<string, V>;
 
 export type Environment = 'development' | 'production';
 
+export const HTTP_SUCCESS = 200 as const;
+
 const createCookieString = (value: string): string =>
     replaceCommasWithPipes(replaceQuotesWithApostrophes(value));