✅ Update to electron 12 for native wayland support

benjamb · May 28, 2021, 12:39pm

Feature name

Native wayland support (not a feature per se)

Feature function

Bitwarden desktop app will run natively on wayland
What benefits will this feature bring?
- better dpi scaling
- no tearing
- multi-touch gestures
- in theory lower footprint

Related topics + references

github.com/electron/electron

fix: add Wayland support

electron:master ← vially:wayland

opened 10:52AM - 18 Oct 20 UTC

vially

+271 -158

#### Description of Change Add initial support for running Electron on Waylan…d (#10915). Since version 87, Wayland support is enabled in the default Chromium *build* and can be enabled at *runtime* with a feature flag: `--enable-features=UseOzonePlatform --ozone-platform=wayland` ([chromium#1085700](https://bugs.chromium.org/p/chromium/issues/detail?id=1085700)). This pull-request attempts to do the same for Electron. This means that the non-Ozone X11 is still the default but Ozone/Wayland and Ozone/X11 can now be chosen *at runtime* using this feature flag: ``` electron --enable-features=UseOzonePlatform --ozone-platform=wayland ``` ``` electron --enable-features=UseOzonePlatform --ozone-platform=x11 ``` **The Wayland support is very experimental and various features which were working in X11 may either be broken or not implemented for Wayland.** Therefore, this pull-request should be seen more like *the minimal amount of changes required to show an Electron window in Wayland* rather than the complete set of changes required to bring full Wayland support to Electron. ##### Build configuration I'm not familiar with Electron's CI build system but there's a chance it might require some changes to accommodate Wayland support on Linux. If it turns out that's the case I might need some help from someone familiar with these systems. FWIW, this is the [build tools](https://github.com/electron/build-tools) config that I've used locally to build and test this: <details> <summary>GN gen args</summary> ```json { "goma": "cache-only", "root": "/home/vially/projects/electron", "gen": { "args": [ "import(\"//electron/build/args/testing.gn\")", "import(\"/home/vially/.electron_build_tools/third_party/goma.gn\")", "blink_symbol_level=0", "icu_use_data_file=false", "is_component_ffmpeg=false", "link_pulseaudio=true", "treat_warnings_as_errors=false", "use_gnome_keyring=false", "use_sysroot=false", "use_ozone=true", "ozone_auto_platforms=false", "ozone_platform_wayland=true", "ozone_platform_x11=true", "use_system_libwayland=true", "use_glib=true", "rtc_use_pipewire=true" ], "out": "Testing" }, "env": { "CHROMIUM_BUILDTOOLS_PATH": "/home/vially/projects/electron/src/buildtools", "GIT_CACHE_PATH": "/home/vially/.git_cache" }, "remotes": { "electron": { "origin": "[email protected]:electron/electron.git", "hedgepigdaniel": "[email protected]:hedgepigdaniel/electron.git", "fork": "[email protected]:vially/electron.git" }, "node": { "origin": "[email protected]:electron/node.git" } } } ``` </details> #### Acknowledgements Thank you @hedgepigdaniel for providing the [set of patches](https://github.com/hedgepigdaniel/electron/commits/arch-10) that this pull-request was based on. Also a big thank you to @msisov, @nickdiego, @tonikitoo and many others from the @Igalia team for adding Wayland support to Chromium. #### Checklist - [x] PR description included and stakeholders cc'd (@ckerr @zcbenz) - [x] `npm test` passes - [x] PR title follows semantic [commit guidelines](https://github.com/electron/electron/blob/master/docs/development/pull-requests.md#commit-message-guidelines) #### Release Notes Notes: none

github.com/microsoft/vscode

Native wayland support with newest electron

opened 05:03PM - 22 Oct 20 UTC

closed 04:11PM - 04 Apr 22 UTC

toger5

upstream linux electron upstream-issue-linked insiders-released

Native wayland support would be great to run vs code without XWayland as describ…ed in https://github.com/microsoft/vscode/issues/77752. Recently electron merged the chrome version with the ozone backend needed: https://github.com/electron/electron/pull/26022 This would allow for: - Kinetic scrolling (maybe this is more elegantly implemented on the elctron side) - Better touch support (touch scrolling) - better dpi scaling

LukeVader · May 28, 2021, 10:45pm

I would conciser this a necessity, besides the listed features that the app would gain from the update for wayland, it would also mean enhanced security for any wayland user.

If you aren’t aware any X application can see any other X application without needing to request for permission, which you can imagine is a major security risk, especially when it comes to a password manager. Wayland solves this

MetalGearDaner · September 16, 2021, 9:37pm

Any updates on this issue? Bitwarden on XWayland doesn’t work on my Arch setup… it’s just a blank window.

tgreer · September 17, 2021, 10:36am

I’ll check - we’ve update electron a few times recently @MetalGearDaner

tgreer · September 17, 2021, 6:04pm

Looks like 11.4 is where we’re at right now - thanks for keeping this active!

MetalGearDaner · September 18, 2021, 9:10am

Thanks for the info! Pretty close to Electron 12, I hope it gets updated soon. I’ll check now and then

tgreer · September 28, 2021, 3:36pm

@MetalGearDaner we just updated to electron 14

github.com/bitwarden/desktop

Bump Electron to v14

bitwarden:master ← bitwarden:feature/bump-electron

opened 07:27PM - 23 Sep 21 UTC

Hinton

+2320 -1824

## Objective Upgrade Electron to use 14.0.1. I replaced the old electron-bui…lder patch with a work-around which sadly means we codesign twice but is less hacky. Codesigning is usually fairly quick so should be fine. ### Testing Considerations We'll need to do a regression sweep to verify nothing broke. We should also verify the safari extension is signed correctly. Depends on https://github.com/bitwarden/jslib/pull/498

MetalGearDaner · September 28, 2021, 5:47pm

That’s amazing! Thanks for the good and fast work