@torrent-tv/proxy 2.89.6 → 2.89.8

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (92) hide show
  1. package/AGENTS.md +32 -12
  2. package/CHANGELOG.md +2340 -2330
  3. package/assets/calibration/audio/NOTICE.md +19 -19
  4. package/assets/calibration/audio/manifest.json +98 -98
  5. package/biome.json +412 -412
  6. package/docs/browser-proxy-contract.md +155 -155
  7. package/docs/container-architecture.md +273 -273
  8. package/docs/encode-run-state.md +1 -1
  9. package/docs/playback-start-forecast.md +113 -98
  10. package/package.json +51 -50
  11. package/routes/api/sources/files/get.js +106 -106
  12. package/scripts/build-audio-samples.mjs +31 -31
  13. package/services/encode/EncodeRun.js +67 -15
  14. package/services/encode/EncodeRuns.js +19 -7
  15. package/services/encode/OutputOpening.js +784 -784
  16. package/services/encode/audio-calibration.js +67 -67
  17. package/services/encode/audio-work-rate.js +15 -15
  18. package/services/encode/encode-exit.js +2 -0
  19. package/services/encode/hwaccel.js +1894 -1894
  20. package/services/encode/output/index.js +24 -24
  21. package/services/encode/piece-completeness.js +60 -2
  22. package/services/encode/run-command.js +757 -755
  23. package/services/encode/segment-formats/index.js +1 -0
  24. package/services/encode/segment-formats/mp4-boxes.js +8 -1
  25. package/services/media/ContainerOrchestrator.js +202 -202
  26. package/services/media/KeyframeTables.js +356 -356
  27. package/services/media/SubtitleCues.js +592 -592
  28. package/services/media/audio-inventory.js +299 -299
  29. package/services/media/container/AviContainer.js +268 -268
  30. package/services/media/container/Container.js +632 -632
  31. package/services/media/container/ContainerFactory.js +38 -38
  32. package/services/media/container/MatroskaContainer.js +1031 -1031
  33. package/services/media/container/Mp4Container.js +1354 -1354
  34. package/services/media/container/SubtitleFileContainer.js +339 -339
  35. package/services/media/container/ebml-stream.js +174 -174
  36. package/services/media/container/matroska-clusters.js +1165 -1165
  37. package/services/media/container/unavailable.js +77 -77
  38. package/services/media/tracks/ContainerTrack.js +84 -84
  39. package/services/media/tracks/TextSubtitleTrack.js +295 -295
  40. package/services/storage/piece-store/shared-piece-store.js +1937 -1937
  41. package/services/storage/segment-store/SegmentStore.js +1294 -1294
  42. package/services/torrent/Contents.js +382 -382
  43. package/services/torrent/episode-naming.js +182 -182
  44. package/services/torrent/torrent-pool.js +2688 -2688
  45. package/services/torrent/worker/client.js +836 -836
  46. package/services/torrent/worker/held-bytes.js +231 -231
  47. package/services/torrent/worker/worker.js +1137 -1137
  48. package/services/transport/data-channel-handler.js +1373 -1373
  49. package/services/viewer/PriorityMap.js +421 -421
  50. package/test/audio-calibration.test.js +23 -23
  51. package/test/auto-quality-step.test.js +762 -762
  52. package/test/coalesce.test.js +39 -39
  53. package/test/coverage-follows-the-disk.test.js +5 -0
  54. package/test/decode-cost.test.js +475 -475
  55. package/test/encode-run.test.js +58 -0
  56. package/test/episode-naming.test.js +131 -131
  57. package/test/failed-encoder-still-serves-what-exists.test.js +1 -1
  58. package/test/fixtures/audio-frame-boundary.json +1 -1
  59. package/test/fixtures/refused-audio-20261002.json +10 -0
  60. package/test/fmp4-presentation-clock.test.js +4 -2
  61. package/test/format-keyed-outputs.test.js +78 -78
  62. package/test/health-metrics.test.js +11 -13
  63. package/test/held-read-ownership.test.js +77 -77
  64. package/test/helpers/encode-run.js +14 -6
  65. package/test/helpers/held-file.js +77 -77
  66. package/test/helpers/manager.js +62 -62
  67. package/test/helpers/matroska-file.js +296 -296
  68. package/test/keyframe-table-budget.test.js +123 -123
  69. package/test/matroska-cluster-discovery.test.js +323 -323
  70. package/test/one-output-one-session.test.js +273 -273
  71. package/test/output-speed.test.js +6 -1
  72. package/test/piece-completeness.test.js +37 -1
  73. package/test/quality-variants.test.js +1274 -1270
  74. package/test/rate-control-in-the-output.test.js +4 -3
  75. package/test/reads-not-yet-arrived.test.js +218 -218
  76. package/test/seek-frees-the-viewers-requests.test.js +1 -1
  77. package/test/segment-closed-on-both-branches.test.js +114 -114
  78. package/test/segment-judged-by-its-own-header.test.js +222 -222
  79. package/test/segment-serve-wiring.test.js +481 -481
  80. package/test/serving-existing-output.test.js +111 -111
  81. package/test/source-files-route.test.js +113 -113
  82. package/test/subtitle-cue-walk.test.js +385 -385
  83. package/test/subtitle-metadata.test.js +15 -15
  84. package/test/subtitle-plan-waits.test.js +125 -125
  85. package/test/subtitle-track-numbering.test.js +391 -391
  86. package/test/two-viewers-one-picture.test.js +508 -508
  87. package/test/viewer-requests-admission.test.js +92 -92
  88. package/test/viewer-starts-on-map.test.js +27 -27
  89. package/test/viewer-states.test.js +5 -2
  90. package/test/viewing-generations.test.js +390 -390
  91. package/test/whole-file-held-read.test.js +30 -30
  92. package/utils/coalesce.js +41 -41
