feat: migrate reporting service contract from logging to reporting module

src/constants.ts

@@ -139,8 +139,6 @@ const Constants = {
         identityUrl: 'identity.mparticle.com/v1/',
         aliasUrl: 'jssdks.mparticle.com/v1/identity/',
         userAudienceUrl: 'nativesdks.mparticle.com/v1/',
-        loggingUrl: 'apps.rokt-api.com/v1/log',
-        errorUrl: 'apps.rokt-api.com/v1/errors',
     },
     // These are the paths that are used to construct the CNAME urls
     CNAMEUrlPaths: {
@@ -150,8 +148,6 @@ const Constants = {
         configUrl: '/tags/JS/v2/',
         identityUrl: '/identity/v1/',
         aliasUrl: '/webevents/v1/identity/',
-        loggingUrl: '/v1/log',
-        errorUrl: '/v1/errors',
     },
     Base64CookieKeys: {
         csm: 1,

src/identityApiClient.ts

@@ -25,7 +25,7 @@ import {
     IIdentityResponse,
 } from './identity-user-interfaces';
 import { IMParticleWebSDKInstance } from './mp-instance';
-import { ErrorCodes } from './logging/types';
+import { ErrorCodes, WSDKErrorSeverity } from './reporting/types';
 
 const { HTTPCodes, Messages, IdentityMethods } = Constants;
 
@@ -329,10 +329,13 @@ export default function IdentityAPIClient(
             }
 
             const errorMessage = (err as Error).message || err.toString();
-            Logger.error(
-                'Error sending identity request to servers' + ' - ' + errorMessage,
-                ErrorCodes.IDENTITY_REQUEST
-            );
+            const msg = 'Error sending identity request to servers' + ' - ' + errorMessage;
+            Logger.error(msg);
+            mpInstance._ErrorReportingDispatcher?.report({
+                message: msg,
+                code: ErrorCodes.IDENTITY_REQUEST,
+                severity: WSDKErrorSeverity.ERROR,
+            });
 
             mpInstance.processQueueOnIdentityFailure?.();
             invokeCallback(callback, HTTPCodes.noHttpCoverage, errorMessage);

src/logger.ts

@@ -1,25 +1,19 @@
 import { LogLevelType, SDKInitConfig, SDKLoggerApi } from './sdkRuntimeModels';
-import { ReportingLogger } from './logging/reportingLogger';
-import { ErrorCodes } from './logging/types';
 
 export type ILoggerConfig = Pick<SDKInitConfig, 'logLevel' | 'logger'>;
 export type IConsoleLogger = Partial<Pick<SDKLoggerApi, 'error' | 'warning' | 'verbose'>>;
 
 export class Logger {
     private logLevel: LogLevelType;
     private logger: IConsoleLogger;
-    private reportingLogger: ReportingLogger;
 
-    constructor(config: ILoggerConfig,
-        reportingLogger?: ReportingLogger,
-    ) {
+    constructor(config: ILoggerConfig) {
         this.logLevel = config.logLevel ?? LogLevelType.Warning;
         this.logger = config.logger ?? new ConsoleLogger();
-        this.reportingLogger = reportingLogger;
     }
 
     public verbose(msg: string): void {
-        if(this.logLevel === LogLevelType.None) 
+        if(this.logLevel === LogLevelType.None)
             return;
 
         if (this.logger.verbose && this.logLevel === LogLevelType.Verbose) {
@@ -37,15 +31,12 @@ export class Logger {
         }
     }
 
-    public error(msg: string, codeForReporting?: ErrorCodes): void {
+    public error(msg: string): void {
         if(this.logLevel === LogLevelType.None)
             return;
 
         if (this.logger.error) {
             this.logger.error(msg);
-            if (codeForReporting) {
-                this.reportingLogger?.error(msg, codeForReporting);
-            }
         }
     }
 

src/mp-instance.ts

@@ -52,7 +52,9 @@ import ForegroundTimer from './foregroundTimeTracker';
 import RoktManager, { IRoktOptions } from './roktManager';
 import filteredMparticleUser from './filteredMparticleUser';
 import CookieConsentManager, { ICookieConsentManager } from './cookieConsentManager';
-import { ReportingLogger } from './logging/reportingLogger';
+import { ErrorReportingDispatcher } from './reporting/errorReportingDispatcher';
+import { LoggingDispatcher } from './reporting/loggingDispatcher';
+import { IErrorReportingService, ILoggingService } from './reporting/types';
 
 export interface IErrorLogMessage {
     message?: string;
@@ -85,7 +87,8 @@ export interface IMParticleWebSDKInstance extends MParticleWebSDK {
     _NativeSdkHelpers: INativeSdkHelpers;
     _Persistence: IPersistence;
     _CookieConsentManager: ICookieConsentManager;
-    _ReportingLogger: ReportingLogger;
+    _ErrorReportingDispatcher: ErrorReportingDispatcher;
+    _LoggingDispatcher: LoggingDispatcher;
     _RoktManager: RoktManager;
     _SessionManager: ISessionManager;
     _ServerModel: IServerModel;
@@ -266,14 +269,14 @@ export default function mParticleInstance(this: IMParticleWebSDKInstance, instan
         }
     };
 
-    this._resetForTests = function(config, keepPersistence, instance, reportingLogger?: ReportingLogger) {
+    this._resetForTests = function(config, keepPersistence, instance) {
         if (instance._Store) {
             delete instance._Store;
         }
-        instance.Logger = new Logger(config, reportingLogger);
+        instance._ErrorReportingDispatcher = new ErrorReportingDispatcher();
+        instance._LoggingDispatcher = new LoggingDispatcher();
+        instance.Logger = new Logger(config);
         instance._Store = new Store(config, instance);
-        // Update ReportingLogger with the new Store reference to avoid stale data
-        reportingLogger?.setStore(instance._Store);
         instance._Store.isLocalStorageAvailable = instance._Persistence.determineLocalStorageAvailability(
             window.localStorage
         );
@@ -1406,6 +1409,14 @@ export default function mParticleInstance(this: IMParticleWebSDKInstance, instan
         }
     };
 
+    this.registerErrorReportingService = function(service: IErrorReportingService) {
+        self._ErrorReportingDispatcher.register(service);
+    };
+
+    this.registerLoggingService = function(service: ILoggingService) {
+        self._LoggingDispatcher.register(service);
+    };
+
     const launcherInstanceGuidKey = Constants.Rokt.LauncherInstanceGuidKey;
     this.setLauncherInstanceGuid = function() {
         if (!window[launcherInstanceGuidKey] 
@@ -1630,16 +1641,11 @@ function createIdentityCache(mpInstance) {
 }
 
 function runPreConfigFetchInitialization(mpInstance, apiKey, config) {
-    mpInstance._ReportingLogger = new ReportingLogger(
-        config,
-        Constants.sdkVersion,
-        undefined,
-        mpInstance.getLauncherInstanceGuid(),
-    );
-    mpInstance.Logger = new Logger(config, mpInstance._ReportingLogger);
+    mpInstance._ErrorReportingDispatcher = new ErrorReportingDispatcher();
+    mpInstance._LoggingDispatcher = new LoggingDispatcher();
+    mpInstance.Logger = new Logger(config);
     mpInstance._Store = new Store(config, mpInstance, apiKey);
     window.mParticle.Store = mpInstance._Store;
-    mpInstance._ReportingLogger.setStore(mpInstance._Store);
     mpInstance.Logger.verbose(StartingInitialization);
 
     // Initialize CookieConsentManager with privacy flags from launcherOptions

src/mparticle-instance-manager.ts

@@ -487,6 +487,12 @@ function mParticleInstanceManager(this: IMParticleInstanceManager) {
     this._setWrapperSDKInfo = function(name, version) {
         self.getInstance()._setWrapperSDKInfo(name, version);
     };
+    this.registerErrorReportingService = function(service) {
+        self.getInstance().registerErrorReportingService(service);
+    };
+    this.registerLoggingService = function(service) {
+        self.getInstance().registerLoggingService(service);
+    };
 }
 
 const mParticleManager = new mParticleInstanceManager();

src/reporting/errorReportingDispatcher.ts

@@ -0,0 +1,13 @@
+import { IErrorReportingService, ISDKError } from './types';
+
+export class ErrorReportingDispatcher implements IErrorReportingService {
+    private services: IErrorReportingService[] = [];
+
+    public register(service: IErrorReportingService): void {
+        this.services.push(service);
+    }
+
+    public report(error: ISDKError): void {
+        this.services.forEach(s => s.report(error));
+    }
+}

src/reporting/loggingDispatcher.ts

@@ -0,0 +1,13 @@
+import { ILoggingService, ISDKLogEntry } from './types';
+
+export class LoggingDispatcher implements ILoggingService {
+    private services: ILoggingService[] = [];
+
+    public register(service: ILoggingService): void {
+        this.services.push(service);
+    }
+
+    public log(entry: ISDKLogEntry): void {
+        this.services.forEach(s => s.log(entry));
+    }
+}