@torrent-tv/proxy 2.89.6 → 2.89.7

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 (436) hide show
  1. package/.claude/commands/opsx/apply.md +155 -155
  2. package/.claude/commands/opsx/archive.md +160 -160
  3. package/.claude/commands/opsx/explore.md +174 -174
  4. package/.claude/commands/opsx/propose.md +109 -109
  5. package/.claude/commands/opsx/sync.md +143 -143
  6. package/.claude/skills/openspec-apply-change/SKILL.md +159 -159
  7. package/.claude/skills/openspec-archive-change/SKILL.md +117 -117
  8. package/.claude/skills/openspec-explore/SKILL.md +289 -289
  9. package/.claude/skills/openspec-propose/SKILL.md +113 -113
  10. package/.claude/skills/openspec-sync-specs/SKILL.md +147 -147
  11. package/.dockerignore +5 -5
  12. package/AGENTS.md +338 -338
  13. package/CHANGELOG.md +5 -0
  14. package/Dockerfile +30 -30
  15. package/LICENSE +16 -16
  16. package/README.md +369 -369
  17. package/assets/calibration/NOTICE.md +100 -100
  18. package/assets/diagnostics/sctpstate.gdb +31 -31
  19. package/bin/cli.js +684 -684
  20. package/bin/thread-pool.js +30 -30
  21. package/docs/download-architecture.md +261 -261
  22. package/docs/encode-architecture.md +765 -765
  23. package/docs/encode-run-state.md +96 -96
  24. package/docs/logs.md +97 -97
  25. package/docs/playback-start-forecast.md +17 -2
  26. package/docs/socks5-egress-research.md +114 -114
  27. package/docs/storage-architecture.md +273 -273
  28. package/knip.json +14 -14
  29. package/openspec/changes/adaptive-bitrate/design.md +92 -92
  30. package/openspec/changes/adaptive-bitrate/proposal.md +56 -56
  31. package/openspec/changes/adaptive-bitrate/specs/adaptive-bitrate/spec.md +51 -51
  32. package/openspec/changes/adaptive-bitrate/tasks.md +40 -40
  33. package/openspec/changes/binary-distribution/.openspec.yaml +2 -2
  34. package/openspec/changes/binary-distribution/proposal.md +53 -53
  35. package/openspec/changes/chunked-request-bodies/design.md +81 -81
  36. package/openspec/changes/chunked-request-bodies/proposal.md +53 -53
  37. package/openspec/changes/chunked-request-bodies/specs/chunked-request-bodies/spec.md +30 -30
  38. package/openspec/changes/chunked-request-bodies/tasks.md +40 -40
  39. package/openspec/changes/cold-start/design.md +98 -98
  40. package/openspec/changes/cold-start/proposal.md +62 -62
  41. package/openspec/changes/cold-start/specs/cold-start/spec.md +47 -47
  42. package/openspec/changes/cold-start/tasks.md +48 -48
  43. package/openspec/changes/disk-cap/.openspec.yaml +2 -2
  44. package/openspec/changes/disk-cap/proposal.md +37 -37
  45. package/openspec/changes/disk-cap/specs/disk-cap/spec.md +25 -25
  46. package/openspec/changes/disk-cap/tasks.md +19 -19
  47. package/openspec/changes/proxy-observability/.openspec.yaml +2 -2
  48. package/openspec/changes/proxy-observability/design.md +38 -38
  49. package/openspec/changes/proxy-observability/proposal.md +49 -49
  50. package/openspec/changes/proxy-observability/specs/observability/spec.md +33 -33
  51. package/openspec/changes/proxy-observability/tasks.md +21 -21
  52. package/openspec/changes/seek-debounce/design.md +118 -118
  53. package/openspec/changes/seek-debounce/proposal.md +59 -59
  54. package/openspec/changes/seek-debounce/specs/seek-debounce/spec.md +41 -41
  55. package/openspec/changes/seek-debounce/tasks.md +33 -33
  56. package/openspec/changes/subtitle-language/.openspec.yaml +2 -2
  57. package/openspec/changes/subtitle-language/proposal.md +50 -50
  58. package/openspec/changes/subtitle-language/specs/subtitle-language/spec.md +34 -34
  59. package/openspec/changes/subtitle-language/tasks.md +26 -26
  60. package/openspec/changes/track-selection/.openspec.yaml +2 -2
  61. package/openspec/changes/track-selection/design.md +47 -47
  62. package/openspec/changes/track-selection/proposal.md +45 -45
  63. package/openspec/changes/track-selection/specs/track-selection/spec.md +41 -41
  64. package/openspec/changes/track-selection/tasks.md +20 -20
  65. package/openspec/changes/transcode-quality/.openspec.yaml +2 -2
  66. package/openspec/changes/transcode-quality/proposal.md +51 -51
  67. package/openspec/changes/transcode-quality/specs/transcode-quality/spec.md +139 -139
  68. package/openspec/changes/transcode-quality/tasks.md +63 -63
  69. package/openspec/config.yaml +38 -38
  70. package/package.json +1 -1
  71. package/public/.well-known/appspecific/com.chrome.devtools.json +1 -1
  72. package/research/delivery-wedge-stand-ladder-2026-09-13.md +329 -329
  73. package/research/double-spawn-2026-09-10.md +171 -171
  74. package/research/handover-2026-09-13.md +209 -209
  75. package/research/handover-reader-claims-removal-2026-09-12.md +166 -166
  76. package/research/piece-withdrawn-but-still-claimed-2026-09-12.md +175 -175
  77. package/research/preset-benchmark-size-scaling-2026-08-22.md +55 -55
  78. package/research/priority-map-is-the-truth-2026-09-12.md +225 -225
  79. package/routes/api/client-logs/post.js +86 -86
  80. package/routes/api/delivery-sink/get.js +72 -72
  81. package/routes/api/link-probe/get.js +51 -51
  82. package/routes/api/playback-plan/audio-tracks/post.js +29 -29
  83. package/routes/api/playback-plan/post.js +53 -53
  84. package/routes/api/sources/post.js +36 -36
  85. package/routes/api/sources/stats/get.js +132 -132
  86. package/routes/api/sources/warm/post.js +217 -217
  87. package/routes/api/subtitles/get.js +230 -230
  88. package/routes/api/transcode-sessions/fragment-far/post.js +60 -60
  89. package/routes/api/transcode-sessions/net-report/post.js +138 -138
  90. package/routes/api/transcode-sessions/post.js +178 -178
  91. package/routes/api/transcode-sessions/progress/get.js +27 -27
  92. package/routes/api/transcode-sessions/release/post.js +41 -41
  93. package/routes/api/transcode-sessions/seek/post.js +63 -63
  94. package/routes/health/get.js +13 -13
  95. package/routes/healthz/get.js +13 -13
  96. package/routes/stream/get.js +416 -416
  97. package/routes/transcode/audio-file/get.js +64 -64
  98. package/routes/transcode/audio-warm/get.js +95 -95
  99. package/routes/transcode/session-file/get.js +52 -52
  100. package/routes/transcode/variant-file/get.js +95 -95
  101. package/routes/transcode/variant-warm/get.js +84 -84
  102. package/scripts/render-run-graph.js +173 -173
  103. package/server.js +748 -748
  104. package/services/encode/CoverageMap.js +428 -428
  105. package/services/encode/CushionReport.js +345 -345
  106. package/services/encode/EncodeAdmission.js +376 -376
  107. package/services/encode/EncodeOrchestrator.js +1192 -1192
  108. package/services/encode/EncodePlan.js +1368 -1368
  109. package/services/encode/EncodeRun.js +32 -4
  110. package/services/encode/EncodeRuns.js +19 -7
  111. package/services/encode/Encoder.js +142 -142
  112. package/services/encode/EncoderSelection.js +38 -38
  113. package/services/encode/LocalObservations.js +359 -359
  114. package/services/encode/NvencEncoder.js +50 -50
  115. package/services/encode/OutputTimes.js +579 -579
  116. package/services/encode/QsvEncoder.js +58 -58
  117. package/services/encode/Renditions.js +2283 -2283
  118. package/services/encode/RunClock.js +87 -87
  119. package/services/encode/RunProgress.js +79 -79
  120. package/services/encode/SegmentDemand.js +95 -95
  121. package/services/encode/SoftwareEncoder.js +121 -121
  122. package/services/encode/V4l2m2mEncoder.js +53 -53
  123. package/services/encode/VaapiEncoder.js +66 -66
  124. package/services/encode/args.js +418 -418
  125. package/services/encode/available-share.js +89 -89
  126. package/services/encode/calibration.js +361 -361
  127. package/services/encode/contention.js +128 -128
  128. package/services/encode/decode-cost-fit.js +363 -363
  129. package/services/encode/encode-exit.js +116 -114
  130. package/services/encode/encode-run-state.js +551 -551
  131. package/services/encode/encoder-readings.js +43 -43
  132. package/services/encode/fingerprint.js +322 -322
  133. package/services/encode/host-load.js +174 -174
  134. package/services/encode/index.js +9 -9
  135. package/services/encode/learned-median.js +90 -90
  136. package/services/encode/output/EncodedOutput.js +57 -57
  137. package/services/encode/output/Output.js +131 -131
  138. package/services/encode/output/OutputCatalog.js +414 -414
  139. package/services/encode/output/OutputSpec.js +390 -390
  140. package/services/encode/output/Timeline.js +308 -308
  141. package/services/encode/output/cut-grid.js +107 -107
  142. package/services/encode/output/ladder.js +32 -32
  143. package/services/encode/output/playlists.js +284 -284
  144. package/services/encode/output/rates.js +125 -125
  145. package/services/encode/output-key-format.js +21 -21
  146. package/services/encode/piece-completeness.js +60 -2
  147. package/services/encode/quality/EncodeCost.js +1043 -1043
  148. package/services/encode/quality/HostLoad.js +525 -525
  149. package/services/encode/quality/HostTimings.js +249 -249
  150. package/services/encode/quality/OutputQualityState.js +24 -24
  151. package/services/encode/quality/QualityController.js +758 -758
  152. package/services/encode/quality/QualityOffer.js +416 -416
  153. package/services/encode/quality/drain-threat.js +47 -47
  154. package/services/encode/quality/link-budget.js +337 -337
  155. package/services/encode/quality/output-format.js +319 -319
  156. package/services/encode/quality/serving-output.js +216 -216
  157. package/services/encode/quality/visible-rung.js +57 -57
  158. package/services/encode/run-budget.js +97 -97
  159. package/services/encode/run-command.js +3 -1
  160. package/services/encode/run-costs.js +155 -155
  161. package/services/encode/run-inputs.js +53 -53
  162. package/services/encode/segment-formats/fmp4.js +476 -476
  163. package/services/encode/segment-formats/index.js +1 -0
  164. package/services/encode/segment-formats/init-compat.js +324 -324
  165. package/services/encode/segment-formats/mp4-boxes.js +8 -1
  166. package/services/encode/segment-formats/mpegts.js +134 -134
  167. package/services/encode/start-stop-cost.js +178 -178
  168. package/services/encode/throughput.js +97 -97
  169. package/services/encode/torrent-cost.js +88 -88
  170. package/services/identity/installation-id.js +38 -38
  171. package/services/media/SourceFile.js +298 -298
  172. package/services/media/SubtitleOrchestrator.js +167 -167
  173. package/services/media/container/KeyframeTable.js +272 -272
  174. package/services/media/container/ebml-reader.js +159 -159
  175. package/services/media/ffmpeg-banner.js +260 -260
  176. package/services/media/keyframe-probe.js +157 -157
  177. package/services/media/media-info-probe.js +93 -93
  178. package/services/media/playback-planner.js +931 -931
  179. package/services/media/tracks/AudioTrack.js +143 -143
  180. package/services/media/tracks/ImageSubtitleTrack.js +19 -19
  181. package/services/media/tracks/SubtitleTrack.js +38 -38
  182. package/services/media/tracks/VideoTrack.js +33 -33
  183. package/services/media/tracks/audio-bound.js +233 -233
  184. package/services/media/tracks/index.js +15 -15
  185. package/services/media/tracks/language-detect.js +174 -174
  186. package/services/server/OutputLifecycle.js +418 -418
  187. package/services/server/SegmentServing.js +1152 -1152
  188. package/services/server/ViewerRequests.js +785 -785
  189. package/services/server/WaitLedger.js +142 -142
  190. package/services/server/controllers/PlaybackController.js +40 -40
  191. package/services/server/controllers/SubtitleController.js +109 -109
  192. package/services/server/http-responses.js +60 -60
  193. package/services/server/transcode-session-files.js +325 -325
  194. package/services/server/wire-outputs.js +1029 -1029
  195. package/services/storage/Diagnostics.js +202 -202
  196. package/services/storage/MachineBudget.js +235 -235
  197. package/services/storage/allowance.js +107 -107
  198. package/services/storage/core-dumps.js +106 -106
  199. package/services/storage/files/CompletedFiles.js +391 -391
  200. package/services/storage/files/piece-from-whole-file.js +118 -118
  201. package/services/storage/free.js +71 -71
  202. package/services/storage/keep.js +48 -48
  203. package/services/storage/machine-memory.js +56 -56
  204. package/services/storage/memory-report.js +575 -575
  205. package/services/storage/piece-store/piece-disk-store.js +539 -539
  206. package/services/storage/piece-store/piece-lru.js +495 -495
  207. package/services/storage/returns.js +103 -103
  208. package/services/storage/wire.js +175 -175
  209. package/services/torrent/demand/DemandRegister.js +202 -202
  210. package/services/torrent/demand/Urgency.js +137 -137
  211. package/services/torrent/demand/Window.js +118 -118
  212. package/services/torrent/demand/index.js +8 -8
  213. package/services/torrent/demand/pieces.js +140 -140
  214. package/services/torrent/download/SwarmSelection.js +386 -386
  215. package/services/torrent/download/registry.js +102 -102
  216. package/services/torrent/download/withdraw-claim.js +80 -80
  217. package/services/torrent/files.js +455 -455
  218. package/services/torrent/naming.js +619 -619
  219. package/services/torrent/piece-store-of.js +29 -29
  220. package/services/torrent/supply-margin.js +264 -264
  221. package/services/torrent/worker/background-fill.js +213 -213
  222. package/services/torrent/worker/channel.js +271 -271
  223. package/services/torrent/worker/fastest-wires.js +342 -342
  224. package/services/torrent/worker/handle-state.js +23 -23
  225. package/services/torrent/worker/install-webrtc-shim.js +32 -32
  226. package/services/torrent/worker/piece-reader.js +1078 -1078
  227. package/services/torrent/worker/pool-adapter.js +371 -371
  228. package/services/torrent/worker/protocol.js +184 -184
  229. package/services/torrent/worker/resume-warm.js +107 -107
  230. package/services/torrent/worker/webrtc-shim.js +219 -219
  231. package/services/transport/delivery-probe.js +842 -842
  232. package/services/transport/health-collector.js +53 -53
  233. package/services/transport/nat-classifier.js +231 -231
  234. package/services/transport/packet-witness.js +808 -808
  235. package/services/transport/port-mapper.js +235 -235
  236. package/services/transport/registry-api.js +81 -81
  237. package/services/transport/tunnel-client.js +447 -447
  238. package/services/transport/usrsctp-state.js +175 -175
  239. package/services/transport/webrtc-manager.js +484 -484
  240. package/services/viewer/Assignments.js +340 -340
  241. package/services/viewer/PriorityOrchestrator.js +325 -325
  242. package/services/viewer/Viewer.js +691 -691
  243. package/services/viewer/Viewers.js +368 -368
  244. package/services/viewer/active-output.js +37 -37
  245. package/services/viewer/audio-start.js +46 -46
  246. package/services/viewer/buffer-trend.js +81 -81
  247. package/services/viewer/choices.js +647 -647
  248. package/services/viewer/media-time.js +355 -355
  249. package/services/viewer/playback-readiness.js +635 -635
  250. package/services/viewer/positions.js +126 -126
  251. package/services/viewer/report-intake.js +46 -46
  252. package/store/source-registry.js +71 -71
  253. package/test/asset-paths.test.js +28 -28
  254. package/test/audio-buffer-continuity.test.js +77 -77
  255. package/test/audio-inventory.test.js +212 -212
  256. package/test/audio-track-bitrate.test.js +40 -40
  257. package/test/available-share.test.js +76 -76
  258. package/test/background-fill.test.js +190 -190
  259. package/test/client-log-file.test.js +110 -110
  260. package/test/completed-files.test.js +115 -115
  261. package/test/concurrent-cost.test.js +148 -148
  262. package/test/container-media-info.test.js +228 -228
  263. package/test/contention.test.js +76 -76
  264. package/test/core-dumps.test.js +57 -57
  265. package/test/coverage-follows-the-disk.test.js +228 -228
  266. package/test/coverage-map.test.js +195 -195
  267. package/test/cue-push-carries-what-the-walk-found.test.js +58 -58
  268. package/test/cut-times-timeline.test.js +65 -65
  269. package/test/cuts-follow-published-grid.test.js +109 -109
  270. package/test/data-channel-frame.test.js +63 -63
  271. package/test/data-channel-viewer-lifecycle.test.js +92 -92
  272. package/test/dead-torrent-handle.test.js +52 -52
  273. package/test/declared-rates.test.js +116 -116
  274. package/test/declared-tracks.test.js +43 -43
  275. package/test/decode-cost-fit.test.js +202 -202
  276. package/test/delivery-probe.test.js +393 -393
  277. package/test/demand-register.test.js +206 -206
  278. package/test/dht-bootstrap.test.js +72 -72
  279. package/test/drain-threat.test.js +65 -65
  280. package/test/duplicate-add.test.js +48 -48
  281. package/test/encode-admission.test.js +146 -146
  282. package/test/encode-cost.test.js +275 -275
  283. package/test/encode-exit.test.js +111 -111
  284. package/test/encode-orchestrator.test.js +426 -426
  285. package/test/encode-plan-viewers.test.js +725 -725
  286. package/test/encode-plan.test.js +545 -545
  287. package/test/encode-run-state.test.js +314 -314
  288. package/test/encode-run.test.js +38 -0
  289. package/test/encode-slope.test.js +46 -46
  290. package/test/encoded-output.test.js +39 -39
  291. package/test/encoder-kinds.test.js +122 -122
  292. package/test/encoder-readings.test.js +68 -68
  293. package/test/every-claimant-is-told-its-share.test.js +152 -152
  294. package/test/failed-encoder-still-serves-what-exists.test.js +354 -354
  295. package/test/failed-start-breaker.test.js +202 -202
  296. package/test/fastest-wires.test.js +143 -143
  297. package/test/ffmpeg-stream-counts.test.js +78 -78
  298. package/test/file-edges.test.js +191 -191
  299. package/test/fixtures/refused-audio-20261002.json +10 -0
  300. package/test/fmp4-presentation-clock.test.js +4 -2
  301. package/test/fmp4-self-contained.test.js +80 -80
  302. package/test/fmp4-timestamps.test.js +140 -140
  303. package/test/fmp4-track-completeness.test.js +41 -41
  304. package/test/health-metrics.test.js +38 -38
  305. package/test/held-request-width.test.js +157 -157
  306. package/test/helpers/encode-run.js +240 -240
  307. package/test/helpers/output-spec.js +63 -63
  308. package/test/host-load.test.js +68 -68
  309. package/test/index-accuracy-is-about-the-file.test.js +128 -128
  310. package/test/init-compat.test.js +219 -219
  311. package/test/input-lost-quiets-the-plan.test.js +261 -261
  312. package/test/input-unavailable.test.js +48 -48
  313. package/test/installation-id.test.js +39 -39
  314. package/test/keeping-period.test.js +83 -83
  315. package/test/keyframe-index-accuracy.test.js +188 -188
  316. package/test/keyframes-belong-to-the-file.test.js +249 -249
  317. package/test/learned-median.test.js +37 -37
  318. package/test/letting-go-asks-who-is-watching.test.js +191 -191
  319. package/test/limit-row-by-area.test.js +60 -60
  320. package/test/link-budget.test.js +111 -111
  321. package/test/link-probe.test.js +56 -56
  322. package/test/local-encoding-data.test.js +273 -273
  323. package/test/logger-repeats.test.js +134 -134
  324. package/test/look-ahead-coverage.test.js +56 -56
  325. package/test/manager-surface.test.js +291 -291
  326. package/test/matroska-cues-track.test.js +192 -192
  327. package/test/media-time.test.js +62 -62
  328. package/test/memory-budget.test.js +390 -390
  329. package/test/move-cost.test.js +216 -216
  330. package/test/mp4-subtitles.test.js +173 -173
  331. package/test/one-authority.test.js +285 -285
  332. package/test/one-budget.test.js +149 -149
  333. package/test/one-resource-divided.test.js +185 -185
  334. package/test/one-serving-output-per-height.test.js +458 -458
  335. package/test/orchestrator-wired.test.js +207 -207
  336. package/test/output-catalog.test.js +39 -39
  337. package/test/output-shape.test.js +21 -21
  338. package/test/output-spec.test.js +251 -251
  339. package/test/output-speed.test.js +87 -87
  340. package/test/outputs-being-prepared.test.js +40 -40
  341. package/test/packet-witness-ring.test.js +236 -236
  342. package/test/packet-witness.test.js +148 -148
  343. package/test/piece-completeness.test.js +37 -1
  344. package/test/piece-disk-store.test.js +401 -401
  345. package/test/piece-from-whole-file.test.js +129 -129
  346. package/test/piece-lru.test.js +319 -319
  347. package/test/piece-reader.test.js +162 -162
  348. package/test/piece-selection-offset.test.js +85 -85
  349. package/test/piece-store-eviction.test.js +595 -595
  350. package/test/piece-store-never-refuses.test.js +153 -153
  351. package/test/piece-store-reservations.test.js +403 -403
  352. package/test/piece-store-slow-disk.test.js +159 -159
  353. package/test/piece-tail.test.js +97 -97
  354. package/test/plan-host-timings.test.js +68 -68
  355. package/test/plan-is-steady.test.js +225 -225
  356. package/test/playback-readiness.test.js +518 -518
  357. package/test/playback-start-regressions.test.js +101 -101
  358. package/test/priority-map-download.test.js +174 -174
  359. package/test/priority-map-emptied.test.js +204 -204
  360. package/test/priority-map-per-output.test.js +215 -215
  361. package/test/priority-map.test.js +163 -163
  362. package/test/probe-wedge-certainty.test.js +60 -60
  363. package/test/produced-copy-choice.test.js +213 -213
  364. package/test/published-timeline.test.js +83 -83
  365. package/test/quality-offer.test.js +160 -160
  366. package/test/rate-control-in-the-output.test.js +180 -180
  367. package/test/read-survives-withdrawal.test.js +164 -164
  368. package/test/read-window.test.js +365 -365
  369. package/test/resume-warm.test.js +39 -39
  370. package/test/run-graph-drift.test.js +37 -37
  371. package/test/run-inputs.test.js +80 -80
  372. package/test/run-intervals.test.js +100 -100
  373. package/test/run-position-follows-published-grid.test.js +89 -89
  374. package/test/run-progress.test.js +64 -64
  375. package/test/same-height-switch.test.js +663 -663
  376. package/test/seek-frees-the-viewers-requests.test.js +217 -217
  377. package/test/seek-landing.test.js +109 -109
  378. package/test/seek-target-not-superseded.test.js +195 -195
  379. package/test/segment-cut-times.test.js +63 -63
  380. package/test/segment-demand.test.js +80 -80
  381. package/test/segment-hold-supersede.test.js +91 -91
  382. package/test/segment-store-eviction.test.js +247 -247
  383. package/test/segment-store.test.js +352 -352
  384. package/test/segment-true-start.test.js +86 -86
  385. package/test/segments-are-shared.test.js +176 -176
  386. package/test/send-chunk-bytes.test.js +86 -86
  387. package/test/serving-output.test.js +102 -102
  388. package/test/shared-piece-store.test.js +310 -310
  389. package/test/sidecar-naming.test.js +142 -142
  390. package/test/soundtrack-rate-bound.test.js +289 -289
  391. package/test/source-file.test.js +133 -133
  392. package/test/source-registry.test.js +18 -18
  393. package/test/split-a-stretch.test.js +139 -139
  394. package/test/stale-request-after-seek.test.js +158 -158
  395. package/test/startup-readings.test.js +124 -124
  396. package/test/stream-route.test.js +237 -237
  397. package/test/subtitle-cue-framing.test.js +200 -200
  398. package/test/subtitle-cue-source.test.js +102 -102
  399. package/test/subtitle-cursor.test.js +63 -63
  400. package/test/subtitle-defaults.test.js +118 -118
  401. package/test/subtitle-language.test.js +252 -252
  402. package/test/supply-margin.test.js +190 -190
  403. package/test/swarm-follows-readers.test.js +174 -174
  404. package/test/swarm-reach.test.js +130 -130
  405. package/test/swarm-selection.test.js +220 -220
  406. package/test/tail-duplication.test.js +167 -167
  407. package/test/the-channel-has-both-ends.test.js +91 -91
  408. package/test/the-torrent-thread-serves-bytes.test.js +107 -107
  409. package/test/thread-pool.test.js +53 -53
  410. package/test/timeline.test.js +84 -84
  411. package/test/torrent-contents.test.js +235 -235
  412. package/test/torrent-cost.test.js +71 -71
  413. package/test/torrent-files.test.js +221 -221
  414. package/test/torrent-naming.test.js +255 -255
  415. package/test/tracks-begin-together.test.js +209 -209
  416. package/test/tunnel-renewal.test.js +167 -167
  417. package/test/upload-hurry.test.js +186 -186
  418. package/test/usrsctp-state.test.js +131 -131
  419. package/test/video-facts.test.js +102 -102
  420. package/test/viewer-assignments.test.js +143 -143
  421. package/test/viewer-outputs.test.js +285 -285
  422. package/test/viewer-presence.test.js +116 -116
  423. package/test/viewer-states.test.js +189 -189
  424. package/test/viewer-subtitle-subscription.test.js +96 -96
  425. package/test/viewer.test.js +139 -139
  426. package/test/visible-rung.test.js +37 -37
  427. package/test/wait-ledger.test.js +100 -100
  428. package/test/webrtc-shim.test.js +149 -149
  429. package/test/wedge-certainty.test.js +131 -131
  430. package/test/withdraw-piece-claim.test.js +212 -212
  431. package/test/worker-channel.test.js +158 -158
  432. package/utils/client-log-file.js +151 -151
  433. package/utils/logger.js +312 -312
  434. package/utils/parse-range.js +25 -25
  435. package/utils/perf.js +59 -59
  436. package/utils/torrent-source-key.js +38 -38
