[DDW-809] Address PR comments

input-output-hk · Jun 28, 2022 · 2759b03 · 2759b03
1 parent b4a5571
commit 2759b03
Show file tree

Hide file tree

Showing 20 changed files with 146 additions and 68 deletions.
diff --git a/source/renderer/app/analytics/index.ts b/source/renderer/app/analytics/index.ts
@@ -1,3 +1,3 @@
-export { AnalyticsAcceptanceStatus } from './types';
+export { AnalyticsAcceptanceStatus, EventCategories } from './types';
 export type { AnalyticsClient, AnalyticsTracker } from './types';
 export { noopAnalyticsTracker } from './NoopAnalyticsTracker';
diff --git a/source/renderer/app/analytics/types.ts b/source/renderer/app/analytics/types.ts
@@ -13,5 +13,14 @@ export interface AnalyticsTracker {
   enableTracking(): Promise<void>;
   disableTracking(): void;
   sendPageNavigationEvent(pageTitle: string): void;
-  sendEvent(category: string, name: string, action?: string): void;
+  sendEvent(category: EventCategories, name: string, action?: string): void;
+}
+
+export enum EventCategories {
+  WALLETS = 'Wallets',
+  STAKE_POOLS = 'Stake Pools',
+  SETTINGS = 'Settings',
+  LAYOUT = 'Layout',
+  SYSTEM_MENU = 'System Menu',
+  VOTING = 'Voting',
 }
diff --git a/source/renderer/app/components/staking/stake-pools/StakePools.tsx b/source/renderer/app/components/staking/stake-pools/StakePools.tsx
@@ -23,7 +23,7 @@ import {
 import smashSettingsIcon from '../../../assets/images/smash-settings-ic.inline.svg';
 import tinySpinnerIcon from '../../../assets/images/spinner-tiny.inline.svg';
 import { getSmashServerNameFromUrl } from '../../../utils/staking';
-import { AnalyticsTracker } from '../../../analytics';
+import { AnalyticsTracker, EventCategories } from '../../../analytics';
 
 const messages = defineMessages({
   delegatingListTitle: {
@@ -120,7 +120,7 @@ class StakePools extends Component<Props, State> {
   sendSearchAnalyticsEvent = debounce(
     () =>
       this.props.analyticsTracker.sendEvent(
-        'Stake Pools',
+        EventCategories.STAKE_POOLS,
         'Used stake pools search'
       ),
     5000
@@ -147,7 +147,7 @@ class StakePools extends Component<Props, State> {
     });
 
     this.props.analyticsTracker.sendEvent(
-      'Stake Pools',
+      EventCategories.STAKE_POOLS,
       'Changed view to grid view'
     );
   };
@@ -159,7 +159,7 @@ class StakePools extends Component<Props, State> {
     });
 
     this.props.analyticsTracker.sendEvent(
-      'Stake Pools',
+      EventCategories.STAKE_POOLS,
       'Changed view to grid rewards view'
     );
   };
@@ -171,7 +171,7 @@ class StakePools extends Component<Props, State> {
     });
 
     this.props.analyticsTracker.sendEvent(
-      'Stake Pools',
+      EventCategories.STAKE_POOLS,
       'Changed view to list view'
     );
   };

diff --git a/source/renderer/app/components/wallet/WalletSendForm.tsx b/source/renderer/app/components/wallet/WalletSendForm.tsx
@@ -41,7 +41,7 @@ import { DiscreetWalletAmount } from '../../features/discreet-mode';
 import WalletTokenPicker from './tokens/wallet-token-picker/WalletTokenPicker';
 import { ClearButton } from './widgets/ClearButton';
 import { Divider } from './widgets/Divider';
-import { AnalyticsTracker } from '../../analytics';
+import { AnalyticsTracker, EventCategories } from '../../analytics';
 
 messages.fieldIsRequired = globalMessages.fieldIsRequired;
 type AdaInputState = 'restored' | 'updated' | 'reset' | 'none';
@@ -709,7 +709,7 @@ class WalletSendForm extends Component<Props, State> {
         this.removeAssetFields(uniqueId);
         await this.calculateTransactionFee(true);
         this.props.analyticsTracker.sendEvent(
-          'Wallets',
+          EventCategories.WALLETS,
           'Removed token from transaction'
         );
       }
