Bundle Stream Deck plugin in DMG install flow

Author: rschwabco

electron-builder.release.yml

@@ -17,6 +17,8 @@ extraResources:
     to: trayTemplate.png
   - from: build/trayTemplate@2x.png
     to: trayTemplate@2x.png
+  - from: stream-deck/com.roie.deck-threads.sdPlugin
+    to: stream-deck-plugin/com.roie.deck-threads.sdPlugin
 
 directories:
   buildResources: build

electron/main.cjs

@@ -1,4 +1,5 @@
 const { app, BrowserWindow, ipcMain, Menu, nativeImage, nativeTheme, shell, Tray } = require("electron");
+const fs = require("node:fs");
 const path = require("node:path");
 const http = require("node:http");
 const { execFile } = require("node:child_process");
@@ -14,9 +15,11 @@ const {
   writeSourceAllocation,
 } = require("./source-allocation.cjs");
 const { assignStableTaskSlots, readTaskSlotIds, writeTaskSlotIds } = require("./task-slots.cjs");
+const { installBundledStreamDeckPlugin } = require("./stream-deck-plugin-install.cjs");
 
 const execFileAsync = promisify(execFile);
 const BRIDGE_HOST = "127.0.0.1";
+const STREAM_DECK_PLUGIN_BUNDLE = "com.roie.deck-threads.sdPlugin";
 const requestedBridgePort = Number(process.env.DECK_THREADS_BRIDGE_PORT);
 const BRIDGE_PORT = Number.isInteger(requestedBridgePort) && requestedBridgePort > 0 && requestedBridgePort <= 65535
   ? requestedBridgePort
@@ -59,6 +62,27 @@ function getResourcePath(filename) {
     : path.join(__dirname, "..", "build", filename);
 }
 
