@torrent-tv/proxy 2.69.2 → 2.71.0

package/test/read-window.test.js

@@ -62,11 +62,13 @@ async function recordingTorrent({ pieceCount, present = () => true }) {
     bitfield: { get: (index) => present(index) },
     files: [{ offset: 0, length: totalLength, name: "file.bin" }],
     _critical: [],
+    _selections: { _items: [] },
     calls,
     held,
     _select(from, to, _priority, _notify, isStreamSelection) {
       calls.push({ call: "select", from, to, stream: isStreamSelection === true });
       held.push(`${from}-${to}`);
+      this._selections._items.push({ from, to });
     },
     _deselect(from, to, isStreamSelection) {
       calls.push({ call: "deselect", from, to, stream: isStreamSelection === true });
@@ -74,6 +76,10 @@ async function recordingTorrent({ pieceCount, present = () => true }) {
       if (at >= 0) {
         held.splice(at, 1);
       }
+      const item = this._selections._items.findIndex((one) => one.from === from && one.to === to);
+      if (item >= 0) {
+        this._selections._items.splice(item, 1);
+      }
     },
     critical(from, to) {
       calls.push({ call: "critical", from, to });
@@ -181,7 +187,7 @@ test("an abandoned read leaves nothing selected", async () => {
   }
 });
 
-test("two readers add up, and one leaving takes only its own window", async () => {
+test("two readers add up, and one leaving takes only its own", async () => {
   const { torrent, store, directory } = await recordingTorrent({ pieceCount: 8000 });
   try {
     const head = readFragments({
@@ -195,18 +201,24 @@ test("two readers add up, and one leaving takes only its own window", async () =
     (await head.next()).value.release();
     (await tail.next()).value.release();
 
-    assert.equal(torrent.held.length, 2, "the two readers did not both hold a window");
-    const [headWindow, tailWindow] = torrent.held;
+    // Not a count: each reader states several bands by level, and two readers
+    // wanting the same pieces are one instruction. What matters is that both
+    // are represented and that leaving removes only what leaving should.
+    const pieceOf = (range) => Number(range.split("-")[0]);
+    const held = [...torrent.held];
+    assert.ok(held.some((range) => pieceOf(range) < 4000), "the head reader holds nothing");
+    assert.ok(held.some((range) => pieceOf(range) >= 4000), "the tail reader holds nothing");
 
     await tail.return();
-    assert.deepEqual(
-      torrent.held,
-      [headWindow],
-      `leaving reader took the wrong window (expected to remove ${tailWindow})`
+    const after = [...torrent.held];
+    assert.ok(
+      after.some((range) => pieceOf(range) < 4000),
+      "the head reader's window went with the tail reader"
     );
+    assert.ok(after.length < held.length, "the tail reader took nothing away when it left");
 
     await head.return();
-    assert.deepEqual(torrent.held, []);
+    assert.deepEqual(torrent.held, [], "the last reader left something behind");
   } finally {
     store.destroy(() => undefined);
     await fs.rm(directory, { recursive: true, force: true });

package/test/swarm-selection.test.js

@@ -0,0 +1,191 @@
+/**
+ * @file The one place that speaks to WebTorrent.
+ *
+ * Driven against a stub torrent shaped like the vendored 2.8.5: a selection
+ * list it can be asked about, a bitfield saying what has arrived, and the
+ * private `_select`/`_deselect` the real one exposes.
+ */
+
+import test from "node:test";
+import assert from "node:assert/strict";
+
+import { DemandRegister } from "../services/demand/DemandRegister.js";
+import { Urgency } from "../services/demand/Urgency.js";
+import { SwarmSelection } from "../services/download/SwarmSelection.js";
+
+const PIECE = 1024;
+
+/**
+ * @param {object} [params]
+ * @param {number[]} [params.have] - Pieces that have arrived.
+ * @param {number} [params.files] - How many files, each ten pieces long.
+ * @returns {object}
+ */
+function stubTorrent({ have = [], files = 1 } = {}) {
+  const arrived = new Set(have);
+  const items = [];
+  return {
+    pieceLength: PIECE,
+    files: Array.from({ length: files }, (unused, index) => ({
+      offset: index * 10 * PIECE,
+      length: 10 * PIECE
+    })),
+    bitfield: { get: (index) => arrived.has(index) },
+    _critical: [],
+    _selections: { _items: items },
+    calls: { select: [], deselect: [], critical: [] },
+    _select(from, to, priority, notify, isStream) {
+      this.calls.select.push({ from, to, priority, isStream });
+      items.push({ from, to, priority });
+    },
+    _deselect(from, to) {
+      this.calls.deselect.push({ from, to });
+      const at = items.findIndex((item) => item.from === from && item.to === to);
+      if (at >= 0) {
+        items.splice(at, 1);
+      }
+    },
+    critical(from, to) {
+      this.calls.critical.push({ from, to });
+      for (let index = from; index <= to; index += 1) {
+        this._critical[index] = true;
+      }
+    },
+    /** Pretend the library dropped a satisfied selection, which it does. */
+    forget(from, to) {
+      const at = items.findIndex((item) => item.from === from && item.to === to);
+      if (at >= 0) {
+        items.splice(at, 1);
+      }
+    }
+  };
+}
+
+test("nothing is asked of the swarm until somebody states a need", () => {
+  const torrent = stubTorrent();
+  const selection = new SwarmSelection({ torrent, register: new DemandRegister() });
+
+  assert.deepEqual(selection.reconcile(), { stated: 0, withdrawn: 0 });
+  assert.equal(torrent.calls.select.length, 0);
+});
+
+test("two viewers of one film are two instructions, and both are urgent", () => {
+  const torrent = stubTorrent();
+  const register = new DemandRegister();
+  const selection = new SwarmSelection({ torrent, register });
+
+  // One stopped at the start, one stopped further in. Both pictures are still.
+  register.state({ claimant: "v1", fileIndex: 0, byteStart: 0, byteEnd: PIECE - 1, urgency: Urgency.BLOCKED });
+  register.state({ claimant: "v2", fileIndex: 0, byteStart: 5 * PIECE, byteEnd: 6 * PIECE - 1, urgency: Urgency.BLOCKED });
+  selection.reconcile();
+
+  assert.deepEqual(torrent.calls.select, [
+    { from: 0, to: 0, priority: 1, isStream: true },
+    { from: 5, to: 5, priority: 1, isStream: true }
+  ]);
+  // Both may take a block from a slow peer, and the mark spans both.
+  assert.deepEqual(torrent.calls.critical, [{ from: 0, to: 5 }]);
+});
+
+test("the same pieces wanted by two claimants are one instruction", () => {
+  const torrent = stubTorrent();
+  const register = new DemandRegister();
+  const selection = new SwarmSelection({ torrent, register });
+
+  // Picture and sound of one viewer read the same file and overlap.
+  register.state({ claimant: "video", fileIndex: 0, byteStart: 0, byteEnd: PIECE - 1, urgency: Urgency.NEAR });
+  register.state({ claimant: "audio", fileIndex: 0, byteStart: 0, byteEnd: PIECE - 1, urgency: Urgency.NEAR });
+  const first = selection.reconcile();
+
+  assert.equal(first.stated, 1, "one range, told once");
+  assert.equal(torrent.calls.select.length, 1);
+});
+
+test("the speculative levels are withdrawn whole the moment something urgent is missing", () => {
+  const torrent = stubTorrent({ have: [0] });
+  const register = new DemandRegister();
+  const selection = new SwarmSelection({ torrent, register });
+
+  register.state({ claimant: "video", fileIndex: 0, byteStart: 0, byteEnd: PIECE - 1, urgency: Urgency.NEAR });
+  register.state({ claimant: "fill", fileIndex: 0, byteStart: 5 * PIECE, byteEnd: 9 * PIECE - 1, urgency: Urgency.TAIL });
+  selection.reconcile();
+
+  assert.equal(selection.statedRanges().length, 2, "nothing urgent is missing, so the tail is stated");
+  assert.ok(torrent.calls.select.some((call) => call.priority === 0), "and it is stated as zero");
+
+  // The viewer moves on to a piece that has not arrived.
+  register.state({ claimant: "video", fileIndex: 0, byteStart: PIECE, byteEnd: 2 * PIECE - 1, urgency: Urgency.NEAR });
+  selection.reconcile();
+
+  assert.deepEqual(
+    selection.statedRanges().map((range) => range.priority),
+    [1],
+    "the tail is out of the download set entirely, not lowered — a peer with nothing urgent to give must not be able to fall through to it"
+  );
+  assert.ok(torrent.calls.deselect.length > 0);
+});
+
+test("a selection the library drops once satisfied is stated again", () => {
+  const torrent = stubTorrent();
+  const register = new DemandRegister();
+  const selection = new SwarmSelection({ torrent, register });
+
+  register.state({ claimant: "video", fileIndex: 0, byteStart: 0, byteEnd: PIECE - 1, urgency: Urgency.NEAR });
+  selection.reconcile();
+  assert.equal(torrent.calls.select.length, 1);
+
+  // Nothing changed: no second instruction.
+  selection.reconcile();
+  assert.equal(torrent.calls.select.length, 1);
+
+  // WebTorrent removes a selection once every piece in it has arrived, and says
+  // nothing about having done so. The window is still wanted.
+  torrent.forget(0, 0);
+  selection.reconcile();
+  assert.equal(torrent.calls.select.length, 2, "stated again, because the library had let it go");
+});
+
+test("a claimant that withdraws takes its instruction with it", () => {
+  const torrent = stubTorrent();
+  const register = new DemandRegister();
+  const selection = new SwarmSelection({ torrent, register });
+
+  register.state({ claimant: "video", fileIndex: 0, byteStart: 0, byteEnd: PIECE - 1, urgency: Urgency.BLOCKED });
+  selection.reconcile();
+  register.withdraw("video");
+  const after = selection.reconcile();
+
+  assert.equal(after.withdrawn, 1);
+  assert.equal(selection.statedRanges().length, 0);
+  // And the displacement mark goes with it: WebTorrent never clears it itself,
+  // so a reader walking a film would leave every piece of it marked.
+  assert.equal(torrent._critical.some((marked) => marked === true), false);
+});
+
+test("a window is bounded by its own file, so it cannot claim the next one", () => {
+  const torrent = stubTorrent({ files: 3 });
+  const register = new DemandRegister();
+  const selection = new SwarmSelection({ torrent, register });
+
+  // Asking past the end of file 1. File 1 occupies pieces 10-19.
+  register.state({
+    claimant: "video", fileIndex: 1, byteStart: 0, byteEnd: 100 * PIECE, urgency: Urgency.NEAR
+  });
+  selection.reconcile();
+
+  assert.deepEqual(torrent.calls.select, [{ from: 10, to: 19, priority: 1, isStream: true }]);
+});
+
+test("releasing everything leaves the library holding nothing of ours", () => {
+  const torrent = stubTorrent();
+  const register = new DemandRegister();
+  const selection = new SwarmSelection({ torrent, register });
+
+  register.state({ claimant: "video", fileIndex: 0, byteStart: 0, byteEnd: 3 * PIECE, urgency: Urgency.BLOCKED });
+  selection.reconcile();
+  selection.releaseAll();
+
+  assert.equal(torrent._selections._items.length, 0);
+  assert.equal(selection.statedRanges().length, 0);
+  assert.equal(torrent._critical.some((marked) => marked === true), false);
+});

package/utils/logger.js

@@ -38,6 +38,40 @@ let fileStream = null;
 /** @type {string} */
 let filePath = "";
 let writtenBytes = 0;
+/**
+ * Where lines go when this module is running in a worker thread.
+ *
+ * A worker thread is a separate instance of the runtime: it loads its own copy
+ * of every module, so `fileStream` above is a DIFFERENT variable there, and
+ * `logToFile` is only ever called on the main thread. The result was silent:
+ * measured 2026-09-02 over a whole log file of 49 938 lines, every line the
+ * torrent thread wrote through this module — the piece reader's, including the
+ * comparison of the two claim strategies that had been awaited for weeks, and
+ * the torrent pool's — was absent, while the same lines were visible in the
+ * container's output, which is destroyed by every release.
+ *
+ * Two threads cannot both write the file: they would race on the rotation and
+ * could interleave mid-line. So there is one writer, and a worker sends its
+ * lines to it. Set by the worker at startup; unset on the main thread, where
+ * the file is written directly.
+ *
+ * @type {((level: string, message: string) => void) | null}
+ */
+let forward = null;
+
+/**
+ * Send this thread's log lines to the thread that owns the file.
+ *
+ * Called by a worker at startup. Until it is, a worker's lines reach the
+ * console and nothing else — which is what they did for as long as this module
+ * has existed.
+ *
+ * @param {((level: string, message: string) => void) | null} sink
+ * @returns {void}
+ */
+export function forwardLogsTo(sink) {
+  forward = typeof sink === "function" ? sink : null;
+}
 
 /**
  * Return the current time as a compact ISO-8601 (UTC) string, e.g.
@@ -119,24 +153,32 @@ function toFile(line) {
  * @type {ProxyLogger}
  */
 export const logger = {
-  info: (message) => {
-    const line = `${PREFIX} [${ts()}] ${message}`;
-    console.log(chalk.cyan(line));
-    toFile(line);
-  },
-  success: (message) => {
-    const line = `${PREFIX} [${ts()}] ${message}`;
-    console.log(chalk.green(line));
-    toFile(line);
-  },
-  warn: (message) => {
-    const line = `${PREFIX} [${ts()}] ${message}`;
-    console.warn(chalk.yellow(line));
-    toFile(line);
-  },
-  error: (message) => {
-    const line = `${PREFIX} [${ts()}] ${message}`;
-    console.error(chalk.red(line));
-    toFile(line);
-  }
+  info: (message) => write("info", message, chalk.cyan, console.log),
+  success: (message) => write("success", message, chalk.green, console.log),
+  warn: (message) => write("warn", message, chalk.yellow, console.warn),
+  error: (message) => write("error", message, chalk.red, console.error)
 };
+
+/**
+ * One path for every level, so a line cannot reach the console and miss the
+ * file depending on which method was called or which thread called it.
+ *
+ * @param {string} level
+ * @param {string} message
+ * @param {(text: string) => string} colour
+ * @param {(text: string) => void} toConsole
+ * @returns {void}
+ */
+function write(level, message, colour, toConsole) {
+  toConsole(colour(`${PREFIX} [${ts()}] ${message}`));
+  if (forward) {
+    try {
+      forward(level, message);
+    } catch {
+      // silent-ok: a thread whose channel has closed is shutting down, and a
+      // failed log line must not be what ends it.
+    }
+    return;
+  }
+  toFile(`${PREFIX} [${ts()}] ${message}`);
+}