luulam/9router
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

fix(tray): switch macOS/Linux tray to systray2 fork (#1080)

Browse Source 
The legacy `systray@1.0.5` package (last published 2018) bundles a 2017
x86_64 Go binary whose Mach-O headers are rejected by modern dyld (macOS
14+ / Apple Silicon). The result on affected systems was that
`9router --tray` (and "Hide to Tray" from the interactive menu) printed
"Router is now running in system tray" but no menubar icon appeared —
the failure was silently swallowed by `catch (err) { return null }`.

This swaps the runtime tray library for `systray2@2.1.4`, which embeds
the maintained getlantern/systray-portable binaries that work on macOS
14+ under Rosetta. Changes:

- hooks/trayRuntime.js: install `systray2@2.1.4` (not `systray@1.0.5`)
  into ~/.9router/runtime/node_modules. Always purge the legacy systray
  package on every run — its binary is broken on macOS and an AV false
  positive on Windows. chmod +x the bundled Go binary in case the npm
  tarball drops the executable bit (observed on macOS).
- src/cli/tray/tray.js: resolveSystray() now prefers systray2 with a
  fallback to legacy systray for safety. initUnixTray() uses the new
  .ready() promise API, surfaces failures to stderr instead of silently
  returning null, and sets isTemplateIcon:false so the full-color
  icon.png renders correctly (template mode would show a solid white
  square because only the alpha channel is used). killTray() passes
  false to systray2's kill so it doesn't call process.exit(0) before
  the rest of cleanup (server SIGKILL, MITM/tunnel) runs.
- package.json: update the `comment_systray` field to describe the new
  package choice.

Fixes #1079
This commit is contained in:
Tri Dung Nguyen
2026-05-13 15:30:33 +07:00
committed by GitHub
parent 003be82d97
commit 5cab23d92e
3 changed files with 109 additions and 31 deletions
Download Patch File Download Diff File Expand all files Collapse all files

79
cli/src/cli/tray/tray.js
View File

@@ -140,37 +140,75 @@ function initWindowsTray(options) {
/**
* macOS/Linux tray via systray binary
*
* Prefers `systray2` (active fork of `systray`, ships newer
* getlantern/systray-portable binaries that work on macOS 14+ and Apple
* Silicon under Rosetta). Falls back to legacy `systray@1.0.5` if systray2
* is not available, though that binary's Mach-O headers are rejected by
* modern dyld and the icon will not appear.
*/
function resolveSystray() {
// Try local first (dev), then runtime dir (production lazy install)
try {
return require("systray").default;
} catch (e) {}
let runtimeDir = null;
try {
const { getRuntimeNodeModules } = require("../../../hooks/sqliteRuntime");
const systrayPath = path.join(getRuntimeNodeModules(), "systray");
return require(systrayPath).default;
} catch (e) {
return null;
runtimeDir = getRuntimeNodeModules();
} catch (e) {}
// 1) systray2 in runtime dir (where ensureTrayRuntime installs it)
if (runtimeDir) {
try { return { mod: require(path.join(runtimeDir, "systray2")).default, isV2: true }; } catch (e) {}
}
// 2) systray2 resolvable from the package's own node_modules / NODE_PATH
try { return { mod: require("systray2").default, isV2: true }; } catch (e) {}
// 3) Legacy systray fallback (unlikely to render on modern macOS)
try { return { mod: require("systray").default, isV2: false }; } catch (e) {}
if (runtimeDir) {
try { return { mod: require(path.join(runtimeDir, "systray")).default, isV2: false }; } catch (e) {}
}
return null;
}
function chmodTrayBin(pkgName) {
// systray2's npm tarball occasionally lands without +x on the bundled Go
// binary (observed on macOS). spawn() then fails with EACCES. Best-effort
// chmod on every init avoids a hard-to-diagnose silent tray failure.
try {
const { getRuntimeNodeModules } = require("../../../hooks/sqliteRuntime");
const binName = process.platform === "darwin" ? "tray_darwin_release" : "tray_linux_release";
const candidates = [
path.join(getRuntimeNodeModules(), pkgName, "traybin", binName),
path.join(__dirname, "..", "..", "..", "node_modules", pkgName, "traybin", binName)
];
for (const p of candidates) {
if (fs.existsSync(p)) fs.chmodSync(p, 0o755);
}
} catch (e) {}
}
function initUnixTray(options) {
const { port } = options;
try {
const SysTray = resolveSystray();
if (!SysTray) return null;
const resolved = resolveSystray();
if (!resolved) return null;
const { mod: SysTray, isV2 } = resolved;
chmodTrayBin(isV2 ? "systray2" : "systray");
const autostartEnabled = getAutostartEnabled();
const items = buildMenuItems(port, autostartEnabled);
const menu = {
icon: getIconBase64(),
// The bundled icon.png is a full-color RGBA logo. Don't mark it as a
// template icon: macOS would then render it as a solid white square
// because template mode only uses the alpha channel.
isTemplateIcon: false,
title: "",
tooltip: `9Router - Port ${port}`,
items
};
trayInstance = new SysTray({ menu, debug: false, copyDir: true });
trayInstance = new SysTray({ menu, debug: false, copyDir: false });
isWinTray = false;
trayInstance.onClick((action) => {
@@ -187,11 +225,21 @@ function initUnixTray(options) {
});
});
trayInstance.onReady(() => {});
trayInstance.onError(() => {});
if (isV2) {
// systray2 exposes a ready() promise instead of onReady/onError. Surface
// failures (binary crash, EACCES, etc.) so users can see why the icon
// didn't appear instead of getting a misleading "running in tray" log.
trayInstance.ready().catch((err) => {
process.stderr.write(`[9router] tray failed to start: ${err && err.message ? err.message : err}\n`);
});
} else {
trayInstance.onReady(() => {});
trayInstance.onError(() => {});
}
return trayInstance;
} catch (err) {
process.stderr.write(`[9router] tray init error: ${err.message}\n`);
return null;
}
}
@@ -207,7 +255,10 @@ function killTray() {
if (instance) {
try {
if (wasWin) instance.kill();
else instance.kill(true);
// systray2.kill(true) defaults to calling process.exit(0) which aborts
// the rest of cleanup (server SIGKILL, MITM/tunnel cleanup). Pass false
// so callers stay in control of process exit.
else instance.kill(false);
} catch (e) {}
}
}