@torrent-tv/proxy 2.87.7 → 2.87.8

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (456) 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 +322 -322
  13. package/CHANGELOG.md +4 -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/biome.json +411 -411
  22. package/docs/container-architecture.md +218 -218
  23. package/docs/download-architecture.md +261 -261
  24. package/docs/encode-architecture.md +729 -729
  25. package/docs/encode-run-state.md +96 -96
  26. package/docs/logs.md +97 -97
  27. package/docs/socks5-egress-research.md +114 -114
  28. package/docs/storage-architecture.md +267 -267
  29. package/knip.json +14 -14
  30. package/openspec/changes/adaptive-bitrate/design.md +92 -92
  31. package/openspec/changes/adaptive-bitrate/proposal.md +56 -56
  32. package/openspec/changes/adaptive-bitrate/specs/adaptive-bitrate/spec.md +51 -51
  33. package/openspec/changes/adaptive-bitrate/tasks.md +40 -40
  34. package/openspec/changes/binary-distribution/.openspec.yaml +2 -2
  35. package/openspec/changes/binary-distribution/proposal.md +53 -53
  36. package/openspec/changes/chunked-request-bodies/design.md +81 -81
  37. package/openspec/changes/chunked-request-bodies/proposal.md +53 -53
  38. package/openspec/changes/chunked-request-bodies/specs/chunked-request-bodies/spec.md +30 -30
  39. package/openspec/changes/chunked-request-bodies/tasks.md +40 -40
  40. package/openspec/changes/cold-start/design.md +98 -98
  41. package/openspec/changes/cold-start/proposal.md +62 -62
  42. package/openspec/changes/cold-start/specs/cold-start/spec.md +47 -47
  43. package/openspec/changes/cold-start/tasks.md +48 -48
  44. package/openspec/changes/disk-cap/.openspec.yaml +2 -2
  45. package/openspec/changes/disk-cap/proposal.md +37 -37
  46. package/openspec/changes/disk-cap/specs/disk-cap/spec.md +25 -25
  47. package/openspec/changes/disk-cap/tasks.md +19 -19
  48. package/openspec/changes/proxy-observability/.openspec.yaml +2 -2
  49. package/openspec/changes/proxy-observability/design.md +38 -38
  50. package/openspec/changes/proxy-observability/proposal.md +49 -49
  51. package/openspec/changes/proxy-observability/specs/observability/spec.md +33 -33
  52. package/openspec/changes/proxy-observability/tasks.md +21 -21
  53. package/openspec/changes/seek-debounce/design.md +118 -118
  54. package/openspec/changes/seek-debounce/proposal.md +59 -59
  55. package/openspec/changes/seek-debounce/specs/seek-debounce/spec.md +41 -41
  56. package/openspec/changes/seek-debounce/tasks.md +33 -33
  57. package/openspec/changes/subtitle-language/.openspec.yaml +2 -2
  58. package/openspec/changes/subtitle-language/proposal.md +50 -50
  59. package/openspec/changes/subtitle-language/specs/subtitle-language/spec.md +34 -34
  60. package/openspec/changes/subtitle-language/tasks.md +26 -26
  61. package/openspec/changes/track-selection/.openspec.yaml +2 -2
  62. package/openspec/changes/track-selection/design.md +47 -47
  63. package/openspec/changes/track-selection/proposal.md +45 -45
  64. package/openspec/changes/track-selection/specs/track-selection/spec.md +41 -41
  65. package/openspec/changes/track-selection/tasks.md +20 -20
  66. package/openspec/changes/transcode-quality/.openspec.yaml +2 -2
  67. package/openspec/changes/transcode-quality/proposal.md +51 -51
  68. package/openspec/changes/transcode-quality/specs/transcode-quality/spec.md +139 -139
  69. package/openspec/changes/transcode-quality/tasks.md +63 -63
  70. package/openspec/config.yaml +38 -38
  71. package/package.json +1 -1
  72. package/public/.well-known/appspecific/com.chrome.devtools.json +1 -1
  73. package/research/delivery-wedge-stand-ladder-2026-09-13.md +329 -329
  74. package/research/double-spawn-2026-09-10.md +171 -171
  75. package/research/handover-2026-09-13.md +209 -209
  76. package/research/handover-reader-claims-removal-2026-09-12.md +166 -166
  77. package/research/piece-withdrawn-but-still-claimed-2026-09-12.md +175 -175
  78. package/research/preset-benchmark-size-scaling-2026-08-22.md +55 -55
  79. package/research/priority-map-is-the-truth-2026-09-12.md +225 -225
  80. package/routes/api/client-logs/post.js +86 -86
  81. package/routes/api/delivery-sink/get.js +72 -72
  82. package/routes/api/link-probe/get.js +51 -51
  83. package/routes/api/playback-plan/audio-tracks/post.js +29 -29
  84. package/routes/api/playback-plan/post.js +53 -53
  85. package/routes/api/sources/files/get.js +100 -100
  86. package/routes/api/sources/post.js +36 -36
  87. package/routes/api/sources/stats/get.js +132 -132
  88. package/routes/api/subtitles/get.js +230 -230
  89. package/routes/api/transcode-sessions/fragment-far/post.js +60 -60
  90. package/routes/api/transcode-sessions/net-report/post.js +129 -129
  91. package/routes/api/transcode-sessions/post.js +160 -160
  92. package/routes/api/transcode-sessions/progress/get.js +27 -27
  93. package/routes/api/transcode-sessions/release/post.js +41 -41
  94. package/routes/api/transcode-sessions/seek/post.js +63 -63
  95. package/routes/health/get.js +13 -13
  96. package/routes/healthz/get.js +13 -13
  97. package/routes/stream/get.js +361 -361
  98. package/routes/transcode/audio-file/get.js +64 -64
  99. package/routes/transcode/audio-warm/get.js +84 -84
  100. package/routes/transcode/session-file/get.js +52 -52
  101. package/routes/transcode/variant-file/get.js +95 -95
  102. package/routes/transcode/variant-warm/get.js +84 -84
  103. package/scripts/render-run-graph.js +173 -173
  104. package/services/encode/CoverageMap.js +428 -428
  105. package/services/encode/CushionReport.js +345 -345
  106. package/services/encode/EncodeAdmission.js +332 -332
  107. package/services/encode/EncodeOrchestrator.js +1217 -1217
  108. package/services/encode/EncodePlan.js +1366 -1366
  109. package/services/encode/EncodeRun.js +776 -776
  110. package/services/encode/EncodeRuns.js +1229 -1229
  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/OutputOpening.js +755 -755
  116. package/services/encode/OutputTimes.js +579 -579
  117. package/services/encode/QsvEncoder.js +58 -58
  118. package/services/encode/Renditions.js +2162 -2162
  119. package/services/encode/RunProgress.js +84 -84
  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 +416 -416
  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 +114 -114
  130. package/services/encode/encode-run-state.js +551 -551
  131. package/services/encode/encoder-readings.js +45 -45
  132. package/services/encode/fingerprint.js +322 -322
  133. package/services/encode/host-load.js +174 -174
  134. package/services/encode/hwaccel.js +1894 -1894
  135. package/services/encode/index.js +9 -9
  136. package/services/encode/learned-median.js +90 -90
  137. package/services/encode/output/EncodedOutput.js +57 -57
  138. package/services/encode/output/Output.js +131 -131
  139. package/services/encode/output/OutputCatalog.js +414 -414
  140. package/services/encode/output/OutputSpec.js +390 -390
  141. package/services/encode/output/Timeline.js +308 -308
  142. package/services/encode/output/cut-grid.js +107 -107
  143. package/services/encode/output/index.js +20 -20
  144. package/services/encode/output/ladder.js +32 -32
  145. package/services/encode/output/playlists.js +284 -284
  146. package/services/encode/output/rates.js +125 -125
  147. package/services/encode/output-key-format.js +21 -21
  148. package/services/encode/quality/EncodeCost.js +1083 -1083
  149. package/services/encode/quality/HostLoad.js +525 -525
  150. package/services/encode/quality/HostTimings.js +249 -249
  151. package/services/encode/quality/OutputQualityState.js +28 -28
  152. package/services/encode/quality/QualityController.js +935 -935
  153. package/services/encode/quality/QualityOffer.js +416 -416
  154. package/services/encode/quality/drain-threat.js +47 -47
  155. package/services/encode/quality/link-budget.js +254 -254
  156. package/services/encode/quality/output-format.js +266 -266
  157. package/services/encode/quality/serving-output.js +216 -216
  158. package/services/encode/quality/visible-rung.js +57 -57
  159. package/services/encode/run-budget.js +97 -97
  160. package/services/encode/run-command.js +747 -747
  161. package/services/encode/run-costs.js +155 -155
  162. package/services/encode/run-inputs.js +42 -42
  163. package/services/encode/segment-formats/fmp4.js +437 -437
  164. package/services/encode/segment-formats/index.js +77 -77
  165. package/services/encode/segment-formats/init-compat.js +324 -324
  166. package/services/encode/segment-formats/mp4-boxes.js +311 -311
  167. package/services/encode/segment-formats/mpegts.js +134 -134
  168. package/services/encode/start-stop-cost.js +178 -178
  169. package/services/encode/throughput.js +97 -97
  170. package/services/encode/torrent-cost.js +88 -88
  171. package/services/identity/installation-id.js +38 -38
  172. package/services/media/ContainerOrchestrator.js +149 -149
  173. package/services/media/KeyframeTables.js +316 -316
  174. package/services/media/SourceFile.js +298 -298
  175. package/services/media/SubtitleCues.js +520 -520
  176. package/services/media/SubtitleOrchestrator.js +167 -167
  177. package/services/media/container/AviContainer.js +266 -266
  178. package/services/media/container/Container.js +603 -603
  179. package/services/media/container/ContainerFactory.js +56 -56
  180. package/services/media/container/KeyframeTable.js +272 -272
  181. package/services/media/container/MatroskaContainer.js +1494 -1494
  182. package/services/media/container/Mp4Container.js +1244 -1244
  183. package/services/media/container/SubtitleFileContainer.js +322 -322
  184. package/services/media/container/ebml-reader.js +159 -159
  185. package/services/media/ffmpeg-banner.js +260 -260
  186. package/services/media/keyframe-probe.js +157 -157
  187. package/services/media/media-info-probe.js +93 -93
  188. package/services/media/tracks/AudioTrack.js +131 -131
  189. package/services/media/tracks/ContainerTrack.js +75 -75
  190. package/services/media/tracks/ImageSubtitleTrack.js +19 -19
  191. package/services/media/tracks/SubtitleTrack.js +38 -38
  192. package/services/media/tracks/TextSubtitleTrack.js +287 -287
  193. package/services/media/tracks/VideoTrack.js +33 -33
  194. package/services/media/tracks/index.js +15 -15
  195. package/services/media/tracks/language-detect.js +174 -174
  196. package/services/server/OutputLifecycle.js +418 -418
  197. package/services/server/SegmentServing.js +1146 -1146
  198. package/services/server/ViewerRequests.js +522 -522
  199. package/services/server/WaitLedger.js +142 -142
  200. package/services/server/controllers/SubtitleController.js +109 -109
  201. package/services/server/http-responses.js +60 -60
  202. package/services/server/transcode-session-files.js +325 -325
  203. package/services/server/wire-outputs.js +983 -983
  204. package/services/storage/Diagnostics.js +202 -202
  205. package/services/storage/MachineBudget.js +235 -235
  206. package/services/storage/allowance.js +107 -107
  207. package/services/storage/core-dumps.js +106 -106
  208. package/services/storage/files/CompletedFiles.js +391 -391
  209. package/services/storage/files/piece-from-whole-file.js +118 -118
  210. package/services/storage/free.js +71 -71
  211. package/services/storage/keep.js +48 -48
  212. package/services/storage/machine-memory.js +56 -56
  213. package/services/storage/memory-report.js +575 -575
  214. package/services/storage/piece-store/piece-disk-store.js +516 -516
  215. package/services/storage/piece-store/piece-lru.js +495 -495
  216. package/services/storage/piece-store/shared-piece-store.js +1880 -1880
  217. package/services/storage/returns.js +103 -103
  218. package/services/storage/segment-store/SegmentStore.js +1196 -1196
  219. package/services/storage/wire.js +175 -175
  220. package/services/torrent/Contents.js +324 -324
  221. package/services/torrent/demand/DemandRegister.js +202 -202
  222. package/services/torrent/demand/Urgency.js +137 -137
  223. package/services/torrent/demand/Window.js +118 -118
  224. package/services/torrent/demand/index.js +8 -8
  225. package/services/torrent/demand/pieces.js +140 -140
  226. package/services/torrent/download/SwarmSelection.js +386 -386
  227. package/services/torrent/download/registry.js +102 -102
  228. package/services/torrent/download/withdraw-claim.js +80 -80
  229. package/services/torrent/files.js +455 -455
  230. package/services/torrent/naming.js +619 -619
  231. package/services/torrent/piece-store-of.js +29 -29
  232. package/services/torrent/supply-margin.js +262 -262
  233. package/services/torrent/worker/background-fill.js +213 -213
  234. package/services/torrent/worker/channel.js +271 -271
  235. package/services/torrent/worker/fastest-wires.js +342 -342
  236. package/services/torrent/worker/handle-state.js +23 -23
  237. package/services/torrent/worker/held-bytes.js +155 -155
  238. package/services/torrent/worker/install-webrtc-shim.js +32 -32
  239. package/services/torrent/worker/piece-reader.js +1078 -1078
  240. package/services/torrent/worker/resume-warm.js +107 -107
  241. package/services/torrent/worker/webrtc-shim.js +219 -219
  242. package/services/transport/data-channel-handler.js +21 -8
  243. package/services/transport/delivery-probe.js +842 -842
  244. package/services/transport/health-collector.js +53 -53
  245. package/services/transport/nat-classifier.js +231 -231
  246. package/services/transport/packet-witness.js +808 -808
  247. package/services/transport/port-mapper.js +235 -235
  248. package/services/transport/registry-api.js +81 -81
  249. package/services/transport/tunnel-client.js +447 -447
  250. package/services/transport/usrsctp-state.js +175 -175
  251. package/services/transport/webrtc-manager.js +484 -484
  252. package/services/viewer/Assignments.js +340 -340
  253. package/services/viewer/PriorityMap.js +390 -390
  254. package/services/viewer/PriorityOrchestrator.js +325 -325
  255. package/services/viewer/Viewer.js +657 -657
  256. package/services/viewer/Viewers.js +368 -368
  257. package/services/viewer/active-output.js +37 -37
  258. package/services/viewer/audio-start.js +46 -46
  259. package/services/viewer/buffer-trend.js +81 -81
  260. package/services/viewer/choices.js +647 -647
  261. package/services/viewer/positions.js +126 -126
  262. package/services/viewer/report-intake.js +46 -46
  263. package/store/source-registry.js +71 -71
  264. package/test/asset-paths.test.js +28 -28
  265. package/test/audio-track-bitrate.test.js +40 -40
  266. package/test/auto-quality-step.test.js +707 -707
  267. package/test/available-share.test.js +76 -76
  268. package/test/background-fill.test.js +190 -190
  269. package/test/client-log-file.test.js +110 -110
  270. package/test/completed-files.test.js +115 -115
  271. package/test/concurrent-cost.test.js +148 -148
  272. package/test/container-media-info.test.js +228 -228
  273. package/test/contention.test.js +76 -76
  274. package/test/core-dumps.test.js +57 -57
  275. package/test/coverage-follows-the-disk.test.js +228 -228
  276. package/test/coverage-map.test.js +195 -195
  277. package/test/cue-push-carries-what-the-walk-found.test.js +58 -58
  278. package/test/cut-times-timeline.test.js +65 -65
  279. package/test/cuts-follow-published-grid.test.js +109 -109
  280. package/test/data-channel-frame.test.js +63 -63
  281. package/test/data-channel-viewer-lifecycle.test.js +92 -0
  282. package/test/dead-torrent-handle.test.js +52 -52
  283. package/test/declared-rates.test.js +116 -116
  284. package/test/declared-tracks.test.js +35 -35
  285. package/test/decode-cost-fit.test.js +202 -202
  286. package/test/decode-cost.test.js +462 -462
  287. package/test/delivery-probe.test.js +393 -393
  288. package/test/demand-register.test.js +206 -206
  289. package/test/dht-bootstrap.test.js +72 -72
  290. package/test/drain-threat.test.js +65 -65
  291. package/test/duplicate-add.test.js +48 -48
  292. package/test/encode-admission.test.js +146 -146
  293. package/test/encode-cost.test.js +283 -283
  294. package/test/encode-exit.test.js +111 -111
  295. package/test/encode-orchestrator.test.js +419 -419
  296. package/test/encode-plan-viewers.test.js +718 -718
  297. package/test/encode-plan.test.js +545 -545
  298. package/test/encode-run-state.test.js +314 -314
  299. package/test/encode-run.test.js +161 -161
  300. package/test/encode-slope.test.js +46 -46
  301. package/test/encoded-output.test.js +39 -39
  302. package/test/encoder-kinds.test.js +122 -122
  303. package/test/encoder-readings.test.js +46 -46
  304. package/test/every-claimant-is-told-its-share.test.js +152 -152
  305. package/test/failed-encoder-still-serves-what-exists.test.js +354 -354
  306. package/test/failed-start-breaker.test.js +202 -202
  307. package/test/fastest-wires.test.js +143 -143
  308. package/test/ffmpeg-stream-counts.test.js +78 -78
  309. package/test/file-edges.test.js +191 -191
  310. package/test/fmp4-self-contained.test.js +80 -80
  311. package/test/fmp4-timestamps.test.js +140 -140
  312. package/test/fmp4-track-completeness.test.js +41 -41
  313. package/test/format-keyed-outputs.test.js +78 -78
  314. package/test/health-metrics.test.js +38 -38
  315. package/test/held-request-width.test.js +157 -157
  316. package/test/helpers/encode-run.js +136 -136
  317. package/test/helpers/held-file.js +29 -29
  318. package/test/helpers/manager.js +57 -57
  319. package/test/helpers/output-spec.js +63 -63
  320. package/test/host-load.test.js +68 -68
  321. package/test/index-accuracy-is-about-the-file.test.js +128 -128
  322. package/test/init-compat.test.js +219 -219
  323. package/test/input-lost-quiets-the-plan.test.js +261 -261
  324. package/test/input-unavailable.test.js +48 -48
  325. package/test/installation-id.test.js +39 -39
  326. package/test/keeping-period.test.js +83 -83
  327. package/test/keyframe-index-accuracy.test.js +188 -188
  328. package/test/keyframe-table-budget.test.js +102 -102
  329. package/test/keyframes-belong-to-the-file.test.js +249 -249
  330. package/test/learned-median.test.js +37 -37
  331. package/test/letting-go-asks-who-is-watching.test.js +191 -191
  332. package/test/limit-row-by-area.test.js +60 -60
  333. package/test/link-budget.test.js +111 -111
  334. package/test/link-probe.test.js +56 -56
  335. package/test/local-encoding-data.test.js +273 -273
  336. package/test/logger-repeats.test.js +134 -134
  337. package/test/look-ahead-coverage.test.js +56 -56
  338. package/test/manager-surface.test.js +292 -292
  339. package/test/matroska-cues-track.test.js +192 -192
  340. package/test/memory-budget.test.js +390 -390
  341. package/test/move-cost.test.js +216 -216
  342. package/test/mp4-subtitles.test.js +173 -173
  343. package/test/one-authority.test.js +285 -285
  344. package/test/one-budget.test.js +149 -149
  345. package/test/one-output-one-session.test.js +204 -204
  346. package/test/one-resource-divided.test.js +185 -185
  347. package/test/one-serving-output-per-height.test.js +458 -458
  348. package/test/orchestrator-wired.test.js +206 -206
  349. package/test/output-catalog.test.js +39 -39
  350. package/test/output-shape.test.js +21 -21
  351. package/test/output-spec.test.js +251 -251
  352. package/test/output-speed.test.js +88 -88
  353. package/test/outputs-being-prepared.test.js +40 -40
  354. package/test/packet-witness-ring.test.js +236 -236
  355. package/test/packet-witness.test.js +148 -148
  356. package/test/piece-disk-store.test.js +381 -381
  357. package/test/piece-from-whole-file.test.js +129 -129
  358. package/test/piece-lru.test.js +319 -319
  359. package/test/piece-reader.test.js +162 -162
  360. package/test/piece-selection-offset.test.js +85 -85
  361. package/test/piece-store-eviction.test.js +560 -560
  362. package/test/piece-store-never-refuses.test.js +153 -153
  363. package/test/piece-store-reservations.test.js +318 -318
  364. package/test/piece-store-slow-disk.test.js +159 -159
  365. package/test/piece-tail.test.js +97 -97
  366. package/test/plan-host-timings.test.js +68 -68
  367. package/test/plan-is-steady.test.js +225 -225
  368. package/test/priority-map-download.test.js +174 -174
  369. package/test/priority-map-emptied.test.js +204 -204
  370. package/test/priority-map-per-output.test.js +215 -215
  371. package/test/priority-map.test.js +163 -163
  372. package/test/probe-wedge-certainty.test.js +60 -60
  373. package/test/produced-copy-choice.test.js +213 -213
  374. package/test/published-timeline.test.js +83 -83
  375. package/test/quality-offer.test.js +162 -162
  376. package/test/quality-variants.test.js +1229 -1229
  377. package/test/rate-control-in-the-output.test.js +180 -180
  378. package/test/read-survives-withdrawal.test.js +164 -164
  379. package/test/read-window.test.js +365 -365
  380. package/test/resume-warm.test.js +39 -39
  381. package/test/run-graph-drift.test.js +37 -37
  382. package/test/run-inputs.test.js +80 -80
  383. package/test/run-intervals.test.js +100 -100
  384. package/test/run-position-follows-published-grid.test.js +89 -89
  385. package/test/run-progress.test.js +65 -65
  386. package/test/same-height-switch.test.js +664 -664
  387. package/test/seek-frees-the-viewers-requests.test.js +217 -217
  388. package/test/seek-landing.test.js +109 -109
  389. package/test/seek-target-not-superseded.test.js +195 -195
  390. package/test/segment-closed-on-both-branches.test.js +96 -96
  391. package/test/segment-cut-times.test.js +63 -63
  392. package/test/segment-demand.test.js +80 -80
  393. package/test/segment-hold-supersede.test.js +91 -91
  394. package/test/segment-judged-by-its-own-header.test.js +221 -221
  395. package/test/segment-serve-wiring.test.js +475 -475
  396. package/test/segment-store-eviction.test.js +247 -247
  397. package/test/segment-store.test.js +323 -323
  398. package/test/segment-true-start.test.js +86 -86
  399. package/test/segments-are-shared.test.js +176 -176
  400. package/test/send-chunk-bytes.test.js +86 -86
  401. package/test/serving-existing-output.test.js +102 -102
  402. package/test/serving-output.test.js +102 -102
  403. package/test/shared-piece-store.test.js +310 -310
  404. package/test/sidecar-naming.test.js +142 -142
  405. package/test/source-file.test.js +133 -133
  406. package/test/source-files-route.test.js +103 -103
  407. package/test/source-registry.test.js +18 -18
  408. package/test/split-a-stretch.test.js +139 -139
  409. package/test/stale-request-after-seek.test.js +158 -158
  410. package/test/startup-readings.test.js +124 -124
  411. package/test/stream-route.test.js +182 -182
  412. package/test/subtitle-cue-framing.test.js +200 -200
  413. package/test/subtitle-cue-source.test.js +102 -102
  414. package/test/subtitle-cue-walk.test.js +370 -370
  415. package/test/subtitle-cursor.test.js +63 -63
  416. package/test/subtitle-defaults.test.js +118 -118
  417. package/test/subtitle-language.test.js +252 -252
  418. package/test/subtitle-track-numbering.test.js +386 -386
  419. package/test/supply-margin.test.js +177 -177
  420. package/test/swarm-follows-readers.test.js +174 -174
  421. package/test/swarm-reach.test.js +130 -130
  422. package/test/swarm-selection.test.js +220 -220
  423. package/test/tail-duplication.test.js +167 -167
  424. package/test/the-channel-has-both-ends.test.js +91 -91
  425. package/test/the-torrent-thread-serves-bytes.test.js +107 -107
  426. package/test/thread-pool.test.js +53 -53
  427. package/test/timeline.test.js +84 -84
  428. package/test/torrent-contents.test.js +235 -235
  429. package/test/torrent-cost.test.js +71 -71
  430. package/test/torrent-files.test.js +221 -221
  431. package/test/torrent-naming.test.js +255 -255
  432. package/test/tracks-begin-together.test.js +209 -209
  433. package/test/tunnel-renewal.test.js +167 -167
  434. package/test/two-viewers-one-picture.test.js +407 -407
  435. package/test/upload-hurry.test.js +186 -186
  436. package/test/usrsctp-state.test.js +131 -131
  437. package/test/video-facts.test.js +102 -102
  438. package/test/viewer-assignments.test.js +143 -143
  439. package/test/viewer-outputs.test.js +285 -285
  440. package/test/viewer-presence.test.js +116 -116
  441. package/test/viewer-requests-admission.test.js +89 -89
  442. package/test/viewer-states.test.js +189 -189
  443. package/test/viewer-subtitle-subscription.test.js +96 -96
  444. package/test/viewer.test.js +139 -139
  445. package/test/viewing-generations.test.js +390 -390
  446. package/test/visible-rung.test.js +37 -37
  447. package/test/wait-ledger.test.js +100 -100
  448. package/test/webrtc-shim.test.js +149 -149
  449. package/test/wedge-certainty.test.js +131 -131
  450. package/test/withdraw-piece-claim.test.js +212 -212
  451. package/test/worker-channel.test.js +158 -158
  452. package/utils/client-log-file.js +151 -151
  453. package/utils/logger.js +312 -312
  454. package/utils/parse-range.js +25 -25
  455. package/utils/perf.js +59 -59
  456. package/utils/torrent-source-key.js +38 -38
