fix: add Wayland support by vially · Pull Request #26022 · electron/electron

vially · 2020-10-18T10:52:21Z

Description of Change

Add initial support for running Electron on Wayland (#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).

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 config that I've used locally to build and test this:

GN gen args

{
  "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": "git@github.com:electron/electron.git",
      "hedgepigdaniel": "git@github.com:hedgepigdaniel/electron.git",
      "fork": "git@github.com:vially/electron.git"
    },
    "node": {
      "origin": "git@github.com:electron/node.git"
    }
  }
}

Acknowledgements

Thank you @hedgepigdaniel for providing the set of patches 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

PR description included and stakeholders cc'd (@ckerr @zcbenz)
npm test passes
PR title follows semantic commit guidelines

Release Notes

Notes: none

ckerr

This looks like a great start. Thanks for doing this work!

release-clerk · 2020-10-20T18:24:58Z

No Release Notes

deepak1556 · 2020-10-20T19:58:43Z

Thanks for the PR, question about the gn args used, I see you had built with "use_sysroot=false". Is there a missing dependency we need add to our sysroot ?

vially · 2020-10-20T20:55:33Z

I see you had built with "use_sysroot=false". Is there a missing dependency we need add to our sysroot?

I'm not sure to be honest. I only used "use_sysroot=false" in my config because that's what is used in the Archlinux electron package build script and it was the easiest way to get started building Electron on my machine. And since it worked I never payed any attention to it or bothered changing the build configuration.

I'll try to build with "use_sysroot=true" and report back here the results. If I find out that there are indeed missing dependencies in the Electron sysroot I'll submit a pull-request to add them (I guess debian-sysroot-image-creator is the right repository for that).

deepak1556 · 2020-10-20T21:36:53Z

Thanks!

I guess debian-sysroot-image-creator is the right repository for that).

yup thats correct.

vially · 2020-10-22T16:20:33Z

Building with "use_sysroot=true" seems to work fine and the build seems to run fine both on Wayland and on X11. I suppose this means there are no missing Wayland dependencies in the Electron sysroot. @deepak1556

GN args (use_sysroot=true)

{
  "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\")",
      "use_sysroot=true"
    ],
    "out": "Testing"
  },
  "env": {
    "CHROMIUM_BUILDTOOLS_PATH": "/home/vially/projects/electron/src/buildtools",
    "GIT_CACHE_PATH": "/home/vially/.git_cache"
  },
  "remotes": {
    "electron": {
      "origin": "git@github.com:electron/electron.git",
      "hedgepigdaniel": "git@github.com:hedgepigdaniel/electron.git",
      "fork": "git@github.com:vially/electron.git"
    },
    "node": {
      "origin": "git@github.com:electron/node.git"
    }
  }
}

filenames.gni

bernharl · 2020-10-24T09:33:32Z

When will this be in a release?

ovflowd · 2020-10-25T12:54:27Z

As part of the GNOME Team, I'm genuinely excited to see this happening.

Thank you for all the efforts, Electron contributors!

We at GNOME, say thank you!

vially · 2020-10-25T13:57:47Z

When will this be in a release?

Unless additional issues are uncovered which will make it necessary to revert this pull-request I think this will land in Electron 12.

However, as I've mentioned in the description, this is still very experimental so bugs and missing features are to be expected in the first release.

fosskers · 2021-03-04T22:25:14Z

Just a double-check: was this actually included in Electron 12?

vially · 2021-03-08T21:50:25Z

@fosskers Sorry, I somehow missed this notification and I guess you must have gotten your answer by now. But in case you haven't, yes, it has landed in version 12 (:tada:) and can be tested by running:

electron --enable-features=UseOzonePlatform --ozone-platform=wayland

fosskers · 2021-03-08T23:16:37Z

Thanks @vially I'm sure there are many people who would be happy to hear that!

After thinking about it a few times, I finally decided to add the wayland socket permission to the flatpak. While it's not strictly necessary it also doesn't hurt much, but simplifies the usage of the upcoming support for the electron wayland integration. Further references: #173 electron/electron#26022

RangerMauve · 2021-05-06T05:13:49Z

Has anybody managed to set these flags at runtime?

I'm working on a Web browser and currently getting it to work on the Pinephone. When I don't use these flags the text gets all fuzzy due to the scaling.

Adding the flags in works great and fixes the fuzziness and makes it more snappy overall. However, this only works if I add the flags on the CLI. If I try to specify the flags in webPreferences.additionalArguments or commandLine.appendSwitch it doesn't seem to have the desired effect. It either does nothing, or leads to a gray screen.

Has anybody seen this issue, or is there another place I should be specifying arguments that would work better?

After thinking about it a few times, I finally decided to add the wayland socket permission to the flatpak. While it's not strictly necessary it also doesn't hurt much, but simplifies the usage of the upcoming support for the electron wayland integration. Further references: flathub/im.riot.Riot#173 electron/electron#26022

