Compare commits

..

No commits in common. "0283ce6136d2db1eef1b36a7caf543609f16275f" and "a46794b386afeb83ae659a11554858796ad16bc3" have entirely different histories.

4 changed files with 24 additions and 101 deletions

View file

@ -21,7 +21,7 @@ A lightweight widget plugin that shows Tailscale connectivity status on the Dank
- Dank Material Shell installed and running - Dank Material Shell installed and running
- `tailscale` CLI available on `PATH` - `tailscale` CLI available on `PATH`
- A clipboard tool (`dms` or `wl-copy`) - A clipboard tool (`dms`, `wl-copy`, or `clipmanctl`)
## Installation ## Installation

View file

@ -18,7 +18,6 @@ PluginComponent {
property string _copyText: "" property string _copyText: ""
property string _copyCurrentTool: "" property string _copyCurrentTool: ""
property int _copyAttempted: 0 property int _copyAttempted: 0
property bool _pendingToggle: false // transient one-shot for poll-then-act (#42) reset immediately after use, no "desired state" cache
layerNamespacePlugin: "tailscalectl" layerNamespacePlugin: "tailscalectl"
popoutWidth: 360 popoutWidth: 360
@ -112,23 +111,12 @@ PluginComponent {
root.peers = [] root.peers = []
ToastService.showError("tailscalectl", TailscaleLib.errorMessage("status")) ToastService.showError("tailscalectl", TailscaleLib.errorMessage("status"))
} }
// #42 poll-then-act: if a toggle was requested, use the *fresh* state we just received
// #47: structured logging evaluated and rejected toasts + 120-char stderr already give
// actionable feedback; persistent logs would add state/rotation with no net UX benefit.
if (root._pendingToggle) {
root._pendingToggle = false
toggleProcess.command = TailscaleLib.buildToggleCommand(root.isConnected)
toggleProcess.running = true
}
} }
} }
function toggleTailscale() { function toggleTailscale() {
// #42: poll-then-act never decide up/down from potentially stale root.isConnected. toggleProcess.command = TailscaleLib.buildToggleCommand(root.isConnected)
// Force a fresh statusCheck; the decision happens in its onExited using the just-received value. toggleProcess.running = true
root._pendingToggle = true
statusCheck.running = true
} }
function setExitNode(hostname) { function setExitNode(hostname) {
@ -214,7 +202,7 @@ PluginComponent {
} }
MouseArea { MouseArea {
visible: TailscaleLib.shouldShowClearExitNode(root.currentExitNode) visible: root.currentExitNode !== ""
cursorShape: Qt.PointingHandCursor cursorShape: Qt.PointingHandCursor
hoverEnabled: true hoverEnabled: true
anchors.verticalCenter: parent.verticalCenter anchors.verticalCenter: parent.verticalCenter
@ -304,7 +292,7 @@ PluginComponent {
id: exitNodeButton id: exitNodeButton
text: "↗" text: "↗"
font.pixelSize: Theme.fontSizeSmall font.pixelSize: Theme.fontSizeSmall
color: TailscaleLib.isActiveExitNode(root.currentExitNode, modelData.hostname) ? Theme.primary : Theme.surfaceVariantText color: root.currentExitNode === modelData.hostname ? Theme.primary : Theme.surfaceVariantText
} }
} }
} }

View file

