@torrent-tv/proxy 2.82.0 → 2.83.0

package/services/torrent-pool.js

@@ -8,6 +8,7 @@
  * download.
  */
 
+import { IDLE_KEEP_MS } from "./disk/keep.js";
 import dns from "node:dns/promises";
 import os from "node:os";
 import path from "node:path";
@@ -61,13 +62,13 @@ const DHT_RESOLVE_TIMEOUT_MS = 2000;
 // torrent data lives under here.
 const WEBTORRENT_STORE_ROOT = path.join(os.tmpdir(), "webtorrent");
 
-// How long a torrent may sit with zero active file readers before it is
-// removed (with its on-disk store). Generous so brief gaps between ffmpeg
-// range reads — a pause, a backgrounded tab, or a phone turned off for a few
-// minutes — do not evict an in-use torrent's already-downloaded data, so a
-// resume plays from disk instead of re-downloading. A longer idle (viewer truly
-// gone) frees the disk; the global disk cap still evicts earlier under pressure.
-const TORRENT_IDLE_TTL_MS = 15 * 60 * 1000;
+// How long a torrent may sit with zero active file readers before it is removed
+// with its on-disk store. ONE NUMBER for everything nobody is using, shared with
+// the produced segments — see `services/disk/keep.js` for why it is one and what
+// it stands for. It was fifteen minutes here against thirty for the session it
+// feeds, so a viewer returning at the twentieth minute got a session whose source
+// had gone.
+const TORRENT_IDLE_TTL_MS = IDLE_KEEP_MS;
 
 // Bytes ahead of a read position to mark CRITICAL on each range request. In
 // WebTorrent, `critical` does NOT reorder the sequential piece scan — it enables

package/test/keeping-period.test.js

@@ -0,0 +1,83 @@
+/**
+ * @file How long material nobody is using is kept, and where that number comes
+ * from.
+ *
+ * It was three numbers and they contradicted each other: a torrent went at
+ * fifteen minutes while the session it feeds lived to thirty, so between them
+ * there was a session with no source. All three stand for one unmeasured thing
+ * — whether the viewer comes back — so they are one number now, and the thing
+ * they stand for is being measured.
+ */
+
+import test from "node:test";
+import assert from "node:assert/strict";
+import { IDLE_KEEP_MS } from "../services/disk/keep.js";
+import { Returns } from "../services/disk/returns.js";
+
+const MINUTE = 60 * 1000;
+
+test("material outlives the session that reads it", () => {
+  // The contradiction this replaced, stated as the rule it must never break
+  // again: whatever holds a source must not go while something that reads it
+  // is still alive. The session's own period is thirty minutes.
+  const SESSION_TTL_MS = 30 * MINUTE;
+  assert.ok(
+    IDLE_KEEP_MS > SESSION_TTL_MS,
+    "a session would outlive its own source again: material is kept " +
+      `${IDLE_KEEP_MS / MINUTE}min against a session's ${SESSION_TTL_MS / MINUTE}min`
+  );
+});
+
+test("one number, and both kinds of material read it", async () => {
+  // Two guesses about one unknown is what produced the contradiction. Asserted
+  // on the source: a second literal period appearing anywhere is the fault
+  // coming back.
+  const { readFileSync } = await import("node:fs");
+  const path = await import("node:path");
+  const { fileURLToPath } = await import("node:url");
+  const here = path.dirname(fileURLToPath(import.meta.url));
+  const read = (relative) => readFileSync(path.join(here, "..", relative), "utf8");
+
+  assert.match(read("services/torrent-pool.js"), /TORRENT_IDLE_TTL_MS = IDLE_KEEP_MS/);
+  assert.match(read("services/hls-session-manager.js"), /SEGMENT_STORE_IDLE_MS = IDLE_KEEP_MS/);
+});
+
+test("a session opened on material still held is a return, and its age is kept", () => {
+  const returns = new Returns();
+  const now = 10 * 60 * MINUTE;
+
+  returns.note({ lastReadAt: now - 5 * MINUTE, now });
+  returns.note({ lastReadAt: now - 45 * MINUTE, now });
+  returns.note({ lastReadAt: now - 20 * MINUTE, now });
+
+  const shape = returns.shape();
+  assert.equal(shape.warm, 3);
+  assert.equal(shape.cold, 0);
+  assert.equal(shape.medianMs, 20 * MINUTE, "the middle return is not the median");
+  assert.equal(shape.longestMs, 45 * MINUTE);
+});
+
+test("a session opened on material this proxy never had is not a return", () => {
+  const returns = new Returns();
+  const now = 10 * 60 * MINUTE;
+
+  returns.note({ lastReadAt: null, now });
+  returns.note({ lastReadAt: 0, now });
+
+  assert.equal(returns.shape(), null, "an opening with nothing behind it was counted as a return");
+});
+
+test("the reading says what viewers do beside what is being kept", () => {
+  const returns = new Returns();
+  const now = 10 * 60 * MINUTE;
+  assert.equal(returns.describe(IDLE_KEEP_MS), null, "it spoke before it had anything to say");
+
+  returns.note({ lastReadAt: now - 12 * MINUTE, now });
+  returns.note({ lastReadAt: null, now });
+
+  const line = returns.describe(IDLE_KEEP_MS);
+  assert.match(line, /1 session\(s\) opened on material still held/);
+  assert.match(line, /1 on material gone/);
+  assert.match(line, /median 12min after the last read/);
+  assert.match(line, /kept for 60min/);
+});

