@torrent-tv/proxy 2.89.1 → 2.89.2

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 (442) 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 +6 -1
  13. package/CHANGELOG.md +2299 -2288
  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 +729 -729
  23. package/docs/encode-run-state.md +96 -96
  24. package/docs/logs.md +97 -97
  25. package/docs/playback-start-forecast.md +42 -8
  26. package/docs/socks5-egress-research.md +114 -114
  27. package/docs/storage-architecture.md +267 -267
  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 +380 -380
  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/services/encode/CoverageMap.js +428 -428
  104. package/services/encode/CushionReport.js +345 -345
  105. package/services/encode/EncodeAdmission.js +376 -376
  106. package/services/encode/EncodeOrchestrator.js +1217 -1217
  107. package/services/encode/EncodePlan.js +1366 -1366
  108. package/services/encode/EncodeRun.js +813 -813
  109. package/services/encode/Encoder.js +142 -142
  110. package/services/encode/EncoderSelection.js +38 -38
  111. package/services/encode/LocalObservations.js +359 -359
  112. package/services/encode/NvencEncoder.js +50 -50
  113. package/services/encode/OutputTimes.js +579 -579
  114. package/services/encode/QsvEncoder.js +58 -58
  115. package/services/encode/Renditions.js +2282 -2282
  116. package/services/encode/RunProgress.js +84 -84
  117. package/services/encode/SegmentDemand.js +95 -95
  118. package/services/encode/SoftwareEncoder.js +121 -121
  119. package/services/encode/V4l2m2mEncoder.js +53 -53
  120. package/services/encode/VaapiEncoder.js +66 -66
  121. package/services/encode/args.js +418 -418
  122. package/services/encode/available-share.js +89 -89
  123. package/services/encode/calibration.js +361 -361
  124. package/services/encode/contention.js +128 -128
  125. package/services/encode/decode-cost-fit.js +363 -363
  126. package/services/encode/encode-exit.js +114 -114
  127. package/services/encode/encode-run-state.js +551 -551
  128. package/services/encode/encoder-readings.js +45 -45
  129. package/services/encode/fingerprint.js +322 -322
  130. package/services/encode/host-load.js +174 -174
  131. package/services/encode/index.js +9 -9
  132. package/services/encode/learned-median.js +90 -90
  133. package/services/encode/output/EncodedOutput.js +57 -57
  134. package/services/encode/output/Output.js +131 -131
  135. package/services/encode/output/OutputCatalog.js +414 -414
  136. package/services/encode/output/OutputSpec.js +390 -390
  137. package/services/encode/output/Timeline.js +308 -308
  138. package/services/encode/output/cut-grid.js +107 -107
  139. package/services/encode/output/ladder.js +32 -32
  140. package/services/encode/output/playlists.js +284 -284
  141. package/services/encode/output/rates.js +125 -125
  142. package/services/encode/output-key-format.js +21 -21
  143. package/services/encode/quality/HostLoad.js +525 -525
  144. package/services/encode/quality/HostTimings.js +249 -249
  145. package/services/encode/quality/OutputQualityState.js +28 -28
  146. package/services/encode/quality/QualityController.js +935 -935
  147. package/services/encode/quality/QualityOffer.js +416 -416
  148. package/services/encode/quality/drain-threat.js +47 -47
  149. package/services/encode/quality/link-budget.js +349 -349
  150. package/services/encode/quality/output-format.js +319 -319
  151. package/services/encode/quality/serving-output.js +216 -216
  152. package/services/encode/quality/visible-rung.js +57 -57
  153. package/services/encode/run-budget.js +97 -97
  154. package/services/encode/run-costs.js +155 -155
  155. package/services/encode/run-inputs.js +42 -42
  156. package/services/encode/segment-formats/fmp4.js +476 -458
  157. package/services/encode/segment-formats/index.js +103 -85
  158. package/services/encode/segment-formats/init-compat.js +324 -324
  159. package/services/encode/segment-formats/mp4-boxes.js +604 -541
  160. package/services/encode/segment-formats/mpegts.js +134 -134
  161. package/services/encode/start-stop-cost.js +178 -178
  162. package/services/encode/throughput.js +97 -97
  163. package/services/encode/torrent-cost.js +88 -88
  164. package/services/identity/installation-id.js +38 -38
  165. package/services/media/SourceFile.js +298 -298
  166. package/services/media/SubtitleOrchestrator.js +167 -167
  167. package/services/media/container/KeyframeTable.js +272 -272
  168. package/services/media/container/ebml-reader.js +159 -159
  169. package/services/media/ffmpeg-banner.js +260 -260
  170. package/services/media/keyframe-probe.js +157 -157
  171. package/services/media/media-info-probe.js +93 -93
  172. package/services/media/playback-planner.js +931 -931
  173. package/services/media/tracks/AudioTrack.js +143 -143
  174. package/services/media/tracks/ImageSubtitleTrack.js +19 -19
  175. package/services/media/tracks/SubtitleTrack.js +38 -38
  176. package/services/media/tracks/VideoTrack.js +33 -33
  177. package/services/media/tracks/audio-bound.js +233 -233
  178. package/services/media/tracks/index.js +15 -15
  179. package/services/media/tracks/language-detect.js +174 -174
  180. package/services/server/OutputLifecycle.js +418 -418
  181. package/services/server/SegmentServing.js +1150 -1150
  182. package/services/server/ViewerRequests.js +790 -786
  183. package/services/server/WaitLedger.js +142 -142
  184. package/services/server/controllers/PlaybackController.js +40 -40
  185. package/services/server/controllers/SubtitleController.js +109 -109
  186. package/services/server/http-responses.js +60 -60
  187. package/services/server/transcode-session-files.js +325 -325
  188. package/services/server/wire-outputs.js +1024 -1020
  189. package/services/storage/Diagnostics.js +202 -202
  190. package/services/storage/MachineBudget.js +235 -235
  191. package/services/storage/allowance.js +107 -107
  192. package/services/storage/core-dumps.js +106 -106
  193. package/services/storage/files/CompletedFiles.js +391 -391
  194. package/services/storage/files/piece-from-whole-file.js +118 -118
  195. package/services/storage/free.js +71 -71
  196. package/services/storage/keep.js +48 -48
  197. package/services/storage/machine-memory.js +56 -56
  198. package/services/storage/memory-report.js +575 -575
  199. package/services/storage/piece-store/piece-disk-store.js +539 -539
  200. package/services/storage/piece-store/piece-lru.js +495 -495
  201. package/services/storage/returns.js +103 -103
  202. package/services/storage/segment-store/SegmentStore.js +1255 -1255
  203. package/services/storage/wire.js +175 -175
  204. package/services/torrent/demand/DemandRegister.js +202 -202
  205. package/services/torrent/demand/Urgency.js +137 -137
  206. package/services/torrent/demand/Window.js +118 -118
  207. package/services/torrent/demand/index.js +8 -8
  208. package/services/torrent/demand/pieces.js +140 -140
  209. package/services/torrent/download/SwarmSelection.js +386 -386
  210. package/services/torrent/download/registry.js +102 -102
  211. package/services/torrent/download/withdraw-claim.js +80 -80
  212. package/services/torrent/files.js +455 -455
  213. package/services/torrent/naming.js +619 -619
  214. package/services/torrent/piece-store-of.js +29 -29
  215. package/services/torrent/supply-margin.js +262 -262
  216. package/services/torrent/worker/background-fill.js +213 -213
  217. package/services/torrent/worker/channel.js +271 -271
  218. package/services/torrent/worker/client.js +836 -836
  219. package/services/torrent/worker/fastest-wires.js +342 -342
  220. package/services/torrent/worker/handle-state.js +23 -23
  221. package/services/torrent/worker/install-webrtc-shim.js +32 -32
  222. package/services/torrent/worker/piece-reader.js +1078 -1078
  223. package/services/torrent/worker/pool-adapter.js +371 -371
  224. package/services/torrent/worker/protocol.js +184 -184
  225. package/services/torrent/worker/resume-warm.js +107 -107
  226. package/services/torrent/worker/webrtc-shim.js +219 -219
  227. package/services/transport/delivery-probe.js +842 -842
  228. package/services/transport/health-collector.js +53 -53
  229. package/services/transport/nat-classifier.js +231 -231
  230. package/services/transport/packet-witness.js +808 -808
  231. package/services/transport/port-mapper.js +235 -235
  232. package/services/transport/registry-api.js +81 -81
  233. package/services/transport/tunnel-client.js +447 -447
  234. package/services/transport/usrsctp-state.js +175 -175
  235. package/services/transport/webrtc-manager.js +484 -484
  236. package/services/viewer/Assignments.js +340 -340
  237. package/services/viewer/PriorityOrchestrator.js +325 -325
  238. package/services/viewer/Viewer.js +691 -691
  239. package/services/viewer/Viewers.js +368 -368
  240. package/services/viewer/active-output.js +37 -37
  241. package/services/viewer/audio-start.js +46 -46
  242. package/services/viewer/buffer-trend.js +81 -81
  243. package/services/viewer/choices.js +647 -647
  244. package/services/viewer/media-time.js +355 -0
  245. package/services/{server → viewer}/playback-readiness.js +635 -516
  246. package/services/viewer/positions.js +126 -126
  247. package/services/viewer/report-intake.js +46 -46
  248. package/store/source-registry.js +71 -71
  249. package/test/asset-paths.test.js +28 -28
  250. package/test/audio-buffer-continuity.test.js +77 -70
  251. package/test/audio-inventory.test.js +212 -212
  252. package/test/audio-track-bitrate.test.js +40 -40
  253. package/test/auto-quality-step.test.js +707 -707
  254. package/test/available-share.test.js +76 -76
  255. package/test/background-fill.test.js +190 -190
  256. package/test/client-log-file.test.js +110 -110
  257. package/test/completed-files.test.js +115 -115
  258. package/test/concurrent-cost.test.js +148 -148
  259. package/test/container-media-info.test.js +228 -228
  260. package/test/contention.test.js +76 -76
  261. package/test/core-dumps.test.js +57 -57
  262. package/test/coverage-follows-the-disk.test.js +228 -228
  263. package/test/coverage-map.test.js +195 -195
  264. package/test/cue-push-carries-what-the-walk-found.test.js +58 -58
  265. package/test/cut-times-timeline.test.js +65 -65
  266. package/test/cuts-follow-published-grid.test.js +109 -109
  267. package/test/data-channel-frame.test.js +63 -63
  268. package/test/data-channel-viewer-lifecycle.test.js +92 -92
  269. package/test/dead-torrent-handle.test.js +52 -52
  270. package/test/declared-rates.test.js +116 -116
  271. package/test/declared-tracks.test.js +43 -43
  272. package/test/decode-cost-fit.test.js +202 -202
  273. package/test/decode-cost.test.js +462 -462
  274. package/test/delivery-probe.test.js +393 -393
  275. package/test/demand-register.test.js +206 -206
  276. package/test/dht-bootstrap.test.js +72 -72
  277. package/test/drain-threat.test.js +65 -65
  278. package/test/duplicate-add.test.js +48 -48
  279. package/test/encode-admission.test.js +146 -146
  280. package/test/encode-cost.test.js +283 -283
  281. package/test/encode-exit.test.js +111 -111
  282. package/test/encode-orchestrator.test.js +419 -419
  283. package/test/encode-plan-viewers.test.js +718 -718
  284. package/test/encode-plan.test.js +545 -545
  285. package/test/encode-run-state.test.js +314 -314
  286. package/test/encode-run.test.js +162 -162
  287. package/test/encode-slope.test.js +46 -46
  288. package/test/encoded-output.test.js +39 -39
  289. package/test/encoder-kinds.test.js +122 -122
  290. package/test/encoder-readings.test.js +46 -46
  291. package/test/every-claimant-is-told-its-share.test.js +152 -152
  292. package/test/failed-encoder-still-serves-what-exists.test.js +354 -354
  293. package/test/failed-start-breaker.test.js +202 -202
  294. package/test/fastest-wires.test.js +143 -143
  295. package/test/ffmpeg-stream-counts.test.js +78 -78
  296. package/test/file-edges.test.js +191 -191
  297. package/test/fmp4-presentation-clock.test.js +146 -162
  298. package/test/fmp4-self-contained.test.js +80 -80
  299. package/test/fmp4-timestamps.test.js +140 -140
  300. package/test/fmp4-track-completeness.test.js +41 -41
  301. package/test/format-keyed-outputs.test.js +78 -78
  302. package/test/health-metrics.test.js +38 -38
  303. package/test/held-request-width.test.js +157 -157
  304. package/test/helpers/encode-run.js +136 -136
  305. package/test/helpers/manager.js +57 -57
  306. package/test/helpers/output-spec.js +63 -63
  307. package/test/host-load.test.js +68 -68
  308. package/test/index-accuracy-is-about-the-file.test.js +128 -128
  309. package/test/init-compat.test.js +219 -219
  310. package/test/input-lost-quiets-the-plan.test.js +261 -261
  311. package/test/input-unavailable.test.js +48 -48
  312. package/test/installation-id.test.js +39 -39
  313. package/test/keeping-period.test.js +83 -83
  314. package/test/keyframe-index-accuracy.test.js +188 -188
  315. package/test/keyframes-belong-to-the-file.test.js +249 -249
  316. package/test/learned-median.test.js +37 -37
  317. package/test/letting-go-asks-who-is-watching.test.js +191 -191
  318. package/test/limit-row-by-area.test.js +60 -60
  319. package/test/link-budget.test.js +112 -112
  320. package/test/link-probe.test.js +56 -56
  321. package/test/local-encoding-data.test.js +273 -273
  322. package/test/logger-repeats.test.js +134 -134
  323. package/test/look-ahead-coverage.test.js +56 -56
  324. package/test/manager-surface.test.js +292 -292
  325. package/test/matroska-cues-track.test.js +192 -192
  326. package/test/media-time.test.js +62 -0
  327. package/test/memory-budget.test.js +390 -390
  328. package/test/move-cost.test.js +216 -216
  329. package/test/mp4-subtitles.test.js +173 -173
  330. package/test/one-authority.test.js +285 -285
  331. package/test/one-budget.test.js +149 -149
  332. package/test/one-resource-divided.test.js +185 -185
  333. package/test/one-serving-output-per-height.test.js +458 -458
  334. package/test/orchestrator-wired.test.js +206 -206
  335. package/test/output-catalog.test.js +39 -39
  336. package/test/output-shape.test.js +21 -21
  337. package/test/output-spec.test.js +251 -251
  338. package/test/output-speed.test.js +88 -88
  339. package/test/outputs-being-prepared.test.js +40 -40
  340. package/test/packet-witness-ring.test.js +236 -236
  341. package/test/packet-witness.test.js +148 -148
  342. package/test/piece-disk-store.test.js +401 -401
  343. package/test/piece-from-whole-file.test.js +129 -129
  344. package/test/piece-lru.test.js +319 -319
  345. package/test/piece-reader.test.js +162 -162
  346. package/test/piece-selection-offset.test.js +85 -85
  347. package/test/piece-store-eviction.test.js +595 -595
  348. package/test/piece-store-never-refuses.test.js +153 -153
  349. package/test/piece-store-reservations.test.js +403 -403
  350. package/test/piece-store-slow-disk.test.js +159 -159
  351. package/test/piece-tail.test.js +97 -97
  352. package/test/plan-host-timings.test.js +68 -68
  353. package/test/plan-is-steady.test.js +225 -225
  354. package/test/playback-readiness.test.js +518 -483
  355. package/test/playback-start-regressions.test.js +101 -99
  356. package/test/priority-map-download.test.js +174 -174
  357. package/test/priority-map-emptied.test.js +204 -204
  358. package/test/priority-map-per-output.test.js +215 -215
  359. package/test/priority-map.test.js +163 -163
  360. package/test/probe-wedge-certainty.test.js +60 -60
  361. package/test/produced-copy-choice.test.js +213 -213
  362. package/test/published-timeline.test.js +83 -83
  363. package/test/quality-offer.test.js +162 -162
  364. package/test/quality-variants.test.js +1257 -1257
  365. package/test/rate-control-in-the-output.test.js +180 -180
  366. package/test/read-survives-withdrawal.test.js +164 -164
  367. package/test/read-window.test.js +365 -365
  368. package/test/resume-warm.test.js +39 -39
  369. package/test/run-graph-drift.test.js +37 -37
  370. package/test/run-inputs.test.js +80 -80
  371. package/test/run-intervals.test.js +100 -100
  372. package/test/run-position-follows-published-grid.test.js +89 -89
  373. package/test/run-progress.test.js +65 -65
  374. package/test/same-height-switch.test.js +664 -664
  375. package/test/seek-frees-the-viewers-requests.test.js +217 -217
  376. package/test/seek-landing.test.js +109 -109
  377. package/test/seek-target-not-superseded.test.js +195 -195
  378. package/test/segment-closed-on-both-branches.test.js +96 -96
  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-judged-by-its-own-header.test.js +221 -221
  383. package/test/segment-store-eviction.test.js +247 -247
  384. package/test/segment-store.test.js +352 -352
  385. package/test/segment-true-start.test.js +86 -86
  386. package/test/segments-are-shared.test.js +176 -176
  387. package/test/send-chunk-bytes.test.js +86 -86
  388. package/test/serving-existing-output.test.js +105 -105
  389. package/test/serving-output.test.js +102 -102
  390. package/test/shared-piece-store.test.js +310 -310
  391. package/test/sidecar-naming.test.js +142 -142
  392. package/test/soundtrack-rate-bound.test.js +289 -289
  393. package/test/source-file.test.js +133 -133
  394. package/test/source-registry.test.js +18 -18
  395. package/test/split-a-stretch.test.js +139 -139
  396. package/test/stale-request-after-seek.test.js +158 -158
  397. package/test/startup-readings.test.js +124 -124
  398. package/test/stream-route.test.js +209 -209
  399. package/test/subtitle-cue-framing.test.js +200 -200
  400. package/test/subtitle-cue-source.test.js +102 -102
  401. package/test/subtitle-cursor.test.js +63 -63
  402. package/test/subtitle-defaults.test.js +118 -118
  403. package/test/subtitle-language.test.js +252 -252
  404. package/test/supply-margin.test.js +177 -177
  405. package/test/swarm-follows-readers.test.js +174 -174
  406. package/test/swarm-reach.test.js +130 -130
  407. package/test/swarm-selection.test.js +220 -220
  408. package/test/tail-duplication.test.js +167 -167
  409. package/test/the-channel-has-both-ends.test.js +91 -91
  410. package/test/the-torrent-thread-serves-bytes.test.js +107 -107
  411. package/test/thread-pool.test.js +53 -53
  412. package/test/timeline.test.js +84 -84
  413. package/test/torrent-contents.test.js +235 -235
  414. package/test/torrent-cost.test.js +71 -71
  415. package/test/torrent-files.test.js +221 -221
  416. package/test/torrent-naming.test.js +255 -255
  417. package/test/tracks-begin-together.test.js +209 -209
  418. package/test/tunnel-renewal.test.js +167 -167
  419. package/test/two-viewers-one-picture.test.js +504 -504
  420. package/test/upload-hurry.test.js +186 -186
  421. package/test/usrsctp-state.test.js +131 -131
  422. package/test/video-facts.test.js +102 -102
  423. package/test/viewer-assignments.test.js +143 -143
  424. package/test/viewer-outputs.test.js +285 -285
  425. package/test/viewer-presence.test.js +116 -116
  426. package/test/viewer-requests-admission.test.js +89 -89
  427. package/test/viewer-states.test.js +189 -189
  428. package/test/viewer-subtitle-subscription.test.js +96 -96
  429. package/test/viewer.test.js +139 -139
  430. package/test/viewing-generations.test.js +390 -390
  431. package/test/visible-rung.test.js +37 -37
  432. package/test/wait-ledger.test.js +100 -100
  433. package/test/webrtc-shim.test.js +149 -149
  434. package/test/wedge-certainty.test.js +131 -131
  435. package/test/whole-file-held-read.test.js +30 -30
  436. package/test/withdraw-piece-claim.test.js +212 -212
  437. package/test/worker-channel.test.js +158 -158
  438. package/utils/client-log-file.js +151 -151
  439. package/utils/logger.js +312 -312
  440. package/utils/parse-range.js +25 -25
  441. package/utils/perf.js +59 -59
  442. package/utils/torrent-source-key.js +38 -38
