feat: Add alias for sha256 identities (#1252)

Author: jamesnrokt

package-lock.json

@@ -118,7 +118,7 @@
         "@types/jest": "^29.5.1",
         "@types/jest-expect-message": "^1.1.0",
         "@types/mocha": "^9.0.0",
-        "@types/mparticle__web-sdk": "^2.16.1",
+        "@types/mparticle__web-sdk": "^2.66.0",
         "@types/node": "^20.1.0",
         "babel-preset-minify": "^0.5.1",
         "browser-sync": "^2.26.3",

package.json

@@ -289,6 +289,48 @@ const getExpireTimestamp = (maxAge: number = ONE_DAY_IN_SECONDS): number =>
 const parseIdentityResponse = (responseText: string): IdentityResultBody =>
     responseText ? JSON.parse(responseText) : ({} as IdentityResultBody);
 
+type Sha256IdentityAlias = 'email_sha256' | 'mobile_sha256';
+
+const SHA256_IDENTITY_ALIASES: Readonly<
+    Record<Sha256IdentityAlias, keyof UserIdentities>
+> = {
+    email_sha256: 'other',
+    mobile_sha256: 'other2',
+};
+
+type UserIdentitiesWithAliases = UserIdentities &
+    Partial<Record<Sha256IdentityAlias, string | null>>;
+
+export const normalizeUserIdentityKeys = (
+    userIdentities: UserIdentitiesWithAliases
+): UserIdentities => {
+    const normalized: UserIdentitiesWithAliases = { ...userIdentities };
+    (Object.keys(SHA256_IDENTITY_ALIASES) as Sha256IdentityAlias[]).forEach(
+        (alias) => {
+            if (alias in normalized) {
+                const value = normalized[alias];
+                delete normalized[alias];
+                normalized[SHA256_IDENTITY_ALIASES[alias]] = value;
+            }
+        }
+    );
+    return normalized;
+};
+
+// Compare two identity objects by key and value, independent of
+// object key insertion order. The two sides come from different sources
+// (numeric IdentityType iteration vs. partner-provided / alias-normalized
+// order)
+const identitiesEqual = (
+    a?: UserIdentities,
+    b?: UserIdentities
+): boolean => {
+    const aKeys = Object.keys(a ?? {});
+    const bKeys = Object.keys(b ?? {});
+    if (aKeys.length !== bKeys.length) return false;
+    return aKeys.every((key) => a[key] === b[key]);
+};
+
 export const hasIdentityRequestChanged = (
     currentUser: IMParticleUser,
     newIdentityRequest: IdentityApiData
@@ -300,11 +342,11 @@ export const hasIdentityRequestChanged = (
     const currentUserIdentities =
         currentUser.getUserIdentities().userIdentities;
 
-    const newIdentities = newIdentityRequest.userIdentities;
-
-    return (
-        JSON.stringify(currentUserIdentities) !== JSON.stringify(newIdentities)
+    const newIdentities = normalizeUserIdentityKeys(
+        newIdentityRequest.userIdentities
     );
+
+    return !identitiesEqual(currentUserIdentities, newIdentities);
 };
 
 /**

src/identity-utils.ts

@@ -4,6 +4,7 @@ import {
     cacheOrClearIdCache,
     createKnownIdentities,
     executeSearchRequest,
+    normalizeUserIdentityKeys,
     tryCacheIdentity,
 } from './identity-utils';
 import AudienceManager from './audienceManager';
@@ -35,11 +36,21 @@ export default function Identity(mpInstance) {
             );
 
             // First, remove any falsy identity values and warn about them
-            const cleanedIdentityApiData = mpInstance._Helpers.Validators.removeFalsyIdentityValues(
+            const removedFalsyIdentityData = mpInstance._Helpers.Validators.removeFalsyIdentityValues(
                 identityApiData,
                 mpInstance.Logger
             );
 
+            // Normalize convenience aliases (email_sha256 → other, mobile_sha256 → other2)
+            const cleanedIdentityApiData = removedFalsyIdentityData?.userIdentities
+                ? {
+                      ...removedFalsyIdentityData,
+                      userIdentities: normalizeUserIdentityKeys(
+                          removedFalsyIdentityData.userIdentities
+                      ),
+                  }
+                : removedFalsyIdentityData;
+
             var identityValidationResult = mpInstance._Helpers.Validators.validateIdentities(
                 cleanedIdentityApiData,
                 method

src/identity.js

@@ -161,9 +161,9 @@ export interface SDKProductAction {
 }
 
 export interface SDKProduct {
-    Sku?: string;
-    Name?: string;
-    Price?: number;
+    Sku: string;
+    Name: string;
+    Price: number;
     Quantity?: number;
     Brand?: string;
     Variant?: string;
@@ -173,7 +173,7 @@ export interface SDKProduct {
     TotalAmount?: number;
 
     // https://go.mparticle.com/work/SQDSDKS-4801
-    Attributes?: Record<string, unknown> | null;
+    Attributes?: Record<string, unknown>;
 }
 
 // https://go.mparticle.com/work/SQDSDKS-6949
@@ -306,7 +306,7 @@ export const LogLevelType = {
 // Currently, this extends MPConfiguration in @types/mparticle__web-sdk
 // and the two will be merged in once the Store module is refactored
 export interface SDKInitConfig
-    extends Omit<MPConfiguration, 'dataPlan' | 'logLevel'> {
+    extends Omit<MPConfiguration, 'dataPlan' | 'logLevel' | 'identityCallback'> {
     dataPlan?: DataPlanConfig | KitBlockerDataPlan; // TODO: These should be eventually split into two different attributes
     logLevel?: LogLevelType;
 

src/sdkRuntimeModels.ts

@@ -205,6 +205,10 @@ export const IdentityType = {
                 return IdentityType.PhoneNumber2;
             case 'phone_number_3':
                 return IdentityType.PhoneNumber3;
+            case 'email_sha256':
+                return IdentityType.Other;
+            case 'mobile_sha256':
+                return IdentityType.Other2;
             default:
                 return false;
         }