feat: use wayland when available

Auto-detect wayland in the yarn watch script.

We use a shell script wrapper to launch sophie with wayland-specific
arguments whenever appropriate. Because of this, the electron binary
that ships with sophie has been renamed to sophie-bin.

Signed-off-by: Kristóf Marussy <kristof@marussy.com>

4 files changed, 114 insertions, 28 deletions

diff --git a/.electron-builder.config.cjs b/.electron-builder.config.cjs
index efd9ef7..3eef91c 100644
--- a/.electron-builder.config.cjs
+++ b/.electron-builder.config.cjs
@@ -1,29 +1,8 @@
+const { readFile, rename, writeFile  } = require('node:fs/promises');
+const path = require('node:path');
+
 const { Arch } = require('electron-builder');
 const { flipFuses, FuseV1Options, FuseVersion } = require('@electron/fuses');
-const { join } = require('path');
-
-/**
- * @type {import('electron-builder').Configuration}
- * @see https://www.electron.build/configuration/configuration
- */
-const config = {
-  directories: {
-    output: 'dist',
-    buildResources: 'buildResources',
-  },
-  files: [
-    'packages/main/dist/**',
-    'packages/preload/dist/**',
-    'packages/renderer/dist/**',
-    'packages/service-preload/dist/**',
-    'locales/**',
-    // Do not ship with source maps.
-    '!**/*.map',
-  ],
-  afterPack(context) {
-    return burnFuses(context);
-  },
-};
 
 /**
  * Hardens the shipped electron binary by burning some electron fuses.
@@ -46,7 +25,7 @@ async function burnFuses(context) {
       darwin: '.app',
       win32: '.exe',
     }[context.electronPlatformName] || '';
-  const electronBinaryPath = join(
+  const electronBinaryPath = path.join(
     context.appOutDir,
     `${context.packager.appInfo.productFilename}${ext}`,
   );
@@ -66,4 +45,73 @@ async function burnFuses(context) {
   return flipFuses(electronBinaryPath, fuseConfig);
 }
 
+/**
+ * Adds a wrapper scripts that detects in wayland is in use and enabled it in chromium.
+ *
+ * The script in `build-heleprs/detect_wayland.sh` uses the `WAYLAND_DISPLAY` environmental
+ * variable to detect whether wayland is in use.
+ *
+ * If wayland is in use, the script enables the wayland ozone backed for chromium
+ * and pipewire screen sharing. Otherwise, the x11 ozone backend will be used.
+ *
+ * @param {import('electron-builder').AfterPackContext} context The `electron-builder` context.
+ * @return {Promise<void>} The promise to add the wrapper script.
+ * @see https://stackoverflow.com/a/45537237
+ */
+async function enableWaylandAutoDetection(context) {
+  const { appOutDir, packager: { appInfo: { productName, productFilename } } } = context;
+  const electronBinaryPath = path.join(appOutDir, productFilename);
+  const newFilename = `${productFilename}-bin`;
+  const newElectronBinaryPath = path.join(appOutDir, newFilename);
+  await rename(electronBinaryPath, newElectronBinaryPath);
+  const wrapperScriptPath = path.join(__dirname, 'build-helpers/detect_wayland.sh');
+  const wrapperScriptTempate = await readFile(wrapperScriptPath, 'utf8');
+  const replacements = new Map([
+    ['PRODUCT_NAME', productName],
+    ['REAL_BINARY_NAME', newFilename],
+  ]);
+  const wrapperScript = wrapperScriptTempate.replaceAll(
+    /\{\{([^}]+)\}\}/g,
+    (_match, /** @type {string} */ variable) => {
+      const replacement = replacements.get(variable);
+      if (replacement === undefined) {
+        throw new Error(`Unknown variable: ${variable}`);
+      }
+      return replacement;
+    },
+  );
+  await writeFile(electronBinaryPath, wrapperScript, {
+    encoding: 'utf8',
+    mode: 0o755,
+  });
+}
+
+/**
+ * @type {import('electron-builder').Configuration}
+ * @see https://www.electron.build/configuration/configuration
+ */
+const config = {
+  directories: {
+    output: 'dist',
+    buildResources: 'buildResources',
+  },
+  files: [
+    'packages/main/dist/**',
+    'packages/preload/dist/**',
+    'packages/renderer/dist/**',
+    'packages/service-preload/dist/**',
+    'locales/**',
+    // Do not ship with source maps.
+    '!**/*.map',
+  ],
+  afterPack(context) {
+    return burnFuses(context);
+  },
+  async afterSign(context) {
+    if (context.electronPlatformName === 'linux') {
+      await enableWaylandAutoDetection(context);
+    }
+  }
+};
+
 module.exports = config;
