Fixes #134612: Added electron flags for wayland #135191

zzeebbii · 2021-10-15T22:06:06Z

enable-features and the ozone-platform flag will be parsed from the runtime argv.json file.
This PR fixes #134612

zzeebbii · 2021-10-22T11:54:25Z

@deepak1556 can you please at least start the workflows for this PR? :)

deepak1556

Thanks for working on this, left some style comments

src/main.js

src/vs/workbench/electron-sandbox/desktop.contribution.ts

deepak1556 · 2021-11-09T04:03:32Z

Additionally it would be good to implement a auto value in Electron similar to what is implemented for chrome://flags https://bugs.chromium.org/p/chromium/issues/detail?id=1246928

zzeebbii · 2021-11-09T17:22:41Z

Additionally it would be good to implement a auto value in Electron similar to what is implemented for chrome://flags https://bugs.chromium.org/p/chromium/issues/detail?id=1246928

@deepak1556 I've fixed the things you mentioned but I couldn't understand what you said about auto. Can you please explain a little bit more?

deepak1556 · 2021-11-15T16:35:17Z

src/main.js

 			else if (argvValue === true || argvValue === 'true') {
 				if (argvKey === 'disable-hardware-acceleration') {
 					app.disableHardwareAcceleration(); // needs to be called explicitly
 				} else {
 					app.commandLine.appendSwitch(argvKey);
 				}
 			}