@@ -1170,7 +1170,7 @@ class WalletSendForm extends Component<Props, State> {
               onTokenPickerDialogClose();
               checked.forEach(this.addAssetRow);
               this.props.analyticsTracker.sendEvent(
-                'Wallets',
+                EventCategories.WALLETS,
                 'Added token to transaction'
               );
             }}

diff --git a/source/renderer/app/components/wallet/transactions/WalletTransactionsList.tsx b/source/renderer/app/components/wallet/transactions/WalletTransactionsList.tsx
@@ -16,7 +16,7 @@ import { SimpleTransactionList } from './render-strategies/SimpleTransactionList
 import { TransactionInfo, TransactionsGroup } from './types';
 import type { Row } from './types';
 import { getNonZeroAssetTokens } from '../../../utils/assets';
-import { AnalyticsTracker } from '../../../analytics';
+import { AnalyticsTracker, EventCategories } from '../../../analytics';
 
 const messages = defineMessages({
   today: {
@@ -206,7 +206,7 @@ class WalletTransactionsList extends Component<Props, State> {
     if (this.props.onShowMoreTransactions) {
       this.props.onShowMoreTransactions(walletId);
       this.props.analyticsTracker.sendEvent(
-        'Wallet Details',
+        EventCategories.WALLETS,
         'Clicked Show More Transactions button'
       );
     }

diff --git a/source/renderer/app/features/discreet-mode/feature.ts b/source/renderer/app/features/discreet-mode/feature.ts
@@ -5,7 +5,7 @@ import { DiscreetModeApi } from './api';
 import { SENSITIVE_DATA_SYMBOL } from './config';
 import { defaultReplacer } from './replacers/defaultReplacer';
 import type { ReplacerFn } from './types';
-import { AnalyticsTracker } from '../../analytics';
+import { AnalyticsTracker, EventCategories } from '../../analytics';
 
 export class DiscreetMode extends Feature {
   constructor(
@@ -52,7 +52,7 @@ export class DiscreetMode extends Feature {
   toggleDiscreetMode = () => {
     this.isDiscreetMode = !this.isDiscreetMode;
     this.analyticsTracker.sendEvent(
-      'Settings',
+      EventCategories.SETTINGS,
       this.isDiscreetMode
         ? 'Turned on discreet mode'
         : 'Turned off discreet mode'
@@ -67,7 +67,7 @@ export class DiscreetMode extends Feature {
       this.openInDiscreetMode = nextSetting;
     });
     this.analyticsTracker.sendEvent(
-      'Settings',
+      EventCategories.SETTINGS,
       this.isDiscreetMode
         ? 'Turned on discreet mode by default'
         : 'Turned off discreet mode by default'

diff --git a/source/renderer/app/stores/AppStore.ts b/source/renderer/app/stores/AppStore.ts
@@ -15,6 +15,7 @@ import { getGPUStatusChannel } from '../ipc/get-gpu-status.ipc';
 import { generateFileNameWithTimestamp } from '../../../common/utils/files';
 import type { GpuStatus } from '../types/gpuStatus';
 import type { ApplicationDialog } from '../types/applicationDialogTypes';
+import { EventCategories } from '../analytics';
 
 export default class AppStore extends Store {
   @observable
@@ -89,7 +90,7 @@ export default class AppStore extends Store {
     this.newsFeedIsOpen = !this.newsFeedIsOpen;
 
     if (this.newsFeedIsOpen) {
-      this._sendAnalyticsEvent('Topbar', 'Opened newsfeed');
+      this.analytics.sendEvent(EventCategories.LAYOUT, 'Opened newsfeed');
     }
   };
   @action
@@ -118,37 +119,46 @@ export default class AppStore extends Store {
       case DIALOGS.ABOUT:
         // @ts-ignore ts-migrate(2345) FIXME: Argument of type 'string' is not assignable to par... Remove this comment to see the full error message
         this._updateActiveDialog(DIALOGS.ABOUT);
-        this._sendAnalyticsEvent('System menu', 'Showed about dialog');
+        this.analytics.sendEvent(
+          EventCategories.SYSTEM_MENU,
+          'Showed about dialog'
+        );
         break;
 
       case DIALOGS.DAEDALUS_DIAGNOSTICS:
         // @ts-ignore ts-migrate(2345) FIXME: Argument of type 'string' is not assignable to par... Remove this comment to see the full error message
         this._updateActiveDialog(DIALOGS.DAEDALUS_DIAGNOSTICS);
-        this._sendAnalyticsEvent('System menu', 'Showed diagnostics dialog');
+        this.analytics.sendEvent(
+          EventCategories.SYSTEM_MENU,
+          'Showed diagnostics dialog'
+        );
 
         break;
 
       case DIALOGS.TOGGLE_RTS_FLAGS_MODE:
         // @ts-ignore ts-migrate(2345) FIXME: Argument of type 'string' is not assignable to par... Remove this comment to see the full error message
         this._updateActiveDialog(DIALOGS.TOGGLE_RTS_FLAGS_MODE);
-        this._sendAnalyticsEvent(
-          'System menu',
+        this.analytics.sendEvent(
+          EventCategories.SYSTEM_MENU,
           'Showed toggle RTS flags dialog'
         );
         break;
 
       case DIALOGS.ITN_REWARDS_REDEMPTION:
         // @ts-ignore ts-migrate(2554) FIXME: Expected 1 arguments, but got 0.
         this.actions.staking.onRedeemStart.trigger();
-        this._sendAnalyticsEvent(
-          'System menu',
+        this.analytics.sendEvent(
+          EventCategories.SYSTEM_MENU,
           'Showed ITN rewards redemption dialog'
         );
         break;
 
       case NOTIFICATIONS.DOWNLOAD_LOGS:
         this._downloadLogs();
-        this._sendAnalyticsEvent('System menu', 'Downloaded logs');
+        this.analytics.sendEvent(
+          EventCategories.SYSTEM_MENU,
+          'Downloaded logs'
+        );
         break;
 
       case PAGES.SETTINGS:
@@ -247,8 +257,4 @@ export default class AppStore extends Store {
   _setIsDownloadingLogs = (isDownloadNotificationVisible: boolean) => {
     this.isDownloadNotificationVisible = isDownloadNotificationVisible;
   };
-
-  _sendAnalyticsEvent = (category: string, actionName: string) => {
-    this.analytics.sendEvent(category, actionName);
-  };
 }
diff --git a/source/renderer/app/stores/AssetsStore.ts b/source/renderer/app/stores/AssetsStore.ts
@@ -6,6 +6,7 @@ import Asset from '../domains/Asset';
 import { ROUTES } from '../routes-config';
 import { ellipsis } from '../utils/strings';
 import type { GetAssetsResponse, AssetToken } from '../api/assets/types';
+import { EventCategories } from '../analytics';
 
 type WalletId = string;
 export default class AssetsStore extends Store {
@@ -108,7 +109,10 @@ export default class AssetsStore extends Store {
       decimals,
     });
 
-    this.analytics.sendEvent('Wallets', 'Changed native token settings');
+    this.analytics.sendEvent(
+      EventCategories.WALLETS,
+      'Changed native token settings'
+    );
   };
   @action
   _onEditedAssetUnset = () => {
@@ -197,7 +201,7 @@ export default class AssetsStore extends Store {
     await this.favoritesRequest.execute();
 
     this.analytics.sendEvent(
-      'Wallets',
+      EventCategories.WALLETS,
       !isFavorite
         ? 'Added token from favorites'
         : 'Removed token from favorites'

diff --git a/source/renderer/app/stores/CurrencyStore.ts b/source/renderer/app/stores/CurrencyStore.ts
@@ -7,6 +7,7 @@ import {
   getCurrencyFromCode,
 } from '../config/currencyConfig';
 import type { Currency, LocalizedCurrency } from '../types/currencyTypes';
+import { EventCategories } from '../analytics';
 
 export default class CurrencyStore extends Store {
   @observable
@@ -128,15 +129,19 @@ export default class CurrencyStore extends Store {
       await this.api.localStorage.setCurrencySelected(selected.code);
     }
 
-    this.analytics.sendEvent('Settings', 'Changed currency', code);
+    this.analytics.sendEvent(
+      EventCategories.SETTINGS,
+      'Changed currency',
+      code
+    );
   };
   @action
   _toggleCurrencyIsActive = () => {
     this.isActive = !this.isActive;
     this.api.localStorage.setCurrencyIsActive(this.isActive);
 
     this.analytics.sendEvent(
-      'Settings',
+      EventCategories.SETTINGS,
       `Turned ${
         this.isActive ? 'on' : 'off'
       } displaying ada balances in other currency`

diff --git a/source/renderer/app/stores/HardwareWalletsStore.ts b/source/renderer/app/stores/HardwareWalletsStore.ts
@@ -101,6 +101,7 @@ import type {
   TrezorWitness,
 } from '../../../common/types/hardware-wallets.types';
 import { logger } from '../utils/logging';
+import { EventCategories } from '../analytics';
 
 export type TxSignRequestTypes = {
   coinSelection: CoinSelectionsResponse;
@@ -526,7 +527,7 @@ export default class HardwareWalletsStore extends Store {
         );
 
         this.analytics.sendEvent(
-          'Wallets',
+          EventCategories.WALLETS,
           'Transaction made',
           'Hardware wallet'
         );
@@ -1472,7 +1473,7 @@ export default class HardwareWalletsStore extends Store {
         }
 
         this.analytics.sendEvent(
-          'Wallets',
+          EventCategories.WALLETS,
           'Verified wallet address with hardware wallet'
         );
       } else {

diff --git a/source/renderer/app/stores/NetworkStatusStore.ts b/source/renderer/app/stores/NetworkStatusStore.ts
@@ -42,6 +42,7 @@ import type { CheckDiskSpaceResponse } from '../../../common/types/no-disk-space
 import { TlsCertificateNotValidError } from '../api/nodes/errors';
 import { openLocalDirectoryChannel } from '../ipc/open-local-directory';
 import { toggleRTSFlagsModeChannel } from '../ipc/toggleRTSFlagsModeChannel';
+import { EventCategories } from '../analytics';
 
 // DEFINE CONSTANTS -------------------------
 const NETWORK_STATUS = {
@@ -432,7 +433,7 @@ export default class NetworkStatusStore extends Store {
   // DEFINE ACTIONS
   @action _toggleRTSFlagsMode = async () => {
     this.analytics.sendEvent(
-      'Settings',
+      EventCategories.SETTINGS,
       `RTS flags ${this.isRTSFlagsModeEnabled ? 'disabled' : 'enabled'}`
     );
     await toggleRTSFlagsModeChannel.send();

diff --git a/source/renderer/app/stores/ProfileStore.ts b/source/renderer/app/stores/ProfileStore.ts
@@ -41,7 +41,7 @@ import {
   TIME_OPTIONS,
 } from '../config/profileConfig';
 import { buildSystemInfo } from '../utils/buildSystemInfo';
-import { AnalyticsAcceptanceStatus } from '../analytics/types';
+import { AnalyticsAcceptanceStatus, EventCategories } from '../analytics/types';
 
 export default class ProfileStore extends Store {
   @observable
@@ -370,15 +370,19 @@ export default class ProfileStore extends Store {
       this.stores.wallets.refreshWalletsData();
     }
 
-    this.analytics.sendEvent('Settings', 'Changed user settings', param);
+    this.analytics.sendEvent(
+      EventCategories.SETTINGS,
+      'Changed user settings',
+      param
+    );
   };
   _updateTheme = async ({ theme }: { theme: string }) => {
     // @ts-ignore ts-migrate(1320) FIXME: Type of 'await' operand must either be a valid pro... Remove this comment to see the full error message
     await this.setThemeRequest.execute(theme);
     // @ts-ignore ts-migrate(1320) FIXME: Type of 'await' operand must either be a valid pro... Remove this comment to see the full error message
     await this.getThemeRequest.execute();
 
-    this.analytics.sendEvent('Settings', 'Changed theme', theme);
+    this.analytics.sendEvent(EventCategories.SETTINGS, 'Changed theme', theme);
   };
   _acceptTermsOfUse = async () => {
     // @ts-ignore ts-migrate(1320) FIXME: Type of 'await' operand must either be a valid pro... Remove this comment to see the full error message