+async function ensureBundledStreamDeckPlugin() {
+  if (process.platform !== "darwin" || !app.isPackaged) {
+    return { status: "development" };
+  }
+
+  const source = path.join(process.resourcesPath, "stream-deck-plugin", STREAM_DECK_PLUGIN_BUNDLE);
+  const pluginsRoot = process.env.DECK_THREADS_STREAM_DECK_PLUGINS_DIR
+    || path.join(app.getPath("home"), "Library", "Application Support", "com.elgato.StreamDeck", "Plugins");
+  const destination = path.join(pluginsRoot, STREAM_DECK_PLUGIN_BUNDLE);
+  const result = await installBundledStreamDeckPlugin(source, destination);
+
+  if (result.status === "installed"
+    && process.env.DECK_THREADS_SKIP_STREAM_DECK_RESTART !== "1"
+    && fs.existsSync("/Applications/Elgato Stream Deck.app")) {
+    await execFileAsync("/usr/bin/pkill", ["-x", "Stream Deck"]).catch(() => undefined);
+    await execFileAsync("/usr/bin/open", ["-a", "/Applications/Elgato Stream Deck.app"]).catch(() => undefined);
+  }
+
+  return result;
+}
+
 function getLaunchAtLoginStatus() {
   if (process.platform !== "darwin" || !app.isPackaged) {
     return { openAtLogin: false, status: "development" };
@@ -481,6 +505,15 @@ app.whenReady().then(() => {
   const openedAtLogin = app.isPackaged && app.getLoginItemSettings().wasOpenedAtLogin;
   if (openedAtLogin) app.dock?.hide();
   else showMainWindow();
+  ensureBundledStreamDeckPlugin()
+    .then((result) => {
+      if (result.status === "installed") {
+        emitEvent("system", "success", "Stream Deck plugin installed", `Version ${result.version || "current"} is ready.`);
+      }
+    })
+    .catch((error) => {
+      emitEvent("system", "warning", "Could not install the Stream Deck plugin", error.message);
+    });
   if (process.env.CODEX_BRIDGE_API_DISABLED !== "1") startBridgeServer();
   app.on("activate", showMainWindow);
 });

electron/stream-deck-plugin-install.cjs

@@ -0,0 +1,35 @@
+const fs = require("node:fs");
+const path = require("node:path");
+
+function readPluginVersion(pluginRoot) {
+  try {
+    const manifest = JSON.parse(fs.readFileSync(path.join(pluginRoot, "manifest.json"), "utf8"));
+    return typeof manifest.Version === "string" ? manifest.Version : null;
+  } catch {
+    return null;
+  }
+}
+
+async function installBundledStreamDeckPlugin(source, destination) {
+  if (!fs.existsSync(source)) return { status: "not-bundled", version: null };
+
+  const sourceVersion = readPluginVersion(source);
+  const destinationVersion = readPluginVersion(destination);
+  if (sourceVersion && sourceVersion === destinationVersion) {
+    return { status: "up-to-date", version: sourceVersion };
+  }
+
+  const pluginsRoot = path.dirname(destination);
+  const staging = path.join(pluginsRoot, `.${path.basename(destination)}.installing-${process.pid}`);
+  await fs.promises.mkdir(pluginsRoot, { recursive: true });
+  await fs.promises.rm(staging, { recursive: true, force: true });
+  await fs.promises.cp(source, staging, { recursive: true });
+  await fs.promises.rm(destination, { recursive: true, force: true });
+  await fs.promises.rename(staging, destination);
+  return { status: "installed", version: sourceVersion };
+}
+
+module.exports = {
+  installBundledStreamDeckPlugin,
+  readPluginVersion,
+};

package.json

@@ -25,6 +25,7 @@
     "marketplace:assets": "electron scripts/generate-marketplace-assets.cjs",
     "start": "electron .",
     "test:state": "node scripts/test-codex-state.cjs",
+    "test:bundled-plugin": "node scripts/test-bundled-plugin.cjs",
     "qa:electron": "node scripts/qa-electron.cjs",
     "streamdeck:build": "npm --prefix stream-deck run build",
     "streamdeck:validate": "npm --prefix stream-deck run validate",
@@ -72,6 +73,10 @@
       {
         "from": "build/trayTemplate@2x.png",
         "to": "trayTemplate@2x.png"
+      },
+      {
+        "from": "stream-deck/com.roie.deck-threads.sdPlugin",
+        "to": "stream-deck-plugin/com.roie.deck-threads.sdPlugin"
       }
     ],
     "directories": {

scripts/test-bundled-plugin.cjs

@@ -0,0 +1,41 @@
+const assert = require("node:assert/strict");
+const fs = require("node:fs");
+const os = require("node:os");
+const path = require("node:path");
+const { installBundledStreamDeckPlugin } = require("../electron/stream-deck-plugin-install.cjs");
+
+async function main() {
+  const root = fs.mkdtempSync(path.join(os.tmpdir(), "deck-threads-plugin-test-"));
+  const source = path.join(root, "source", "com.roie.deck-threads.sdPlugin");
+  const destination = path.join(root, "plugins", "com.roie.deck-threads.sdPlugin");
+  try {
+    fs.mkdirSync(source, { recursive: true });
+    fs.writeFileSync(path.join(source, "manifest.json"), JSON.stringify({ Version: "1.0.0" }));
+    fs.writeFileSync(path.join(source, "plugin.js"), "current");
+
+    const installed = await installBundledStreamDeckPlugin(source, destination);
+    assert.equal(installed.status, "installed");
+    assert.equal(fs.readFileSync(path.join(destination, "plugin.js"), "utf8"), "current");
+
+    const unchanged = await installBundledStreamDeckPlugin(source, destination);
+    assert.equal(unchanged.status, "up-to-date");
+
+    fs.writeFileSync(path.join(source, "manifest.json"), JSON.stringify({ Version: "1.1.0" }));
+    fs.writeFileSync(path.join(source, "plugin.js"), "updated");
+    const updated = await installBundledStreamDeckPlugin(source, destination);
+    assert.equal(updated.status, "installed");
+    assert.equal(updated.version, "1.1.0");
+    assert.equal(fs.readFileSync(path.join(destination, "plugin.js"), "utf8"), "updated");
+
+    const missing = await installBundledStreamDeckPlugin(path.join(root, "missing"), destination);
+    assert.equal(missing.status, "not-bundled");
+  } finally {
+    fs.rmSync(root, { recursive: true, force: true });
+  }
+  console.log("Bundled Stream Deck plugin installation verified.");
+}
+
+main().catch((error) => {
+  console.error(error);
+  process.exitCode = 1;
+});