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

59
cli/hooks/trayRuntime.js
View File

@@ -1,27 +1,34 @@
// Lazy install systray for macOS/Linux into USER_DATA_DIR/runtime/node_modules.
// Lazy install systray2 for macOS/Linux into USER_DATA_DIR/runtime/node_modules.
// Windows uses PowerShell NotifyIcon (no binary) → no systray needed.
// This keeps the published npm tarball free of unsigned Go binaries that
// trigger antivirus false positives (e.g. Kaspersky flagging tray_windows.exe).
//
// We use the maintained `systray2` fork. The original `systray@1.0.5` package
// bundles a 2017 x86_64 Go binary whose Mach-O headers are rejected by modern
// dyld (macOS 14+), so the tray silently fails to register on Apple Silicon.
const { spawnSync } = require("child_process");
const fs = require("fs");
const path = require("path");
const { getRuntimeDir, getRuntimeNodeModules } = require("./sqliteRuntime");
const SYSTRAY_VERSION = "1.0.5";
const SYSTRAY_PKG = "systray2";
const SYSTRAY_VERSION = "2.1.4";
const LEGACY_SYSTRAY_PKG = "systray";
function hasSystray() {
return fs.existsSync(path.join(getRuntimeNodeModules(), "systray", "package.json"));
return fs.existsSync(path.join(getRuntimeNodeModules(), SYSTRAY_PKG, "package.json"));
}
// Remove legacy systray from all known locations on Windows (AV false positive cleanup)
function cleanupWindowsSystray({ silent = false } = {}) {
if (process.platform !== "win32") return;
// 1) Runtime dir: %APPDATA%\9router\runtime\node_modules\systray
// 2) npm global nested: <npm_prefix>\node_modules\9router\node_modules\systray
// __dirname here = <npm_prefix>\node_modules\9router\hooks → up 1 = pkg root
// Remove the legacy `systray` package from all known locations.
// On Windows it was an AV false-positive risk; on macOS/Linux its bundled
// binary is broken on modern OS versions.
function cleanupLegacySystray({ silent = false } = {}) {
// 1) Runtime dir: ~/.9router/runtime/node_modules/systray (or %APPDATA% on Win)
// 2) npm global nested: <npm_prefix>/node_modules/9router/node_modules/systray
// __dirname here = <pkg root>/hooks → up 1 = pkg root
const targets = [
path.join(getRuntimeNodeModules(), "systray"),
path.join(__dirname, "..", "node_modules", "systray")
path.join(getRuntimeNodeModules(), LEGACY_SYSTRAY_PKG),
path.join(__dirname, "..", "node_modules", LEGACY_SYSTRAY_PKG)
];
for (const dir of targets) {
if (fs.existsSync(dir)) {
@@ -35,6 +42,21 @@ function cleanupWindowsSystray({ silent = false } = {}) {
}
}
// systray2's npm tarball sometimes ships the bundled Go binary without the
// executable bit set on macOS, causing spawn() to fail with EACCES. Set +x
// best-effort so the tray actually starts.
function chmodSystrayBin({ silent = false } = {}) {
if (process.platform === "win32") return;
const binName = process.platform === "darwin" ? "tray_darwin_release" : "tray_linux_release";
const binPath = path.join(getRuntimeNodeModules(), SYSTRAY_PKG, "traybin", binName);
if (!fs.existsSync(binPath)) return;
try {
fs.chmodSync(binPath, 0o755);
} catch (e) {
if (!silent) console.warn(`[9router][runtime] chmod tray bin failed: ${e.message}`);
}
}
function ensureRuntimeDir() {
const dir = getRuntimeDir();
if (!fs.existsSync(dir)) fs.mkdirSync(dir, { recursive: true });
@@ -63,20 +85,25 @@ function npmInstall(pkgs, { silent = false } = {}) {
return res.status === 0;
}
// Public: ensure systray is installed on macOS/Linux only.
// Public: ensure systray2 is installed on macOS/Linux only.
// Windows skips entirely (uses PowerShell tray).
function ensureTrayRuntime({ silent = false } = {}) {
// Always evict the legacy `systray` package — its binary is broken on
// modern macOS and an AV false-positive on Windows.
cleanupLegacySystray({ silent });
if (process.platform === "win32") {
cleanupWindowsSystray({ silent });
return { systray: false, skipped: true };
}
if (hasSystray()) {
if (!silent) console.log("[9router][runtime] systray OK");
chmodSystrayBin({ silent });
if (!silent) console.log("[9router][runtime] systray2 OK");
return { systray: true };
}
const ok = npmInstall([`systray@${SYSTRAY_VERSION}`], { silent });
const ok = npmInstall([`${SYSTRAY_PKG}@${SYSTRAY_VERSION}`], { silent });
if (ok) chmodSystrayBin({ silent });
if (!ok && !silent) {
console.warn("[9router][runtime] systray install failed (tray will be disabled)");
console.warn("[9router][runtime] systray2 install failed (tray will be disabled)");
}
return { systray: ok && hasSystray() };
}