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>

1 files changed, 73 insertions, 25 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;