windscout 0.5.6 → 0.5.8

package/README.md

@@ -20,7 +20,7 @@ WindScout drives the official `windscribe-cli`: it connects to each country × p
 npm install -g windscout   # or run once with: npx windscout
 ```
 
-On startup, WindScout checks npm for a newer version. If there is one, it shows the command to update, both in the picker and after the final report.
+On startup, WindScout checks npm for a newer version. Above the repository link at the bottom of the screen, it shows the installed version in grey (`windscout 0.5.6 · latest` once npm confirms nothing newer is out), or, when a newer one is out, an update notice in yellow. In the picker, press `u` to update and restart on the new version. The update runs `npm install -g windscout@latest`, with `sudo` when your global npm folder belongs to root (sudo then asks for your password). The update command is also printed after the final report.
 
 ## Usage
 
@@ -52,6 +52,8 @@ Run `windscout` with no arguments to open the interactive picker:
 | `1`–`6` | toggle a protocol (`1`–`5` on Linux, which has no IKEv2) |
 | `s` | toggle the speed test (off = connect-only mode) |
 | `f` | toggle "block internet while scanning" (firewall) |
+| `r` | toggle random order: scan the selected countries shuffled, a new order each run |
+| `u` | update to the newer version and restart (only when the picker shows one is out) |
 | `enter` | start scanning |
 | `q` | quit (during a scan: stop and show partial results; press again to force quit) |
 
@@ -79,7 +81,8 @@ windscout -t 40 -a                          # longer connect timeout, also list
 | `-a, --all` | include failed attempts in the final table | off |
 | `-n, --no-speed` | connect-only mode: skip the download test, rank by latency | picker: saved, or connect-only on first run; with `-c`: speed test on |
 | `-f, --firewall` | block internet while scanning, except through the VPN | picker: saved, or off; with `-c`: off |
-| `-v, --version` | print the installed version; if a newer one is on npm, show the update command and ask (y/n) to run it | |
+| `-r, --random` | scan the countries in a random order | picker: saved, or off; with `-c`: off |
+| `-v, --version` | print the installed version; if a newer one is on npm, show the update command (with `sudo` when needed) and ask (y/n) to run it | |
 
 ## Connect-only mode
 

package/dist/cli.js

@@ -13,7 +13,7 @@ import { command, report, target } from "./tui/report.js";
 import { leaveScreen, out } from "./tui/terminal.js";
 import { cyan, green, yellow } from "./tui/text.js";
 import { now, sleep } from "./time.js";
-import { checkUpdate, UPDATE_COMMAND, updateNotice, VERSION, viaNpx } from "./update.js";
+import { canUpdate, checkUpdate, runUpdate, updateNotice, versionLines } from "./update.js";
 import { blockInternet, CLI, connectState, isFirewallOn, PROTOCOLS, restoreFirewall, waitForLogin, windscribe } from "./windscribe.js";
 const HELP = `Usage: windscout [options]
 
@@ -27,6 +27,7 @@ Options:
   -a, --all             also show failed attempts in the final table
   -n, --no-speed        connect-only: skip the download test, rank by latency (faster scan)
   -f, --firewall        block internet while scanning, except through the VPN (turned back off afterwards)
+  -r, --random          scan the countries in a random order
   -v, --version         show the installed version (and offer to update if a newer one is out)
   -h, --help            show this help
 
@@ -61,6 +62,17 @@ async function offerConnect(choices, timeout) {
         return;
     }
 }
