Compare commits

...

48 commits

Author SHA1 Message Date
Ebeneezer (Hermes Agent)
bbce7f0100 docs: sync README/manifest to v0.2.1 behavior and i18n keys
Written by AI agent working for @jtmorris. Model: Grok 4.5.
2026-07-15 01:11:59 -07:00
Ebeneezer (Hermes Agent)
7c31598594 fix(ui): layout spacer, peer empty state, busy mutex, style
- RowLayout + real Layout.fillWidth spacer (#18)
- ListView boundsBehavior StopAtBounds (#27)
- Show Not connected empty state when disconnected (#55)
- Single-flight _busy guard across status/toggle/exit/copy
- Inline exit-node active/clear checks (no over-abstract predicates)
- Terminate JS statements in QML handlers with semicolons

Written by AI agent working for @jtmorris. Model: Grok 4.5.
2026-07-15 01:11:59 -07:00
Ebeneezer (Hermes Agent)
61626dff51 fix: clear disconnected peer state; abort toggle on failed status poll
- parseStatusResult returns empty peers/IP/exit node when BackendState
  is not Running so the UI cannot show a stale node list (#55)
- commandForPendingAction requires statusOk; never invents up/down from
  a failed truth poll
- Relax hostname validation for multi-label MagicDNS names (max 253)
- Drop trivial shouldShowClearExitNode / isActiveExitNode exports
- Expand unit tests for the above and export surface

Written by AI agent working for @jtmorris. Model: Grok 4.5.
2026-07-15 01:11:59 -07:00
00a40a9aa2 Cleaned up agent comment. 2026-05-25 03:00:33 +00:00
3986ee3490 fix: remove duplicate version key from plugin.json and modernize for-in loop in lib.js
- plugin.json contained duplicate "version" keys ("0.1.0" then "0.2.0"); JSON parsers take the last value so it appeared to work, but this is invalid per spec and a maintenance hazard.
- findActiveExitNode used legacy for-in + hasOwnProperty guard; replaced with Object.keys() for modern, safe iteration (now consistent with parsePeers and the rest of lib.js).
- All 36 unit tests pass after the change.

Written by AI agent working for @jtmorris. Model: grok-build-0.1.
2026-05-25 03:00:33 +00:00
3403bf2c15 Made some tweaks to comments to remove non-useful agent noise. 2026-05-25 03:00:33 +00:00
4b9d6ce6d8 chore(polish): manifest, docs, tests, and nits for dms-plugin-dev alignment
- plugin.json: added capabilities + requires; bumped to 0.2.0
- README: corrected "auto-refresh" claim (now documents the intentional on-demand + defensive poll-act-poll); added Implementation notes section covering Proc + I18n + best practices
- test/lib.test.js: updated the manual verification comment (now references Proc + preserved behavior)
- Minor version references in README example + caption
- All changes keep exact toggle semantics and follow repo style

Written by AI agent working for @jtmorris. Model: grok-build-0.1.
2026-05-25 03:00:33 +00:00
843e3d01f0 feat(proc): direct drop-in port from 4x raw Process to Proc singleton (exact poll-act-poll behavior preserved)
- Removed import Quickshell.Io + all 4 Process { toggleProcess, copyProcess, exitNodeProcess, statusCheck }
- All one-shot commands now use Proc.runCommand(id, argv, (stdout, exitCode) => {...})
- _pendingAction moved to clean root property (was hacked onto statusCheck object)
- Introduced _runStatusCheck() helper + updated wrappers (toggleTailscale, refreshStatus, setExitNode, copyToClipboard, _runNextCopy)
- Exact same sequencing and defensive logic:
  * toggle: set pending → status poll for truth → decide up/down → act → post-act status verify
  * copy retry state machine unchanged (just Proc instead of .command/.running)
  * exit-node and generic refresh paths identical
- Added explicit comment documenting why the poll-act-poll exists (defensive, not forbidden state per AGENTS.md)
- stderr detail dropped from action errors (per chosen A strategy; generic messages only)
- All new JS follows repo ; + {} style
- I18n wrappers already in place from prior slice

Written by AI agent working for @jtmorris. Model: grok-build-0.1.
2026-05-25 03:00:33 +00:00
cb280d1e4e feat(i18n): wrap all user-facing strings in TailscaleWidget.qml with I18n.tr (strategy A)
- header, details, exit node prefix/none, invalid hostname, copied (with .arg), all formatError toasts
- Glyph literals ("×", "↗", "—") left as-is (decorative, not linguistic)
- "tailscalectl" toast titles kept as technical IDs
- All call sites now go through I18n for future translation
- Tests unaffected (still green)

Written by AI agent working for @jtmorris. Model: grok-build-0.1.
2026-05-25 03:00:33 +00:00
7942bc3471 feat(i18n): make lib.js strings I18n source keys (strategy A); remove dead symbol exports; update tests; add i18n/ scaffolding + en.json placeholder
- getStrings().copied now returns template key "Copied %1 to clipboard" (interpolation at QML call site via .arg)
- Removed unused clearExitNode/setExitNode from getStrings (were dead code)
- Tests updated for new shape while preserving coverage
- New tailscalectl/i18n/ with README + en.json for future-proofing (per dms-plugin-dev best practice)
- Exact behavior preserved; no logic changes

Written by AI agent working for @jtmorris. Model: grok-build-0.1.
2026-05-25 03:00:33 +00:00
aacc027984 style: strictly enforce semicolon termination + curly braces on all JS statements
- lib.js, test/lib.test.js, and all executable JS in TailscaleWidget.qml (onExited handlers, custom methods, onClicked blocks) now terminate every statement with ;
- All if/for/while blocks use {} even for single statements (per repo code style rules)
- No behavior change; all tests continue to pass
- This was the missing follow-up to the previous refactor (the changes existed in the working tree but were never committed on the feature branch)

Written by AI agent working for @jtmorris. Model: grok-build-0.1.
2026-05-25 03:00:33 +00:00
7b41d7177f refactor: extract toggle decision logic to lib.js and scope one-shot coordination to statusCheck Process
- Add PendingAction constant and commandForPendingAction pure function (fully tested)
- Remove root _pendingToggle property
- Use dynamic _pendingAction on the statusCheck Process for the fresh-status hand-off
- Introduce refreshStatus() helper and deduplicate the two post-action refresh sites
- All JS statements now terminate with semicolons; all blocks use braces
- Behavior unchanged; coordination token no longer leaks to widget root
- Enables future post-status actions without adding more root properties

Written by AI agent working for @jtmorris. Model: grok-build-0.1.
2026-05-25 03:00:33 +00:00
12ef07040c Code formatting cleanup. 2026-05-25 03:00:33 +00:00
b02f8ba45b test: update coverage comment to reflect current reality
- Remove all historical references (#48, first-principles, newly extracted, etc.)
- Remove mentions of deleted components (5s Timer, old copy state machine)
- Make the comment strictly about what the tests actually cover and the real shortcoming (no automated QML coverage)
- Per request: code comments exist to explain the code, not preserve history
2026-05-25 03:00:33 +00:00
6e4e5d51ec refactor(clipboard): replace object map + 4 helpers with simple array + getClipboardCommands; QML becomes dumb index driver
- lib.js: single clipboardTools array + getClipboardCommands(text) returning argv lists
- Delete validateClipboardTool, buildCopyCommand, nextClipboardTool, allClipboardTools, safeClipboardTools, old clipboardTools object
- Remove noClipboardTool / invalidClipboardCommand from getStrings (dead)
- TailscaleWidget.qml: remove _copyCurrentTool + _executeCopy; add _copyIndex + _runNextCopy
- copyProcess.onExited and copyToClipboard now purely index-driven, no tool names
- Update tests: remove 4 old clipboard test blocks + dead string assertions; add focused getClipboardCommands tests
- All 34 tests pass

This is the minimal honest design given Process is a QML type.
2026-05-25 03:00:33 +00:00
e695db6650 security: validate hostname in makeExitNodeCommand (balanced paranoia, direct-argv defense-in-depth, TDD) 2026-05-25 03:00:33 +00:00
a40d8d49a4 refactor: centralize remaining error paths and popout strings via formatError + getStrings (final polish pass) 2026-05-25 03:00:33 +00:00
4a7803dc42 refactor: simplify copy path — drop caching and multi-tool retry state machine, keep simple dms→wl-copy fallback (first-principles plan) 2026-05-25 03:00:33 +00:00
5ace4095c6 feat: remove 5-second refreshTimer — first major step toward low-duty-cycle architecture (on-demand + post-action verification only) 2026-05-25 03:00:33 +00:00
619c988f56 chore: remove historical issue-chasing comments from QML and lib.js (per first-principles plan) 2026-05-25 03:00:33 +00:00
9dd73b6d55 refactor: add getStatusCommand pure helper + test (TDD step 2 — prepares low-duty-cycle status calls) 2026-05-25 03:00:33 +00:00
6b71197770 refactor: introduce formatError centralizer + remove first batch of historical comments (TDD step 1 of first-principles plan) 2026-05-25 03:00:33 +00:00
ee36ae5c72 chore: evaluate structured logging per AGENTS.md rule 1 — no addition justified (#47)
- Existing toasts + truncated stderr provide the actionable information for users and errors
- Adding persistent debug logs would introduce state, rotation, and maintenance concerns
- with no demonstrable improvement to UX, decisions, or security for normal operation
- Explicit no-op commit closes the planning issue

Written by AI agent working for @jtmorris. Model: Grok build-0.1.
2026-05-25 03:00:33 +00:00
e1569dd870 fix: eliminate toggle decision staleness via poll-then-act (no cached desired state) (#42)
- toggleTailscale() now forces a fresh statusCheck instead of reading possibly-stale root.isConnected
- The actual up/down decision happens in statusCheck.onExited using the just-received value
- _pendingToggle is a transient one-shot flag (reset immediately after use) — not a persistent 'desired state' cache
- Complies with AGENTS.md rule 1 / #11

Written by AI agent working for @jtmorris. Model: Grok build-0.1.
2026-05-25 03:00:33 +00:00
b10503f4d5 test: coverage for newly extracted pure helpers; document Process/Widget manual verification boundary (#48)
- The new helpers from #43 are now under test
- Added explicit comment explaining that full lifecycle + timing + QML behavior remains manual verification only (no QML test runner exists)

Written by AI agent working for @jtmorris. Model: Grok build-0.1.
2026-05-25 03:00:33 +00:00
440e954099 refactor: extract shouldShowClearExitNode and isActiveExitNode to lib.js (TDD) — light progress on #43
- Two small pure UI predicates moved out of QML delegate
- QML now calls TailscaleLib.* (thinner glue)
- New tests + all existing tests pass
- No new state, no architecture change

Written by AI agent working for @jtmorris. Model: Grok build-0.1.
2026-05-25 03:00:33 +00:00
925233dfb9 feat: extract UI strings to lib.js; harden clipboard to direct argv, drop clipmanctl (#34, #49)
- safeClipboardTools now only dms + wl-copy (clipmanctl removed as niche optional history manager)
- buildCopyCommand now returns pure argv arrays (no sh -c, no escaping, eliminates future injection risk)
- Added getStrings() for centralised user-facing strings (prep for real i18n)
- Updated all tests (TDD) and README
- All 29 tests pass

Written by AI agent working for @jtmorris. Model: Grok build-0.1.
2026-05-25 03:00:33 +00:00
89d95cb864 chore: remaining issues batch progress (#23-#34) 2026-05-25 03:00:33 +00:00
62a364d14e chore: JS quality batch (#20 for-in guard, #21 add edge tests, #22 dedup errorMessage keys) 2026-05-25 03:00:33 +00:00
2a53748895 chore: batch minor layout fixes (#18, #19, #27) - Row anchors, boundsBehavior 2026-05-25 03:00:33 +00:00
8a31851769 chore: verify copyProcess already has proper onExited exit-status check + success toast
Toast moved out of copyToClipboard() into onExited (code===0 path).
Fallback clipboard rotation also present.
Issue #17 already addressed by existing implementation.
Fixes #17
2026-05-25 03:00:33 +00:00
cafc281949 chore: confirm single authoritative error path for statusCheck
parseStatusResult safely catches JSON errors (lib.js:68).
onStreamFinished performs no toasts.
All failure toasts centralized in statusCheck.onExited (TailscaleWidget.qml:103).
Eliminates historical double-toast spam described in #13.
Fixes #13
2026-05-25 03:00:33 +00:00
028be9d571 Better scoped semicolon coding style. 2026-05-25 03:00:33 +00:00
1cb01144a5 Added some opinionated coding style guidelines. 2026-05-25 03:00:33 +00:00
1a937a8249 fix: remove binaryAvailable, fix statusCheck parser location, add timer guard
- Revert binaryAvailable property: reintroduced stale-state anti-pattern
  already rejected in #11. All error paths already handled by Process
  onExited handlers.
- Move statusCheck parsing from onStreamFinished to onExited (#38):
  parser now only runs after exit code validation, preventing stale
  data from being applied on failure.
- Add refreshTimer guard (#44): timer no longer spawns new statusCheck
  while one is already running.

Closes #38, #44. Reverts #52 partial fix.
2026-05-25 03:00:33 +00:00
afdcba9d4c fix: remove propagateComposedEvents and fix plugin author (#50, #51)
- TailscaleWidget.qml: remove propagateComposedEvents from right-click MouseArea
- plugin.json: clean up author string
2026-05-25 03:00:33 +00:00
da4d566f0c fix: lib.js security and correctness fixes (#40, #41)
- parsePeers: add hasOwnProperty guard and filter null entries
- findActiveExitNode: add hasOwnProperty guard to for..in loop
- makeExitNodeCommand: handle empty hostname correctly
2026-05-25 03:00:33 +00:00
f08b01314e chore: remaining issues batch progress (#23-#34) 2026-05-25 03:00:33 +00:00
2a6b3aea6a chore: JS quality batch (#20 for-in guard, #21 add edge tests, #22 dedup errorMessage keys) 2026-05-25 03:00:33 +00:00
2bad002c69 chore: batch minor layout fixes (#18, #19, #27) - Row anchors, boundsBehavior 2026-05-25 03:00:33 +00:00
97ec919170 chore: verify copyProcess already has proper onExited exit-status check + success toast
Toast moved out of copyToClipboard() into onExited (code===0 path).
Fallback clipboard rotation also present.
Issue #17 already addressed by existing implementation.
Fixes #17
2026-05-25 03:00:33 +00:00
2fa5694895 fix: remove unused settings_read/settings_write permissions from plugin.json
Only process permission is required for tailscale + clipboard commands.
Least-privilege fix. Fixes #16
2026-05-25 03:00:33 +00:00
b6ead317e1 fix: add running guards to prevent concurrent toggleProcess/exitNodeProcess
Rapid clicks or slow ops no longer spawn duplicate tailscale invocations.
Matches existing pattern used for copyProcess safety.
Fixes #15
2026-05-25 03:00:33 +00:00
42d3bef5c6 fix: capture intended toggle action at click time to avoid stale isConnected in error toast
Store _pendingToggleAction before starting toggleProcess.
Use it in onExited instead of live root.isConnected.
Prevents 'Failed to disconnect' when user actually clicked connect.
Fixes #14
2026-05-25 03:00:33 +00:00
dce33692ad chore: confirm single authoritative error path for statusCheck
parseStatusResult safely catches JSON errors (lib.js:68).
onStreamFinished performs no toasts.
All failure toasts centralized in statusCheck.onExited (TailscaleWidget.qml:103).
Eliminates historical double-toast spam described in #13.
Fixes #13
2026-05-25 03:00:33 +00:00
3d62e4c4b2 fix: remove redundant binaryAvailable guard from TailscaleWidget.qml
Removes stale one-way property, guards, and dead UI branch.
Error handling already covered by Process onExited handlers.
Fixes #11
2026-05-25 03:00:33 +00:00
6385f6b19c Professionalize the author name. 2026-05-25 02:49:59 +00:00
5523738dc5 Added guard against useless state caching anti-pattern AI agents keep insisting on.
Multiple LLMs keep trying to revert issue #11 unless specifically argued against, and keep sneaking it into code. Other, similar examples of this pathological insistence on storing/caching state that offers no tangible benefit warranting the complexity and edge cases have been tried, but headed off by me earlier.
2026-05-21 09:15:27 +00:00
8 changed files with 843 additions and 391 deletions

127
AGENTS.md
View file

@ -5,6 +5,8 @@ You **MUST** read each of these documents before contributing to this repository
- Repo interaction rules: `docs/agents/repo-instructions.md`
- Domain model & context rules: `docs/agents/domain.md`
---
## Critical Coding & Version Control Conduct
- **NEVER** commit directly to `master` or `testing without explicit human instruction.
@ -12,5 +14,128 @@ You **MUST** read each of these documents before contributing to this repository
- **ALWAYS** create new branches when working on non-trivial coding tasks.
- **ALWAYS** commit self-contained logical unit of work.
---
## Issues, PRs, and Comments Conduct
- **ALWAYS** end your written contributions with `Written by AI agent working for @jtmorris. Model: <MODEL NAME>.`. Replace `<MODEL NAME>` with the LLM model, version, and, if relevant, number of parameters. For example: `Claude Sonnet 4.7`, `Grok 4.3`, `Qwen 3.6 27B`.
- **ALWAYS** end your written contributions with `Written by AI agent working for @jtmorris. Model: <MODEL NAME>.`. Replace `<MODEL NAME>` with the LLM model, version, and, if relevant, number of parameters. For example: `Claude Sonnet 4.7`, `Grok 4.3`, `Qwen 3.6 27B`.
---
## Critical Design Rules
### 1. Only Store or Cache State When It Serves a Purpose
**Never store or cache state unless doing so meets at least one of:**
1. It is the authoritative source of truth owned by this component.
2. It delivers actionable feedback that meaningfully improves the user experience or a decision.
3. It provides a demonstrable and reasonably argued security or performance improvement (the burden of proof is on the proposer).
4. The information cannot be obtained at the moment it is needed and keeping it produces a clear net benefit.
Storing state creates a potential disconnect with reality. Managing that disconnect requires extra tests, defensive checks, and cognitive overhead. State should be added only when the benefit is obvious and defensible.
**Textbook Example (this repository issue #11)**
Proposal: run `which tailscale` at startup, set a `binaryAvailable` boolean, and guard every `tailscale` invocation behind it.
**Why this was harmful**
1. Wrong solution to the actual problem. This project is a GUI wrapper around the `tailscale` binary. If the binary doesnt exist, there is nothing to do except surface an error. Storing a flag and guarding UI actions adds state for no gain.
2. Creates a new class of edge cases that must be tested: the binary existed when the flag was set but later disappears. The code must now defend against both “flag is false” and “flag is wrong.”
3. Unreliable guard for a failure the code must handle anyway. A missing binary produces a clear exit-code failure on the real command. Checking the flag *and* handling the failure duplicates work.
Reference: #11.
## Code Style Guidance
### 1. **NEVER** Write Conditional and Loop Blocks Without Curly Braces
**ALWAYS** use curly braces, `{}`, for if, else, while, and for blocks, even when they contain only a single statement. This ensures that any future additions to the block remain within the intended control flow. Reference: `CVE-2014-1266`.
**GOOD** Examples:
```javascript
if (myvar) {
do_action();
}
```
```javascript
if (myvar) { do_action(); }
```
```javascript
while (myvar) {
do_action();
}
```
```javascript
while (myvar) { do_action(); }
```
**BAD** Examples:
```javascript
if (myvar)
do_action();
```
```javascript
if (myvar) do_action();
```
```javascript
while (myvar)
do_action();
```
```javascript
while (myvar) do_action();
```
### 2. ALWAYS Terminate JavaScript Statements with Semicolons
ALWAYS end every JavaScript statement with a semicolon (;).
Rationale: Semicolons make intent explicit, eliminate ASI surprises, improve readability, and produce clearer diffs and tooling output.
Scope:
- Applies to all JavaScript statements — inside signal handlers (onClicked: { ... }), custom methods (function foo() { ... }), arrow function bodies, standalone .js files, and test files.
- Does NOT apply to QML declarative property bindings (width: 100, text: "foo", anchors.centerIn: parent, model: myModel, etc.). These are not statements; adding ; after them is either a syntax error or non-idiomatic in QML.
- When multiple QML bindings are written on a single line for compactness, ; is used only as a separator between bindings (Qt/QML convention), not as a statement terminator.
GOOD (JavaScript statements):
```javascript
// Inside a QML signal handler or method
onClicked: {
root.toggleTailscale();
ToastService.showInfo("Toggled");
}
function buildCommand(hostname) {
if (hostname === "") {
return ["tailscale", "set", "--exit-node="];
}
return ["tailscale", "set", "--exit-node=" + hostname];
}
```
```javascript
// In a .js file
if (!peerMap) {
return [];
}
return Object.keys(peerMap).map(...);
```
BAD (missing semicolons on statements):
```javascript
if (condition) {
doAction()
}
return value
```
BAD (incorrect semicolon on QML binding — never do this):
```javascript
width: 360; // OK (separator on same line)
height: 400; // WRONG — this is a binding, not a statement
text: "Tailscale"; // WRONG
```
GOOD (correct QML binding style):
```javascript
width: 360
height: 400
text: "Tailscale"
Item { width: 1; height: 1; Layout.fillWidth: true } // ; only as separator
```

View file

@ -2,26 +2,28 @@
A lightweight widget plugin that shows Tailscale connectivity status on the Dank Bar with quick controls for toggling connection, switching exit nodes, and copying peer addresses.
![Tailscale Widget v0.1.0](resources/dms_tailscalectl_v0.1.0.png)
![Tailscale Widget v0.2.1](resources/dms_tailscalectl_v0.1.0.png)
## Features
- **Status icon** in the bar — `vpn_key` when connected, `vpn_key_off` when disconnected
- **Right-click** to toggle Tailscale on/off
- **Left-click** to open a popout showing:
- Your current Tailscale IP
- Your current Tailscale IP (when connected)
- Active exit node (with clear button)
- Peer list with hostnames and IPs
- Peer list with hostnames and IPs (when connected)
- A clear "Not connected" empty state when disconnected (no stale peer list)
- **Click-to-copy** any hostname or IP to clipboard
- **Exit node selection** — click `↗` on any exit-node-capable peer to route through it
- **Auto-refresh** — status polls every 5 seconds
- **On-demand status** — polls Tailscale for ground truth on load, explicit actions, and post-mutation verification (defensive poll-act-poll for toggles; no always-on timer)
- **Single-flight actions** — concurrent status/toggle/exit/copy chains are rejected while an operation is in flight
- **Toast notifications** for all errors
## Requirements
- Dank Material Shell installed and running
- `tailscale` CLI available on `PATH`
- A clipboard tool (`dms`, `wl-copy`, or `clipmanctl`)
- A clipboard tool (`dms` or `wl-copy`)
## Installation
@ -42,7 +44,8 @@ A lightweight widget plugin that shows Tailscale connectivity status on the Dank
tailscalectl/
├── plugin.json
├── TailscaleWidget.qml
└── lib.js
├── lib.js
└── i18n/
```
3. Reload the plugin:
@ -70,15 +73,27 @@ A lightweight widget plugin that shows Tailscale connectivity status on the Dank
"id": "tailscalectl",
"name": "Tailscale",
"description": "Tailscale status and controls on the Dank Bar",
"version": "0.1.0",
"author": "John Morris & Vybe (AI Slop... er... Coding Assistant)",
"author": "John Morris",
"icon": "vpn_key",
"type": "widget",
"capabilities": ["dankbar-widget"],
"component": "./TailscaleWidget.qml",
"permissions": ["settings_read", "settings_write", "process"]
"permissions": ["process"],
"requires": ["tailscale"],
"version": "0.2.1"
}
```
## Implementation notes
- Uses `Proc` singleton (from `qs.Common`) for all external `tailscale` commands (one-shot stdout capture + auto cleanup).
- Fully I18n-ready via `I18n.tr(...)` (source keys in American English only today; see `tailscalectl/i18n/` for scaffolding).
- Follows current `dms-plugin-dev` + DMS 1.4 plugin best practices (capabilities, requires, no raw Process for one-shots, etc.).
- Toggle uses intentional defensive poll-act-poll; a failed status poll aborts the pending toggle (does not invent `up`/`down`).
- When `BackendState` is not `Running`, peer list / exit node / self IP are cleared so the UI never shows a stale connected-looking peer list.
- Status row uses `RowLayout` with a real `Layout.fillWidth` spacer (not a no-op on plain `Row`).
- Peer `ListView` uses `Flickable.StopAtBounds` (no desktop rubber-band overshoot).
## Testing
```bash

View file

@ -4,178 +4,170 @@ import qs.Common
import qs.Services
import qs.Widgets
import qs.Modules.Plugins
import Quickshell.Io
import "./lib.js" as TailscaleLib
PluginComponent {
id: root
property bool isConnected: false
property bool binaryAvailable: true
property string tailscaleIP: ""
property string currentExitNode: ""
property var peers: []
property string cachedClipboardTool: ""
property string _copyText: ""
property string _copyCurrentTool: ""
property int _copyAttempted: 0
property int _copyIndex: 0
// Transient coordination for defensive poll-act-poll toggle (not long-term cache).
// Poll for ground truth act poll again for verification.
property string _pendingAction: ""
// Single-flight guard: prevent interleaved status/toggle/exit/copy chains (#15/#30 class).
property bool _busy: false
layerNamespacePlugin: "tailscalectl"
popoutWidth: 360
popoutHeight: 400
Timer {
interval: 5000
running: true
repeat: true
onTriggered: statusCheck.running = true
}
Component.onCompleted: {
statusCheck.running = true
root._runStatusCheck();
}
Process {
id: toggleProcess
stderr: StdioCollector {}
onExited: (code, status) => {
if (code !== 0) {
var action = root.isConnected ? "disconnect" : "connect"
var detail = toggleProcess.stderr.text.trim().slice(0, 120)
ToastService.showError("tailscalectl", TailscaleLib.errorMessage(action) + (detail ? " — " + detail : ""))
}
statusCheck.running = true
function _runStatusCheck() {
if (root._busy && root._pendingAction === "") {
// A non-toggle status refresh while something is already in flight: skip.
// Toggle path sets _pendingAction first and is allowed to chain after actions clear busy carefully.
return;
}
}
Process {
id: copyProcess
stderr: StdioCollector {}
onExited: (code, status) => {
if (code === 0) {
root.cachedClipboardTool = root._copyCurrentTool
ToastService.showInfo("Copied " + root._copyText + " to clipboard")
root._busy = true;
Proc.runCommand("tailscale-status", TailscaleLib.getStatusCommand(), (stdout, code) => {
var statusOk = (code === 0);
if (statusOk) {
const state = TailscaleLib.parseStatusResult(stdout);
root.isConnected = state.isConnected;
root.tailscaleIP = state.tailscaleIP;
root.currentExitNode = state.currentExitNode;
root.peers = state.peers;
} else {
root._copyAttempted += 1
if (root._copyAttempted < TailscaleLib.allClipboardTools().length) {
root._copyCurrentTool = TailscaleLib.nextClipboardTool(root._copyCurrentTool)
root._executeCopy()
} else {
var detail = copyProcess.stderr.text.trim().slice(0, 120)
ToastService.showError("tailscalectl", "No clipboard tool found" + (detail ? " — " + detail : ""))
}
root.isConnected = false;
root.tailscaleIP = "";
root.currentExitNode = "";
root.peers = [];
ToastService.showError("tailscalectl", I18n.tr(TailscaleLib.formatError("status")));
}
}
const cmd = TailscaleLib.commandForPendingAction(root._pendingAction, root.isConnected, statusOk);
if (cmd) {
// Fresh poll succeeded; act, then verify with another status poll.
Proc.runCommand("tailscale-toggle", cmd, (out, c) => {
if (c !== 0) {
const action = root.isConnected ? "disconnect" : "connect";
ToastService.showError("tailscalectl", I18n.tr(TailscaleLib.formatError(action)));
}
root._pendingAction = "";
// Keep busy through verification poll: call internal runner that assumes we own the lock.
root._runStatusCheckUnlocked();
});
} else {
// Includes failed status while a toggle was pending: abort rather than invent up/down.
root._pendingAction = "";
root._busy = false;
}
});
}
Process {
id: exitNodeProcess
stderr: StdioCollector {}
onExited: (code, status) => {
if (code !== 0) {
var detail = exitNodeProcess.stderr.text.trim().slice(0, 120)
ToastService.showError("tailscalectl", TailscaleLib.errorMessage("set") + (detail ? " — " + detail : ""))
// Used only as the continuation after toggle action; assumes _busy is already true.
function _runStatusCheckUnlocked() {
Proc.runCommand("tailscale-status", TailscaleLib.getStatusCommand(), (stdout, code) => {
if (code === 0) {
const state = TailscaleLib.parseStatusResult(stdout);
root.isConnected = state.isConnected;
root.tailscaleIP = state.tailscaleIP;
root.currentExitNode = state.currentExitNode;
root.peers = state.peers;
} else {
root.isConnected = false;
root.tailscaleIP = "";
root.currentExitNode = "";
root.peers = [];
ToastService.showError("tailscalectl", I18n.tr(TailscaleLib.formatError("status")));
}
statusCheck.running = true
}
}
Process {
id: statusCheck
command: ["tailscale", "status", "--json"]
stdout: StdioCollector {
onStreamFinished: {
const state = TailscaleLib.parseStatusResult(this.text)
root.isConnected = state.isConnected
root.tailscaleIP = state.tailscaleIP
root.currentExitNode = state.currentExitNode
root.peers = state.peers
}
}
onExited: (code, status) => {
if (code !== 0) {
root.isConnected = false
root.tailscaleIP = ""
root.currentExitNode = ""
root.peers = []
if (code === 127) {
root.binaryAvailable = false
ToastService.showError("tailscalectl", "Tailscale binary not found")
} else {
ToastService.showError("tailscalectl", TailscaleLib.errorMessage("status"))
}
}
}
root._busy = false;
});
}
function toggleTailscale() {
if (!root.binaryAvailable) {
ToastService.showError("tailscalectl", "Tailscale not available")
return
if (root._busy) {
return;
}
toggleProcess.command = TailscaleLib.buildToggleCommand(root.isConnected)
toggleProcess.running = true
root._pendingAction = TailscaleLib.PendingAction.TOGGLE;
root._runStatusCheck();
}
function refreshStatus() {
if (root._busy) {
return;
}
root._runStatusCheck();
}
function setExitNode(hostname) {
if (!root.binaryAvailable) {
ToastService.showError("tailscalectl", "Tailscale not available")
return
if (root._busy) {
return;
}
exitNodeProcess.command = TailscaleLib.makeExitNodeCommand(hostname)
exitNodeProcess.running = true
const cmd = TailscaleLib.makeExitNodeCommand(hostname);
if (!cmd) {
ToastService.showError("tailscalectl", I18n.tr(TailscaleLib.getStrings().invalidExitNodeHostname));
return;
}
root._busy = true;
Proc.runCommand("tailscale-exit", cmd, (stdout, code) => {
if (code !== 0) {
ToastService.showError("tailscalectl", I18n.tr(TailscaleLib.formatError("set")));
}
// Verify via unlocked status continuation (busy already held).
root._runStatusCheckUnlocked();
});
}
function copyToClipboard(text) {
root._copyText = text
root._copyAttempted = 0
if (root.cachedClipboardTool) {
root._copyCurrentTool = root.cachedClipboardTool
} else {
root._copyCurrentTool = TailscaleLib.allClipboardTools()[0]
if (root._busy) {
return;
}
root._executeCopy()
root._copyText = text;
root._copyIndex = 0;
root._busy = true;
root._runNextCopy();
}
function _executeCopy() {
var cmd = TailscaleLib.buildCopyCommand(root._copyText, root._copyCurrentTool)
if (!cmd) {
ToastService.showError("tailscalectl", "Invalid clipboard command")
return
function _runNextCopy() {
const cmds = TailscaleLib.getClipboardCommands(root._copyText);
if (root._copyIndex >= cmds.length) {
ToastService.showError("tailscalectl", I18n.tr(TailscaleLib.formatError("clipboard")));
root._busy = false;
return;
}
copyProcess.command = cmd
copyProcess.running = true
Proc.runCommand("tailscale-copy-" + root._copyIndex, cmds[root._copyIndex], (stdout, code) => {
if (code === 0) {
ToastService.showInfo(I18n.tr(TailscaleLib.getStrings().copied).arg(root._copyText));
root._busy = false;
} else {
root._copyIndex += 1;
root._runNextCopy();
}
});
}
popoutContent: Component {
PopoutComponent {
headerText: "Tailscale"
detailsText: root.isConnected ? "Connected" : "Disconnected"
headerText: I18n.tr(TailscaleLib.getStrings().header)
detailsText: root.isConnected ? I18n.tr(TailscaleLib.getStrings().connected) : I18n.tr(TailscaleLib.getStrings().disconnected)
showCloseButton: true
Item {
id: contentItem
width: parent.width
height: Theme.spacingM + statusRow.implicitHeight + Theme.spacingM + peerList.height + Theme.spacingM
height: Theme.spacingM + statusRow.implicitHeight + Theme.spacingM + peerArea.height + Theme.spacingM
StyledText {
visible: !root.binaryAvailable
text: "Tailscale not available"
anchors.centerIn: parent
font.pixelSize: Theme.fontSizeSmall
color: Theme.surfaceVariantText
}
Row {
RowLayout {
id: statusRow
y: Theme.spacingM
width: parent.width
@ -188,11 +180,11 @@ PluginComponent {
MouseArea {
cursorShape: Qt.PointingHandCursor
hoverEnabled: true
anchors.verticalCenter: parent.verticalCenter
Layout.alignment: Qt.AlignVCenter
width: toggleIcon.implicitWidth
height: toggleIcon.implicitHeight
onClicked: {
root.toggleTailscale()
root.toggleTailscale();
}
DankIcon {
@ -208,27 +200,30 @@ PluginComponent {
text: root.tailscaleIP || "—"
font.pixelSize: Theme.fontSizeSmall
color: Theme.primary
anchors.verticalCenter: parent.verticalCenter
Layout.alignment: Qt.AlignVCenter
}
Item { width: 1; height: 1; Layout.fillWidth: true }
Item {
Layout.fillWidth: true
height: 1
}
StyledText {
text: "Exit node: " + (root.currentExitNode || "None")
text: I18n.tr(TailscaleLib.getStrings().exitNodePrefix) + (root.currentExitNode || I18n.tr(TailscaleLib.getStrings().none))
font.pixelSize: Theme.fontSizeSmall
color: Theme.surfaceVariantText
anchors.verticalCenter: parent.verticalCenter
Layout.alignment: Qt.AlignVCenter
}
MouseArea {
visible: root.currentExitNode !== ""
cursorShape: Qt.PointingHandCursor
hoverEnabled: true
anchors.verticalCenter: parent.verticalCenter
Layout.alignment: Qt.AlignVCenter
width: clearExitNodeText.implicitWidth
height: clearExitNodeText.implicitHeight
onClicked: {
root.setExitNode("")
root.setExitNode("");
}
StyledText {
@ -240,78 +235,100 @@ PluginComponent {
}
}
ListView {
id: peerList
// Peer list when connected; empty-state hint when not (#55).
Item {
id: peerArea
y: Theme.spacingM + statusRow.implicitHeight + Theme.spacingM
width: parent.width - Theme.spacingM * 2
height: Math.min(root.peers.length * (Theme.fontSizeSmall + Theme.spacingXS), 200)
height: root.isConnected
? Math.min(Math.max(root.peers.length, 1) * (Theme.fontSizeSmall + Theme.spacingXS), 200)
: (Theme.fontSizeSmall + Theme.spacingXS)
anchors.left: parent.left
anchors.leftMargin: Theme.spacingM
model: root.peers
interactive: true
boundsBehavior: Flickable.DragAndOvershootBounds
delegate: Item {
width: peerList.width
height: Theme.fontSizeSmall + Theme.spacingXS
StyledText {
visible: !root.isConnected
anchors.fill: parent
text: I18n.tr(TailscaleLib.getStrings().notConnectedHint)
font.pixelSize: Theme.fontSizeSmall
color: Theme.surfaceVariantText
horizontalAlignment: Text.AlignHCenter
verticalAlignment: Text.AlignVCenter
}
Row {
anchors.fill: parent
spacing: Theme.spacingS
anchors.verticalCenter: parent.verticalCenter
ListView {
id: peerList
visible: root.isConnected
anchors.fill: parent
model: root.peers
interactive: true
// Desktop popout: no rubber-band overshoot (#27).
boundsBehavior: Flickable.StopAtBounds
clip: true
MouseArea {
cursorShape: Qt.PointingHandCursor
hoverEnabled: true
delegate: Item {
width: peerList.width
height: Theme.fontSizeSmall + Theme.spacingXS
Row {
anchors.left: parent.left
anchors.right: parent.right
anchors.verticalCenter: parent.verticalCenter
width: peerHostnameText.implicitWidth
height: peerHostnameText.implicitHeight
onClicked: {
root.copyToClipboard(modelData.hostname)
spacing: Theme.spacingS
MouseArea {
cursorShape: Qt.PointingHandCursor
hoverEnabled: true
anchors.verticalCenter: parent.verticalCenter
width: peerHostnameText.implicitWidth
height: peerHostnameText.implicitHeight
onClicked: {
root.copyToClipboard(modelData.hostname);
}
StyledText {
id: peerHostnameText
text: modelData.hostname
font.pixelSize: Theme.fontSizeSmall
color: modelData.online ? Theme.primary : Theme.surfaceVariantText
}
}
StyledText {
id: peerHostnameText
text: modelData.hostname
font.pixelSize: Theme.fontSizeSmall
color: modelData.online ? Theme.primary : Theme.surfaceVariantText
}
}
MouseArea {
cursorShape: Qt.PointingHandCursor
hoverEnabled: true
anchors.verticalCenter: parent.verticalCenter
width: peerIpText.implicitWidth
height: peerIpText.implicitHeight
onClicked: {
root.copyToClipboard(modelData.ip);
}
MouseArea {
cursorShape: Qt.PointingHandCursor
hoverEnabled: true
anchors.verticalCenter: parent.verticalCenter
width: peerIpText.implicitWidth
height: peerIpText.implicitHeight
onClicked: {
root.copyToClipboard(modelData.ip)
StyledText {
id: peerIpText
text: modelData.ip
font.pixelSize: Theme.fontSizeSmall
color: Theme.surfaceVariantText
}
}
StyledText {
id: peerIpText
text: modelData.ip
font.pixelSize: Theme.fontSizeSmall
color: Theme.surfaceVariantText
}
}
MouseArea {
visible: modelData.exitNode
cursorShape: Qt.PointingHandCursor
hoverEnabled: true
anchors.verticalCenter: parent.verticalCenter
width: exitNodeButton.implicitWidth
height: exitNodeButton.implicitHeight
onClicked: {
root.setExitNode(modelData.hostname);
}
MouseArea {
visible: modelData.exitNode
cursorShape: Qt.PointingHandCursor
hoverEnabled: true
anchors.verticalCenter: parent.verticalCenter
width: exitNodeButton.implicitWidth
height: exitNodeButton.implicitHeight
onClicked: {
root.setExitNode(modelData.hostname)
}
StyledText {
id: exitNodeButton
text: "↗"
font.pixelSize: Theme.fontSizeSmall
color: root.currentExitNode === modelData.hostname ? Theme.primary : Theme.surfaceVariantText
StyledText {
id: exitNodeButton
text: "↗"
font.pixelSize: Theme.fontSizeSmall
color: (root.currentExitNode === modelData.hostname) ? Theme.primary : Theme.surfaceVariantText
}
}
}
}
@ -321,16 +338,11 @@ PluginComponent {
}
}
// propagateComposedEvents: true so that right-clicks both trigger our context menu
// *and* bubble to any parent MouseArea (e.g. for shell-level drag handling).
// Documented because the default (false) is far more common and this choice
// frequently surprises future maintainers.
MouseArea {
anchors.fill: parent
acceptedButtons: Qt.RightButton
propagateComposedEvents: true
onClicked: {
root.toggleTailscale()
root.toggleTailscale();
}
}
@ -357,4 +369,4 @@ PluginComponent {
}
}
}
}
}

View file

@ -0,0 +1,22 @@
# I18n for tailscalectl
This plugin is fully instrumented with `I18n.tr(...)` (from `qs.Common`) for all user-facing strings.
- Source keys are the American English strings defined in `lib.js` (returned by `getStrings()`, plus bases from `errorMessage()` / `formatError()`).
- Call sites in `TailscaleWidget.qml` wrap them: `I18n.tr(TailscaleLib.getStrings().foo)` or `I18n.tr(TailscaleLib.getStrings().copied).arg(text)`.
- Today: falls back to the key (perfect en-US).
- Future: Drop additional `xx.json` here (or contribute keys to DMS core translations) when a loader or extraction process supports per-plugin locales.
## Current keys (source of truth)
See `getStrings()` and `errorMessage()` in `lib.js` for the canonical list.
Example `en.json` (for documentation / future tools) lives beside this README.
## Notes
- Symbols/glyphs ("×", "↗", "—") are intentionally left as literals in the UI (not run through I18n as they are not linguistic content).
- Plugin name/description in `plugin.json` and technical IDs ("tailscalectl") remain English.
- This follows DMS `dms-plugin-dev` best practice for future-proofing even when only en is shipped.
Written by AI agent working for @jtmorris. Model: Grok 4.5.

16
tailscalectl/i18n/en.json Normal file
View file

@ -0,0 +1,16 @@
{
"Tailscale": "Tailscale",
"Connected": "Connected",
"Disconnected": "Disconnected",
"Exit node: ": "Exit node: ",
"None": "None",
"Copied %1 to clipboard": "Copied %1 to clipboard",
"Invalid exit node hostname": "Invalid exit node hostname",
"Not connected": "Not connected",
"Failed to connect to Tailscale": "Failed to connect to Tailscale",
"Failed to disconnect from Tailscale": "Failed to disconnect from Tailscale",
"Failed to set exit node": "Failed to set exit node",
"Failed to read Tailscale status": "Failed to read Tailscale status",
"Error copying to clipboard": "Error copying to clipboard",
"Tailscale command failed": "Tailscale command failed"
}

View file

@ -1,77 +1,113 @@
function parsePeers(peerMap) {
if (!peerMap) return []
if (!peerMap) {
return [];
}
return Object.keys(peerMap).map(function (key) {
var p = peerMap[key]
var p = peerMap[key];
return {
hostname: p.HostName || key,
ip: (p.TailscaleIPs && p.TailscaleIPs.length) ? p.TailscaleIPs[0] : "",
online: p.Online || false,
exitNode: p.ExitNodeOption || false
}
})
};
});
}
function makeExitNodeCommand(hostname) {
return ["tailscale", "set", "--exit-node=" + hostname]
if (!isValidExitNodeHostname(hostname)) {
return null;
}
if (hostname === "") {
return ["tailscale", "set", "--exit-node="];
}
return ["tailscale", "set", "--exit-node=" + hostname];
}
function findActiveExitNode(peerMap) {
if (!peerMap) return ""
for (const key in peerMap) {
const p = peerMap[key]
if (!peerMap) {
return "";
}
for (const key of Object.keys(peerMap)) {
const p = peerMap[key];
if (p.ExitNode) {
return p.HostName || key
return p.HostName || key;
}
}
return ""
return "";
}
var safeClipboardTools = ["dms", "wl-copy", "clipmanctl"]
const clipboardTools = [
{ argv: ["dms", "cl", "copy"] },
{ argv: ["wl-copy"] }
];
var clipboardCmdMap = {
"dms": "dms cl copy",
"wl-copy": "wl-copy",
"clipmanctl": "clipmanctl copy"
function getClipboardCommands(text) {
return clipboardTools.map(function (tool) {
return tool.argv.concat([text]);
});
}
function validateClipboardTool(tool) {
return typeof tool === "string" && safeClipboardTools.includes(tool)
function getStrings() {
return {
header: "Tailscale",
connected: "Connected",
disconnected: "Disconnected",
exitNodePrefix: "Exit node: ",
none: "None",
copied: "Copied %1 to clipboard",
invalidExitNodeHostname: "Invalid exit node hostname",
notConnectedHint: "Not connected"
};
}
function buildCopyCommand(text, tool) {
if (!validateClipboardTool(tool)) return null
var cmd = clipboardCmdMap[tool]
if (!cmd) return null
var escaped = text.replace(/'/g, "'\\''")
return ["sh", "-c", "printf '%s' '" + escaped + "' | " + cmd]
}
function nextClipboardTool(currentTool) {
var idx = safeClipboardTools.indexOf(currentTool)
if (idx < 0) return safeClipboardTools[0]
return safeClipboardTools[(idx + 1) % safeClipboardTools.length]
}
function allClipboardTools() {
return safeClipboardTools.slice()
// Security: validate hostnames coming from tailscale status JSON.
// Fail closed on obviously malicious input. Allow multi-label MagicDNS names
// up to DNS FQDN length (253).
function isValidExitNodeHostname(hostname) {
if (typeof hostname !== "string") {
return false;
}
if (hostname === "") {
return true;
}
if (hostname.length > 253) {
return false;
}
// Each label: alnum start/end, alnum/hyphen/underscore inside; dots separate labels.
return /^(?=.{1,253}$)([a-zA-Z0-9]([a-zA-Z0-9_-]{0,61}[a-zA-Z0-9])?)(\.([a-zA-Z0-9]([a-zA-Z0-9_-]{0,61}[a-zA-Z0-9])?))*$/.test(hostname);
}
function parseStatusResult(jsonText) {
try {
const data = JSON.parse(jsonText)
const data = JSON.parse(jsonText);
const isConnected = data.BackendState === "Running";
if (!isConnected) {
// #55: when not Running, do not surface stale peer list / exit node / IP.
return {
isConnected: false,
tailscaleIP: "",
currentExitNode: "",
peers: []
};
}
return {
isConnected: data.BackendState === "Running",
isConnected: true,
tailscaleIP: (data.Self && data.Self.TailscaleIPs && data.Self.TailscaleIPs[0]) || "",
currentExitNode: findActiveExitNode(data.Peer || {}),
peers: parsePeers(data.Peer || {})
}
};
} catch (e) {
return { isConnected: false, tailscaleIP: "", currentExitNode: "", peers: [] }
return { isConnected: false, tailscaleIP: "", currentExitNode: "", peers: [] };
}
}
function buildToggleCommand(isConnected) {
return isConnected ? ["tailscale", "down"] : ["tailscale", "up"]
return isConnected ? ["tailscale", "down"] : ["tailscale", "up"];
}
// Single source of truth for the status command used for on-demand and post-action verification.
function getStatusCommand() {
return ["tailscale", "status", "--json"];
}
function errorMessage(cmd) {
@ -81,12 +117,52 @@ function errorMessage(cmd) {
"down": "Failed to disconnect from Tailscale",
"disconnect": "Failed to disconnect from Tailscale",
"set": "Failed to set exit node",
"status": "Failed to read Tailscale status"
}
return messages[cmd] || "Tailscale command failed"
"status": "Failed to read Tailscale status",
"clipboard": "Error copying to clipboard"
};
return messages[cmd] || "Tailscale command failed";
}
// CommonJS export for Node.js tests (ignored by QML)
if (typeof module !== "undefined" && module.exports) {
module.exports = { parsePeers, makeExitNodeCommand, findActiveExitNode, errorMessage, validateClipboardTool, buildCopyCommand, nextClipboardTool, allClipboardTools, buildToggleCommand, parseStatusResult }
// Central error formatting for the widget. detail is optional truncated stderr or extra context.
function formatError(action, detail) {
var base = errorMessage(action);
if (detail && detail.length > 0) {
var truncated = detail.length > 120 ? detail.slice(0, 120) : detail;
return base + " — " + truncated;
}
return base;
}
const PendingAction = Object.freeze({
TOGGLE: "toggle"
});
// statusOk must be true (successful status poll) before acting on pending toggle.
// Never invent up/down from a failed poll (would force "up" after clearing isConnected).
function commandForPendingAction(pending, freshIsConnected, statusOk) {
if (!statusOk) {
return null;
}
if (pending === PendingAction.TOGGLE) {
return buildToggleCommand(freshIsConnected);
}
return null;
}
if (typeof module !== "undefined" && module.exports) {
module.exports = {
parsePeers,
makeExitNodeCommand,
findActiveExitNode,
errorMessage,
formatError,
getStatusCommand,
isValidExitNodeHostname,
getClipboardCommands,
buildToggleCommand,
parseStatusResult,
getStrings,
PendingAction,
commandForPendingAction
};
}

View file

@ -2,10 +2,12 @@
"id": "tailscalectl",
"name": "Tailscale",
"description": "Tailscale status and controls on the Dank Bar",
"version": "0.1.0",
"author": "John Morris & Vybe (AI Slop... er... Coding Assistant)",
"author": "John Morris",
"icon": "vpn_key",
"type": "widget",
"capabilities": ["dankbar-widget"],
"component": "./TailscaleWidget.qml",
"permissions": ["settings_read", "settings_write", "process"]
"permissions": ["process"],
"requires": ["tailscale"],
"version": "0.2.1"
}

View file

@ -1,7 +1,32 @@
import { test } from "node:test"
import assert from "node:assert"
import lib from "../tailscalectl/lib.js"
const { parsePeers, makeExitNodeCommand, findActiveExitNode, errorMessage, validateClipboardTool, buildCopyCommand, nextClipboardTool, allClipboardTools, buildToggleCommand, parseStatusResult } = lib
import { test } from "node:test";
import assert from "node:assert";
import lib from "../tailscalectl/lib.js";
const {
parsePeers,
makeExitNodeCommand,
findActiveExitNode,
errorMessage,
formatError,
getStatusCommand,
isValidExitNodeHostname,
getClipboardCommands,
buildToggleCommand,
parseStatusResult,
getStrings,
PendingAction,
commandForPendingAction
} = lib;
/*
* Unit tests for pure functions in lib.js.
*
* TailscaleWidget.qml has no automated test coverage. Proc.runCommand
* coordination, busy-mutex behavior, and widget UI must be verified
* manually in a running DMS instance.
*/
// --- parsePeers ---
test("parsePeers extracts exitNode from ExitNodeOption", () => {
const peerMap = {
@ -17,185 +42,344 @@ test("parsePeers extracts exitNode from ExitNodeOption", () => {
Online: true,
ExitNodeOption: false
}
}
};
const peers = parsePeers(peerMap)
const peers = parsePeers(peerMap);
assert.strictEqual(peers[0].exitNode, true)
assert.strictEqual(peers[1].exitNode, false)
})
assert.strictEqual(peers.length, 2);
assert.strictEqual(peers[0].exitNode, true);
assert.strictEqual(peers[1].exitNode, false);
assert.strictEqual(peers[0].hostname, "router");
assert.strictEqual(peers[0].ip, "100.64.0.1");
assert.strictEqual(peers[0].online, true);
});
test("parsePeers returns empty array for null/undefined peerMap", () => {
assert.deepStrictEqual(parsePeers(null), []);
assert.deepStrictEqual(parsePeers(undefined), []);
});
test("parsePeers returns empty array for empty peerMap", () => {
assert.deepStrictEqual(parsePeers({}), []);
});
test("parsePeers falls back to key when HostName missing", () => {
const peers = parsePeers({
"node-key-abc": { TailscaleIPs: ["100.64.0.9"], Online: false }
});
assert.strictEqual(peers[0].hostname, "node-key-abc");
assert.strictEqual(peers[0].ip, "100.64.0.9");
assert.strictEqual(peers[0].online, false);
assert.strictEqual(peers[0].exitNode, false);
});
test("parsePeers uses empty ip when TailscaleIPs missing or empty", () => {
const peers = parsePeers({
a: { HostName: "a" },
b: { HostName: "b", TailscaleIPs: [] }
});
assert.strictEqual(peers[0].ip, "");
assert.strictEqual(peers[1].ip, "");
});
// --- makeExitNodeCommand / hostname validation ---
test("makeExitNodeCommand returns tailscale set command for hostname", () => {
const cmd = makeExitNodeCommand("router")
assert.deepStrictEqual(cmd, ["tailscale", "set", "--exit-node=router"])
})
const cmd = makeExitNodeCommand("router");
assert.deepStrictEqual(cmd, ["tailscale", "set", "--exit-node=router"]);
});
test("makeExitNodeCommand with empty string clears exit node", () => {
const cmd = makeExitNodeCommand("")
assert.deepStrictEqual(cmd, ["tailscale", "set", "--exit-node="])
})
const cmd = makeExitNodeCommand("");
assert.deepStrictEqual(cmd, ["tailscale", "set", "--exit-node="]);
});
test("makeExitNodeCommand returns null for invalid hostname", () => {
assert.strictEqual(makeExitNodeCommand("; rm"), null);
assert.strictEqual(makeExitNodeCommand("$(whoami)"), null);
assert.strictEqual(makeExitNodeCommand(null), null);
assert.strictEqual(makeExitNodeCommand(42), null);
});
test("makeExitNodeCommand still produces correct argv for valid input", () => {
assert.deepStrictEqual(makeExitNodeCommand(""), ["tailscale", "set", "--exit-node="]);
assert.deepStrictEqual(makeExitNodeCommand("gluetun-sjc"), ["tailscale", "set", "--exit-node=gluetun-sjc"]);
});
test("isValidExitNodeHostname accepts empty string (clear)", () => {
assert.strictEqual(isValidExitNodeHostname(""), true);
});
test("isValidExitNodeHostname accepts realistic Tailscale hostnames", () => {
["router", "gluetun-sjc", "my-exit-node-01", "peer_with_underscore", "a.b.c"].forEach((h) => {
assert.strictEqual(isValidExitNodeHostname(h), true, h);
});
});
test("isValidExitNodeHostname accepts MagicDNS-style FQDNs under 253 chars", () => {
assert.strictEqual(isValidExitNodeHostname("my-node.tail1234.ts.net"), true);
const longButValid = "a".repeat(60) + "." + "b".repeat(60) + "." + "c".repeat(60);
assert.ok(longButValid.length < 253);
assert.strictEqual(isValidExitNodeHostname(longButValid), true);
});
test("isValidExitNodeHostname rejects injection attempts and garbage", () => {
["; rm -rf /", "$(whoami)", "`id`", "foo;bar", "a&b", "x\ny", "evil$(date)", " spacy ", "-leading", "trailing-"].forEach((h) => {
assert.strictEqual(isValidExitNodeHostname(h), false, h);
});
});
test("isValidExitNodeHostname rejects non-strings and oversized names", () => {
assert.strictEqual(isValidExitNodeHostname(undefined), false);
assert.strictEqual(isValidExitNodeHostname({}), false);
assert.strictEqual(isValidExitNodeHostname("x".repeat(254)), false);
});
// --- findActiveExitNode ---
test("findActiveExitNode returns hostname of peer with ExitNode=true", () => {
const peerMap = {
"peer-1": { HostName: "gluetun-sjc", ExitNode: true, ExitNodeOption: true },
"peer-2": { HostName: "gluetun-den", ExitNode: false, ExitNodeOption: true }
}
assert.strictEqual(findActiveExitNode(peerMap), "gluetun-sjc")
})
};
assert.strictEqual(findActiveExitNode(peerMap), "gluetun-sjc");
});
test("findActiveExitNode returns empty string when no exit node", () => {
const peerMap = {
"peer-1": { HostName: "laptop", ExitNode: false, ExitNodeOption: false }
}
assert.strictEqual(findActiveExitNode(peerMap), "")
})
};
assert.strictEqual(findActiveExitNode(peerMap), "");
});
test("errorMessage returns user-friendly message for tailscale up failure", () => {
const msg = errorMessage("up", 1)
assert.strictEqual(msg, "Failed to connect to Tailscale")
})
test("findActiveExitNode returns empty string for null peerMap", () => {
assert.strictEqual(findActiveExitNode(null), "");
});
test("errorMessage returns user-friendly message for tailscale down failure", () => {
const msg = errorMessage("down", 1)
assert.strictEqual(msg, "Failed to disconnect from Tailscale")
})
test("findActiveExitNode falls back to map key when HostName missing", () => {
const peerMap = {
"key-only": { ExitNode: true }
};
assert.strictEqual(findActiveExitNode(peerMap), "key-only");
});
test("errorMessage returns user-friendly message for tailscale set failure", () => {
const msg = errorMessage("set", 1)
assert.strictEqual(msg, "Failed to set exit node")
})
// --- errorMessage / formatError ---
test("errorMessage returns user-friendly message for tailscale status failure", () => {
const msg = errorMessage("status", 1)
assert.strictEqual(msg, "Failed to read Tailscale status")
})
test("errorMessage returns user-friendly messages for known actions", () => {
assert.strictEqual(errorMessage("up"), "Failed to connect to Tailscale");
assert.strictEqual(errorMessage("connect"), "Failed to connect to Tailscale");
assert.strictEqual(errorMessage("down"), "Failed to disconnect from Tailscale");
assert.strictEqual(errorMessage("disconnect"), "Failed to disconnect from Tailscale");
assert.strictEqual(errorMessage("set"), "Failed to set exit node");
assert.strictEqual(errorMessage("status"), "Failed to read Tailscale status");
assert.strictEqual(errorMessage("clipboard"), "Error copying to clipboard");
});
test("errorMessage returns generic message for unknown command", () => {
const msg = errorMessage("unknown", 1)
assert.strictEqual(msg, "Tailscale command failed")
})
assert.strictEqual(errorMessage("unknown"), "Tailscale command failed");
});
// --- validateClipboardTool ---
test("formatError returns base message without detail", () => {
assert.strictEqual(formatError("status"), "Failed to read Tailscale status");
assert.strictEqual(formatError("set"), "Failed to set exit node");
});
test("validateClipboardTool accepts whitelisted tool names", () => {
assert.strictEqual(validateClipboardTool("dms"), true)
assert.strictEqual(validateClipboardTool("wl-copy"), true)
assert.strictEqual(validateClipboardTool("clipmanctl"), true)
})
test("formatError appends and truncates detail to 120 chars", () => {
const longDetail = "x".repeat(200);
const msg = formatError("up", longDetail);
assert.ok(msg.includes("Failed to connect to Tailscale"));
assert.ok(msg.endsWith("x".repeat(120)));
assert.ok(msg.length < 200);
});
test("validateClipboardTool rejects malicious inputs", () => {
assert.strictEqual(validateClipboardTool("rm -rf /"), false)
assert.strictEqual(validateClipboardTool("echo hi; malicious"), false)
assert.strictEqual(validateClipboardTool("$(whoami)"), false)
assert.strictEqual(validateClipboardTool("wl-copy || rm -rf /"), false)
})
test("formatError handles empty or falsy detail gracefully", () => {
assert.strictEqual(formatError("down", ""), "Failed to disconnect from Tailscale");
assert.strictEqual(formatError("connect", null), "Failed to connect to Tailscale");
});
test("validateClipboardTool rejects empty and falsy inputs", () => {
assert.strictEqual(validateClipboardTool(""), false)
assert.strictEqual(validateClipboardTool(null), false)
assert.strictEqual(validateClipboardTool(undefined), false)
})
// --- clipboard ---
// --- buildCopyCommand ---
test("getClipboardCommands returns ordered argv arrays with text appended", () => {
const cmds = getClipboardCommands("1.2.3.4");
assert.ok(Array.isArray(cmds));
assert.strictEqual(cmds.length, 2);
assert.deepStrictEqual(cmds[0], ["dms", "cl", "copy", "1.2.3.4"]);
assert.deepStrictEqual(cmds[1], ["wl-copy", "1.2.3.4"]);
});
test("buildCopyCommand returns safe command for whitelisted clipboard tool", () => {
const cmd = buildCopyCommand("hello", "wl-copy")
assert.ok(Array.isArray(cmd))
assert.strictEqual(cmd[0], "sh")
assert.strictEqual(cmd[1], "-c")
})
test("getClipboardCommands handles text with special characters safely (direct argv)", () => {
const cmds = getClipboardCommands("it's a 'test' with \"quotes\" and\nnewlines");
assert.ok(Array.isArray(cmds));
assert.strictEqual(cmds.length, 2);
assert.ok(cmds[0].includes("it's a 'test' with \"quotes\" and\nnewlines"));
});
test("buildCopyCommand returns null for invalid clipboard tool", () => {
assert.strictEqual(buildCopyCommand("hello", "rm -rf /"), null)
assert.strictEqual(buildCopyCommand("hello", ""), null)
assert.strictEqual(buildCopyCommand("hello", null), null)
})
// --- strings ---
test("buildCopyCommand safely handles text with special characters", () => {
const cmd = buildCopyCommand("it's a 'test' with \"quotes\" and\nnewlines", "wl-copy")
assert.ok(Array.isArray(cmd))
})
test("getStrings returns canonical UI strings for the widget", () => {
const s = getStrings();
assert.ok(s.header);
assert.ok(s.connected);
assert.ok(s.disconnected);
assert.ok(s.exitNodePrefix);
assert.ok(s.none);
assert.ok(s.copied);
assert.ok(s.invalidExitNodeHostname);
assert.ok(s.notConnectedHint);
});
// --- nextClipboardTool ---
test("getStrings.copied is the I18n template key (interpolation via .arg at call site)", () => {
const s = getStrings();
assert.strictEqual(s.copied, "Copied %1 to clipboard");
});
test("nextClipboardTool cycles through tools", () => {
assert.strictEqual(nextClipboardTool("dms"), "wl-copy")
assert.strictEqual(nextClipboardTool("wl-copy"), "clipmanctl")
assert.strictEqual(nextClipboardTool("clipmanctl"), "dms")
})
// --- toggle helpers ---
test("nextClipboardTool falls back to first tool for unknown input", () => {
assert.strictEqual(nextClipboardTool(""), "dms")
assert.strictEqual(nextClipboardTool("unknown"), "dms")
})
test("buildToggleCommand returns down when connected", () => {
assert.deepStrictEqual(buildToggleCommand(true), ["tailscale", "down"]);
});
// --- allClipboardTools ---
test("allClipboardTools returns the list of safe tools", () => {
const tools = allClipboardTools()
assert.ok(Array.isArray(tools))
assert.strictEqual(tools.length, 3)
assert.ok(tools.includes("dms"))
assert.ok(tools.includes("wl-copy"))
assert.ok(tools.includes("clipmanctl"))
})
// --- buildToggleCommand ---
test("buildToggleCommand returns down command when connected", () => {
assert.deepStrictEqual(buildToggleCommand(true), ["tailscale", "down"])
})
test("buildToggleCommand returns up command when disconnected", () => {
assert.deepStrictEqual(buildToggleCommand(false), ["tailscale", "up"])
})
test("buildToggleCommand returns up when disconnected", () => {
assert.deepStrictEqual(buildToggleCommand(false), ["tailscale", "up"]);
});
test("buildToggleCommand treats null and undefined as disconnected", () => {
assert.deepStrictEqual(buildToggleCommand(null), ["tailscale", "up"])
assert.deepStrictEqual(buildToggleCommand(undefined), ["tailscale", "up"])
})
assert.deepStrictEqual(buildToggleCommand(null), ["tailscale", "up"]);
assert.deepStrictEqual(buildToggleCommand(undefined), ["tailscale", "up"]);
});
// --- parseStatusResult ---
test("commandForPendingAction returns toggle command when pending is TOGGLE and statusOk", () => {
assert.deepStrictEqual(commandForPendingAction(PendingAction.TOGGLE, true, true), ["tailscale", "down"]);
assert.deepStrictEqual(commandForPendingAction(PendingAction.TOGGLE, false, true), ["tailscale", "up"]);
assert.deepStrictEqual(commandForPendingAction(PendingAction.TOGGLE, null, true), ["tailscale", "up"]);
});
test("parseStatusResult produces correct state from valid JSON", () => {
test("commandForPendingAction returns null when status poll failed (do not invent up/down)", () => {
assert.strictEqual(commandForPendingAction(PendingAction.TOGGLE, false, false), null);
assert.strictEqual(commandForPendingAction(PendingAction.TOGGLE, true, false), null);
assert.strictEqual(commandForPendingAction(PendingAction.TOGGLE, false, undefined), null);
});
test("commandForPendingAction returns null for no pending action or unknown pending value", () => {
assert.strictEqual(commandForPendingAction(null, true, true), null);
assert.strictEqual(commandForPendingAction(undefined, false, true), null);
assert.strictEqual(commandForPendingAction("something-else", true, true), null);
assert.strictEqual(commandForPendingAction("", true, true), null);
});
// --- parseStatusResult (#55 and ground-truth parsing) ---
test("parseStatusResult produces correct state from valid Running JSON", () => {
const json = JSON.stringify({
BackendState: "Running",
Self: { TailscaleIPs: ["100.64.0.5"] },
Peer: {
"key-1": { HostName: "router", TailscaleIPs: ["100.64.0.1"], Online: true, ExitNode: true, ExitNodeOption: true }
"key-1": {
HostName: "router",
TailscaleIPs: ["100.64.0.1"],
Online: true,
ExitNode: true,
ExitNodeOption: true
}
}
})
const state = parseStatusResult(json)
assert.strictEqual(state.isConnected, true)
assert.strictEqual(state.tailscaleIP, "100.64.0.5")
assert.strictEqual(state.currentExitNode, "router")
assert.strictEqual(state.peers.length, 1)
})
});
const state = parseStatusResult(json);
assert.strictEqual(state.isConnected, true);
assert.strictEqual(state.tailscaleIP, "100.64.0.5");
assert.strictEqual(state.currentExitNode, "router");
assert.strictEqual(state.peers.length, 1);
});
test("parseStatusResult returns safe defaults for invalid JSON", () => {
const state = parseStatusResult("not json at all")
assert.strictEqual(state.isConnected, false)
assert.strictEqual(state.tailscaleIP, "")
assert.strictEqual(state.currentExitNode, "")
assert.strictEqual(state.peers.length, 0)
})
const state = parseStatusResult("not json at all");
assert.strictEqual(state.isConnected, false);
assert.strictEqual(state.tailscaleIP, "");
assert.strictEqual(state.currentExitNode, "");
assert.deepStrictEqual(state.peers, []);
});
test("parseStatusResult handles missing Self gracefully", () => {
const json = JSON.stringify({ BackendState: "Running", Peer: {} })
const state = parseStatusResult(json)
assert.strictEqual(state.isConnected, true)
assert.strictEqual(state.tailscaleIP, "")
})
test("parseStatusResult handles missing Self gracefully when Running", () => {
const json = JSON.stringify({ BackendState: "Running", Peer: {} });
const state = parseStatusResult(json);
assert.strictEqual(state.isConnected, true);
assert.strictEqual(state.tailscaleIP, "");
});
test("parseStatusResult handles missing and empty Peer gracefully", () => {
const json = JSON.stringify({ BackendState: "Running", Self: { TailscaleIPs: ["100.64.0.5"] } })
const state = parseStatusResult(json)
assert.strictEqual(state.peers.length, 0)
assert.strictEqual(state.currentExitNode, "")
})
test("parseStatusResult handles missing and empty Peer gracefully when Running", () => {
const json = JSON.stringify({
BackendState: "Running",
Self: { TailscaleIPs: ["100.64.0.5"] }
});
const state = parseStatusResult(json);
assert.strictEqual(state.peers.length, 0);
assert.strictEqual(state.currentExitNode, "");
});
test("parseStatusResult sets isConnected false for non-Running BackendState", () => {
const json = JSON.stringify({ BackendState: "NeedsLogin", Self: { TailscaleIPs: ["100.64.0.5"] }, Peer: {} })
const state = parseStatusResult(json)
assert.strictEqual(state.isConnected, false)
})
const json = JSON.stringify({
BackendState: "NeedsLogin",
Self: { TailscaleIPs: ["100.64.0.5"] },
Peer: {}
});
const state = parseStatusResult(json);
assert.strictEqual(state.isConnected, false);
});
// #55: disconnected must not surface peer list / exit node from leftover JSON
test("parseStatusResult clears peers and exit node when BackendState is not Running (#55)", () => {
const json = JSON.stringify({
BackendState: "Stopped",
Self: { TailscaleIPs: ["100.64.0.5"] },
Peer: {
"k1": {
HostName: "router",
TailscaleIPs: ["100.64.0.1"],
Online: false,
ExitNode: true,
ExitNodeOption: true
}
}
});
const state = parseStatusResult(json);
assert.strictEqual(state.isConnected, false);
assert.deepStrictEqual(state.peers, []);
assert.strictEqual(state.currentExitNode, "");
// Self IP may still appear in raw JSON; we clear display IP when disconnected
// so the popout does not look "half connected".
assert.strictEqual(state.tailscaleIP, "");
});
test("parseStatusResult clears peers for NeedsLogin even if Peer map is populated (#55)", () => {
const json = JSON.stringify({
BackendState: "NeedsLogin",
Self: { TailscaleIPs: ["100.64.0.5"] },
Peer: {
"k1": { HostName: "ghost", TailscaleIPs: ["100.64.0.2"], Online: false }
}
});
const state = parseStatusResult(json);
assert.strictEqual(state.isConnected, false);
assert.deepStrictEqual(state.peers, []);
assert.strictEqual(state.currentExitNode, "");
assert.strictEqual(state.tailscaleIP, "");
});
// --- getStatusCommand ---
test("getStatusCommand returns the canonical tailscale status --json argv", () => {
const cmd = getStatusCommand();
assert.deepStrictEqual(cmd, ["tailscale", "status", "--json"]);
});
// --- PendingAction constant ---
test("PendingAction.TOGGLE is the stable string used by the widget", () => {
assert.strictEqual(PendingAction.TOGGLE, "toggle");
});
// --- export surface: no over-abstracted UI predicates ---
test("lib does not export trivial UI predicates shouldShowClearExitNode / isActiveExitNode", () => {
assert.strictEqual(lib.shouldShowClearExitNode, undefined);
assert.strictEqual(lib.isActiveExitNode, undefined);
});