+
+			// Other arguments with value type as 'string'
+			else if (typeof argvValue === 'string') {


Suggested change

else if (typeof argvValue === 'string') {

// ozone platform

else if (argvKey === 'ozone-platform') {

if (argvValue) {

app.commandLine.appendSwitch(argvKey, argvValue);

app.commandLine.appendSwitch('enable-features', 'UseOzonePlatform');

}

}

deepak1556 · 2021-11-15T16:37:50Z

auto flag is more of a note to me, it needs to be implemented in Electron similar to the work done in https://bugs.chromium.org/p/chromium/issues/detail?id=1246928 so that most of the time runtime picks the correct ozone platform.

ozone-platform flag will be parsed from runtime argv.json file.

torhovland · 2021-12-18T09:32:47Z

I would love to see this one merged!

zzeebbii · 2022-01-10T09:14:21Z

@deepak1556 is there any update on this one? :)

zzeebbii · 2022-04-27T08:22:50Z

Hi @deepak1556 is there any plan to merge this PR?

tobiasgrosser · 2022-07-06T16:50:02Z

Hi, I would like to use this patch. Is there anything blocking the merge and can I help in some way with finalizing this patch?

kowalski7cc · 2022-07-09T09:58:22Z

Can be --enable-features=WaylandWindowDecorations added as well? It would help with decorations when not using the custom titlebar

vially · 2022-08-04T18:00:09Z

src/main.js

+			else if (argvKey === 'ozone-platform') {
+				if (argvValue) {
+					app.commandLine.appendSwitch(argvKey, argvValue);
+					app.commandLine.appendSwitch('enable-features', 'UseOzonePlatform');


The UseOzonePlatform feature no longer needs to be explicitly enabled since a couple of Electron releases ago, so this can be safely removed.

Suggested change

app.commandLine.appendSwitch('enable-features', 'UseOzonePlatform');

vially · 2022-08-04T18:03:57Z

src/main.js

@@ -167,6 +167,9 @@ function configureCommandlineSwitchesSync(cliArgs) {

 		// Force enable screen readers on Linux via this flag
 		SUPPORTED_ELECTRON_SWITCHES.push('force-renderer-accessibility');
+
+		// Specify ozone platform implementation to use.
+		SUPPORTED_ELECTRON_SWITCHES.push('ozone-platform');


Since #154092, Visual Studio Code is using an Electron version that supports the --ozone-platform-hint flag. So it may be worth enabling this flag too (ozone-platform-hint) as part of this pull-request.

@vially unfortunately we cannot support ozone-platform-hint from application code since the flag detection happens before application code starts its execution which would be in ElectronBrowserMainParts::PreMainMessageLoopRun

ReillyBrogan · 2022-08-04T22:56:21Z

Posting this here for visibility. I updated Electron to 19.0.10 locally to experiment with the new --ozone-platform-hint flag and one thing that I noticed is that Electron running in Wayland sets the window app_id to the name of the desktop file (sans .desktop), as defined during the build. Unfortunately VSCode seems to set this to the name of the URL handler desktop file instead which means that the DE will not correctly identify vscode windows as belonging to the vscode application which means that they will not be associated with vscode in the "taskbar" (or whatever the given DE uses) and various other undesired behavior.

I'm not sure why VSCode sets it to the URL handler, as far as I can tell the URL handler works fine if it's set to the normal desktop file instead so I don't think that setting it to that is actually required for the URL handler.

Ref (read the Electron dev comments as well as my own): electron/electron#34855 (comment)
Code that sets it to the url handler:

vscode/build/gulpfile.vscode.js

Line 202 in 0ea1cfd

    
           packageJsonUpdates.desktopName = `${product.applicationName}-url-handler.desktop`;

I'm mentioning this as part of this PR because the individuals involved in this PR are clearly interested in Wayland on Linux and this will need to be resolved if Wayland is made the default (for Wayland users) or even if it's exposed as an option directly.

deepak1556 · 2022-08-16T11:47:37Z

Sorry for the delay on this, looking into the changes again ozone platform initialization happens earlier https://github.com/electron/electron/blob/main/shell/browser/electron_browser_main_parts.cc#L220-L221 before entry point JS code of VSCode can run which makes it difficult to support this flag as an application configurable argument. Users are required to continue specifying either --ozone-platform=<wayland|x11> or --ozone-platform-hint=<wayland|x11|auto> when launching the application to get the desired backend.

scratchmex · 2022-08-28T19:26:06Z

@deepak1556 When is going to be a default solution for people running wayland? Is there any issue tracking it?

edit: maybe using this? electron/electron#34937

ghost · 2022-09-02T20:02:40Z

Sorry for the delay on this, looking into the changes again ozone platform initialization happens earlier https://github.com/electron/electron/blob/main/shell/browser/electron_browser_main_parts.cc#L220-L221 before entry point JS code of VSCode can run which makes it difficult to support this flag as an application configurable argument. Users are required to continue specifying either --ozone-platform=<wayland|x11> or --ozone-platform-hint=<wayland|x11|auto> when launching the application to get the desired backend.

wayland is quickly becoming the default on linux distros. is there a long term plan to address this?

sedax90 · 2022-09-06T07:04:33Z

vscode is the only reason I could not use fractional scaling in office with wayland...

vscode-triage-bot assigned weinand Oct 15, 2021

weinand assigned bpasero and unassigned weinand Oct 18, 2021

bpasero assigned deepak1556 and unassigned bpasero Oct 18, 2021

deepak1556 added this to the November 2021 milestone Oct 29, 2021

deepak1556 reviewed Nov 9, 2021

View reviewed changes

src/main.js Outdated Show resolved Hide resolved

src/vs/workbench/electron-sandbox/desktop.contribution.ts Outdated Show resolved Hide resolved

src/vs/workbench/electron-sandbox/desktop.contribution.ts Outdated Show resolved Hide resolved

zzeebbii force-pushed the fix/electron-wayland branch 2 times, most recently from e67c2e8 to 2cc4453 Compare November 9, 2021 17:04

deepak1556 reviewed Nov 15, 2021

View reviewed changes

Fixes microsoft#134612: Added electron flags for wayland

4116982

ozone-platform flag will be parsed from runtime argv.json file.

zzeebbii force-pushed the fix/electron-wayland branch from 2cc4453 to 4116982 Compare November 15, 2021 18:54

deepak1556 modified the milestones: November 2021, December 2021 Dec 2, 2021

deepak1556 modified the milestones: January 2022, February 2022 Jan 28, 2022

deepak1556 modified the milestones: February 2022, March 2022 Feb 24, 2022

deepak1556 removed this from the March 2022 milestone Mar 23, 2022

deepak1556 added this to the May 2022 milestone May 2, 2022

noahtallen mentioned this pull request May 13, 2022

Native wayland support with newest electron #109176

Closed

joyceerhl modified the milestones: May 2022, June 2022 Jun 3, 2022

deepak1556 removed this from the June 2022 milestone Jun 30, 2022

sedax90 mentioned this pull request Jul 15, 2022

Gnome fractional scaling not supported - blurry UI #72759

Closed

vially reviewed Aug 4, 2022

View reviewed changes

a-priestley mentioned this pull request Aug 12, 2022

Blank window running on Wayland desktop in Linux itchio/itch#2680

Open

deepak1556 closed this Aug 16, 2022

deepak1556 mentioned this pull request Aug 16, 2022

Add Wayland Electron Arguments to argv.json #134612

Closed

github-actions bot locked and limited conversation to collaborators Oct 2, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fixes #134612: Added electron flags for wayland #135191

Fixes #134612: Added electron flags for wayland #135191

zzeebbii commented Oct 15, 2021

zzeebbii commented Oct 22, 2021

deepak1556 left a comment

deepak1556 commented Nov 9, 2021

zzeebbii commented Nov 9, 2021

deepak1556 Nov 15, 2021

zzeebbii Nov 15, 2021

deepak1556 commented Nov 15, 2021

torhovland commented Dec 18, 2021

zzeebbii commented Jan 10, 2022

zzeebbii commented Apr 27, 2022

tobiasgrosser commented Jul 6, 2022

kowalski7cc commented Jul 9, 2022

vially Aug 4, 2022 •

edited

vially Aug 4, 2022

deepak1556 Aug 16, 2022

ReillyBrogan commented Aug 4, 2022

deepak1556 commented Aug 16, 2022

scratchmex commented Aug 28, 2022 •

edited

ghost commented Sep 2, 2022

sedax90 commented Sep 6, 2022

Fixes #134612: Added electron flags for wayland #135191

Fixes #134612: Added electron flags for wayland #135191

Conversation

zzeebbii commented Oct 15, 2021

zzeebbii commented Oct 22, 2021

deepak1556 left a comment

Choose a reason for hiding this comment

deepak1556 commented Nov 9, 2021

zzeebbii commented Nov 9, 2021

deepak1556 Nov 15, 2021

Choose a reason for hiding this comment

zzeebbii Nov 15, 2021

Choose a reason for hiding this comment

deepak1556 commented Nov 15, 2021

torhovland commented Dec 18, 2021

zzeebbii commented Jan 10, 2022

zzeebbii commented Apr 27, 2022

tobiasgrosser commented Jul 6, 2022

kowalski7cc commented Jul 9, 2022

vially Aug 4, 2022 • edited

Choose a reason for hiding this comment

vially Aug 4, 2022

Choose a reason for hiding this comment

deepak1556 Aug 16, 2022

Choose a reason for hiding this comment

ReillyBrogan commented Aug 4, 2022

deepak1556 commented Aug 16, 2022

scratchmex commented Aug 28, 2022 • edited

ghost commented Sep 2, 2022

sedax90 commented Sep 6, 2022

vially Aug 4, 2022 •

edited

scratchmex commented Aug 28, 2022 •

edited