feat: define reporting service contracts and dispatchers by alexs-mparticle · Pull Request #1224 · mParticle/mparticle-web-sdk

alexs-mparticle · 2026-03-20T20:45:45Z

Summary

Defines IErrorReportingService and ILoggingService interfaces in src/reporting/types.ts
Adds ErrorReportingDispatcher and LoggingDispatcher for multi-service fan-out
Decouples Logger from reporting — Logger is now console-only
Removes concrete ReportingLogger implementation (moves to Rokt kit)
Removes Rokt-specific URLs from constants
Renames src/logging/ to src/reporting/
Exposes registerErrorReportingService() and registerLoggingService() on mParticle API

Companion kit PR: mparticle-integrations/mparticle-javascript-integration-rokt#70

Test plan

Lint, build, Jest tests pass (495 tests)
Verify registration APIs exposed on window.mParticle
Verify Logger.error() no longer triggers remote reporting

…dule - Define IErrorReportingService, ILoggingService, ISDKError, ISDKLogEntry contracts - Add ErrorReportingDispatcher and LoggingDispatcher for multi-service fan-out - Decouple Logger from reporting (console-only now) - Remove concrete ReportingLogger implementation (moves to kit) - Remove Rokt-specific URLs from constants - Rename src/logging/ to src/reporting/ - Expose registerErrorReportingService/registerLoggingService on mParticle API

cursor · 2026-03-20T20:45:50Z

PR Summary

Medium Risk
Medium risk because it refactors cross-cutting logging/reporting behavior and removes the built-in remote ReportingLogger, which could change what errors get surfaced or reported if integrations don’t register replacement services.

Overview
Refactors SDK reporting by removing the built-in ReportingLogger (and its loggingUrl/errorUrl configuration and constants) and making Logger strictly console-only (Logger.error() no longer triggers any reporting side effects).

Introduces structured reporting contracts in src/reporting/types.ts plus ErrorReportingDispatcher/LoggingDispatcher fan-out dispatchers, wires them into mp-instance (including Rokt init) and adds public registration hooks (_registerErrorReportingService, _registerLoggingService) on window.mParticle/instance manager.

Updates IdentityAPIClient and RoktManager to emit console logs and separately send structured errors/warnings (e.g., identity request failures and identity mismatch warnings) through the new dispatchers, and revises tests accordingly.

^{Written by Cursor Bugbot for commit e1b78da. This will update automatically on new commits. Configure here.}

src/reporting/errorReportingDispatcher.ts

src/mp-instance.ts

- Add optional chaining for _ErrorReportingDispatcher in identityApiClient so tests without a mock dispatcher don't crash - Add registerErrorReportingService and registerLoggingService to the expected public API keys in instance manager test

This reverts commit e573c1f.

…ning Reverts optional chaining on _ErrorReportingDispatcher.report() which was masking potential bugs. Instead, properly adds ErrorReportingDispatcher instances to all mock mpInstance objects in identity API client tests.

…uctor - Wrap each service call in try-catch in ErrorReportingDispatcher and LoggingDispatcher so one failing service doesn't break fan-out - Move dispatcher instantiation from runPreConfigFetchInitialization to mParticleInstance constructor so registration works before init() - Destructure errorReporter in identityApiClient for cleaner usage

Rename registerErrorReportingService/registerLoggingService to _registerErrorReportingService/_registerLoggingService to signal these are internal APIs consumed by kits, not public.

Pass ErrorReportingDispatcher and LoggingDispatcher into RoktManager.init() from mp-instance. Add INFO log on kit attach (ROKT_KIT_ATTACHED) and WARNING reports on identity mismatch (IDENTITY_MISMATCH) alongside existing logger.warning calls. Add new error codes to reporting types.

…y swallowing

… mocks The identity API client test mocks were missing _ErrorReportingDispatcher, causing a TypeError when report() was called on 5xx errors. Added optional chaining to the call site and added the mock to both test cases.

Merge development into feat/reporting-service-migration-core, resolving conflicts in dist/ bundle files by accepting development's versions (CI will regenerate these after merge).