package/test/piece-disk-store.test.js

@@ -265,3 +265,91 @@ test("the spill ceiling is what the disk's owner said, divided between the store
     await fs.rm(directory, { recursive: true, force: true, maxRetries: 10, retryDelay: 20 });
   }
 });
+
+test("what lies behind every reader goes without waiting for the disk to be short", async () => {
+  // THE SECOND RULE. The ceiling is a share of free space, and on a roomy host
+  // that is tens of gigabytes against a measured growth of 14 400 MB in one
+  // viewing — so the ceiling alone never binds and nothing is removed until the
+  // torrent itself goes. A piece behind every read head has been read.
+  const { store, directory } = await makeStore(1000 * PIECE);
+  try {
+    for (const index of [0, 1, 2, 3, 4, 5]) {
+      await store.write(index, pieceOf(index));
+    }
+
+    const removed = store.forgetBehind([3, 4]);
+    await store.settled();
+
+    assert.equal(removed, 3, "the three behind the earliest reader should have gone");
+    assert.deepEqual([0, 1, 2].map((index) => store.has(index)), [false, false, false]);
+    assert.deepEqual([3, 4, 5].map((index) => store.has(index)), [true, true, true]);
+    assert.equal(store.stats().behind, 3);
+  } finally {
+    await store.destroy();
+    await fs.rm(directory, { recursive: true, force: true, maxRetries: 10, retryDelay: 20 });
+  }
+});
+
+test("with no reader at all, nothing is thrown away", async () => {
+  // A store between reads is not a store nobody wants. What empties it whole is
+  // the torrent going idle, which removes the store and its directory.
+  const { store, directory } = await makeStore(1000 * PIECE);
+  try {
+    for (const index of [0, 1, 2]) {
+      await store.write(index, pieceOf(index));
+    }
+    assert.equal(store.forgetBehind([]), 0);
+    assert.equal(store.size, 3);
+  } finally {
+    await store.destroy();
+    await fs.rm(directory, { recursive: true, force: true, maxRetries: 10, retryDelay: 20 });
+  }
+});
+
+test("a piece being read is not taken even when it is behind everybody", async () => {
+  const { store, directory } = await makeStore(1000 * PIECE);
+  try {
+    await store.write(0, pieceOf(0));
+    await store.write(5, pieceOf(5));
+    const reading = store.read(0, Buffer.alloc(PIECE));
+    const removed = store.forgetBehind([5]);
+    await reading;
+    await store.settled();
+
+    assert.equal(removed, 0, "a piece under a reader was thrown away");
+    assert.equal(store.has(0), true);
+  } finally {
+    await store.destroy();
+    await fs.rm(directory, { recursive: true, force: true, maxRetries: 10, retryDelay: 20 });
+  }
+});
+
+test("when there is no room, what is behind the readers goes before what is ahead", async () => {
+  const directory = await fs.mkdtemp(path.join(os.tmpdir(), "piece-disk-heads-"));
+  const clock = { at: 1000 };
+  // The reader stands on #5. #4 is behind it and was touched LAST, so under the
+  // old rule — least recently used — it would have been the safest piece there.
+  const store = new PieceDiskStore({
+    directory,
+    name: "pieces",
+    chunkLength: PIECE,
+    allowanceBytes: 3 * PIECE,
+    now: () => clock.at,
+    readHeads: () => [5]
+  });
+  try {
+    for (const index of [8, 7, 4]) {
+      clock.at += 100;
+      await store.write(index, pieceOf(index));
+    }
+    clock.at += 100;
+    await store.write(9, pieceOf(9));
+    await store.settled();
+
+    assert.equal(store.has(4), false, "the piece behind the reader was kept because it was touched last");
+    assert.deepEqual([7, 8, 9].map((index) => store.has(index)), [true, true, true]);
+  } finally {
+    await store.destroy();
+    await fs.rm(directory, { recursive: true, force: true, maxRetries: 10, retryDelay: 20 });
+  }
+});