Merge pull request #2927 from input-output-hk/feat/ddw-1025-matomo-poc

[DDW-809] Analytics - part 1 - analytics opt-in, settings and unique user ID generation

Author: danielmain

package.json

@@ -103,9 +103,12 @@
     "@types/node": "14.18.1",
     "@types/qrcode.react": "1.0.2",
     "@types/react": "16.9.56",
+    "@types/react-router": "5.1.18",
+    "@types/react-router-dom": "5.3.3",
     "@types/react-svg-inline": "2.1.3",
     "@types/react-table": "^7.7.9",
     "@types/trezor-connect": "8.1.18",
+    "@types/uuid": "8.3.4",
     "@typescript-eslint/eslint-plugin": "5.20.0",
     "@typescript-eslint/parser": "5.20.0",
     "@xarc/run": "1.1.1",
@@ -291,6 +294,7 @@
     "url": "0.11.0",
     "usb-detection": "4.13.0",
     "util": "0.12.4",
+    "uuid": "8.3.2",
     "validator": "13.7.0"
   },
   "devEngines": {

source/common/config/electron-store.config.ts

@@ -23,6 +23,8 @@ export const STORAGE_KEYS: Record<string, StorageKey> = {
   STAKE_POOLS_LIST_VIEW_TOOLTIP: 'STAKE-POOLS-LIST-VIEW-TOOLTIP',
   STAKING_INFO_WAS_OPEN: 'ALONZO-INFO-WAS-OPEN',
   TERMS_OF_USE_ACCEPTANCE: 'TERMS-OF-USE-ACCEPTANCE',
+  ANALYTICS_ACCEPTANCE: 'ANALYTICS-ACCEPTANCE',
+  USER_ID: 'USER-ID',
   THEME: 'THEME',
   TOKEN_FAVORITES: 'TOKEN-FAVORITES',
   USER_DATE_FORMAT_ENGLISH: 'USER-DATE-FORMAT-ENGLISH',

source/common/ipc/constants.ts

@@ -1,4 +1,6 @@
-export const DIALOGS = {
+import { ApplicationDialog } from '../../renderer/app/types/applicationDialogTypes';
+
+export const DIALOGS: Record<string, ApplicationDialog> = {
   ABOUT: 'ABOUT_DIALOG',
   DAEDALUS_DIAGNOSTICS: 'DAEDALUS_DIAGNOSTICS_DIALOG',
   ITN_REWARDS_REDEMPTION: 'ITN_REWARDS_REDEMPTION_DIALOG',

source/common/ipc/lib/IpcConversation.ts

@@ -1,5 +1,5 @@
 import { isString } from 'lodash';
-import uuid from 'uuid';
+import { v4 as uuidv4 } from 'uuid';
 
 export type IpcSender = {
   send: (channel: string, conversationId: string, ...args: Array<any>) => void;
@@ -68,7 +68,7 @@ export class IpcConversation<Incoming, Outgoing> {
     receiver: IpcReceiver
   ): Promise<Incoming> {
     return new Promise((resolve, reject) => {
-      const conversationId = uuid();
+      const conversationId = uuidv4();
 
       const handler = (
         event,

source/common/types/electron-store.types.ts

@@ -26,6 +26,8 @@ export type StorageKey =
   | 'USER-TIME-FORMAT'
   | 'WALLET-MIGRATION-STATUS'
   | 'WALLETS'
+  | 'ANALYTICS-ACCEPTANCE'
+  | 'USER-ID'
   | 'WINDOW-BOUNDS';
 export type StoreMessage = {
   type: StorageType;

source/common/types/environment.types.ts

@@ -23,7 +23,8 @@ export type Environment = {
   mainProcessID: string;
   rendererProcessID: string;
   os: string;
-  cpu: string;
+  system: string;
+  cpu: Cpu;
   ram: number;
   hasMetHardwareRequirements: boolean;
   installerVersion: string;
@@ -33,6 +34,7 @@ export type Environment = {
   isLinux: boolean;
   isBlankScreenFixActive: boolean;
   keepLocalClusterRunning: boolean;
+  analyticsFeatureEnabled: boolean;
 };
 // constants
 export const PRODUCTION = 'production';

source/main/environment.ts

@@ -50,6 +50,7 @@ const isPreview = checkIsPreview(NETWORK);
 const isShelleyQA = checkIsShelleyQA(NETWORK);
 const isSelfnode = checkIsSelfnode(NETWORK);
 const isDevelopment = checkIsDevelopment(NETWORK);
+const analyticsFeatureEnabled = isMainnet || isStaging || isTestnet;
 const keepLocalClusterRunning = process.env.KEEP_LOCAL_CLUSTER_RUNNING;
 const API_VERSION = process.env.API_VERSION || 'dev';
 const NODE_VERSION = '1.35.3'; // TODO: pick up this value from process.env
@@ -111,6 +112,7 @@ export const environment: Environment = Object.assign(
     isBlankScreenFixActive,
     keepLocalClusterRunning,
     hasMetHardwareRequirements,
+    analyticsFeatureEnabled,
   },
   process.env
 );

source/renderer/app/Routes.tsx

@@ -34,6 +34,7 @@ import WalletSettingsPage from './containers/wallet/WalletSettingsPage';
 import WalletUtxoPage from './containers/wallet/WalletUtxoPage';
 import VotingRegistrationPage from './containers/voting/VotingRegistrationPage';
 import { IS_STAKING_INFO_PAGE_AVAILABLE } from './config/stakingConfig';
+import AnalyticsConsentPage from './containers/profile/AnalyticsConsentPage';
 
 export const Routes = withRouter(() => (
   <Route path={ROUTES.ROOT}>
@@ -49,6 +50,10 @@ export const Routes = withRouter(() => (
           component={InitialSettingsPage}
         />
         <Route path={ROUTES.PROFILE.TERMS_OF_USE} component={TermsOfUsePage} />
+        <Route
+          path={ROUTES.PROFILE.ANALYTICS}
+          component={AnalyticsConsentPage}
+        />
         <Route
           path={ROUTES.PROFILE.DATA_LAYER_MIGRATION}
           component={DataLayerMigrationPage}

source/renderer/app/actions/lib/Action.ts

@@ -3,7 +3,7 @@ import { bindAll } from 'lodash';
 /**
  * Listener type as Function that takes specific params <P>
  */
-export type Listener<P> = (params: P) => any;
+export type Listener<P> = (params: P) => void;
 /**
  * Action class with typed params
  */
@@ -30,8 +30,8 @@ export default class Action<Params> {
     this.listeners.push(listener);
   }
 
-  trigger(params?: Params) {
-    this.listeners.forEach((listener) => listener(params));
+  async trigger(params?: Params): Promise<void> {
+    await Promise.all(this.listeners.map((listener) => listener(params)));
   }
 
   remove(listener: Listener<Params>) {

source/renderer/app/actions/profile-actions.ts

@@ -1,6 +1,8 @@
-import Action from './lib/Action'; // ======= PROFILE ACTIONS =======
+import Action from './lib/Action';
+import { AnalyticsAcceptanceStatus } from '../analytics/types';
 
 export default class ProfileActions {
+  acceptAnalytics: Action<AnalyticsAcceptanceStatus> = new Action();
   acceptTermsOfUse: Action<any> = new Action();
   acceptDataLayerMigration: Action<any> = new Action();
   getLogs: Action<any> = new Action();