@ -31,13 +31,12 @@ function findActiveExitNode(peerMap) {
return "" return ""
} }
var safeClipboardTools = ["dms", "wl-copy"] var safeClipboardTools = ["dms", "wl-copy", "clipmanctl"]
// Direct argv form — no sh -c, no escaping, no future injection surface (#49) var clipboardCmdMap = {
// clipmanctl intentionally dropped (niche optional history manager, not needed on DMS + Wayland) "dms": "dms cl copy",
var clipboardTools = { "wl-copy": "wl-copy",
"dms": { argv: ["dms", "cl", "copy"] }, "clipmanctl": "clipmanctl copy"
"wl-copy": { argv: ["wl-copy"] }
} }
function validateClipboardTool(tool) { function validateClipboardTool(tool) {
@ -45,10 +44,11 @@ function validateClipboardTool(tool) {
} }
function buildCopyCommand(text, tool) { function buildCopyCommand(text, tool) {
const entry = clipboardTools[tool] if (!validateClipboardTool(tool)) return null
if (!entry) return null var cmd = clipboardCmdMap[tool]
// Pure argv — the Process will pass the string verbatim. No shell involved. if (!cmd) return null
return [...entry.argv, text] var escaped = text.replace(/'/g, "'\\''")
return ["sh", "-c", "printf '%s' '" + escaped + "' | " + cmd]
} }
function nextClipboardTool(currentTool) { function nextClipboardTool(currentTool) {
@ -61,30 +61,6 @@ function allClipboardTools() {
return safeClipboardTools.slice() return safeClipboardTools.slice()
} }
function getStrings() {
return {
header: "Tailscale",
connected: "Connected",
disconnected: "Disconnected",
exitNodePrefix: "Exit node: ",
none: "None",
copied: function (text) { return "Copied " + text + " to clipboard" },
noClipboardTool: "No clipboard tool found",
invalidClipboardCommand: "Invalid clipboard command",
clearExitNode: "×",
setExitNode: "↗"
}
}
// Light UI predicates extracted from QML (advances #43 — keeps view thin)
function shouldShowClearExitNode(currentExitNode) {
return currentExitNode !== ""
}
function isActiveExitNode(currentExitNode, hostname) {
return currentExitNode === hostname
}
function parseStatusResult(jsonText) { function parseStatusResult(jsonText) {
try { try {
const data = JSON.parse(jsonText) const data = JSON.parse(jsonText)
@ -117,5 +93,5 @@ function errorMessage(cmd) {
// CommonJS export for Node.js tests (ignored by QML) // CommonJS export for Node.js tests (ignored by QML)
if (typeof module !== "undefined" && module.exports) { if (typeof module !== "undefined" && module.exports) {
module.exports = { parsePeers, makeExitNodeCommand, findActiveExitNode, errorMessage, validateClipboardTool, buildCopyCommand, nextClipboardTool, allClipboardTools, buildToggleCommand, parseStatusResult, getStrings, shouldShowClearExitNode, isActiveExitNode } module.exports = { parsePeers, makeExitNodeCommand, findActiveExitNode, errorMessage, validateClipboardTool, buildCopyCommand, nextClipboardTool, allClipboardTools, buildToggleCommand, parseStatusResult }
} }

View file

@ -1,20 +1,7 @@
import { test } from "node:test" import { test } from "node:test"
import assert from "node:assert" import assert from "node:assert"
import lib from "../tailscalectl/lib.js" import lib from "../tailscalectl/lib.js"
const { parsePeers, makeExitNodeCommand, findActiveExitNode, errorMessage, validateClipboardTool, buildCopyCommand, nextClipboardTool, allClipboardTools, buildToggleCommand, parseStatusResult, getStrings, shouldShowClearExitNode, isActiveExitNode } = lib const { parsePeers, makeExitNodeCommand, findActiveExitNode, errorMessage, validateClipboardTool, buildCopyCommand, nextClipboardTool, allClipboardTools, buildToggleCommand, parseStatusResult } = lib
/*
* Test coverage note for #48:
* All pure functions exported from lib.js (including the newly extracted
* getStrings, shouldShowClearExitNode, isActiveExitNode, and the clipboard
* helpers) are exercised here via node:test.
*
* The four Process objects, 5-second Timer, onExited handlers, copy fallback
* state machine, and overall widget behavior in TailscaleWidget.qml have no
* automated test coverage. There is no QML test runner in this project.
* Those paths are verified manually (see verification checklist in the
* feature branch commits).
*/
test("parsePeers extracts exitNode from ExitNodeOption", () => { test("parsePeers extracts exitNode from ExitNodeOption", () => {
const peerMap = { const peerMap = {
@ -93,7 +80,7 @@ test("errorMessage returns generic message for unknown command", () => {
test("validateClipboardTool accepts whitelisted tool names", () => { test("validateClipboardTool accepts whitelisted tool names", () => {
assert.strictEqual(validateClipboardTool("dms"), true) assert.strictEqual(validateClipboardTool("dms"), true)
assert.strictEqual(validateClipboardTool("wl-copy"), true) assert.strictEqual(validateClipboardTool("wl-copy"), true)
// clipmanctl intentionally dropped (see #49) assert.strictEqual(validateClipboardTool("clipmanctl"), true)
}) })
test("validateClipboardTool rejects malicious inputs", () => { test("validateClipboardTool rejects malicious inputs", () => {
@ -114,7 +101,8 @@ test("validateClipboardTool rejects empty and falsy inputs", () => {
test("buildCopyCommand returns safe command for whitelisted clipboard tool", () => { test("buildCopyCommand returns safe command for whitelisted clipboard tool", () => {
const cmd = buildCopyCommand("hello", "wl-copy") const cmd = buildCopyCommand("hello", "wl-copy")
assert.ok(Array.isArray(cmd)) assert.ok(Array.isArray(cmd))
assert.deepStrictEqual(cmd, ["wl-copy", "hello"]) // direct argv, no sh -c (see #49) assert.strictEqual(cmd[0], "sh")
assert.strictEqual(cmd[1], "-c")
}) })
test("buildCopyCommand returns null for invalid clipboard tool", () => { test("buildCopyCommand returns null for invalid clipboard tool", () => {
@ -132,7 +120,8 @@ test("buildCopyCommand safely handles text with special characters", () => {
test("nextClipboardTool cycles through tools", () => { test("nextClipboardTool cycles through tools", () => {
assert.strictEqual(nextClipboardTool("dms"), "wl-copy") assert.strictEqual(nextClipboardTool("dms"), "wl-copy")
assert.strictEqual(nextClipboardTool("wl-copy"), "dms") // clipmanctl dropped (#49) assert.strictEqual(nextClipboardTool("wl-copy"), "clipmanctl")
assert.strictEqual(nextClipboardTool("clipmanctl"), "dms")
}) })
test("nextClipboardTool falls back to first tool for unknown input", () => { test("nextClipboardTool falls back to first tool for unknown input", () => {
@ -145,40 +134,10 @@ test("nextClipboardTool falls back to first tool for unknown input", () => {
test("allClipboardTools returns the list of safe tools", () => { test("allClipboardTools returns the list of safe tools", () => {
const tools = allClipboardTools() const tools = allClipboardTools()
assert.ok(Array.isArray(tools)) assert.ok(Array.isArray(tools))
assert.strictEqual(tools.length, 2) assert.strictEqual(tools.length, 3)
assert.ok(tools.includes("dms")) assert.ok(tools.includes("dms"))
assert.ok(tools.includes("wl-copy")) assert.ok(tools.includes("wl-copy"))
// clipmanctl intentionally removed (#49) assert.ok(tools.includes("clipmanctl"))
})
// --- getStrings (for #34 i18n prep) ---
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.copied)
assert.ok(s.noClipboardTool)
assert.ok(s.invalidClipboardCommand)
})
test("getStrings.copied interpolates the text", () => {
const s = getStrings()
const msg = s.copied("100.64.0.5")
assert.ok(msg.includes("100.64.0.5"))
})
test("shouldShowClearExitNode returns true only when there is a current exit node", () => {
assert.strictEqual(shouldShowClearExitNode("router"), true)
assert.strictEqual(shouldShowClearExitNode(""), false)
})
test("isActiveExitNode correctly identifies the active exit node button", () => {
assert.strictEqual(isActiveExitNode("gluetun-sjc", "gluetun-sjc"), true)
assert.strictEqual(isActiveExitNode("gluetun-sjc", "gluetun-den"), false)
assert.strictEqual(isActiveExitNode("", "router"), false)
}) })
// --- buildToggleCommand --- // --- buildToggleCommand ---