feat: Report deprecated method usage through logging dispatcher by rmi22186 · Pull Request #1270 · mParticle/mparticle-web-sdk

rmi22186 · 2026-05-21T16:47:28Z

Summary

Add a core helper for deprecated API usage that preserves existing console warnings and emits structured logging dispatcher events.
Report deprecated usage with code MP_DEPRECATED_METHOD_USAGE and message set to the deprecated method name.
Wire existing deprecated method warnings through the helper across core, identity, session, and consent code paths.

Verification

Focused Jest reporting logger spec passed.
npm run lint passed.

Notes

Existing unrelated workspace changes were left unstaged and are not included in this PR.

cursor · 2026-05-21T17:15:15Z

PR Summary

Low Risk
Low risk: behavior is limited to how deprecation warnings are reported, with no changes to core identity/session/consent state logic beyond adding optional structured logging.

Overview
Adds a shared logDeprecatedMethodUsage helper that keeps existing deprecation Logger.warning output while also emitting a structured LoggingDispatcher event with new code MP_DEPRECATED_METHOD_USAGE.

Routes several existing deprecated entry points (Consent removeCCPAState, Identity cart APIs, legacy commerce methods like logCheckout/logPurchase/logRefund, SessionManager getSession, and deprecated onUserAlias) through this helper, and includes Jest coverage to verify dispatcher emission and the no-dispatcher case.

^{Reviewed by Cursor Bugbot for commit b596fbd. Bugbot is set up for automated code reviews on this repo. Configure here.}

alexs-mparticle · 2026-05-21T17:26:37Z

+export function logDeprecatedApiUsage(
+    mpInstance: DeprecatedApiLoggerInstance,
+    usage: DeprecatedApiUsage
+): void {
+    mpInstance.Logger?.warning(usage.warningMessage);
+    mpInstance._LoggingDispatcher?.log({
+        message: usage.methodName,
+        code: ErrorCodes.MP_DEPRECATED_METHOD_USAGE,
+    });
+}


Consistency: We're switching between Deprecated Method vs Deprecated API in this logger, let's stick to one.

Suggested change

export function logDeprecatedApiUsage(

mpInstance: DeprecatedApiLoggerInstance,

usage: DeprecatedApiUsage

): void {

mpInstance.Logger?.warning(usage.warningMessage);

mpInstance._LoggingDispatcher?.log({

message: usage.methodName,

code: ErrorCodes.MP_DEPRECATED_METHOD_USAGE,

});

}

export function logDeprecatedMethodUsage(

mpInstance: DeprecatedMethodLoggerInstance,

usage: DeprecatedMethodUsage

): void {

mpInstance.Logger?.warning(usage.warningMessage);

mpInstance._LoggingDispatcher?.log({

message: usage.methodName,

code: ErrorCodes.MP_DEPRECATED_METHOD_USAGE,

});

}

alexs-mparticle · 2026-05-21T17:27:38Z

