chore(suite-analytics): remove suite-analytics from common code

matejkriz · matejkriz · commit 6b819626b0c5 · 2024-11-08T14:54:17.000+01:00
diff --git a/packages/suite/src/middlewares/suite/analyticsMiddleware.ts b/packages/suite/src/middlewares/suite/analyticsMiddleware.ts
@@ -1,4 +1,5 @@
 import { MiddlewareAPI } from 'redux';
+import { isAnyOf } from '@reduxjs/toolkit';
 
 import { BigNumber } from '@trezor/utils/src/bigNumber';
 import { getPhysicalDeviceCount } from '@suite-common/suite-utils';
@@ -7,6 +8,11 @@ import {
     selectDevices,
     selectDevicesCount,
     authorizeDeviceThunk,
+    deviceActions,
+    firmwareActions,
+    handleFwHashError,
+    INVALID_HASH_ERROR,
+    firmwareUpdate,
 } from '@suite-common/wallet-core';
 import { analytics, EventType } from '@trezor/suite-analytics';
 import { TRANSPORT, DEVICE } from '@trezor/connect';
@@ -56,6 +62,34 @@ const analyticsMiddleware =
             });
         }
 
+        if (handleFwHashError.fulfilled.match(action)) {
+            analytics.report({
+                type: EventType.FirmwareValidateHashError,
+                payload: {
+                    error: action.meta.arg.errorMessage,
+                },
+            });
+        }
+
+        if (isAnyOf(firmwareUpdate.fulfilled, firmwareUpdate.rejected)(action)) {
+            const { device, toBtcOnly, toFwVersion, error = '' } = action.payload ?? {};
+
+            if (device?.features) {
+                analytics.report({
+                    type: EventType.DeviceUpdateFirmware,
+                    payload: {
+                        model: device.features.internal_model,
+                        fromFwVersion:
+                            device?.firmware === 'none' ? 'none' : getFirmwareVersion(device),
+                        fromBlVersion: getBootloaderVersion(device),
+                        error,
+                        toBtcOnly,
+                        toFwVersion,
+                    },
+                });
+            }
+        }
+
         switch (action.type) {
             case SUITE.READY:
                 // reporting can start when analytics is properly initialized and enabled
@@ -222,6 +256,24 @@ const analyticsMiddleware =
                 break;
             }
 
+            case deviceActions.rememberDevice.type: {
+                analytics.report({
+                    type: action.payload.remember
+                        ? EventType.SwitchDeviceRemember
+                        : EventType.SwitchDeviceForget,
+                });
+                break;
+            }
+
+            case firmwareActions.setFirmwareUpdateError.type: {
+                if (action.payload === INVALID_HASH_ERROR) {
+                    analytics.report({
+                        type: EventType.FirmwareValidateHashMismatch,
+                    });
+                }
+                break;
+            }
+
             default:
                 break;
         }
diff --git a/suite-common/wallet-core/package.json b/suite-common/wallet-core/package.json
@@ -32,7 +32,6 @@
         "@trezor/connect": "workspace:*",
         "@trezor/device-utils": "workspace:*",
         "@trezor/env-utils": "workspace:*",
-        "@trezor/suite-analytics": "workspace:*",
         "@trezor/type-utils": "workspace:*",
         "@trezor/utils": "workspace:*",
         "date-fns": "^2.30.0",
diff --git a/suite-common/wallet-core/src/device/deviceThunks.ts b/suite-common/wallet-core/src/device/deviceThunks.ts
@@ -11,7 +11,6 @@ import TrezorConnect, {
     DeviceState,
 } from '@trezor/connect';
 import { TrezorDevice } from '@suite-common/suite-types';
-import { analytics, EventType } from '@trezor/suite-analytics';
 import { notificationsActions } from '@suite-common/toast-notifications';
 import {
     sortByTimestamp,
@@ -87,20 +86,15 @@ export const selectDeviceThunk = createThunk<void, SelectDeviceThunkParams, void
  */
 export const toggleRememberDevice = createThunk(
     `${DEVICE_MODULE_PREFIX}/toggleRememberDevice`,
-    ({ device, forceRemember }: { device: TrezorDevice; forceRemember?: true }, { dispatch }) => {
-        analytics.report({
-            type: device.remember ? EventType.SwitchDeviceForget : EventType.SwitchDeviceRemember,
-        });
-
-        return dispatch(
+    ({ device, forceRemember }: { device: TrezorDevice; forceRemember?: true }, { dispatch }) =>
+        dispatch(
             deviceActions.rememberDevice({
                 device,
                 remember: !device.remember || !!forceRemember,
                 // if device is already remembered, do not force it, it would remove the remember on return to suite
                 forceRemember: device.remember ? undefined : forceRemember,
             }),
-        );
-    },
+        ),
 );
 
 export type CreateDeviceInstanceError = {
diff --git a/suite-common/wallet-core/src/firmware/firmwareThunks.ts b/suite-common/wallet-core/src/firmware/firmwareThunks.ts
@@ -1,10 +1,4 @@
-import {
-    getBootloaderVersion,
-    getFirmwareVersion,
-    hasBitcoinOnlyFirmware,
-    isBitcoinOnlyDevice,
-} from '@trezor/device-utils';
-import { analytics, EventType } from '@trezor/suite-analytics';
+import { hasBitcoinOnlyFirmware, isBitcoinOnlyDevice } from '@trezor/device-utils';
 import TrezorConnect, { FirmwareType } from '@trezor/connect';
 import { createThunk } from '@suite-common/redux-utils';
 import { TrezorDevice } from '@suite-common/suite-types';
@@ -13,7 +7,7 @@ import { selectFirmware } from './firmwareReducer';
 import { FIRMWARE_MODULE_PREFIX, firmwareActions } from './firmwareActions';
 import { getBinFilesBaseUrlThunk } from './getBinFilesBaseUrlThunk';
 
-const handleFwHashError = createThunk(
+export const handleFwHashError = createThunk(
     `${FIRMWARE_MODULE_PREFIX}/handleFwHashError`,
     ({ device, errorMessage }: { device: TrezorDevice; errorMessage: string }, { dispatch }) => {
         // device.id should always be present here (device is initialized and in normal mode) during successful TrezorConnect.getFirmwareHash call
@@ -25,12 +19,6 @@ const handleFwHashError = createThunk(
                 `${errorMessage}. Unable to validate firmware hash. If you want to check authenticity of newly installed firmware please proceed to device settings and reinstall firmware.`,
             ),
         );
-        analytics.report({
-            type: EventType.FirmwareValidateHashError,
-            payload: {
-                error: errorMessage,
-            },
-        });
     },
 );
 
@@ -44,9 +32,6 @@ const handleFwHashMismatch = createThunk(
             dispatch(firmwareActions.setHashInvalid(device.id));
         }
         dispatch(firmwareActions.setFirmwareUpdateError(INVALID_HASH_ERROR));
-        analytics.report({
-            type: EventType.FirmwareValidateHashMismatch,
-        });
     },
 );
 
