refactor: Identify refactor points in Identity related workflows (#886)

mParticle · May 22, 2024 · a99b6fe · a99b6fe
1 parent b5e164d
commit a99b6fe
Show file tree

Hide file tree

Showing 5 changed files with 23 additions and 0 deletions.
diff --git a/src/identity.js b/src/identity.js
@@ -17,6 +17,7 @@ export default function Identity(mpInstance) {
     this.idCache = null;
     this.audienceManager = null;
 
+    // https://go.mparticle.com/work/SQDSDKS-6353
     this.IdentityRequest = {
         preProcessIdentityRequest: function(identityApiData, callback, method) {
             mpInstance.Logger.verbose(
@@ -217,6 +218,7 @@ export default function Identity(mpInstance) {
          * @param {Function} [callback] A callback function that is called when the identify request completes
          */
         identify: function(identityApiData, callback) {
+            // https://go.mparticle.com/work/SQDSDKS-6337
             var mpid,
                 currentUser = mpInstance.Identity.getCurrentUser(),
                 preProcessResult = mpInstance._Identity.IdentityRequest.preProcessIdentityRequest(
@@ -310,6 +312,7 @@ export default function Identity(mpInstance) {
          * @param {Function} [callback] A callback function that is called when the logout request completes
          */
         logout: function(identityApiData, callback) {
+            // https://go.mparticle.com/work/SQDSDKS-6337
             var mpid,
                 currentUser = mpInstance.Identity.getCurrentUser(),
                 preProcessResult = mpInstance._Identity.IdentityRequest.preProcessIdentityRequest(
@@ -399,6 +402,7 @@ export default function Identity(mpInstance) {
          * @param {Function} [callback] A callback function that is called when the login request completes
          */
         login: function(identityApiData, callback) {
+            // https://go.mparticle.com/work/SQDSDKS-6337
             var mpid,
                 currentUser = mpInstance.Identity.getCurrentUser(),
                 preProcessResult = mpInstance._Identity.IdentityRequest.preProcessIdentityRequest(
@@ -494,6 +498,7 @@ export default function Identity(mpInstance) {
          * @param {Function} [callback] A callback function that is called when the modify request completes
          */
         modify: function(identityApiData, callback) {
+            // https://go.mparticle.com/work/SQDSDKS-6337
             var mpid,
                 currentUser = mpInstance.Identity.getCurrentUser(),
                 preProcessResult = mpInstance._Identity.IdentityRequest.preProcessIdentityRequest(
@@ -781,6 +786,7 @@ export default function Identity(mpInstance) {
         },
     };
 
+    // https://go.mparticle.com/work/SQDSDKS-6354
     /**
      * Invoke these methods on the mParticle.Identity.getCurrentUser() object.
      * Example: mParticle.Identity.getCurrentUser().getAllUserAttributes()
@@ -1466,6 +1472,7 @@ export default function Identity(mpInstance) {
         };
     };
 
+    // https://go.mparticle.com/work/SQDSDKS-6355
     this.parseIdentityResponse = function(
         xhr,
         previousMPID,
@@ -1513,6 +1520,7 @@ export default function Identity(mpInstance) {
                 mpInstance._Store.mpid = identityApiResult.mpid;
 
                 if (prevUser) {
+                    // https://go.mparticle.com/work/SQDSDKS-6329
                     mpInstance._Persistence.setLastSeenTime(previousMPID);
                 }
 
@@ -1569,6 +1577,7 @@ export default function Identity(mpInstance) {
                         'Successfully parsed Identity Response'
                     );
 
+                    // https://go.mparticle.com/work/SQDSDKS-6356
                     //this covers an edge case where, users stored before "firstSeenTime" was introduced
                     //will not have a value for "fst" until the current MPID changes, and in some cases,
                     //the current MPID will never change
@@ -1577,6 +1586,7 @@ export default function Identity(mpInstance) {
                         prevUser &&
                         identityApiResult.mpid === prevUser.getMPID()
                     ) {
+                        // https://go.mparticle.com/work/SQDSDKS-6329
                         mpInstance._Persistence.setFirstSeenTime(
                             identityApiResult.mpid
                         );
@@ -1645,12 +1655,14 @@ export default function Identity(mpInstance) {
                         identityApiData
                     );
 
+                    // https://go.mparticle.com/work/SQDSDKS-6357
                     mpInstance._Store.context =
                         identityApiResult.context || mpInstance._Store.context;
                 }
 
                 newUser = mpInstance.Identity.getCurrentUser();
 
+                // https://go.mparticle.com/work/SQDSDKS-6359
                 if (
                     identityApiData &&
                     identityApiData.onUserAlias &&
@@ -1784,6 +1796,7 @@ export default function Identity(mpInstance) {
             }
         }
 
+        // https://go.mparticle.com/work/SQDSDKS-6354
         currentUserInMemory = this.IdentityAPI.getUser(mpid);
 
         for (var identityType in newUserIdentities) {

diff --git a/src/identityApiClient.js b/src/identityApiClient.js
@@ -10,6 +10,7 @@ export default function IdentityAPIClient(mpInstance) {
         var xhr,
             xhrCallback = function() {
                 if (xhr.readyState === 4) {
+                    // https://go.mparticle.com/work/SQDSDKS-6368
                     mpInstance.Logger.verbose(
                         'Received ' + xhr.statusText + ' from server'
                     );
@@ -73,6 +74,7 @@ export default function IdentityAPIClient(mpInstance) {
             previousMPID,
             xhrCallback = function() {
                 if (xhr.readyState === 4) {
+                    // https://go.mparticle.com/work/SQDSDKS-6368
                     mpInstance.Logger.verbose(
                         'Received ' + xhr.statusText + ' from server'
                     );

diff --git a/src/persistence.js b/src/persistence.js
@@ -1112,6 +1112,7 @@ export default function _Persistence(mpInstance) {
         if (!mpid) {
             return;
         }
+        // https://go.mparticle.com/work/SQDSDKS-6329
         if (!time) {
             time = new Date().getTime();
         }
@@ -1152,6 +1153,7 @@ export default function _Persistence(mpInstance) {
         if (!mpid) {
             return;
         }
+        // https://go.mparticle.com/work/SQDSDKS-6329
         if (!time) {
             time = new Date().getTime();
         }

diff --git a/src/sdkRuntimeModels.ts b/src/sdkRuntimeModels.ts
@@ -34,7 +34,10 @@ export interface SDKEvent {
     IsFirstRun: boolean;
     EventName: string;
     EventCategory: number;
+
+    // https://go.mparticle.com/work/SQDSDKS-5196
     UserAttributes?: { [key: string]: string | string[] | null };
+
     UserIdentities?: ISDKUserIdentity[];
     SourceMessageId: string;
     MPID: string;

diff --git a/src/serverModel.ts b/src/serverModel.ts
@@ -46,7 +46,10 @@ export interface IServerV2DTO {
     dp_v?: number;
     n?: string;
     et?: number;
+
+    // https://go.mparticle.com/work/SQDSDKS-5196
     ua?: Dictionary<string | string[]>;
+
     ui?: ISDKUserIdentity[];
     ia?: Dictionary<Dictionary<string>>;
     str?: ServerSettings;