feat: Create logging service #1137

alexs-mparticle · 2025-12-17T21:32:57Z

Background

{Explain the context of the change, including the problem it addresses or relevant background information}

What Has Changed

{Describe the changes introduced by this PR}

Screenshots/Video

{Include any screenshots or video demonstrating the new feature or fix, if applicable}

Checklist

I have performed a self-review of my own code.
I have made corresponding changes to the documentation.
I have added tests that prove my fix is effective or that my feature works.
I have tested this locally.

Additional Notes

{Any additional information or context relevant to this PR}

Reference Issue (For employees only. Ignore if you are an outside contributor)

Closes https://go/j/[ticket-number]

mattbodle

Update the description please

Copilot

Pull request overview

This PR introduces a centralized logging service infrastructure to the mParticle Web SDK, enabling remote error and warning reporting to Rokt endpoints. The implementation includes a ReportingLogger class with rate limiting, feature flag controls, and integration with the existing Logger class.

Key changes:

Adds ReportingLogger service with rate limiting and conditional enablement
Integrates remote logging into the existing Logger class
Adds support for error codes and stack trace reporting
Configures logging and error URL endpoints via SDK configuration

Reviewed changes

Copilot reviewed 12 out of 12 changed files in this pull request and generated 65 comments.

Show a summary per file

File	Description
test/jest/reportingLogger.spec.ts	Adds comprehensive test coverage for ReportingLogger and RateLimiter classes
src/logging/reportingLogger.ts	Implements the core ReportingLogger service with rate limiting and conditional logging
src/logging/logRequest.ts	Defines request body types and severity enum for logging API
src/logging/errorCodes.ts	Defines ErrorCodes enum for error categorization
src/logger.ts	Integrates ReportingLogger into existing Logger class
src/mp-instance.ts	Initializes ReportingLogger during SDK setup and wires configuration
src/sdkRuntimeModels.ts	Updates SDKLoggerApi and SDKInitConfig interfaces to support error codes
src/store.ts	Adds loggingUrl and errorUrl to SDKConfig interface
src/uploaders.ts	Extends IFetchPayload headers to support rokt-account-id header
src/constants.ts	Adds default logging and error URLs for both standard and CNAME configurations
src/identityApiClient.ts	Updates error logging to include ErrorCodes
src/roktManager.ts	Adds TODO comment for future enhancement

Comments suppressed due to low confidence (1)

test/jest/reportingLogger.spec.ts:91

Superfluous argument passed to constructor of class ReportingLogger.

        logger = new ReportingLogger(baseUrl, sdkVersion, accountId, mockRateLimiter);

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2025-12-17T22:35:06Z

src/logging/reportingLogger.ts

+    private sendLog(
+        severity: WSDKErrorSeverity,
+        msg: string,
+        code: ErrorCodes,


The sendLog() method signature shows 'code: ErrorCodes' as required, but since error() and warning() methods should accept optional codes, this should also be optional ('code?: ErrorCodes'). Additionally, when code is undefined, the logRequest object should handle this appropriately (possibly omitting the code field or using a default value).

It should default to "UNKNOWN_ERROR"

Copilot · 2025-12-17T22:35:06Z

src/logging/reportingLogger.ts

+    };
+
+    public warning(msg: string, code: ErrorCodes) { 
+        this.sendLog(WSDKErrorSeverity.WARNING, msg, code);
+    };


Unnecessary semicolon after the method body. Remove the trailing semicolon for consistency with JavaScript/TypeScript conventions.

Suggested change

};

public warning(msg: string, code: ErrorCodes) {

this.sendLog(WSDKErrorSeverity.WARNING, msg, code);

};

}

public warning(msg: string, code: ErrorCodes) {

this.sendLog(WSDKErrorSeverity.WARNING, msg, code);

}

Copilot · 2025-12-17T22:35:07Z

test/jest/reportingLogger.spec.ts

+                return ++count > 3;
+            }),
+        };
+        logger = new ReportingLogger(baseUrl, sdkVersion, accountId, mockRateLimiter);


Same issue as line 27 - the ReportingLogger constructor signature doesn't match what's being called in the test. The correct signature is (sdkVersion, rateLimiter?, launcherInstanceGuid?). Update to match the actual constructor signature.

Copilot · 2025-12-17T22:35:07Z

test/jest/reportingLogger.spec.ts

+        expect(rateLimiter.incrementAndCheck(LogRequestSeverity.Error)).toBe(true);
+        expect(rateLimiter.incrementAndCheck(LogRequestSeverity.Error)).toBe(true);


