Merge pull request #2022 from bugsnag/PLAT-10961/electron-linux-crash

Fix Electron Linux crash
bugsnag · Oct 11, 2023 · 775699d · 775699d
2 parents 86e96f9 + 02e7bad
commit 775699d
Show file tree

Hide file tree

Showing 8 changed files with 52 additions and 130 deletions.
diff --git a/.github/workflows/test-electron.yml b/.github/workflows/test-electron.yml
@@ -8,9 +8,9 @@ jobs:
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
-        electron: [ '^12.0.0', '^20.0.0' ]
+        electron: [ '^12.0.0', '^20.0.0', '^25.0.0', '^26.0.0' ]
         node-version: [12, 14]
-        os: [ ubuntu-20.04, windows-2019 ]
+        os: [ ubuntu-22.04, windows-2019 ]
 
     steps:
     - uses: actions/checkout@v2

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,11 @@
 # Changelog
 
+## TBD
+
+### Fixed
+
+- (electron) Fix startup crash when using Electron v26+ on Linux [#2022](https://github.com/bugsnag/bugsnag-js/pull/2022)
+
 ## 7.22.0 (2023-09-13)
 
 ### Changes

diff --git a/packages/electron/src/client/test/client.test-main.ts b/packages/electron/src/client/test/client.test-main.ts
diff --git a/packages/electron/test/notifier.test-main.ts b/packages/electron/test/notifier.test-main.ts
diff --git a/packages/electron/test/notifier.test-renderer.ts b/packages/electron/test/notifier.test-renderer.ts
diff --git a/packages/plugin-electron-device/device.js b/packages/plugin-electron-device/device.js
@@ -45,15 +45,49 @@ module.exports = (app, screen, process, filestore, NativeClient, powerMonitor) =
       }
     })
 
-    client.addMetadata('device', {
-      // the value for 'idleThreshold' doesn't matter here because it is ignored
-      // if the system is locked and that's the only state we care about
-      isLocked: powerMonitor.getSystemIdleState(1) === 'locked',
-      // note: this is only available from Electron 12, earlier versions cannot
-      // read the battery state without 'on-ac'/'on-battery' events
-      usingBattery: powerMonitor.onBatteryPower
+    app.whenReady().then(() => {
+      client.addMetadata('device', {
+        // the value for 'idleThreshold' doesn't matter here because it is ignored
+        // if the system is locked and that's the only state we care about
+        isLocked: powerMonitor.getSystemIdleState(1) === 'locked',
+        // note: this is only available from Electron 12, earlier versions cannot
+        // read the battery state without 'on-ac'/'on-battery' events
+        usingBattery: powerMonitor.onBatteryPower
+      })
+
+      powerMonitor.on('on-ac', () => {
+        client.addMetadata('device', { usingBattery: false })
+      })
+
+      powerMonitor.on('on-battery', () => {
+        client.addMetadata('device', { usingBattery: true })
+      })
+
+      powerMonitor.on('unlock-screen', () => {
+        client.addMetadata('device', { isLocked: false })
+      })
+
+      powerMonitor.on('lock-screen', () => {
+        client.addMetadata('device', { isLocked: true })
+      })
     })
 
+    client.addOnError(event => {
+      event.device = Object.assign(
+        {},
+        event.device,
+        device,
+        {
+          freeMemory: kibibytesToBytes(process.getSystemMemoryInfo().free),
+          time: new Date()
+        }
+      )
+
+      event.addMetadata('device', { idleTime: powerMonitor.getSystemIdleTime() })
+
+      setDefaultUserId(event)
+    }, true)
+
     app.whenReady().then(() => {
       // on windows, app.getLocale won't return the locale until the app is ready
       const locale = app.getLocale()
@@ -88,38 +122,6 @@ module.exports = (app, screen, process, filestore, NativeClient, powerMonitor) =
       })
     })
 
-    powerMonitor.on('on-ac', () => {
-      client.addMetadata('device', { usingBattery: false })
-    })
-
-    powerMonitor.on('on-battery', () => {
-      client.addMetadata('device', { usingBattery: true })
-    })
-
-    powerMonitor.on('unlock-screen', () => {
-      client.addMetadata('device', { isLocked: false })
-    })
-
-    powerMonitor.on('lock-screen', () => {
-      client.addMetadata('device', { isLocked: true })
-    })
-
-    client.addOnError(event => {
-      event.device = Object.assign(
-        {},
-        event.device,
-        device,
-        {
-          freeMemory: kibibytesToBytes(process.getSystemMemoryInfo().free),
-          time: new Date()
-        }
-      )
-
-      event.addMetadata('device', { idleTime: powerMonitor.getSystemIdleTime() })
-
-      setDefaultUserId(event)
-    }, true)
-
     client.addOnSession(session => {
       session.device = Object.assign(
         {},

diff --git a/scripts/cppcheck.sh b/scripts/cppcheck.sh
@@ -17,8 +17,9 @@ SUPPRESSED_ERRORS=(\
     --suppress='unusedVariable:*/deps/*' \
     --suppress='variableScope:*/deps/*' \
     --suppress='ConfigurationNotChecked:*/deps/parson/parson.c:1425' \
-    --suppress='knownConditionTrueFalse:*/deps/parson/parson.c:692' \
+    --suppress='knownConditionTrueFalse:*/deps/parson/parson.c:600' \
     --suppress='memleak:*/plugin-electron-client-state-persistence/src/deps/tinycthread/tinycthread.c:620' \
+    --suppress='constParameter:*/plugin-electron-client-state-persistence/src/deps/tinycthread/tinycthread.c:591' \
     --suppress='unusedFunction:*/plugin-electron-client-state-persistence/src/api.c:513' \
     --suppress='unusedFunction:*/plugin-electron-app/src/api.c:60')
 

diff --git a/test/electron/features/support/steps/request-steps.js b/test/electron/features/support/steps/request-steps.js
@@ -5,7 +5,7 @@ const { readFixtureFile } = require('../utils')
 const expect = require('../utils/expect')
 const { applySourcemaps } = require('../utils/source-mapper')
 
-const REQUEST_RESOLUTION_TIMEOUT = 3000
+const REQUEST_RESOLUTION_TIMEOUT = 5000
 const launchConfig = { timeout: 30 * 1000 }
 const requestDelay = (callback) => new Promise((resolve, reject) => {
   setTimeout(() => callback(resolve), REQUEST_RESOLUTION_TIMEOUT)