+                logDeprecatedApiUsage(self, {
+                    methodName: 'eCommerce.Cart.add()',
+                    warningMessage: generateDeprecationMessage(


Nit: Maybe we reference the module in the log so we know where the entry point was?

Suggested change

logDeprecatedApiUsage(self, {

methodName: 'eCommerce.Cart.add()',

warningMessage: generateDeprecationMessage(

logDeprecatedApiUsage(self, {

methodName: 'mPInstance.eCommerce.Cart.add()',

warningMessage: generateDeprecationMessage(

alexs-mparticle · 2026-05-21T17:29:52Z

-                    identityApiData,
-                    mpInstance.Logger
-                );
+                tryOnUserAlias(prevUser, newUser, identityApiData, mpInstance);


Wy reimport the whole mPInstance?

because logDeprecatedApiUsage takes it as an argument in order to pass both Logger and _LoggingDispatcher. Would you prefer logDeprecatedApiUsage take Logger and _LoggingDispatcher directly?

Yes, I think that would be preferable.

alexs-mparticle · 2026-05-21T17:30:49Z

-                'removeCCPAState is deprecated and will be removed in a future release; use removeCCPAConsentState instead'
-            );
+            logDeprecatedApiUsage(mpInstance, {
+                methodName: 'removeCCPAState',


Suggested change

methodName: 'removeCCPAState',

methodName: 'Consent.removeCCPAState',

cursor

Cursor Bugbot has reviewed your changes and found 1 potential issue.

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

^{Reviewed by Cursor Bugbot for commit 4495494. Configure here.}

cursor · 2026-05-21T18:06:46Z

-                self.Logger.warning(
-                    generateDeprecationMessage(
+                logDeprecatedMethodUsage(self, {
+                    methodName: 'mPInstance.eCommerce.Cart.add()',


Inconsistent methodName prefix across structured log entries

Low Severity

The methodName values in the same file use two different prefixes: mPInstance for Cart methods (e.g. mPInstance.eCommerce.Cart.add()) and mParticle for others (e.g. mParticle.logCheckout). mPInstance isn't a public API name or a variable name used in the codebase — it appears to be an internal shorthand. Since these values are emitted as structured log entries for downstream consumption, the inconsistent prefix makes filtering and aggregating deprecation events unreliable.

Additional Locations (1)

src/mp-instance.ts#L947-L948

^{Reviewed by Cursor Bugbot for commit 4495494. Configure here.}

sonarqubecloud · 2026-05-21T20:20:49Z

Quality Gate passed

Issues
0 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

feat: report deprecated method usage

c44f7e2

rmi22186 force-pushed the feat/deprecated-method-usage-logging branch from 8ffea9d to c44f7e2 Compare May 21, 2026 17:07

rmi22186 changed the title ~~Report deprecated method usage through logging dispatcher~~ feat: Report deprecated method usage through logging dispatcher May 21, 2026

rmi22186 requested a review from alexs-mparticle May 21, 2026 17:14

rmi22186 marked this pull request as ready for review May 21, 2026 17:15

rmi22186 requested a review from a team as a code owner May 21, 2026 17:15

alexs-mparticle requested changes May 21, 2026

View reviewed changes

chore: address deprecated method logging review comments

4495494

cursor Bot reviewed May 21, 2026

View reviewed changes

rmi22186 force-pushed the feat/deprecated-method-usage-logging branch from 4495494 to 29be20b Compare May 21, 2026 19:53

chore: avoid passing mpInstance to deprecated logger

b53796c

rmi22186 force-pushed the feat/deprecated-method-usage-logging branch from 29be20b to b53796c Compare May 21, 2026 19:56

chore: require deprecated method logger

ef2a844

alexs-mparticle reviewed May 21, 2026

View reviewed changes

Comment thread src/reporting/deprecatedMethodLogger.ts

chore: put deprecated usage argument first

b596fbd

alexs-mparticle approved these changes May 21, 2026

View reviewed changes

rmi22186 merged commit 2578b9a into development May 22, 2026
30 of 33 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Report deprecated method usage through logging dispatcher#1270

feat: Report deprecated method usage through logging dispatcher#1270
rmi22186 merged 5 commits into
developmentfrom
feat/deprecated-method-usage-logging

rmi22186 commented May 21, 2026 •

edited

Loading

Uh oh!

cursor Bot commented May 21, 2026 •

edited

Loading

Uh oh!

alexs-mparticle May 21, 2026

Uh oh!

alexs-mparticle May 21, 2026

Uh oh!

alexs-mparticle May 21, 2026

Uh oh!

rmi22186 May 21, 2026

Uh oh!

alexs-mparticle May 21, 2026

Uh oh!

alexs-mparticle May 21, 2026

Uh oh!

cursor Bot left a comment

Uh oh!

cursor Bot May 21, 2026

Uh oh!

Uh oh!

sonarqubecloud Bot commented May 21, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

	methodName: 'removeCCPAState',
	methodName: 'Consent.removeCCPAState',

Conversation

rmi22186 commented May 21, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Verification

Notes

Uh oh!

cursor Bot commented May 21, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

PR Summary

Uh oh!

alexs-mparticle May 21, 2026

Choose a reason for hiding this comment

Uh oh!

alexs-mparticle May 21, 2026

Choose a reason for hiding this comment

Uh oh!

alexs-mparticle May 21, 2026

Choose a reason for hiding this comment

Uh oh!

rmi22186 May 21, 2026

Choose a reason for hiding this comment

Uh oh!

alexs-mparticle May 21, 2026

Choose a reason for hiding this comment

Uh oh!

alexs-mparticle May 21, 2026

Choose a reason for hiding this comment

Uh oh!

cursor Bot left a comment

Choose a reason for hiding this comment

Uh oh!

cursor Bot May 21, 2026

Choose a reason for hiding this comment

Inconsistent methodName prefix across structured log entries

Uh oh!

Uh oh!

sonarqubecloud Bot commented May 21, 2026

Quality Gate passed

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

rmi22186 commented May 21, 2026 •

edited

Loading

cursor Bot commented May 21, 2026 •

edited

Loading

Inconsistent `methodName` prefix across structured log entries