windscout 0.4.3 → 0.4.5

package/README.md

@@ -51,6 +51,7 @@ Run `windscout` with no arguments to open the interactive picker:
 | `a` / `n` | select all / unselect all (only the matching countries while a search is active) |
 | `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) |
 | `enter` | start scanning |
 | `q` | quit (during a scan: stop and show partial results; press again to force quit) |
 
@@ -77,6 +78,7 @@ windscout -t 40 -a                          # longer connect timeout, also list
 | `-t, --timeout` | seconds to wait for each connection | 20 |
 | `-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, and the update command if a newer one is on npm | |
 
 ## Connect-only mode
@@ -98,7 +100,11 @@ Both modes show an **availability grid**: one row per country, and ✓ / ✗ for
 ╰─────────────────────────┴────────────────────────┴─────────┴───────────┴─────╯
 ```
 
-While scanning, press `tab` to switch between the availability grid and the speed or latency ranking. In connect-only mode the scan starts on the availability grid.
+While scanning, press `tab` to switch between the availability grid and the speed or latency ranking. Press `p` (or `space`) to pause: the current attempt finishes, the VPN disconnects, and the scan waits until you press `p` again. Paused time doesn't count toward elapsed or remaining. In connect-only mode the scan starts on the availability grid.
+
+## Block internet while scanning (firewall)
+
+Between attempts the VPN is disconnected for a moment, and apps on your computer (browser, messengers, updates) can go online over your real connection. Turn on **block internet while scanning** with `f` in the picker or `--firewall`, and WindScout switches on the Windscribe app's firewall for the scan: nothing gets online except through the VPN. When the scan ends or you stop it, the firewall goes back off (if you already had it on, WindScout leaves it on). While a scan is paused, the firewall keeps blocking.
 
 ## Output
 

package/package.json

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

package/windscout.js

@@ -47,6 +47,8 @@ const noFlags = process.platform === "win32" || process.env.TERM_PROGRAM === "Ap
 const flag = (code) => !noFlags && /^[A-Z]{2}$/.test(code) ? String.fromCodePoint(...[...code].map((c) => 0x1f1a5 + c.charCodeAt(0))) : "  ";
 let stop = 0;
 let speedTest = true; // false = connect-only mode: skip the download test, rank by latency
+let firewall = false; // turn on the app's firewall while scanning, so nothing goes online outside the VPN
+let restoreFirewall = async () => {}; // set by scan(); also called on a crash so the internet isn't left blocked
 
 // ---------- windscribe + measurements ----------
 
@@ -314,6 +316,7 @@ function loadConfig() {
       countries: (c.countries ?? []).filter((x) => COUNTRIES.includes(x)),
       protocols: (c.protocols ?? []).filter((x) => PROTOCOLS.includes(x)),
       speed: c.speed !== false,
+      firewall: c.firewall === true,
     };
   } catch {
     return null; // first run or unreadable file
@@ -415,7 +418,7 @@ function pick(saved, timeout) {
     const render = () => {
       const rows = out.rows || 24;
       const list = visible();
-      const height = Math.max(3, rows - 19 - (update ? 1 : 0));
+      const height = Math.max(3, rows - 20 - (update ? 1 : 0));
       cursor = Math.max(0, Math.min(cursor, list.length - 1));
       if (cursor < top) top = cursor;
       if (cursor >= top + height) top = cursor - height + 1;
@@ -426,6 +429,10 @@ function pick(saved, timeout) {
       const speedLine = `${dim(under("s"))} ${speedTest ? green("● speed test") : dim("○ speed test")}  ${dim(speedTest
         ? "ranks by download speed · adds ~15s per working connection"
         : "off: connect-only, ranks by latency")}`;
+      const fwLabel = "block internet while scanning (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 search = searching
         ? `${cyan("🔍")} ${bold(query)}${cyan("▏")}`
         : query ? `🔍 ${query}` : dim("🔍 press / to search");
@@ -442,9 +449,9 @@ function pick(saved, timeout) {
       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)) + 4 });
+        { caption: search, captionRight: dim(range), minWidth: Math.max(vw(protoLine), vw(speedLine), vw(fwLine)) + 4 });
       const width = vw(table[0]);
-      const head = box([protoLine, speedLine], {
+      const head = box([protoLine, speedLine, fwLine], {
         title: bold(cyan("WindScout")),
         right: `${bold(String(selected.size))}${dim(`/${COUNTRIES.length} selected`)}`,
         width: width - 4,
@@ -460,7 +467,7 @@ function pick(saved, timeout) {
         centerIn(dim(searching
           ? "type to filter · ↑↓ move · enter/esc done"
           : `↑↓ move · space select · a/n ${query ? "all/none shown" : "all/none"} · / search`), width),
-        centerIn(dim(searching ? "" : `1-${PROTOCOLS.length} protocols · s speed test · enter start · ${query ? "esc clear · " : ""}q quit`), width),
+        centerIn(dim(searching ? "" : `1-${PROTOCOLS.length} protocols · s speed test · f firewall · enter start · ${query ? "esc clear · " : ""}q quit`), width),
       ];
       lines.splice(head.length + table.length + 1, 0, centerIn(buttonLine, width), "");
       if (message) lines.push(centerIn(yellow(message), width));
@@ -485,7 +492,7 @@ function pick(saved, timeout) {
         return range;
       });
       hit = {
-        protoRow: y0 + 1, speedRow: y0 + 2, protoHits,
+        protoRow: y0 + 1, speedRow: y0 + 2, firewallRow: y0 + 3, protoHits,
         searchRow: y0 + head.length + 1,
         firstRow: y0 + head.length + 5, shown: shown.length,
         buttonRow: y0 + head.length + table.length + 1, buttonHits,
@@ -510,6 +517,7 @@ function pick(saved, timeout) {
         countries: COUNTRIES.filter((c) => selected.has(c)),
         protocols: PROTOCOLS.filter((p) => protos.has(p)),
         speed: speedTest,
+        firewall,
       };
       saveConfig(choice);
       finish(choice);
@@ -535,6 +543,7 @@ function pick(saved, timeout) {
           const i = hit.protoHits.findIndex(([a, b]) => x >= a && x < b);
           if (i >= 0) protos.has(PROTOCOLS[i]) ? protos.delete(PROTOCOLS[i]) : protos.add(PROTOCOLS[i]);
         } else if (y === hit.speedRow) speedTest = !speedTest;
+        else if (y === hit.firewallRow) firewall = !firewall;
         else if (y === hit.buttonRow) {
           const id = hit.buttonHits.find(([, a, b]) => x >= a && x < b)?.[0];
           if (id === "start" && start()) return;
@@ -578,6 +587,7 @@ function pick(saved, timeout) {
       else if (k === "a") list.forEach((c) => selected.add(c));
       else if (k === "n") list.forEach((c) => selected.delete(c));
       else if (k === "s") speedTest = !speedTest;
+      else if (k === "f") firewall = !firewall;
       else if (/^[1-9]$/.test(str ?? "") && PROTOCOLS[Number(str) - 1]) {
         const p = PROTOCOLS[Number(str) - 1];
         protos.has(p) ? protos.delete(p) : protos.add(p);
@@ -599,12 +609,18 @@ async function scan(countries, protocols, timeout, tty) {
   const started = now();
   let done = 0, attemptStart = now(), current = "", step = "", frame = 0, finishedCountries = [];
   let view = speedTest ? "ranking" : "availability"; // tab switches
+  // pause lands between attempts, so the VPN is disconnected while waiting; idle = seconds spent paused
+  let paused = false, waiting = false, waitStart = 0, idle = 0, resume = () => {};
+  // firewall: block everything outside the VPN while switching locations; put it back the way the user had it
+  const fwChanged = firewall && /^Firewall state: Off/m.test(await cli("status"));
+  if (fwChanged) await cli("firewall", "on");
+  restoreFirewall = async () => { if (fwChanged) await cli("firewall", "off"); };
 
   const render = () => {
     const rows = out.rows || 24;
-    const elapsed = now() - started;
+    const elapsed = now() - started - idle - (waiting ? now() - waitStart : 0);
     // smooth bar: count the running attempt as partially done
-    const partial = Math.min(0.95, (now() - attemptStart) / attemptSeconds(timeout));
+    const partial = waiting ? 0 : Math.min(0.95, (now() - attemptStart) / attemptSeconds(timeout));
     const fraction = (done + (done < total ? partial : 0)) / total;
     const eta = (total - done) * (done ? elapsed / done : attemptSeconds(timeout));
     const spinner = "⠋⠙⠹⠸⠼⠴⠦⠧⠇⠏"[frame++ % 10];
@@ -640,8 +656,9 @@ async function scan(countries, protocols, timeout, tty) {
       "",
       stop
         ? yellow(" stopping after the current attempt…")
+        : waiting ? yellow(` paused · VPN disconnected${fwChanged ? " · firewall blocking internet" : ""} · press p to resume`)
         : ` ${cyan(spinner)} ${bold(current)}`,
-      stop ? "" : `   ${dim(step)} ${dim("·")} ${duration(now() - attemptStart)}`,
+      stop || waiting ? "" : `   ${dim(step)} ${dim("·")} ${duration(now() - attemptStart)}${paused && frame % 8 < 5 ? yellow(" · pausing after this attempt") : ""}`,
       null,
       centerIn(stats, inner),
     ], {
@@ -658,34 +675,45 @@ async function scan(countries, protocols, timeout, tty) {
       while (vw(txt) > width && failed.length) 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 · 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), "", centerIn(dim(repoLink), width));
     draw(lines);
   };
 
   let timer;
   if (tty) {
     if (!fullscreen) enterScreen();
-    input.on("keypress", (str, key = {}) => {
+    input.on("keypress", async (str, key = {}) => {
       if (key.name === "tab") {
         view = view === "ranking" ? "availability" : "ranking";
         render();
+      } else if (key.name === "p" || key.name === "space") {
+        paused = !paused;
+        if (!paused) resume();
+        render();
       } else if (key.name === "q" || key.name === "escape" || (key.ctrl && key.name === "c")) {
         if (stop++) { // second press: bail out now
           leaveScreen();
           console.error(`stopped. the VPN may still be connecting: run '${CLI} disconnect'`);
+          await restoreFirewall();
           process.exit(130);
         }
+        resume(); // a paused scan stops right away
         render();
       }
     });
     out.on("resize", render);
     timer = setInterval(render, 120);
   } else {
-    process.on("SIGINT", () => { if (stop++) process.exit(130); });
+    process.on("SIGINT", async () => { if (stop++) await restoreFirewall(), process.exit(130); });
   }
 
   outer: for (const loc of countries) {
     for (const proto of protocols) {
+      if (paused && !stop) {
+        waiting = true, waitStart = now();
+        await new Promise((r) => (resume = r));
+        waiting = false, idle += now() - waitStart;
+      }
       if (stop) break outer;
       current = `${flag(loc)} ${countryName(loc)} ${dim("·")} ${proto}`;
       attemptStart = now();
@@ -698,6 +726,7 @@ async function scan(countries, protocols, timeout, tty) {
     }
     finishedCountries.push(loc); // table/failed list refresh per finished country
   }
+  await restoreFirewall();
 
   if (tty) {
     clearInterval(timer);
@@ -767,6 +796,7 @@ Options:
   -t, --timeout SEC     seconds to wait for each connection (default: 20)
   -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)
   -v, --version         show the installed version (and whether a newer one is out)
   -h, --help            show this help
 
@@ -783,6 +813,7 @@ async function main() {
       help: { type: "boolean", short: "h", default: false },
       version: { type: "boolean", short: "v", default: false },
       "no-speed": { type: "boolean", short: "n", default: false },
+      firewall: { type: "boolean", short: "f", default: false },
     },
   });
   if (a.help) return console.log(HELP);
@@ -810,13 +841,14 @@ async function main() {
     const saved = loadConfig();
     if (protocols && saved) saved.protocols = protocols.filter((p) => PROTOCOLS.includes(p));
     speedTest = !a["no-speed"] && (saved?.speed ?? false); // first run: connect-only
+    firewall = a.firewall || (saved?.firewall ?? false);
     const choice = await pick(saved, timeout);
     if (!choice) return;
     countries = choice.countries;
     protocols = protocols ?? choice.protocols;
   }
   protocols ??= PROTOCOLS;
-  if (a.countries) speedTest = !a["no-speed"];
+  if (a.countries) speedTest = !a["no-speed"], firewall = a.firewall;
 
   const results = await scan(countries, protocols, timeout, tty);
   if (stop) console.log(yellow("interrupted, showing partial results"));
@@ -825,8 +857,9 @@ async function main() {
   if (update) console.error("\n" + yellow(updateNotice()));
 }
 
-main().catch((e) => {
+main().catch(async (e) => {
   leaveScreen();
   console.error(`windscout: ${e.message}`);
+  await restoreFirewall().catch(() => console.error(`the firewall may still be on: run '${CLI} firewall off'`));
   process.exit(1);
 });