Skip to content

Commit b53796c

Browse files
rmi22186rmi22186
committed
chore: avoid passing mpInstance to deprecated logger
1 parent 4495494 commit b53796c

6 files changed

Lines changed: 172 additions & 112 deletions

File tree

‎src/consent.ts‎

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -506,10 +506,14 @@ export default function Consent(this: IConsent, mpInstance: IMParticleWebSDKInst
506506

507507
// TODO: Can we remove this? It is deprecated.
508508
function removeCCPAState(this: ConsentState) {
509-
logDeprecatedMethodUsage(mpInstance, {
510-
methodName: 'Consent.removeCCPAState',
511-
warningMessage: 'removeCCPAState is deprecated and will be removed in a future release; use removeCCPAConsentState instead',
512-
});
509+
logDeprecatedMethodUsage(
510+
mpInstance.Logger,
511+
mpInstance._LoggingDispatcher,
512+
{
513+
methodName: 'Consent.removeCCPAState',
514+
warningMessage: 'removeCCPAState is deprecated and will be removed in a future release; use removeCCPAConsentState instead',
515+
}
516+
);
513517
// @ts-ignore
514518
return removeCCPAConsentState();
515519
}

‎src/identity.js‎

Lines changed: 80 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -1253,11 +1253,15 @@ export default function Identity(mpInstance) {
12531253
* @return a cart object
12541254
*/
12551255
getCart: function() {
1256-
logDeprecatedMethodUsage(mpInstance, {
1257-
methodName: 'Identity.getCurrentUser().getCart()',
1258-
warningMessage:
1259-
'Deprecated function Identity.getCurrentUser().getCart() will be removed in future releases',
1260-
});
1256+
logDeprecatedMethodUsage(
1257+
mpInstance.Logger,
1258+
mpInstance._LoggingDispatcher,
1259+
{
1260+
methodName: 'Identity.getCurrentUser().getCart()',
1261+
warningMessage:
1262+
'Deprecated function Identity.getCurrentUser().getCart() will be removed in future releases',
1263+
}
1264+
);
12611265
return self.mParticleUserCart();
12621266
},
12631267

@@ -1337,47 +1341,61 @@ export default function Identity(mpInstance) {
13371341
* @deprecated
13381342
*/
13391343
add: function() {
1340-
logDeprecatedMethodUsage(mpInstance, {
1341-
methodName: 'Identity.getCurrentUser().getCart().add()',
1342-
warningMessage: generateDeprecationMessage(
1343-
'Identity.getCurrentUser().getCart().add()',
1344-
true,
1345-
'eCommerce.logProductAction()',
1346-
'https://docs.mparticle.com/developers/sdk/web/commerce-tracking'
1347-
),
1348-
});
1344+
logDeprecatedMethodUsage(
1345+
mpInstance.Logger,
1346+
mpInstance._LoggingDispatcher,
1347+
{
1348+
methodName: 'Identity.getCurrentUser().getCart().add()',
1349+
warningMessage: generateDeprecationMessage(
1350+
'Identity.getCurrentUser().getCart().add()',
1351+
true,
1352+
'eCommerce.logProductAction()',
1353+
'https://docs.mparticle.com/developers/sdk/web/commerce-tracking'
1354+
),
1355+
}
1356+
);
13491357
},
13501358
/**
13511359
* Removes a cart product from the current user cart
13521360
* @method remove
13531361
* @deprecated
13541362
*/
13551363
remove: function() {
1356-
logDeprecatedMethodUsage(mpInstance, {
1357-
methodName: 'Identity.getCurrentUser().getCart().remove()',
1358-
warningMessage: generateDeprecationMessage(
1359-
'Identity.getCurrentUser().getCart().remove()',
1360-
true,
1361-
'eCommerce.logProductAction()',
1362-
'https://docs.mparticle.com/developers/sdk/web/commerce-tracking'
1363-
),
1364-
});
1364+
logDeprecatedMethodUsage(
1365+
mpInstance.Logger,
1366+
mpInstance._LoggingDispatcher,
1367+
{
1368+
methodName:
1369+
'Identity.getCurrentUser().getCart().remove()',
1370+
warningMessage: generateDeprecationMessage(
1371+
'Identity.getCurrentUser().getCart().remove()',
1372+
true,
1373+
'eCommerce.logProductAction()',
1374+
'https://docs.mparticle.com/developers/sdk/web/commerce-tracking'
1375+
),
1376+
}
1377+
);
13651378
},
13661379
/**
13671380
* Clears the user's cart
13681381
* @method clear
13691382
* @deprecated
13701383
*/
13711384
clear: function() {
1372-
logDeprecatedMethodUsage(mpInstance, {
1373-
methodName: 'Identity.getCurrentUser().getCart().clear()',
1374-
warningMessage: generateDeprecationMessage(
1375-
'Identity.getCurrentUser().getCart().clear()',
1376-
true,
1377-
'',
1378-
'https://docs.mparticle.com/developers/sdk/web/commerce-tracking'
1379-
),
1380-
});
1385+
logDeprecatedMethodUsage(
1386+
mpInstance.Logger,
1387+
mpInstance._LoggingDispatcher,
1388+
{
1389+
methodName:
1390+
'Identity.getCurrentUser().getCart().clear()',
1391+
warningMessage: generateDeprecationMessage(
1392+
'Identity.getCurrentUser().getCart().clear()',
1393+
true,
1394+
'',
1395+
'https://docs.mparticle.com/developers/sdk/web/commerce-tracking'
1396+
),
1397+
}
1398+
);
13811399
},
13821400
/**
13831401
* Returns all cart products
@@ -1386,16 +1404,20 @@ export default function Identity(mpInstance) {
13861404
* @deprecated
13871405
*/
13881406
getCartProducts: function() {
1389-
logDeprecatedMethodUsage(mpInstance, {
1390-
methodName:
1391-
'Identity.getCurrentUser().getCart().getCartProducts()',
1392-
warningMessage: generateDeprecationMessage(
1393-
'Identity.getCurrentUser().getCart().getCartProducts()',
1394-
true,
1395-
'eCommerce.logProductAction()',
1396-
'https://docs.mparticle.com/developers/sdk/web/commerce-tracking'
1397-
),
1398-
});
1407+
logDeprecatedMethodUsage(
1408+
mpInstance.Logger,
1409+
mpInstance._LoggingDispatcher,
1410+
{
1411+
methodName:
1412+
'Identity.getCurrentUser().getCart().getCartProducts()',
1413+
warningMessage: generateDeprecationMessage(
1414+
'Identity.getCurrentUser().getCart().getCartProducts()',
1415+
true,
1416+
'eCommerce.logProductAction()',
1417+
'https://docs.mparticle.com/developers/sdk/web/commerce-tracking'
1418+
),
1419+
}
1420+
);
13991421
return [];
14001422
},
14011423
};
@@ -1544,7 +1566,13 @@ export default function Identity(mpInstance) {
15441566
newUser = mpInstance.Identity.getCurrentUser();
15451567

15461568
// https://go.mparticle.com/work/SQDSDKS-6359
1547-
tryOnUserAlias(prevUser, newUser, identityApiData, mpInstance);
1569+
tryOnUserAlias(
1570+
prevUser,
1571+
newUser,
1572+
identityApiData,
1573+
mpInstance.Logger,
1574+
mpInstance._LoggingDispatcher
1575+
);
15481576

15491577
const persistence = mpInstance._Persistence.getPersistence();
15501578

@@ -1778,20 +1806,26 @@ export default function Identity(mpInstance) {
17781806
}
17791807

17801808
// https://go.mparticle.com/work/SQDSDKS-6359
1781-
function tryOnUserAlias(previousUser, newUser, identityApiData, mpInstance) {
1809+
function tryOnUserAlias(
1810+
previousUser,
1811+
newUser,
1812+
identityApiData,
1813+
logger,
1814+
loggingDispatcher
1815+
) {
17821816
if (
17831817
identityApiData &&
17841818
identityApiData.onUserAlias &&
17851819
isFunction(identityApiData.onUserAlias)
17861820
) {
17871821
try {
1788-
logDeprecatedMethodUsage(mpInstance, {
1822+
logDeprecatedMethodUsage(logger, loggingDispatcher, {
17891823
methodName: 'onUserAlias',
17901824
warningMessage: generateDeprecationMessage('onUserAlias'),
17911825
});
17921826
identityApiData.onUserAlias(previousUser, newUser);
17931827
} catch (e) {
1794-
mpInstance.Logger.error(
1828+
logger.error(
17951829
'There was an error with your onUserAlias function - ' + e
17961830
);
17971831
}

‎src/mp-instance.ts‎

Lines changed: 63 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -773,15 +773,19 @@ export default function mParticleInstance(this: IMParticleWebSDKInstance, instan
773773
* @deprecated
774774
*/
775775
add: function(product, logEventBoolean) {
776-
logDeprecatedMethodUsage(self, {
777-
methodName: 'mPInstance.eCommerce.Cart.add()',
778-
warningMessage: generateDeprecationMessage(
779-
'eCommerce.Cart.add()',
780-
true,
781-
'eCommerce.logProductAction()',
782-
'https://docs.mparticle.com/developers/sdk/web/commerce-tracking'
783-
),
784-
});
776+
logDeprecatedMethodUsage(
777+
self.Logger,
778+
self._LoggingDispatcher,
779+
{
780+
methodName: 'mPInstance.eCommerce.Cart.add()',
781+
warningMessage: generateDeprecationMessage(
782+
'eCommerce.Cart.add()',
783+
true,
784+
'eCommerce.logProductAction()',
785+
'https://docs.mparticle.com/developers/sdk/web/commerce-tracking'
786+
),
787+
}
788+
);
785789
},
786790
/**
787791
* Removes a product from the cart
@@ -791,31 +795,39 @@ export default function mParticleInstance(this: IMParticleWebSDKInstance, instan
791795
* @deprecated
792796
*/
793797
remove: function(product, logEventBoolean) {
794-
logDeprecatedMethodUsage(self, {
795-
methodName: 'mPInstance.eCommerce.Cart.remove()',
796-
warningMessage: generateDeprecationMessage(
797-
'eCommerce.Cart.remove()',
798-
true,
799-
'eCommerce.logProductAction()',
800-
'https://docs.mparticle.com/developers/sdk/web/commerce-tracking'
801-
),
802-
});
798+
logDeprecatedMethodUsage(
799+
self.Logger,
800+
self._LoggingDispatcher,
801+
{
802+
methodName: 'mPInstance.eCommerce.Cart.remove()',
803+
warningMessage: generateDeprecationMessage(
804+
'eCommerce.Cart.remove()',
805+
true,
806+
'eCommerce.logProductAction()',
807+
'https://docs.mparticle.com/developers/sdk/web/commerce-tracking'
808+
),
809+
}
810+
);
803811
},
804812
/**
805813
* Clears the cart
806814
* @method clear
807815
* @deprecated
808816
*/
809817
clear: function() {
810-
logDeprecatedMethodUsage(self, {
811-
methodName: 'mPInstance.eCommerce.Cart.clear()',
812-
warningMessage: generateDeprecationMessage(
813-
'eCommerce.Cart.clear()',
814-
true,
815-
'',
816-
'https://docs.mparticle.com/developers/sdk/web/commerce-tracking'
817-
),
818-
});
818+
logDeprecatedMethodUsage(
819+
self.Logger,
820+
self._LoggingDispatcher,
821+
{
822+
methodName: 'mPInstance.eCommerce.Cart.clear()',
823+
warningMessage: generateDeprecationMessage(
824+
'eCommerce.Cart.clear()',
825+
true,
826+
'',
827+
'https://docs.mparticle.com/developers/sdk/web/commerce-tracking'
828+
),
829+
}
830+
);
819831
},
820832
},
821833
/**
@@ -944,10 +956,14 @@ export default function mParticleInstance(this: IMParticleWebSDKInstance, instan
944956
* @deprecated
945957
*/
946958
logCheckout: function(step, option, attrs, customFlags) {
947-
logDeprecatedMethodUsage(self, {
948-
methodName: 'mParticle.logCheckout',
949-
warningMessage: 'mParticle.logCheckout is deprecated, please use mParticle.logProductAction instead',
950-
});
959+
logDeprecatedMethodUsage(
960+
self.Logger,
961+
self._LoggingDispatcher,
962+
{
963+
methodName: 'mParticle.logCheckout',
964+
warningMessage: 'mParticle.logCheckout is deprecated, please use mParticle.logProductAction instead',
965+
}
966+
);
951967

952968
if (!self._Store.isInitialized) {
953969
self.ready(function() {
@@ -1025,10 +1041,14 @@ export default function mParticleInstance(this: IMParticleWebSDKInstance, instan
10251041
attrs,
10261042
customFlags
10271043
) {
1028-
logDeprecatedMethodUsage(self, {
1029-
methodName: 'mParticle.logPurchase',
1030-
warningMessage: 'mParticle.logPurchase is deprecated, please use mParticle.logProductAction instead',
1031-
});
1044+
logDeprecatedMethodUsage(
1045+
self.Logger,
1046+
self._LoggingDispatcher,
1047+
{
1048+
methodName: 'mParticle.logPurchase',
1049+
warningMessage: 'mParticle.logPurchase is deprecated, please use mParticle.logProductAction instead',
1050+
}
1051+
);
10321052
if (!self._Store.isInitialized) {
10331053
self.ready(function() {
10341054
self.eCommerce.logPurchase(
@@ -1138,10 +1158,14 @@ export default function mParticleInstance(this: IMParticleWebSDKInstance, instan
11381158
attrs,
11391159
customFlags
11401160
) {
1141-
logDeprecatedMethodUsage(self, {
1142-
methodName: 'mParticle.logRefund',
1143-
warningMessage: 'mParticle.logRefund is deprecated, please use mParticle.logProductAction instead',
1144-
});
1161+
logDeprecatedMethodUsage(
1162+
self.Logger,
1163+
self._LoggingDispatcher,
1164+
{
1165+
methodName: 'mParticle.logRefund',
1166+
warningMessage: 'mParticle.logRefund is deprecated, please use mParticle.logProductAction instead',
1167+
}
1168+
);
11451169
if (!self._Store.isInitialized) {
11461170
self.ready(function() {
11471171
self.eCommerce.logRefund(

‎src/reporting/deprecatedMethodLogger.ts‎

Lines changed: 5 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,18 @@
11
import { ErrorCodes, ILoggingService } from './types';
2-
3-
interface DeprecatedMethodLoggerInstance {
4-
Logger?: {
5-
warning(message: string): void;
6-
};
7-
_LoggingDispatcher?: ILoggingService;
8-
}
2+
import { SDKLoggerApi } from '../sdkRuntimeModels';
93

104
interface DeprecatedMethodUsage {
115
methodName: string;
126
warningMessage: string;
137
}
148

159
export function logDeprecatedMethodUsage(
16-
mpInstance: DeprecatedMethodLoggerInstance,
10+
logger: Pick<SDKLoggerApi, 'warning'> | undefined,
11+
loggingDispatcher: ILoggingService | undefined,
1712
usage: DeprecatedMethodUsage
1813
): void {
19-
mpInstance.Logger?.warning(usage.warningMessage);
20-
mpInstance._LoggingDispatcher?.log({
14+
logger?.warning(usage.warningMessage);
15+
loggingDispatcher?.log({
2116
message: usage.methodName,
2217
code: ErrorCodes.MP_DEPRECATED_METHOD_USAGE,
2318
});

0 commit comments

Comments
 (0)