Catch for fs_user_id aliases

Author: opti-jnguyen

packages/optimizely-sdk/lib/index.browser.tests.js

@@ -605,6 +605,7 @@ describe('javascript-sdk (Browser)', function() {
       beforeEach(function() {
         sandbox.stub(logger, 'log');
         sandbox.stub(logger, 'error');
+        sandbox.stub(logger, 'warn');
         clock = sinon.useFakeTimers(new Date());
       });
 
@@ -804,6 +805,77 @@ describe('javascript-sdk (Browser)', function() {
         sinon.assert.called(fakeEventManager.sendEvent);
       });
 
+      it('should convert fs-user-id, FS-USER-ID, and FS_USER_ID to fs_user_id identifier when calling sendOdpEvent', async () => {
+        const fakeEventManager = {
+          updateSettings: sinon.spy(),
+          start: sinon.spy(),
+          stop: sinon.spy(),
+          registerVuid: sinon.spy(),
+          identifyUser: sinon.spy(),
+          sendEvent: sinon.spy(),
+          flush: sinon.spy(),
+        };
+
+        const client = optimizelyFactory.createInstance({
+          datafile: testData.getOdpIntegratedConfigWithSegments(),
+          errorHandler: fakeErrorHandler,
+          eventDispatcher: fakeEventDispatcher,
+          eventBatchSize: null,
+          logger,
+          odpOptions: {
+            eventManager: fakeEventManager,
+          },
+        });
+
+        const readyData = await client.onReady();
+        assert.equal(readyData.success, true);
+        assert.isUndefined(readyData.reason);
+
+        // fs-user-id
+        client.sendOdpEvent(ODP_EVENT_ACTION.INITIALIZED, undefined, new Map([['fs-user-id', 'fsUserA']]));
+        sinon.assert.notCalled(logger.error);
+        sinon.assert.neverCalledWith(logger.warn, LOG_MESSAGES.ODP_SEND_EVENT_IDENTIFIER_CONVERSION_FAILED);
+
+        const sendEventArgs1 = fakeEventManager.sendEvent.args;
+        assert.deepEqual(
+          sendEventArgs1[0].toString(),
+          new OdpEvent('fullstack', 'client_initialized', new Map([['fs_user_id', 'fsUserA']]), new Map()).toString()
+        );
+
+        // FS-USER-ID
+        client.sendOdpEvent(ODP_EVENT_ACTION.INITIALIZED, undefined, new Map([['FS-USER-ID', 'fsUserA']]));
+        sinon.assert.notCalled(logger.error);
+        sinon.assert.neverCalledWith(logger.warn, LOG_MESSAGES.ODP_SEND_EVENT_IDENTIFIER_CONVERSION_FAILED);
+
+        const sendEventArgs2 = fakeEventManager.sendEvent.args;
+        assert.deepEqual(
+          sendEventArgs2[0].toString(),
+          new OdpEvent('fullstack', 'client_initialized', new Map([['fs_user_id', 'fsUserA']]), new Map()).toString()
+        );
+
+        // FS_USER_ID
+        client.sendOdpEvent(ODP_EVENT_ACTION.INITIALIZED, undefined, new Map([['FS_USER_ID', 'fsUserA']]));
+        sinon.assert.notCalled(logger.error);
+        sinon.assert.neverCalledWith(logger.warn, LOG_MESSAGES.ODP_SEND_EVENT_IDENTIFIER_CONVERSION_FAILED);
+
+        const sendEventArgs3 = fakeEventManager.sendEvent.args;
+        assert.deepEqual(
+          sendEventArgs3[0].toString(),
+          new OdpEvent('fullstack', 'client_initialized', new Map([['fs_user_id', 'fsUserA']]), new Map()).toString()
+        );
+
+        // fs_user_id
+        client.sendOdpEvent(ODP_EVENT_ACTION.INITIALIZED, undefined, new Map([['fs_user_id', 'fsUserA']]));
+        sinon.assert.notCalled(logger.error);
+        sinon.assert.neverCalledWith(logger.warn, LOG_MESSAGES.ODP_SEND_EVENT_IDENTIFIER_CONVERSION_FAILED);
+
+        const sendEventArgs4 = fakeEventManager.sendEvent.args;
+        assert.deepEqual(
+          sendEventArgs4[0].toString(),
+          new OdpEvent('fullstack', 'client_initialized', new Map([['fs_user_id', 'fsUserA']]), new Map()).toString()
+        );
+      });
+
       it('should throw an error and not send an odp event when calling sendOdpEvent with an invalid action input', async () => {
         const fakeEventManager = {
           updateSettings: sinon.spy(),

packages/optimizely-sdk/lib/optimizely/index.ts

@@ -65,6 +65,8 @@ import {
   NODE_CLIENT_ENGINE,
   NODE_CLIENT_VERSION,
   ODP_DEFAULT_EVENT_TYPE,
+  FS_USER_ID_ALIAS,
+  ODP_USER_KEY,
 } from '../utils/enums';
 
 const MODULE_NAME = 'OPTIMIZELY';
@@ -1712,8 +1714,27 @@ export default class Optimizely implements Client {
 
     const odpEventType = type ?? ODP_DEFAULT_EVENT_TYPE;
 
+    const odpIdentifiers = new Map(identifiers);
+
+    if (identifiers && identifiers.size > 0) {
+      try {
+        identifiers.forEach((identifier_value, identifier_key) => {
+          // Catch for fs-user-id, FS-USER-ID, and FS_USER_ID and assign value to fs_user_id identifier.
+          if (
+            FS_USER_ID_ALIAS === identifier_key.toLowerCase() ||
+            ODP_USER_KEY.FS_USER_ID === identifier_key.toLowerCase()
+          ) {
+            odpIdentifiers.delete(identifier_key);
+            odpIdentifiers.set(ODP_USER_KEY.FS_USER_ID, identifier_value);
+          }
+        });
+      } catch (e) {
+        this.logger.warn(LOG_MESSAGES.ODP_SEND_EVENT_IDENTIFIER_CONVERSION_FAILED);
+      }
+    }
+
     try {
-      const odpEvent = new OdpEvent(odpEventType, action, identifiers, data);
+      const odpEvent = new OdpEvent(odpEventType, action, odpIdentifiers, data);
       this.odpManager.sendEvent(odpEvent);
     } catch (e) {
       this.logger.error(ERROR_MESSAGES.ODP_EVENT_FAILED, e);

packages/optimizely-sdk/lib/utils/enums/index.ts

@@ -123,6 +123,8 @@ export const LOG_MESSAGES = {
   ODP_DISABLED: 'ODP Disabled.',
   ODP_IDENTIFY_FAILED_ODP_DISABLED: '%s: ODP identify event for user %s is not dispatched (ODP disabled).',
   ODP_IDENTIFY_FAILED_ODP_NOT_INTEGRATED: '%s: ODP identify event %s is not dispatched (ODP not integrated).',
+  ODP_SEND_EVENT_IDENTIFIER_CONVERSION_FAILED:
+    '%s: sendOdpEvent failed to parse through and convert fs_user_id aliases',
   PARSED_REVENUE_VALUE: '%s: Parsed revenue value "%s" from event tags.',
   PARSED_NUMERIC_VALUE: '%s: Parsed event value "%s" from event tags.',
   RETURNING_STORED_VARIATION:
@@ -349,6 +351,11 @@ export enum ODP_USER_KEY {
   FS_USER_ID = 'fs_user_id',
 }
 
+/**
+ * Alias for fs_user_id to catch for and automatically convert to fs_user_id
+ */
+export const FS_USER_ID_ALIAS = 'fs-user-id';
+
 export const ODP_DEFAULT_EVENT_TYPE = 'fullstack';
 export const ODP_EVENT_BROWSER_ENDPOINT = 'https://jumbe.zaius.com/v2/zaius.gif';