Skip to content

fix: start:wayland defaults to wrong compositor socket #4268

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
flightlesstux wants to merge 1 commit into
base: develop
Choose a base branch
from
+1 −1
Open

fix: start:wayland defaults to wrong compositor socket #4268

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@
"server:watch": "node ./serveronly/watcher.js",
"start": "node --run start:wayland",
"start:dev": "node --run start:wayland -- dev",
"start:wayland": "WAYLAND_DISPLAY=\"${WAYLAND_DISPLAY:=wayland-1}\" ./node_modules/.bin/electron js/electron.js --ozone-platform=wayland",
"start:wayland": "WAYLAND_DISPLAY=\"${WAYLAND_DISPLAY:-$(ls \"${XDG_RUNTIME_DIR:-/run/user/$(id -u)}\" 2>/dev/null | grep -m1 '^wayland-[0-9]*$')}\"; WAYLAND_DISPLAY=\"${WAYLAND_DISPLAY:-wayland-0}\" ./node_modules/.bin/electron js/electron.js --ozone-platform=wayland",

@KristjanESPERANTO KristjanESPERANTO Sep 16, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could this be simplified to the following?

Suggested change
"start:wayland": "WAYLAND_DISPLAY=\"${WAYLAND_DISPLAY:-$(ls \"${XDG_RUNTIME_DIR:-/run/user/$(id -u)}\" 2>/dev/null | grep -m1 '^wayland-[0-9]*$')}\"; WAYLAND_DISPLAY=\"${WAYLAND_DISPLAY:-wayland-0}\" ./node_modules/.bin/electron js/electron.js --ozone-platform=wayland",
"start:wayland": "./node_modules/.bin/electron js/electron.js --ozone-platform=wayland",

The current script explicitly defaults WAYLAND_DISPLAY to wayland-1, while the standard Wayland default is wayland-0. On my Debian system, removing the explicit assignment works correctly.

I haven't tested this on a Raspberry Pi, though. Could someone confirm that Electron also uses wayland-0 there when WAYLAND_DISPLAY is unset?

@khassel khassel Sep 16, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

works with unset WAYLAND_DISPLAY on a pi 4:

####  System Information  ####
- MM:       version: v2.38.0-develop; git: e1cc0696; branch: develop
- SYSTEM:   manufacturer: Raspberry Pi Foundation; model: Raspberry Pi 4 Model B Rev 1.5; virtual: false
- OS:       platform: linux; distro: Debian GNU/Linux; release: 13; arch: arm64; kernel: 6.18.50+rpt-rpi-v8
- VERSIONS: electron: 44.1.1; used node: 24.19.0; installed node: 22.22.2; npm: 10.9.7; pm2: 
- ENV:      XDG_SESSION_TYPE: tty; MM_CONFIG_FILE: undefined
            WAYLAND_DISPLAY:  undefined; DISPLAY: undefined; ELECTRON_ENABLE_GPU: undefined
- RAM:      total: 3795.74 MB; free: 3183.61 MB; used: 612.13 MB
- OTHERS:   uptime: 18 minutes; timeZone: Europe/Berlin

@KristjanESPERANTO KristjanESPERANTO Sep 17, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@sdetweil What do you think about the simplified version "./node_modules/.bin/electron js/electron.js --ozone-platform=wayland" ?

@sdetweil sdetweil Sep 17, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

is that a temporary parameter? or do you think it will last?

@KristjanESPERANTO KristjanESPERANTO Sep 17, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good question! I just tested this with Electron 44.1.1 on Debian, and MagicMirror started successfully without --ozone-platform=wayland.

Could we simplify the script even further to this?

"start:wayland": "./node_modules/.bin/electron js/electron.js"

@khassel khassel Sep 17, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

no, this fails on my pi 4 ...

@khassel khassel Sep 17, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more. 

mm@pi4-argon:~/MagicMirror $ env | grep -i xdg_
XDG_SESSION_TYPE=tty
XDG_SESSION_CLASS=user
XDG_SESSION_ID=4
XDG_RUNTIME_DIR=/run/user/1000

Running XDG_SESSION_TYPE=wayland ./node_modules/.bin/electron js/electron.js works. Electron uses XDG_SESSION_TYPE if --ozone-platform=auto (the default).

So we should not remove --ozone-platform=wayland.

@KristjanESPERANTO KristjanESPERANTO Sep 17, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Okay, thanks for testing! So "./node_modules/.bin/electron js/electron.js --ozone-platform=wayland" stays the candidate.

Out of curiosity: Why do you have XDG_SESSION_TYPE=tty and not XDG_SESSION_TYPE: wayland?

@khassel khassel Sep 17, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this is the default in raspberry pi os

@KristjanESPERANTO KristjanESPERANTO Sep 18, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@flightlesstux Please confirm if "start:wayland": "./node_modules/.bin/electron js/electron.js --ozone-platform=wayland" also works for you.

"start:wayland:dev": "node --run start:wayland -- dev",
"start:windows": ".\\node_modules\\.bin\\electron js\\electron.js",
"start:windows:dev": "node --run start:windows -- dev",
Expand Down