diff --git a/build-helpers/detect_wayland.sh b/build-helpers/detect_wayland.sh
new file mode 100644
index 0000000..e82a383
--- /dev/null
+++ b/build-helpers/detect_wayland.sh
@@ -0,0 +1,16 @@
+#!/usr/bin/env sh
+if [ ! -L "$0" ]; then
+  electron_dir="$(dirname "$0")"
+else
+  if command -v readlink >/dev/null; then
+    electron_dir="$(dirname "$(readlink -f "$0")")"
+  else
+    electron_dir="/opt/{{PRODUCT_NAME}}"
+  fi
+fi
+electron_path="${electron_dir}/{{REAL_BINARY_NAME}}"
+if [ -n "${WAYLAND_DISPLAY+1}" ]; then
+  exec "${electron_path}" --enable-features=WaylandWindowDecorations,WebRTCPipeWireCapturer --ozone-platform=wayland "$@"
+else
+  exec "${electron_path}" --ozone-platform=x11 "$@"
+fi
diff --git a/package.json b/package.json
index 2e60130..9c864cc 100644
--- a/package.json
+++ b/package.json
@@ -23,7 +23,7 @@
     "test": "node --experimental-vm-modules --no-warnings $(yarn bin jest)",
     "test:ci": "yarn test --ci --coverage --reporters=default --reporters=jest-junit",
     "test:integ": "electron scripts/electronJest.cjs --user-data-dir=userDataDir/integ --config=jest.integ.config.cjs --runInBand",
-    "test:integ:xvfb": "cross-env DISABLE_GPU=true xvfb-run -s \"-screen 0 1920x1080x24\" electron scripts/electronJest.cjs --user-data-dir=userDataDir/integ --config=jest.integ.config.cjs --runInBand",
+    "test:integ:xvfb": "cross-env DISABLE_GPU=true xvfb-run -s \"-screen 0 1920x1080x24\" electron scripts/electronJest.cjs --user-data-dir=userDataDir/integ --disable-features=WebRTCPipeWireCapturer --ozone-platform=x11 --config=jest.integ.config.cjs --runInBand",
     "test:integ:ci": "cross-env DISABLE_GPU=true yarn test:integ --ci --coverage --reporters=default --reporters=jest-junit",
     "test:integ:xvfb:ci": "yarn test:integ:xvfb --ci --coverage --reporters=default --reporters=jest-junit",
     "build": "node scripts/build.js",
diff --git a/scripts/watch.js b/scripts/watch.js
index eeee6e4..5db0d30 100644
--- a/scripts/watch.js
+++ b/scripts/watch.js
@@ -1,4 +1,5 @@
 import { spawn } from 'node:child_process';
+import os from 'node:os';
 import path from 'node:path';
 
 import { watch } from 'chokidar';
@@ -31,7 +32,7 @@ const userDataDir = path.join(thisDir, '../userDataDir/development');
 
 /** @type {RegExp[]} */
 const stderrIgnorePatterns = [
-  // warning about devtools extension
+  // Warning about devtools extension
   // https://github.com/cawa-93/vite-electron-builder/issues/492
   // https://github.com/MarshallOfSound/electron-devtools-installer/issues/143
   /ExtensionLoadWarning/,
@@ -44,6 +45,8 @@ const stderrIgnorePatterns = [
   // Does not seem to occur in production
   // https://github.com/electron/electron/issues/32133#issuecomment-1079916988
   /(sandbox_bundle\.js script failed to run|object null is not iterable).+ node:electron\/js2c\/sandbox_bundle \(160\)$/,
+  // Warning when GPU-accelerated video decoding is not available (some wayland configs)
+  /Passthrough is not supported, GL is/,
 ];
 
 /**
@@ -134,6 +137,20 @@ function setupMainPackageWatcher(viteDevServer) {
   const portOrDefault = port || 3000;
   process.env.VITE_DEV_SERVER_URL = `${protocol}//${hostOrDefault}:${portOrDefault}/`;
 
+  /** @type {string[]} */
+  let extraArgs = [];
+
+  if (['aix', 'freebsd', 'linux', 'openbsd', 'sunos'].includes(os.platform())) {
+    // Use wayland display server if available.
+    extraArgs =
+      'WAYLAND_DISPLAY' in process.env
+        ? [
+            '--enable-features=WaylandWindowDecorations,WebRTCPipeWireCapturer',
+            '--ozone-platform=wayland',
+          ]
+        : ['--ozone-platform=x11'];
+  }
+
   /** @type {import('child_process').ChildProcessByStdio<null, null, import('stream').Readable>
     | undefined} */
   let childProcess;
@@ -144,7 +161,12 @@ function setupMainPackageWatcher(viteDevServer) {
   function spawnProcess() {
     childProcess = spawn(
       String(electronPath),
-      ['.', `--user-data-dir=${userDataDir}`, ...process.argv.slice(2)],
+      [
+        '.',
+        `--user-data-dir=${userDataDir}`,
+        ...extraArgs,
+        ...process.argv.slice(2),
+      ],
       {
         stdio: ['inherit', 'inherit', 'pipe'],
       },