@@ -1,390 +1,390 @@
1
- /**
2
- * @file A viewer's own viewings, and what each request made in one of them
3
- * holds — roadmap item 97, step 9.
4
- *
5
- * The property under all of it: a seek of ONE viewer decides nothing about
6
- * another viewer's requests, a request made for a viewing its viewer has left
7
- * is refused before it can cause anything, and an output is not taken away
8
- * while a response is still being sent from it or a request made against it
9
- * may still be repeated.
10
- *
11
- * Nothing here starts a torrent, a worker or ffmpeg: the routes, the viewer
12
- * registry and the lifecycle are driven with plain values.
13
- */
14
-
15
- import test from "node:test";
16
- import assert from "node:assert/strict";
17
- import { EventEmitter } from "node:events";
18
- import { handleTranscodeVariantFileGet } from "../routes/transcode/variant-file/get.js";
19
- import { handleTranscodeAudioFileGet } from "../routes/transcode/audio-file/get.js";
20
- import { serveSessionFile, statedGenerationOf } from "../services/server/transcode-session-files.js";
21
- import { Viewers } from "../services/viewer/Viewers.js";
22
- import { ACCEPT_WINDOW_MS } from "../services/viewer/Viewer.js";
23
- import {
24
- acceptsGeneration,
25
- chooseOutput,
26
- generationOfRequest,
27
- givenOutputOf,
28
- holdForResponse,
29
- noteGivenOutput
30
- } from "../services/viewer/choices.js";
31
- import { ViewerRequests } from "../services/server/ViewerRequests.js";
32
- import { OutputLifecycle } from "../services/server/OutputLifecycle.js";
33
- import { fmp4Format } from "../services/encode/segment-formats/fmp4.js";
34
-
35
- const OUTPUT_ID = "1111111122223333";
36
- const OTHER_ID = "4444444455556666";
37
-
38
- /**
39
- * A reply that records what the route answered, with a response underneath
40
- * that can say it finished, closed or failed.
41
- *
42
- * @returns {{ reply: object, sent: { code: number, headers: Record<string, string>, body: unknown } }}
43
- */
44
- function recordingReply() {
45
- const sent = { code: 200, headers: {}, body: undefined };
46
- const raw = Object.assign(new EventEmitter(), { destroyed: false, writableEnded: false });
47
- const reply = {
48
- raw,
49
- code(value) {
50
- sent.code = value;
51
- return reply;
52
- },
53
- header(name, value) {
54
- sent.headers[name.toLowerCase()] = String(value);
55
- return reply;
56
- },
57
- send(body) {
58
- sent.body = body;
59
- return reply;
60
- }
61
- };
62
- return { reply, sent };
63
- }
64
-
65
- /**
66
- * @param {Record<string, string>} params
67
- * @param {Record<string, string>} query
68
- * @returns {object}
69
- */
70
- function requestOf(params, query) {
71
- return { params, query, headers: {}, raw: { on() {}, off() {} } };
72
- }
73
-
74
- test("a request for a viewing that was left is refused before the step is resolved", async () => {
75
- const resolved = [];
76
- const renditions = {
77
- resolveVariantFile: async (...args) => {
78
- resolved.push(args);
79
- return { sessionId: null };
80
- }
81
- };
82
- const viewerRequests = { acceptsRequest: (_consumerId, generation) => generation !== 3 };
83
-
84
- const stale = recordingReply();
85
- await handleTranscodeVariantFileGet(
86
- requestOf({ sessionId: OUTPUT_ID, height: "720", fileName: "segment-00005.mp4" }, { consumer: "viewer-a", generation: "3" }),
87
- stale.reply,
88
- { renditions, serving: {}, viewerRequests }
89
- );
90
- assert.equal(resolved.length, 0, "resolving could make a step and register the viewer on it");
91
- assert.equal(stale.sent.code, 503);
92
- assert.equal(stale.sent.headers["retry-after"], "0");
93
-
94
- const current = recordingReply();
95
- await handleTranscodeVariantFileGet(
96
- requestOf({ sessionId: OUTPUT_ID, height: "720", fileName: "segment-00005.mp4" }, { consumer: "viewer-a", generation: "4" }),
97
- current.reply,
98
- { renditions, serving: {}, viewerRequests }
99
- );
100
- assert.equal(resolved.length, 1, "a request of the current viewing is resolved");
101
- assert.equal(resolved[0][4], 4, "and it is handed the generation it carried");
102
- });
103
-
104
- test("a request for a soundtrack of a viewing that was left is refused before it is resolved", async () => {
105
- const resolved = [];
106
- const renditions = {
107
- resolveAudioRenditionFile: async (...args) => {
108
- resolved.push(args);
109
- return { sessionId: null };
110
- }
111
- };
112
- const viewerRequests = { acceptsRequest: () => false };
113
- const { reply, sent } = recordingReply();
114
-
115
- await handleTranscodeAudioFileGet(
116
- requestOf({ sessionId: OUTPUT_ID, trackIndex: "1", fileName: "segment-00005.mp4" }, { consumer: "viewer-a", generation: "0" }),
117
- reply,
118
- { renditions, serving: {}, viewerRequests }
119
- );
120
-
121
- assert.equal(resolved.length, 0);
122
- assert.equal(sent.code, 503);
123
- });
124
-
125
- test("only a stated non-negative integer is a generation", () => {
126
- assert.equal(statedGenerationOf({ query: { generation: "7" } }), 7);
127
- assert.ok(Number.isNaN(statedGenerationOf({ query: {} })), "nothing stated");
128
- assert.ok(Number.isNaN(statedGenerationOf({ query: { generation: "-1" } })));
129
- assert.ok(Number.isNaN(statedGenerationOf({ query: { generation: "2.5" } })));
130
- assert.ok(Number.isNaN(statedGenerationOf({ query: { generation: "abc" } })));
131
- });
132
-
133
- test("one viewer's seek does not touch another viewer's assignments on a shared output", () => {
134
- const viewers = new Viewers();
135
- const shared = { id: OUTPUT_ID, outputKey: "key-shared" };
136
- viewers.of(shared, "viewer-a");
137
- viewers.of(shared, "viewer-b");
138
- noteGivenOutput(viewers, "viewer-a", 0, 720, 5, "key-shared");
139
- noteGivenOutput(viewers, "viewer-b", 0, 720, 5, "key-shared");
140
- const seekedAt = Date.now();
141
-
142
- viewers.get("viewer-a").assignments.statedGeneration(1, seekedAt);
143
-
144
- const longAfter = seekedAt + ACCEPT_WINDOW_MS + 1;
145
- assert.equal(acceptsGeneration(viewers, "viewer-b", 0, longAfter), true, "the other viewer did not seek");
146
- assert.equal(givenOutputOf(viewers, "viewer-b", 0, 720, 5), "key-shared");
147
-
148
- assert.equal(
149
- acceptsGeneration(viewers, "viewer-a", 0, seekedAt + 1_000),
150
- true,
151
- "a request of the viewing just left, arriving late, is still taken within the window"
152
- );
153
- assert.equal(
154
- givenOutputOf(viewers, "viewer-a", 0, 720, 5),
155
- "key-shared",
156
- "and is answered by what answered it, not decided anew"
157
- );
158
- assert.equal(
159
- acceptsGeneration(viewers, "viewer-a", 0, longAfter),
160
- false,
161
- "past the window, a request of the viewing left is refused"
162
- );
163
- });
164
-
165
- test("a request that states no generation belongs to the viewer's current one", () => {
166
- const viewers = new Viewers();
167
- viewers.of({ id: OUTPUT_ID, outputKey: "key" }, "viewer-a");
168
- viewers.get("viewer-a").assignments.statedGeneration(3);
169
-
170
- assert.equal(generationOfRequest(viewers, "viewer-a", Number.NaN), 3);
171
- assert.equal(generationOfRequest(viewers, "viewer-a", 1), 1, "a stated one is kept as stated");
172
- assert.equal(acceptsGeneration(viewers, "nobody", 0), true, "a viewer not known yet takes everything");
173
- });
174
-
175
- test("a response already begun holds its output across a change of viewing, and its release is safe to repeat", async () => {
176
- const viewers = new Viewers();
177
- const output = { id: OUTPUT_ID, outputKey: "key-sent" };
178
- viewers.of({ id: OTHER_ID, outputKey: "key-other" }, "viewer-a");
179
- const serving = {
180
- seekEpoch: () => 0,
181
- getFileStream: async () => ({ kind: "file", contentType: "video/mp4", stream: "bytes", isPlaylist: false })
182
- };
183
- const viewerRequests = {
184
- holdResponse: (_sessionId, consumerId) => holdForResponse(viewers, consumerId, output.outputKey)
185
- };
186
- const { reply, sent } = recordingReply();
187
-
188
- await serveSessionFile(
189
- requestOf({}, { consumer: "viewer-a" }),
190
- reply,
191
- { serving, viewerRequests, sessionId: OUTPUT_ID, fileName: "segment-00005.mp4" }
192
- );
193
- assert.equal(sent.body, "bytes", "the fixture must reach sending");
194
-
195
- viewers.get("viewer-a").assignments.statedGeneration(9, Date.now() - 10 * ACCEPT_WINDOW_MS);
196
- assert.equal(viewers.assignmentsHold(output), true, "the response is still going out");
197
-
198
- reply.raw.emit("finish");
199
- assert.equal(viewers.assignmentsHold(output), false, "finished, it holds nothing");
200
- reply.raw.emit("close");
201
- reply.raw.emit("error", new Error("after the end"));
202
- assert.equal(viewers.assignmentsHold(output), false, "and the events after it change nothing");
203
- });
204
-
205
- test("a response over before it began is released at once", async () => {
206
- const viewers = new Viewers();
207
- const output = { id: OUTPUT_ID, outputKey: "key-sent" };
208
- viewers.of({ id: OTHER_ID, outputKey: "key-other" }, "viewer-a");
209
- const serving = {
210
- seekEpoch: () => 0,
211
- getFileStream: async () => ({ kind: "file", contentType: "video/mp4", stream: "bytes", isPlaylist: false })
212
- };
213
- const viewerRequests = {
214
- holdResponse: (_sessionId, consumerId) => holdForResponse(viewers, consumerId, output.outputKey)
215
- };
216
- const { reply } = recordingReply();
217
- reply.raw.destroyed = true;
218
-
219
- await serveSessionFile(
220
- requestOf({}, { consumer: "viewer-a" }),
221
- reply,
222
- { serving, viewerRequests, sessionId: OUTPUT_ID, fileName: "segment-00005.mp4" }
223
- );
224
-
225
- assert.equal(viewers.assignmentsHold(output), false, "no event of it will fire again to release it");
226
- });
227
-
228
- test("the picture's own route records its answer under the height it is named after", () => {
229
- const viewers = new Viewers();
230
- const picture = {
231
- id: OUTPUT_ID,
232
- outputKey: "key-picture",
233
- spec: { video: {} },
234
- segmentFormat: fmp4Format
235
- };
236
- const soundtrack = {
237
- id: OTHER_ID,
238
- outputKey: "key-sound",
239
- spec: { video: null },
240
- segmentFormat: fmp4Format
241
- };
242
- viewers.of(picture, "viewer-a");
243
- const byId = new Map([[picture.id, picture], [soundtrack.id, soundtrack]]);
244
- const requests = new ViewerRequests({
245
- outputs: { get: (id) => byId.get(id) ?? null, variantHeightOf: () => 1080 },
246
- generationOfRequest: (consumerId, stated) => generationOfRequest(viewers, consumerId, stated),
247
- noteGivenOutput: (...args) => noteGivenOutput(viewers, ...args)
248
- });
249
-
250
- requests.noteAnsweredDirectly(OUTPUT_ID, "viewer-a", 0, "segment-00012.mp4");
251
- requests.noteAnsweredDirectly(OUTPUT_ID, "viewer-a", 0, "init.mp4");
252
- requests.noteAnsweredDirectly(OUTPUT_ID, "viewer-a", 0, "index.m3u8");
253
- requests.noteAnsweredDirectly(OTHER_ID, "viewer-a", 0, "segment-00012.mp4");
254
-
255
- assert.equal(givenOutputOf(viewers, "viewer-a", 0, 1080, 12), "key-picture");
256
- assert.equal(givenOutputOf(viewers, "viewer-a", 0, 1080, -1), "key-picture", "the init is segment -1");
257
- const held = viewers.get("viewer-a").assignments.heldKeys();
258
- assert.equal(held.has("key-sound"), false, "a soundtrack is not a height and records nothing");
259
- assert.deepEqual([...held], ["key-picture"], "and a playlist records nothing either");
260
- });
261
-
262
- /**
263
- * An output lifecycle whose disposals are recorded instead of carried out:
264
- * what is checked is WHETHER it disposes, not how.
265
- *
266
- * @param {{ viewers: Viewers, outputs: object[] }} setup
267
- */
268
- function lifecycleOver({ viewers, outputs }) {
269
- const byId = new Map(outputs.map((output) => [output.id, output]));
270
- const lifecycle = new OutputLifecycle({
271
- viewers,
272
- sessionTtlMs: 0,
273
- outputs: {
274
- get: (id) => byId.get(id) ?? null,
275
- has: (id) => byId.has(id),
276
- touch() {},
277
- familyOf: (output) => [output],
278
- expiredBefore: () => [...byId.keys()],
279
- values: () => byId.values()
280
- },
281
- timelines: { forgetUnused() {} },
282
- sourceFiles: { forgetUnused() {}, get() {} },
283
- keyframeTables: { forgetUnused() {} },
284
- machineBudget: { revise: async () => {}, segmentBytes: () => 0 },
285
- returns: { describe: () => null },
286
- segmentStore: { enforce() {} },
287
- viewerSegmentsOn: () => []
288
- });
289
- const disposed = [];
290
- lifecycle.disposeSession = async (id) => {
291
- disposed.push(id);
292
- byId.delete(id);
293
- };
294
- return { lifecycle, disposed };
295
- }
296
-
297
- test("an output an assignment holds is kept when its last viewer leaves, and by the idle expiry until it lapses", async () => {
298
- const viewers = new Viewers();
299
- const output = { id: OUTPUT_ID, outputKey: "key-held" };
300
- const elsewhere = { id: OTHER_ID, outputKey: "key-elsewhere" };
301
- viewers.of(output, "viewer-a");
302
- // Viewer B moved to another output a moment ago; a request of theirs made
303
- // against this one may still be repeated.
304
- viewers.of(elsewhere, "viewer-b");
305
- noteGivenOutput(viewers, "viewer-b", 0, 720, 5, output.outputKey);
306
- const { lifecycle, disposed } = lifecycleOver({ viewers, outputs: [output] });
307
-
308
- await lifecycle.releaseSessionConsumer(OUTPUT_ID, "viewer-a", "test");
309
- assert.deepEqual(disposed, [], "nobody watches it, but an assignment still holds it");
310
-
311
- await lifecycle.cleanupExpired();
312
- assert.deepEqual(disposed, [], "the idle expiry asks the same assignments");
313
-
314
- viewers.get("viewer-b").assignments.statedGeneration(1, Date.now() - ACCEPT_WINDOW_MS - 1);
315
- await lifecycle.cleanupExpired();
316
- assert.deepEqual(disposed, [OUTPUT_ID], "once the window of that viewing has passed, it goes");
317
- });
318
-
319
- test("the idle expiry does not ask whether anybody is registered — only the assignments", async () => {
320
- // A paused viewer stays registered on what they were watching. Whether that
321
- // should hold an output past the idle period is roadmap item 75's question;
322
- // step 9 must not answer it by accident.
323
- const viewers = new Viewers();
324
- const output = { id: OUTPUT_ID, outputKey: "key-paused" };
325
- viewers.of(output, "viewer-paused");
326
- const { lifecycle, disposed } = lifecycleOver({ viewers, outputs: [output] });
327
-
328
- await lifecycle.cleanupExpired();
329
-
330
- assert.deepEqual(disposed, [OUTPUT_ID]);
331
- });
332
-
333
- test("a response already begun holds its output across a change of choice and the viewer leaving that output", () => {
334
- // Roadmap item 97, step 11: the viewer was given 720p at 2800 and is being
335
- // moved to 1400. The piece of 2800 already going out must finish, and its
336
- // output must not be taken away under it — even once the viewer has left it.
337
- const viewers = new Viewers();
338
- const at2800 = { id: OUTPUT_ID, outputKey: "key-720-2800" };
339
- const at1400 = { id: OTHER_ID, outputKey: "key-720-1400" };
340
- viewers.of(at2800, "viewer-a");
341
- viewers.of(at1400, "viewer-a");
342
- chooseOutput(viewers, "viewer-a", 720, at2800.outputKey);
343
- const release = holdForResponse(viewers, "viewer-a", at2800.outputKey);
344
-
345
- chooseOutput(viewers, "viewer-a", 720, at1400.outputKey);
346
- viewers.leaves(at2800, "viewer-a");
347
-
348
- assert.equal(viewers.forOutput(at2800).size, 0, "nobody is watching it any more");
349
- assert.equal(viewers.stillNeeded(at2800), true, "but the response being sent from it holds it");
350
- release();
351
- assert.equal(viewers.stillNeeded(at2800), false, "and once it is finished, nothing does");
352
- });
353
-
354
- test("the step route answers what the rule decided: unavailable, lost, or the stored piece", async () => {
355
- const viewerRequests = {
356
- acceptsRequest: () => true,
357
- holdResponseForKey: () => () => {}
358
- };
359
- const route = async (resolved, serving = {}) => {
360
- const { reply, sent } = recordingReply();
361
- await handleTranscodeVariantFileGet(
362
- requestOf({ sessionId: OUTPUT_ID, height: "720", fileName: "segment-00005.mp4" }, { consumer: "viewer-a", generation: "0" }),
363
- reply,
364
- { renditions: { resolveVariantFile: async () => resolved }, serving, viewerRequests }
365
- );
366
- return sent;
367
- };
368
-
369
- const unavailable = await route({ sessionId: null, unavailable: { reason: "no limit fits", figures: { verdict: "does not fit" } } });
370
- assert.equal(unavailable.code, 409);
371
- assert.equal(unavailable.body.outcome, "output-unavailable");
372
- assert.equal(unavailable.body.figures.verdict, "does not fit", "the figures travel to the page");
373
-
374
- const lost = await route({ sessionId: null, lost: { reason: "the output that answered it has gone" } });
375
- assert.equal(lost.code, 409);
376
- assert.equal(lost.body.outcome, "assignment-lost", "not a retry: the same request would be answered the same way");
377
-
378
- const stored = await route(
379
- { sessionId: null, recover: { key: "gone-key", likeId: OUTPUT_ID } },
380
- { storedPieceOf: async () => ({ kind: "file", stream: "stored-bytes", contentType: "video/mp4", isPlaylist: false }) }
381
- );
382
- assert.equal(stored.body, "stored-bytes", "the very piece that was given");
383
- assert.equal(stored.headers["content-type"], "video/mp4");
384
-
385
- const vanished = await route(
386
- { sessionId: null, recover: { key: "gone-key", likeId: OUTPUT_ID } },
387
- { storedPieceOf: async () => null }
388
- );
389
- assert.equal(vanished.body.outcome, "assignment-lost", "a stored piece that went meanwhile is a lost address");
390
- });
1
+ /**
2
+ * @file A viewer's own viewings, and what each request made in one of them
3
+ * holds — roadmap item 97, step 9.
4
+ *
5
+ * The property under all of it: a seek of ONE viewer decides nothing about
6
+ * another viewer's requests, a request made for a viewing its viewer has left
7
+ * is refused before it can cause anything, and an output is not taken away
8
+ * while a response is still being sent from it or a request made against it
9
+ * may still be repeated.
10
+ *
11
+ * Nothing here starts a torrent, a worker or ffmpeg: the routes, the viewer
12
+ * registry and the lifecycle are driven with plain values.
13
+ */
14
+
15
+ import test from "node:test";
16
+ import assert from "node:assert/strict";
17
+ import { EventEmitter } from "node:events";
18
+ import { handleTranscodeVariantFileGet } from "../routes/transcode/variant-file/get.js";
19
+ import { handleTranscodeAudioFileGet } from "../routes/transcode/audio-file/get.js";
20
+ import { serveSessionFile, statedGenerationOf } from "../services/server/transcode-session-files.js";
21
+ import { Viewers } from "../services/viewer/Viewers.js";
22
+ import { ACCEPT_WINDOW_MS } from "../services/viewer/Viewer.js";
23
+ import {
24
+ acceptsGeneration,
25
+ chooseOutput,
26
+ generationOfRequest,
27
+ givenOutputOf,
28
+ holdForResponse,
29
+ noteGivenOutput
30
+ } from "../services/viewer/choices.js";
31
+ import { ViewerRequests } from "../services/server/ViewerRequests.js";
32
+ import { OutputLifecycle } from "../services/server/OutputLifecycle.js";
33
+ import { fmp4Format } from "../services/encode/segment-formats/fmp4.js";
34
+
35
+ const OUTPUT_ID = "1111111122223333";
36
+ const OTHER_ID = "4444444455556666";
37
+
38
+ /**
39
+ * A reply that records what the route answered, with a response underneath
40
+ * that can say it finished, closed or failed.
41
+ *
42
+ * @returns {{ reply: object, sent: { code: number, headers: Record<string, string>, body: unknown } }}
43
+ */
44
+ function recordingReply() {
45
+ const sent = { code: 200, headers: {}, body: undefined };
46
+ const raw = Object.assign(new EventEmitter(), { destroyed: false, writableEnded: false });
47
+ const reply = {
48
+ raw,
49
+ code(value) {
50
+ sent.code = value;
51
+ return reply;
52
+ },
53
+ header(name, value) {
54
+ sent.headers[name.toLowerCase()] = String(value);
55
+ return reply;
56
+ },
57
+ send(body) {
58
+ sent.body = body;
59
+ return reply;
60
+ }
61
+ };
62
+ return { reply, sent };
63
+ }
64
+
65
+ /**
66
+ * @param {Record<string, string>} params
67
+ * @param {Record<string, string>} query
68
+ * @returns {object}
69
+ */
70
+ function requestOf(params, query) {
71
+ return { params, query, headers: {}, raw: { on() {}, off() {} } };
72
+ }
73
+
74
+ test("a request for a viewing that was left is refused before the step is resolved", async () => {
75
+ const resolved = [];
76
+ const renditions = {
77
+ resolveVariantFile: async (...args) => {
78
+ resolved.push(args);
79
+ return { sessionId: null };
80
+ }
81
+ };
82
+ const viewerRequests = { acceptsRequest: (_consumerId, generation) => generation !== 3 };
83
+
84
+ const stale = recordingReply();
85
+ await handleTranscodeVariantFileGet(
86
+ requestOf({ sessionId: OUTPUT_ID, height: "720", fileName: "segment-00005.mp4" }, { consumer: "viewer-a", generation: "3" }),
87
+ stale.reply,
88
+ { renditions, serving: {}, viewerRequests }
89
+ );
90
+ assert.equal(resolved.length, 0, "resolving could make a step and register the viewer on it");
91
+ assert.equal(stale.sent.code, 503);
92
+ assert.equal(stale.sent.headers["retry-after"], "0");
93
+
94
+ const current = recordingReply();
95
+ await handleTranscodeVariantFileGet(
96
+ requestOf({ sessionId: OUTPUT_ID, height: "720", fileName: "segment-00005.mp4" }, { consumer: "viewer-a", generation: "4" }),
97
+ current.reply,
98
+ { renditions, serving: {}, viewerRequests }
99
+ );
100
+ assert.equal(resolved.length, 1, "a request of the current viewing is resolved");
101
+ assert.equal(resolved[0][4], 4, "and it is handed the generation it carried");
102
+ });
103
+
104
+ test("a request for a soundtrack of a viewing that was left is refused before it is resolved", async () => {
105
+ const resolved = [];
106
+ const renditions = {
107
+ resolveAudioRenditionFile: async (...args) => {
108
+ resolved.push(args);
109
+ return { sessionId: null };
110
+ }
111
+ };
112
+ const viewerRequests = { acceptsRequest: () => false };
113
+ const { reply, sent } = recordingReply();
114
+
115
+ await handleTranscodeAudioFileGet(
116
+ requestOf({ sessionId: OUTPUT_ID, trackIndex: "1", fileName: "segment-00005.mp4" }, { consumer: "viewer-a", generation: "0" }),
117
+ reply,
118
+ { renditions, serving: {}, viewerRequests }
119
+ );
120
+
121
+ assert.equal(resolved.length, 0);
122
+ assert.equal(sent.code, 503);
123
+ });
124
+
125
+ test("only a stated non-negative integer is a generation", () => {
126
+ assert.equal(statedGenerationOf({ query: { generation: "7" } }), 7);
127
+ assert.ok(Number.isNaN(statedGenerationOf({ query: {} })), "nothing stated");
128
+ assert.ok(Number.isNaN(statedGenerationOf({ query: { generation: "-1" } })));
129
+ assert.ok(Number.isNaN(statedGenerationOf({ query: { generation: "2.5" } })));
130
+ assert.ok(Number.isNaN(statedGenerationOf({ query: { generation: "abc" } })));
131
+ });
132
+
133
+ test("one viewer's seek does not touch another viewer's assignments on a shared output", () => {
134
+ const viewers = new Viewers();
135
+ const shared = { id: OUTPUT_ID, outputKey: "key-shared" };
136
+ viewers.of(shared, "viewer-a");
137
+ viewers.of(shared, "viewer-b");
138
+ noteGivenOutput(viewers, "viewer-a", 0, 720, 5, "key-shared");
139
+ noteGivenOutput(viewers, "viewer-b", 0, 720, 5, "key-shared");
140
+ const seekedAt = Date.now();
141
+
142
+ viewers.get("viewer-a").assignments.statedGeneration(1, seekedAt);
143
+
144
+ const longAfter = seekedAt + ACCEPT_WINDOW_MS + 1;
145
+ assert.equal(acceptsGeneration(viewers, "viewer-b", 0, longAfter), true, "the other viewer did not seek");
146
+ assert.equal(givenOutputOf(viewers, "viewer-b", 0, 720, 5), "key-shared");
147
+
148
+ assert.equal(
149
+ acceptsGeneration(viewers, "viewer-a", 0, seekedAt + 1_000),
150
+ true,
151
+ "a request of the viewing just left, arriving late, is still taken within the window"
152
+ );
153
+ assert.equal(
154
+ givenOutputOf(viewers, "viewer-a", 0, 720, 5),
155
+ "key-shared",
156
+ "and is answered by what answered it, not decided anew"
157
+ );
158
+ assert.equal(
159
+ acceptsGeneration(viewers, "viewer-a", 0, longAfter),
160
+ false,
161
+ "past the window, a request of the viewing left is refused"
162
+ );
163
+ });
164
+
165
+ test("a request that states no generation belongs to the viewer's current one", () => {
166
+ const viewers = new Viewers();
167
+ viewers.of({ id: OUTPUT_ID, outputKey: "key" }, "viewer-a");
168
+ viewers.get("viewer-a").assignments.statedGeneration(3);
169
+
170
+ assert.equal(generationOfRequest(viewers, "viewer-a", Number.NaN), 3);
171
+ assert.equal(generationOfRequest(viewers, "viewer-a", 1), 1, "a stated one is kept as stated");
172
+ assert.equal(acceptsGeneration(viewers, "nobody", 0), true, "a viewer not known yet takes everything");
173
+ });
174
+
175
+ test("a response already begun holds its output across a change of viewing, and its release is safe to repeat", async () => {
176
+ const viewers = new Viewers();
177
+ const output = { id: OUTPUT_ID, outputKey: "key-sent" };
178
+ viewers.of({ id: OTHER_ID, outputKey: "key-other" }, "viewer-a");
179
+ const serving = {
180
+ seekEpoch: () => 0,
181
+ getFileStream: async () => ({ kind: "file", contentType: "video/mp4", stream: "bytes", isPlaylist: false })
182
+ };
183
+ const viewerRequests = {
184
+ holdResponse: (_sessionId, consumerId) => holdForResponse(viewers, consumerId, output.outputKey)
185
+ };
186
+ const { reply, sent } = recordingReply();
187
+
188
+ await serveSessionFile(
189
+ requestOf({}, { consumer: "viewer-a" }),
190
+ reply,
191
+ { serving, viewerRequests, sessionId: OUTPUT_ID, fileName: "segment-00005.mp4" }
192
+ );
193
+ assert.equal(sent.body, "bytes", "the fixture must reach sending");
194
+
195
+ viewers.get("viewer-a").assignments.statedGeneration(9, Date.now() - 10 * ACCEPT_WINDOW_MS);
196
+ assert.equal(viewers.assignmentsHold(output), true, "the response is still going out");
197
+
198
+ reply.raw.emit("finish");
199
+ assert.equal(viewers.assignmentsHold(output), false, "finished, it holds nothing");
200
+ reply.raw.emit("close");
201
+ reply.raw.emit("error", new Error("after the end"));
202
+ assert.equal(viewers.assignmentsHold(output), false, "and the events after it change nothing");
203
+ });
204
+
205
+ test("a response over before it began is released at once", async () => {
206
+ const viewers = new Viewers();
207
+ const output = { id: OUTPUT_ID, outputKey: "key-sent" };
208
+ viewers.of({ id: OTHER_ID, outputKey: "key-other" }, "viewer-a");
209
+ const serving = {
210
+ seekEpoch: () => 0,
211
+ getFileStream: async () => ({ kind: "file", contentType: "video/mp4", stream: "bytes", isPlaylist: false })
212
+ };
213
+ const viewerRequests = {
214
+ holdResponse: (_sessionId, consumerId) => holdForResponse(viewers, consumerId, output.outputKey)
215
+ };
216
+ const { reply } = recordingReply();
217
+ reply.raw.destroyed = true;
218
+
219
+ await serveSessionFile(
220
+ requestOf({}, { consumer: "viewer-a" }),
221
+ reply,
222
+ { serving, viewerRequests, sessionId: OUTPUT_ID, fileName: "segment-00005.mp4" }
223
+ );
224
+
225
+ assert.equal(viewers.assignmentsHold(output), false, "no event of it will fire again to release it");
226
+ });
227
+
228
+ test("the picture's own route records its answer under the height it is named after", () => {
229
+ const viewers = new Viewers();
230
+ const picture = {
231
+ id: OUTPUT_ID,
232
+ outputKey: "key-picture",
233
+ spec: { video: {} },
234
+ segmentFormat: fmp4Format
235
+ };
236
+ const soundtrack = {
237
+ id: OTHER_ID,
238
+ outputKey: "key-sound",
239
+ spec: { video: null },
240
+ segmentFormat: fmp4Format
241
+ };
242
+ viewers.of(picture, "viewer-a");
243
+ const byId = new Map([[picture.id, picture], [soundtrack.id, soundtrack]]);
244
+ const requests = new ViewerRequests({
245
+ outputs: { get: (id) => byId.get(id) ?? null, variantHeightOf: () => 1080 },
246
+ generationOfRequest: (consumerId, stated) => generationOfRequest(viewers, consumerId, stated),
247
+ noteGivenOutput: (...args) => noteGivenOutput(viewers, ...args)
248
+ });
249
+
250
+ requests.noteAnsweredDirectly(OUTPUT_ID, "viewer-a", 0, "segment-00012.mp4");
251
+ requests.noteAnsweredDirectly(OUTPUT_ID, "viewer-a", 0, "init.mp4");
252
+ requests.noteAnsweredDirectly(OUTPUT_ID, "viewer-a", 0, "index.m3u8");
253
+ requests.noteAnsweredDirectly(OTHER_ID, "viewer-a", 0, "segment-00012.mp4");
254
+
255
+ assert.equal(givenOutputOf(viewers, "viewer-a", 0, 1080, 12), "key-picture");
256
+ assert.equal(givenOutputOf(viewers, "viewer-a", 0, 1080, -1), "key-picture", "the init is segment -1");
257
+ const held = viewers.get("viewer-a").assignments.heldKeys();
258
+ assert.equal(held.has("key-sound"), false, "a soundtrack is not a height and records nothing");
259
+ assert.deepEqual([...held], ["key-picture"], "and a playlist records nothing either");
260
+ });
261
+
262
+ /**
263
+ * An output lifecycle whose disposals are recorded instead of carried out:
264
+ * what is checked is WHETHER it disposes, not how.
265
+ *
266
+ * @param {{ viewers: Viewers, outputs: object[] }} setup
267
+ */
268
+ function lifecycleOver({ viewers, outputs }) {
269
+ const byId = new Map(outputs.map((output) => [output.id, output]));
270
+ const lifecycle = new OutputLifecycle({
271
+ viewers,
272
+ sessionTtlMs: 0,
273
+ outputs: {
274
+ get: (id) => byId.get(id) ?? null,
275
+ has: (id) => byId.has(id),
276
+ touch() {},
277
+ familyOf: (output) => [output],
278
+ expiredBefore: () => [...byId.keys()],
279
+ values: () => byId.values()
280
+ },
281
+ timelines: { forgetUnused() {} },
282
+ sourceFiles: { forgetUnused() {}, get() {} },
283
+ keyframeTables: { forgetUnused() {} },
284
+ machineBudget: { revise: async () => {}, segmentBytes: () => 0 },
285
+ returns: { describe: () => null },
286
+ segmentStore: { enforce() {} },
287
+ viewerSegmentsOn: () => []
288
+ });
289
+ const disposed = [];
290
+ lifecycle.disposeSession = async (id) => {
291
+ disposed.push(id);
292
+ byId.delete(id);
293
+ };
294
+ return { lifecycle, disposed };
295
+ }
296
+
297
+ test("an output an assignment holds is kept when its last viewer leaves, and by the idle expiry until it lapses", async () => {
298
+ const viewers = new Viewers();
299
+ const output = { id: OUTPUT_ID, outputKey: "key-held" };
300
+ const elsewhere = { id: OTHER_ID, outputKey: "key-elsewhere" };
301
+ viewers.of(output, "viewer-a");
302
+ // Viewer B moved to another output a moment ago; a request of theirs made
303
+ // against this one may still be repeated.
304
+ viewers.of(elsewhere, "viewer-b");
305
+ noteGivenOutput(viewers, "viewer-b", 0, 720, 5, output.outputKey);
306
+ const { lifecycle, disposed } = lifecycleOver({ viewers, outputs: [output] });
307
+
308
+ await lifecycle.releaseSessionConsumer(OUTPUT_ID, "viewer-a", "test");
309
+ assert.deepEqual(disposed, [], "nobody watches it, but an assignment still holds it");
310
+
311
+ await lifecycle.cleanupExpired();
312
+ assert.deepEqual(disposed, [], "the idle expiry asks the same assignments");
313
+
314
+ viewers.get("viewer-b").assignments.statedGeneration(1, Date.now() - ACCEPT_WINDOW_MS - 1);
315
+ await lifecycle.cleanupExpired();
316
+ assert.deepEqual(disposed, [OUTPUT_ID], "once the window of that viewing has passed, it goes");
317
+ });
318
+
319
+ test("the idle expiry does not ask whether anybody is registered — only the assignments", async () => {
320
+ // A paused viewer stays registered on what they were watching. Whether that
321
+ // should hold an output past the idle period is roadmap item 75's question;
322
+ // step 9 must not answer it by accident.
323
+ const viewers = new Viewers();
324
+ const output = { id: OUTPUT_ID, outputKey: "key-paused" };
325
+ viewers.of(output, "viewer-paused");
326
+ const { lifecycle, disposed } = lifecycleOver({ viewers, outputs: [output] });
327
+
328
+ await lifecycle.cleanupExpired();
329
+
330
+ assert.deepEqual(disposed, [OUTPUT_ID]);
331
+ });
332
+
333
+ test("a response already begun holds its output across a change of choice and the viewer leaving that output", () => {
334
+ // Roadmap item 97, step 11: the viewer was given 720p at 2800 and is being
335
+ // moved to 1400. The piece of 2800 already going out must finish, and its
336
+ // output must not be taken away under it — even once the viewer has left it.
337
+ const viewers = new Viewers();
338
+ const at2800 = { id: OUTPUT_ID, outputKey: "key-720-2800" };
339
+ const at1400 = { id: OTHER_ID, outputKey: "key-720-1400" };
340
+ viewers.of(at2800, "viewer-a");
341
+ viewers.of(at1400, "viewer-a");
342
+ chooseOutput(viewers, "viewer-a", 720, at2800.outputKey);
343
+ const release = holdForResponse(viewers, "viewer-a", at2800.outputKey);
344
+
345
+ chooseOutput(viewers, "viewer-a", 720, at1400.outputKey);
346
+ viewers.leaves(at2800, "viewer-a");
347
+
348
+ assert.equal(viewers.forOutput(at2800).size, 0, "nobody is watching it any more");
349
+ assert.equal(viewers.stillNeeded(at2800), true, "but the response being sent from it holds it");
350
+ release();
351
+ assert.equal(viewers.stillNeeded(at2800), false, "and once it is finished, nothing does");
352
+ });
353
+
354
+ test("the step route answers what the rule decided: unavailable, lost, or the stored piece", async () => {
355
+ const viewerRequests = {
356
+ acceptsRequest: () => true,
357
+ holdResponseForKey: () => () => {}
358
+ };
359
+ const route = async (resolved, serving = {}) => {
360
+ const { reply, sent } = recordingReply();
361
+ await handleTranscodeVariantFileGet(
362
+ requestOf({ sessionId: OUTPUT_ID, height: "720", fileName: "segment-00005.mp4" }, { consumer: "viewer-a", generation: "0" }),
363
+ reply,
364
+ { renditions: { resolveVariantFile: async () => resolved }, serving, viewerRequests }
365
+ );
366
+ return sent;
367
+ };
368
+
369
+ const unavailable = await route({ sessionId: null, unavailable: { reason: "no limit fits", figures: { verdict: "does not fit" } } });
370
+ assert.equal(unavailable.code, 409);
371
+ assert.equal(unavailable.body.outcome, "output-unavailable");
372
+ assert.equal(unavailable.body.figures.verdict, "does not fit", "the figures travel to the page");
373
+
374
+ const lost = await route({ sessionId: null, lost: { reason: "the output that answered it has gone" } });
375
+ assert.equal(lost.code, 409);
376
+ assert.equal(lost.body.outcome, "assignment-lost", "not a retry: the same request would be answered the same way");
377
+
378
+ const stored = await route(
379
+ { sessionId: null, recover: { key: "gone-key", likeId: OUTPUT_ID } },
380
+ { storedPieceOf: async () => ({ kind: "file", stream: "stored-bytes", contentType: "video/mp4", isPlaylist: false }) }
381
+ );
382
+ assert.equal(stored.body, "stored-bytes", "the very piece that was given");
383
+ assert.equal(stored.headers["content-type"], "video/mp4");
384
+
385
+ const vanished = await route(
386
+ { sessionId: null, recover: { key: "gone-key", likeId: OUTPUT_ID } },
387
+ { storedPieceOf: async () => null }
388
+ );
389
+ assert.equal(vanished.body.outcome, "assignment-lost", "a stored piece that went meanwhile is a lost address");
390
+ });