The test uses LogRequestSeverity.Error but should use WSDKErrorSeverity.ERROR to match the actual implementation.

Copilot · 2025-12-17T22:35:07Z

test/jest/reportingLogger.spec.ts

+
+    it('allows up to 10 warning logs then rate limits', () => {
+        for (let i = 0; i < 10; i++) {
+            expect(rateLimiter.incrementAndCheck(LogRequestSeverity.Warning)).toBe(false);


The test uses LogRequestSeverity.Warning but should use WSDKErrorSeverity.WARNING to match the actual implementation.

Copilot · 2025-12-17T22:35:22Z

test/jest/reportingLogger.spec.ts

+        for (let i = 0; i < 10; i++) {
+            expect(rateLimiter.incrementAndCheck(LogRequestSeverity.Info)).toBe(false);
+        }
+        expect(rateLimiter.incrementAndCheck(LogRequestSeverity.Info)).toBe(true);


The base expression of this property access is always undefined.

Copilot · 2025-12-17T22:35:22Z

test/jest/reportingLogger.spec.ts

+            expect(rateLimiter.incrementAndCheck(LogRequestSeverity.Info)).toBe(false);
+        }
+        expect(rateLimiter.incrementAndCheck(LogRequestSeverity.Info)).toBe(true);
+        expect(rateLimiter.incrementAndCheck(LogRequestSeverity.Info)).toBe(true);


The base expression of this property access is always undefined.

Copilot · 2025-12-17T22:35:22Z

test/jest/reportingLogger.spec.ts

+
+    it('tracks rate limits independently per severity', () => {
+        for (let i = 0; i < 10; i++) {
+            rateLimiter.incrementAndCheck(LogRequestSeverity.Error);


The base expression of this property access is always undefined.

Copilot · 2025-12-17T22:35:22Z

test/jest/reportingLogger.spec.ts

+        for (let i = 0; i < 10; i++) {
+            rateLimiter.incrementAndCheck(LogRequestSeverity.Error);
+        }
+        expect(rateLimiter.incrementAndCheck(LogRequestSeverity.Error)).toBe(true);


The base expression of this property access is always undefined.

Copilot · 2025-12-17T22:35:23Z

test/jest/reportingLogger.spec.ts

+            rateLimiter.incrementAndCheck(LogRequestSeverity.Error);
+        }
+        expect(rateLimiter.incrementAndCheck(LogRequestSeverity.Error)).toBe(true);
+        expect(rateLimiter.incrementAndCheck(LogRequestSeverity.Warning)).toBe(false);


The base expression of this property access is always undefined.

mattbodle · 2025-12-17T22:37:43Z

src/logging/reportingLogger.ts

+            code: code,
+            url: this.getUrl(),
+            deviceInfo: this.getUserAgent(),
+            stackTrace: stackTrace ?? 'this is my stack trace',


Assuming this is temporary as we don't need a fallback?

@mattbodle should we have it default to an empty string or undefined?

mattbodle · 2025-12-17T22:46:29Z

src/identityApiClient.ts

-            Logger.error('Error sending identity request to servers' + ' - ' + errorMessage);
+            Logger.error(
+                'Error sending identity request to servers' + ' - ' + errorMessage,
+                ErrorCodes.UNHANDLED_EXCEPTION


I would use this error code as a fallback if there is no errorcode. In this example I would create a code similar to IDENTITY_REQUEST

mattbodle · 2025-12-17T22:48:44Z

src/logging/reportingLogger.ts

+    private readonly rateLimiter: IRateLimiter;
+    private loggingUrl: string;
+    private errorUrl: string;
+    private accountId: string;


Why do we need to maintain this here? Should it be stored as state elsewhere?

Note: We should inject _Store so we can persist accountId and grab other properties later.

mattbodle

Could we add an integration test as part of this PR?

Copilot

Copilot encountered an error and was unable to review this pull request. You can try again by re-requesting a review.

… up imports in reportingLogger

… window for location and ROKT_DOMAIN

…locker parameter from related functions

…Uploader and XHRUploader

…proved type safety

… and update tests for new rate limiting behavior

…d update related tests

…n apiClient tests for improved compatibility

…rtingLogger for better encapsulation and update related tests

…entity requests

… with SDKConfig adjustments

sonarqubecloud · 2026-01-16T13:36:18Z

Quality Gate failed

Failed conditions
17.9% Duplication on New Code (required ≤ 3%)

See analysis details on SonarQube Cloud

mattbodle · 2026-01-16T17:44:37Z

A general question about this repo, are we using snake case or camel case for file names? Can we choose one and add to linting rules?

mattbodle · 2026-01-16T17:46:46Z

src/logging/logRequest.ts

@@ -0,0 +1,23 @@
+import { ErrorCodes } from "./errorCodes";
+export type ErrorCode = ErrorCodes | string;


Question on the decision to separate the files here - why are error codes in a separate file, but severity is combined in this one?

rmi22186 · 2026-01-16T19:48:07Z

src/logger.ts

        if (this.logger.warning && 
            (this.logLevel === LogLevelType.Verbose || this.logLevel === LogLevelType.Warning)) {
            this.logger.warning(msg);
+            this.reportingLogger?.warning(msg, code);


Let's not send warnings yet. Let's start with errors.

rmi22186 · 2026-01-16T19:56:59Z

src/identityApiClient.ts

-            Logger.error('Error sending identity request to servers' + ' - ' + errorMessage);
+            Logger.error(
+                'Error sending identity request to servers' + ' - ' + errorMessage,
+                ErrorCodes.IDENTITY_REQUEST


only upload errors that have error codes so that we can trickle the errors in as opposed to floding

rmi22186 · 2026-01-16T19:57:43Z

src/logging/reportingLogger.ts

+                version: this.getVersion(),
+            },
+            severity: severity,
+            code: code ?? ErrorCodes.UNKNOWN_ERROR,


update this to only sen if an error code exists

rmi22186 · 2026-01-20T02:10:19Z

src/logging/logRequest.ts

+export type ErrorsRequestBody = {
+    additionalInformation?: Record<string, string>;
+    code: ErrorCode;
+    severity: WSDKErrorSeverity;
+    stackTrace?: string;
+    deviceInfo?: string;
+    integration?: string;
+    reporter?: string;
+    url?: string;
+  };
+
+export type LogRequestBody = ErrorsRequestBody;


Any reason to not just do

Suggested change

export type ErrorsRequestBody = {

additionalInformation?: Record<string, string>;

code: ErrorCode;

severity: WSDKErrorSeverity;

stackTrace?: string;

deviceInfo?: string;

integration?: string;

reporter?: string;

url?: string;

};

export type LogRequestBody = ErrorsRequestBody;

export type LogRequestBody = {

additionalInformation?: Record<string, string>;

code: ErrorCode;

severity: WSDKErrorSeverity;

stackTrace?: string;

deviceInfo?: string;

integration?: string;

reporter?: string;

url?: string;

};

rmi22186 · 2026-01-20T02:12:32Z

src/logging/reportingLogger.ts

+    private readonly reporter: string = 'mp-wsdk';
+    private readonly integration: string = 'mp-wsdk';


Would these ver differ and if not should we make them one string? or have a constant and set each to the constant?

rmi22186 · 2026-01-20T02:15:26Z

src/logging/reportingLogger.ts

+        this.sendError(WSDKErrorSeverity.WARNING, msg, code);
+    }
+
+    private sendToServer(url: string,severity: WSDKErrorSeverity, msg: string, code?: ErrorCodes, stackTrace?: string): void {


Suggested change

private sendToServer(url: string,severity: WSDKErrorSeverity, msg: string, code?: ErrorCodes, stackTrace?: string): void {

private sendToServer(url: string, severity: WSDKErrorSeverity, msg: string, code?: ErrorCodes, stackTrace?: string): void {

rmi22186 · 2026-01-20T02:18:42Z

src/logging/reportingLogger.ts

+    }
+
+    private sendLog(severity: WSDKErrorSeverity, msg: string, code?: ErrorCodes, stackTrace?: string): void {
+        const url = this.getLoggingUrl();


We should compute the string once in the constructor and store them on the class vs computing it every time a log is sent

rmi22186 · 2026-01-20T02:18:45Z

src/logging/reportingLogger.ts

+        this.sendToServer(url, severity, msg, code, stackTrace);
+    }
+    private sendError(severity: WSDKErrorSeverity, msg: string, code?: ErrorCodes, stackTrace?: string): void {
+        const url = this.getErrorUrl();


We should compute the string once in the constructor and store them on the class vs computing it every time a log is sent

rmi22186 · 2026-01-20T02:19:31Z

src/logging/reportingLogger.ts

+        this.sendToServer(url, severity, msg, code, stackTrace);
+    }
+
+    private getLogRequest(severity: WSDKErrorSeverity, msg: string, code?: ErrorCodes, stackTrace?: string): LogRequestBody {


Not a getter.

Suggested change

private getLogRequest(severity: WSDKErrorSeverity, msg: string, code?: ErrorCodes, stackTrace?: string): LogRequestBody {

private buildLogRequest(severity: WSDKErrorSeverity, msg: string, code?: ErrorCodes, stackTrace?: string): LogRequestBody {

rmi22186 · 2026-01-20T02:20:28Z

src/logging/reportingLogger.ts

+        this.rateLimiter = rateLimiter ?? new RateLimiter();
+    }
+
+    public setIntegrationName(integrationName: string) {


When would this be called?

rmi22186 · 2026-01-20T02:23:07Z

src/logging/reportingLogger.ts

+        // QUESTION: Should isDebugModeEnabled take precedence over
+        // isFeatureFlagEnabled and rokt domain present?


I think keeping it this way is fine. Technically Rokt domain is required for this to be work at all.

rmi22186 · 2026-01-20T02:28:08Z

src/mp-instance.ts

 function runPreConfigFetchInitialization(mpInstance, apiKey, config) {
-    mpInstance.Logger = new Logger(config);
-    mpInstance._Store = new Store(config, mpInstance, apiKey);
+


Suggested change

rmi22186 · 2026-01-20T02:32:04Z

src/sdkConfigManager.ts

+
+        for (const prop in Constants.DefaultConfig) {
+            if (Constants.DefaultConfig.hasOwnProperty(prop)) {
+                config[prop] = Constants.DefaultConfig[prop];


should this be

Suggested change

config[prop] = Constants.DefaultConfig[prop];

sdkConfig[prop] = Constants.DefaultConfig[prop];

rmi22186 · 2026-01-20T02:36:50Z

src/sdkConfigManager.ts

+    private processFlags(config: SDKInitConfig): IFeatureFlags {
+        const flags: IFeatureFlags = {};
+        const {
+            ReportBatching,
+            EventBatchingIntervalMillis,
+            OfflineStorage,
+            DirectUrlRouting,
+            CacheIdentity,
+            AudienceAPI,
+            CaptureIntegrationSpecificIds,
+            CaptureIntegrationSpecificIdsV2,
+            AstBackgroundEvents
+        } = Constants.FeatureFlags;


this matches the store's function processFlags. can we DRY it up?

actually it looks like a few methods were moved here. so please remove them from store.ts

rmi22186 · 2026-01-20T02:37:16Z

src/sdkConfigManager.ts

+
+

Suggested change

rmi22186

Looking really good overall. mostly minor comments

rmi22186 · 2026-01-20T03:01:39Z

src/logger.ts


        if (this.logger.error) {
            this.logger.error(msg);
+            this.reportingLogger.error(msg, code);


Suggested change

this.reportingLogger.error(msg, code);

this.reportingLogger?.error(msg, code);

rmi22186 · 2026-01-20T03:03:11Z

src/logging/reportingLogger.ts

+
+// QUESTION: Should we collapse the interface with the class?
+export interface IReportingLogger {
+    error(msg: string, code?: ErrorCodes, stackTrace?: string): void;


should this have info?

alexs-mparticle changed the title ~~Feat/sdke 511 create logging service v2 revised~~ feat: Create logging service Dec 17, 2025

alexs-mparticle changed the base branch from development to blackout2025 December 17, 2025 21:45

alexs-mparticle force-pushed the feat/SDKE-511-create-logging-service-v2-revised branch from 5078a52 to b972c57 Compare December 17, 2025 21:52

alexs-mparticle requested review from Copilot, mattbodle and rmi22186 December 17, 2025 22:09

Copilot started reviewing on behalf of alexs-mparticle December 17, 2025 22:10 View session

mattbodle requested changes Dec 17, 2025

View reviewed changes

Copilot AI reviewed Dec 17, 2025

View reviewed changes

mattbodle reviewed Dec 17, 2025

View reviewed changes

mattbodle reviewed Dec 18, 2025

View reviewed changes

alexs-mparticle requested review from Copilot and mattbodle December 18, 2025 21:46

Copilot started reviewing on behalf of alexs-mparticle December 18, 2025 21:48 View session

Copilot AI reviewed Dec 18, 2025

View reviewed changes

gtamanaha changed the base branch from blackout2025 to development January 15, 2026 00:47

gtamanaha changed the base branch from development to blackout2025 January 15, 2026 00:48

gtamanaha added 11 commits January 14, 2026 21:54

feat: Migrate Logger to Typescript (#1120)

4a1b8c7

feat: Create Logging Service

9d39a16

fix(apiClient): Update upload URL construction in APIClient and clean…

4f2e84f

… up imports in reportingLogger

fix(tests): Update reportingLogger tests to use globalThis instead of…

82b7b16

… window for location and ROKT_DOMAIN

refactor(mParticleInstance): Simplify initialization by removing kitB…

8c9af41

…locker parameter from related functions

test(apiClient): Add unit tests for sendLogToServer method with Fetch…

d44807a

…Uploader and XHRUploader

refactor(reportingLogger): Add return types to private methods for im…

9270c08

…proved type safety

refactor(reportingLogger): Allow optional rate limiter in constructor…

ae34428

… and update tests for new rate limiting behavior

refactor(reportingLogger): Change rateLimiter type to IRateLimiter an…

70fa12b

…d update related tests

fix(tests): Replace global references from 'global' to 'globalThis' i…

adf4165

…n apiClient tests for improved compatibility

refactor(logging): Move sendLogToServer method from APIClient to Repo…

90f5bea

…rtingLogger for better encapsulation and update related tests

alexs-mparticle and others added 5 commits January 14, 2026 21:56

Revise implementation of ReportingLogger

f7effbf

Revised implementation

692b4a7

Introduce IDENTITY_REQUEST error code and update error logging for id…

7bafa5f

…entity requests

Remove unnecessary semicolons

184ecb5

refactor(reportingLogger): Update logging URLs and enhance test setup…

22114bf

… with SDKConfig adjustments

gtamanaha force-pushed the feat/SDKE-511-create-logging-service-v2-revised branch from 06e9d53 to 22114bf Compare January 15, 2026 00:56

gtamanaha changed the base branch from blackout2025 to development January 15, 2026 00:57

gtamanaha marked this pull request as ready for review January 15, 2026 11:22

Conflicts

3d41bdc

mattbodle reviewed Jan 16, 2026

View reviewed changes

rmi22186 reviewed Jan 16, 2026

View reviewed changes

rmi22186 reviewed Jan 20, 2026

View reviewed changes

src/sdkConfigManager.ts

Comment on lines +88 to +89

Copy link

Member

rmi22186 Jan 20, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change

rmi22186 requested changes Jan 20, 2026

View reviewed changes

rmi22186 reviewed Jan 20, 2026

View reviewed changes

		expect(rateLimiter.incrementAndCheck(LogRequestSeverity.Error)).toBe(true);
		expect(rateLimiter.incrementAndCheck(LogRequestSeverity.Error)).toBe(true);

		@@ -0,0 +1,23 @@
		import { ErrorCodes } from "./errorCodes";
		export type ErrorCode = ErrorCodes \| string;

		private readonly reporter: string = 'mp-wsdk';
		private readonly integration: string = 'mp-wsdk';

	private sendToServer(url: string,severity: WSDKErrorSeverity, msg: string, code?: ErrorCodes, stackTrace?: string): void {
	private sendToServer(url: string, severity: WSDKErrorSeverity, msg: string, code?: ErrorCodes, stackTrace?: string): void {

	private getLogRequest(severity: WSDKErrorSeverity, msg: string, code?: ErrorCodes, stackTrace?: string): LogRequestBody {
	private buildLogRequest(severity: WSDKErrorSeverity, msg: string, code?: ErrorCodes, stackTrace?: string): LogRequestBody {

		// QUESTION: Should isDebugModeEnabled take precedence over
		// isFeatureFlagEnabled and rokt domain present?

	config[prop] = Constants.DefaultConfig[prop];
	sdkConfig[prop] = Constants.DefaultConfig[prop];

	this.reportingLogger.error(msg, code);
	this.reportingLogger?.error(msg, code);

feat: Create logging service #1137

Are you sure you want to change the base?

feat: Create logging service #1137

Uh oh!

Conversation

alexs-mparticle commented Dec 17, 2025

Background

What Has Changed

Screenshots/Video

Checklist

Additional Notes

Reference Issue (For employees only. Ignore if you are an outside contributor)

Uh oh!

mattbodle left a comment

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Dec 17, 2025

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 17, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 17, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 17, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 17, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 17, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 17, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 17, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 17, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 17, 2025

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mattbodle left a comment

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Uh oh!

sonarqubecloud bot commented Jan 16, 2026

Quality Gate failed

Uh oh!

mattbodle commented Jan 16, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!