Mirrors/trezor-suite
2
0
Fork 0
mirror of https://github.com/trezor/trezor-suite.git synced 2026-03-09 08:48:15 +01:00
Code Issues Packages Projects Releases Wiki Activity

feat(connect): send analytics data from connect core

Browse Source
This commit is contained in:
tomasklim
2022-10-31 14:37:01 +01:00
committed by Tomáš Klíma
parent cccc502813
commit f7b5e27ce7
18 changed files with 110 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
packages/connect-analytics/src/constants.ts
View File

@@ -1,4 +1,5 @@
export enum EventType {
AppReady = 'app/ready',
SettingsTracking = 'settings/tracking',
}

26
packages/connect-analytics/src/types/events.ts
View File

@@ -1,8 +1,28 @@
import { EventType } from '../constants';
export type ConnectAnalyticsEvent = {
type: EventType.SettingsTracking;
export type EventTypeDeviceSelected = {
type: EventType.DeviceSelected;
payload: {
value: boolean;
mode: 'normal' | 'bootloader' | 'initialize' | 'seedless';
pinProtection: boolean | '';
passphraseProtection: boolean | '';
backupType: string;
language: string;
model: string;
vendor: string;
firmware: string;
firmwareRevision: string;
firmwareType: string;
bootloaderHash: string;
bootloaderVersion: string;
};
};
export type ConnectAnalyticsEvent =
| EventTypeDeviceSelected
| {
type: EventType.SettingsTracking;
payload: {
value: boolean;
};
};

1
packages/connect-popup/package.json
View File

@@ -13,6 +13,7 @@
"dependencies": {
"@trezor/components": "*",
"@trezor/connect": "9.0.4",
"@trezor/connect-analytics": "*",
"@trezor/connect-ui": "*",
"@trezor/crypto-utils": "*",
"@trezor/urls": "*"

10
packages/connect-popup/src/index.tsx
View File

@@ -10,6 +10,7 @@ import {
PopupHandshake,
} from '@trezor/connect';
import { reactEventBus } from '@trezor/connect-ui/src/utils/eventBus';
import { analytics, EventType } from '@trezor/connect-analytics';
import * as view from './view';
import {
@@ -75,6 +76,15 @@ const handleMessage = (event: MessageEvent<PopupEvent | UiEvent>) => {
const message = parseMessage(data);
if (
message?.payload &&
typeof message.payload === 'object' &&
'analytics' in message.payload &&
message.payload.analytics
) {
analytics.report(message.payload.analytics);
}
console.log('message.type', message.type);
console.log('message', message);
switch (message.type) {

1
packages/connect-popup/tsconfig.json
View File

@@ -8,6 +8,7 @@
"references": [
{ "path": "../components" },
{ "path": "../connect" },
{ "path": "../connect-analytics" },
{ "path": "../connect-ui" },
{ "path": "../crypto-utils" },
{ "path": "../urls" },

1
packages/connect-ui/src/utils/analytics.ts
View File

@@ -42,5 +42,6 @@ export const initAnalytics = () => {
onEnable,
onDisable,
},
useQueue: true,
});
};

4
packages/connect/CHANGELOG.md
View File

@@ -1,3 +1,7 @@
# 9.0.5 - UNRELEASED
- introduction of connect analytics
# 9.0.4
- @trezor/blockchain-link 2.1.5

2
packages/connect/package.json
View File

@@ -47,7 +47,9 @@
},
"dependencies": {
"@trezor/blockchain-link": "^2.1.5",
"@trezor/connect-analytics": "*",
"@trezor/connect-common": "0.0.10",
"@trezor/device-utils": "*",
"@trezor/transport": "^1.1.5",
"@trezor/utils": "^9.0.3",
"@trezor/utxo-lib": "^1.0.1",

4
packages/connect/src/core/index.ts
View File

@@ -2,6 +2,7 @@
import EventEmitter from 'events';
import { DataManager } from '../data/DataManager';
import { DeviceList } from '../device/DeviceList';
import { enhancePostMessageWithAnalytics } from '../data/analyticsInfo';
import { ERRORS } from '../constants';
@@ -361,6 +362,9 @@ export const onCall = async (message: CoreMessage) => {
throw error;
}
method.postMessage = (message: CoreMessage) =>
enhancePostMessageWithAnalytics(postMessage, message, { device });
method.setDevice(device);
// find pending calls to this device

52
packages/connect/src/data/analyticsInfo.ts Normal file
View File

@@ -0,0 +1,52 @@
/* eslint-disable no-case-declarations */
import { EventType } from '@trezor/connect-analytics';
import {
getBootloaderHash,
getBootloaderVersion,
getDeviceMode,
getDeviceModel,
getFirmwareRevision,
getFirmwareType,
getFirmwareVersion,
} from '@trezor/device-utils';
import { CoreMessage, UI_REQUEST } from '../events';
import type { Device } from '../device/Device';
export const enhancePostMessageWithAnalytics = (
callback: (message: CoreMessage) => void,
message: CoreMessage,
data: { device?: Device },
) => {
switch (message.type) {
case UI_REQUEST.REQUEST_CONFIRMATION:
const { device } = data;
callback({
...message,
payload: {
...message.payload,
analytics: {
type: EventType.DeviceSelected,
payload: {
mode: getDeviceMode(device),
pinProtection: device?.features.pin_protection || '',
passphraseProtection: device?.features.passphrase_protection || '',
backupType: device?.features.backup_type || 'Bip39',
language: device?.features.language || '',
model: getDeviceModel(device),
vendor: device?.features.vendor || '',
firmware: getFirmwareVersion(device),
firmwareRevision: getFirmwareRevision(device),
firmwareType: getFirmwareType(device),
bootloaderHash: getBootloaderHash(device),
bootloaderVersion: getBootloaderVersion(device),
},
},
},
});
break;
default:
callback(message);
}
};

2
packages/connect/src/events/ui-request.ts
View File

@@ -1,6 +1,7 @@
/*
* messages to UI emitted as UI_EVENT
*/
import type { EventTypeDeviceSelected } from '@trezor/connect-analytics';
import type { PROTO } from '../constants';
import type { TransportDisableWebUSB } from './transport';
@@ -172,6 +173,7 @@ export interface UiRequestConfirmation {
className: string;
label: string;
};
analytics?: EventTypeDeviceSelected;
};
}

2
packages/connect/tsconfig.json
View File

@@ -4,7 +4,9 @@
"include": ["../../submodules/trezor-common"],
"references": [
{ "path": "../blockchain-link" },
{ "path": "../connect-analytics" },
{ "path": "../connect-common" },
{ "path": "../device-utils" },
{ "path": "../transport" },
{ "path": "../utils" },
{ "path": "../utxo-lib" },

5
packages/device-utils/src/modelUtils.ts
View File

@@ -1,6 +1,3 @@
import { PartialDevice } from './types';
export const getDeviceModel = (device: PartialDevice): 'T' | '1' => {
const { features } = device;
return typeof features?.major_version === 'number' && features?.major_version > 1 ? 'T' : '1';
};
export const getDeviceModel = (device?: PartialDevice) => device?.features?.model || '';

1
packages/device-utils/src/types/index.ts
View File

@@ -13,6 +13,7 @@ export type PartialDevice = Partial<{
fw_patch: number | null;
initialized: boolean | null;
no_backup: boolean | null;
model: string | null;
};
firmwareType: string | null;
}>;

2
packages/suite-analytics/src/types/events.ts
View File

@@ -79,7 +79,7 @@ export type SuiteAnalyticsEvent =
type: EventType.DeviceSetupCompleted;
payload: Partial<Omit<OnboardingAnalytics, 'startTime'>> & {
duration: number;
device: 'T' | '1';
device: string;
};
}
| {

3
packages/suite/src/components/suite/images/DeviceConfirmImage.tsx
View File

@@ -4,12 +4,11 @@ import { Image, ImageProps } from '@trezor/components';
import { ImageType } from '@trezor/components/src/components/Image/Image';
import { getDeviceModel } from '@trezor/device-utils';
const getImage = (majorVersion: '1' | 'T'): ImageType => {
const getImage = (majorVersion: string): ImageType => {
switch (majorVersion) {
case '1':
return 'ONE_DEVICE_CONFIRM';
case 'T':
return 'T_DEVICE_CONFIRM';
default:
return 'T_DEVICE_CONFIRM';
}

9
packages/suite/src/utils/suite/__fixtures__/device.ts
View File

@@ -164,17 +164,12 @@ const isSelectedInstance = [
const getDeviceModel = [
{
description: `model T`,
device: SUITE_DEVICE,
device: getSuiteDevice(undefined, { model: 'T' }),
result: 'T',
},
{
description: `model One`,
device: getSuiteDevice(undefined, { major_version: 1 }),
result: '1',
},
{
description: `model One (no features)`,
device: getSuiteDevice({ type: 'unacquired' }),
device: getSuiteDevice(undefined, { model: '1' }),
result: '1',
},
];

2
packages/suite/src/views/recovery/index.tsx
View File

@@ -92,7 +92,7 @@ export const Recovery = ({ onCancel }: ForegroundAppProps) => {
actions.checkSeed();
};
const model = device ? getDeviceModel(device) : 'T';
const model = device && getDeviceModel(device) === '1' ? '1' : 'T';
const learnMoreUrl = getCheckBackupUrl(device);
const isModelOne = model === '1';
const statesInProgressBar = isModelOne