dev: Improve Sentry reporting (#2247)

With the new v3.x major version of Sentry, we can easily improve our
reporting via our client setup.

We will now include the Sentry preload script in our persisting
session partition which could help capture request errors.
We also add 2 integrations:
- ElectronMinidump which should offer better crash dumps than the
  default SentryMinidump integration (especially since we've uploaded
  the Electron debug symbols corresponding to the version we're using)
- ExtraErrorData whichi will extract all custom attributes from our
  errors and attach them as `extra` info. For this reason, we will
  stop attaching log messages' attributes via `setExtra` and use a
  scope context instead

core/app.js

@@ -31,7 +31,6 @@ const SyncState = require('./syncstate')
 const Registration = require('./remote/registration')
 const logger = require('./utils/logger')
 const { LOG_FILE, LOG_FILENAME } = logger
-const sentry = require('./utils/sentry')
 const { sendToTrash } = require('./utils/fs')
 const notes = require('./utils/notes')
 const web = require('./utils/web')
@@ -356,8 +355,6 @@ class App {
     const clientInfo = this.clientInfo()
     log.info(clientInfo, 'user config')
 
-    sentry.setup(clientInfo)
-
     if (!this.config.isValid()) {
       throw new config.InvalidConfigError()
     }

core/utils/sentry.js

@@ -2,19 +2,34 @@
  *
  * @module core/utils/sentry
  * @flow
+ *
+ * Setup our Sentry integration to send errors and crash reports to our Sentry
+ * server.
+ *
+ * Follow these steps to upload Electron debug symbols after each version
+ * upgrade:
+ *
+ * 1. `sentry-wizard --skip-connect -u <server url> --integration electron
+ * 2. Follow the steps (auth tokens can be generated here: https://<server url>/settings/account/api/auth-tokens/)
+ * 3. `node sentry-symbols.js`
  */
 
+const { session } = require('electron')
 const Sentry = require('@sentry/electron')
+const {
+  ExtraErrorData: ExtraErrorDataIntegration
+} = require('@sentry/integrations')
 const bunyan = require('bunyan')
 const url = require('url')
+const _ = require('lodash')
 
+const { SESSION_PARTITION_NAME } = require('../../gui/js/proxy')
 const logger = require('./logger')
+
 const log = logger({
   component: 'Sentry'
 })
 
-const _ = require('lodash')
-
 module.exports = {
   setup,
   flag,
@@ -57,7 +72,27 @@ function setup(clientInfos /*: ClientInfo */) {
     Sentry.init({
       dsn: SENTRY_DSN,
       release: appVersion,
-      environment
+      environment,
+      // Inject preload script into all used sessions
+      getSessions: () => [
+        session.defaultSession,
+        session.fromPartition(SESSION_PARTITION_NAME)
+      ],
+      // Adding the ElectronMinidump integration like this
+      // ensures that it is the first integrations to be initialized.
+      integrations: defaultIntegrations => {
+        return [
+          // Uploads minidumps via Crashpad/Breakpad built in uploader with
+          // partial context when reporting native crash.
+          new Sentry.Integrations.ElectronMinidump(),
+          // Extract all non-native attributes up to <depth> from Error objects
+          // and attach them to events as extra data.
+          // If the error object has a .toJSON() method, it will be run to
+          // extract the additional data.
+          new ExtraErrorDataIntegration({ depth: 10 }),
+          ...defaultIntegrations
+        ]
+      }
     })
     Sentry.configureScope(scope => {
       scope.setUser({ username: instance })
@@ -115,10 +150,9 @@ const handleBunyanMessage = msg => {
 
     Sentry.withScope(scope => {
       scope.setLevel(level)
-      scope.setExtras(extra)
+      scope.setContext('msgDetails', extra)
 
       if (msg.err) {
-        if (msg.err.reason) scope.setExtra('reason', msg.err.reason)
         Sentry.captureException(format(msg.err))
       } else {
         Sentry.captureMessage(msg.msg)

gui/js/proxy.js

@@ -10,7 +10,8 @@ const http = require('http')
 const https = require('https')
 const yargs = require('yargs')
 
-const log = require('../../core/app').logger({
+const logger = require('../../core/utils/logger')
+const log = logger({
   component: 'GUI:proxy'
 })
 

gui/main.js

@@ -2,9 +2,17 @@
 
 // Initialize `remote` module so that renderer processes can use it.
 require('@electron/remote/main').initialize()
-const { app, Menu, Notification, ipcMain, dialog } = require('electron')
+const {
+  app,
+  Menu,
+  Notification,
+  ipcMain,
+  dialog,
+  session
+} = require('electron')
 
 const Desktop = require('../core/app.js')
+const sentry = require('../core/utils/sentry')
 const { openNote } = require('./utils/notes')
 const pkg = require('../package.json')
 
@@ -57,7 +65,9 @@ if (!mainInstance && !process.env.COZY_DESKTOP_PROPERTY_BASED_TESTING) {
   app.exit()
 }
 
-let desktop
+let desktop = new Desktop.App(process.env.COZY_DESKTOP_DIR)
+sentry.setup(desktop.clientInfo())
+
 let diskTimeout = null
 let onboardingWindow = null
 let helpWindow = null
@@ -565,26 +575,11 @@ app.on('ready', async () => {
     app.dock.hide()
   }
 
-  const { session } = require('electron')
-
   const hostID = (dumbhash(os.hostname()) % 4096).toString(16)
   let userAgent = `Cozy-Desktop-${process.platform}-${pkg.version}-${hostID}`
   await proxy.setup(app, proxy.config(), session, userAgent)
   log.info('Loading CLI...')
   i18n.init(app)
-  try {
-    desktop = new Desktop.App(process.env.COZY_DESKTOP_DIR)
-  } catch (err) {
-    if (err.message.match(/GLIBCXX/)) {
-      await dialog.showMessageBox(null, {
-        type: 'error',
-        message: translate('Error Bad GLIBCXX version'),
-        buttons: [translate('AppMenu Close')]
-      })
-      await exit(0)
-      return
-    } else throw err
-  }
 
   const { argv } = process
 

package.json

@@ -82,7 +82,8 @@
     "@babel/runtime": "7.16.7",
     "@electron/remote": "2.0.8",
     "@parcel/watcher": "https://github.com/taratatach/parcel-watcher.git#v3.0.0",
-    "@sentry/electron": "2.5.4",
+    "@sentry/electron": "3.0.7",
+    "@sentry/integrations": "7.5.1",
     "async": "3.2.3",
     "auto-bind": "4.0.0",
     "auto-launch": "^5.0.3",
@@ -126,6 +127,7 @@
   },
   "devDependencies": {
     "@babel/core": "7.16.7",
+    "@sentry/cli": "^2.3.0",
     "babel-preset-cozy-app": "^2.0.1",
     "chai": "4.3.4",
     "chai-like": "1.1.1",
@@ -139,6 +141,7 @@
     "devtron": "^1.4.0",
     "electron": "19.0.0",
     "electron-builder": "^22.8.1",
+    "electron-download": "^4.1.1",
     "electron-mocha": "11.0.2",
     "electron-notarize": "^0.1.1",
     "elm": "^0.19.1",