@@ -62,11 +47,27 @@ const handleFwHashValid = createThunk(
     },
 );
 
-export const firmwareUpdate = createThunk(
+type FirmwareUpdateProps = {
+    firmwareType?: FirmwareType;
+    binary?: ArrayBuffer;
+};
+
+type FirmwareUpdateResult = {
+    device?: TrezorDevice;
+    toFwVersion?: string;
+    toBtcOnly?: boolean;
+    error?: string;
+};
+
+export const firmwareUpdate = createThunk<
+    FirmwareUpdateResult,
+    FirmwareUpdateProps,
+    { rejectValue: FirmwareUpdateResult }
+>(
     `${FIRMWARE_MODULE_PREFIX}/firmwareUpdate`,
     async (
-        { firmwareType, binary }: { firmwareType?: FirmwareType; binary?: ArrayBuffer },
-        { dispatch, getState, extra },
+        { firmwareType, binary },
+        { dispatch, getState, extra, fulfillWithValue, rejectWithValue },
     ) => {
         dispatch(firmwareActions.setStatus('started'));
 
@@ -92,7 +93,9 @@ export const firmwareUpdate = createThunk(
             dispatch(firmwareActions.setStatus('error'));
             dispatch(firmwareActions.setFirmwareUpdateError('Device not connected'));
 
-            return;
+            return rejectWithValue({
+                error: 'Device not connected',
+            });
         }
 
         // Cache device when firmware installation starts so that we can reference the original firmware version and type during the installation process.
@@ -130,32 +133,22 @@ export const firmwareUpdate = createThunk(
             language: device.firmware === 'none' ? targetTranslationLanguage : undefined,
         });
 
-        // condition to satisfy TS
-        if (device.features) {
-            const targetProperties = binary
-                ? {}
-                : {
-                      toFwVersion: device?.firmwareRelease?.release.version.join('.'),
-                      toBtcOnly: toBitcoinOnlyFirmware,
-                  };
-            analytics.report({
-                type: EventType.DeviceUpdateFirmware,
-                payload: {
-                    model: device.features.internal_model,
-                    fromFwVersion:
-                        device?.firmware === 'none' ? 'none' : getFirmwareVersion(device),
-                    fromBlVersion: getBootloaderVersion(device),
-                    error: !firmwareUpdateResponse.success
-                        ? firmwareUpdateResponse.payload.error
-                        : '',
-                    ...targetProperties,
-                },
-            });
-        }
+        const targetProperties = binary
+            ? {}
+            : {
+                  toFwVersion: device?.firmwareRelease?.release.version.join('.'),
+                  toBtcOnly: toBitcoinOnlyFirmware,
+              };
 
         if (!firmwareUpdateResponse.success) {
             dispatch(firmwareActions.setStatus('error'));
             dispatch(firmwareActions.setFirmwareUpdateError(firmwareUpdateResponse.payload.error));
+
+            return rejectWithValue({
+                device,
+                error: firmwareUpdateResponse.payload.error,
+                ...targetProperties,
+            });
         } else {
             const { check } = firmwareUpdateResponse.payload;
             if (check === 'mismatch') {
@@ -172,6 +165,11 @@ export const firmwareUpdate = createThunk(
             } else {
                 dispatch(handleFwHashValid(device));
             }
+
+            return fulfillWithValue({
+                device,
+                ...targetProperties,
+            });
         }
     },
 );
diff --git a/suite-common/wallet-core/tsconfig.json b/suite-common/wallet-core/tsconfig.json
@@ -24,9 +24,6 @@
         { "path": "../../packages/connect" },
         { "path": "../../packages/device-utils" },
         { "path": "../../packages/env-utils" },
-        {
-            "path": "../../packages/suite-analytics"
-        },
         { "path": "../../packages/type-utils" },
         { "path": "../../packages/utils" }
     ]
diff --git a/yarn.lock b/yarn.lock
@@ -9207,7 +9207,6 @@ __metadata:
     "@trezor/connect": "workspace:*"
     "@trezor/device-utils": "workspace:*"
     "@trezor/env-utils": "workspace:*"
-    "@trezor/suite-analytics": "workspace:*"
     "@trezor/type-utils": "workspace:*"
     "@trezor/utils": "workspace:*"
     date-fns: "npm:^2.30.0"
