Skip to content

Commit f17a111

Browse files
jaissica12jaissica12
committed
chore: update deprecated content in generateDeprecationMessage
1 parent b62107d commit f17a111

7 files changed

Lines changed: 68 additions & 25 deletions

File tree

‎src/constants.ts‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,9 @@ const Constants = {
66
platform: 'web',
77
Messages: {
88
DeprecationMessages: {
9-
MethodIsDeprecatedPostfix:
10-
'is a deprecated method and will be removed in future releases',
9+
MethodHasBeenDeprecated: 'has been deprecated.',
10+
MethodMarkedForDeprecationPostfix:
11+
'is a deprecated method and will be removed in future releases.',
1112
AlternativeMethodPrefix: 'Please use the alternate method:',
1213
},
1314
ErrorMessages: {

‎src/identity.js‎

Lines changed: 24 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1299,7 +1299,12 @@ export default function Identity(mpInstance) {
12991299
// eslint-disable-next-line no-unused-vars
13001300
add: function(product, logEvent) {
13011301
mpInstance.Logger.warning(
1302-
'Deprecated function Identity.getCurrentUser().getCart().add()'
1302+
generateDeprecationMessage(
1303+
'Identity.getCurrentUser().getCart().add()',
1304+
true,
1305+
'eCommerce.logProductAction()',
1306+
'https://docs.mparticle.com/developers/sdk/web/commerce-tracking'
1307+
)
13031308
);
13041309
},
13051310
/**
@@ -1312,7 +1317,12 @@ export default function Identity(mpInstance) {
13121317
// eslint-disable-next-line no-unused-vars
13131318
remove: function(product, logEvent) {
13141319
mpInstance.Logger.warning(
1315-
'Deprecated function Identity.getCurrentUser().getCart().remove()'
1320+
generateDeprecationMessage(
1321+
'Identity.getCurrentUser().getCart().remove()',
1322+
true,
1323+
'eCommerce.logProductAction()',
1324+
'https://docs.mparticle.com/developers/sdk/web/commerce-tracking'
1325+
)
13161326
);
13171327
},
13181328
/**
@@ -1322,7 +1332,12 @@ export default function Identity(mpInstance) {
13221332
*/
13231333
clear: function() {
13241334
mpInstance.Logger.warning(
1325-
'Deprecated function Identity.getCurrentUser().getCart().clear()'
1335+
generateDeprecationMessage(
1336+
'Identity.getCurrentUser().getCart().clear()',
1337+
true,
1338+
'',
1339+
'https://docs.mparticle.com/developers/sdk/web/commerce-tracking'
1340+
)
13261341
);
13271342
},
13281343
/**
@@ -1333,7 +1348,12 @@ export default function Identity(mpInstance) {
13331348
*/
13341349
getCartProducts: function() {
13351350
mpInstance.Logger.warning(
1336-
'Deprecated function Identity.getCurrentUser().getCart().getCartProducts()'
1351+
generateDeprecationMessage(
1352+
'Identity.getCurrentUser().getCart().getCartProducts()',
1353+
true,
1354+
'eCommerce.logProductAction()',
1355+
'https://docs.mparticle.com/developers/sdk/web/commerce-tracking'
1356+
)
13371357
);
13381358
return [];
13391359
},

‎src/mp-instance.ts‎

Lines changed: 19 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ import Consent, { IConsent } from './consent';
3636
import KitBlocker from './kitBlocking';
3737
import ConfigAPIClient, { IKitConfigs } from './configAPIClient';
3838
import IdentityAPIClient from './identityApiClient';
39-
import { isFunction, parseConfig, valueof } from './utils';
39+
import { isFunction, parseConfig, valueof, generateDeprecationMessage } from './utils';
4040
import { DisabledVault, LocalStorageVault } from './vault';
4141
import { removeExpiredIdentityCacheDates } from './identity-utils';
4242
import IntegrationCapture from './integrationCapture';
@@ -706,7 +706,12 @@ export default function mParticleInstance(this: IMParticleWebSDKInstance, instan
706706
*/
707707
add: function(product, logEventBoolean) {
708708
self.Logger.warning(
709-
'Deprecated function eCommerce.Cart.add()'
709+
generateDeprecationMessage(
710+
'eCommerce.Cart.add()',
711+
true,
712+
'eCommerce.logProductAction()',
713+
'https://docs.mparticle.com/developers/sdk/web/commerce-tracking'
714+
)
710715
);
711716
},
712717
/**
@@ -718,7 +723,12 @@ export default function mParticleInstance(this: IMParticleWebSDKInstance, instan
718723
*/
719724
remove: function(product, logEventBoolean) {
720725
self.Logger.warning(
721-
'Deprecated function eCommerce.Cart.remove()'
726+
generateDeprecationMessage(
727+
'eCommerce.Cart.remove()',
728+
true,
729+
'eCommerce.logProductAction()',
730+
'https://docs.mparticle.com/developers/sdk/web/commerce-tracking'
731+
)
722732
);
723733
},
724734
/**
@@ -728,7 +738,12 @@ export default function mParticleInstance(this: IMParticleWebSDKInstance, instan
728738
*/
729739
clear: function() {
730740
self.Logger.warning(
731-
'Deprecated function eCommerce.Cart.clear()'
741+
generateDeprecationMessage(
742+
'eCommerce.Cart.clear()',
743+
true,
744+
'',
745+
'https://docs.mparticle.com/developers/sdk/web/commerce-tracking'
746+
)
732747
);
733748
},
734749
},

‎src/sessionManager.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ export default function SessionManager(
7272
mpInstance.Logger.warning(
7373
generateDeprecationMessage(
7474
'SessionManager.getSession()',
75-
75+
false,
7676
'SessionManager.getSessionId()'
7777
)
7878
);

‎src/utils.ts‎

Lines changed: 16 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -57,18 +57,25 @@ const findKeyInObject = (obj: any, key: string): string => {
5757

5858
const generateDeprecationMessage = (
5959
methodName: string,
60-
alternateMethod: string
60+
isDeprecated?: boolean,
61+
alternateMethod?: string,
62+
docsUrl?: string,
6163
): string => {
62-
const messageArray: string[] = [
63-
methodName,
64-
Messages.DeprecationMessages.MethodIsDeprecatedPostfix,
65-
];
64+
const messageArray: string[] = [methodName];
65+
66+
if (isDeprecated) {
67+
messageArray.push(Messages.DeprecationMessages.MethodHasBeenDeprecated);
68+
} else {
69+
messageArray.push(Messages.DeprecationMessages.MethodMarkedForDeprecationPostfix);
70+
}
6671

6772
if (alternateMethod) {
68-
messageArray.push(alternateMethod);
69-
messageArray.push(
70-
Messages.DeprecationMessages.MethodIsDeprecatedPostfix
71-
);
73+
messageArray.push(Messages.DeprecationMessages.AlternativeMethodPrefix);
74+
messageArray.push(alternateMethod + ".");
75+
}
76+
77+
if (docsUrl) {
78+
messageArray.push("See - " + docsUrl);
7279
}
7380

7481
return messageArray.join(' ');

‎test/src/tests-identity.ts‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4566,7 +4566,7 @@ describe('identity', function() {
45664566
// deprecates on both .getCart, then .add
45674567
bond.callCount.should.equal(4);
45684568
bond.getCalls()[1].args[0].should.eql(
4569-
'Deprecated function Identity.getCurrentUser().getCart().add()'
4569+
'Identity.getCurrentUser().getCart().add() has been deprecated. Please use the alternate method: eCommerce.logProductAction(). See - https://docs.mparticle.com/developers/sdk/web/commerce-tracking'
45704570
);
45714571
});
45724572

@@ -4595,7 +4595,7 @@ describe('identity', function() {
45954595
// deprecates on both .getCart, then .add
45964596
bond.callCount.should.equal(4);
45974597
bond.getCalls()[1].args[0].should.eql(
4598-
'Deprecated function Identity.getCurrentUser().getCart().remove()'
4598+
'Identity.getCurrentUser().getCart().remove() has been deprecated. Please use the alternate method: eCommerce.logProductAction(). See - https://docs.mparticle.com/developers/sdk/web/commerce-tracking'
45994599
);
46004600
});
46014601

@@ -4617,7 +4617,7 @@ describe('identity', function() {
46174617
// deprecates on both .getCart, then .add
46184618
bond.callCount.should.equal(4);
46194619
bond.getCalls()[1].args[0].should.eql(
4620-
'Deprecated function Identity.getCurrentUser().getCart().clear()'
4620+
'Identity.getCurrentUser().getCart().clear() has been deprecated. See - https://docs.mparticle.com/developers/sdk/web/commerce-tracking'
46214621
);
46224622
});
46234623

@@ -4640,7 +4640,7 @@ describe('identity', function() {
46404640
// deprecates on both .getCart, then .add
46414641
bond.callCount.should.equal(4);
46424642
bond.getCalls()[1].args[0].should.eql(
4643-
'Deprecated function Identity.getCurrentUser().getCart().getCartProducts()'
4643+
'Identity.getCurrentUser().getCart().getCartProducts() has been deprecated. Please use the alternate method: eCommerce.logProductAction(). See - https://docs.mparticle.com/developers/sdk/web/commerce-tracking'
46444644
);
46454645
});
46464646
});

‎test/src/tests-session-manager.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -144,7 +144,7 @@ describe('SessionManager', () => {
144144
mpInstance._SessionManager.getSession();
145145

146146
expect(consoleSpy.lastCall.firstArg).to.equal(
147-
'SessionManager.getSession() is a deprecated method and will be removed in future releases SessionManager.getSessionId() is a deprecated method and will be removed in future releases'
147+
'SessionManager.getSession() is a deprecated method and will be removed in future releases. Please use the alternate method: SessionManager.getSessionId().'
148148
);
149149

150150
consoleSpy.restore();

0 commit comments

Comments
 (0)