Skip to content

Commit 1f6abe1

Browse files
mprew97mprew97
authored
[MOB-11714]: rename anonymous -> unknown (#520)
* rename anonymous -> unknown * accidentally got deleted * Update authorization.ts
1 parent c811b67 commit 1f6abe1

28 files changed

Lines changed: 353 additions & 349 deletions

‎react-example/src/index.tsx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ const HomeLink = styled(Link)`
4747
configOptions: {
4848
isEuIterableService: false,
4949
dangerouslyAllowJsPopups: true,
50-
enableAnonActivation: true
50+
enableUnknownActivation: true
5151
},
5252
generateJWT: ({ email, userID }) =>
5353
axios

‎react-example/src/indexWithoutJWT.tsx‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -46,9 +46,9 @@ const HomeLink = styled(Link)`
4646
configOptions: {
4747
isEuIterableService: false,
4848
dangerouslyAllowJsPopups: true,
49-
enableAnonActivation: true,
50-
onAnonUserCreated: (userId: string) => {
51-
console.log('onAnonUserCreated', userId);
49+
enableUnknownActivation: true,
50+
onUnknownUserCreated: (userId: string) => {
51+
console.log('onUnknownUserCreated', userId);
5252
}
5353
}
5454
};

‎src/authorization/authorization.ts‎

Lines changed: 81 additions & 82 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,10 @@ import { clearMessages } from 'src/inapp/inapp';
55
import {
66
IS_PRODUCTION,
77
STATIC_HEADERS,
8-
SHARED_PREF_ANON_USER_ID,
8+
SHARED_PREF_UNKNOWN_USER_ID,
99
ENDPOINTS,
1010
RouteConfig,
11-
SHARED_PREF_ANON_USAGE_TRACKED,
11+
SHARED_PREF_UNKNOWN_USAGE_TRACKED,
1212
SHARED_PREFS_CRITERIA
1313
} from 'src/constants';
1414
import {
@@ -20,12 +20,12 @@ import {
2020
validateTokenTime,
2121
isEmail
2222
} from './utils';
23-
import { AnonymousUserMerge } from 'src/anonymousUserTracking/anonymousUserMerge';
23+
import { UnknownUserMerge } from 'src/unknownUserTracking/unknownUserMerge';
2424
import {
25-
AnonymousUserEventManager,
26-
isAnonymousUsageTracked,
27-
registerAnonUserIdSetter
28-
} from 'src/anonymousUserTracking/anonymousUserEventManager';
25+
UnknownUserEventManager,
26+
isUnknownUsageTracked,
27+
registerUnknownUserIdSetter
28+
} from 'src/unknownUserTracking/unknownUserEventManager';
2929
import { IdentityResolution, Options, config } from 'src/utils/config';
3030
import { getTypeOfAuth, setTypeOfAuth, TypeOfAuth } from 'src/utils/typeOfAuth';
3131
import AuthorizationToken from 'src/utils/authorizationToken';
@@ -35,7 +35,7 @@ let authIdentifier: null | string = null;
3535
let userInterceptor: number | null = null;
3636
let apiKey: null | string = null;
3737
let generateJWTGlobal: any = null;
38-
const anonUserManager = new AnonymousUserEventManager();
38+
const unknownUserManager = new UnknownUserEventManager();
3939

4040
export interface GenerateJWTPayload {
4141
email?: string;
@@ -70,10 +70,10 @@ export interface WithoutJWT {
7070
clearVisitorEventsAndUserData: () => void;
7171
}
7272

73-
export const setAnonUserId = async (userId: string) => {
74-
const anonymousUsageTracked = isAnonymousUsageTracked();
73+
export const setUnknownUserId = async (userId: string) => {
74+
const unknownUsageTracked = isUnknownUsageTracked();
7575

76-
if (!anonymousUsageTracked) return;
76+
if (!unknownUsageTracked) return;
7777

7878
let token: null | string = null;
7979
if (generateJWTGlobal) {
@@ -91,27 +91,26 @@ export const setAnonUserId = async (userId: string) => {
9191
return config;
9292
});
9393
addUserIdToRequest(userId);
94-
localStorage.setItem(SHARED_PREF_ANON_USER_ID, userId);
94+
localStorage.setItem(SHARED_PREF_UNKNOWN_USER_ID, userId);
9595
};
9696

97-
registerAnonUserIdSetter(setAnonUserId);
97+
registerUnknownUserIdSetter(setUnknownUserId);
9898

99-
const clearAnonymousUser = () => {
100-
localStorage.removeItem(SHARED_PREF_ANON_USER_ID);
99+
const clearUnknownUser = () => {
100+
localStorage.removeItem(SHARED_PREF_UNKNOWN_USER_ID);
101101
};
102102

103-
const getAnonUserId = () => {
104-
if (config.getConfig('enableAnonActivation')) {
105-
const anonUser = localStorage.getItem(SHARED_PREF_ANON_USER_ID);
106-
return anonUser === undefined ? null : anonUser;
107-
} else {
108-
return null;
103+
const getUnknownUserId = () => {
104+
if (config.getConfig('enableUnknownActivation')) {
105+
const unknownUser = localStorage.getItem(SHARED_PREF_UNKNOWN_USER_ID);
106+
return unknownUser === undefined ? null : unknownUser;
109107
}
108+
return null;
110109
};
111110

112111
const initializeUserId = (userId: string) => {
113112
addUserIdToRequest(userId);
114-
clearAnonymousUser();
113+
clearUnknownUser();
115114
};
116115

117116
const addUserIdToRequest = (userId: string) => {
@@ -211,12 +210,12 @@ const addUserIdToRequest = (userId: string) => {
211210

212211
const initializeEmailUser = (email: string) => {
213212
addEmailToRequest(email);
214-
clearAnonymousUser();
213+
clearUnknownUser();
215214
};
216215

217216
const syncEvents = () => {
218-
if (config.getConfig('enableAnonActivation')) {
219-
anonUserManager.syncEvents();
217+
if (config.getConfig('enableUnknownActivation')) {
218+
unknownUserManager.syncEvents();
220219
}
221220
};
222221

@@ -396,15 +395,15 @@ export function initialize(
396395

397396
const handleTokenExpiration = createTokenExpirationTimer();
398397

399-
const enableAnonymousTracking = () => {
398+
const enableUnknownTracking = () => {
400399
try {
401-
if (config.getConfig('enableAnonActivation')) {
402-
anonUserManager.getAnonCriteria();
403-
anonUserManager.updateAnonSession();
404-
const anonymousUserId = getAnonUserId();
405-
if (anonymousUserId !== null) {
406-
// This block will restore the anon userID from localstorage
407-
setAnonUserId(anonymousUserId);
400+
if (config.getConfig('enableUnknownActivation')) {
401+
unknownUserManager.getUnknownCriteria();
402+
unknownUserManager.updateUnknownSession();
403+
const unknownUserId = getUnknownUserId();
404+
if (unknownUserId !== null) {
405+
// This block will restore the unknown userID from localstorage
406+
setUnknownUserId(unknownUserId);
408407
}
409408
}
410409
} catch (error) {
@@ -418,22 +417,22 @@ export function initialize(
418417
merge?: boolean
419418
): Promise<boolean> => {
420419
const typeOfAuth = getTypeOfAuth();
421-
const enableAnonActivation = config.getConfig('enableAnonActivation');
420+
const enableUnknownActivation = config.getConfig('enableUnknownActivation');
422421
const sourceUserIdOrEmail =
423-
authIdentifier === null ? getAnonUserId() : authIdentifier;
422+
authIdentifier === null ? getUnknownUserId() : authIdentifier;
424423
const sourceUserId = typeOfAuth === 'email' ? null : sourceUserIdOrEmail;
425424
const sourceEmail = typeOfAuth === 'email' ? sourceUserIdOrEmail : null;
426425
const destinationUserId = isEmail ? null : emailOrUserId;
427426
const destinationEmail = isEmail ? emailOrUserId : null;
428-
// This function will try to merge if anon user exists
427+
// This function will try to merge if unknown user exists
429428
if (
430-
(getAnonUserId() !== null || authIdentifier !== null) &&
429+
(getUnknownUserId() !== null || authIdentifier !== null) &&
431430
merge &&
432-
enableAnonActivation
431+
enableUnknownActivation
433432
) {
434-
const anonymousUserMerge = new AnonymousUserMerge();
433+
const unknownUserMerge = new UnknownUserMerge();
435434
try {
436-
await anonymousUserMerge.mergeUser(
435+
await unknownUserMerge.mergeUser(
437436
sourceUserId,
438437
sourceEmail,
439438
destinationUserId,
@@ -447,7 +446,7 @@ export function initialize(
447446
};
448447

449448
if (!generateJWT) {
450-
enableAnonymousTracking();
449+
enableUnknownTracking();
451450
/* we want to set a normal non-JWT enabled API key */
452451
return {
453452
setNewAuthToken: (newToken: string) => {
@@ -478,8 +477,8 @@ export function initialize(
478477
const identityResolutionConfig =
479478
config.getConfig('identityResolution');
480479
const merge =
481-
identityResolution?.mergeOnAnonymousToKnown ||
482-
identityResolutionConfig?.mergeOnAnonymousToKnown;
480+
identityResolution?.mergeOnUnknownToKnown ||
481+
identityResolutionConfig?.mergeOnUnknownToKnown;
483482
const replay =
484483
identityResolution?.replayOnVisitorToKnown ||
485484
identityResolutionConfig?.replayOnVisitorToKnown;
@@ -490,7 +489,7 @@ export function initialize(
490489
if (replay) {
491490
syncEvents();
492491
} else {
493-
anonUserManager.removeAnonSessionCriteriaData();
492+
unknownUserManager.removeUnknownSessionCriteriaData();
494493
}
495494
return Promise.resolve();
496495
}
@@ -508,8 +507,8 @@ export function initialize(
508507
const identityResolutionConfig =
509508
config.getConfig('identityResolution');
510509
const merge =
511-
identityResolution?.mergeOnAnonymousToKnown ||
512-
identityResolutionConfig?.mergeOnAnonymousToKnown;
510+
identityResolution?.mergeOnUnknownToKnown ||
511+
identityResolutionConfig?.mergeOnUnknownToKnown;
513512
const replay =
514513
identityResolution?.replayOnVisitorToKnown ||
515514
identityResolutionConfig?.replayOnVisitorToKnown;
@@ -520,7 +519,7 @@ export function initialize(
520519
if (replay) {
521520
syncEvents();
522521
} else {
523-
anonUserManager.removeAnonSessionCriteriaData();
522+
unknownUserManager.removeUnknownSessionCriteriaData();
524523
}
525524
return Promise.resolve();
526525
}
@@ -530,7 +529,7 @@ export function initialize(
530529
}
531530
},
532531
logout: () => {
533-
anonUserManager.removeAnonSessionCriteriaData();
532+
unknownUserManager.removeUnknownSessionCriteriaData();
534533
setTypeOfAuth(null);
535534
authIdentifier = null;
536535
/* clear fetched in-app messages */
@@ -550,34 +549,34 @@ export function initialize(
550549
}
551550
},
552551
setVisitorUsageTracked: (consent: boolean) => {
553-
/* if consent is true, we want to clear anon user data and start tracking from point forward */
552+
/* if consent is true, we want to clear unknown user data and start tracking from point forward */
554553
if (consent) {
555-
anonUserManager.removeAnonSessionCriteriaData();
554+
unknownUserManager.removeUnknownSessionCriteriaData();
556555
localStorage.removeItem(SHARED_PREFS_CRITERIA);
557556

558-
localStorage.setItem(SHARED_PREF_ANON_USAGE_TRACKED, 'true');
559-
enableAnonymousTracking();
557+
localStorage.setItem(SHARED_PREF_UNKNOWN_USAGE_TRACKED, 'true');
558+
enableUnknownTracking();
560559
} else {
561-
/* if consent is false, we want to stop tracking and clear anon user data */
562-
const anonymousUsageTracked = isAnonymousUsageTracked();
563-
if (anonymousUsageTracked) {
564-
anonUserManager.removeAnonSessionCriteriaData();
560+
/* if consent is false, we want to stop tracking and clear unknown user data */
561+
const unknownUsageTracked = isUnknownUsageTracked();
562+
if (unknownUsageTracked) {
563+
unknownUserManager.removeUnknownSessionCriteriaData();
565564

566565
localStorage.removeItem(SHARED_PREFS_CRITERIA);
567-
localStorage.removeItem(SHARED_PREF_ANON_USER_ID);
568-
localStorage.removeItem(SHARED_PREF_ANON_USAGE_TRACKED);
566+
localStorage.removeItem(SHARED_PREF_UNKNOWN_USER_ID);
567+
localStorage.removeItem(SHARED_PREF_UNKNOWN_USAGE_TRACKED);
569568

570569
setTypeOfAuth(null);
571570
authIdentifier = null;
572571
/* clear fetched in-app messages */
573572
clearMessages();
574573
}
575-
localStorage.setItem(SHARED_PREF_ANON_USAGE_TRACKED, 'false');
574+
localStorage.setItem(SHARED_PREF_UNKNOWN_USAGE_TRACKED, 'false');
576575
}
577576
},
578577
clearVisitorEventsAndUserData: () => {
579-
anonUserManager.removeAnonSessionCriteriaData();
580-
clearAnonymousUser();
578+
unknownUserManager.removeUnknownSessionCriteriaData();
579+
clearUnknownUser();
581580
}
582581
};
583582
}
@@ -846,7 +845,7 @@ export function initialize(
846845
});
847846
};
848847

849-
enableAnonymousTracking();
848+
enableUnknownTracking();
850849
return {
851850
clearRefresh: () => {
852851
/* this will just clear the existing timeout */
@@ -861,8 +860,8 @@ export function initialize(
861860
try {
862861
const identityResolutionConfig = config.getConfig('identityResolution');
863862
const merge =
864-
identityResolution?.mergeOnAnonymousToKnown ||
865-
identityResolutionConfig?.mergeOnAnonymousToKnown;
863+
identityResolution?.mergeOnUnknownToKnown ||
864+
identityResolutionConfig?.mergeOnUnknownToKnown;
866865
const replay =
867866
identityResolution?.replayOnVisitorToKnown ||
868867
identityResolutionConfig?.replayOnVisitorToKnown;
@@ -876,7 +875,7 @@ export function initialize(
876875
if (replay) {
877876
syncEvents();
878877
} else {
879-
anonUserManager.removeAnonSessionCriteriaData();
878+
unknownUserManager.removeUnknownSessionCriteriaData();
880879
}
881880
return token;
882881
}
@@ -906,8 +905,8 @@ export function initialize(
906905
try {
907906
const identityResolutionConfig = config.getConfig('identityResolution');
908907
const merge =
909-
identityResolution?.mergeOnAnonymousToKnown ||
910-
identityResolutionConfig?.mergeOnAnonymousToKnown;
908+
identityResolution?.mergeOnUnknownToKnown ||
909+
identityResolutionConfig?.mergeOnUnknownToKnown;
911910
const replay =
912911
identityResolution?.replayOnVisitorToKnown ||
913912
identityResolutionConfig?.replayOnVisitorToKnown;
@@ -921,7 +920,7 @@ export function initialize(
921920
if (replay) {
922921
syncEvents();
923922
} else {
924-
anonUserManager.removeAnonSessionCriteriaData();
923+
unknownUserManager.removeUnknownSessionCriteriaData();
925924
}
926925
return token;
927926
}
@@ -944,7 +943,7 @@ export function initialize(
944943
}
945944
},
946945
logout: () => {
947-
anonUserManager.removeAnonSessionCriteriaData();
946+
unknownUserManager.removeUnknownSessionCriteriaData();
948947
setTypeOfAuth(null);
949948
authIdentifier = null;
950949
/* clear fetched in-app messages */
@@ -978,34 +977,34 @@ export function initialize(
978977
});
979978
},
980979
setVisitorUsageTracked: (consent: boolean) => {
981-
/* if consent is true, we want to clear anon user data and start tracking from point forward */
980+
/* if consent is true, we want to clear unknown user data and start tracking from point forward */
982981
if (consent) {
983-
anonUserManager.removeAnonSessionCriteriaData();
982+
unknownUserManager.removeUnknownSessionCriteriaData();
984983
localStorage.removeItem(SHARED_PREFS_CRITERIA);
985984

986-
localStorage.setItem(SHARED_PREF_ANON_USAGE_TRACKED, 'true');
987-
enableAnonymousTracking();
985+
localStorage.setItem(SHARED_PREF_UNKNOWN_USAGE_TRACKED, 'true');
986+
enableUnknownTracking();
988987
} else {
989-
/* if consent is false, we want to stop tracking and clear anon user data */
990-
const anonymousUsageTracked = isAnonymousUsageTracked();
991-
if (anonymousUsageTracked) {
992-
anonUserManager.removeAnonSessionCriteriaData();
988+
/* if consent is false, we want to stop tracking and clear unknown user data */
989+
const unknownUsageTracked = isUnknownUsageTracked();
990+
if (unknownUsageTracked) {
991+
unknownUserManager.removeUnknownSessionCriteriaData();
993992

994993
localStorage.removeItem(SHARED_PREFS_CRITERIA);
995-
localStorage.removeItem(SHARED_PREF_ANON_USER_ID);
996-
localStorage.removeItem(SHARED_PREF_ANON_USAGE_TRACKED);
994+
localStorage.removeItem(SHARED_PREF_UNKNOWN_USER_ID);
995+
localStorage.removeItem(SHARED_PREF_UNKNOWN_USAGE_TRACKED);
997996

998997
setTypeOfAuth(null);
999998
authIdentifier = null;
1000999
/* clear fetched in-app messages */
10011000
clearMessages();
10021001
}
1003-
localStorage.setItem(SHARED_PREF_ANON_USAGE_TRACKED, 'false');
1002+
localStorage.setItem(SHARED_PREF_UNKNOWN_USAGE_TRACKED, 'false');
10041003
}
10051004
},
10061005
clearVisitorEventsAndUserData: () => {
1007-
anonUserManager.removeAnonSessionCriteriaData();
1008-
clearAnonymousUser();
1006+
unknownUserManager.removeUnknownSessionCriteriaData();
1007+
clearUnknownUser();
10091008
}
10101009
};
10111010
}

0 commit comments

Comments
 (0)