refactor(logging): Update ReportingLogger initialization and enhance error logging in RoktManager for improved clarity

Author: gtamanaha

src/mp-instance.ts

@@ -1553,7 +1553,7 @@ function createIdentityCache(mpInstance) {
 }
 
 function runPreConfigFetchInitialization(mpInstance, apiKey, config) {
-    const reportingLogger = new ReportingLogger(Constants.sdkVersion, mpInstance);
+    const reportingLogger = new ReportingLogger(mpInstance, Constants.sdkVersion);
     mpInstance.Logger = new Logger(config, reportingLogger);
     mpInstance._Store = new Store(config, mpInstance, apiKey);
     window.mParticle.Store = mpInstance._Store;

src/mparticle-instance-manager.ts

@@ -7,6 +7,7 @@ import MPSideloadedKit from './sideloadedKit';
 import { IMParticleInstanceManager } from './sdkRuntimeModels';
 import { IStore } from './store';
 import { Dictionary } from '@mparticle/web-sdk';
+import { IReportingLogger } from './logging/reportingLogger';
 
 if (!Array.prototype.forEach) {
     Array.prototype.forEach = Polyfill.forEach;
@@ -446,18 +447,20 @@ function mParticleInstanceManager(this: IMParticleInstanceManager) {
         self.getInstance().reset(self.getInstance());
     };
 
-    this._resetForTests = function(MPConfig, keepPersistence) {
+    this._resetForTests = function(MPConfig, keepPersistence, _?: IMParticleWebSDKInstance, reportingLogger?: IReportingLogger) {
         if (typeof keepPersistence === 'boolean') {
             self.getInstance()._resetForTests(
                 MPConfig,
                 keepPersistence,
-                self.getInstance()
+                self.getInstance(),
+                reportingLogger
             );
         } else {
             self.getInstance()._resetForTests(
                 MPConfig,
                 false,
-                self.getInstance()
+                self.getInstance(),
+                reportingLogger
             );
         }
     };

src/roktManager.ts

@@ -346,7 +346,7 @@ export default class RoktManager {
 
         this.messageQueue.forEach((message) => {
             if(!(message.methodName in this) || !isFunction(this[message.methodName])) {
-                this.logger?.error(`RoktManager: Method ${message.methodName} not found`);
+                this.logger?.error(`RoktManager: Method ${message.methodName} not found`, ErrorCodes.ROKT_MANAGER);
 
                 return;
             }

test/jest/roktManager.spec.ts

@@ -1,6 +1,7 @@
 import { IKitConfigs } from "../../src/configAPIClient";
 import { IMParticleUser } from "../../src/identity-user-interfaces";
 import { SDKIdentityApi } from "../../src/identity.interfaces";
+import { ErrorCodes } from "../../src/logging/errorCodes";
 import { IMParticleWebSDKInstance } from "../../src/mp-instance";
 import RoktManager, { IRoktKit, IRoktSelectPlacementsOptions } from "../../src/roktManager";
 import { testMPID } from '../src/config/constants';
@@ -554,7 +555,8 @@ describe('RoktManager', () => {
 
             // Verify error was logged for non-existent method
             expect(mockMPInstance.Logger.error).toHaveBeenCalledWith(
-                'RoktManager: Method nonExistentMethod not found'
+                'RoktManager: Method nonExistentMethod not found',
+                ErrorCodes.ROKT_MANAGER
             );
 
             // Verify message was removed from queue even though method didn't exist
@@ -1030,8 +1032,10 @@ describe('RoktManager', () => {
                 }
             }, expect.any(Function));
             expect(mockMPInstance.Logger.warning).toHaveBeenCalledWith(
-                'Email mismatch detected. Current email differs from email passed to selectPlacements call. Proceeding to call identify with email from selectPlacements call. Please verify your implementation.'
+                'Email mismatch detected. Current email differs from email passed to selectPlacements call. Proceeding to call identify with email from selectPlacements call. Please verify your implementation.',
+                ErrorCodes.EMAIL_MISMATCH
             );
+            expect(mockMPInstance.Logger.error).not.toHaveBeenCalled();
         });
 
         it('should not call identify when email matches current user email', () => {
@@ -1217,7 +1221,8 @@ describe('RoktManager', () => {
                 }
             }, expect.any(Function));
             expect(mockMPInstance.Logger.warning).toHaveBeenCalledWith(
-                "emailsha256 mismatch detected. Current mParticle hashedEmail differs from hashedEmail passed to selectPlacements call. Proceeding to call identify with hashedEmail from selectPlacements call. Please verify your implementation."
+                "emailsha256 mismatch detected. Current mParticle hashedEmail differs from hashedEmail passed to selectPlacements call. Proceeding to call identify with hashedEmail from selectPlacements call. Please verify your implementation.",
+                ErrorCodes.EMAILSHA256_MISMATCH
             );
         });
 
@@ -1307,7 +1312,8 @@ describe('RoktManager', () => {
                 }
             }, expect.any(Function));
             expect(mockMPInstance.Logger.warning).toHaveBeenCalledWith(
-                "emailsha256 mismatch detected. Current mParticle hashedEmail differs from hashedEmail passed to selectPlacements call. Proceeding to call identify with hashedEmail from selectPlacements call. Please verify your implementation."
+                "emailsha256 mismatch detected. Current mParticle hashedEmail differs from hashedEmail passed to selectPlacements call. Proceeding to call identify with hashedEmail from selectPlacements call. Please verify your implementation.",
+                ErrorCodes.EMAILSHA256_MISMATCH
             );
         });
 
@@ -1396,7 +1402,8 @@ describe('RoktManager', () => {
 
             // Verify error was logged
             expect(mockMPInstance.Logger.error).toHaveBeenCalledWith(
-                'Failed to identify user with new email: ' + JSON.stringify(mockError)
+                'Failed to identify user with new email: ' + JSON.stringify(mockError),
+                ErrorCodes.ROKT_MANAGER
             );
 
             // Verify selectPlacements was still called

test/src/tests-eCommerce.js

@@ -4,13 +4,20 @@ import fetchMock from 'fetch-mock/esm/client';
 import { urls, apiKey, MPConfig, testMPID, ProductActionType, PromotionActionType } from './config/constants';
 const { waitForCondition, fetchMockSuccess, hasIdentifyReturned } = Utils;
 
+const mockReportingLogger = {
+    error: sinon.spy(),
+    warning: sinon.spy()
+};
+
 const forwarderDefaultConfiguration = Utils.forwarderDefaultConfiguration,
     findEventFromRequest = Utils.findEventFromRequest,
     MockForwarder = Utils.MockForwarder;
 
 describe('eCommerce', function() {
     beforeEach(function() {
-        mParticle._resetForTests(MPConfig);
+        mockReportingLogger.error.resetHistory();
+        mockReportingLogger.warning.resetHistory();
+        mParticle._resetForTests(MPConfig, false, undefined, mockReportingLogger);
         delete mParticle._instances['default_instance'];
         fetchMock.config.overwriteRoutes = true;
         fetchMock.post(urls.events, 200);
@@ -1343,7 +1350,7 @@ describe('eCommerce', function() {
 
         it('should deprecate add', async () => {
             await waitForCondition(hasIdentifyReturned);
-            mParticle._resetForTests(MPConfig);
+            mParticle._resetForTests(MPConfig, false, undefined, mockReportingLogger);
             const bond = sinon.spy(mParticle.getInstance().Logger, 'warning');
 
             const product = mParticle.eCommerce.createProduct(