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]

… 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

…uctor to accept accountId, with corresponding test adjustments

…tion with valueof utility and update ReportingLogger to use baseUrl; adjust tests accordingly

…in ReportingLogger, with corresponding tests for fallback behavior

…responding test expectation

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