@@ -1,371 +1,371 @@
1
- /**
2
- * @file `TorrentPool`'s interface, served from the worker thread.
3
- *
4
- * The routes, the planner, the health report and the session manager all reach
5
- * for a torrent pool and use it the same handful of ways. Rather than rewrite
6
- * every one of them to thread a `sourceKey` through and await what used to be
7
- * immediate, this presents the shape they already expect and does the thread
8
- * hop behind it. Swapping the implementation is then a one-line change at
9
- * construction, and the call sites are untouched — which is what keeps a change
10
- * of this size reviewable.
11
- *
12
- * Two accommodations are needed, and both are deliberate:
13
- *
14
- * - **`prioritizeByteRange` stays synchronous.** It returns nothing the caller
15
- * inspects, so the command is dispatched and not awaited. Awaiting it would
16
- * mean touching every call site for no observable gain.
17
- * - **`getTorrent` needs a `sourceKey`.** Torrent objects cannot cross a
18
- * thread, so the worker keys them. Callers that have one pass it; the rest
19
- * get one derived from the source itself, so the identity stays stable
20
- * across calls for the same torrent.
21
- */
22
-
23
- import { TorrentWorkerClient } from "./client.js";
24
- import { deriveSourceKey } from "../../../utils/torrent-source-key.js";
25
-
26
- /**
27
- * A torrent pool whose work happens on another thread.
28
- *
29
- * See `protocol.js` for why: the torrent was taking ~85% of the main thread and
30
- * everything owed to a viewer queued behind it.
31
- */
32
- export class WorkerTorrentPool {
33
- #client;
34
- /** Stand-ins by source key, so repeat calls return the same object. */
35
- #torrents = new Map();
36
-
37
- /**
38
- * @param {{ memoryBytes?: number, stateDir?: string }} [options]
39
- * @param {object | null} [client] - The worker interface; tests supply a fake.
40
- */
41
- constructor(options = {}, client = null) {
42
- this.#client = client ?? new TorrentWorkerClient(options);
43
- }
44
-
45
- /**
46
- * Load (or join) a torrent and return a stand-in for it.
47
- *
48
- * @param {"magnet" | "torrent"} sourceType
49
- * @param {string} source
50
- * @returns {Promise<object>}
51
- */
52
- async getTorrent(sourceType, source) {
53
- const sourceKey = await deriveSourceKey(sourceType, source);
54
- const existing = this.#torrents.get(sourceKey);
55
- if (existing) {
56
- return existing;
57
- }
58
- const torrent = await this.#client.getTorrent({ sourceKey, sourceType, source });
59
- this.#torrents.set(sourceKey, torrent);
60
- return torrent;
61
- }
62
-
63
- /**
64
- * Claim a file for reading; the returned function releases it.
65
- *
66
- * Synchronous by design — see the file header.
67
- *
68
- * @param {object} torrent - A stand-in from {@link getTorrent}.
69
- * @param {number} fileIndex
70
- * @returns {() => void}
71
- */
72
- /** What the spilled pieces weigh on the torrent thread, as last revised. */
73
- get spilledBytes() {
74
- return this.#client.spilledBytes;
75
- }
76
-
77
- /**
78
- * Say how much disk those spilled pieces may take between them.
79
- *
80
- * @param {number} bytes
81
- * @returns {Promise<number>} What they hold now.
82
- */
83
- allowSpillBytes(bytes) {
84
- return this.#client.allowSpillBytes(bytes);
85
- }
86
-
87
- get memoryClaim() {
88
- return this.#client.memoryClaim ?? { held: 0, wanted: 0 };
89
- }
90
-
91
- allowMemoryBytes(bytes) {
92
- return this.#client.allowMemoryBytes(bytes);
93
- }
94
-
95
- get wholeFileBytes() {
96
- return this.#client.wholeFileBytes ?? 0;
97
- }
98
-
99
- /** Completed files announced by the worker, shared with the HTTP reader. */
100
- get wholeFiles() {
101
- return this.#client.wholeFiles;
102
- }
103
-
104
- allowWholeFileBytes(bytes) {
105
- return this.#client.allowWholeFileBytes(bytes);
106
- }
107
-
108
- /**
109
- * Bytes every torrent here has moved.
110
- *
111
- * @returns {Promise<{ downloaded: number, uploaded: number }>}
112
- */
113
- async getTorrentTotals() {
114
- return this.#client.getTorrentTotals();
115
- }
116
-
117
- /**
118
- * Live download figures for the progress display.
119
- *
120
- * @param {object} torrent
121
- * @param {number | null} [fileIndex]
122
- * @param {{ resumeAnchorByteStart?: number | null }} [options]
123
- * @returns {Promise<object | null>}
124
- */
125
- async getFileStats(torrent, fileIndex = null, options = {}) {
126
- const sourceKey = torrent?.sourceKey;
127
- if (!sourceKey) {
128
- return null;
129
- }
130
- return this.#client.getFileStats({
131
- sourceKey,
132
- fileIndex,
133
- resumeAnchorByteStart: options?.resumeAnchorByteStart ?? null
134
- });
135
- }
136
-
137
- /**
138
- * Fetch one whole file using only the room the viewer's own reading leaves.
139
- *
140
- * For a soundtrack or subtitle file shipped beside the picture: small next to
141
- * the film, and having it on disk is what turns a later switch into a local
142
- * read instead of a wait on the swarm.
143
- *
144
- * @param {object} torrent
145
- * @param {number} fileIndex
146
- * @returns {Promise<boolean>} Whether a fill was started by this call.
147
- */
148
- async fillFileInBackground(torrent, fileIndex) {
149
- const sourceKey = torrent?.sourceKey;
150
- if (!sourceKey) {
151
- return false;
152
- }
153
- const answer = await this.#client.fillFile({ sourceKey, fileIndex });
154
- return answer?.started === true;
155
- }
156
-
157
- /**
158
- * Ask the torrent to fetch all remaining files at conditional TAIL urgency.
159
- *
160
- * @param {object} torrent
161
- * @returns {Promise<boolean>}
162
- */
163
- async fillTorrent(torrent) {
164
- const sourceKey = torrent?.sourceKey;
165
- if (!sourceKey) {
166
- return false;
167
- }
168
- const answer = await this.#client.fillTorrent(sourceKey);
169
- return answer?.started === true;
170
- }
171
-
172
-
173
-
174
-
175
- /**
176
- * Start fetching the region a viewer is about to resume at. Named in seconds
177
- * here; the worker turns it into bytes, where the file's duration is readable.
178
- *
179
- * @param {object} torrent
180
- * @param {number} fileIndex
181
- * @param {number} positionSeconds
182
- * @returns {Promise<boolean>}
183
- */
184
- async warmResumePosition(torrent, fileIndex, positionSeconds, durationSeconds) {
185
- const sourceKey = torrent?.sourceKey;
186
- if (!sourceKey) {
187
- return false;
188
- }
189
- const answer = await this.#client.warmResumePosition({ sourceKey, fileIndex, positionSeconds, durationSeconds });
190
- return answer?.started === true;
191
- }
192
-
193
-
194
-
195
-
196
-
197
-
198
- /**
199
- * Reorder piece selection around a read position.
200
- *
201
- * Synchronous by design — see the file header.
202
- *
203
- * @param {object} torrent
204
- * @param {number} fileIndex
205
- * @param {number} byteStart
206
- * @param {number} [windowBytes]
207
- * @param {{ wholeFileRead?: boolean }} [options]
208
- * @returns {void}
209
- */
210
- prioritizeByteRange(torrent, fileIndex, byteStart, windowBytes, options) {
211
- const sourceKey = torrent?.sourceKey;
212
- if (!sourceKey) {
213
- return;
214
- }
215
- void this.#client
216
- .prioritizeByteRange({
217
- sourceKey,
218
- fileIndex,
219
- byteStart,
220
- windowBytes,
221
- wholeFileRead: options?.wholeFileRead === true
222
- })
223
- .catch(() => undefined);
224
- }
225
-
226
- /**
227
- * Hand the download the priority map for one file.
228
- *
229
- * The map is republished whenever it changes, so a call that fails costs a
230
- * moment rather than correctness — which is why the caller lets it go rather
231
- * than retrying.
232
- *
233
- * @param {{ sourceKey: string, fileIndex: number, durationSeconds: number, zones: object[] }} params
234
- * @returns {Promise<void>}
235
- */
236
- async setPriorityMap({ sourceKey, fileIndex, durationSeconds, zones }) {
237
- if (!sourceKey) {
238
- return;
239
- }
240
- await this.#client.setPriorityMap({ sourceKey, fileIndex, durationSeconds, zones });
241
- }
242
-
243
- /**
244
- * Pre-fetch the head and tail the codec probe needs.
245
- *
246
- * Takes an options object, matching `TorrentPool.prefetchFileEdges` — this
247
- * adapter exists to present that same interface. It previously declared
248
- * positional parameters instead, so the planner's options object arrived as
249
- * `headBytes` and only worked because it was passed along far enough to be
250
- * destructured at the far end. Anyone calling it as documented got the
251
- * defaults instead of the sizes they asked for.
252
- *
253
- * @param {object} torrent
254
- * @param {number} fileIndex
255
- * @param {{ headBytes?: number, tailBytes?: number, timeoutMs?: number }} [options]
256
- * @returns {Promise<unknown>}
257
- */
258
- /**
259
- * One byte range of one file, as bytes, on THIS thread.
260
- *
261
- * What the media layer is built from: a container takes `readRange(start,
262
- * end)` and nothing else, so with this it can be parsed here instead of in
263
- * the torrent thread. It used to be parsed there for one stated reason —
264
- * "the main thread cannot open a read stream on one of its files", which is
265
- * true of WebTorrent's own API and not of the bytes: the pieces live in
266
- * shared memory and this read is the same one that serves every segment,
267
- * so it waits for what has not arrived and steers the swarm toward it.
268
- *
269
- * **It COPIES, deliberately.** The zero-copy path — positions across the
270
- * channel, the piece pinned until the far side says it is done — exists for
271
- * 10 MB segments on the critical path, where the copy was measured at
272
- * 18.84 ms. A container header is 64-256 KB and read once per file, about
273
- * 0.12 ms, against a parse of 0.8 s and a swarm wait of up to a minute. The
274
- * pinning protocol would buy nothing and is not on this path.
275
- *
276
- * @param {object} torrent
277
- * @param {number} fileIndex
278
- * @param {number} start - First byte, inclusive.
279
- * @param {number} end - Last byte, inclusive.
280
- * @returns {Promise<Buffer | null>} Null when the read failed or was cut
281
- * short, which a container reads as "this file does not say".
282
- */
283
- /**
284
- * The byte ranges of one file the torrent holds WHOLE.
285
- *
286
- * What the subtitle walk decides from: it may read only what is already
287
- * downloaded, and a list taken once per pass replaces a question per cluster.
288
- *
289
- * @param {object} torrent
290
- * @param {number} fileIndex
291
- * @returns {Promise<Array<[number, number]>>}
292
- */
293
- async heldRangesOf(torrent, fileIndex) {
294
- const sourceKey = torrent?.sourceKey;
295
- return sourceKey ? this.#client.heldRanges({ sourceKey, fileIndex }) : [];
296
- }
297
-
298
- /**
299
- * Bytes of a range the torrent already holds, never fetched.
300
- *
301
- * Not `readRangeOf`: that one declares demand and steers the swarm, which is
302
- * right for a viewer waiting on a segment and wrong for a walk that must pull
303
- * nothing the viewer is not waiting for.
304
- *
305
- * @param {object} torrent
306
- * @param {number} fileIndex
307
- * @param {number} start
308
- * @param {number} end - Inclusive.
309
- * @returns {Promise<Buffer | null>}
310
- */
311
- async readHeldOf(torrent, fileIndex, start, end) {
312
- const sourceKey = torrent?.sourceKey;
313
- return sourceKey ? this.#client.readHeld({ sourceKey, fileIndex, start, end }) : null;
314
- }
315
-
316
- async readRangeOf(torrent, fileIndex, start, end) {
317
- const sourceKey = torrent?.sourceKey;
318
- if (!sourceKey || !(end >= start) || !(start >= 0)) {
319
- return null;
320
- }
321
- const stream = this.#client.createReadStream({ sourceKey, fileIndex, start, end });
322
- const chunks = [];
323
- let total = 0;
324
- try {
325
- const reader = stream.getReader();
326
- for (;;) {
327
- const { done, value } = await reader.read();
328
- if (done) {
329
- break;
330
- }
331
- chunks.push(Buffer.from(value));
332
- total += value.length;
333
- }
334
- } catch {
335
- return null;
336
- }
337
- return total > 0 ? Buffer.concat(chunks, total) : null;
338
- }
339
-
340
- async prefetchFileEdges(torrent, fileIndex, options = {}) {
341
- const sourceKey = torrent?.sourceKey;
342
- if (!sourceKey) {
343
- return null;
344
- }
345
- return this.#client.prefetchFileEdges({ sourceKey, fileIndex, options });
346
- }
347
-
348
- /**
349
- * Which films this proxy holds right now, and how much of each.
350
- *
351
- * What content affinity is decided from: a viewer of a film somebody here is
352
- * already downloading costs this proxy the encode and nothing else, while the
353
- * same viewer sent anywhere else starts the download from nothing.
354
- *
355
- * @returns {Promise<{ infoHash: string, progress: number, bytes: number }[]>}
356
- */
357
- async heldTorrents() {
358
- const answer = await this.#client.heldTorrents();
359
- return Array.isArray(answer?.held) ? answer.held : [];
360
- }
361
-
362
- /**
363
- * Shut the torrent client down and stop the thread.
364
- *
365
- * @returns {Promise<void>}
366
- */
367
- async destroyAll() {
368
- this.#torrents.clear();
369
- await this.#client.destroyAll();
370
- }
371
- }
1
+ /**
2
+ * @file `TorrentPool`'s interface, served from the worker thread.
3
+ *
4
+ * The routes, the planner, the health report and the session manager all reach
5
+ * for a torrent pool and use it the same handful of ways. Rather than rewrite
6
+ * every one of them to thread a `sourceKey` through and await what used to be
7
+ * immediate, this presents the shape they already expect and does the thread
8
+ * hop behind it. Swapping the implementation is then a one-line change at
9
+ * construction, and the call sites are untouched — which is what keeps a change
10
+ * of this size reviewable.
11
+ *
12
+ * Two accommodations are needed, and both are deliberate:
13
+ *
14
+ * - **`prioritizeByteRange` stays synchronous.** It returns nothing the caller
15
+ * inspects, so the command is dispatched and not awaited. Awaiting it would
16
+ * mean touching every call site for no observable gain.
17
+ * - **`getTorrent` needs a `sourceKey`.** Torrent objects cannot cross a
18
+ * thread, so the worker keys them. Callers that have one pass it; the rest
19
+ * get one derived from the source itself, so the identity stays stable
20
+ * across calls for the same torrent.
21
+ */
22
+
23
+ import { TorrentWorkerClient } from "./client.js";
24
+ import { deriveSourceKey } from "../../../utils/torrent-source-key.js";
25
+
26
+ /**
27
+ * A torrent pool whose work happens on another thread.
28
+ *
29
+ * See `protocol.js` for why: the torrent was taking ~85% of the main thread and
30
+ * everything owed to a viewer queued behind it.
31
+ */
32
+ export class WorkerTorrentPool {
33
+ #client;
34
+ /** Stand-ins by source key, so repeat calls return the same object. */
35
+ #torrents = new Map();
36
+
37
+ /**
38
+ * @param {{ memoryBytes?: number, stateDir?: string }} [options]
39
+ * @param {object | null} [client] - The worker interface; tests supply a fake.
40
+ */
41
+ constructor(options = {}, client = null) {
42
+ this.#client = client ?? new TorrentWorkerClient(options);
43
+ }
44
+
45
+ /**
46
+ * Load (or join) a torrent and return a stand-in for it.
47
+ *
48
+ * @param {"magnet" | "torrent"} sourceType
49
+ * @param {string} source
50
+ * @returns {Promise<object>}
51
+ */
52
+ async getTorrent(sourceType, source) {
53
+ const sourceKey = await deriveSourceKey(sourceType, source);
54
+ const existing = this.#torrents.get(sourceKey);
55
+ if (existing) {
56
+ return existing;
57
+ }
58
+ const torrent = await this.#client.getTorrent({ sourceKey, sourceType, source });
59
+ this.#torrents.set(sourceKey, torrent);
60
+ return torrent;
61
+ }
62
+
63
+ /**
64
+ * Claim a file for reading; the returned function releases it.
65
+ *
66
+ * Synchronous by design — see the file header.
67
+ *
68
+ * @param {object} torrent - A stand-in from {@link getTorrent}.
69
+ * @param {number} fileIndex
70
+ * @returns {() => void}
71
+ */
72
+ /** What the spilled pieces weigh on the torrent thread, as last revised. */
73
+ get spilledBytes() {
74
+ return this.#client.spilledBytes;
75
+ }
76
+
77
+ /**
78
+ * Say how much disk those spilled pieces may take between them.
79
+ *
80
+ * @param {number} bytes
81
+ * @returns {Promise<number>} What they hold now.
82
+ */
83
+ allowSpillBytes(bytes) {
84
+ return this.#client.allowSpillBytes(bytes);
85
+ }
86
+
87
+ get memoryClaim() {
88
+ return this.#client.memoryClaim ?? { held: 0, wanted: 0 };
89
+ }
90
+
91
+ allowMemoryBytes(bytes) {
92
+ return this.#client.allowMemoryBytes(bytes);
93
+ }
94
+
95
+ get wholeFileBytes() {
96
+ return this.#client.wholeFileBytes ?? 0;
97
+ }
98
+
99
+ /** Completed files announced by the worker, shared with the HTTP reader. */
100
+ get wholeFiles() {
101
+ return this.#client.wholeFiles;
102
+ }
103
+
104
+ allowWholeFileBytes(bytes) {
105
+ return this.#client.allowWholeFileBytes(bytes);
106
+ }
107
+
108
+ /**
109
+ * Bytes every torrent here has moved.
110
+ *
111
+ * @returns {Promise<{ downloaded: number, uploaded: number }>}
112
+ */
113
+ async getTorrentTotals() {
114
+ return this.#client.getTorrentTotals();
115
+ }
116
+
117
+ /**
118
+ * Live download figures for the progress display.
119
+ *
120
+ * @param {object} torrent
121
+ * @param {number | null} [fileIndex]
122
+ * @param {{ resumeAnchorByteStart?: number | null }} [options]
123
+ * @returns {Promise<object | null>}
124
+ */
125
+ async getFileStats(torrent, fileIndex = null, options = {}) {
126
+ const sourceKey = torrent?.sourceKey;
127
+ if (!sourceKey) {
128
+ return null;
129
+ }
130
+ return this.#client.getFileStats({
131
+ sourceKey,
132
+ fileIndex,
133
+ resumeAnchorByteStart: options?.resumeAnchorByteStart ?? null
134
+ });
135
+ }
136
+
137
+ /**
138
+ * Fetch one whole file using only the room the viewer's own reading leaves.
139
+ *
140
+ * For a soundtrack or subtitle file shipped beside the picture: small next to
141
+ * the film, and having it on disk is what turns a later switch into a local
142
+ * read instead of a wait on the swarm.
143
+ *
144
+ * @param {object} torrent
145
+ * @param {number} fileIndex
146
+ * @returns {Promise<boolean>} Whether a fill was started by this call.
147
+ */
148
+ async fillFileInBackground(torrent, fileIndex) {
149
+ const sourceKey = torrent?.sourceKey;
150
+ if (!sourceKey) {
151
+ return false;
152
+ }
153
+ const answer = await this.#client.fillFile({ sourceKey, fileIndex });
154
+ return answer?.started === true;
155
+ }
156
+
157
+ /**
158
+ * Ask the torrent to fetch all remaining files at conditional TAIL urgency.
159
+ *
160
+ * @param {object} torrent
161
+ * @returns {Promise<boolean>}
162
+ */
163
+ async fillTorrent(torrent) {
164
+ const sourceKey = torrent?.sourceKey;
165
+ if (!sourceKey) {
166
+ return false;
167
+ }
168
+ const answer = await this.#client.fillTorrent(sourceKey);
169
+ return answer?.started === true;
170
+ }
171
+
172
+
173
+
174
+
175
+ /**
176
+ * Start fetching the region a viewer is about to resume at. Named in seconds
177
+ * here; the worker turns it into bytes, where the file's duration is readable.
178
+ *
179
+ * @param {object} torrent
180
+ * @param {number} fileIndex
181
+ * @param {number} positionSeconds
182
+ * @returns {Promise<boolean>}
183
+ */
184
+ async warmResumePosition(torrent, fileIndex, positionSeconds, durationSeconds) {
185
+ const sourceKey = torrent?.sourceKey;
186
+ if (!sourceKey) {
187
+ return false;
188
+ }
189
+ const answer = await this.#client.warmResumePosition({ sourceKey, fileIndex, positionSeconds, durationSeconds });
190
+ return answer?.started === true;
191
+ }
192
+
193
+
194
+
195
+
196
+
197
+
198
+ /**
199
+ * Reorder piece selection around a read position.
200
+ *
201
+ * Synchronous by design — see the file header.
202
+ *
203
+ * @param {object} torrent
204
+ * @param {number} fileIndex
205
+ * @param {number} byteStart
206
+ * @param {number} [windowBytes]
207
+ * @param {{ wholeFileRead?: boolean }} [options]
208
+ * @returns {void}
209
+ */
210
+ prioritizeByteRange(torrent, fileIndex, byteStart, windowBytes, options) {
211
+ const sourceKey = torrent?.sourceKey;
212
+ if (!sourceKey) {
213
+ return;
214
+ }
215
+ void this.#client
216
+ .prioritizeByteRange({
217
+ sourceKey,
218
+ fileIndex,
219
+ byteStart,
220
+ windowBytes,
221
+ wholeFileRead: options?.wholeFileRead === true
222
+ })
223
+ .catch(() => undefined);
224
+ }
225
+
226
+ /**
227
+ * Hand the download the priority map for one file.
228
+ *
229
+ * The map is republished whenever it changes, so a call that fails costs a
230
+ * moment rather than correctness — which is why the caller lets it go rather
231
+ * than retrying.
232
+ *
233
+ * @param {{ sourceKey: string, fileIndex: number, durationSeconds: number, zones: object[] }} params
234
+ * @returns {Promise<void>}
235
+ */
236
+ async setPriorityMap({ sourceKey, fileIndex, durationSeconds, zones }) {
237
+ if (!sourceKey) {
238
+ return;
239
+ }
240
+ await this.#client.setPriorityMap({ sourceKey, fileIndex, durationSeconds, zones });
241
+ }
242
+
243
+ /**
244
+ * Pre-fetch the head and tail the codec probe needs.
245
+ *
246
+ * Takes an options object, matching `TorrentPool.prefetchFileEdges` — this
247
+ * adapter exists to present that same interface. It previously declared
248
+ * positional parameters instead, so the planner's options object arrived as
249
+ * `headBytes` and only worked because it was passed along far enough to be
250
+ * destructured at the far end. Anyone calling it as documented got the
251
+ * defaults instead of the sizes they asked for.
252
+ *
253
+ * @param {object} torrent
254
+ * @param {number} fileIndex
255
+ * @param {{ headBytes?: number, tailBytes?: number, timeoutMs?: number }} [options]
256
+ * @returns {Promise<unknown>}
257
+ */
258
+ /**
259
+ * One byte range of one file, as bytes, on THIS thread.
260
+ *
261
+ * What the media layer is built from: a container takes `readRange(start,
262
+ * end)` and nothing else, so with this it can be parsed here instead of in
263
+ * the torrent thread. It used to be parsed there for one stated reason —
264
+ * "the main thread cannot open a read stream on one of its files", which is
265
+ * true of WebTorrent's own API and not of the bytes: the pieces live in
266
+ * shared memory and this read is the same one that serves every segment,
267
+ * so it waits for what has not arrived and steers the swarm toward it.
268
+ *
269
+ * **It COPIES, deliberately.** The zero-copy path — positions across the
270
+ * channel, the piece pinned until the far side says it is done — exists for
271
+ * 10 MB segments on the critical path, where the copy was measured at
272
+ * 18.84 ms. A container header is 64-256 KB and read once per file, about
273
+ * 0.12 ms, against a parse of 0.8 s and a swarm wait of up to a minute. The
274
+ * pinning protocol would buy nothing and is not on this path.
275
+ *
276
+ * @param {object} torrent
277
+ * @param {number} fileIndex
278
+ * @param {number} start - First byte, inclusive.
279
+ * @param {number} end - Last byte, inclusive.
280
+ * @returns {Promise<Buffer | null>} Null when the read failed or was cut
281
+ * short, which a container reads as "this file does not say".
282
+ */
283
+ /**
284
+ * The byte ranges of one file the torrent holds WHOLE.
285
+ *
286
+ * What the subtitle walk decides from: it may read only what is already
287
+ * downloaded, and a list taken once per pass replaces a question per cluster.
288
+ *
289
+ * @param {object} torrent
290
+ * @param {number} fileIndex
291
+ * @returns {Promise<Array<[number, number]>>}
292
+ */
293
+ async heldRangesOf(torrent, fileIndex) {
294
+ const sourceKey = torrent?.sourceKey;
295
+ return sourceKey ? this.#client.heldRanges({ sourceKey, fileIndex }) : [];
296
+ }
297
+
298
+ /**
299
+ * Bytes of a range the torrent already holds, never fetched.
300
+ *
301
+ * Not `readRangeOf`: that one declares demand and steers the swarm, which is
302
+ * right for a viewer waiting on a segment and wrong for a walk that must pull
303
+ * nothing the viewer is not waiting for.
304
+ *
305
+ * @param {object} torrent
306
+ * @param {number} fileIndex
307
+ * @param {number} start
308
+ * @param {number} end - Inclusive.
309
+ * @returns {Promise<Buffer | null>}
310
+ */
311
+ async readHeldOf(torrent, fileIndex, start, end) {
312
+ const sourceKey = torrent?.sourceKey;
313
+ return sourceKey ? this.#client.readHeld({ sourceKey, fileIndex, start, end }) : null;
314
+ }
315
+
316
+ async readRangeOf(torrent, fileIndex, start, end) {
317
+ const sourceKey = torrent?.sourceKey;
318
+ if (!sourceKey || !(end >= start) || !(start >= 0)) {
319
+ return null;
320
+ }
321
+ const stream = this.#client.createReadStream({ sourceKey, fileIndex, start, end });
322
+ const chunks = [];
323
+ let total = 0;
324
+ try {
325
+ const reader = stream.getReader();
326
+ for (;;) {
327
+ const { done, value } = await reader.read();
328
+ if (done) {
329
+ break;
330
+ }
331
+ chunks.push(Buffer.from(value));
332
+ total += value.length;
333
+ }
334
+ } catch {
335
+ return null;
336
+ }
337
+ return total > 0 ? Buffer.concat(chunks, total) : null;
338
+ }
339
+
340
+ async prefetchFileEdges(torrent, fileIndex, options = {}) {
341
+ const sourceKey = torrent?.sourceKey;
342
+ if (!sourceKey) {
343
+ return null;
344
+ }
345
+ return this.#client.prefetchFileEdges({ sourceKey, fileIndex, options });
346
+ }
347
+
348
+ /**
349
+ * Which films this proxy holds right now, and how much of each.
350
+ *
351
+ * What content affinity is decided from: a viewer of a film somebody here is
352
+ * already downloading costs this proxy the encode and nothing else, while the
353
+ * same viewer sent anywhere else starts the download from nothing.
354
+ *
355
+ * @returns {Promise<{ infoHash: string, progress: number, bytes: number }[]>}
356
+ */
357
+ async heldTorrents() {
358
+ const answer = await this.#client.heldTorrents();
359
+ return Array.isArray(answer?.held) ? answer.held : [];
360
+ }
361
+
362
+ /**
363
+ * Shut the torrent client down and stop the thread.
364
+ *
365
+ * @returns {Promise<void>}
366
+ */
367
+ async destroyAll() {
368
+ this.#torrents.clear();
369
+ await this.#client.destroyAll();
370
+ }
371
+ }