… type

src/sdkRuntimeModels.ts

rmi22186 · 2026-04-03T18:35:33Z

src/roktManager.ts


+        this.loggingService?.log({
+            message: 'RoktManager: Kit attached, Rokt is ready',
+            code: ErrorCodes.ROKT_KIT_ATTACHED,


Should this be an errorcode?

rmi22186 · 2026-04-03T18:55:06Z

test/jest/logging-integration.spec.ts

-    const accountId = '9876543210';
-    const integrationName = 'test-integration';
+    describe('Logger is decoupled from reporting', () => {
+        it('Logger.error() does not trigger any reporting', () => {


This test doesn't seem to do what you're claiming it does. I'd remove...all it does is test that no error is thrown. The test below this proves that logger is decoupled from reporting

rmi22186 · 2026-04-03T19:00:28Z

test/jest/reportingLogger.spec.ts

+    it('log() is a no-op when no services are registered', () => {
+        // Should not throw
+        dispatcher.log({
+            message: 'test',


Test name is awkward here. also isn't doing what you are asserting. (There is no assertion). This is also obvious, but how about

const mockService: ILoggingService = { log: jest.fn() }; // Intentionally NOT registering mockService on this dispatcher dispatcher.log({ message: 'test' }); expect(mockService.log).not.toHaveBeenCalled();

rmi22186

minor nits

The TODO indicated this cast should be removed once removeCCPAState was removed. Since removeCCPAState is being removed in this PR, the cast is no longer needed. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

This reverts commit e84e375.

sonarqubecloud · 2026-04-03T19:23:29Z

Quality Gate passed

Issues
0 New issues
0 Accepted issues

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

See analysis details on SonarQube Cloud

cursor

Cursor Bugbot has reviewed your changes and found 2 potential issues.

^{Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, have a team admin enable autofix in the Cursor dashboard.}

cursor · 2026-04-03T19:27:26Z

src/reporting/types.ts

+    UNHANDLED_EXCEPTION: 'UNHANDLED_EXCEPTION',
+    IDENTITY_REQUEST: 'IDENTITY_REQUEST',
+    IDENTITY_MISMATCH: 'IDENTITY_MISMATCH',
+    ROKT_KIT_ATTACHED: 'ROKT_KIT_ATTACHED',


Informational event misclassified as an error code

Low Severity

ROKT_KIT_ATTACHED is defined in the ErrorCodes enum but represents a successful informational event ("Kit attached, Rokt is ready"), not an error or warning. It's only used in loggingService?.log(...), the informational logging path. Placing a success event in an enum named ErrorCodes is misleading and could confuse consumers implementing ILoggingService or IErrorReportingService contracts. As the reviewer noted, this doesn't belong in ErrorCodes.

Additional Locations (1)

src/roktManager.ts#L210-L214

cursor · 2026-04-03T19:27:26Z

test/jest/logging-integration.spec.ts

-            value: { userAgent: 'test-user-agent' }
+            // Logger.error() should only output to console - no reporting side effects
+            // This verifies the decoupling is complete
+            expect(() => logger.error('test error')).not.toThrow();


Test asserts no-throw instead of verifying decoupling

Low Severity

The test named "Logger.error() does not trigger any reporting" only asserts not.toThrow(). It creates no mock services and makes no assertions about reporting behavior, so it doesn't actually verify the decoupling claim in its name. The subsequent test already proves the decoupling properly, making this test redundant and misleading.

alexs-mparticle requested a review from a team as a code owner March 20, 2026 20:45

alexs-mparticle mentioned this pull request Mar 20, 2026

feat: implement Rokt reporting service in kit mparticle-integrations/mparticle-javascript-integration-rokt#70

Open

6 tasks

cursor bot reviewed Mar 20, 2026

View reviewed changes

src/reporting/errorReportingDispatcher.ts Show resolved Hide resolved

src/mp-instance.ts Show resolved Hide resolved

alexs-mparticle marked this pull request as draft March 20, 2026 20:55

alexs-mparticle added 4 commits March 20, 2026 17:12

chore: remove dist/ from tracking (already in gitignore)

e573c1f

Revert "chore: remove dist/ from tracking (already in gitignore)"

caf86dd

This reverts commit e573c1f.

chore: restore dist files to pre-fix state

4adf5fa

alexs-mparticle mentioned this pull request Mar 20, 2026

feat: migrate reporting service contract from logging to reporting module #1221

Closed

4 tasks

alexs-mparticle changed the base branch from master to development March 20, 2026 21:18

alexs-mparticle added 6 commits March 23, 2026 13:44

refactor: prefix registration methods with underscore for internal use

d52684d

Rename registerErrorReportingService/registerLoggingService to _registerErrorReportingService/_registerLoggingService to signal these are internal APIs consumed by kits, not public.

fix: log errors from reporting service dispatchers instead of silentl…

5b3bc0f

…y swallowing

alexs-mparticle marked this pull request as ready for review March 24, 2026 15:12

alexs-mparticle requested review from jaissica12 and rmi22186 March 24, 2026 18:15

alexs-mparticle added 2 commits March 26, 2026 12:56

merge: resolve dist file conflicts from development branch

b2f1e7a

Merge development into feat/reporting-service-migration-core, resolving conflicts in dist/ bundle files by accepting development's versions (CI will regenerate these after merge).

fix: mark dispatcher services as readonly and remove unused ErrorCode…

f153c27

… type

cursor bot reviewed Mar 26, 2026

View reviewed changes

src/sdkRuntimeModels.ts Show resolved Hide resolved

rmi22186 reviewed Apr 3, 2026

View reviewed changes

rmi22186 and others added 2 commits April 3, 2026 15:21

refactor: remove unnecessary cast in createConsentState

e84e375

The TODO indicated this cast should be removed once removeCCPAState was removed. Since removeCCPAState is being removed in this PR, the cast is no longer needed. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

Revert "refactor: remove unnecessary cast in createConsentState"

e1b78da

This reverts commit e84e375.

cursor bot reviewed Apr 3, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: define reporting service contracts and dispatchers#1224

feat: define reporting service contracts and dispatchers#1224
alexs-mparticle wants to merge 15 commits intodevelopmentfrom
feat/reporting-service-migration-core

alexs-mparticle commented Mar 20, 2026 •

edited

Loading

Uh oh!

cursor bot commented Mar 20, 2026 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

Uh oh!

rmi22186 Apr 3, 2026

Uh oh!

rmi22186 Apr 3, 2026

Uh oh!

rmi22186 Apr 3, 2026

Uh oh!

rmi22186 left a comment

Uh oh!

sonarqubecloud bot commented Apr 3, 2026

Uh oh!

cursor bot left a comment

Uh oh!

cursor bot Apr 3, 2026

Uh oh!

cursor bot Apr 3, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

alexs-mparticle commented Mar 20, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Test plan

Uh oh!

cursor bot commented Mar 20, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

PR Summary

Uh oh!

Uh oh!

Uh oh!

Uh oh!

rmi22186 Apr 3, 2026

Choose a reason for hiding this comment

Uh oh!

rmi22186 Apr 3, 2026

Choose a reason for hiding this comment

Uh oh!

rmi22186 Apr 3, 2026

Choose a reason for hiding this comment

Uh oh!

rmi22186 left a comment

Choose a reason for hiding this comment

Uh oh!

sonarqubecloud bot commented Apr 3, 2026

Quality Gate passed

Uh oh!

cursor bot left a comment

Choose a reason for hiding this comment

Uh oh!

cursor bot Apr 3, 2026

Choose a reason for hiding this comment

Informational event misclassified as an error code

Uh oh!

cursor bot Apr 3, 2026

Choose a reason for hiding this comment

Test asserts no-throw instead of verifying decoupling

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

alexs-mparticle commented Mar 20, 2026 •

edited

Loading

cursor bot commented Mar 20, 2026 •

edited

Loading