@bugsnag/electron - Unable to package app as an Apple Silicon Universal build

[JordanDC2]

Describe the bug

When building my app targeting either arm64 or x64, everything turns out totally fine. However, when targeting a Universal .dmg, it appears that some of bugsnag's native modules, when rebuilt, do not map appropriately. During the build process (specifically electron-forge publish --dry-run --arch universal), the following error appears in the Generating multi-arch bundles > Generating x64 bundle > Mapping native dependencies step:

An unhandled rejection has occurred inside Forge:
Error: The "main/native_modules/build/Release/bugsnag_pecsp_bindings.node" mapped to multiple modules "/Users/jordanchristiansen/<my-app>/node_modules/@bugsnag/plugin-electron-client-state-persistence/bin/darwin-arm64-136/plugin-electron-client-state-persistence.node, /Users/jordanchristiansen/<my-app>/node_modules/@bugsnag/plugin-electron-client-state-persistence/build/Release/bugsnag_pecsp_bindings.node" but the same modules post rebuild did not map to the same native code
at _Task.task [as taskFn] (/Users/jordanchristiansen/<my-app>/node_modules/@electron-forge/plugin-webpack/dist/WebpackPlugin.js:395:71)
    at async _Task.run (/Users/jordanchristiansen/<my-app>/node_modules/listr2/dist/index.cjs:2063:11)

Steps to reproduce

1. Use the minimum setup for electron, forge, and bugsnag
2. add "package": "electron-forge package" to package.json scripts
3. add "make": "electron-forge make" to package.json scripts
4. add "publish": "electron-forge publish --dry-run --arch universal" to package.json scripts
5. run npm run publish
6. kaboom

Environment

• @bugsnag/electron version: 8.2.0
• @electron-forge/* version: 7.8.1
• webpack version: 5.100.2

[toniewypada]

Hi @JordanDC2 👋🏻,

we were able to reproduce the issue you’re seeing and we’re investigating if that’s an issue with our notifier or Electron Forge. Is this issue present since using Electron Forge v7.8.1, or have you noticed it with earlier versions of Forge?

[JordanDC2]

Hi @JordanDC2 👋🏻,

we were able to reproduce the issue you’re seeing and we’re investigating if that’s an issue with our notifier or Electron Forge. Is this issue present since using Electron Forge v7.8.1, or have you noticed it with earlier versions of Forge?

Thank you for looking into this! This is not an issue that I have tested on any other version of electron forge, as I only very recently added Bugsnag to the project, then found that my builds no longer work because of this error. I have not used Bugsnag with any other version of forge, but I have used many other versions of forge independent of Bugsnag and have not had issues running universal darwin builds.

[toniewypada]

Hi @JordanDC2 , thanks for confirmation.

I’ve investigated this further and managed to solve the problem using Electron Rebuild package. It should be included in Forge by default, and you use it to recompile native Node modules, so they match your Electron version and the target CPU architecture (so prevents mismatch/incompatible arch crashes).

To implement this solution, you’d need to configure Forge to rebuild only the two BugSnag native modules which are causing the issue, so @bugsnag/plugin-electron-client-state-persistence and @bugsnag/plugin-electron-app. When configuring rebuildConfig you can specify which modules to rebuild using onlyModules option (you can check all the available options here).

Then you can add a packageAfterCopy hook (described here) to delete any prebuilt native artifacts for the BugSnag plugins (folders typically named bin/ or prebuilds/ inside packages). Once that’s done, Forge rebuild package can rebuild the plugins for specific arch against the staged buildPath.

Please let us know if you need further assistance with Electron. If you don’t want to share any details of your config/app in the public GitHub issue, feel free to contact us at support@bugsnag.com.

[JordanDC2]

Thank you for looking into this issue!

It seems to me that the electron rebuild config was all that was needed. Adding the following to my forge.config.js was sufficient to solve the issue:

"rebuildConfig": {
	"onlyModules": [ "@bugsnag/plugin-electron-client-state-persistence", "@bugsnag/plugin-electron-app" ]
},

Was there some issue you had that required the use of the packageAfterCopy hook?

[toniewypada]

@JordanDC2 , I’ve added the packageAfterCopy hook while testing to avoid errors caused by old prebuilt artifacts, it simplified the process for me 🙂