@@ -1,551 +1,551 @@
1
- /**
2
- * @file The encoder run as a transition table: states, the relation between
3
- * them, and the answers derived from a state. Pure — no ffmpeg, no torrent, no
4
- * filesystem, no clock — so every decision can be exercised by `node --test`.
5
- *
6
- * This table is the SPECIFICATION, not a description of code written elsewhere.
7
- * The session manager executes it, the picture in `docs/encode-run-state.md` is
8
- * rendered from it, and every transition a real run makes is logged as state,
9
- * event and target — so a run that takes an edge this table does not declare is
10
- * a violation the log names, and a state never entered is a gap in coverage.
11
- *
12
- * Why a table at all, for this and not for everything: five field failures in a
13
- * row were not wrong lines but EMPTY CELLS — a pair of state and event nobody
14
- * had considered. A run at #26 meeting a request for #0; a request behind the
15
- * head arriving while a seek settles; a suspended encoder's cumulative speed
16
- * read as a measurement; a session in "failed" answering 500 for ever because
17
- * no edge leads out of it; an audio track left with its encoder when the viewer
18
- * moved to another. A table makes an empty cell visible before a release; a
19
- * conditional buried in 6900 lines does not.
20
- *
21
- * The four principles are the project's, and they decide everything below —
22
- * they are argued at length in `server/public/domain/app-state.js`, whose shape
23
- * this follows deliberately:
24
- *
25
- * 1. **Moore.** An output depends on the state alone, never on the edge taken.
26
- * So "is the input being read", "can the process be signalled" and "what
27
- * does a missing segment get answered" are functions of the state, computed
28
- * by the caller, never commanded alongside a transition.
29
- * 2. **Extended state.** Something becomes a state only when it changes what is
30
- * legal or what is shown. `encoderPauseUnsupported`, the seek-failure
31
- * counter, the wait epoch and the rest stay variables with guards.
32
- * 3. **Hierarchy.** An edge shared by several states is declared once on their
33
- * superstate; {@link nextState} walks the containment chain.
34
- * 4. **Graph discipline.** Deterministic, total (an unlisted pair is IGNORED,
35
- * never an exception), every state reachable, no dead ends. The ABSENT edges
36
- * carry the meaning — see {@link ABSENT_EDGE_INVARIANTS}.
37
- *
38
- * Derivation from the code as it stood at proxy 2.22.0, with line numbers:
39
- * `research/encode-run-machine-2026-08-16.md`.
40
- */
41
-
42
- /**
43
- * Control states of ONE encoder run inside one session.
44
- *
45
- * The session's own lifetime (live vs disposed) is deliberately not here: it is
46
- * two states and one edge, and the value is in taking it out of the field this
47
- * machine replaces, not in tabulating it.
48
- *
49
- * @readonly
50
- */
51
- export const ENCODE_RUN_STATE = Object.freeze({
52
- /**
53
- * No process exists and one is expected: before the first run, and between a
54
- * retry timer firing and the spawn it leads to.
55
- *
56
- * Distinct from {@link ENCODE_RUN_STATE.STOPPED}, which looks identical in
57
- * the old field set (`session.ffmpeg === null`) and calls for the opposite
58
- * answer — that is the whole reason both exist.
59
- */
60
- IDLE: "IDLE",
61
- /** Spawned; nothing servable produced by THIS run yet. */
62
- STARTING: "STARTING",
63
- /** This run has produced at least one servable segment. */
64
- PRODUCING: "PRODUCING",
65
- /**
66
- * `SIGSTOP` delivered, the process alive. The one state where a live run
67
- * reads nothing: suspending the encoder stops the only thing pulling on the
68
- * torrent, which is how an eleven-minute download stall came about (2.9.105).
69
- */
70
- SUSPENDED: "SUSPENDED",
71
- /**
72
- * The input went away and a restart is timed. Not a failure: the data can
73
- * come back, so requests are held rather than refused (2.9.112).
74
- */
75
- RETRY_WAIT: "RETRY_WAIT",
76
- /**
77
- * Stopped on purpose with no replacement — a rung the viewer switched away
78
- * from. Its segments stay servable and a switch back restarts it, but nothing
79
- * a REQUEST does may revive it, or the host ends up running the encoder the
80
- * viewer left as well as the one they chose.
81
- */
82
- STOPPED: "STOPPED",
83
- /** Ran through the last segment of the file. Nothing is owed. */
84
- ENDED_COMPLETE: "ENDED_COMPLETE",
85
- /** Terminal for this target: requests are answered as failures. */
86
- ENDED_FAILED: "ENDED_FAILED"
87
- });
88
-
89
- /** Where a run begins, so no caller hardcodes it. */
90
- export const INITIAL_RUN_STATE = ENCODE_RUN_STATE.IDLE;
91
-
92
- /**
93
- * One line per state, for the rendered picture.
94
- *
95
- * Data rather than a comment because the drawing is GENERATED from this file:
96
- * a legend kept beside the diagram drifts from the table, and a drawing that
97
- * disagrees with the code is worse than none.
98
- *
99
- * @type {Readonly<Record<string, string>>}
100
- */
101
- export const STATE_MEANING = Object.freeze({
102
- [ENCODE_RUN_STATE.IDLE]: "No process, and one is expected — before the first run, or after a retry timer fired.",
103
- [ENCODE_RUN_STATE.STARTING]: "Spawned; this run has produced nothing servable yet.",
104
- [ENCODE_RUN_STATE.PRODUCING]: "This run has produced at least one servable segment.",
105
- [ENCODE_RUN_STATE.SUSPENDED]: "SIGSTOP delivered, process alive — and nothing is reading the input.",
106
- [ENCODE_RUN_STATE.RETRY_WAIT]: "The input went away; a restart is timed. Requests are held, not refused.",
107
- [ENCODE_RUN_STATE.STOPPED]: "Stopped on purpose with no replacement — a rung the viewer switched away from.",
108
- [ENCODE_RUN_STATE.ENDED_COMPLETE]: "Ran through the last segment of the file. Nothing is owed.",
109
- [ENCODE_RUN_STATE.ENDED_FAILED]: "Terminal for this target: requests are answered as failures."
110
- });
111
-
112
- /**
113
- * Superstates. Containers, not states: they declare a shared edge once and
114
- * express an output over a group.
115
- *
116
- * @readonly
117
- */
118
- export const ENCODE_RUN_SUPERSTATE = Object.freeze({
119
- /** A pid exists and can be signalled: STARTING, PRODUCING, SUSPENDED. */
120
- ALIVE: "ALIVE",
121
- /** A missing segment is held rather than refused: ALIVE plus RETRY_WAIT. */
122
- WORKING: "WORKING",
123
- /** Every state. Exists so a universal edge is written once. */
124
- RUN: "RUN"
125
- });
126
-
127
- /**
128
- * Freeze an object and everything under it. `Object.freeze` is shallow, and a
129
- * transition relation that can be edited at runtime is not a specification.
130
- *
131
- * @template T
132
- * @param {T} value
133
- * @returns {T}
134
- */
135
- function deepFreeze(value) {
136
- if (value !== null && typeof value === "object" && !Object.isFrozen(value)) {
137
- Object.freeze(value);
138
- for (const inner of Object.values(value)) {
139
- deepFreeze(inner);
140
- }
141
- }
142
- return value;
143
- }
144
-
145
- /**
146
- * Containment, innermost first — the chain {@link nextState} walks when a state
147
- * declares no edge of its own for an event.
148
- *
149
- * @type {Readonly<Record<string, string | null>>}
150
- */
151
- const PARENT = Object.freeze({
152
- [ENCODE_RUN_STATE.STARTING]: ENCODE_RUN_SUPERSTATE.ALIVE,
153
- [ENCODE_RUN_STATE.PRODUCING]: ENCODE_RUN_SUPERSTATE.ALIVE,
154
- [ENCODE_RUN_STATE.SUSPENDED]: ENCODE_RUN_SUPERSTATE.ALIVE,
155
- [ENCODE_RUN_SUPERSTATE.ALIVE]: ENCODE_RUN_SUPERSTATE.WORKING,
156
- [ENCODE_RUN_STATE.RETRY_WAIT]: ENCODE_RUN_SUPERSTATE.WORKING,
157
- [ENCODE_RUN_SUPERSTATE.WORKING]: ENCODE_RUN_SUPERSTATE.RUN,
158
- [ENCODE_RUN_STATE.IDLE]: ENCODE_RUN_SUPERSTATE.RUN,
159
- [ENCODE_RUN_STATE.STOPPED]: ENCODE_RUN_SUPERSTATE.RUN,
160
- [ENCODE_RUN_STATE.ENDED_COMPLETE]: ENCODE_RUN_SUPERSTATE.RUN,
161
- [ENCODE_RUN_STATE.ENDED_FAILED]: ENCODE_RUN_SUPERSTATE.RUN,
162
- [ENCODE_RUN_SUPERSTATE.RUN]: null
163
- });
164
-
165
- /**
166
- * Events, named for what HAPPENED. An event that names its target cannot be
167
- * refused without contradicting itself.
168
- *
169
- * `EXITED_COMPLETE` and `EXITED_SHORT` are two events for one exit code
170
- * because ffmpeg exits 0 both at the end of the file and when its input simply
171
- * stops delivering — a distinction that cost a frozen player and had to be
172
- * recovered by comparing what was produced against the published playlist
173
- * (2.9.104). Written down, it can never collapse back into one.
174
- *
175
- * @readonly
176
- */
177
- export const ENCODE_RUN_EVENT = Object.freeze({
178
- /** A process was spawned for this session. */
179
- SPAWNED: "SPAWNED",
180
- /**
181
- * The first servable segment of THIS run was served.
182
- *
183
- * The only event whose raising is guarded by the current state, and
184
- * deliberately so: "something has been produced" is a level, not an edge, and
185
- * the guard is a READ of the state rather than a second copy of it. Declared
186
- * on STARTING alone, so a segment served by a suspended run cannot resume it
187
- * — which is exactly the sawtooth of 2.9.93.
188
- */
189
- FIRST_SEGMENT: "FIRST_SEGMENT",
190
- /** `SIGSTOP` was delivered. */
191
- SUSPEND_ORDERED: "SUSPEND_ORDERED",
192
- /** `SIGCONT` was sent. */
193
- RESUME_ORDERED: "RESUME_ORDERED",
194
- /** The run was stopped with no replacement. */
195
- STOP_ORDERED: "STOP_ORDERED",
196
- /** Exit 0, having produced through the last segment. */
197
- EXITED_COMPLETE: "EXITED_COMPLETE",
198
- /** Exit 0, short of the last segment — the input dried up. */
199
- EXITED_SHORT: "EXITED_SHORT",
200
- /** Died because the input was not there. Recoverable. */
201
- EXITED_INPUT_LOST: "EXITED_INPUT_LOST",
202
- /** Died for any other reason, or could not be spawned at all. */
203
- EXITED_FAILED: "EXITED_FAILED",
204
- /** The input-retry timer fired. */
205
- RETRY_DUE: "RETRY_DUE"
206
- });
207
-
208
- /**
209
- * One line per event, for the rendered picture. Same reason as
210
- * {@link STATE_MEANING}.
211
- *
212
- * @type {Readonly<Record<string, string>>}
213
- */
214
- export const EVENT_MEANING = Object.freeze({
215
- [ENCODE_RUN_EVENT.SPAWNED]: "A process was spawned for this session.",
216
- [ENCODE_RUN_EVENT.FIRST_SEGMENT]: "The first servable segment of this run was served.",
217
- [ENCODE_RUN_EVENT.SUSPEND_ORDERED]: "SIGSTOP was delivered.",
218
- [ENCODE_RUN_EVENT.RESUME_ORDERED]: "SIGCONT was sent.",
219
- [ENCODE_RUN_EVENT.STOP_ORDERED]: "The run was stopped with no replacement.",
220
- [ENCODE_RUN_EVENT.EXITED_COMPLETE]: "Exit 0, having produced through the last segment.",
221
- [ENCODE_RUN_EVENT.EXITED_SHORT]: "Exit 0, short of the last segment — the input dried up.",
222
- [ENCODE_RUN_EVENT.EXITED_INPUT_LOST]: "Died because the input was not there. Recoverable.",
223
- [ENCODE_RUN_EVENT.EXITED_FAILED]: "Died for any other reason, or could not be spawned.",
224
- [ENCODE_RUN_EVENT.RETRY_DUE]: "The input-retry timer fired."
225
- });
226
-
227
- /**
228
- * The transition relation. One target per state and event.
229
- *
230
- * `SPAWNED` sits on RUN because a run may be spawned from any state at all: at
231
- * session creation (IDLE), replacing a live run on a seek (ALIVE), after a
232
- * retry (IDLE), on a switch back to a rung (STOPPED), and after a failure
233
- * (ENDED_*). Declared once, it also makes the restart edge impossible to
234
- * forget on a state added later.
235
- *
236
- * @type {Readonly<Record<string, Readonly<Record<string, string>>>>}
237
- */
238
- const TRANSITIONS = deepFreeze({
239
- [ENCODE_RUN_SUPERSTATE.RUN]: {
240
- // A spawn always lands in STARTING, including from STARTING itself: the new
241
- // run has produced nothing, whatever its predecessor had done.
242
- [ENCODE_RUN_EVENT.SPAWNED]: ENCODE_RUN_STATE.STARTING
243
- },
244
-
245
- [ENCODE_RUN_SUPERSTATE.WORKING]: {
246
- // Stopping reaches a dead run too: the exit handler leaves the handle in
247
- // place, so `#stopEncodeRun` runs its course in RETRY_WAIT as well.
248
- [ENCODE_RUN_EVENT.STOP_ORDERED]: ENCODE_RUN_STATE.STOPPED
249
- },
250
-
251
- [ENCODE_RUN_SUPERSTATE.ALIVE]: {
252
- [ENCODE_RUN_EVENT.SUSPEND_ORDERED]: ENCODE_RUN_STATE.SUSPENDED,
253
- [ENCODE_RUN_EVENT.EXITED_COMPLETE]: ENCODE_RUN_STATE.ENDED_COMPLETE,
254
- // Stopping short is a FAILURE that may be restarted, not a finished file.
255
- [ENCODE_RUN_EVENT.EXITED_SHORT]: ENCODE_RUN_STATE.ENDED_FAILED,
256
- [ENCODE_RUN_EVENT.EXITED_INPUT_LOST]: ENCODE_RUN_STATE.RETRY_WAIT,
257
- [ENCODE_RUN_EVENT.EXITED_FAILED]: ENCODE_RUN_STATE.ENDED_FAILED
258
- },
259
-
260
- [ENCODE_RUN_STATE.STARTING]: {
261
- [ENCODE_RUN_EVENT.FIRST_SEGMENT]: ENCODE_RUN_STATE.PRODUCING
262
- },
263
-
264
- [ENCODE_RUN_STATE.SUSPENDED]: {
265
- // Resuming lands in PRODUCING even for a run suspended before its first
266
- // segment (2.9.117 suspended one 136 ms in). No output distinguishes the
267
- // two: both read the input, both can be signalled, both hold a missing
268
- // segment and both say "running" on the wire. The distinction that does
269
- // exist — the warm-up figure — is answered before the first spawn.
270
- [ENCODE_RUN_EVENT.RESUME_ORDERED]: ENCODE_RUN_STATE.PRODUCING
271
- },
272
-
273
- [ENCODE_RUN_STATE.RETRY_WAIT]: {
274
- // The timer fired; nothing is running and nothing is armed. The spawn it
275
- // leads to may still be abandoned (a newer run won the race), and IDLE is
276
- // the honest state for that moment.
277
- [ENCODE_RUN_EVENT.RETRY_DUE]: ENCODE_RUN_STATE.IDLE
278
- }
279
- });
280
-
281
- /**
282
- * What the MISSING edges assert, as data so the tests execute them rather than
283
- * a reader trusting prose. Each entry is a shipped defect stated as a rule.
284
- *
285
- * @type {ReadonlyArray<{ from: string, event: string, mustNotReach: string, because: string }>}
286
- */
287
- export const ABSENT_EDGE_INVARIANTS = Object.freeze([
288
- {
289
- from: ENCODE_RUN_STATE.SUSPENDED,
290
- event: ENCODE_RUN_EVENT.FIRST_SEGMENT,
291
- mustNotReach: ENCODE_RUN_STATE.PRODUCING,
292
- because:
293
- "a segment request must not release a suspended encoder — 2.9.93, where any request did, " +
294
- "and the run sawtoothed from 155 s to 922 s ahead of the viewer in three minutes"
295
- },
296
- {
297
- from: ENCODE_RUN_STATE.ENDED_FAILED,
298
- event: ENCODE_RUN_EVENT.FIRST_SEGMENT,
299
- mustNotReach: ENCODE_RUN_STATE.PRODUCING,
300
- because:
301
- "a dead run is not a producing one — 2.9.93, where the handle pointed at a corpse and every " +
302
- "later seek was waved through as already covered, so the session answered 500 for ever"
303
- },
304
- {
305
- from: ENCODE_RUN_STATE.ENDED_FAILED,
306
- event: ENCODE_RUN_EVENT.RESUME_ORDERED,
307
- mustNotReach: ENCODE_RUN_STATE.PRODUCING,
308
- because: "there is no process to continue; only a spawn leads out of a failure"
309
- },
310
- {
311
- from: ENCODE_RUN_STATE.IDLE,
312
- event: ENCODE_RUN_EVENT.FIRST_SEGMENT,
313
- mustNotReach: ENCODE_RUN_STATE.PRODUCING,
314
- because: "nothing produces before a process exists"
315
- },
316
- {
317
- from: ENCODE_RUN_STATE.RETRY_WAIT,
318
- event: ENCODE_RUN_EVENT.FIRST_SEGMENT,
319
- mustNotReach: ENCODE_RUN_STATE.PRODUCING,
320
- because: "a run waiting for its input back has no process; only a spawn resumes production"
321
- },
322
- {
323
- from: ENCODE_RUN_STATE.STOPPED,
324
- event: ENCODE_RUN_EVENT.RESUME_ORDERED,
325
- mustNotReach: ENCODE_RUN_STATE.PRODUCING,
326
- because:
327
- "a rung the viewer switched away from must not be revived by its own held requests — " +
328
- "the host has one encoder's worth of capacity and the rung on screen needs it"
329
- }
330
- ]);
331
-
332
- /**
333
- * The state `event` leads to, or `null` when the event means nothing here.
334
- *
335
- * Two answers with two meanings, kept apart on purpose:
336
- *
337
- * - `null` — no edge exists for this pair; the event is IGNORED. A caller may
338
- * reasonably log it, and in this codebase that log line IS the measurement
339
- * of whether this table matches reality.
340
- * - the state passed in — an edge exists and leads back here; nothing
341
- * changed, and no entry work may re-run.
342
- *
343
- * Never throws. The machine this pattern replaces did, from inside an event
344
- * listener, so a refused transition abandoned the rest of the handler and left
345
- * the app describing a state it was no longer in.
346
- *
347
- * @param {string} state - Current state.
348
- * @param {string} event - One of {@link ENCODE_RUN_EVENT}.
349
- * @returns {string | null}
350
- */
351
- export function nextState(state, event) {
352
- let scope = state;
353
- while (scope) {
354
- const target = TRANSITIONS[scope]?.[event];
355
- if (target !== undefined) {
356
- return target;
357
- }
358
- scope = PARENT[scope] ?? null;
359
- }
360
- return null;
361
- }
362
-
363
- /**
364
- * Whether `state` sits inside `superstate` (or is it).
365
- *
366
- * @param {string} state
367
- * @param {string} superstate - One of {@link ENCODE_RUN_SUPERSTATE}.
368
- * @returns {boolean}
369
- */
370
- export function isWithin(state, superstate) {
371
- let scope = state;
372
- while (scope) {
373
- if (scope === superstate) {
374
- return true;
375
- }
376
- scope = PARENT[scope] ?? null;
377
- }
378
- return false;
379
- }
380
-
381
- /**
382
- * Is anything reading the input right now?
383
- *
384
- * The output the torrent turns on, and the one that had no name anywhere in the
385
- * codebase until the pool learned it the hard way: suspending the encoder stops
386
- * the only reader, the reader's window is then satisfied, WebTorrent drops the
387
- * selection, and the download dies with the swarm wide open — eleven minutes of
388
- * it, measured 2026-08-05 with 150 peers connected.
389
- *
390
- * @param {string} state
391
- * @returns {boolean}
392
- */
393
- export function isInputBeingRead(state) {
394
- return state === ENCODE_RUN_STATE.STARTING || state === ENCODE_RUN_STATE.PRODUCING;
395
- }
396
-
397
- /**
398
- * May a signal be sent to this run's process?
399
- *
400
- * Replaces re-deriving the answer from a child-process handle at five sites.
401
- * The OS remains the authority on whether a pid still exists: a caller must
402
- * keep its `try`/`catch` and feed a throw back as an exit event, never
403
- * contradict it. A machine that believes it owns the process's life is wrong
404
- * the first time ffmpeg is killed from outside.
405
- *
406
- * @param {string} state
407
- * @returns {boolean}
408
- */
409
- export function processCanBeSignalled(state) {
410
- return isWithin(state, ENCODE_RUN_SUPERSTATE.ALIVE);
411
- }
412
-
413
- /**
414
- * What a request for a segment that is not on disk gets.
415
- *
416
- * `"hold"` and `"fail"` were three answers to one condition across the serving
417
- * path — hold, 404 and 500 — chosen at each site. They are one answer here.
418
- *
419
- * @param {string} state
420
- * @returns {"hold" | "fail"}
421
- */
422
- export function answerForMissingSegment(state) {
423
- return state === ENCODE_RUN_STATE.ENDED_FAILED ? "fail" : "hold";
424
- }
425
-
426
- /**
427
- * The status string the browser is given.
428
- *
429
- * A Moore output rather than a second field maintained by hand at seven sites,
430
- * which is how the two came to be read together with `||`.
431
- *
432
- * @param {string} state
433
- * @returns {"starting" | "running" | "ready" | "failed"}
434
- */
435
- export function wireState(state) {
436
- if (state === ENCODE_RUN_STATE.IDLE || state === ENCODE_RUN_STATE.RETRY_WAIT) {
437
- return "starting";
438
- }
439
- if (state === ENCODE_RUN_STATE.ENDED_COMPLETE) {
440
- return "ready";
441
- }
442
- if (state === ENCODE_RUN_STATE.ENDED_FAILED) {
443
- return "failed";
444
- }
445
- // STARTING, PRODUCING, SUSPENDED and STOPPED. The last of these keeps the
446
- // value its run left behind, which is what a stopped rung reports today; a
447
- // family's progress is answered from the variant on screen in any case.
448
- return "running";
449
- }
450
-
451
- /**
452
- * May the encoder be repositioned from this state?
453
- *
454
- * False only for a run that reached the end of the file: everything it could
455
- * produce exists, so a restart would re-make what is already on disk.
456
- *
457
- * @param {string} state
458
- * @returns {boolean}
459
- */
460
- export function mayRestart(state) {
461
- return state !== ENCODE_RUN_STATE.ENDED_COMPLETE;
462
- }
463
-
464
- /**
465
- * Every declared edge, flattened, for the tests and for drawing the graph.
466
- * Superstate edges are reported against the superstate, not expanded.
467
- *
468
- * @returns {Array<{ from: string, event: string, to: string }>}
469
- */
470
- export function declaredEdges() {
471
- const edges = [];
472
- for (const [from, byEvent] of Object.entries(TRANSITIONS)) {
473
- for (const [event, to] of Object.entries(byEvent)) {
474
- edges.push({ from, event, to });
475
- }
476
- }
477
- return edges;
478
- }
479
-
480
- /**
481
- * The containment chain, for the graph renderer. A copy, so no caller can edit
482
- * the table by editing what it was handed.
483
- *
484
- * @returns {Array<{ state: string, parent: string | null }>}
485
- */
486
- export function declaredContainment() {
487
- return Object.entries(PARENT).map(([state, parent]) => ({ state, parent }));
488
- }
489
-
490
- /**
491
- * Every run in one output's registered collection, earliest first.
492
- *
493
- * @param {object[] | Set<object>} runs
494
- * @returns {object[]}
495
- */
496
- export function runsOf(runs) {
497
- const listed = Array.isArray(runs) ? runs : runs instanceof Set ? [...runs] : [];
498
- return [...listed].sort((left, right) => left.from - right.from);
499
- }
500
-
501
- /**
502
- * The runs in one output's registered collection that still have a process.
503
- *
504
- * @param {object[] | Set<object>} runs
505
- * @returns {object[]}
506
- */
507
- export function liveRunsOf(runs) {
508
- return runsOf(runs).filter((run) => run.isAlive);
509
- }
510
-
511
- /**
512
- * What one output's registered encoders are doing, as one state.
513
- *
514
- * The most advanced state among its live runs: an output with anything
515
- * producing IS producing, whatever else it has going. An output that has never
516
- * started a run, or whose runs have all ended, is at the table's own initial
517
- * state — which is what "nothing is encoding" means.
518
- *
519
- * @param {object[] | Set<object>} runs
520
- * @returns {string}
521
- */
522
- export function runStateOf(runs) {
523
- let answer = INITIAL_RUN_STATE;
524
- let rank = -1;
525
- for (const run of runsOf(runs)) {
526
- const at = RUN_STATE_ORDER.indexOf(run.state);
527
- if (at > rank) {
528
- rank = at;
529
- answer = run.state;
530
- }
531
- }
532
- return answer;
533
- }
534
-
535
- /**
536
- * How advanced a run state is, for reducing several runs to one answer.
537
- *
538
- * Producing outranks starting, and both outrank a run that has ended: what a
539
- * caller asking "what is this output's encoding doing" wants to know is
540
- * whether anything is being made, not what the quietest of them is up to.
541
- */
542
- const RUN_STATE_ORDER = [
543
- ENCODE_RUN_STATE.ENDED_FAILED,
544
- ENCODE_RUN_STATE.ENDED_COMPLETE,
545
- ENCODE_RUN_STATE.STOPPED,
546
- ENCODE_RUN_STATE.IDLE,
547
- ENCODE_RUN_STATE.RETRY_WAIT,
548
- ENCODE_RUN_STATE.SUSPENDED,
549
- ENCODE_RUN_STATE.STARTING,
550
- ENCODE_RUN_STATE.PRODUCING
551
- ];
1
+ /**
2
+ * @file The encoder run as a transition table: states, the relation between
3
+ * them, and the answers derived from a state. Pure — no ffmpeg, no torrent, no
4
+ * filesystem, no clock — so every decision can be exercised by `node --test`.
5
+ *
6
+ * This table is the SPECIFICATION, not a description of code written elsewhere.
7
+ * The session manager executes it, the picture in `docs/encode-run-state.md` is
8
+ * rendered from it, and every transition a real run makes is logged as state,
9
+ * event and target — so a run that takes an edge this table does not declare is
10
+ * a violation the log names, and a state never entered is a gap in coverage.
11
+ *
12
+ * Why a table at all, for this and not for everything: five field failures in a
13
+ * row were not wrong lines but EMPTY CELLS — a pair of state and event nobody
14
+ * had considered. A run at #26 meeting a request for #0; a request behind the
15
+ * head arriving while a seek settles; a suspended encoder's cumulative speed
16
+ * read as a measurement; a session in "failed" answering 500 for ever because
17
+ * no edge leads out of it; an audio track left with its encoder when the viewer
18
+ * moved to another. A table makes an empty cell visible before a release; a
19
+ * conditional buried in 6900 lines does not.
20
+ *
21
+ * The four principles are the project's, and they decide everything below —
22
+ * they are argued at length in `server/public/domain/app-state.js`, whose shape
23
+ * this follows deliberately:
24
+ *
25
+ * 1. **Moore.** An output depends on the state alone, never on the edge taken.
26
+ * So "is the input being read", "can the process be signalled" and "what
27
+ * does a missing segment get answered" are functions of the state, computed
28
+ * by the caller, never commanded alongside a transition.
29
+ * 2. **Extended state.** Something becomes a state only when it changes what is
30
+ * legal or what is shown. `encoderPauseUnsupported`, the seek-failure
31
+ * counter, the wait epoch and the rest stay variables with guards.
32
+ * 3. **Hierarchy.** An edge shared by several states is declared once on their
33
+ * superstate; {@link nextState} walks the containment chain.
34
+ * 4. **Graph discipline.** Deterministic, total (an unlisted pair is IGNORED,
35
+ * never an exception), every state reachable, no dead ends. The ABSENT edges
36
+ * carry the meaning — see {@link ABSENT_EDGE_INVARIANTS}.
37
+ *
38
+ * Derivation from the code as it stood at proxy 2.22.0, with line numbers:
39
+ * `research/encode-run-machine-2026-08-16.md`.
40
+ */
41
+
42
+ /**
43
+ * Control states of ONE encoder run inside one session.
44
+ *
45
+ * The session's own lifetime (live vs disposed) is deliberately not here: it is
46
+ * two states and one edge, and the value is in taking it out of the field this
47
+ * machine replaces, not in tabulating it.
48
+ *
49
+ * @readonly
50
+ */
51
+ export const ENCODE_RUN_STATE = Object.freeze({
52
+ /**
53
+ * No process exists and one is expected: before the first run, and between a
54
+ * retry timer firing and the spawn it leads to.
55
+ *
56
+ * Distinct from {@link ENCODE_RUN_STATE.STOPPED}, which looks identical in
57
+ * the old field set (`session.ffmpeg === null`) and calls for the opposite
58
+ * answer — that is the whole reason both exist.
59
+ */
60
+ IDLE: "IDLE",
61
+ /** Spawned; nothing servable produced by THIS run yet. */
62
+ STARTING: "STARTING",
63
+ /** This run has produced at least one servable segment. */
64
+ PRODUCING: "PRODUCING",
65
+ /**
66
+ * `SIGSTOP` delivered, the process alive. The one state where a live run
67
+ * reads nothing: suspending the encoder stops the only thing pulling on the
68
+ * torrent, which is how an eleven-minute download stall came about (2.9.105).
69
+ */
70
+ SUSPENDED: "SUSPENDED",
71
+ /**
72
+ * The input went away and a restart is timed. Not a failure: the data can
73
+ * come back, so requests are held rather than refused (2.9.112).
74
+ */
75
+ RETRY_WAIT: "RETRY_WAIT",
76
+ /**
77
+ * Stopped on purpose with no replacement — a rung the viewer switched away
78
+ * from. Its segments stay servable and a switch back restarts it, but nothing
79
+ * a REQUEST does may revive it, or the host ends up running the encoder the
80
+ * viewer left as well as the one they chose.
81
+ */
82
+ STOPPED: "STOPPED",
83
+ /** Ran through the last segment of the file. Nothing is owed. */
84
+ ENDED_COMPLETE: "ENDED_COMPLETE",
85
+ /** Terminal for this target: requests are answered as failures. */
86
+ ENDED_FAILED: "ENDED_FAILED"
87
+ });
88
+
89
+ /** Where a run begins, so no caller hardcodes it. */
90
+ export const INITIAL_RUN_STATE = ENCODE_RUN_STATE.IDLE;
91
+
92
+ /**
93
+ * One line per state, for the rendered picture.
94
+ *
95
+ * Data rather than a comment because the drawing is GENERATED from this file:
96
+ * a legend kept beside the diagram drifts from the table, and a drawing that
97
+ * disagrees with the code is worse than none.
98
+ *
99
+ * @type {Readonly<Record<string, string>>}
100
+ */
101
+ export const STATE_MEANING = Object.freeze({
102
+ [ENCODE_RUN_STATE.IDLE]: "No process, and one is expected — before the first run, or after a retry timer fired.",
103
+ [ENCODE_RUN_STATE.STARTING]: "Spawned; this run has produced nothing servable yet.",
104
+ [ENCODE_RUN_STATE.PRODUCING]: "This run has produced at least one servable segment.",
105
+ [ENCODE_RUN_STATE.SUSPENDED]: "SIGSTOP delivered, process alive — and nothing is reading the input.",
106
+ [ENCODE_RUN_STATE.RETRY_WAIT]: "The input went away; a restart is timed. Requests are held, not refused.",
107
+ [ENCODE_RUN_STATE.STOPPED]: "Stopped on purpose with no replacement — a rung the viewer switched away from.",
108
+ [ENCODE_RUN_STATE.ENDED_COMPLETE]: "Ran through the last segment of the file. Nothing is owed.",
109
+ [ENCODE_RUN_STATE.ENDED_FAILED]: "Terminal for this target: requests are answered as failures."
110
+ });
111
+
112
+ /**
113
+ * Superstates. Containers, not states: they declare a shared edge once and
114
+ * express an output over a group.
115
+ *
116
+ * @readonly
117
+ */
118
+ export const ENCODE_RUN_SUPERSTATE = Object.freeze({
119
+ /** A pid exists and can be signalled: STARTING, PRODUCING, SUSPENDED. */
120
+ ALIVE: "ALIVE",
121
+ /** A missing segment is held rather than refused: ALIVE plus RETRY_WAIT. */
122
+ WORKING: "WORKING",
123
+ /** Every state. Exists so a universal edge is written once. */
124
+ RUN: "RUN"
125
+ });
126
+
127
+ /**
128
+ * Freeze an object and everything under it. `Object.freeze` is shallow, and a
129
+ * transition relation that can be edited at runtime is not a specification.
130
+ *
131
+ * @template T
132
+ * @param {T} value
133
+ * @returns {T}
134
+ */
135
+ function deepFreeze(value) {
136
+ if (value !== null && typeof value === "object" && !Object.isFrozen(value)) {
137
+ Object.freeze(value);
138
+ for (const inner of Object.values(value)) {
139
+ deepFreeze(inner);
140
+ }
141
+ }
142
+ return value;
143
+ }
144
+
145
+ /**
146
+ * Containment, innermost first — the chain {@link nextState} walks when a state
147
+ * declares no edge of its own for an event.
148
+ *
149
+ * @type {Readonly<Record<string, string | null>>}
150
+ */
151
+ const PARENT = Object.freeze({
152
+ [ENCODE_RUN_STATE.STARTING]: ENCODE_RUN_SUPERSTATE.ALIVE,
153
+ [ENCODE_RUN_STATE.PRODUCING]: ENCODE_RUN_SUPERSTATE.ALIVE,
154
+ [ENCODE_RUN_STATE.SUSPENDED]: ENCODE_RUN_SUPERSTATE.ALIVE,
155
+ [ENCODE_RUN_SUPERSTATE.ALIVE]: ENCODE_RUN_SUPERSTATE.WORKING,
156
+ [ENCODE_RUN_STATE.RETRY_WAIT]: ENCODE_RUN_SUPERSTATE.WORKING,
157
+ [ENCODE_RUN_SUPERSTATE.WORKING]: ENCODE_RUN_SUPERSTATE.RUN,
158
+ [ENCODE_RUN_STATE.IDLE]: ENCODE_RUN_SUPERSTATE.RUN,
159
+ [ENCODE_RUN_STATE.STOPPED]: ENCODE_RUN_SUPERSTATE.RUN,
160
+ [ENCODE_RUN_STATE.ENDED_COMPLETE]: ENCODE_RUN_SUPERSTATE.RUN,
161
+ [ENCODE_RUN_STATE.ENDED_FAILED]: ENCODE_RUN_SUPERSTATE.RUN,
162
+ [ENCODE_RUN_SUPERSTATE.RUN]: null
163
+ });
164
+
165
+ /**
166
+ * Events, named for what HAPPENED. An event that names its target cannot be
167
+ * refused without contradicting itself.
168
+ *
169
+ * `EXITED_COMPLETE` and `EXITED_SHORT` are two events for one exit code
170
+ * because ffmpeg exits 0 both at the end of the file and when its input simply
171
+ * stops delivering — a distinction that cost a frozen player and had to be
172
+ * recovered by comparing what was produced against the published playlist
173
+ * (2.9.104). Written down, it can never collapse back into one.
174
+ *
175
+ * @readonly
176
+ */
177
+ export const ENCODE_RUN_EVENT = Object.freeze({
178
+ /** A process was spawned for this session. */
179
+ SPAWNED: "SPAWNED",
180
+ /**
181
+ * The first servable segment of THIS run was served.
182
+ *
183
+ * The only event whose raising is guarded by the current state, and
184
+ * deliberately so: "something has been produced" is a level, not an edge, and
185
+ * the guard is a READ of the state rather than a second copy of it. Declared
186
+ * on STARTING alone, so a segment served by a suspended run cannot resume it
187
+ * — which is exactly the sawtooth of 2.9.93.
188
+ */
189
+ FIRST_SEGMENT: "FIRST_SEGMENT",
190
+ /** `SIGSTOP` was delivered. */
191
+ SUSPEND_ORDERED: "SUSPEND_ORDERED",
192
+ /** `SIGCONT` was sent. */
193
+ RESUME_ORDERED: "RESUME_ORDERED",
194
+ /** The run was stopped with no replacement. */
195
+ STOP_ORDERED: "STOP_ORDERED",
196
+ /** Exit 0, having produced through the last segment. */
197
+ EXITED_COMPLETE: "EXITED_COMPLETE",
198
+ /** Exit 0, short of the last segment — the input dried up. */
199
+ EXITED_SHORT: "EXITED_SHORT",
200
+ /** Died because the input was not there. Recoverable. */
201
+ EXITED_INPUT_LOST: "EXITED_INPUT_LOST",
202
+ /** Died for any other reason, or could not be spawned at all. */
203
+ EXITED_FAILED: "EXITED_FAILED",
204
+ /** The input-retry timer fired. */
205
+ RETRY_DUE: "RETRY_DUE"
206
+ });
207
+
208
+ /**
209
+ * One line per event, for the rendered picture. Same reason as
210
+ * {@link STATE_MEANING}.
211
+ *
212
+ * @type {Readonly<Record<string, string>>}
213
+ */
214
+ export const EVENT_MEANING = Object.freeze({
215
+ [ENCODE_RUN_EVENT.SPAWNED]: "A process was spawned for this session.",
216
+ [ENCODE_RUN_EVENT.FIRST_SEGMENT]: "The first servable segment of this run was served.",
217
+ [ENCODE_RUN_EVENT.SUSPEND_ORDERED]: "SIGSTOP was delivered.",
218
+ [ENCODE_RUN_EVENT.RESUME_ORDERED]: "SIGCONT was sent.",
219
+ [ENCODE_RUN_EVENT.STOP_ORDERED]: "The run was stopped with no replacement.",
220
+ [ENCODE_RUN_EVENT.EXITED_COMPLETE]: "Exit 0, having produced through the last segment.",
221
+ [ENCODE_RUN_EVENT.EXITED_SHORT]: "Exit 0, short of the last segment — the input dried up.",
222
+ [ENCODE_RUN_EVENT.EXITED_INPUT_LOST]: "Died because the input was not there. Recoverable.",
223
+ [ENCODE_RUN_EVENT.EXITED_FAILED]: "Died for any other reason, or could not be spawned.",
224
+ [ENCODE_RUN_EVENT.RETRY_DUE]: "The input-retry timer fired."
225
+ });
226
+
227
+ /**
228
+ * The transition relation. One target per state and event.
229
+ *
230
+ * `SPAWNED` sits on RUN because a run may be spawned from any state at all: at
231
+ * session creation (IDLE), replacing a live run on a seek (ALIVE), after a
232
+ * retry (IDLE), on a switch back to a rung (STOPPED), and after a failure
233
+ * (ENDED_*). Declared once, it also makes the restart edge impossible to
234
+ * forget on a state added later.
235
+ *
236
+ * @type {Readonly<Record<string, Readonly<Record<string, string>>>>}
237
+ */
238
+ const TRANSITIONS = deepFreeze({
239
+ [ENCODE_RUN_SUPERSTATE.RUN]: {
240
+ // A spawn always lands in STARTING, including from STARTING itself: the new
241
+ // run has produced nothing, whatever its predecessor had done.
242
+ [ENCODE_RUN_EVENT.SPAWNED]: ENCODE_RUN_STATE.STARTING
243
+ },
244
+
245
+ [ENCODE_RUN_SUPERSTATE.WORKING]: {
246
+ // Stopping reaches a dead run too: the exit handler leaves the handle in
247
+ // place, so `#stopEncodeRun` runs its course in RETRY_WAIT as well.
248
+ [ENCODE_RUN_EVENT.STOP_ORDERED]: ENCODE_RUN_STATE.STOPPED
249
+ },
250
+
251
+ [ENCODE_RUN_SUPERSTATE.ALIVE]: {
252
+ [ENCODE_RUN_EVENT.SUSPEND_ORDERED]: ENCODE_RUN_STATE.SUSPENDED,
253
+ [ENCODE_RUN_EVENT.EXITED_COMPLETE]: ENCODE_RUN_STATE.ENDED_COMPLETE,
254
+ // Stopping short is a FAILURE that may be restarted, not a finished file.
255
+ [ENCODE_RUN_EVENT.EXITED_SHORT]: ENCODE_RUN_STATE.ENDED_FAILED,
256
+ [ENCODE_RUN_EVENT.EXITED_INPUT_LOST]: ENCODE_RUN_STATE.RETRY_WAIT,
257
+ [ENCODE_RUN_EVENT.EXITED_FAILED]: ENCODE_RUN_STATE.ENDED_FAILED
258
+ },
259
+
260
+ [ENCODE_RUN_STATE.STARTING]: {
261
+ [ENCODE_RUN_EVENT.FIRST_SEGMENT]: ENCODE_RUN_STATE.PRODUCING
262
+ },
263
+
264
+ [ENCODE_RUN_STATE.SUSPENDED]: {
265
+ // Resuming lands in PRODUCING even for a run suspended before its first
266
+ // segment (2.9.117 suspended one 136 ms in). No output distinguishes the
267
+ // two: both read the input, both can be signalled, both hold a missing
268
+ // segment and both say "running" on the wire. The distinction that does
269
+ // exist — the warm-up figure — is answered before the first spawn.
270
+ [ENCODE_RUN_EVENT.RESUME_ORDERED]: ENCODE_RUN_STATE.PRODUCING
271
+ },
272
+
273
+ [ENCODE_RUN_STATE.RETRY_WAIT]: {
274
+ // The timer fired; nothing is running and nothing is armed. The spawn it
275
+ // leads to may still be abandoned (a newer run won the race), and IDLE is
276
+ // the honest state for that moment.
277
+ [ENCODE_RUN_EVENT.RETRY_DUE]: ENCODE_RUN_STATE.IDLE
278
+ }
279
+ });
280
+
281
+ /**
282
+ * What the MISSING edges assert, as data so the tests execute them rather than
283
+ * a reader trusting prose. Each entry is a shipped defect stated as a rule.
284
+ *
285
+ * @type {ReadonlyArray<{ from: string, event: string, mustNotReach: string, because: string }>}
286
+ */
287
+ export const ABSENT_EDGE_INVARIANTS = Object.freeze([
288
+ {
289
+ from: ENCODE_RUN_STATE.SUSPENDED,
290
+ event: ENCODE_RUN_EVENT.FIRST_SEGMENT,
291
+ mustNotReach: ENCODE_RUN_STATE.PRODUCING,
292
+ because:
293
+ "a segment request must not release a suspended encoder — 2.9.93, where any request did, " +
294
+ "and the run sawtoothed from 155 s to 922 s ahead of the viewer in three minutes"
295
+ },
296
+ {
297
+ from: ENCODE_RUN_STATE.ENDED_FAILED,
298
+ event: ENCODE_RUN_EVENT.FIRST_SEGMENT,
299
+ mustNotReach: ENCODE_RUN_STATE.PRODUCING,
300
+ because:
301
+ "a dead run is not a producing one — 2.9.93, where the handle pointed at a corpse and every " +
302
+ "later seek was waved through as already covered, so the session answered 500 for ever"
303
+ },
304
+ {
305
+ from: ENCODE_RUN_STATE.ENDED_FAILED,
306
+ event: ENCODE_RUN_EVENT.RESUME_ORDERED,
307
+ mustNotReach: ENCODE_RUN_STATE.PRODUCING,
308
+ because: "there is no process to continue; only a spawn leads out of a failure"
309
+ },
310
+ {
311
+ from: ENCODE_RUN_STATE.IDLE,
312
+ event: ENCODE_RUN_EVENT.FIRST_SEGMENT,
313
+ mustNotReach: ENCODE_RUN_STATE.PRODUCING,
314
+ because: "nothing produces before a process exists"
315
+ },
316
+ {
317
+ from: ENCODE_RUN_STATE.RETRY_WAIT,
318
+ event: ENCODE_RUN_EVENT.FIRST_SEGMENT,
319
+ mustNotReach: ENCODE_RUN_STATE.PRODUCING,
320
+ because: "a run waiting for its input back has no process; only a spawn resumes production"
321
+ },
322
+ {
323
+ from: ENCODE_RUN_STATE.STOPPED,
324
+ event: ENCODE_RUN_EVENT.RESUME_ORDERED,
325
+ mustNotReach: ENCODE_RUN_STATE.PRODUCING,
326
+ because:
327
+ "a rung the viewer switched away from must not be revived by its own held requests — " +
328
+ "the host has one encoder's worth of capacity and the rung on screen needs it"
329
+ }
330
+ ]);
331
+
332
+ /**
333
+ * The state `event` leads to, or `null` when the event means nothing here.
334
+ *
335
+ * Two answers with two meanings, kept apart on purpose:
336
+ *
337
+ * - `null` — no edge exists for this pair; the event is IGNORED. A caller may
338
+ * reasonably log it, and in this codebase that log line IS the measurement
339
+ * of whether this table matches reality.
340
+ * - the state passed in — an edge exists and leads back here; nothing
341
+ * changed, and no entry work may re-run.
342
+ *
343
+ * Never throws. The machine this pattern replaces did, from inside an event
344
+ * listener, so a refused transition abandoned the rest of the handler and left
345
+ * the app describing a state it was no longer in.
346
+ *
347
+ * @param {string} state - Current state.
348
+ * @param {string} event - One of {@link ENCODE_RUN_EVENT}.
349
+ * @returns {string | null}
350
+ */
351
+ export function nextState(state, event) {
352
+ let scope = state;
353
+ while (scope) {
354
+ const target = TRANSITIONS[scope]?.[event];
355
+ if (target !== undefined) {
356
+ return target;
357
+ }
358
+ scope = PARENT[scope] ?? null;
359
+ }
360
+ return null;
361
+ }
362
+
363
+ /**
364
+ * Whether `state` sits inside `superstate` (or is it).
365
+ *
366
+ * @param {string} state
367
+ * @param {string} superstate - One of {@link ENCODE_RUN_SUPERSTATE}.
368
+ * @returns {boolean}
369
+ */
370
+ export function isWithin(state, superstate) {
371
+ let scope = state;
372
+ while (scope) {
373
+ if (scope === superstate) {
374
+ return true;
375
+ }
376
+ scope = PARENT[scope] ?? null;
377
+ }
378
+ return false;
379
+ }
380
+
381
+ /**
382
+ * Is anything reading the input right now?
383
+ *
384
+ * The output the torrent turns on, and the one that had no name anywhere in the
385
+ * codebase until the pool learned it the hard way: suspending the encoder stops
386
+ * the only reader, the reader's window is then satisfied, WebTorrent drops the
387
+ * selection, and the download dies with the swarm wide open — eleven minutes of
388
+ * it, measured 2026-08-05 with 150 peers connected.
389
+ *
390
+ * @param {string} state
391
+ * @returns {boolean}
392
+ */
393
+ export function isInputBeingRead(state) {
394
+ return state === ENCODE_RUN_STATE.STARTING || state === ENCODE_RUN_STATE.PRODUCING;
395
+ }
396
+
397
+ /**
398
+ * May a signal be sent to this run's process?
399
+ *
400
+ * Replaces re-deriving the answer from a child-process handle at five sites.
401
+ * The OS remains the authority on whether a pid still exists: a caller must
402
+ * keep its `try`/`catch` and feed a throw back as an exit event, never
403
+ * contradict it. A machine that believes it owns the process's life is wrong
404
+ * the first time ffmpeg is killed from outside.
405
+ *
406
+ * @param {string} state
407
+ * @returns {boolean}
408
+ */
409
+ export function processCanBeSignalled(state) {
410
+ return isWithin(state, ENCODE_RUN_SUPERSTATE.ALIVE);
411
+ }
412
+
413
+ /**
414
+ * What a request for a segment that is not on disk gets.
415
+ *
416
+ * `"hold"` and `"fail"` were three answers to one condition across the serving
417
+ * path — hold, 404 and 500 — chosen at each site. They are one answer here.
418
+ *
419
+ * @param {string} state
420
+ * @returns {"hold" | "fail"}
421
+ */
422
+ export function answerForMissingSegment(state) {
423
+ return state === ENCODE_RUN_STATE.ENDED_FAILED ? "fail" : "hold";
424
+ }
425
+
426
+ /**
427
+ * The status string the browser is given.
428
+ *
429
+ * A Moore output rather than a second field maintained by hand at seven sites,
430
+ * which is how the two came to be read together with `||`.
431
+ *
432
+ * @param {string} state
433
+ * @returns {"starting" | "running" | "ready" | "failed"}
434
+ */
435
+ export function wireState(state) {
436
+ if (state === ENCODE_RUN_STATE.IDLE || state === ENCODE_RUN_STATE.RETRY_WAIT) {
437
+ return "starting";
438
+ }
439
+ if (state === ENCODE_RUN_STATE.ENDED_COMPLETE) {
440
+ return "ready";
441
+ }
442
+ if (state === ENCODE_RUN_STATE.ENDED_FAILED) {
443
+ return "failed";
444
+ }
445
+ // STARTING, PRODUCING, SUSPENDED and STOPPED. The last of these keeps the
446
+ // value its run left behind, which is what a stopped rung reports today; a
447
+ // family's progress is answered from the variant on screen in any case.
448
+ return "running";
449
+ }
450
+
451
+ /**
452
+ * May the encoder be repositioned from this state?
453
+ *
454
+ * False only for a run that reached the end of the file: everything it could
455
+ * produce exists, so a restart would re-make what is already on disk.
456
+ *
457
+ * @param {string} state
458
+ * @returns {boolean}
459
+ */
460
+ export function mayRestart(state) {
461
+ return state !== ENCODE_RUN_STATE.ENDED_COMPLETE;
462
+ }
463
+
464
+ /**
465
+ * Every declared edge, flattened, for the tests and for drawing the graph.
466
+ * Superstate edges are reported against the superstate, not expanded.
467
+ *
468
+ * @returns {Array<{ from: string, event: string, to: string }>}
469
+ */
470
+ export function declaredEdges() {
471
+ const edges = [];
472
+ for (const [from, byEvent] of Object.entries(TRANSITIONS)) {
473
+ for (const [event, to] of Object.entries(byEvent)) {
474
+ edges.push({ from, event, to });
475
+ }
476
+ }
477
+ return edges;
478
+ }
479
+
480
+ /**
481
+ * The containment chain, for the graph renderer. A copy, so no caller can edit
482
+ * the table by editing what it was handed.
483
+ *
484
+ * @returns {Array<{ state: string, parent: string | null }>}
485
+ */
486
+ export function declaredContainment() {
487
+ return Object.entries(PARENT).map(([state, parent]) => ({ state, parent }));
488
+ }
489
+
490
+ /**
491
+ * Every run in one output's registered collection, earliest first.
492
+ *
493
+ * @param {object[] | Set<object>} runs
494
+ * @returns {object[]}
495
+ */
496
+ export function runsOf(runs) {
497
+ const listed = Array.isArray(runs) ? runs : runs instanceof Set ? [...runs] : [];
498
+ return [...listed].sort((left, right) => left.from - right.from);
499
+ }
500
+
501
+ /**
502
+ * The runs in one output's registered collection that still have a process.
503
+ *
504
+ * @param {object[] | Set<object>} runs
505
+ * @returns {object[]}
506
+ */
507
+ export function liveRunsOf(runs) {
508
+ return runsOf(runs).filter((run) => run.isAlive);
509
+ }
510
+
511
+ /**
512
+ * What one output's registered encoders are doing, as one state.
513
+ *
514
+ * The most advanced state among its live runs: an output with anything
515
+ * producing IS producing, whatever else it has going. An output that has never
516
+ * started a run, or whose runs have all ended, is at the table's own initial
517
+ * state — which is what "nothing is encoding" means.
518
+ *
519
+ * @param {object[] | Set<object>} runs
520
+ * @returns {string}
521
+ */
522
+ export function runStateOf(runs) {
523
+ let answer = INITIAL_RUN_STATE;
524
+ let rank = -1;
525
+ for (const run of runsOf(runs)) {
526
+ const at = RUN_STATE_ORDER.indexOf(run.state);
527
+ if (at > rank) {
528
+ rank = at;
529
+ answer = run.state;
530
+ }
531
+ }
532
+ return answer;
533
+ }
534
+
535
+ /**
536
+ * How advanced a run state is, for reducing several runs to one answer.
537
+ *
538
+ * Producing outranks starting, and both outrank a run that has ended: what a
539
+ * caller asking "what is this output's encoding doing" wants to know is
540
+ * whether anything is being made, not what the quietest of them is up to.
541
+ */
542
+ const RUN_STATE_ORDER = [
543
+ ENCODE_RUN_STATE.ENDED_FAILED,
544
+ ENCODE_RUN_STATE.ENDED_COMPLETE,
545
+ ENCODE_RUN_STATE.STOPPED,
546
+ ENCODE_RUN_STATE.IDLE,
547
+ ENCODE_RUN_STATE.RETRY_WAIT,
548
+ ENCODE_RUN_STATE.SUSPENDED,
549
+ ENCODE_RUN_STATE.STARTING,
550
+ ENCODE_RUN_STATE.PRODUCING
551
+ ];