+/** u in the picker: update, then run the new version in this one's place, with the same arguments */
+function updateAndRestart() {
+    const status = runUpdate();
+    if (status) {
+        console.error(yellow(`update failed (exit ${status})`));
+        process.exitCode = status;
+        return;
+    }
+    console.log(green("updated · restarting windscout"));
+    process.exitCode = spawnSync(process.execPath, [...process.execArgv, ...process.argv.slice(1)], { stdio: "inherit" }).status ?? 1;
+}
 async function main() {
     const { values: a } = parseArgs({
         options: {
@@ -72,25 +84,17 @@ async function main() {
             version: { type: "boolean", short: "v", default: false },
             "no-speed": { type: "boolean", short: "n", default: false },
             firewall: { type: "boolean", short: "f", default: false },
+            random: { type: "boolean", short: "r", default: false },
         },
     });
     if (a.help)
         return console.log(HELP);
     checkUpdate(); // runs while the app starts and the user picks, before the VPN starts switching
     if (a.version) {
-        console.log(`windscout ${VERSION}`);
         await checkUpdate();
-        const notice = updateNotice();
-        if (!notice)
-            return;
-        console.error(yellow(notice));
-        if (process.stdin.isTTY && out.isTTY && !viaNpx() && /^y(es)?$/i.test(await ask("update now? (y/n) "))) {
-            console.log(cyan(UPDATE_COMMAND));
-            // shell: npm is npm.cmd on Windows
-            const { status } = spawnSync(UPDATE_COMMAND, { shell: true, stdio: "inherit" });
-            if (status)
-                process.exitCode = status;
-        }
+        console.log(versionLines().join("\n"));
+        if (canUpdate() && process.stdin.isTTY && out.isTTY && /^y(es)?$/i.test(await ask("update now? (y/n) ")))
+            process.exitCode = runUpdate();
         return;
     }
     let timeout = a.timeout ? Number(a.timeout) : undefined;
@@ -102,6 +106,7 @@ async function main() {
     let protocols = a.protocols ? list(a.protocols) : undefined;
     let speedTest = !a["no-speed"];
     let firewall = a.firewall;
+    let random = a.random;
     if (!countries) {
         if (!tty)
             throw new Error("no terminal for the picker: pass countries with -c");
@@ -113,17 +118,23 @@ async function main() {
             speedTest: speedTest && (saved?.speed ?? false), // first run: connect-only
             // already on in the app: show it on, since the scan won't turn it off
             firewall: firewall || isFirewallOn(status) || (saved?.firewall ?? false),
+            random: random || (saved?.random ?? false),
         });
         if (!choice)
             return;
+        if (choice === "update")
+            return updateAndRestart();
         countries = choice.countries;
         protocols ??= choice.protocols;
         speedTest = choice.speed;
         firewall = choice.firewall;
+        random = choice.random;
         timeout = choice.timeout;
     }
     protocols ??= PROTOCOLS;
     timeout ??= DEFAULT_TIMEOUT;
+    if (random)
+        countries = countries.map((c) => [Math.random(), c]).sort(([x], [y]) => x - y).map(([, c]) => c);
     const scan = new Scan(countries, protocols, { timeout, speedTest });
     const blocking = firewall && (await blockInternet());
     const view = tty ? showProgress(scan, blocking) : logProgress(scan);
@@ -134,9 +145,8 @@ async function main() {
         console.log(yellow("interrupted, showing partial results"));
     const choices = report(scan.results, protocols, { all: a.all, speedTest });
     await checkUpdate();
-    const notice = updateNotice();
-    if (notice)
-        console.error("\n" + yellow(notice));
+    if (updateNotice())
+        console.error("\n" + versionLines().join("\n"));
     if (tty && choices.length)
         await offerConnect(choices, timeout);
 }

package/dist/config.js

@@ -15,6 +15,7 @@ export function loadConfig() {
             protocols: (c.protocols ?? []).filter((x) => PROTOCOLS.includes(x)),
             speed: c.speed !== false,
             firewall: c.firewall === true,
+            random: c.random === true,
             timeout: c.timeout >= MIN_TIMEOUT ? c.timeout : DEFAULT_TIMEOUT,
         };
     }

package/dist/tui/picker.js

@@ -1,15 +1,15 @@
 import { MIN_TIMEOUT, saveConfig } from "../config.js";
 import { attemptSeconds, estimate } from "../scan.js";
 import { duration } from "../time.js";
-import { checkUpdate, updateNotice } from "../update.js";
+import { canUpdate, checkUpdate, versionLines } from "../update.js";
 import { COUNTRIES, PROTOCOLS } from "../windscribe.js";
 import { countryName, flag } from "./country.js";
 import { draw, enterScreen, input, leaveScreen, out, repoLink } from "./terminal.js";
 import { bold, cyan, dim, green, under, vw, yellow } from "./text.js";
 import { box, centerIn, grid } from "./widgets.js";
 const flip = (set, value) => (set.has(value) ? set.delete(value) : set.add(value));
-/** Resolves to the choice (also saved for next time), or null when the user quits */
-export function pick(saved, { timeout, speedTest, firewall }) {
+/** Resolves to the choice (also saved for next time), null when the user quits, or "update" for u */
+export function pick(saved, { timeout, speedTest, firewall, random }) {
     const selected = new Set(saved?.countries ?? []);
     const protos = new Set(saved?.protocols.length ? saved.protocols : PROTOCOLS);
     let cursor = 0, top = 0, message = "", query = "", searching = false;
@@ -23,9 +23,9 @@ export function pick(saved, { timeout, speedTest, firewall }) {
     return new Promise((resolve) => {
         const render = () => {
             const rows = out.rows || 24;
-            const notice = updateNotice();
+            const version = versionLines(true);
             const matches = visible();
-            const height = Math.max(3, rows - 21 - (notice ? 1 : 0));
+            const height = Math.max(3, rows - 22 - version.length);
             cursor = Math.max(0, Math.min(cursor, matches.length - 1));
             if (cursor < top)
                 top = cursor;
@@ -40,6 +40,9 @@ export function pick(saved, { timeout, speedTest, firewall }) {
             const fwLine = `${dim(under("f"))} ${firewall ? green("● " + fwLabel) : dim("○ " + fwLabel)}  ${dim(firewall
                 ? "only VPN traffic gets through"
                 : "off: apps may leak in between")}`;
+            const randomLine = `${dim(under("r"))} ${random ? green("● random order") : dim("○ random order")}  ${dim(random
+                ? "scans the countries shuffled, a new order each run"
+                : "off: scans in list order")}`;
             timeout = Number(seconds);
             const short = timeout < MIN_TIMEOUT;
             const timeoutLine = `${dim(under("t"))} timeout ${editing ? bold(seconds) + cyan("▏") : (short ? yellow : bold)(seconds || "?")} s  ${dim(`per connection · at least ${MIN_TIMEOUT}`)}`;
@@ -63,9 +66,9 @@ export function pick(saved, { timeout, speedTest, firewall }) {
                 ["quit", under("Q") + "uit"],
             ];
             const buttonLine = buttons.map(([id, label]) => (id === "start" ? bold(cyan(`[ ${label} ]`)) : dim(`[ ${label} ]`))).join("  ");
-            const table = grid([{ title: "" }, { title: "Code" }, { title: "Country" }], body, { caption: search, captionRight: dim(range), minWidth: Math.max(vw(protoLine), vw(speedLine), vw(fwLine), vw(timeoutLine)) + 4 });
+            const table = grid([{ title: "" }, { title: "Code" }, { title: "Country" }], body, { caption: search, captionRight: dim(range), minWidth: Math.max(vw(protoLine), vw(speedLine), vw(fwLine), vw(randomLine), vw(timeoutLine)) + 4 });
             const width = vw(table[0]);
-            const head = box([protoLine, speedLine, fwLine, timeoutLine], {
+            const head = box([protoLine, speedLine, fwLine, randomLine, timeoutLine], {
                 title: bold(cyan("WindScout")),
                 right: `${bold(String(selected.size))}${dim(`/${COUNTRIES.length} selected`)}`,
                 width: width - 4,
@@ -85,13 +88,11 @@ export function pick(saved, { timeout, speedTest, firewall }) {
                     : searching
                         ? "type to filter · ↑↓ move · enter/esc done"
                         : `↑↓ move · space select · a/n ${query ? "all/none shown" : "all/none"} · / search`), width),
-                centerIn(dim(searching || editing ? "" : `1-${PROTOCOLS.length} protocols · s speed test · f firewall · t timeout · enter start · ${query ? "esc clear · " : ""}q quit`), width),
+                centerIn(dim(searching || editing ? "" : `1-${PROTOCOLS.length} protocols · s speed test · f firewall · r random · t timeout · enter start · ${query ? "esc clear · " : ""}q quit`), width),
             ];
             if (message)
                 lines.push(centerIn(yellow(message), width));
-            lines.push("", centerIn(dim(repoLink), width));
-            if (notice)
-                lines.push(centerIn(yellow(notice), width));
+            lines.push("", ...version.map((l) => centerIn(l, width)), centerIn(dim(repoLink), width));
             const at = draw(lines);
             // click map, in screen coordinates
             let px = at.left + 2; // "│ " before the protocol line
@@ -109,20 +110,20 @@ export function pick(saved, { timeout, speedTest, firewall }) {
                 return range;
             });
             hit = {
-                protoRow: at.top + 1, protoHits, speedRow: at.top + 2, firewallRow: at.top + 3, timeoutRow: at.top + 4,
+                protoRow: at.top + 1, protoHits, speedRow: at.top + 2, firewallRow: at.top + 3, randomRow: at.top + 4, timeoutRow: at.top + 5,
                 searchRow: at.top + head.length + 1,
                 firstRow: at.top + head.length + 5, shown: shown.length,
                 buttonRow: at.top + head.length + table.length + 1, buttonHits,
             };
         };
         let closed = false;
-        checkUpdate().then(() => updateNotice() && !closed && render()); // the check usually lands after the first draw
+        checkUpdate().then(() => !closed && render()); // the check usually lands after the first draw
         const finish = (value) => {
             closed = true;
             out.off("resize", render);
             input.removeAllListeners("keypress");
             input.removeAllListeners("mouse");
-            if (!value)
+            if (!value || value === "update")
                 leaveScreen();
             resolve(value);
         };
@@ -141,6 +142,7 @@ export function pick(saved, { timeout, speedTest, firewall }) {
                 protocols: PROTOCOLS.filter((p) => protos.has(p)),
                 speed: speedTest,
                 firewall,
+                random,
                 timeout,
             };
             saveConfig(choice);
@@ -180,6 +182,8 @@ export function pick(saved, { timeout, speedTest, firewall }) {
                     speedTest = !speedTest;
                 else if (y === hit.firewallRow)
                     firewall = !firewall;
+                else if (y === hit.randomRow)
+                    random = !random;
                 else if (y === hit.buttonRow) {
                     const id = hit.buttonHits.find(([, a, b]) => x >= a && x < b)?.[0];
                     if (id === "start" && start())
@@ -255,8 +259,12 @@ export function pick(saved, { timeout, speedTest, firewall }) {
                 speedTest = !speedTest;
             else if (k === "f")
                 firewall = !firewall;
+            else if (k === "r")
+                random = !random;
             else if (k === "t")
                 editing = true, seconds = "";
+            else if (k === "u" && canUpdate())
+                return finish("update");
             else if (/^[1-9]$/.test(str ?? "") && PROTOCOLS[Number(str) - 1])
                 flip(protos, PROTOCOLS[Number(str) - 1]);
             else if (k === "escape" && query)

package/dist/tui/progress.js

@@ -1,6 +1,7 @@
 import { sortOk } from "../probe.js";
 import { attemptSeconds } from "../scan.js";
 import { duration, now } from "../time.js";
+import { versionLines } from "../update.js";
 import { CLI, restoreFirewall } from "../windscribe.js";
 import { countryName, flag } from "./country.js";
 import { matrix, resultTable } from "./tables.js";
@@ -34,7 +35,8 @@ export function showProgress(scan, blocking) {
         ].join(dim("   │   "));
         const minW = Math.max(64, vw(stats) + 6); // panel and table share one width
         // results table gets whatever height the status panel and footer leave
-        const room = Math.max(1, rows - 22);
+        const version = versionLines();
+        const room = Math.max(1, rows - 22 - version.length);
         const table = view === "availability"
             ? matrix(results, protocols, { minWidth: minW, limit: room })
             : ok.length
@@ -73,7 +75,7 @@ export function showProgress(scan, blocking) {
                 txt = txt.slice(0, -8) + "…"; // ponytail: crude trim, fine for a status line
             lines.push("", centerIn(txt, width));
         }
-        lines.push("", centerIn(dim(`tab ${view === "ranking" ? "availability" : "ranking"} view · p ${paused ? "resume" : "pause"} · q stop · q twice force quit`), width), "", centerIn(dim(repoLink), width));
+        lines.push("", centerIn(dim(`tab ${view === "ranking" ? "availability" : "ranking"} view · p ${paused ? "resume" : "pause"} · q stop · q twice force quit`), width), "", ...version.map((l) => centerIn(l, width)), centerIn(dim(repoLink), width));
         draw(lines);
     };
     enterScreen();

package/dist/update.js

@@ -1,7 +1,10 @@
-// The installed version, and whether npm has a newer one.
-import { readFileSync } from "node:fs";
+// The installed version, whether npm has a newer one, and updating to it.
+import { spawnSync } from "node:child_process";
+import { accessSync, constants, readFileSync } from "node:fs";
+import { cyan, dim, under, yellow } from "./tui/text.js";
 export const VERSION = JSON.parse(readFileSync(new URL("../package.json", import.meta.url), "utf8")).version;
 let latest = null; // newer version on npm, once known
+let upToDate = false; // npm answered, and has nothing newer
 let check;
 // numeric x.y.z compare; parseInt drops a prerelease suffix ("0-beta" → 0)
 export function newer(a, b) {
@@ -15,17 +18,48 @@ export function newer(a, b) {
 export function checkUpdate() {
     check ??= fetch("https://registry.npmjs.org/windscout/latest", { signal: AbortSignal.timeout(3000) })
         .then((r) => r.json())
-        .then(({ version }) => { if (version && newer(version, VERSION))
-        latest = version; })
+        .then(({ version }) => {
+        if (version && newer(version, VERSION))
+            latest = version;
+        else
+            upToDate = Boolean(version);
+    })
         .catch(() => { });
     return check;
 }
 // run through npx: there's nothing installed to update, the next npx windscout@latest fetches it
 export const viaNpx = () => process.env.npm_command === "exec";
-export const UPDATE_COMMAND = "npm install -g windscout@latest";
-/** "update available: …" with the command to run, once checkUpdate() found a newer version */
-export function updateNotice() {
+// npm replaces the folder this package sits in; a root-owned global folder (system Node) needs sudo for that
+const sudo = (() => {
+    try {
+        accessSync(new URL("../..", import.meta.url), constants.W_OK);
+        return false;
+    }
+    catch {
+        return true;
+    }
+})();
+const INSTALL = "npm install -g windscout@latest";
+export const UPDATE_COMMAND = (sudo ? "sudo " : "") + INSTALL;
+// npm is Node too: through a slow tunnel its downloads time out like fetch did (see measure.ts) without these
+const NODE_FIX = "--no-network-family-autoselection --dns-result-order=ipv4first";
+/** A newer version is out, and npm can install it (under npx there's nothing installed to update) */
+export const canUpdate = () => latest !== null && !viaNpx();
+/** Runs the update in this terminal (sudo asks for the password here); returns npm's exit status */
+export function runUpdate() {
+    console.log(cyan(UPDATE_COMMAND));
+    const NODE_OPTIONS = `${process.env.NODE_OPTIONS ?? ""} ${NODE_FIX}`.trim();
+    // sudo clears the environment, so env sets NODE_OPTIONS on its side; shell: npm is npm.cmd on Windows
+    return spawnSync(sudo ? `sudo env NODE_OPTIONS="${NODE_FIX}" ${INSTALL}` : INSTALL, { shell: true, stdio: "inherit", env: { ...process.env, NODE_OPTIONS } }).status ?? 1;
+}
+/** "update available: …" and how to get it, once checkUpdate() found a newer version; onKey: this screen updates on u */
+export function updateNotice(onKey = false) {
     if (!latest)
         return null;
-    return `update available: ${VERSION} → ${latest} · run: ${viaNpx() ? "npx windscout@latest" : UPDATE_COMMAND}`;
+    return [`update available: ${VERSION} → ${latest}`,
+        viaNpx() ? "quit, then run: npx windscout@latest"
+            : onKey ? `press ${under("u")} to update and restart · runs ${UPDATE_COMMAND}`
+                : `run: ${UPDATE_COMMAND}, then restart windscout`];
 }
+/** The version line(s) above the repo link: the update notice in yellow, or the installed version in grey */
+export const versionLines = (onKey = false) => updateNotice(onKey)?.map(yellow) ?? [dim(`windscout ${VERSION}${upToDate ? " · latest" : ""}`)];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "windscout",
-  "version": "0.5.6",
+  "version": "0.5.8",
   "description": "Find which Windscribe locations and protocols work from your network, ranked by speed (unofficial)",
   "type": "module",
   "bin": {