windscout 0.6.4 → 0.7.0

package/dist/tui/progress.js

@@ -7,11 +7,13 @@ import { countryName, flag } from "./country.js";
 import { matrix, resultTable } from "./tables.js";
 import { draw, enterScreen, input, leaveScreen, out, repoLink } from "./terminal.js";
 import { bold, cyan, dim, green, red, vw, yellow } from "./text.js";
-import { bar, box, centerIn } from "./widgets.js";
+import { bar, box, centerIn, spin } from "./widgets.js";
 /** Progress bar, current attempt, results so far. tab switches the table, p pauses, q stops (twice: quits).
  * blocking: we turned the firewall on for the scan */
 export function showProgress(scan, blocking) {
-    const { protocols, options: { timeout, speedTest } } = scan;
+    const { protocols, options: { timeout } } = scan;
+    const speedTest = scan.options.speedTest || Boolean(scan.options.stopAtFirst); // stop at the first measures speed too
+    let quitting = false; // q pressed: a second one quits right away
     let view = speedTest ? "ranking" : "availability"; // tab switches
     let frame = 0;
     const render = () => {
@@ -22,7 +24,7 @@ export function showProgress(scan, blocking) {
         const partial = slots.reduce((sum, s) => sum + (s.current ? Math.min(0.95, (now() - s.attemptStart) / attemptSeconds(timeout)) : 0), 0);
         const fraction = (done + (done < total ? partial : 0)) / total;
         const eta = (total - done) * (done ? elapsed / done : attemptSeconds(timeout) / slots.length);
-        const spinner = "⠋⠙⠹⠸⠼⠴⠦⠧⠇⠏"[frame++ % 10];
+        const spinner = spin(frame++);
         const ok = sortOk(results);
         // blocked: nothing worked, and something was really tried (a key limit or a port the app doesn't offer tries nothing)
         const failed = finished.filter((c) => !results.some((r) => r.query === c && r.status === "ok")
@@ -51,9 +53,10 @@ export function showProgress(scan, blocking) {
                 : [];
         const width = Math.max(minW, table.length ? vw(table[0]) : 0);
         const inner = width - 4;
-        const status = stopping ? yellow(` stopping after the current attempt${many ? "s" : ""}…`)
-            : waiting ? yellow(` paused · VPN disconnected${blocking ? " · firewall blocking internet" : ""} · press p to resume`)
-                : "";
+        const status = scan.found ? green(" ✓ a connection held up · stopping the other attempts…")
+            : stopping ? yellow(` stopping after the current attempt${many ? "s" : ""}…`)
+                : waiting ? yellow(` paused · VPN disconnected${blocking ? " · firewall blocking internet" : ""} · press p to resume`)
+                    : "";
         const pausing = paused && !waiting && frame % 8 < 5;
         const slotLine = (s) => {
             if (!s.current)
@@ -102,12 +105,13 @@ export function showProgress(scan, blocking) {
             render();
         }
         else if (key.name === "q" || key.name === "escape" || (key.ctrl && key.name === "c")) {
-            if (scan.stopping) { // second press: bail out now
+            if (quitting) { // second press: bail out now
                 leaveScreen();
                 console.error(`stopped. the VPN may still be connecting: run '${CLI} disconnect'`);
                 await restoreFirewall();
                 process.exit(130);
             }
+            quitting = true;
             scan.stop();
             render();
         }
@@ -126,11 +130,13 @@ const clip = (s, n) => (s.length > n ? s.slice(0, Math.max(0, n - 1)) + "…" :
 /** A line per attempt. Ctrl-C stops after the current attempt, a second one quits */
 export function logProgress(scan) {
     const many = scan.slots.length > 1; // attempts overlap: a whole line once each is done
+    let quitting = false; // Ctrl-C pressed: a second one quits right away
     process.on("SIGINT", async () => {
-        if (scan.stopping) {
+        if (quitting) {
             await restoreFirewall();
             process.exit(130);
         }
+        quitting = true;
         scan.stop();
     });
     return {

package/dist/tui/tables.js

@@ -14,7 +14,7 @@ const resultRow = (r, i) => [
     r.connectS === null ? "-" : `${fmt(r.connectS, 1)} s`,
     r.latencyMs === null ? "-" : `${fmt(r.latencyMs, 0)} ms`,
     r.speedMbps === null ? "-" : bold(`${fmt(r.speedMbps, 1)} Mbps`),
-    r.status === "ok" ? green("✓ ok") : r.status === "key limit" || r.status === "no such port" ? yellow(r.status) : red(r.status),
+    r.status === "ok" ? green("✓ ok") : ["key limit", "no such port", "unreliable"].includes(r.status) ? yellow(r.status) : red(r.status),
 ];
 /** Numbered attempts, in the given order; the Speed column only when the speed test ran */
 export function resultTable(results, speedTest, options) {

package/dist/tui/terminal.js

@@ -13,6 +13,8 @@ export const input = new PassThrough();
 emitKeypressEvents(input);
 let fullscreen = false;
 let link = null; // where draw() last put the repo link
+let waiting; // drawUntilNext()'s timer
+let redrawing = false; // drawUntilNext()'s own redraw is drawing
 const openUrl = (url) => spawn({ darwin: "open", win32: "explorer" }[process.platform] ?? "xdg-open", [url], { stdio: "ignore", detached: true })
     .on("error", () => { }).unref();
 // SGR mouse report: ESC [ < button ; col ; row (M = press, m = release)
@@ -40,6 +42,7 @@ export function enterScreen() {
 }
 /** Back to the normal screen; drops every key and mouse listener */
 export function leaveScreen() {
+    clearInterval(waiting);
     if (!fullscreen)
         return;
     fullscreen = false;
@@ -51,8 +54,26 @@ export function leaveScreen() {
     out.write("\x1b[?1000l\x1b[?1006l\x1b[?25h\x1b[?1049l");
 }
 process.on("exit", leaveScreen);
+/** Calls redraw every 120 ms (for a spinner) while the screen waits for the next one: until another screen draws, or leaveScreen() */
+export function drawUntilNext(redraw) {
+    const tick = () => {
+        redrawing = true;
+        try {
+            redraw();
+        }
+        finally {
+            redrawing = false;
+        }
+    };
+    clearInterval(waiting);
+    waiting = setInterval(tick, 120);
+    waiting.unref(); // never what keeps the process alive
+    tick();
+}
 /** Redraws in place, centered: home, each line cleared to its end, then clear below (no flicker). Returns the top-left corner */
 export function draw(lines) {
+    if (!redrawing)
+        clearInterval(waiting); // another screen: it takes over from drawUntilNext()
     const cols = out.columns || 80, rows = out.rows || 24;
     const w = Math.max(...lines.map(vw));
     const left = " ".repeat(Math.max(0, Math.floor((cols - w) / 2)));

package/dist/tui/widgets.js

@@ -32,6 +32,8 @@ export function grid(cols, rows, { caption, captionRight = "", minWidth = 0, str
     out.push(row(cols.map((c) => bold(c.title))), rule("├", "┼", "┤"), ...rows.map(row), rule("╰", "┴", "╯"));
     return out;
 }
+/** A spinner's character for this frame */
+export const spin = (frame) => "⠋⠙⠹⠸⠼⠴⠦⠧⠇⠏"[frame % 10];
 /** s, indented to sit centered in width columns */
 export const centerIn = (s, width) => " ".repeat(Math.max(0, Math.floor((width - vw(s)) / 2))) + s;
 /** Gradient bar (cyan → green) with eighth-block precision on the leading edge */

package/dist/worker.js

@@ -55,9 +55,9 @@ export async function worker() {
         if (!m.probe)
             continue;
         stop = false;
-        const { query, protocol, timeout, speedTest } = m.probe;
+        const { query, protocol, timeout, speedTest, steady } = m.probe;
         const result = await probe(query, protocol, {
-            timeout, speedTest,
+            timeout, speedTest, steady,
             stopped: () => stop,
             onStep: (step) => send({ step }),
             measure: async (fn) => {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "windscout",
-  "version": "0.6.4",
-  "description": "Find which Windscribe locations and protocols work from your network, ranked by latency (unofficial)",
+  "version": "0.7.0",
+  "description": "Find which Windscribe locations and protocols work from your network, ranked by speed (unofficial)",
   "type": "module",
   "bin": {
     "windscout": "dist/cli.js"
@@ -25,12 +25,14 @@
   "keywords": [
     "windscribe",
     "vpn",
+    "speedtest",
     "wireguard",
     "stealth",
     "cli",
     "censorship",
     "firewall",
     "unblock",
+    "vpn-speed-test",
     "server-finder",
     "docker"
   ],