feat(suite-deskop): electron/sentry integration

trezor · Feb 24, 2022 · 90e95bd · 90e95bd
1 parent f2be761
commit 90e95bd
Show file tree

Hide file tree

Showing 4 changed files with 33 additions and 2 deletions.
diff --git a/packages/suite-build/configs/base.webpack.config.ts b/packages/suite-build/configs/base.webpack.config.ts
@@ -20,6 +20,11 @@ import { getPathForProject } from '../utils/path';
 import { suiteVersion } from '../../suite/package.json';
 
 const gitRevision = getRevision();
+
+/**
+ * Assemble release name for Sentry
+ * Same definition is in packages/suite-desktop/scripts/build.js
+ */
 const sentryRelease = `${suiteVersion}.${project}${
     isCodesignBuild ? '.codesign' : ''
 }.${gitRevision}`;

diff --git a/packages/suite-desktop/scripts/build.js b/packages/suite-desktop/scripts/build.js
@@ -6,7 +6,8 @@ const { build } = require('esbuild');
 const pkg = require('../package.json');
 const { suiteVersion } = require('../../suite/package.json');
 
-const { NODE_ENV, USE_MOCKS } = process.env;
+const { NODE_ENV, USE_MOCKS, IS_CODESIGN_BUILD } = process.env;
+const PROJECT = 'desktop';
 
 const electronSource = path.join(__dirname, '..', 'src-electron');
 const isDev = NODE_ENV !== 'production';
@@ -15,6 +16,15 @@ const useMocks = USE_MOCKS === 'true' || (isDev && USE_MOCKS !== 'false');
 // Get git revision
 const gitRevision = childProcess.execSync('git rev-parse HEAD').toString().trim();
 
+/**
+ * Assemble release name for Sentry
+ * Same definition is in packages/suite-build/configs/base.webpack.config.ts,
+ * but reusing is not straightforward because this is JS script run by Node during build.
+ */
+const sentryRelease = `${suiteVersion}.${PROJECT}${
+    IS_CODESIGN_BUILD === 'true' ? '.codesign' : ''
+}.${gitRevision}`;
+
 // Get all modules (used as entry points)
 const modulePath = path.join(electronSource, 'modules');
 const modules = glob.sync(`${modulePath}/**/*.ts`).map(m => `modules${m.replace(modulePath, '')}`);
@@ -69,6 +79,8 @@ build({
         'process.env.PROTOCOLS': JSON.stringify(pkg.build.protocols.schemes),
         'process.env.PKGNAME': JSON.stringify(pkg.name),
         'process.env.VERSION': JSON.stringify(suiteVersion),
+        'process.env.SENTRY_RELEASE': JSON.stringify(sentryRelease),
+        'process.env.SUITE_TYPE': JSON.stringify(PROJECT),
     },
     inject: [path.join(__dirname, 'build-inject.js')],
     plugins: useMocks ? [mockPlugin] : [],

diff --git a/packages/suite-desktop/src-electron/app.ts b/packages/suite-desktop/src-electron/app.ts
@@ -1,7 +1,9 @@
 import path from 'path';
 import url from 'url';
-import { app, BrowserWindow, ipcMain } from 'electron';
+import { app, BrowserWindow, ipcMain, session } from 'electron';
+import { init as initSentry, ElectronOptions, IPCMode } from '@sentry/electron';
 
+import { SENTRY_CONFIG } from '@suite-config';
 import { isDev } from '@suite-utils/build';
 import { PROTOCOL } from './libs/constants';
 import * as store from './libs/store';
@@ -140,3 +142,13 @@ ipcMain.on('app/restart', () => {
     app.relaunch();
     app.exit();
 });
+
+if (!isDev) {
+    const sentryConfig: ElectronOptions = {
+        ...SENTRY_CONFIG,
+        ipcMode: IPCMode.Classic,
+        getSessions: () => [session.defaultSession],
+    };
+
+    initSentry(sentryConfig);
+}
diff --git a/packages/suite-desktop/src-electron/modules/request-filter.ts b/packages/suite-desktop/src-electron/modules/request-filter.ts
@@ -1,6 +1,7 @@
 /**
  * Request Filter feature (blocks non-allowed requests)
  */
+import { captureMessage, Severity } from '@sentry/electron';
 import { allowedDomains } from '../config';
 import { Module } from './index';
 
@@ -31,6 +32,7 @@ const init: Module = ({ interceptor }) => {
             'request-filter',
             `${details.url} was blocked because ${hostname} is not in the exception list`,
         );
+        captureMessage(`request-filter: ${hostname}`, Severity.Warning);
         return { cancel: true };
     });
 };