9router

601 Commits 3 Branches 0 Tags

2 Commits

Author	SHA1	Message	Date
Tri Dung Nguyen	5327a7dc30	fix(autostart): work on nvm + npm 9/10, actually register with launchctl (fixes #1082 ) (#1104 ) * fix(autostart): resolve cli.js path locally, register with launchctl, verify state The current `cli/src/cli/tray/autostart.js` is silently broken on every nvm install (and likely Volta / asdf / Homebrew / user-prefix npm) and on every npm version >= 9. Enabling auto-start from the tray menu writes a launchd plist that references a non-existent script; the menu then reports "✓ Auto-start Enabled" because the existence check only verifies the file is on disk. On the next OS boot launchd fails with MODULE_NOT_FOUND. None of this surfaces to the user. This rewrite addresses the four problems reported in #1082: 1. `npm bin -g` was removed in npm 9. autostart.js called it as a primary resolution mechanism and silently fell back to a hardcoded `/usr/local/lib/node_modules/9router/cli.js` path on failure. Replaced with a `getCliJsPath()` helper that tries (in order): the explicit `cliPath` argument, `process.argv[1]` when it's our own cli.js, and a path computed relative to autostart.js's own location (since this file always lives at `<pkg>/src/cli/tray/autostart.js`, cli.js is three levels up regardless of install layout). Returns null on no match. 2. The `/usr/local/...` fallback was outright wrong for nvm/Volta/asdf installs. Dropped entirely. If no candidate resolves, return false instead of writing a plist pointing at a missing script. 3. `enableMacOS()` never called `launchctl load -w`, only `unload`. The plist was therefore inert until the next user login, with no signal to the user that anything was wrong. Now it unloads (defensive, in case of re-enable) and then loads, so the agent is active in the current session. 4. `isAutoStartEnabled()` on macOS only checked file existence — so the tray menu reported "✓ Enabled" even when launchd had the agent in a failed state or hadn't loaded it. Now also runs `launchctl list ${APP_LABEL}` and only returns true if launchd recognizes the label. Additional changes for robustness: - The macOS plist now invokes node + cli.js directly with absolute paths instead of wrapping in `zsh -l -c "..."`. The shell-wrapper approach depended on the user's login shell sourcing nvm/PATH correctly, which is fragile (nvm.sh sourcing varies between users; some setups don't add node to PATH from a non-interactive login shell). - `EnvironmentVariables.PATH` in the plist now explicitly includes node's bin directory plus the standard system paths, so child processes spawned by cli.js (e.g. the runtime `npm install` calls) can still resolve `npm` even under launchd's minimal default env. - Windows and Linux paths were calling `npm bin -g` with the same fallback problem; both now use `getCliJsPath()` consistently. The Windows VBS branch is simplified (always run node+cli.js, drop the `9router.cmd` lookup that depended on the npm prefix path). - Removed the unused `getStartCommand()` helper that was never imported. Fixes #1082 * fix(autostart): skip launchctl unload/load when current process is the agent When the running 9router cli.js was itself spawned by the autostart launchd agent (after a reboot when autostart was previously enabled), clicking the tray menu's "Disable Auto-start" item would unload the agent — and that unload sends SIGTERM to the running process, killing the click handler and the tray icon before the menu could flip its label. Add a small `isAgentSelfMacOS()` probe (parses `launchctl list ${label}` and compares the PID against `process.pid`). When we're the agent itself, disable skips the unload (the plist file removal is enough to prevent the agent from starting on the next login) and enable skips the load (the plist is already loaded under our own PID, the on-disk update is what matters for next boot). External callers — e.g. enable from a manually-launched 9router or from a script — still get the full unload/load behavior they need. Without this, the tray UX after a reboot was: click Disable -> tray icon silently disappears, no menu label change. Now: click Disable -> label flips to "Enable Auto-start", tray stays, plist removed; click Enable again -> label flips back, plist re-created.	2026-05-14 09:57:05 +07:00
Tri Dung Nguyen	5cab23d92e	fix(tray): switch macOS/Linux tray to systray2 fork (#1080 ) 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	2026-05-13 15:30:33 +07:00

Author

SHA1

Message

Date

Tri Dung Nguyen

5327a7dc30

fix(autostart): work on nvm + npm 9/10, actually register with launchctl (fixes #1082 ) (#1104 )

* fix(autostart): resolve cli.js path locally, register with launchctl, verify state

The current `cli/src/cli/tray/autostart.js` is silently broken on every nvm
install (and likely Volta / asdf / Homebrew / user-prefix npm) and on every
npm version >= 9. Enabling auto-start from the tray menu writes a launchd
plist that references a non-existent script; the menu then reports
"✓ Auto-start Enabled" because the existence check only verifies the file is
on disk. On the next OS boot launchd fails with MODULE_NOT_FOUND. None of
this surfaces to the user.

This rewrite addresses the four problems reported in #1082:

1. `npm bin -g` was removed in npm 9. autostart.js called it as a primary
   resolution mechanism and silently fell back to a hardcoded
   `/usr/local/lib/node_modules/9router/cli.js` path on failure. Replaced
   with a `getCliJsPath()` helper that tries (in order): the explicit
   `cliPath` argument, `process.argv[1]` when it's our own cli.js, and a
   path computed relative to autostart.js's own location (since this file
   always lives at `<pkg>/src/cli/tray/autostart.js`, cli.js is three
   levels up regardless of install layout). Returns null on no match.

2. The `/usr/local/...` fallback was outright wrong for nvm/Volta/asdf
   installs. Dropped entirely. If no candidate resolves, return false
   instead of writing a plist pointing at a missing script.

3. `enableMacOS()` never called `launchctl load -w`, only `unload`. The
   plist was therefore inert until the next user login, with no signal to
   the user that anything was wrong. Now it unloads (defensive, in case of
   re-enable) and then loads, so the agent is active in the current session.

4. `isAutoStartEnabled()` on macOS only checked file existence — so the
   tray menu reported "✓ Enabled" even when launchd had the agent in a
   failed state or hadn't loaded it. Now also runs `launchctl list
   ${APP_LABEL}` and only returns true if launchd recognizes the label.

Additional changes for robustness:

- The macOS plist now invokes node + cli.js directly with absolute paths
  instead of wrapping in `zsh -l -c "..."`. The shell-wrapper approach
  depended on the user's login shell sourcing nvm/PATH correctly, which is
  fragile (nvm.sh sourcing varies between users; some setups don't add
  node to PATH from a non-interactive login shell).
- `EnvironmentVariables.PATH` in the plist now explicitly includes node's
  bin directory plus the standard system paths, so child processes spawned
  by cli.js (e.g. the runtime `npm install` calls) can still resolve `npm`
  even under launchd's minimal default env.
- Windows and Linux paths were calling `npm bin -g` with the same fallback
  problem; both now use `getCliJsPath()` consistently. The Windows VBS
  branch is simplified (always run node+cli.js, drop the `9router.cmd`
  lookup that depended on the npm prefix path).
- Removed the unused `getStartCommand()` helper that was never imported.

Fixes #1082

* fix(autostart): skip launchctl unload/load when current process is the agent

When the running 9router cli.js was itself spawned by the autostart launchd
agent (after a reboot when autostart was previously enabled), clicking the
tray menu's "Disable Auto-start" item would unload the agent — and that
unload sends SIGTERM to the running process, killing the click handler and
the tray icon before the menu could flip its label.

Add a small `isAgentSelfMacOS()` probe (parses `launchctl list ${label}` and
compares the PID against `process.pid`). When we're the agent itself,
disable skips the unload (the plist file removal is enough to prevent the
agent from starting on the next login) and enable skips the load (the plist
is already loaded under our own PID, the on-disk update is what matters for
next boot). External callers — e.g. enable from a manually-launched 9router
or from a script — still get the full unload/load behavior they need.

Without this, the tray UX after a reboot was: click Disable -> tray icon
silently disappears, no menu label change. Now: click Disable -> label
flips to "Enable Auto-start", tray stays, plist removed; click Enable again
-> label flips back, plist re-created.

2026-05-14 09:57:05 +07:00

Tri Dung Nguyen

5cab23d92e

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

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

2026-05-13 15:30:33 +07:00