aboutsummaryrefslogtreecommitdiffstats
path: root/packages/instant
diff options
context:
space:
mode:
authorBrandon Millman <brandon.millman@gmail.com>2018-11-22 04:44:28 +0800
committerBrandon Millman <brandon.millman@gmail.com>2018-11-22 05:16:34 +0800
commit6604e2db20d6263e05b00cf5d36b56788e42d9c2 (patch)
tree9ceef12d9ccb33d29916be9abfd7fe1287cf1093 /packages/instant
parent31d1b4ba670d25c4cd4ed93d32d12718b4804e5d (diff)
downloaddexon-sol-tools-6604e2db20d6263e05b00cf5d36b56788e42d9c2.tar
dexon-sol-tools-6604e2db20d6263e05b00cf5d36b56788e42d9c2.tar.gz
dexon-sol-tools-6604e2db20d6263e05b00cf5d36b56788e42d9c2.tar.bz2
dexon-sol-tools-6604e2db20d6263e05b00cf5d36b56788e42d9c2.tar.lz
dexon-sol-tools-6604e2db20d6263e05b00cf5d36b56788e42d9c2.tar.xz
dexon-sol-tools-6604e2db20d6263e05b00cf5d36b56788e42d9c2.tar.zst
dexon-sol-tools-6604e2db20d6263e05b00cf5d36b56788e42d9c2.zip
chore(instant): refactor usage of event properties in heap
Diffstat (limited to 'packages/instant')
-rw-r--r--packages/instant/src/redux/analytics_middleware.ts12
-rw-r--r--packages/instant/src/util/analytics.ts32
-rw-r--r--packages/instant/src/util/heap.ts4
3 files changed, 26 insertions, 22 deletions
diff --git a/packages/instant/src/redux/analytics_middleware.ts b/packages/instant/src/redux/analytics_middleware.ts
index 889cc875e..931902187 100644
--- a/packages/instant/src/redux/analytics_middleware.ts
+++ b/packages/instant/src/redux/analytics_middleware.ts
@@ -27,19 +27,17 @@ export const analyticsMiddleware: Middleware = store => next => middlewareAction
prevAccount.state === AccountState.Ready && prevAccount.address !== curAccount.address;
const ethAddress = curAccount.address;
if (didJustTurnReady) {
- analytics.trackAccountReady(ethAddress);
- analytics.addUserProperties({ ethAddress });
+ analytics.trackAccountReady({ address: ethAddress });
+ analytics.addUserProperties({ lastKnownEthAddress: ethAddress });
} else if (didJustUpdateAddress) {
- analytics.trackAccountAddressChanged(ethAddress);
- analytics.addUserProperties({ ethAddress });
+ analytics.trackAccountAddressChanged({ address: ethAddress });
+ analytics.addUserProperties({ lastKnownEthAddress: ethAddress });
}
}
break;
case ActionTypes.SET_ACCOUNT_STATE_LOCKED:
if (prevAccount.state !== AccountState.Locked && curAccount.state === AccountState.Locked) {
- // if we are moving from account not locked to account locked, update the current address to undefined and track `Account - Locked`
- const ethAddress = undefined;
- analytics.addUserProperties({ ethAddress });
+ // if we are moving from account not locked to account locked, track `Account - Locked`
analytics.trackAccountLocked();
}
break;
diff --git a/packages/instant/src/util/analytics.ts b/packages/instant/src/util/analytics.ts
index d36bf8fc3..31233fe7a 100644
--- a/packages/instant/src/util/analytics.ts
+++ b/packages/instant/src/util/analytics.ts
@@ -1,6 +1,4 @@
-import { ObjectMap } from '@0x/types';
-
-import { heapUtil } from './heap';
+import { EventProperties, heapUtil } from './heap';
let isDisabled = false;
export const disableAnalytics = (shouldDisableAnalytics: boolean) => {
@@ -21,9 +19,9 @@ enum EventNames {
ACCOUNT_UNLOCK_DENIED = 'Account - Unlock Denied',
ACCOUNT_ADDRESS_CHANGED = 'Account - Address Changed',
}
-const track = (eventName: EventNames, eventData: ObjectMap<string | number> = {}): void => {
+const track = (eventName: EventNames, eventProperties: EventProperties = {}): void => {
evaluateIfEnabled(() => {
- heapUtil.evaluateHeapCall(heap => heap.track(eventName, eventData));
+ heapUtil.evaluateHeapCall(heap => heap.track(eventName, eventProperties));
});
};
function trackingEventFnWithoutPayload(eventName: EventNames): () => void {
@@ -32,16 +30,14 @@ function trackingEventFnWithoutPayload(eventName: EventNames): () => void {
};
}
// tslint:disable-next-line:no-unused-variable
-function trackingEventFnWithPayload<T extends ObjectMap<string | number>>(
- eventName: EventNames,
-): (eventDataProperties: T) => void {
- return (eventDataProperties: T) => {
- track(eventName, eventDataProperties);
+function trackingEventFnWithPayload(eventName: EventNames): (eventProperties: EventProperties) => void {
+ return (eventProperties: EventProperties) => {
+ track(eventName, eventProperties);
};
}
export interface AnalyticsUserOptions {
- ethAddress?: string;
+ lastKnownEthAddress?: string;
ethBalanceInUnitAmount?: string;
}
export interface AnalyticsEventOptions {
@@ -52,6 +48,13 @@ export interface AnalyticsEventOptions {
gitSha?: string;
npmVersion?: string;
}
+export interface AccountReadyEventProperties {
+ address: string;
+}
+export interface AccountAddressChangedEventProperties {
+ address: string;
+}
+
export const analytics = {
addUserProperties: (properties: AnalyticsUserOptions): void => {
evaluateIfEnabled(() => {
@@ -65,9 +68,10 @@ export const analytics = {
},
trackInstantOpened: trackingEventFnWithoutPayload(EventNames.INSTANT_OPENED),
trackAccountLocked: trackingEventFnWithoutPayload(EventNames.ACCOUNT_LOCKED),
- trackAccountReady: (address: string) => trackingEventFnWithPayload(EventNames.ACCOUNT_READY)({ address }),
+ trackAccountReady: (eventProperties: AccountReadyEventProperties) =>
+ trackingEventFnWithPayload(EventNames.ACCOUNT_READY)({ ...eventProperties }),
trackAccountUnlockRequested: trackingEventFnWithoutPayload(EventNames.ACCOUNT_UNLOCK_REQUESTED),
trackAccountUnlockDenied: trackingEventFnWithoutPayload(EventNames.ACCOUNT_UNLOCK_DENIED),
- trackAccountAddressChanged: (address: string) =>
- trackingEventFnWithPayload(EventNames.ACCOUNT_ADDRESS_CHANGED)({ address }),
+ trackAccountAddressChanged: (eventProperties: AccountAddressChangedEventProperties) =>
+ trackingEventFnWithPayload(EventNames.ACCOUNT_ADDRESS_CHANGED)({ ...eventProperties }),
};
diff --git a/packages/instant/src/util/heap.ts b/packages/instant/src/util/heap.ts
index 78ec3b3cc..7c53c9918 100644
--- a/packages/instant/src/util/heap.ts
+++ b/packages/instant/src/util/heap.ts
@@ -6,11 +6,13 @@ import { HEAP_ANALYTICS_ID } from '../constants';
import { AnalyticsEventOptions, AnalyticsUserOptions } from './analytics';
+export type EventProperties = ObjectMap<string | number>;
+
export interface HeapAnalytics {
loaded: boolean;
appid: string;
identify(id: string, idType: string): void;
- track(eventName: string, eventProperties?: ObjectMap<string | number>): void;
+ track(eventName: string, eventProperties?: EventProperties): void;
resetIdentity(): void;
addUserProperties(properties: AnalyticsUserOptions): void;
addEventProperties(properties: AnalyticsEventOptions): void;