…ed() Xref: https://chromium-review.googlesource.com/c/chromium/src/+/4710351 Xref: #26022 This usage was added in #26022 as part of Wayland support and some simple fiddles WfM with this patch on Wayland, but I'm unsure what to be testing for & would like a second opinion on this commit.

* chore: bump chromium in DEPS to 123.0.6265.0 * chore: bump chromium in DEPS to 123.0.6266.0 * chore: update feat_ensure_mas_builds_of_the_same_application_can_use_safestorage.patch Xref: https://chromium-review.googlesource.com/c/chromium/src/+/5232280 reverts the revert *and* undoes the rewrites 😵 * chore: update chromium/disable_hidden.patch Xref: https://chromium-review.googlesource.com/c/chromium/src/+/5148491 minor manual intervention * chore: update patches * chore: Rename mouse lock to pointer lock Xref: https://chromium-review.googlesource.com/c/chromium/src/+/5148491 * refactor: fix use of newly-removed QuitCurrentWhenIdleClosureDeprecated() Xref: https://chromium-review.googlesource.com/c/chromium/src/+/4710351 Xref: #26022 This usage was added in #26022 as part of Wayland support and some simple fiddles WfM with this patch on Wayland, but I'm unsure what to be testing for & would like a second opinion on this commit. * chore: bump chromium in DEPS to 123.0.6268.0 * chore: update patches * 5235021: WebUI: Migrate accessibility and bluetooth internals to WebUIConfig https://chromium-review.googlesource.com/c/chromium/src/+/5235021 * address review comment for 5196547 See: https://chromium-review.googlesource.com/c/chromium/src/+/5196547 Review comment: #41130 (comment) * 5075962: Introduce URLLoaderFactoryBuilder https://chromium-review.googlesource.com/c/chromium/src/+/5075962 * chore: bump chromium in DEPS to 123.0.6270.0 * the missing semicolon strikes again * chore: update chromium patches * chore: update v8 patches * 5242326: Some followup cleanup to Fuchia files in chrome | https://chromium-review.googlesource.com/c/chromium/src/+/5242326 * chore: bump chromium in DEPS to 123.0.6272.0 * chore: update patches * chore: update patch after rebase * 5247339: [Clipboard] Remove ClipboardContentType enum. https://chromium-review.googlesource.com/c/chromium/src/+/5247339 * Reland: "Allow content shell to enable the built-in DNS resolver" https://chromium-review.googlesource.com/c/chromium/src/+/5232354 * 5018206: [accessibility] Migrate to ScopedAccessibilityMode https://chromium-review.googlesource.com/c/chromium/src/+/5018206 * 5246669: [Default Nav Transition]Add GetBackForwardTransitionAnimationManager on WebContentsView | https://chromium-review.googlesource.com/c/chromium/src/+/5246669 * fix: move nut-js to optional spec deps (#41199) * chore: bump chromium in DEPS to 123.0.6265.0 * chore: bump chromium in DEPS to 123.0.6266.0 * chore: update feat_ensure_mas_builds_of_the_same_application_can_use_safestorage.patch Xref: https://chromium-review.googlesource.com/c/chromium/src/+/5232280 reverts the revert *and* undoes the rewrites 😵 * chore: update chromium/disable_hidden.patch Xref: https://chromium-review.googlesource.com/c/chromium/src/+/5148491 minor manual intervention * chore: update patches * chore: Rename mouse lock to pointer lock Xref: https://chromium-review.googlesource.com/c/chromium/src/+/5148491 * refactor: fix use of newly-removed QuitCurrentWhenIdleClosureDeprecated() Xref: https://chromium-review.googlesource.com/c/chromium/src/+/4710351 Xref: #26022 This usage was added in #26022 as part of Wayland support and some simple fiddles WfM with this patch on Wayland, but I'm unsure what to be testing for & would like a second opinion on this commit. * chore: bump chromium in DEPS to 123.0.6268.0 * chore: update patches * 5235021: WebUI: Migrate accessibility and bluetooth internals to WebUIConfig https://chromium-review.googlesource.com/c/chromium/src/+/5235021 * address review comment for 5196547 See: https://chromium-review.googlesource.com/c/chromium/src/+/5196547 Review comment: #41130 (comment) * 5075962: Introduce URLLoaderFactoryBuilder https://chromium-review.googlesource.com/c/chromium/src/+/5075962 * chore: bump chromium in DEPS to 123.0.6270.0 * the missing semicolon strikes again * chore: update chromium patches * chore: update v8 patches * 5242326: Some followup cleanup to Fuchia files in chrome | https://chromium-review.googlesource.com/c/chromium/src/+/5242326 * chore: bump chromium in DEPS to 123.0.6272.0 * chore: update patches * chore: update patch after rebase * 5247339: [Clipboard] Remove ClipboardContentType enum. https://chromium-review.googlesource.com/c/chromium/src/+/5247339 * Reland: "Allow content shell to enable the built-in DNS resolver" https://chromium-review.googlesource.com/c/chromium/src/+/5232354 * 5018206: [accessibility] Migrate to ScopedAccessibilityMode https://chromium-review.googlesource.com/c/chromium/src/+/5018206 * 5246669: [Default Nav Transition]Add GetBackForwardTransitionAnimationManager on WebContentsView | https://chromium-review.googlesource.com/c/chromium/src/+/5246669 * fix: typescript error for optional dependency (cherry picked from commit ea17105) --------- Co-authored-by: electron-roller[bot] <84116207+electron-roller[bot]@users.noreply.github.com> Co-authored-by: Charles Kerr <charles@charleskerr.com> Co-authored-by: PatchUp <73610968+patchup[bot]@users.noreply.github.com> Co-authored-by: clavin <clavin@electronjs.org> Co-authored-by: VerteDinde <vertedinde@electronjs.org> Co-authored-by: John Kleinschmidt <jkleinsc@electronjs.org> Co-authored-by: Sam Maddock <smaddock@slack-corp.com>

