[DDW-1174] Add custom dimension to track legacy and hardware wallet usage

Author: Marcin Mazurek

source/renderer/app/analytics/MatomoAnalyticsTracker.ts

@@ -4,13 +4,15 @@ import { Environment } from '../../../common/types/environment.types';
 import LocalStorageApi from '../api/utils/localStorage';
 import { MatomoClient } from './MatomoClient';
 import { NoopAnalyticsClient } from './noopAnalyticsClient';
+import AdaApi from '../api/api';
 
 export class MatomoAnalyticsTracker implements AnalyticsTracker {
   #analyticsClient: AnalyticsClient;
 
   constructor(
     private environment: Environment,
-    private localStorageApi: LocalStorageApi
+    private localStorageApi: LocalStorageApi,
+    private adaApi: AdaApi
   ) {
     this.#analyticsClient = NoopAnalyticsClient;
     this.#enableTrackingIfAccepted();
@@ -19,6 +21,7 @@ export class MatomoAnalyticsTracker implements AnalyticsTracker {
   async enableTracking() {
     this.#analyticsClient = new MatomoClient(
       this.environment,
+      this.adaApi,
       await this.localStorageApi.getUserID()
     );
   }

source/renderer/app/analytics/MatomoClient.ts

@@ -3,15 +3,11 @@ import { AnalyticsClient } from './types';
 import { Environment } from '../../../common/types/environment.types';
 import {
   ANALYTICS_API_ENDPOINT,
-  CPU_DIMENSION_KEY,
   DEV_MODE_SITE_MAP_ID,
   NETWORK_TO_ANALYTICS_SITE_ID_MAP,
-  OS_DIMENSION_KEY,
-  RAM_DIMENSION_KEY,
-  VERSION_DIMENSION_KEY,
 } from '../config/analyticsConfig';
-import { formattedBytesToSize } from '../utils/formatters';
-import { getShortCpuDescription } from '../utils/getShortCpuDescription';
+import { getCustomDimensions } from './getCustomDimensions';
+import AdaApi from '../api/api';
 
 /**
  * Matomo API reference:
@@ -20,24 +16,28 @@ import { getShortCpuDescription } from '../utils/getShortCpuDescription';
 export class MatomoClient implements AnalyticsClient {
   private matomoTracker: MatomoTracker;
 
-  constructor(private environment: Environment, private userId: string) {
+  constructor(
+    private environment: Environment,
+    private adaApi: AdaApi,
+    private userId: string
+  ) {
     this.matomoTracker = new MatomoTracker(
       this.getMatomoSiteId(environment),
       ANALYTICS_API_ENDPOINT
     );
   }
 
   sendPageNavigationEvent = async (pageTitle: string) => {
+    const customDimensions = await getCustomDimensions(
+      this.environment,
+      this.adaApi
+    );
+
     this.matomoTracker.track({
       _id: this.userId,
       action_name: pageTitle,
       url: this.getAnalyticsURL(),
-      [CPU_DIMENSION_KEY]: getShortCpuDescription(
-        this.environment.cpu[0]?.model
-      ),
-      [RAM_DIMENSION_KEY]: formattedBytesToSize(this.environment.ram, 0),
-      [OS_DIMENSION_KEY]: this.environment.os,
-      [VERSION_DIMENSION_KEY]: this.environment.version,
+      ...customDimensions,
     });
   };
 

source/renderer/app/analytics/getCustomDimensions.ts

@@ -0,0 +1,35 @@
+import { Environment } from '../../../common/types/environment.types';
+import {
+  CPU_DIMENSION_KEY,
+  OS_DIMENSION_KEY,
+  RAM_DIMENSION_KEY,
+  USES_HARDWARE_WALLET_DIMENSION_KEY,
+  USES_LEGACY_WALLET_DIMENSION_KEY,
+  VERSION_DIMENSION_KEY,
+} from '../config/analyticsConfig';
+import { getShortCpuDescription } from '../utils/getShortCpuDescription';
+import { formattedBytesToSize } from '../utils/formatters';
+import AdaApi from '../api/api';
+
+const booleanToText = (flag: boolean) => (flag ? 'yes' : 'no');
+
+export const getCustomDimensions = async (
+  environment: Environment,
+  adaApi: AdaApi
+) => {
+  const usesByronWallets = (await adaApi.getWallets()).some(
+    (wallet) => wallet.isLegacy
+  );
+  const usesHardwareWallets = (await adaApi.getWallets()).some(
+    (wallet) => wallet.isHardwareWallet
+  );
+
+  return {
+    [CPU_DIMENSION_KEY]: getShortCpuDescription(environment.cpu[0]?.model),
+    [RAM_DIMENSION_KEY]: formattedBytesToSize(environment.ram, 0),
+    [OS_DIMENSION_KEY]: environment.os,
+    [VERSION_DIMENSION_KEY]: environment.version,
+    [USES_LEGACY_WALLET_DIMENSION_KEY]: booleanToText(usesByronWallets),
+    [USES_HARDWARE_WALLET_DIMENSION_KEY]: booleanToText(usesHardwareWallets),
+  };
+};

source/renderer/app/config/analyticsConfig.ts

@@ -26,3 +26,5 @@ export const CPU_DIMENSION_KEY = 'dimension1';
 export const RAM_DIMENSION_KEY = 'dimension2';
 export const OS_DIMENSION_KEY = 'dimension3';
 export const VERSION_DIMENSION_KEY = 'dimension4';
+export const USES_LEGACY_WALLET_DIMENSION_KEY = 'dimension5';
+export const USES_HARDWARE_WALLET_DIMENSION_KEY = 'dimension6';

source/renderer/app/index.tsx

@@ -37,7 +37,8 @@ const initializeDaedalus = () => {
   const routingStore = new RouterStore();
   const analyticsTracker = new MatomoAnalyticsTracker(
     environment,
-    api.localStorage
+    api.localStorage,
+    api.ada
   );
   const stores = setUpStores(api, actions, routingStore, analyticsTracker);
   const history = syncHistoryWithStore(hashHistory, routingStore);