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
Refactors error/log reporting by removing the built-in remote ReportingLogger and introducing dispatcher-based integrations, which can change what gets reported and when. Also adds new public registration APIs and adjusts identity/Rokt flows to emit structured reports, so integration regressions are possible.

Overview
Introduces a new pluggable reporting layer: adds IErrorReportingService/ILoggingService contracts plus ErrorReportingDispatcher and LoggingDispatcher to fan out structured errors/log entries to registered services.

Decouples Logger to be console-only (removes ReportingLogger and its tests), removes Rokt-specific loggingUrl/errorUrl config and default/CNAME constants, and updates identity and Rokt paths to explicitly call the error dispatcher for identity request failures and identity mismatch warnings.

Exposes _registerErrorReportingService and _registerLoggingService on mParticle/instance manager, wires dispatchers into mp-instance init/reset flows, and updates tests accordingly.

^{Reviewed by Cursor Bugbot for commit 76b2f3e. Bugbot is set up for automated code reviews on this repo. 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

src/roktManager.ts

test/jest/logging-integration.spec.ts

test/jest/reportingLogger.spec.ts

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.

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.}

src/reporting/types.ts

test/jest/logging-integration.spec.ts

- Remove redundant "Logger.error() does not trigger any reporting" test that only asserted not.toThrow() (decoupling already proven by next test) - Replace assertion-less no-op tests with proper assertions that create mock services, intentionally skip registration, and verify they are not called

sonarqubecloud · 2026-04-06T17:35:26Z

Quality Gate passed

Issues
0 New issues
0 Accepted issues

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

See analysis details on SonarQube Cloud

# [2.61.0](v2.60.1...v2.61.0) (2026-04-07) ### Bug Fixes * Coerce event name to string ([#1234](#1234)) ([fc40e4b](fc40e4b)) ### Features * add /verify skill for lint, build, and test validation ([#1222](#1222)) ([fc744e8](fc744e8)) * define reporting service contracts and dispatchers ([#1224](#1224)) ([79184e0](79184e0))

mparticle-automation · 2026-04-07T16:58:27Z

🎉 This PR is included in version 2.61.0 🎉

The release is available on:

v2.61.0
GitHub release

Your semantic-release bot 📦🚀

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

Merged

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

src/roktManager.ts Show resolved Hide resolved

rmi22186 reviewed Apr 3, 2026

View reviewed changes

test/jest/logging-integration.spec.ts Outdated Show resolved Hide resolved

rmi22186 reviewed Apr 3, 2026

View reviewed changes

test/jest/reportingLogger.spec.ts Outdated 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

src/reporting/types.ts Show resolved Hide resolved

test/jest/logging-integration.spec.ts Outdated Show resolved Hide resolved

alexs-mparticle requested a review from rmi22186 April 6, 2026 18:03

rmi22186 approved these changes Apr 6, 2026

View reviewed changes

alexs-mparticle merged commit 79184e0 into development Apr 6, 2026
28 of 33 checks passed

alexs-mparticle deleted the feat/reporting-service-migration-core branch April 6, 2026 18:08

mparticle-automation added the released label Apr 7, 2026

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 merged 16 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!

Uh oh!

Uh oh!

Uh oh!

rmi22186 left a comment

Uh oh!

cursor bot left a comment

Uh oh!

Uh oh!

Uh oh!

sonarqubecloud bot commented Apr 6, 2026

Uh oh!

Uh oh!

mparticle-automation commented Apr 7, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 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!

Uh oh!

Uh oh!

Uh oh!

rmi22186 left a comment

Choose a reason for hiding this comment

Uh oh!

cursor bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

sonarqubecloud bot commented Apr 6, 2026

Quality Gate passed

Uh oh!

Uh oh!

mparticle-automation commented Apr 7, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

alexs-mparticle commented Mar 20, 2026 •

edited

Loading

cursor bot commented Mar 20, 2026 •

edited

Loading