fix: add Wayland support

398808a

electron-cation bot added new-pr 🌱 PR opened recently and removed new-pr 🌱 PR opened recently labels Oct 18, 2020

zcbenz approved these changes Oct 19, 2020

View reviewed changes

zcbenz requested a review from ckerr October 19, 2020 11:53

ckerr approved these changes Oct 20, 2020

View reviewed changes

codebytere merged commit c4525b4 into electron:master Oct 20, 2020

vially deleted the wayland branch October 20, 2020 18:25

toger5 mentioned this pull request Oct 22, 2020

Native wayland support with newest electron microsoft/vscode#109176

Closed

nornagon reviewed Oct 22, 2020

View reviewed changes

filenames.gni Show resolved Hide resolved

nxadm mentioned this pull request Oct 23, 2020

Native wayland support with newest electron MicrosoftDocs/msteams-docs#2229

Closed

teutat3s mentioned this pull request Nov 2, 2020

Support Wayland natively signalapp/Signal-Desktop#3411

Closed

otaviomad mentioned this pull request Nov 5, 2020

Gnome fractional scaling not supported - blurry UI microsoft/vscode#72759

Closed

nidico mentioned this pull request Nov 14, 2020

Native wayland support element-hq/element-web#15725

Closed

fosskers mentioned this pull request Mar 4, 2021

Wayland Support via Electron 12 bloomrpc/bloomrpc#318

Closed

gytis-ivaskevicius mentioned this pull request Mar 15, 2021

Streaming doesn't work on Wayland flathub/com.discordapp.Discord#89

Closed

VitalyAnkh mentioned this pull request Mar 17, 2021

Update electron to 12 to support Wayland agalwood/Motrix#881

Open

vchernin mentioned this pull request May 12, 2021

[Feature Request]: Build with PipeWire by default in Linux #29115

Closed

3 tasks

refi64 mentioned this pull request Jun 9, 2021

fix: Add support for Wayland window decorations #29618

Merged

3 tasks

xnuk mentioned this pull request Aug 18, 2021

Crashes immediately on startup tobspr-games/shapez.io#348

Closed

This was referenced Mar 17, 2022

[Bug]: segfault in dialog.showMessageBox under native Wayland #33325

Closed

fix: calling of X11 functions when running under Wayland #33355

Merged

ghost mentioned this pull request Jun 14, 2022

[Bug] Blurry rendering on Wayland with Fractional Scaling Zettlr/Zettlr#2215

Closed

5 tasks

saolof mentioned this pull request Apr 18, 2023

Use electron's native wayland support SpacingBat3/WebCord#411

Closed

SnuggleCovenant mentioned this pull request Sep 4, 2023

[Feature Request]: update flatpak to use wayland, x11-fallback FreeTubeApp/FreeTube#3982

Closed

3 tasks

hsyslm mentioned this pull request Sep 6, 2023

Wayland support (Linux)? KraXen72/crankshaft#6

Open

Conversation

vially commented Oct 18, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description of Change

Build configuration

Acknowledgements

Checklist

Release Notes

Uh oh!

ckerr left a comment

Choose a reason for hiding this comment

Uh oh!

release-clerk bot commented Oct 20, 2020

Uh oh!

deepak1556 commented Oct 20, 2020

Uh oh!

vially commented Oct 20, 2020

Uh oh!

deepak1556 commented Oct 20, 2020

Uh oh!

vially commented Oct 22, 2020

Uh oh!

Uh oh!

bernharl commented Oct 24, 2020

Uh oh!

ovflowd commented Oct 25, 2020

Uh oh!

vially commented Oct 25, 2020

Uh oh!

fosskers commented Mar 4, 2021

Uh oh!

vially commented Mar 8, 2021

Uh oh!

fosskers commented Mar 8, 2021

Uh oh!

RangerMauve commented May 6, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

10 participants

vially commented Oct 18, 2020 •

edited

Loading