feat: Create Logging Service SDKE-511 #1123

gtamanaha · 2025-11-25T16:24:28Z

Background

This PR introduces a new server-side logging service that enables the mParticle Web SDK to send error and warning logs to mParticle's backend for improved monitoring and debugging. The implementation includes creating a new ReportingLogger service that can send logs to the server when enabled.

Important: Next PR will include the reporting service call from Logger.ts

What Has Changed

Major Features

New ReportingLogger service for server-side log submission
API Client enhanced with sendLogToServer() method
New logging infrastructure (logRequest, errorCodes, etc.)
Configuration option isWebSdkLoggingEnabled added
Test coverage added for all new functionality

Technical Highlights

Rate limiting: 10 logs per severity type
Conditional enabling: Only active when Rokt domain is present + feature flag or debug mode

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/SDKE-511

… up imports in reportingLogger

… window for location and ROKT_DOMAIN

src/mp-instance.ts

…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

src/logging/errorCodes.ts

alexs-mparticle · 2025-12-09T14:50:48Z

src/logging/errorCodes.ts

@@ -0,0 +1,5 @@
+export type ErrorCodes = (typeof ErrorCodes)[keyof typeof ErrorCodes];
+
+export const ErrorCodes = {


I think this should be ErrorMessages. ErrorCodes sounds like they'd be something numerical like HTTP Error Codes (404, 429, etc).

Are you naming this ErrorMessages because that's something defined on the server side?

src/logging/logMessage.ts

alexs-mparticle · 2025-12-09T14:52:55Z

src/logging/logRequest.ts

@@ -0,0 +1,21 @@
+import { ErrorCodes } from "./errorCodes";
+
+export enum LogRequestSeverity {


We have a type for LogLevelType. Is there any way we can consolidate these into one thing?

I would prefer to keep them separated because these ones depends on the API contract.

src/logging/reportingLogger.ts

alexs-mparticle · 2025-12-09T15:01:12Z

src/logging/reportingLogger.ts

+        [LogRequestSeverity.Error, 10],
+        [LogRequestSeverity.Warning, 10],
+        [LogRequestSeverity.Info, 10],


If each of these default to 10, should we just make this a constant?

I would like to discuss if these amounts are good amount first. @mattbodle @rmi22186 what do you think about these limits?

Can we use the same rate limits and logic from WSDK?

alexs-mparticle · 2025-12-09T15:02:09Z

src/logging/reportingLogger.ts

+
+    public incrementAndCheck(severity: LogRequestSeverity): boolean {
+        const count = this.logCount.get(severity) || 0;
+        const limit = this.rateLimits.get(severity) || 10;


If we want 10 to be the default rate limit, we can then reuse a constant here.

alexs-mparticle · 2025-12-09T15:08:48Z

src/logging/reportingLogger.ts

+    }
+
+    private getUrl(): string {
+        return window.location.href;


In these cases where you're using window, you should first check if window exists, especially if this module is going to log errors that are independent of the SDK itself.

We've had problems in the past of customers and partners using the Web SDK server side and window will not exist.

Added null conditional operator

alexs-mparticle · 2025-12-09T15:12:13Z

src/logging/reportingLogger.ts

+            headers: {
+                Accept: 'text/plain;charset=UTF-8',
+                'Content-Type': 'text/plain;charset=UTF-8',
+                'rokt-account-id': this.accountId


What happens here if accountId is undefined or null?

Added default value 0, which is the same behavior from rokt wsdk.

alexs-mparticle · 2025-12-09T15:22:11Z

test/jest/reportingLogger.spec.ts

+        global.fetch = mockFetch;
+
+        mpInstance = {
+            _Helpers: {


This may be future work but if it's easy enough, we should rewrite createServiceUrl so that it isn't as tightly coupled to the full SDK instance or Store, or make it a function within Store.

If it's future work, we should collect some of these refactors into a launch pad.

Removed mpInstance

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

…in ReportingLogger, with corresponding tests for fallback behavior

…responding test expectation

sonarqubecloud · 2025-12-10T12:36:57Z

Quality Gate passed

Issues
12 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

alexs-mparticle · 2025-12-12T19:26:19Z

src/logging/reportingLogger.ts

+        return window.
+                mParticle?.
+                config?.
+                isWebSdkLoggingEnabled ?? false;


I think we should pass this in as a param in the constructor so that we're not tightly coupled to the window.

alexs-mparticle · 2025-12-12T19:27:04Z

src/logging/reportingLogger.ts

+
+    private isDebugModeEnabled(): boolean {
+        return (
+            window.


Same here. We should not be tightly coupled to the window. There should be a utility method to get url params.

mattbodle · 2025-12-16T15:44:31Z

src/logging/reportingLogger.ts

+    private readonly rateLimiter: IRateLimiter;
+    private readonly DEFAULT_ACCOUNT_ID: string = '0';
+    private readonly DEFAULT_USER_AGENT: string = 'no-user-agent-set';
+    private readonly DEFAULT_URL: string = 'no-url-set';


Add rokt-launcher-instance-guid as a default header

mattbodle · 2025-12-16T17:55:41Z

src/logging/logRequest.ts

+    Info = 'info',
+}
+
+export interface LogRequest {


Copy the exact types from WSDK:

export type WSDKErrorSeverity = (typeof WSDKErrorSeverity)[keyof typeof WSDKErrorSeverity]; export const WSDKErrorSeverity = { ERROR: 'ERROR', INFO: 'INFO', WARNING: 'WARNING', } as const; export interface IWSDKError { name: string; message: string; stack?: string; code?: ErrorCode; reporter?: string; integration?: string; severity?: WSDKErrorSeverity; additionalInformation?: Record<string, string>; handled?: boolean; }

mattbodle · 2025-12-16T17:57:13Z

src/logging/reportingLogger.ts

+    private readonly reporter: string = 'mp-wsdk';
+    private readonly integration: string = 'mp-wsdk';
+    private readonly rateLimiter: IRateLimiter;
+    private readonly DEFAULT_ACCOUNT_ID: string = '0';


No need to set default, do not add account id header if it doesn't exist

mattbodle · 2025-12-16T17:57:16Z

src/logging/reportingLogger.ts

+    private readonly integration: string = 'mp-wsdk';
+    private readonly rateLimiter: IRateLimiter;
+    private readonly DEFAULT_ACCOUNT_ID: string = '0';
+    private readonly DEFAULT_USER_AGENT: string = 'no-user-agent-set';


Is this required??

mattbodle · 2025-12-16T17:57:33Z

src/logging/reportingLogger.ts

+    private readonly rateLimiter: IRateLimiter;
+    private readonly DEFAULT_ACCOUNT_ID: string = '0';
+    private readonly DEFAULT_USER_AGENT: string = 'no-user-agent-set';
+    private readonly DEFAULT_URL: string = 'no-url-set';


Is this required? When do we not get a href?

mattbodle · 2025-12-16T17:58:47Z

src/logging/reportingLogger.ts

+    }
+
+    public error(msg: string, code?: ErrorCodes, stackTrace?: string) {
+        this.sendLog(LogRequestSeverity.Error, msg, code ?? ErrorCodes.UNHANDLED_EXCEPTION, stackTrace);


Can we make code a mandatory parameter?
UNHANDLED_EXCEPTION is a code we specifically use when an error escapes any catch clause and is receeived by the window

mattbodle · 2025-12-16T17:59:20Z

src/logging/reportingLogger.ts

+        const logRequest: LogRequest = {
+            additionalInformation: {
+                message: msg,
+                version: this.sdkVersion,


Should version be here?

mattbodle · 2025-12-16T17:59:42Z

src/logging/reportingLogger.ts

+            code: code,
+            url: this.getUrl(),
+            deviceInfo: this.getUserAgent(),
+            stackTrace: stackTrace ?? '',


stacktrace or stack?

gtamanaha added 2 commits November 25, 2025 13:13

feat: Migrate Logger to Typescript (#1120)

4cc5aa8

feat: Create Logging Service

7358464

gtamanaha changed the base branch from master to blackout2025 November 25, 2025 16:24

gtamanaha changed the title ~~feat: Create Loggin Service~~ feat: Create Logging Service Nov 25, 2025

gtamanaha mentioned this pull request Nov 25, 2025

[Closed] Feat: Create Logging Service #1122

Closed

4 tasks

gtamanaha added 2 commits November 25, 2025 13:29

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

7abe3fe

… up imports in reportingLogger

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

c646b0c

… window for location and ROKT_DOMAIN

gtamanaha commented Nov 25, 2025

View reviewed changes

src/mp-instance.ts Outdated Show resolved Hide resolved

gtamanaha added 6 commits November 27, 2025 10:26

refactor(mParticleInstance): Simplify initialization by removing kitB…

5cef096

…locker parameter from related functions

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

8fa5adb

…Uploader and XHRUploader

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

85f99db

…proved type safety

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

dcd3d84

… and update tests for new rate limiting behavior

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

04c9e79

…d update related tests

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

cb0222e

…n apiClient tests for improved compatibility

gtamanaha marked this pull request as ready for review December 1, 2025 12:32

gtamanaha changed the title ~~feat: Create Logging Service~~ feat: Create Logging Service SDKE-511 Dec 1, 2025

gtamanaha requested a review from rmi22186 December 1, 2025 12:38

gtamanaha added 3 commits December 2, 2025 14:37

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

c8dc013

…rtingLogger for better encapsulation and update related tests

refactor(apiClient): Remove unused LogRequest import to clean up code

8746bd1

feat(reportingLogger): Add 'rokt-account-id' header and update constr…

cac1c3c

…uctor to accept accountId, with corresponding test adjustments

alexs-mparticle requested changes Dec 9, 2025

View reviewed changes

gtamanaha self-assigned this Dec 9, 2025

gtamanaha added 3 commits December 9, 2025 13:52

refactor(errorCodes, reportingLogger): Replace ErrorCodes type defini…

5581588

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

feat(reportingLogger): Introduce default user agent and URL handling …

42a67c0

…in ReportingLogger, with corresponding tests for fallback behavior

fix(reportingLogger): Update default account ID to '0' and adjust cor…

4de0bc7

…responding test expectation

gtamanaha requested a review from alexs-mparticle December 10, 2025 12:37

alexs-mparticle reviewed Dec 12, 2025

View reviewed changes

mattbodle reviewed Dec 16, 2025

View reviewed changes

alexs-mparticle force-pushed the blackout2025 branch from 4cc5aa8 to c48930e Compare December 17, 2025 21:44

		@@ -0,0 +1,5 @@
		export type ErrorCodes = (typeof ErrorCodes)[keyof typeof ErrorCodes];

		export const ErrorCodes = {

		@@ -0,0 +1,21 @@
		import { ErrorCodes } from "./errorCodes";

		export enum LogRequestSeverity {

feat: Create Logging Service SDKE-511 #1123

Are you sure you want to change the base?

feat: Create Logging Service SDKE-511 #1123

Uh oh!

Conversation

gtamanaha commented Nov 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Background

What Has Changed

Major Features

Technical Highlights

Screenshots/Video

Checklist

Additional Notes

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

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

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!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

gtamanaha Dec 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

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!

sonarqubecloud bot commented Dec 10, 2025

Quality Gate passed

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!

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!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

gtamanaha commented Nov 25, 2025 •

edited

Loading

gtamanaha Dec 10, 2025 •

edited

Loading