chore: address deprecated method logging review comments

Author: rmi22186

src/consent.ts

@@ -9,7 +9,7 @@ import KitFilterHelper from './kitFilterHelper';
 import Constants from './constants';
 import { IMParticleUser } from './identity-user-interfaces';
 import { IMParticleWebSDKInstance } from './mp-instance';
-import { logDeprecatedApiUsage } from './reporting/deprecatedApiLogger';
+import { logDeprecatedMethodUsage } from './reporting/deprecatedMethodLogger';
 
 const { CCPAPurpose } = Constants;
 
@@ -506,8 +506,8 @@ export default function Consent(this: IConsent, mpInstance: IMParticleWebSDKInst
 
         // TODO: Can we remove this? It is deprecated.
         function removeCCPAState(this: ConsentState) {
-            logDeprecatedApiUsage(mpInstance, {
-                methodName: 'removeCCPAState',
+            logDeprecatedMethodUsage(mpInstance, {
+                methodName: 'Consent.removeCCPAState',
                 warningMessage: 'removeCCPAState is deprecated and will be removed in a future release; use removeCCPAConsentState instead',
             });
             // @ts-ignore

src/identity.js

@@ -20,7 +20,7 @@ import {
 } from './utils';
 import { hasMPIDAndUserLoginChanged, hasMPIDChanged } from './user-utils';
 import { processReadyQueue } from './pre-init-utils';
-import { logDeprecatedApiUsage } from './reporting/deprecatedApiLogger';
+import { logDeprecatedMethodUsage } from './reporting/deprecatedMethodLogger';
 
 export default function Identity(mpInstance) {
     const { getFeatureFlag, extend } = mpInstance._Helpers;
@@ -1253,7 +1253,7 @@ export default function Identity(mpInstance) {
              * @return a cart object
              */
             getCart: function() {
-                logDeprecatedApiUsage(mpInstance, {
+                logDeprecatedMethodUsage(mpInstance, {
                     methodName: 'Identity.getCurrentUser().getCart()',
                     warningMessage:
                         'Deprecated function Identity.getCurrentUser().getCart() will be removed in future releases',
@@ -1337,7 +1337,7 @@ export default function Identity(mpInstance) {
              * @deprecated
              */
             add: function() {
-                logDeprecatedApiUsage(mpInstance, {
+                logDeprecatedMethodUsage(mpInstance, {
                     methodName: 'Identity.getCurrentUser().getCart().add()',
                     warningMessage: generateDeprecationMessage(
                         'Identity.getCurrentUser().getCart().add()',
@@ -1353,7 +1353,7 @@ export default function Identity(mpInstance) {
              * @deprecated
              */
             remove: function() {
-                logDeprecatedApiUsage(mpInstance, {
+                logDeprecatedMethodUsage(mpInstance, {
                     methodName: 'Identity.getCurrentUser().getCart().remove()',
                     warningMessage: generateDeprecationMessage(
                         'Identity.getCurrentUser().getCart().remove()',
@@ -1369,7 +1369,7 @@ export default function Identity(mpInstance) {
              * @deprecated
              */
             clear: function() {
-                logDeprecatedApiUsage(mpInstance, {
+                logDeprecatedMethodUsage(mpInstance, {
                     methodName: 'Identity.getCurrentUser().getCart().clear()',
                     warningMessage: generateDeprecationMessage(
                         'Identity.getCurrentUser().getCart().clear()',
@@ -1386,7 +1386,7 @@ export default function Identity(mpInstance) {
              * @deprecated
              */
             getCartProducts: function() {
-                logDeprecatedApiUsage(mpInstance, {
+                logDeprecatedMethodUsage(mpInstance, {
                     methodName:
                         'Identity.getCurrentUser().getCart().getCartProducts()',
                     warningMessage: generateDeprecationMessage(
@@ -1785,7 +1785,7 @@ function tryOnUserAlias(previousUser, newUser, identityApiData, mpInstance) {
         isFunction(identityApiData.onUserAlias)
     ) {
         try {
-            logDeprecatedApiUsage(mpInstance, {
+            logDeprecatedMethodUsage(mpInstance, {
                 methodName: 'onUserAlias',
                 warningMessage: generateDeprecationMessage('onUserAlias'),
             });

src/mp-instance.ts

@@ -55,7 +55,7 @@ import CookieConsentManager, { ICookieConsentManager } from './cookieConsentMana
 import { ErrorReportingDispatcher } from './reporting/errorReportingDispatcher';
 import { LoggingDispatcher } from './reporting/loggingDispatcher';
 import { IErrorReportingService, ILoggingService } from './reporting/types';
-import { logDeprecatedApiUsage } from './reporting/deprecatedApiLogger';
+import { logDeprecatedMethodUsage } from './reporting/deprecatedMethodLogger';
 
 export interface IErrorLogMessage {
     message?: string;
@@ -773,8 +773,8 @@ export default function mParticleInstance(this: IMParticleWebSDKInstance, instan
              * @deprecated
              */
             add: function(product, logEventBoolean) {
-                logDeprecatedApiUsage(self, {
-                    methodName: 'eCommerce.Cart.add()',
+                logDeprecatedMethodUsage(self, {
+                    methodName: 'mPInstance.eCommerce.Cart.add()',
                     warningMessage: generateDeprecationMessage(
                         'eCommerce.Cart.add()',
                         true,
@@ -791,8 +791,8 @@ export default function mParticleInstance(this: IMParticleWebSDKInstance, instan
              * @deprecated
              */
             remove: function(product, logEventBoolean) {
-                logDeprecatedApiUsage(self, {
-                    methodName: 'eCommerce.Cart.remove()',
+                logDeprecatedMethodUsage(self, {
+                    methodName: 'mPInstance.eCommerce.Cart.remove()',
                     warningMessage: generateDeprecationMessage(
                         'eCommerce.Cart.remove()',
                         true,
@@ -807,8 +807,8 @@ export default function mParticleInstance(this: IMParticleWebSDKInstance, instan
              * @deprecated
              */
             clear: function() {
-                logDeprecatedApiUsage(self, {
-                    methodName: 'eCommerce.Cart.clear()',
+                logDeprecatedMethodUsage(self, {
+                    methodName: 'mPInstance.eCommerce.Cart.clear()',
                     warningMessage: generateDeprecationMessage(
                         'eCommerce.Cart.clear()',
                         true,
@@ -944,7 +944,7 @@ export default function mParticleInstance(this: IMParticleWebSDKInstance, instan
          * @deprecated
          */
         logCheckout: function(step, option, attrs, customFlags) {
-            logDeprecatedApiUsage(self, {
+            logDeprecatedMethodUsage(self, {
                 methodName: 'mParticle.logCheckout',
                 warningMessage: 'mParticle.logCheckout is deprecated, please use mParticle.logProductAction instead',
             });
@@ -1025,7 +1025,7 @@ export default function mParticleInstance(this: IMParticleWebSDKInstance, instan
             attrs,
             customFlags
         ) {
-            logDeprecatedApiUsage(self, {
+            logDeprecatedMethodUsage(self, {
                 methodName: 'mParticle.logPurchase',
                 warningMessage: 'mParticle.logPurchase is deprecated, please use mParticle.logProductAction instead',
             });
@@ -1138,7 +1138,7 @@ export default function mParticleInstance(this: IMParticleWebSDKInstance, instan
             attrs,
             customFlags
         ) {
-            logDeprecatedApiUsage(self, {
+            logDeprecatedMethodUsage(self, {
                 methodName: 'mParticle.logRefund',
                 warningMessage: 'mParticle.logRefund is deprecated, please use mParticle.logProductAction instead',
             });

src/reporting/deprecatedApiLogger.ts src/reporting/deprecatedMethodLogger.tssrc/reporting/deprecatedApiLogger.ts renamed to src/reporting/deprecatedMethodLogger.ts

@@ -1,20 +1,20 @@
 import { ErrorCodes, ILoggingService } from './types';
 
-interface DeprecatedApiLoggerInstance {
+interface DeprecatedMethodLoggerInstance {
     Logger?: {
         warning(message: string): void;
     };
     _LoggingDispatcher?: ILoggingService;
 }
 
-interface DeprecatedApiUsage {
+interface DeprecatedMethodUsage {
     methodName: string;
     warningMessage: string;
 }
 
-export function logDeprecatedApiUsage(
-    mpInstance: DeprecatedApiLoggerInstance,
-    usage: DeprecatedApiUsage
+export function logDeprecatedMethodUsage(
+    mpInstance: DeprecatedMethodLoggerInstance,
+    usage: DeprecatedMethodUsage
 ): void {
     mpInstance.Logger?.warning(usage.warningMessage);
     mpInstance._LoggingDispatcher?.log({

src/sessionManager.ts

@@ -6,7 +6,7 @@ import { generateDeprecationMessage } from './utils';
 import { IMParticleUser } from './identity-user-interfaces';
 import { IMParticleWebSDKInstance } from './mp-instance';
 import { hasIdentityRequestChanged, hasExplicitIdentifier } from './identity-utils';
-import { logDeprecatedApiUsage } from './reporting/deprecatedApiLogger';
+import { logDeprecatedMethodUsage } from './reporting/deprecatedMethodLogger';
 
 const { Messages } = Constants;
 
@@ -68,7 +68,7 @@ export default function SessionManager(
     };
 
     this.getSession = function (): string {
-        logDeprecatedApiUsage(mpInstance, {
+        logDeprecatedMethodUsage(mpInstance, {
             methodName: 'SessionManager.getSession()',
             warningMessage: generateDeprecationMessage(
                 'SessionManager.getSession()',

test/jest/reportingLogger.spec.ts

@@ -1,7 +1,7 @@
 import { ErrorReportingDispatcher } from '../../src/reporting/errorReportingDispatcher';
 import { LoggingDispatcher } from '../../src/reporting/loggingDispatcher';
 import { IErrorReportingService, ILoggingService, ISDKError, ISDKLogEntry, WSDKErrorSeverity, ErrorCodes } from '../../src/reporting/types';
-import { logDeprecatedApiUsage } from '../../src/reporting/deprecatedApiLogger';
+import { logDeprecatedMethodUsage } from '../../src/reporting/deprecatedMethodLogger';
 
 describe('ErrorReportingDispatcher', () => {
     let dispatcher: ErrorReportingDispatcher;
@@ -130,12 +130,12 @@ describe('LoggingDispatcher', () => {
     });
 });
 
-describe('logDeprecatedApiUsage', () => {
+describe('logDeprecatedMethodUsage', () => {
     it('keeps the console warning and emits structured usage details', () => {
         const warning = jest.fn();
         const log = jest.fn();
 
-        logDeprecatedApiUsage(
+        logDeprecatedMethodUsage(
             {
                 Logger: { warning },
                 _LoggingDispatcher: { log },
@@ -158,7 +158,7 @@ describe('logDeprecatedApiUsage', () => {
     it('does not require a registered logging dispatcher', () => {
         const warning = jest.fn();
 
-        expect(() => logDeprecatedApiUsage(
+        expect(() => logDeprecatedMethodUsage(
             { Logger: { warning } },
             {
                 methodName: 'onUserAlias',