@@ -1,447 +1,447 @@
1
- /**
2
- * @file Outbound WebSocket tunnel from the proxy to the registry server.
3
- *
4
- * The proxy opens one persistent connection on startup. Through it the
5
- * server can:
6
- * - relay browser HTTP requests to the proxy's local Fastify server, and
7
- * - forward WebRTC signalling messages (offers, ICE candidates) between
8
- * the browser and the proxy's WebRTC manager.
9
- *
10
- * The tunnel reconnects automatically with a fixed back-off after any
11
- * unexpected close.
12
- */
13
-
14
- import { WebSocket } from "ws";
15
-
16
- /** @import { HealthMetrics } from './health-collector.js' */
17
-
18
- /**
19
- * Configuration for the tunnel client.
20
- *
21
- * @typedef {Object} TunnelClientOptions
22
- * @property {string} serverUrl
23
- * Base URL of the registry server (http or https — converted to ws/wss automatically).
24
- * @property {string} proxyId
25
- * Stable ID used to identify this proxy on the server.
26
- * @property {string} token
27
- * Auth token sent as the `x-proxy-id` / `x-proxy-token` headers during the WS handshake.
28
- * @property {number} proxyPort
29
- * Local port the proxy's Fastify server is listening on.
30
- * @property {(sessionId: string, signal: WebRtcSignal) => void} [onSignal]
31
- * Called when the server forwards a WebRTC signal (SDP offer or ICE candidate)
32
- * from a browser to this proxy. `sessionId` scopes the signal to a P2P session.
33
- * @property {() => void} [onConnect]
34
- * Called each time the WebSocket connection becomes open (including reconnects).
35
- * Use to re-register the proxy so the server's in-memory store stays consistent
36
- * after server restarts.
37
- * @property {(mediaInfo: object) => { copy: number[], transcode: number[] } | null} [onCanServeRequest]
38
- * Called when the server asks whether this host could sustain a file it has
39
- * been DESCRIBED — height, rate, bitrate, codec — rather than one it holds.
40
- * Answered from this host's startup benchmarks alone: no torrent is added, no
41
- * bytes are fetched and ffmpeg is not run, so it costs milliseconds and can
42
- * be asked of every proxy in the pool at once.
43
- * @property {() => HealthMetrics} [onHealthRequest]
44
- * Called when the server sends a `health-request` message. The return value is
45
- * sent back as `health-response` and used by the server to score this proxy.
46
- * @property {(message: string) => void} [onLog]
47
- * Optional structured log sink.
48
- */
49
-
50
- /**
51
- * A single WebRTC signal message forwarded through the tunnel.
52
- *
53
- * @typedef {Object} WebRtcSignal
54
- * @property {string} type - Signal kind: "offer" | "answer" | "candidate".
55
- * @property {string} [sdp] - SDP string (for "offer" and "answer").
56
- * @property {string} [candidate] - ICE candidate string (for "candidate").
57
- * @property {string} [mid] - SDP media ID associated with the candidate.
58
- */
59
-
60
- /**
61
- * A relay request sent by the server — asking the proxy to perform a local
62
- * HTTP fetch and stream the response back through the tunnel.
63
- *
64
- * @typedef {Object} TunnelRelayRequest
65
- * @property {string} requestId - Unique ID that ties request → response chunks.
66
- * @property {string} method - HTTP method (GET, POST, etc.).
67
- * @property {string} path - Request path on the local proxy (e.g. "/health").
68
- * @property {string} query - Raw query string without the leading "?".
69
- * @property {Record<string, string>} headers - Headers forwarded from the browser.
70
- * @property {string | null} body - Serialised request body, or null.
71
- */
72
-
73
- /**
74
- * The object returned by {@link createTunnelClient}.
75
- *
76
- * @typedef {Object} TunnelClient
77
- * @property {() => void} connect - Open the tunnel; reconnects on drop.
78
- * @property {() => void} disconnect - Close the tunnel; suppresses reconnects.
79
- * @property {(sessionId: string, signal: WebRtcSignal) => void} sendSignal
80
- * Send a WebRTC signal (answer / candidate) back to the browser.
81
- * @property {(endpoint: { externalIp: string | null, externalPort: number, protocol: string }) => void} sendEndpoint
82
- * Report this proxy's UPnP-mapped external endpoint to the server so it can
83
- * dial back and verify reachability.
84
- */
85
-
86
- const RECONNECT_DELAY_MS = 5_000;
87
- /** Send a keepalive ping every 30 s to prevent Cloudflare's idle WebSocket timeout (~100 s). */
88
- const KEEPALIVE_INTERVAL_MS = 30_000;
89
- /**
90
- * Replace the connection before anything upstream ends it for us.
91
- *
92
- * Something between this process and the server closes the socket after
93
- * exactly **100 min 15 s**, whatever is flowing over it. It is not an idle
94
- * timeout — the keepalive above has been running for months — it is a lifetime
95
- * cap. Measured across one day of logs (2026-08-20): 01:54:12 → 03:34:27 →
96
- * ... the same 100:15 apart wherever a restart did not reset the clock, and
97
- * with `code=1006`, an abrupt close with no closing handshake, which is what an
98
- * intermediary killing a connection looks like.
99
- *
100
- * Reconnecting after the fact costs 5 s during which this proxy does not exist
101
- * as far as the registry is concerned, and a viewer arriving in that window is
102
- * told there is no proxy. So the connection is replaced BEFORE the cap, and the
103
- * replacement is seamless: the new socket registers itself with the server,
104
- * which atomically supersedes the old one, and only then does the old one
105
- * close. There is no moment with nothing registered.
106
- *
107
- * Ninety minutes leaves ten minutes of margin against a cap that has been
108
- * exact, and makes the replacement a quiet event rather than a race.
109
- */
110
- const CONNECTION_LIFETIME_MS = 90 * 60_000;
111
-
112
- /**
113
- * Create and manage the outbound WebSocket tunnel to the registry server.
114
- *
115
- * @param {TunnelClientOptions} options
116
- * @returns {TunnelClient}
117
- */
118
- export function createTunnelClient({
119
- serverUrl,
120
- proxyId,
121
- token,
122
- proxyPort,
123
- onSignal,
124
- onConnect,
125
- onHealthRequest,
126
- onCanServeRequest,
127
- onLog,
128
- connectionLifetimeMs = CONNECTION_LIFETIME_MS
129
- }) {
130
- const wsUrl = serverUrl.replace(/^http/, "ws").replace(/\/+$/, "") + "/ws/proxy-tunnel";
131
-
132
- /** @type {WebSocket | null} */
133
- let socket = null;
134
- /** @type {ReturnType<typeof setTimeout> | null} */
135
- let reconnectTimer = null;
136
- /**
137
- * The renewal that will replace the live connection before the upstream cap
138
- * ends it. Owned by the connection it belongs to, and cancelled with it.
139
- *
140
- * @type {ReturnType<typeof setTimeout> | null}
141
- */
142
- let renewalTimer = null;
143
- let stopped = false;
144
-
145
- /**
146
- * Write a message to the log sink if one was provided.
147
- *
148
- * @param {string} message
149
- * @returns {void}
150
- */
151
- function log(message) {
152
- if (typeof onLog === "function") {
153
- onLog(message);
154
- }
155
- }
156
-
157
- /**
158
- * Open a new WebSocket connection to the server.
159
- * Automatically schedules a reconnect after any unintentional close.
160
- *
161
- * @returns {void}
162
- */
163
- function connect() {
164
- if (stopped) {
165
- return;
166
- }
167
- log(`Connecting tunnel to ${wsUrl}`);
168
-
169
- // The connection being opened, held separately from `socket` so that a
170
- // socket which has been SUPERSEDED can still recognise itself. During a
171
- // renewal two exist for a moment, and the old one's close must not be
172
- // mistaken for the tunnel going down.
173
- const connection = new WebSocket(wsUrl, {
174
- headers: {
175
- "x-proxy-id": proxyId,
176
- "x-proxy-token": token,
177
- "user-agent": "torrent-tv-proxy/1.0"
178
- }
179
- });
180
- /** @type {ReturnType<typeof setInterval> | null} */
181
- let keepaliveTimer = null;
182
- socket = connection;
183
-
184
- connection.addEventListener("open", () => {
185
- log("Tunnel connected.");
186
- // Start keepalive pings to prevent Cloudflare's idle WebSocket timeout.
187
- keepaliveTimer = setInterval(() => {
188
- if (connection.readyState === WebSocket.OPEN) {
189
- send({ type: "ping" }, connection);
190
- }
191
- }, KEEPALIVE_INTERVAL_MS);
192
- // And replace this connection before the upstream lifetime cap does.
193
- if (renewalTimer !== null) {
194
- clearTimeout(renewalTimer);
195
- }
196
- renewalTimer = setTimeout(() => {
197
- if (stopped || socket !== connection) {
198
- return;
199
- }
200
- log("Tunnel renewing before the upstream lifetime cap; the replacement takes over first.");
201
- connect();
202
- }, connectionLifetimeMs);
203
- if (typeof onConnect === "function") {
204
- onConnect();
205
- }
206
- });
207
-
208
- connection.addEventListener("message", (event) => {
209
- let message;
210
- try {
211
- message = JSON.parse(event.data);
212
- } catch {
213
- return;
214
- }
215
-
216
- if (message.type === "request") {
217
- void handleRelayRequest(message).catch((error) => {
218
- log(`Tunnel relay error: ${error?.message ?? error}`);
219
- });
220
- return;
221
- }
222
-
223
- // WebRTC signalling: server forwards a signal from a browser session.
224
- if (message.type === "signal") {
225
- if (typeof message.sessionId === "string" && message.signal && typeof onSignal === "function") {
226
- onSignal(message.sessionId, message.signal);
227
- }
228
- return;
229
- }
230
-
231
- // Could this host serve a file it is only told ABOUT? Asked when the
232
- // proxy a viewer landed on has refused the file, so the browser can be
233
- // sent somewhere that will work instead of being shown an error. The
234
- // description travels because the refusing proxy has already probed the
235
- // file: the expensive half is done once, and every other proxy answers
236
- // by arithmetic.
237
- if (message.type === "can-serve-request") {
238
- let offer = null;
239
- try {
240
- offer = typeof onCanServeRequest === "function"
241
- ? onCanServeRequest(message.mediaInfo ?? {})
242
- : null;
243
- } catch {
244
- // silent-ok: an unanswerable question is answered "no", which is what
245
- // a null offer means to the caller.
246
- }
247
- send({ type: "can-serve-response", requestId: message.requestId, offer });
248
- return;
249
- }
250
-
251
- // Health check: server requests current metrics for proxy scoring.
252
- if (message.type === "health-request") {
253
- // Awaited: the answer now carries which films this proxy holds, and the
254
- // truthful list of those lives on the torrent thread.
255
- void (async () => {
256
- let answer = {};
257
- try {
258
- answer = typeof onHealthRequest === "function" ? await onHealthRequest() : {};
259
- } catch {
260
- // silent-ok: a proxy that cannot describe itself is scored on
261
- // nothing rather than not answered at all, which would drop it out
262
- // of every selection until the next poll.
263
- }
264
- send({
265
- type: "health-response",
266
- requestId: message.requestId,
267
- metrics: answer?.metrics ?? answer ?? {},
268
- holds: Array.isArray(answer?.holds) ? answer.holds : []
269
- });
270
- })();
271
- return;
272
- }
273
- });
274
-
275
- connection.addEventListener("close", (event) => {
276
- if (keepaliveTimer !== null) {
277
- clearInterval(keepaliveTimer);
278
- keepaliveTimer = null;
279
- }
280
- // A connection this one replaced. The server closes it as soon as the
281
- // replacement registers, which is the whole point of renewing early —
282
- // there is nothing to report and nothing to reconnect, because the tunnel
283
- // never went down.
284
- if (socket !== connection) {
285
- log(`Tunnel handed over (code=${event.code}); the replacement is already carrying it.`);
286
- return;
287
- }
288
- log(`Tunnel disconnected (code=${event.code}). Reconnecting in ${RECONNECT_DELAY_MS}ms...`);
289
- socket = null;
290
- if (renewalTimer !== null) {
291
- clearTimeout(renewalTimer);
292
- renewalTimer = null;
293
- }
294
- if (!stopped) {
295
- reconnectTimer = setTimeout(connect, RECONNECT_DELAY_MS);
296
- }
297
- });
298
-
299
- connection.addEventListener("error", (event) => {
300
- log(`Tunnel WebSocket error: ${event.message ?? "unknown"}`);
301
- });
302
- }
303
-
304
- /**
305
- * Fetch a resource from the local Fastify server and stream the response
306
- * back to the registry server chunk-by-chunk over the WebSocket.
307
- *
308
- * @param {TunnelRelayRequest} relayRequest
309
- * @returns {Promise<void>}
310
- */
311
- async function handleRelayRequest(relayRequest) {
312
- const { requestId, method, path, query, headers: forwardedHeaders, body } = relayRequest;
313
- const targetUrl = `http://127.0.0.1:${proxyPort}${path}` + (query ? `?${query}` : "");
314
- const requestHeaders = { ...(forwardedHeaders ?? {}), host: `127.0.0.1:${proxyPort}` };
315
-
316
- let response;
317
- try {
318
- response = await fetch(targetUrl, {
319
- method,
320
- headers: requestHeaders,
321
- body: body != null ? body : undefined,
322
- redirect: "manual"
323
- });
324
- } catch (fetchError) {
325
- sendError(requestId, fetchError?.message ?? String(fetchError));
326
- return;
327
- }
328
-
329
- /** @type {Record<string, string>} */
330
- const responseHeaders = {};
331
- for (const [headerName, headerValue] of response.headers.entries()) {
332
- responseHeaders[headerName] = headerValue;
333
- }
334
-
335
- send({ type: "response-start", requestId, status: response.status, headers: responseHeaders });
336
-
337
- if (!response.body) {
338
- send({ type: "response-chunk", requestId, data: "", done: true });
339
- return;
340
- }
341
-
342
- try {
343
- const reader = response.body.getReader();
344
- while (true) {
345
- const { done, value } = await reader.read();
346
- if (done) {
347
- send({ type: "response-chunk", requestId, data: "", done: true });
348
- break;
349
- }
350
- send({
351
- type: "response-chunk",
352
- requestId,
353
- data: Buffer.from(value).toString("base64"),
354
- done: false
355
- });
356
- }
357
- } catch {
358
- send({ type: "response-chunk", requestId, data: "", done: true });
359
- }
360
- }
361
-
362
- /**
363
- * Serialise a message to JSON and send it through the WebSocket if open.
364
- *
365
- * @param {object} message
366
- * @returns {void}
367
- */
368
- function send(message, over = null) {
369
- // Everything the proxy has to say goes over the LIVE connection. `over` is
370
- // for the one thing that belongs to a particular socket rather than to the
371
- // tunnel — its own keepalive — which must not be sent over a replacement
372
- // that has already taken over.
373
- const target = over ?? socket;
374
- if (target && target.readyState === WebSocket.OPEN) {
375
- target.send(JSON.stringify(message));
376
- }
377
- }
378
-
379
- /**
380
- * Send a `response-error` frame for a given relay request.
381
- *
382
- * @param {string} requestId
383
- * @param {string} errorMessage
384
- * @returns {void}
385
- */
386
- function sendError(requestId, errorMessage) {
387
- send({ type: "response-error", requestId, error: errorMessage });
388
- }
389
-
390
- return {
391
- /**
392
- * Start the tunnel. Connects immediately and auto-reconnects on drop.
393
- *
394
- * @returns {void}
395
- */
396
- connect() {
397
- stopped = false;
398
- connect();
399
- },
400
-
401
- /**
402
- * Tear down the tunnel. Closes the current connection and prevents
403
- * any future reconnect attempts.
404
- *
405
- * @returns {void}
406
- */
407
- disconnect() {
408
- stopped = true;
409
- if (renewalTimer !== null) {
410
- clearTimeout(renewalTimer);
411
- renewalTimer = null;
412
- }
413
- if (reconnectTimer != null) {
414
- clearTimeout(reconnectTimer);
415
- reconnectTimer = null;
416
- }
417
- if (socket) {
418
- socket.close(1000, "shutdown");
419
- socket = null;
420
- }
421
- },
422
-
423
- /**
424
- * Forward a WebRTC signal (SDP answer or ICE candidate) from this proxy
425
- * to the browser via the server tunnel.
426
- *
427
- * @param {string} sessionId - Scopes the signal to a single P2P session.
428
- * @param {WebRtcSignal} signal
429
- * @returns {void}
430
- */
431
- sendSignal(sessionId, signal) {
432
- send({ type: "signal", sessionId, signal });
433
- },
434
-
435
- /**
436
- * Report this proxy's UPnP-mapped external endpoint to the server.
437
- * No-op if the tunnel is not currently open (the caller re-sends on
438
- * connect / reconnect).
439
- *
440
- * @param {{ externalIp: string | null, externalPort: number, protocol: string }} endpoint
441
- * @returns {void}
442
- */
443
- sendEndpoint(endpoint) {
444
- send({ type: "proxy-endpoint", endpoint });
445
- }
446
- };
447
- }
1
+ /**
2
+ * @file Outbound WebSocket tunnel from the proxy to the registry server.
3
+ *
4
+ * The proxy opens one persistent connection on startup. Through it the
5
+ * server can:
6
+ * - relay browser HTTP requests to the proxy's local Fastify server, and
7
+ * - forward WebRTC signalling messages (offers, ICE candidates) between
8
+ * the browser and the proxy's WebRTC manager.
9
+ *
10
+ * The tunnel reconnects automatically with a fixed back-off after any
11
+ * unexpected close.
12
+ */
13
+
14
+ import { WebSocket } from "ws";
15
+
16
+ /** @import { HealthMetrics } from './health-collector.js' */
17
+
18
+ /**
19
+ * Configuration for the tunnel client.
20
+ *
21
+ * @typedef {Object} TunnelClientOptions
22
+ * @property {string} serverUrl
23
+ * Base URL of the registry server (http or https — converted to ws/wss automatically).
24
+ * @property {string} proxyId
25
+ * Stable ID used to identify this proxy on the server.
26
+ * @property {string} token
27
+ * Auth token sent as the `x-proxy-id` / `x-proxy-token` headers during the WS handshake.
28
+ * @property {number} proxyPort
29
+ * Local port the proxy's Fastify server is listening on.
30
+ * @property {(sessionId: string, signal: WebRtcSignal) => void} [onSignal]
31
+ * Called when the server forwards a WebRTC signal (SDP offer or ICE candidate)
32
+ * from a browser to this proxy. `sessionId` scopes the signal to a P2P session.
33
+ * @property {() => void} [onConnect]
34
+ * Called each time the WebSocket connection becomes open (including reconnects).
35
+ * Use to re-register the proxy so the server's in-memory store stays consistent
36
+ * after server restarts.
37
+ * @property {(mediaInfo: object) => { copy: number[], transcode: number[] } | null} [onCanServeRequest]
38
+ * Called when the server asks whether this host could sustain a file it has
39
+ * been DESCRIBED — height, rate, bitrate, codec — rather than one it holds.
40
+ * Answered from this host's startup benchmarks alone: no torrent is added, no
41
+ * bytes are fetched and ffmpeg is not run, so it costs milliseconds and can
42
+ * be asked of every proxy in the pool at once.
43
+ * @property {() => HealthMetrics} [onHealthRequest]
44
+ * Called when the server sends a `health-request` message. The return value is
45
+ * sent back as `health-response` and used by the server to score this proxy.
46
+ * @property {(message: string) => void} [onLog]
47
+ * Optional structured log sink.
48
+ */
49
+
50
+ /**
51
+ * A single WebRTC signal message forwarded through the tunnel.
52
+ *
53
+ * @typedef {Object} WebRtcSignal
54
+ * @property {string} type - Signal kind: "offer" | "answer" | "candidate".
55
+ * @property {string} [sdp] - SDP string (for "offer" and "answer").
56
+ * @property {string} [candidate] - ICE candidate string (for "candidate").
57
+ * @property {string} [mid] - SDP media ID associated with the candidate.
58
+ */
59
+
60
+ /**
61
+ * A relay request sent by the server — asking the proxy to perform a local
62
+ * HTTP fetch and stream the response back through the tunnel.
63
+ *
64
+ * @typedef {Object} TunnelRelayRequest
65
+ * @property {string} requestId - Unique ID that ties request → response chunks.
66
+ * @property {string} method - HTTP method (GET, POST, etc.).
67
+ * @property {string} path - Request path on the local proxy (e.g. "/health").
68
+ * @property {string} query - Raw query string without the leading "?".
69
+ * @property {Record<string, string>} headers - Headers forwarded from the browser.
70
+ * @property {string | null} body - Serialised request body, or null.
71
+ */
72
+
73
+ /**
74
+ * The object returned by {@link createTunnelClient}.
75
+ *
76
+ * @typedef {Object} TunnelClient
77
+ * @property {() => void} connect - Open the tunnel; reconnects on drop.
78
+ * @property {() => void} disconnect - Close the tunnel; suppresses reconnects.
79
+ * @property {(sessionId: string, signal: WebRtcSignal) => void} sendSignal
80
+ * Send a WebRTC signal (answer / candidate) back to the browser.
81
+ * @property {(endpoint: { externalIp: string | null, externalPort: number, protocol: string }) => void} sendEndpoint
82
+ * Report this proxy's UPnP-mapped external endpoint to the server so it can
83
+ * dial back and verify reachability.
84
+ */
85
+
86
+ const RECONNECT_DELAY_MS = 5_000;
87
+ /** Send a keepalive ping every 30 s to prevent Cloudflare's idle WebSocket timeout (~100 s). */
88
+ const KEEPALIVE_INTERVAL_MS = 30_000;
89
+ /**
90
+ * Replace the connection before anything upstream ends it for us.
91
+ *
92
+ * Something between this process and the server closes the socket after
93
+ * exactly **100 min 15 s**, whatever is flowing over it. It is not an idle
94
+ * timeout — the keepalive above has been running for months — it is a lifetime
95
+ * cap. Measured across one day of logs (2026-08-20): 01:54:12 → 03:34:27 →
96
+ * ... the same 100:15 apart wherever a restart did not reset the clock, and
97
+ * with `code=1006`, an abrupt close with no closing handshake, which is what an
98
+ * intermediary killing a connection looks like.
99
+ *
100
+ * Reconnecting after the fact costs 5 s during which this proxy does not exist
101
+ * as far as the registry is concerned, and a viewer arriving in that window is
102
+ * told there is no proxy. So the connection is replaced BEFORE the cap, and the
103
+ * replacement is seamless: the new socket registers itself with the server,
104
+ * which atomically supersedes the old one, and only then does the old one
105
+ * close. There is no moment with nothing registered.
106
+ *
107
+ * Ninety minutes leaves ten minutes of margin against a cap that has been
108
+ * exact, and makes the replacement a quiet event rather than a race.
109
+ */
110
+ const CONNECTION_LIFETIME_MS = 90 * 60_000;
111
+
112
+ /**
113
+ * Create and manage the outbound WebSocket tunnel to the registry server.
114
+ *
115
+ * @param {TunnelClientOptions} options
116
+ * @returns {TunnelClient}
117
+ */
118
+ export function createTunnelClient({
119
+ serverUrl,
120
+ proxyId,
121
+ token,
122
+ proxyPort,
123
+ onSignal,
124
+ onConnect,
125
+ onHealthRequest,
126
+ onCanServeRequest,
127
+ onLog,
128
+ connectionLifetimeMs = CONNECTION_LIFETIME_MS
129
+ }) {
130
+ const wsUrl = serverUrl.replace(/^http/, "ws").replace(/\/+$/, "") + "/ws/proxy-tunnel";
131
+
132
+ /** @type {WebSocket | null} */
133
+ let socket = null;
134
+ /** @type {ReturnType<typeof setTimeout> | null} */
135
+ let reconnectTimer = null;
136
+ /**
137
+ * The renewal that will replace the live connection before the upstream cap
138
+ * ends it. Owned by the connection it belongs to, and cancelled with it.
139
+ *
140
+ * @type {ReturnType<typeof setTimeout> | null}
141
+ */
142
+ let renewalTimer = null;
143
+ let stopped = false;
144
+
145
+ /**
146
+ * Write a message to the log sink if one was provided.
147
+ *
148
+ * @param {string} message
149
+ * @returns {void}
150
+ */
151
+ function log(message) {
152
+ if (typeof onLog === "function") {
153
+ onLog(message);
154
+ }
155
+ }
156
+
157
+ /**
158
+ * Open a new WebSocket connection to the server.
159
+ * Automatically schedules a reconnect after any unintentional close.
160
+ *
161
+ * @returns {void}
162
+ */
163
+ function connect() {
164
+ if (stopped) {
165
+ return;
166
+ }
167
+ log(`Connecting tunnel to ${wsUrl}`);
168
+
169
+ // The connection being opened, held separately from `socket` so that a
170
+ // socket which has been SUPERSEDED can still recognise itself. During a
171
+ // renewal two exist for a moment, and the old one's close must not be
172
+ // mistaken for the tunnel going down.
173
+ const connection = new WebSocket(wsUrl, {
174
+ headers: {
175
+ "x-proxy-id": proxyId,
176
+ "x-proxy-token": token,
177
+ "user-agent": "torrent-tv-proxy/1.0"
178
+ }
179
+ });
180
+ /** @type {ReturnType<typeof setInterval> | null} */
181
+ let keepaliveTimer = null;
182
+ socket = connection;
183
+
184
+ connection.addEventListener("open", () => {
185
+ log("Tunnel connected.");
186
+ // Start keepalive pings to prevent Cloudflare's idle WebSocket timeout.
187
+ keepaliveTimer = setInterval(() => {
188
+ if (connection.readyState === WebSocket.OPEN) {
189
+ send({ type: "ping" }, connection);
190
+ }
191
+ }, KEEPALIVE_INTERVAL_MS);
192
+ // And replace this connection before the upstream lifetime cap does.
193
+ if (renewalTimer !== null) {
194
+ clearTimeout(renewalTimer);
195
+ }
196
+ renewalTimer = setTimeout(() => {
197
+ if (stopped || socket !== connection) {
198
+ return;
199
+ }
200
+ log("Tunnel renewing before the upstream lifetime cap; the replacement takes over first.");
201
+ connect();
202
+ }, connectionLifetimeMs);
203
+ if (typeof onConnect === "function") {
204
+ onConnect();
205
+ }
206
+ });
207
+
208
+ connection.addEventListener("message", (event) => {
209
+ let message;
210
+ try {
211
+ message = JSON.parse(event.data);
212
+ } catch {
213
+ return;
214
+ }
215
+
216
+ if (message.type === "request") {
217
+ void handleRelayRequest(message).catch((error) => {
218
+ log(`Tunnel relay error: ${error?.message ?? error}`);
219
+ });
220
+ return;
221
+ }
222
+
223
+ // WebRTC signalling: server forwards a signal from a browser session.
224
+ if (message.type === "signal") {
225
+ if (typeof message.sessionId === "string" && message.signal && typeof onSignal === "function") {
226
+ onSignal(message.sessionId, message.signal);
227
+ }
228
+ return;
229
+ }
230
+
231
+ // Could this host serve a file it is only told ABOUT? Asked when the
232
+ // proxy a viewer landed on has refused the file, so the browser can be
233
+ // sent somewhere that will work instead of being shown an error. The
234
+ // description travels because the refusing proxy has already probed the
235
+ // file: the expensive half is done once, and every other proxy answers
236
+ // by arithmetic.
237
+ if (message.type === "can-serve-request") {
238
+ let offer = null;
239
+ try {
240
+ offer = typeof onCanServeRequest === "function"
241
+ ? onCanServeRequest(message.mediaInfo ?? {})
242
+ : null;
243
+ } catch {
244
+ // silent-ok: an unanswerable question is answered "no", which is what
245
+ // a null offer means to the caller.
246
+ }
247
+ send({ type: "can-serve-response", requestId: message.requestId, offer });
248
+ return;
249
+ }
250
+
251
+ // Health check: server requests current metrics for proxy scoring.
252
+ if (message.type === "health-request") {
253
+ // Awaited: the answer now carries which films this proxy holds, and the
254
+ // truthful list of those lives on the torrent thread.
255
+ void (async () => {
256
+ let answer = {};
257
+ try {
258
+ answer = typeof onHealthRequest === "function" ? await onHealthRequest() : {};
259
+ } catch {
260
+ // silent-ok: a proxy that cannot describe itself is scored on
261
+ // nothing rather than not answered at all, which would drop it out
262
+ // of every selection until the next poll.
263
+ }
264
+ send({
265
+ type: "health-response",
266
+ requestId: message.requestId,
267
+ metrics: answer?.metrics ?? answer ?? {},
268
+ holds: Array.isArray(answer?.holds) ? answer.holds : []
269
+ });
270
+ })();
271
+ return;
272
+ }
273
+ });
274
+
275
+ connection.addEventListener("close", (event) => {
276
+ if (keepaliveTimer !== null) {
277
+ clearInterval(keepaliveTimer);
278
+ keepaliveTimer = null;
279
+ }
280
+ // A connection this one replaced. The server closes it as soon as the
281
+ // replacement registers, which is the whole point of renewing early —
282
+ // there is nothing to report and nothing to reconnect, because the tunnel
283
+ // never went down.
284
+ if (socket !== connection) {
285
+ log(`Tunnel handed over (code=${event.code}); the replacement is already carrying it.`);
286
+ return;
287
+ }
288
+ log(`Tunnel disconnected (code=${event.code}). Reconnecting in ${RECONNECT_DELAY_MS}ms...`);
289
+ socket = null;
290
+ if (renewalTimer !== null) {
291
+ clearTimeout(renewalTimer);
292
+ renewalTimer = null;
293
+ }
294
+ if (!stopped) {
295
+ reconnectTimer = setTimeout(connect, RECONNECT_DELAY_MS);
296
+ }
297
+ });
298
+
299
+ connection.addEventListener("error", (event) => {
300
+ log(`Tunnel WebSocket error: ${event.message ?? "unknown"}`);
301
+ });
302
+ }
303
+
304
+ /**
305
+ * Fetch a resource from the local Fastify server and stream the response
306
+ * back to the registry server chunk-by-chunk over the WebSocket.
307
+ *
308
+ * @param {TunnelRelayRequest} relayRequest
309
+ * @returns {Promise<void>}
310
+ */
311
+ async function handleRelayRequest(relayRequest) {
312
+ const { requestId, method, path, query, headers: forwardedHeaders, body } = relayRequest;
313
+ const targetUrl = `http://127.0.0.1:${proxyPort}${path}` + (query ? `?${query}` : "");
314
+ const requestHeaders = { ...(forwardedHeaders ?? {}), host: `127.0.0.1:${proxyPort}` };
315
+
316
+ let response;
317
+ try {
318
+ response = await fetch(targetUrl, {
319
+ method,
320
+ headers: requestHeaders,
321
+ body: body != null ? body : undefined,
322
+ redirect: "manual"
323
+ });
324
+ } catch (fetchError) {
325
+ sendError(requestId, fetchError?.message ?? String(fetchError));
326
+ return;
327
+ }
328
+
329
+ /** @type {Record<string, string>} */
330
+ const responseHeaders = {};
331
+ for (const [headerName, headerValue] of response.headers.entries()) {
332
+ responseHeaders[headerName] = headerValue;
333
+ }
334
+
335
+ send({ type: "response-start", requestId, status: response.status, headers: responseHeaders });
336
+
337
+ if (!response.body) {
338
+ send({ type: "response-chunk", requestId, data: "", done: true });
339
+ return;
340
+ }
341
+
342
+ try {
343
+ const reader = response.body.getReader();
344
+ while (true) {
345
+ const { done, value } = await reader.read();
346
+ if (done) {
347
+ send({ type: "response-chunk", requestId, data: "", done: true });
348
+ break;
349
+ }
350
+ send({
351
+ type: "response-chunk",
352
+ requestId,
353
+ data: Buffer.from(value).toString("base64"),
354
+ done: false
355
+ });
356
+ }
357
+ } catch {
358
+ send({ type: "response-chunk", requestId, data: "", done: true });
359
+ }
360
+ }
361
+
362
+ /**
363
+ * Serialise a message to JSON and send it through the WebSocket if open.
364
+ *
365
+ * @param {object} message
366
+ * @returns {void}
367
+ */
368
+ function send(message, over = null) {
369
+ // Everything the proxy has to say goes over the LIVE connection. `over` is
370
+ // for the one thing that belongs to a particular socket rather than to the
371
+ // tunnel — its own keepalive — which must not be sent over a replacement
372
+ // that has already taken over.
373
+ const target = over ?? socket;
374
+ if (target && target.readyState === WebSocket.OPEN) {
375
+ target.send(JSON.stringify(message));
376
+ }
377
+ }
378
+
379
+ /**
380
+ * Send a `response-error` frame for a given relay request.
381
+ *
382
+ * @param {string} requestId
383
+ * @param {string} errorMessage
384
+ * @returns {void}
385
+ */
386
+ function sendError(requestId, errorMessage) {
387
+ send({ type: "response-error", requestId, error: errorMessage });
388
+ }
389
+
390
+ return {
391
+ /**
392
+ * Start the tunnel. Connects immediately and auto-reconnects on drop.
393
+ *
394
+ * @returns {void}
395
+ */
396
+ connect() {
397
+ stopped = false;
398
+ connect();
399
+ },
400
+
401
+ /**
402
+ * Tear down the tunnel. Closes the current connection and prevents
403
+ * any future reconnect attempts.
404
+ *
405
+ * @returns {void}
406
+ */
407
+ disconnect() {
408
+ stopped = true;
409
+ if (renewalTimer !== null) {
410
+ clearTimeout(renewalTimer);
411
+ renewalTimer = null;
412
+ }
413
+ if (reconnectTimer != null) {
414
+ clearTimeout(reconnectTimer);
415
+ reconnectTimer = null;
416
+ }
417
+ if (socket) {
418
+ socket.close(1000, "shutdown");
419
+ socket = null;
420
+ }
421
+ },
422
+
423
+ /**
424
+ * Forward a WebRTC signal (SDP answer or ICE candidate) from this proxy
425
+ * to the browser via the server tunnel.
426
+ *
427
+ * @param {string} sessionId - Scopes the signal to a single P2P session.
428
+ * @param {WebRtcSignal} signal
429
+ * @returns {void}
430
+ */
431
+ sendSignal(sessionId, signal) {
432
+ send({ type: "signal", sessionId, signal });
433
+ },
434
+
435
+ /**
436
+ * Report this proxy's UPnP-mapped external endpoint to the server.
437
+ * No-op if the tunnel is not currently open (the caller re-sends on
438
+ * connect / reconnect).
439
+ *
440
+ * @param {{ externalIp: string | null, externalPort: number, protocol: string }} endpoint
441
+ * @returns {void}
442
+ */
443
+ sendEndpoint(endpoint) {
444
+ send({ type: "proxy-endpoint", endpoint });
445
+ }
446
+ };
447
+ }