@torrent-tv/proxy 2.87.10 → 2.87.12

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 (469) 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 +2191 -2181
  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/browser-proxy-contract.md +124 -101
  23. package/docs/container-architecture.md +218 -218
  24. package/docs/download-architecture.md +261 -261
  25. package/docs/encode-architecture.md +729 -729
  26. package/docs/encode-run-state.md +96 -96
  27. package/docs/logs.md +97 -97
  28. package/docs/socks5-egress-research.md +114 -114
  29. package/docs/storage-architecture.md +267 -267
  30. package/knip.json +14 -14
  31. package/openspec/changes/adaptive-bitrate/design.md +92 -92
  32. package/openspec/changes/adaptive-bitrate/proposal.md +56 -56
  33. package/openspec/changes/adaptive-bitrate/specs/adaptive-bitrate/spec.md +51 -51
  34. package/openspec/changes/adaptive-bitrate/tasks.md +40 -40
  35. package/openspec/changes/binary-distribution/.openspec.yaml +2 -2
  36. package/openspec/changes/binary-distribution/proposal.md +53 -53
  37. package/openspec/changes/chunked-request-bodies/design.md +81 -81
  38. package/openspec/changes/chunked-request-bodies/proposal.md +53 -53
  39. package/openspec/changes/chunked-request-bodies/specs/chunked-request-bodies/spec.md +30 -30
  40. package/openspec/changes/chunked-request-bodies/tasks.md +40 -40
  41. package/openspec/changes/cold-start/design.md +98 -98
  42. package/openspec/changes/cold-start/proposal.md +62 -62
  43. package/openspec/changes/cold-start/specs/cold-start/spec.md +47 -47
  44. package/openspec/changes/cold-start/tasks.md +48 -48
  45. package/openspec/changes/disk-cap/.openspec.yaml +2 -2
  46. package/openspec/changes/disk-cap/proposal.md +37 -37
  47. package/openspec/changes/disk-cap/specs/disk-cap/spec.md +25 -25
  48. package/openspec/changes/disk-cap/tasks.md +19 -19
  49. package/openspec/changes/proxy-observability/.openspec.yaml +2 -2
  50. package/openspec/changes/proxy-observability/design.md +38 -38
  51. package/openspec/changes/proxy-observability/proposal.md +49 -49
  52. package/openspec/changes/proxy-observability/specs/observability/spec.md +33 -33
  53. package/openspec/changes/proxy-observability/tasks.md +21 -21
  54. package/openspec/changes/seek-debounce/design.md +118 -118
  55. package/openspec/changes/seek-debounce/proposal.md +59 -59
  56. package/openspec/changes/seek-debounce/specs/seek-debounce/spec.md +41 -41
  57. package/openspec/changes/seek-debounce/tasks.md +33 -33
  58. package/openspec/changes/subtitle-language/.openspec.yaml +2 -2
  59. package/openspec/changes/subtitle-language/proposal.md +50 -50
  60. package/openspec/changes/subtitle-language/specs/subtitle-language/spec.md +34 -34
  61. package/openspec/changes/subtitle-language/tasks.md +26 -26
  62. package/openspec/changes/track-selection/.openspec.yaml +2 -2
  63. package/openspec/changes/track-selection/design.md +47 -47
  64. package/openspec/changes/track-selection/proposal.md +45 -45
  65. package/openspec/changes/track-selection/specs/track-selection/spec.md +41 -41
  66. package/openspec/changes/track-selection/tasks.md +20 -20
  67. package/openspec/changes/transcode-quality/.openspec.yaml +2 -2
  68. package/openspec/changes/transcode-quality/proposal.md +51 -51
  69. package/openspec/changes/transcode-quality/specs/transcode-quality/spec.md +139 -139
  70. package/openspec/changes/transcode-quality/tasks.md +63 -63
  71. package/openspec/config.yaml +38 -38
  72. package/package.json +50 -50
  73. package/public/.well-known/appspecific/com.chrome.devtools.json +1 -1
  74. package/research/delivery-wedge-stand-ladder-2026-09-13.md +329 -329
  75. package/research/double-spawn-2026-09-10.md +171 -171
  76. package/research/handover-2026-09-13.md +209 -209
  77. package/research/handover-reader-claims-removal-2026-09-12.md +166 -166
  78. package/research/piece-withdrawn-but-still-claimed-2026-09-12.md +175 -175
  79. package/research/preset-benchmark-size-scaling-2026-08-22.md +55 -55
  80. package/research/priority-map-is-the-truth-2026-09-12.md +225 -225
  81. package/routes/api/client-logs/post.js +86 -86
  82. package/routes/api/delivery-sink/get.js +72 -72
  83. package/routes/api/link-probe/get.js +51 -51
  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/sources/warm/post.js +217 -217
  89. package/routes/api/subtitles/get.js +230 -230
  90. package/routes/api/transcode-sessions/fragment-far/post.js +60 -60
  91. package/routes/api/transcode-sessions/net-report/post.js +136 -129
  92. package/routes/api/transcode-sessions/post.js +173 -160
  93. package/routes/api/transcode-sessions/progress/get.js +27 -27
  94. package/routes/api/transcode-sessions/release/post.js +41 -41
  95. package/routes/api/transcode-sessions/seek/post.js +63 -63
  96. package/routes/health/get.js +13 -13
  97. package/routes/healthz/get.js +13 -13
  98. package/routes/stream/get.js +361 -361
  99. package/routes/transcode/audio-file/get.js +64 -64
  100. package/routes/transcode/audio-warm/get.js +84 -84
  101. package/routes/transcode/session-file/get.js +52 -52
  102. package/routes/transcode/variant-file/get.js +95 -95
  103. package/routes/transcode/variant-warm/get.js +84 -84
  104. package/scripts/render-run-graph.js +173 -173
  105. package/server.js +725 -725
  106. package/services/encode/CoverageMap.js +428 -428
  107. package/services/encode/CushionReport.js +345 -345
  108. package/services/encode/EncodeAdmission.js +376 -332
  109. package/services/encode/EncodeOrchestrator.js +1217 -1217
  110. package/services/encode/EncodePlan.js +1366 -1366
  111. package/services/encode/EncodeRun.js +776 -776
  112. package/services/encode/EncodeRuns.js +1229 -1229
  113. package/services/encode/Encoder.js +142 -142
  114. package/services/encode/EncoderSelection.js +38 -38
  115. package/services/encode/LocalObservations.js +359 -359
  116. package/services/encode/NvencEncoder.js +50 -50
  117. package/services/encode/OutputOpening.js +758 -755
  118. package/services/encode/OutputTimes.js +579 -579
  119. package/services/encode/QsvEncoder.js +58 -58
  120. package/services/encode/Renditions.js +2184 -2162
  121. package/services/encode/RunProgress.js +84 -84
  122. package/services/encode/SegmentDemand.js +95 -95
  123. package/services/encode/SoftwareEncoder.js +121 -121
  124. package/services/encode/V4l2m2mEncoder.js +53 -53
  125. package/services/encode/VaapiEncoder.js +66 -66
  126. package/services/encode/args.js +416 -416
  127. package/services/encode/available-share.js +89 -89
  128. package/services/encode/calibration.js +361 -361
  129. package/services/encode/contention.js +128 -128
  130. package/services/encode/decode-cost-fit.js +363 -363
  131. package/services/encode/encode-exit.js +114 -114
  132. package/services/encode/encode-run-state.js +551 -551
  133. package/services/encode/encoder-readings.js +45 -45
  134. package/services/encode/fingerprint.js +322 -322
  135. package/services/encode/host-load.js +174 -174
  136. package/services/encode/hwaccel.js +1894 -1894
  137. package/services/encode/index.js +9 -9
  138. package/services/encode/learned-median.js +90 -90
  139. package/services/encode/output/EncodedOutput.js +57 -57
  140. package/services/encode/output/Output.js +131 -131
  141. package/services/encode/output/OutputCatalog.js +414 -414
  142. package/services/encode/output/OutputSpec.js +390 -390
  143. package/services/encode/output/Timeline.js +308 -308
  144. package/services/encode/output/cut-grid.js +107 -107
  145. package/services/encode/output/index.js +20 -20
  146. package/services/encode/output/ladder.js +32 -32
  147. package/services/encode/output/playlists.js +284 -284
  148. package/services/encode/output/rates.js +125 -125
  149. package/services/encode/output-key-format.js +21 -21
  150. package/services/encode/quality/EncodeCost.js +1141 -1083
  151. package/services/encode/quality/HostLoad.js +525 -525
  152. package/services/encode/quality/HostTimings.js +249 -249
  153. package/services/encode/quality/OutputQualityState.js +28 -28
  154. package/services/encode/quality/QualityController.js +935 -935
  155. package/services/encode/quality/QualityOffer.js +416 -416
  156. package/services/encode/quality/drain-threat.js +47 -47
  157. package/services/encode/quality/link-budget.js +254 -254
  158. package/services/encode/quality/output-format.js +315 -266
  159. package/services/encode/quality/serving-output.js +216 -216
  160. package/services/encode/quality/visible-rung.js +57 -57
  161. package/services/encode/run-budget.js +97 -97
  162. package/services/encode/run-command.js +747 -747
  163. package/services/encode/run-costs.js +155 -155
  164. package/services/encode/run-inputs.js +42 -42
  165. package/services/encode/segment-formats/fmp4.js +437 -437
  166. package/services/encode/segment-formats/index.js +77 -77
  167. package/services/encode/segment-formats/init-compat.js +324 -324
  168. package/services/encode/segment-formats/mp4-boxes.js +311 -311
  169. package/services/encode/segment-formats/mpegts.js +134 -134
  170. package/services/encode/start-stop-cost.js +178 -178
  171. package/services/encode/throughput.js +97 -97
  172. package/services/encode/torrent-cost.js +88 -88
  173. package/services/identity/installation-id.js +38 -38
  174. package/services/media/ContainerOrchestrator.js +149 -149
  175. package/services/media/KeyframeTables.js +316 -316
  176. package/services/media/SourceFile.js +298 -298
  177. package/services/media/SubtitleCues.js +520 -520
  178. package/services/media/SubtitleOrchestrator.js +167 -167
  179. package/services/media/audio-inventory.js +245 -245
  180. package/services/media/container/AviContainer.js +266 -266
  181. package/services/media/container/Container.js +603 -603
  182. package/services/media/container/ContainerFactory.js +56 -56
  183. package/services/media/container/KeyframeTable.js +272 -272
  184. package/services/media/container/MatroskaContainer.js +1494 -1494
  185. package/services/media/container/Mp4Container.js +1244 -1244
  186. package/services/media/container/SubtitleFileContainer.js +322 -322
  187. package/services/media/container/ebml-reader.js +159 -159
  188. package/services/media/ffmpeg-banner.js +260 -260
  189. package/services/media/keyframe-probe.js +157 -157
  190. package/services/media/media-info-probe.js +93 -93
  191. package/services/media/playback-planner.js +931 -931
  192. package/services/media/tracks/AudioTrack.js +131 -131
  193. package/services/media/tracks/ContainerTrack.js +75 -75
  194. package/services/media/tracks/ImageSubtitleTrack.js +19 -19
  195. package/services/media/tracks/SubtitleTrack.js +38 -38
  196. package/services/media/tracks/TextSubtitleTrack.js +287 -287
  197. package/services/media/tracks/VideoTrack.js +33 -33
  198. package/services/media/tracks/index.js +15 -15
  199. package/services/media/tracks/language-detect.js +174 -174
  200. package/services/server/OutputLifecycle.js +418 -418
  201. package/services/server/SegmentServing.js +1146 -1146
  202. package/services/server/ViewerRequests.js +727 -522
  203. package/services/server/WaitLedger.js +142 -142
  204. package/services/server/controllers/PlaybackController.js +40 -40
  205. package/services/server/controllers/SubtitleController.js +109 -109
  206. package/services/server/http-responses.js +60 -60
  207. package/services/server/playback-readiness.js +620 -0
  208. package/services/server/transcode-session-files.js +325 -325
  209. package/services/server/wire-outputs.js +992 -983
  210. package/services/storage/Diagnostics.js +202 -202
  211. package/services/storage/MachineBudget.js +235 -235
  212. package/services/storage/allowance.js +107 -107
  213. package/services/storage/core-dumps.js +106 -106
  214. package/services/storage/files/CompletedFiles.js +391 -391
  215. package/services/storage/files/piece-from-whole-file.js +118 -118
  216. package/services/storage/free.js +71 -71
  217. package/services/storage/keep.js +48 -48
  218. package/services/storage/machine-memory.js +56 -56
  219. package/services/storage/memory-report.js +575 -575
  220. package/services/storage/piece-store/piece-disk-store.js +516 -516
  221. package/services/storage/piece-store/piece-lru.js +495 -495
  222. package/services/storage/piece-store/shared-piece-store.js +1880 -1880
  223. package/services/storage/returns.js +103 -103
  224. package/services/storage/segment-store/SegmentStore.js +1196 -1196
  225. package/services/storage/wire.js +175 -175
  226. package/services/torrent/Contents.js +324 -324
  227. package/services/torrent/demand/DemandRegister.js +202 -202
  228. package/services/torrent/demand/Urgency.js +137 -137
  229. package/services/torrent/demand/Window.js +118 -118
  230. package/services/torrent/demand/index.js +8 -8
  231. package/services/torrent/demand/pieces.js +140 -140
  232. package/services/torrent/download/SwarmSelection.js +386 -386
  233. package/services/torrent/download/registry.js +102 -102
  234. package/services/torrent/download/withdraw-claim.js +80 -80
  235. package/services/torrent/files.js +455 -455
  236. package/services/torrent/naming.js +619 -619
  237. package/services/torrent/piece-store-of.js +29 -29
  238. package/services/torrent/supply-margin.js +262 -262
  239. package/services/torrent/torrent-pool.js +2675 -2675
  240. package/services/torrent/worker/background-fill.js +213 -213
  241. package/services/torrent/worker/channel.js +271 -271
  242. package/services/torrent/worker/client.js +765 -765
  243. package/services/torrent/worker/fastest-wires.js +342 -342
  244. package/services/torrent/worker/handle-state.js +23 -23
  245. package/services/torrent/worker/held-bytes.js +155 -155
  246. package/services/torrent/worker/install-webrtc-shim.js +32 -32
  247. package/services/torrent/worker/piece-reader.js +1078 -1078
  248. package/services/torrent/worker/pool-adapter.js +365 -365
  249. package/services/torrent/worker/protocol.js +184 -184
  250. package/services/torrent/worker/resume-warm.js +107 -107
  251. package/services/torrent/worker/webrtc-shim.js +219 -219
  252. package/services/torrent/worker/worker.js +1129 -1129
  253. package/services/transport/data-channel-handler.js +1369 -1369
  254. package/services/transport/delivery-probe.js +842 -842
  255. package/services/transport/health-collector.js +53 -53
  256. package/services/transport/nat-classifier.js +231 -231
  257. package/services/transport/packet-witness.js +808 -808
  258. package/services/transport/port-mapper.js +235 -235
  259. package/services/transport/registry-api.js +81 -81
  260. package/services/transport/tunnel-client.js +447 -447
  261. package/services/transport/usrsctp-state.js +175 -175
  262. package/services/transport/webrtc-manager.js +484 -484
  263. package/services/viewer/Assignments.js +340 -340
  264. package/services/viewer/PriorityMap.js +390 -390
  265. package/services/viewer/PriorityOrchestrator.js +325 -325
  266. package/services/viewer/Viewer.js +682 -657
  267. package/services/viewer/Viewers.js +368 -368
  268. package/services/viewer/active-output.js +37 -37
  269. package/services/viewer/audio-start.js +46 -46
  270. package/services/viewer/buffer-trend.js +81 -81
  271. package/services/viewer/choices.js +647 -647
  272. package/services/viewer/positions.js +126 -126
  273. package/services/viewer/report-intake.js +46 -46
  274. package/store/source-registry.js +71 -71
  275. package/test/asset-paths.test.js +28 -28
  276. package/test/audio-inventory.test.js +212 -212
  277. package/test/audio-track-bitrate.test.js +40 -40
  278. package/test/auto-quality-step.test.js +707 -707
  279. package/test/available-share.test.js +76 -76
  280. package/test/background-fill.test.js +190 -190
  281. package/test/client-log-file.test.js +110 -110
  282. package/test/completed-files.test.js +115 -115
  283. package/test/concurrent-cost.test.js +148 -148
  284. package/test/container-media-info.test.js +228 -228
  285. package/test/contention.test.js +76 -76
  286. package/test/core-dumps.test.js +57 -57
  287. package/test/coverage-follows-the-disk.test.js +228 -228
  288. package/test/coverage-map.test.js +195 -195
  289. package/test/cue-push-carries-what-the-walk-found.test.js +58 -58
  290. package/test/cut-times-timeline.test.js +65 -65
  291. package/test/cuts-follow-published-grid.test.js +109 -109
  292. package/test/data-channel-frame.test.js +63 -63
  293. package/test/data-channel-viewer-lifecycle.test.js +92 -92
  294. package/test/dead-torrent-handle.test.js +52 -52
  295. package/test/declared-rates.test.js +116 -116
  296. package/test/declared-tracks.test.js +43 -43
  297. package/test/decode-cost-fit.test.js +202 -202
  298. package/test/decode-cost.test.js +462 -462
  299. package/test/delivery-probe.test.js +393 -393
  300. package/test/demand-register.test.js +206 -206
  301. package/test/dht-bootstrap.test.js +72 -72
  302. package/test/drain-threat.test.js +65 -65
  303. package/test/duplicate-add.test.js +48 -48
  304. package/test/encode-admission.test.js +146 -146
  305. package/test/encode-cost.test.js +283 -283
  306. package/test/encode-exit.test.js +111 -111
  307. package/test/encode-orchestrator.test.js +419 -419
  308. package/test/encode-plan-viewers.test.js +718 -718
  309. package/test/encode-plan.test.js +545 -545
  310. package/test/encode-run-state.test.js +314 -314
  311. package/test/encode-run.test.js +161 -161
  312. package/test/encode-slope.test.js +46 -46
  313. package/test/encoded-output.test.js +39 -39
  314. package/test/encoder-kinds.test.js +122 -122
  315. package/test/encoder-readings.test.js +46 -46
  316. package/test/every-claimant-is-told-its-share.test.js +152 -152
  317. package/test/failed-encoder-still-serves-what-exists.test.js +354 -354
  318. package/test/failed-start-breaker.test.js +202 -202
  319. package/test/fastest-wires.test.js +143 -143
  320. package/test/ffmpeg-stream-counts.test.js +78 -78
  321. package/test/file-edges.test.js +191 -191
  322. package/test/fmp4-self-contained.test.js +80 -80
  323. package/test/fmp4-timestamps.test.js +140 -140
  324. package/test/fmp4-track-completeness.test.js +41 -41
  325. package/test/format-keyed-outputs.test.js +78 -78
  326. package/test/health-metrics.test.js +38 -38
  327. package/test/held-request-width.test.js +157 -157
  328. package/test/helpers/encode-run.js +136 -136
  329. package/test/helpers/held-file.js +29 -29
  330. package/test/helpers/manager.js +57 -57
  331. package/test/helpers/output-spec.js +63 -63
  332. package/test/host-load.test.js +68 -68
  333. package/test/index-accuracy-is-about-the-file.test.js +128 -128
  334. package/test/init-compat.test.js +219 -219
  335. package/test/input-lost-quiets-the-plan.test.js +261 -261
  336. package/test/input-unavailable.test.js +48 -48
  337. package/test/installation-id.test.js +39 -39
  338. package/test/keeping-period.test.js +83 -83
  339. package/test/keyframe-index-accuracy.test.js +188 -188
  340. package/test/keyframe-table-budget.test.js +102 -102
  341. package/test/keyframes-belong-to-the-file.test.js +249 -249
  342. package/test/learned-median.test.js +37 -37
  343. package/test/letting-go-asks-who-is-watching.test.js +191 -191
  344. package/test/limit-row-by-area.test.js +60 -60
  345. package/test/link-budget.test.js +111 -111
  346. package/test/link-probe.test.js +56 -56
  347. package/test/local-encoding-data.test.js +273 -273
  348. package/test/logger-repeats.test.js +134 -134
  349. package/test/look-ahead-coverage.test.js +56 -56
  350. package/test/manager-surface.test.js +292 -292
  351. package/test/matroska-cues-track.test.js +192 -192
  352. package/test/memory-budget.test.js +390 -390
  353. package/test/move-cost.test.js +216 -216
  354. package/test/mp4-subtitles.test.js +173 -173
  355. package/test/one-authority.test.js +285 -285
  356. package/test/one-budget.test.js +149 -149
  357. package/test/one-output-one-session.test.js +204 -204
  358. package/test/one-resource-divided.test.js +185 -185
  359. package/test/one-serving-output-per-height.test.js +458 -458
  360. package/test/orchestrator-wired.test.js +206 -206
  361. package/test/output-catalog.test.js +39 -39
  362. package/test/output-shape.test.js +21 -21
  363. package/test/output-spec.test.js +251 -251
  364. package/test/output-speed.test.js +88 -88
  365. package/test/outputs-being-prepared.test.js +40 -40
  366. package/test/packet-witness-ring.test.js +236 -236
  367. package/test/packet-witness.test.js +148 -148
  368. package/test/piece-disk-store.test.js +381 -381
  369. package/test/piece-from-whole-file.test.js +129 -129
  370. package/test/piece-lru.test.js +319 -319
  371. package/test/piece-reader.test.js +162 -162
  372. package/test/piece-selection-offset.test.js +85 -85
  373. package/test/piece-store-eviction.test.js +560 -560
  374. package/test/piece-store-never-refuses.test.js +153 -153
  375. package/test/piece-store-reservations.test.js +318 -318
  376. package/test/piece-store-slow-disk.test.js +159 -159
  377. package/test/piece-tail.test.js +97 -97
  378. package/test/plan-host-timings.test.js +68 -68
  379. package/test/plan-is-steady.test.js +225 -225
  380. package/test/playback-readiness.test.js +323 -0
  381. package/test/priority-map-download.test.js +174 -174
  382. package/test/priority-map-emptied.test.js +204 -204
  383. package/test/priority-map-per-output.test.js +215 -215
  384. package/test/priority-map.test.js +163 -163
  385. package/test/probe-wedge-certainty.test.js +60 -60
  386. package/test/produced-copy-choice.test.js +213 -213
  387. package/test/published-timeline.test.js +83 -83
  388. package/test/quality-offer.test.js +162 -162
  389. package/test/quality-variants.test.js +1229 -1229
  390. package/test/rate-control-in-the-output.test.js +180 -180
  391. package/test/read-survives-withdrawal.test.js +164 -164
  392. package/test/read-window.test.js +365 -365
  393. package/test/resume-warm.test.js +39 -39
  394. package/test/run-graph-drift.test.js +37 -37
  395. package/test/run-inputs.test.js +80 -80
  396. package/test/run-intervals.test.js +100 -100
  397. package/test/run-position-follows-published-grid.test.js +89 -89
  398. package/test/run-progress.test.js +65 -65
  399. package/test/same-height-switch.test.js +664 -664
  400. package/test/seek-frees-the-viewers-requests.test.js +217 -217
  401. package/test/seek-landing.test.js +109 -109
  402. package/test/seek-target-not-superseded.test.js +195 -195
  403. package/test/segment-closed-on-both-branches.test.js +96 -96
  404. package/test/segment-cut-times.test.js +63 -63
  405. package/test/segment-demand.test.js +80 -80
  406. package/test/segment-hold-supersede.test.js +91 -91
  407. package/test/segment-judged-by-its-own-header.test.js +221 -221
  408. package/test/segment-serve-wiring.test.js +475 -475
  409. package/test/segment-store-eviction.test.js +247 -247
  410. package/test/segment-store.test.js +323 -323
  411. package/test/segment-true-start.test.js +86 -86
  412. package/test/segments-are-shared.test.js +176 -176
  413. package/test/send-chunk-bytes.test.js +86 -86
  414. package/test/serving-existing-output.test.js +102 -102
  415. package/test/serving-output.test.js +102 -102
  416. package/test/shared-piece-store.test.js +310 -310
  417. package/test/sidecar-naming.test.js +142 -142
  418. package/test/source-file.test.js +133 -133
  419. package/test/source-files-route.test.js +103 -103
  420. package/test/source-registry.test.js +18 -18
  421. package/test/split-a-stretch.test.js +139 -139
  422. package/test/stale-request-after-seek.test.js +158 -158
  423. package/test/startup-readings.test.js +124 -124
  424. package/test/stream-route.test.js +182 -182
  425. package/test/subtitle-cue-framing.test.js +200 -200
  426. package/test/subtitle-cue-source.test.js +102 -102
  427. package/test/subtitle-cue-walk.test.js +370 -370
  428. package/test/subtitle-cursor.test.js +63 -63
  429. package/test/subtitle-defaults.test.js +118 -118
  430. package/test/subtitle-language.test.js +252 -252
  431. package/test/subtitle-track-numbering.test.js +386 -386
  432. package/test/supply-margin.test.js +177 -177
  433. package/test/swarm-follows-readers.test.js +174 -174
  434. package/test/swarm-reach.test.js +130 -130
  435. package/test/swarm-selection.test.js +220 -220
  436. package/test/tail-duplication.test.js +167 -167
  437. package/test/the-channel-has-both-ends.test.js +91 -91
  438. package/test/the-torrent-thread-serves-bytes.test.js +107 -107
  439. package/test/thread-pool.test.js +53 -53
  440. package/test/timeline.test.js +84 -84
  441. package/test/torrent-contents.test.js +235 -235
  442. package/test/torrent-cost.test.js +71 -71
  443. package/test/torrent-files.test.js +221 -221
  444. package/test/torrent-naming.test.js +255 -255
  445. package/test/tracks-begin-together.test.js +209 -209
  446. package/test/tunnel-renewal.test.js +167 -167
  447. package/test/two-viewers-one-picture.test.js +407 -407
  448. package/test/upload-hurry.test.js +186 -186
  449. package/test/usrsctp-state.test.js +131 -131
  450. package/test/video-facts.test.js +102 -102
  451. package/test/viewer-assignments.test.js +143 -143
  452. package/test/viewer-outputs.test.js +285 -285
  453. package/test/viewer-presence.test.js +116 -116
  454. package/test/viewer-requests-admission.test.js +89 -89
  455. package/test/viewer-states.test.js +189 -189
  456. package/test/viewer-subtitle-subscription.test.js +96 -96
  457. package/test/viewer.test.js +139 -139
  458. package/test/viewing-generations.test.js +390 -390
  459. package/test/visible-rung.test.js +37 -37
  460. package/test/wait-ledger.test.js +100 -100
  461. package/test/webrtc-shim.test.js +149 -149
  462. package/test/wedge-certainty.test.js +131 -131
  463. package/test/withdraw-piece-claim.test.js +212 -212
  464. package/test/worker-channel.test.js +158 -158
  465. package/utils/client-log-file.js +151 -151
  466. package/utils/logger.js +312 -312
  467. package/utils/parse-range.js +25 -25
  468. package/utils/perf.js +59 -59
  469. package/utils/torrent-source-key.js +38 -38
@@ -1,575 +1,575 @@
1
- /**
2
- * @file What this process is holding, said out loud on a regular cadence.
3
- *
4
- * Written 2026-08-28, after the kernel killed the proxy and the log could not
5
- * say why. The supervisor recorded `exit code 137` — SIGKILL, so no core dump —
6
- * and the kernel ring buffer held the whole of what was known:
7
- *
8
- * Out of memory: Killed process 3036113 (MainThread)
9
- * anon-rss: 2422628kB total-vm: 20856720kB oom_score_adj: 200
10
- *
11
- * Two point four gigabytes, on a host with under two free, and the addon is the
12
- * first thing the kernel picks because Home Assistant gives addons a positive
13
- * `oom_score_adj`. What the proxy had been logging all along was its share of a
14
- * CPU. Nothing anywhere said how much memory it held, so the growth that ended
15
- * in that line has no shape: one final reading taken by the kernel, and no
16
- * series leading to it.
17
- *
18
- * This is that series. It costs one line a minute and reads only counters the
19
- * runtime already maintains.
20
- */
21
-
22
- import { readdir, readFile, rm, statfs } from "node:fs/promises";
23
- import { availableMemory } from "./machine-memory.js";
24
- import os from "node:os";
25
- import v8 from "node:v8";
26
- import path from "node:path";
27
-
28
- /** How often the reading is taken and written. */
29
- export const MEMORY_REPORT_INTERVAL_MS = 60_000;
30
-
31
- /**
32
- * How often the torrent worker takes its own reading.
33
- *
34
- * A minute cannot see what killed it. Three times — 2026-08-30 14:00 and 23:19,
35
- * 2026-08-31 13:27 — the worker's heap read 28-36 MB in one sample and the
36
- * thread was dead by the sample after next, with the whole rise from 30 MB to
37
- * the 2240 MB heap limit fitting inside a single gap. A second is short enough
38
- * that the rise is a curve rather than a step, and the line is only WRITTEN when
39
- * something moved, so a quiet session costs what it costs today.
40
- */
41
- export const WORKER_MEMORY_SAMPLE_MS = 1_000;
42
-
43
- /**
44
- * What the process is holding, from the runtime's own counters.
45
- *
46
- * `rss` is what the kernel counts against us and therefore what the OOM killer
47
- * reads. The rest says where it went: the JavaScript heap, and everything held
48
- * outside it — which for this proxy is where the interesting growth lives,
49
- * since torrent pieces sit in a `SharedArrayBuffer` and segment bodies pass
50
- * through buffers.
51
- *
52
- * `heapLimit` is this isolate's own ceiling, and it belongs beside the heap
53
- * figures because it is what the runtime kills the thread for reaching — a
54
- * worker created without `resourceLimits` inherits the main isolate's, 2240 MB
55
- * on the addon host. Without it the log said 30 MB and gave no idea how far
56
- * that was from the end.
57
- *
58
- * @returns {{ rss: number, heapUsed: number, heapTotal: number, external: number, arrayBuffers: number, heapLimit: number }}
59
- */
60
- export function readProcessMemory() {
61
- const usage = process.memoryUsage();
62
- let heapLimit = 0;
63
- try {
64
- heapLimit = v8.getHeapStatistics().heap_size_limit ?? 0;
65
- } catch {
66
- // silent-ok: a missing ceiling leaves the term out, it does not cost the
67
- // reading beside it.
68
- }
69
- return {
70
- rss: usage.rss,
71
- heapUsed: usage.heapUsed,
72
- heapTotal: usage.heapTotal,
73
- external: usage.external,
74
- arrayBuffers: usage.arrayBuffers ?? 0,
75
- heapLimit
76
- };
77
- }
78
-
79
- /**
80
- * Anonymous memory grouped by the SHAPE of the mappings holding it.
81
- *
82
- * The rollup says how much there is; this says what it looks like, and the
83
- * three shapes it can take are three different diagnoses of the same number:
84
- *
85
- * - **one growing `[heap]`** — the allocator's break-managed arena. Freed
86
- * blocks stay in it, and on musl there is no `malloc_trim` to ask for them
87
- * back. Nothing above the allocator is holding anything.
88
- * - **many large anonymous mappings** — one per big allocation, which is what
89
- * a 4 MiB piece buffer is. If their count tracks the pieces the store says
90
- * it holds, the memory is accounted for; if it keeps climbing while the
91
- * store's count does not, the buffers are being kept alive by somebody.
92
- * - **many medium ones** — the allocator's own per-thread arenas, taken and
93
- * not returned.
94
- *
95
- * The field failure of 2026-08-31 is 700 MB that is none of the JavaScript
96
- * heaps, none of the piece store, and none of ffmpeg. Which of the three
97
- * shapes it has decides what to change, and no reading so far can tell them
98
- * apart (roadmap item 2, step 4).
99
- *
100
- * @param {string} text - The contents of `/proc/self/smaps`.
101
- * @returns {{ heapBytes: number, largeBytes: number, largeCount: number,
102
- * largestBytes: number, smallBytes: number, smallCount: number,
103
- * fileBytes: number }}
104
- */
105
- export function summariseMappings(text) {
106
- const summary = {
107
- heapBytes: 0,
108
- largeBytes: 0,
109
- largeCount: 0,
110
- largestBytes: 0,
111
- smallBytes: 0,
112
- smallCount: 0,
113
- fileBytes: 0
114
- };
115
- // A mapping is a header line followed by its fields; only `Rss` is wanted,
116
- // because a mapping that is reserved and untouched costs no memory.
117
- let pathName = null;
118
- for (const line of String(text ?? "").split("\n")) {
119
- const header = /^[0-9a-f]+-[0-9a-f]+ \S{4} [0-9a-f]+ \S+ \d+\s*(.*)$/.exec(line);
120
- if (header) {
121
- pathName = header[1].trim();
122
- continue;
123
- }
124
- const rss = /^Rss:\s+(\d+)\s+kB$/.exec(line);
125
- if (!rss || pathName === null) {
126
- continue;
127
- }
128
- const bytes = Number(rss[1]) * 1024;
129
- if (bytes === 0) {
130
- continue;
131
- }
132
- if (pathName === "[heap]") {
133
- summary.heapBytes += bytes;
134
- } else if (pathName !== "" && !pathName.startsWith("[")) {
135
- // Backed by a file: the executable, the libraries, anything mapped in.
136
- // Counted so the anonymous figures can be checked against `rss`.
137
- summary.fileBytes += bytes;
138
- } else if (bytes >= LARGE_MAPPING_BYTES) {
139
- summary.largeBytes += bytes;
140
- summary.largeCount += 1;
141
- summary.largestBytes = Math.max(summary.largestBytes, bytes);
142
- } else {
143
- summary.smallBytes += bytes;
144
- summary.smallCount += 1;
145
- }
146
- }
147
- return summary;
148
- }
149
-
150
- /**
151
- * Where "large" begins. Two megabytes, so a 4 MiB piece buffer is always large
152
- * and an allocator's ordinary arena is not.
153
- */
154
- const LARGE_MAPPING_BYTES = 2 * 1024 * 1024;
155
-
156
- /**
157
- * The mapping summary for this process, or null where /proc is not there.
158
- *
159
- * @returns {Promise<ReturnType<typeof summariseMappings> | null>}
160
- */
161
- export async function readMappingSummary() {
162
- try {
163
- return summariseMappings(await readFile("/proc/self/smaps", "utf8"));
164
- } catch {
165
- // silent-ok: not Linux, or the kernel does not publish it. The line leaves
166
- // the term out rather than printing a worse one.
167
- }
168
- return null;
169
- }
170
-
171
- /**
172
- * Available memory, from the one place that reads it.
173
- *
174
- * @returns {{ bytes: number, measured: boolean }}
175
- */
176
- export { availableMemory };
177
-
178
- /**
179
- * Anonymous memory this process holds, from the kernel's own rollup.
180
- *
181
- * `process.memoryUsage()` sees what V8 knows about. It cannot see memory the
182
- * allocator has taken and not returned, and on musl — which is what the addon
183
- * runs on — a heavy churn of 8 MiB pieces leaves exactly that. The rollup's
184
- * `Anonymous` counts every mapping backed by nothing but memory, which is
185
- * where both a live `SharedArrayBuffer` and a freed-but-retained span sit, so
186
- * the difference between it and what the isolates admit to is the size of what
187
- * neither can explain (roadmap item 2, step 4).
188
- *
189
- * @returns {Promise<number | null>} Bytes, or null off Linux.
190
- */
191
- export async function readAnonymousMemory() {
192
- try {
193
- const text = await readFile("/proc/self/smaps_rollup", "utf8");
194
- const match = /^Anonymous:\s+(\d+)\s+kB$/m.exec(text);
195
- if (match) {
196
- return Number(match[1]) * 1024;
197
- }
198
- } catch {
199
- // silent-ok: not Linux, or the kernel is too old for the rollup. The line
200
- // simply leaves the term out rather than printing a worse one.
201
- }
202
- return null;
203
- }
204
-
205
- /**
206
- * How much room is left where this proxy spills pieces and writes segments.
207
- *
208
- * A budget for memory alone is half a budget: pieces evicted from memory go to
209
- * disk, so a store that is well behaved about RAM can still fill the card an
210
- * addon host boots from. Both limits are the machine's, and neither was
211
- * measured before (roadmap item 2).
212
- *
213
- * @param {string} directory
214
- * @returns {Promise<number | null>} Bytes free, or null where it cannot be read.
215
- */
216
- export async function readDiskFree(directory) {
217
- try {
218
- const stats = await statfs(directory);
219
- return Number(stats.bavail) * Number(stats.bsize);
220
- } catch {
221
- // silent-ok: `statfs` is not everywhere, and a missing disk figure must not
222
- // cost the memory reading beside it.
223
- }
224
- return null;
225
- }
226
-
227
- /**
228
- * Render a size the way a person reads one.
229
- *
230
- * @param {number} bytes
231
- * @returns {string}
232
- */
233
- function megabytes(bytes) {
234
- return `${Math.round(bytes / (1024 * 1024))}MB`;
235
- }
236
-
237
- /**
238
- * One line saying what the process holds and what the machine has left.
239
- *
240
- * Pure, so the wording and the arithmetic can be pinned without a running
241
- * process. Store figures are given in BYTES rather than in pieces: the piece
242
- * count is meaningless without the piece size, and the piece size differs per
243
- * torrent — on the film this proxy died under, 63 pieces meant 504 MB.
244
- *
245
- * Two scopes, because two things are being asked and only one of them is
246
- * per-thread. `rss` and the kernel's rollup belong to the PROCESS, so they are
247
- * read once, on the main thread. The heap, external and arrayBuffer figures
248
- * belong to an ISOLATE, and the torrent worker's are the ones that matter —
249
- * the piece pool is a `SharedArrayBuffer` allocated there, which the main
250
- * isolate cannot see at all. Reporting only the main thread's was half the
251
- * reason 650 MB of a 893 MB process had no explanation on 2026-08-28.
252
- *
253
- * @param {Object} reading
254
- * @param {"process" | "thread"} [reading.scope]
255
- * @param {string} [reading.label] - Which thread the isolate figures are of.
256
- * @param {{ rss: number, heapUsed: number, heapTotal: number, external: number, arrayBuffers: number }} reading.process
257
- * @param {number} [reading.availableBytes]
258
- * @param {boolean} [reading.availableMeasured]
259
- * @param {number | null} [reading.anonymousBytes]
260
- * @param {ReturnType<typeof summariseMappings> | null} [reading.mappings]
261
- * @param {number | null} [reading.diskFreeBytes]
262
- * @param {{ name: string, residentBytes: number, committedBytes: number, spilledBytes: number, budgetBytes: number }[]} [reading.stores]
263
- * @param {string} [reading.extra] - Figures the caller wants on the same line
264
- * rather than on one of its own. The piece-buffer counters are read here so
265
- * that the number of buffers alive and the off-heap mass they should account
266
- * for are the SAME instant: printed on separate timers they were up to a
267
- * minute apart, and 950 MB of `arrayBuffers` could not be checked against the
268
- * 62 buffers a reading half a minute away said were alive (roadmap item 2).
269
- * @returns {string}
270
- */
271
- export function describeMemory({
272
- scope = "process",
273
- label = "",
274
- process: usage,
275
- availableBytes,
276
- availableMeasured,
277
- anonymousBytes = null,
278
- mappings = null,
279
- diskFreeBytes = null,
280
- stores = [],
281
- extra = ""
282
- }) {
283
- const total = (field) => stores.reduce((sum, store) => sum + (store[field] || 0), 0);
284
- const storeResident = total("residentBytes");
285
- const storeCommitted = total("committedBytes");
286
- const storeSpilled = total("spilledBytes");
287
- const storeBudget = total("budgetBytes");
288
- // Holding and having taken are different quantities, and the gap between
289
- // them is the whole of the growth this series exists to find: the pool only
290
- // grows, so a spilled piece frees a slot and no memory.
291
- const storesPart = stores.length === 0
292
- ? "no torrent stores"
293
- : `${stores.length} torrent store(s) holding ${megabytes(storeResident)}, ` +
294
- `committed ${megabytes(storeCommitted)} of ${megabytes(storeBudget)} allowed, ` +
295
- `${megabytes(storeSpilled)} spilled to disk`;
296
- const isolate =
297
- `heap=${megabytes(usage.heapUsed)}/${megabytes(usage.heapTotal)}` +
298
- `${usage.heapLimit ? ` of ${megabytes(usage.heapLimit)} allowed` : ""} ` +
299
- `external=${megabytes(usage.external)} arrayBuffers=${megabytes(usage.arrayBuffers)}`;
300
- const tail = extra ? `; ${extra}` : "";
301
- if (scope === "thread") {
302
- return `memory (${label || "thread"}): ${isolate}; ${storesPart}${tail}`;
303
- }
304
- const shape = mappings === null
305
- ? ""
306
- : ` mappings=[heap ${megabytes(mappings.heapBytes)}, ` +
307
- `${mappings.largeCount} anon ≥2MB = ${megabytes(mappings.largeBytes)} ` +
308
- `(largest ${megabytes(mappings.largestBytes)}), ` +
309
- `${mappings.smallCount} anon <2MB = ${megabytes(mappings.smallBytes)}, ` +
310
- `files ${megabytes(mappings.fileBytes)}]`;
311
- return (
312
- `memory: rss=${megabytes(usage.rss)} ${isolate}` +
313
- `${anonymousBytes === null ? "" : ` anon=${megabytes(anonymousBytes)}`}${shape}; ` +
314
- `${storesPart}; ` +
315
- `machine has ${megabytes(availableBytes ?? 0)} available` +
316
- `${availableMeasured ? "" : " (estimated — /proc/meminfo could not be read)"}` +
317
- `${diskFreeBytes === null ? "" : `, ${megabytes(diskFreeBytes)} free on disk`}` +
318
- tail
319
- );
320
- }
321
-
322
- /**
323
- * The figures whose movement earns a line, each under its own name.
324
- *
325
- * Not the same question as what the scope WATCHES for a heap snapshot. A
326
- * thread's heap is only one of the three ways its isolate holds memory, and on
327
- * 2026-09-02 it was the one that did not move: `heapTotal` stayed at 31-173 MB
328
- * through a session where `arrayBuffers` swung between 130 and 950 MB, so the
329
- * change trigger was watching the one quantity that stood still and every
330
- * reading of the one that grew came out on the quiet interval, a minute apart.
331
- *
332
- * Each figure is compared against its own last written value and any one of
333
- * them moving is enough. Nothing is added together, because `arrayBuffers` is
334
- * documented as part of `external` and reads larger than it on this runtime —
335
- * a contradiction this code has no business resolving.
336
- *
337
- * @param {"process" | "thread"} scope
338
- * @param {{ rss: number, heapTotal: number, external: number, arrayBuffers: number }} memory
339
- * @returns {Record<string, number>}
340
- */
341
- export function watchedFigures(scope, memory) {
342
- if (scope === "thread") {
343
- return {
344
- heap: memory.heapTotal ?? 0,
345
- external: memory.external ?? 0,
346
- buffers: memory.arrayBuffers ?? 0
347
- };
348
- }
349
- return { rss: memory.rss ?? 0 };
350
- }
351
-
352
- /**
353
- * Whether this reading is worth writing down, and why.
354
- *
355
- * A series taken every second and printed every second is unreadable, and one
356
- * printed every minute cannot see a rise that takes forty seconds. So the
357
- * cadence of the READING and the cadence of the LINE are separate: the figure
358
- * is taken often, and written when it has moved or when the quiet interval has
359
- * passed. Pure, so the rule can be pinned without a clock.
360
- *
361
- * @param {Object} state
362
- * @param {number} state.watchedBytes - The figure this scope is watching.
363
- * @param {number} state.lastWrittenBytes
364
- * @param {number} state.sinceWrittenMs
365
- * @param {number} state.changeBytes - Movement that earns a line of its own.
366
- * @param {number} state.quietMs - How long silence may last regardless.
367
- * @returns {boolean}
368
- */
369
- export function readingIsWorthWriting({
370
- watchedBytes,
371
- lastWrittenBytes,
372
- sinceWrittenMs,
373
- changeBytes,
374
- quietMs
375
- }) {
376
- if (quietMs <= 0 || sinceWrittenMs >= quietMs) {
377
- return true;
378
- }
379
- if (changeBytes <= 0) {
380
- return false;
381
- }
382
- return Math.abs(watchedBytes - lastWrittenBytes) >= changeBytes;
383
- }
384
-
385
- /**
386
- * Report memory on a timer until stopped.
387
- *
388
- * @param {Object} options
389
- * @param {(message: string) => void} options.log
390
- * @param {() => { name: string, residentBytes: number, budgetBytes: number }[]} [options.readStores]
391
- * @param {"process" | "thread"} [options.scope] - `thread` leaves out the
392
- * process-wide figures, so the torrent worker can report its own isolate
393
- * without reading /proc twice.
394
- * @param {string} [options.label] - Which thread the isolate figures are of.
395
- * @param {string} [options.diskPath] - Where pieces spill, for the free-space
396
- * reading. Omitted, the disk term is left out rather than guessed.
397
- * @param {number} [options.intervalMs] - How often the figure is READ.
398
- * @param {number} [options.quietMs] - How long the line may stay silent while
399
- * nothing moves. Zero writes every reading, which is what the process scope
400
- * has always done.
401
- * @param {number} [options.changeBytes] - Movement that earns a line before the
402
- * quiet interval is up.
403
- * @param {string} [options.snapshotDir] - Where heap snapshots are written.
404
- * @param {(bytes: number) => boolean} [options.mayKeep] - Whether the evidence
405
- * may take this much room. Absent, it may: a process with no owner of the
406
- * disk — the worker thread, a test — is not told to stop.
407
- * Defaults to the temporary directory, as the process scope always did.
408
- * @param {number} [options.snapshotFloorBytes]
409
- * @param {number} [options.snapshotGrowthBytes]
410
- * @param {number} [options.keepSnapshots] - Newest to keep; zero keeps all.
411
- * @param {() => string} [options.readExtra] - Figures to append to the line,
412
- * read at the same instant as the memory itself.
413
- * @returns {{ stop: () => void }}
414
- */
415
- export function startMemoryReport({
416
- log,
417
- readStores,
418
- readExtra,
419
- scope = "process",
420
- label = "",
421
- diskPath = "",
422
- intervalMs = MEMORY_REPORT_INTERVAL_MS,
423
- quietMs = 0,
424
- changeBytes = 0,
425
- snapshotDir = "",
426
- mayKeep = null,
427
- snapshotFloorBytes = 500 * 1024 * 1024,
428
- snapshotGrowthBytes = 100 * 1024 * 1024,
429
- keepSnapshots = 0
430
- }) {
431
- let highWater = 0;
432
- /** @type {Record<string, number>} */
433
- let lastWritten = {};
434
- let lastWrittenAt = 0;
435
- const slug = (label || scope).replace(/[^a-z0-9]+/gi, "-").toLowerCase();
436
- const directory = snapshotDir || os.tmpdir();
437
-
438
- /**
439
- * @param {number} watchedBytes
440
- * @param {string} why
441
- * @returns {Promise<void>}
442
- */
443
- const takeSnapshot = async (watchedBytes, why) => {
444
- // A snapshot weighs about what the heap weighs, and it takes room from the
445
- // product. Asked for rather than taken; refused, it is a line and not a
446
- // silence — see `storage/Diagnostics.js`.
447
- if (typeof mayKeep === "function" && !mayKeep(watchedBytes)) {
448
- return;
449
- }
450
- let snapPath = "";
451
- try {
452
- snapPath = path.join(directory, `heap-${slug}-${Date.now()}-${watchedBytes}.heapsnapshot`);
453
- // Synchronous and proportional to the heap, so it stops this thread for
454
- // as long as it takes to write. That is the price of the only reading
455
- // that names what is holding the memory, and it is why it is bounded by
456
- // a floor, by a growth step and by how many are kept.
457
- v8.writeHeapSnapshot(snapPath);
458
- log(`memory: wrote heap snapshot of the ${label || scope} to ${snapPath} (${megabytes(watchedBytes)}, ${why})`);
459
- } catch {
460
- // silent-ok: no snapshot is worse than a snapshot, and much better than
461
- // ending the series that leads to the next one.
462
- return;
463
- }
464
- if (keepSnapshots <= 0) {
465
- return;
466
- }
467
- try {
468
- const prefix = `heap-${slug}-`;
469
- const mine = (await readdir(directory))
470
- .filter((name) => name.startsWith(prefix) && name.endsWith(".heapsnapshot"))
471
- .sort();
472
- for (const name of mine.slice(0, Math.max(0, mine.length - keepSnapshots))) {
473
- await rm(path.join(directory, name), { force: true });
474
- }
475
- } catch {
476
- // silent-ok: a snapshot that could not be pruned is a disk-space problem
477
- // for later, not a reason to lose the one just written.
478
- }
479
- };
480
-
481
- const tick = async () => {
482
- try {
483
- let stores = [];
484
- try {
485
- stores = typeof readStores === "function" ? readStores() ?? [] : [];
486
- } catch {
487
- // silent-ok: a store list that cannot be read must not stop the reading
488
- // that matters, which is the process's own.
489
- }
490
- const processMemory = readProcessMemory();
491
- const figures = watchedFigures(scope, processMemory);
492
- const now = Date.now();
493
- const sinceWrittenMs = lastWrittenAt === 0 ? Number.POSITIVE_INFINITY : now - lastWrittenAt;
494
- const write = Object.entries(figures).some(([name, bytes]) => readingIsWorthWriting({
495
- watchedBytes: bytes,
496
- lastWrittenBytes: lastWritten[name] ?? 0,
497
- sinceWrittenMs,
498
- changeBytes,
499
- quietMs
500
- }));
501
-
502
- let anonymousBytes = null;
503
- if (write) {
504
- let extra = "";
505
- try {
506
- extra = typeof readExtra === "function" ? readExtra() ?? "" : "";
507
- } catch {
508
- // silent-ok: a caller's own figures are worth less than the line they
509
- // would have taken down with them.
510
- }
511
- if (scope === "thread") {
512
- log(describeMemory({ scope, label, process: processMemory, stores, extra }));
513
- } else {
514
- // Read only when the line is written. `smaps` is one entry per
515
- // mapping and a busy process has thousands; the rollup and
516
- // `/proc/meminfo` are single lines but still walk page tables, and
517
- // the reading now happens once a second rather than once a minute.
518
- const { bytes, measured } = await availableMemory();
519
- anonymousBytes = await readAnonymousMemory();
520
- log(describeMemory({
521
- scope,
522
- label,
523
- process: processMemory,
524
- availableBytes: bytes,
525
- availableMeasured: measured,
526
- anonymousBytes,
527
- mappings: await readMappingSummary(),
528
- diskFreeBytes: diskPath ? await readDiskFree(diskPath) : null,
529
- stores,
530
- extra
531
- }));
532
- }
533
- lastWritten = figures;
534
- lastWrittenAt = now;
535
- }
536
-
537
- // A snapshot per high-water, so there is a file to open when the growth
538
- // has to be named rather than described.
539
- //
540
- // Deliberately NOT one taken as the ceiling is approached: a snapshot is
541
- // written by the isolate itself and is about the size of its heap, so
542
- // asking for one at 1.9 GB on a machine with 600 MB left is a good way to
543
- // cause the kill being studied. Whatever holds 1.6 GB is the same thing
544
- // that holds 2.2 GB, and at one reading a second no step is ever missed.
545
- //
546
- // AND IT FOLLOWS THE JS HEAP, whatever this scope's LINE is written about.
547
- // A snapshot can only ever explain the heap, and the process is killed by
548
- // two different things: the kernel reads resident memory, V8 reads the
549
- // heap. Taken on resident memory, 54 snapshots were written in one
550
- // afternoon on 2026-09-07 for growth that was mostly native — each one
551
- // stopping the main thread to write a file about the wrong quantity —
552
- // and when V8 did kill the process at 1.99 GB of old space, no snapshot
553
- // had ever been taken of the growth that did it.
554
- const heapWatched = processMemory.heapTotal;
555
- if (heapWatched > highWater + snapshotGrowthBytes && heapWatched > snapshotFloorBytes) {
556
- highWater = heapWatched;
557
- await takeSnapshot(heapWatched, "a new high-water of the heap");
558
- }
559
- // Under `write` by construction: `anonymousBytes` is only read when the
560
- // line is, and at one reading a second an unconditional warning would be
561
- // a line a second for as long as the process stayed large.
562
- if (scope !== "thread" && anonymousBytes !== null && processMemory.rss > 800 * 1024 * 1024) {
563
- log(`memory: high rss=${megabytes(processMemory.rss)} anon=${megabytes(anonymousBytes)} heap=${megabytes(processMemory.heapUsed)} — watch for OOM`);
564
- }
565
- } catch {
566
- // silent-ok: a reading that fails is not worth ending the series over.
567
- }
568
- };
569
- void tick();
570
- const timer = setInterval(() => { void tick(); }, intervalMs);
571
- if (typeof timer.unref === "function") {
572
- timer.unref();
573
- }
574
- return { stop: () => clearInterval(timer) };
575
- }
1
+ /**
2
+ * @file What this process is holding, said out loud on a regular cadence.
3
+ *
4
+ * Written 2026-08-28, after the kernel killed the proxy and the log could not
5
+ * say why. The supervisor recorded `exit code 137` — SIGKILL, so no core dump —
6
+ * and the kernel ring buffer held the whole of what was known:
7
+ *
8
+ * Out of memory: Killed process 3036113 (MainThread)
9
+ * anon-rss: 2422628kB total-vm: 20856720kB oom_score_adj: 200
10
+ *
11
+ * Two point four gigabytes, on a host with under two free, and the addon is the
12
+ * first thing the kernel picks because Home Assistant gives addons a positive
13
+ * `oom_score_adj`. What the proxy had been logging all along was its share of a
14
+ * CPU. Nothing anywhere said how much memory it held, so the growth that ended
15
+ * in that line has no shape: one final reading taken by the kernel, and no
16
+ * series leading to it.
17
+ *
18
+ * This is that series. It costs one line a minute and reads only counters the
19
+ * runtime already maintains.
20
+ */
21
+
22
+ import { readdir, readFile, rm, statfs } from "node:fs/promises";
23
+ import { availableMemory } from "./machine-memory.js";
24
+ import os from "node:os";
25
+ import v8 from "node:v8";
26
+ import path from "node:path";
27
+
28
+ /** How often the reading is taken and written. */
29
+ export const MEMORY_REPORT_INTERVAL_MS = 60_000;
30
+
31
+ /**
32
+ * How often the torrent worker takes its own reading.
33
+ *
34
+ * A minute cannot see what killed it. Three times — 2026-08-30 14:00 and 23:19,
35
+ * 2026-08-31 13:27 — the worker's heap read 28-36 MB in one sample and the
36
+ * thread was dead by the sample after next, with the whole rise from 30 MB to
37
+ * the 2240 MB heap limit fitting inside a single gap. A second is short enough
38
+ * that the rise is a curve rather than a step, and the line is only WRITTEN when
39
+ * something moved, so a quiet session costs what it costs today.
40
+ */
41
+ export const WORKER_MEMORY_SAMPLE_MS = 1_000;
42
+
43
+ /**
44
+ * What the process is holding, from the runtime's own counters.
45
+ *
46
+ * `rss` is what the kernel counts against us and therefore what the OOM killer
47
+ * reads. The rest says where it went: the JavaScript heap, and everything held
48
+ * outside it — which for this proxy is where the interesting growth lives,
49
+ * since torrent pieces sit in a `SharedArrayBuffer` and segment bodies pass
50
+ * through buffers.
51
+ *
52
+ * `heapLimit` is this isolate's own ceiling, and it belongs beside the heap
53
+ * figures because it is what the runtime kills the thread for reaching — a
54
+ * worker created without `resourceLimits` inherits the main isolate's, 2240 MB
55
+ * on the addon host. Without it the log said 30 MB and gave no idea how far
56
+ * that was from the end.
57
+ *
58
+ * @returns {{ rss: number, heapUsed: number, heapTotal: number, external: number, arrayBuffers: number, heapLimit: number }}
59
+ */
60
+ export function readProcessMemory() {
61
+ const usage = process.memoryUsage();
62
+ let heapLimit = 0;
63
+ try {
64
+ heapLimit = v8.getHeapStatistics().heap_size_limit ?? 0;
65
+ } catch {
66
+ // silent-ok: a missing ceiling leaves the term out, it does not cost the
67
+ // reading beside it.
68
+ }
69
+ return {
70
+ rss: usage.rss,
71
+ heapUsed: usage.heapUsed,
72
+ heapTotal: usage.heapTotal,
73
+ external: usage.external,
74
+ arrayBuffers: usage.arrayBuffers ?? 0,
75
+ heapLimit
76
+ };
77
+ }
78
+
79
+ /**
80
+ * Anonymous memory grouped by the SHAPE of the mappings holding it.
81
+ *
82
+ * The rollup says how much there is; this says what it looks like, and the
83
+ * three shapes it can take are three different diagnoses of the same number:
84
+ *
85
+ * - **one growing `[heap]`** — the allocator's break-managed arena. Freed
86
+ * blocks stay in it, and on musl there is no `malloc_trim` to ask for them
87
+ * back. Nothing above the allocator is holding anything.
88
+ * - **many large anonymous mappings** — one per big allocation, which is what
89
+ * a 4 MiB piece buffer is. If their count tracks the pieces the store says
90
+ * it holds, the memory is accounted for; if it keeps climbing while the
91
+ * store's count does not, the buffers are being kept alive by somebody.
92
+ * - **many medium ones** — the allocator's own per-thread arenas, taken and
93
+ * not returned.
94
+ *
95
+ * The field failure of 2026-08-31 is 700 MB that is none of the JavaScript
96
+ * heaps, none of the piece store, and none of ffmpeg. Which of the three
97
+ * shapes it has decides what to change, and no reading so far can tell them
98
+ * apart (roadmap item 2, step 4).
99
+ *
100
+ * @param {string} text - The contents of `/proc/self/smaps`.
101
+ * @returns {{ heapBytes: number, largeBytes: number, largeCount: number,
102
+ * largestBytes: number, smallBytes: number, smallCount: number,
103
+ * fileBytes: number }}
104
+ */
105
+ export function summariseMappings(text) {
106
+ const summary = {
107
+ heapBytes: 0,
108
+ largeBytes: 0,
109
+ largeCount: 0,
110
+ largestBytes: 0,
111
+ smallBytes: 0,
112
+ smallCount: 0,
113
+ fileBytes: 0
114
+ };
115
+ // A mapping is a header line followed by its fields; only `Rss` is wanted,
116
+ // because a mapping that is reserved and untouched costs no memory.
117
+ let pathName = null;
118
+ for (const line of String(text ?? "").split("\n")) {
119
+ const header = /^[0-9a-f]+-[0-9a-f]+ \S{4} [0-9a-f]+ \S+ \d+\s*(.*)$/.exec(line);
120
+ if (header) {
121
+ pathName = header[1].trim();
122
+ continue;
123
+ }
124
+ const rss = /^Rss:\s+(\d+)\s+kB$/.exec(line);
125
+ if (!rss || pathName === null) {
126
+ continue;
127
+ }
128
+ const bytes = Number(rss[1]) * 1024;
129
+ if (bytes === 0) {
130
+ continue;
131
+ }
132
+ if (pathName === "[heap]") {
133
+ summary.heapBytes += bytes;
134
+ } else if (pathName !== "" && !pathName.startsWith("[")) {
135
+ // Backed by a file: the executable, the libraries, anything mapped in.
136
+ // Counted so the anonymous figures can be checked against `rss`.
137
+ summary.fileBytes += bytes;
138
+ } else if (bytes >= LARGE_MAPPING_BYTES) {
139
+ summary.largeBytes += bytes;
140
+ summary.largeCount += 1;
141
+ summary.largestBytes = Math.max(summary.largestBytes, bytes);
142
+ } else {
143
+ summary.smallBytes += bytes;
144
+ summary.smallCount += 1;
145
+ }
146
+ }
147
+ return summary;
148
+ }
149
+
150
+ /**
151
+ * Where "large" begins. Two megabytes, so a 4 MiB piece buffer is always large
152
+ * and an allocator's ordinary arena is not.
153
+ */
154
+ const LARGE_MAPPING_BYTES = 2 * 1024 * 1024;
155
+
156
+ /**
157
+ * The mapping summary for this process, or null where /proc is not there.
158
+ *
159
+ * @returns {Promise<ReturnType<typeof summariseMappings> | null>}
160
+ */
161
+ export async function readMappingSummary() {
162
+ try {
163
+ return summariseMappings(await readFile("/proc/self/smaps", "utf8"));
164
+ } catch {
165
+ // silent-ok: not Linux, or the kernel does not publish it. The line leaves
166
+ // the term out rather than printing a worse one.
167
+ }
168
+ return null;
169
+ }
170
+
171
+ /**
172
+ * Available memory, from the one place that reads it.
173
+ *
174
+ * @returns {{ bytes: number, measured: boolean }}
175
+ */
176
+ export { availableMemory };
177
+
178
+ /**
179
+ * Anonymous memory this process holds, from the kernel's own rollup.
180
+ *
181
+ * `process.memoryUsage()` sees what V8 knows about. It cannot see memory the
182
+ * allocator has taken and not returned, and on musl — which is what the addon
183
+ * runs on — a heavy churn of 8 MiB pieces leaves exactly that. The rollup's
184
+ * `Anonymous` counts every mapping backed by nothing but memory, which is
185
+ * where both a live `SharedArrayBuffer` and a freed-but-retained span sit, so
186
+ * the difference between it and what the isolates admit to is the size of what
187
+ * neither can explain (roadmap item 2, step 4).
188
+ *
189
+ * @returns {Promise<number | null>} Bytes, or null off Linux.
190
+ */
191
+ export async function readAnonymousMemory() {
192
+ try {
193
+ const text = await readFile("/proc/self/smaps_rollup", "utf8");
194
+ const match = /^Anonymous:\s+(\d+)\s+kB$/m.exec(text);
195
+ if (match) {
196
+ return Number(match[1]) * 1024;
197
+ }
198
+ } catch {
199
+ // silent-ok: not Linux, or the kernel is too old for the rollup. The line
200
+ // simply leaves the term out rather than printing a worse one.
201
+ }
202
+ return null;
203
+ }
204
+
205
+ /**
206
+ * How much room is left where this proxy spills pieces and writes segments.
207
+ *
208
+ * A budget for memory alone is half a budget: pieces evicted from memory go to
209
+ * disk, so a store that is well behaved about RAM can still fill the card an
210
+ * addon host boots from. Both limits are the machine's, and neither was
211
+ * measured before (roadmap item 2).
212
+ *
213
+ * @param {string} directory
214
+ * @returns {Promise<number | null>} Bytes free, or null where it cannot be read.
215
+ */
216
+ export async function readDiskFree(directory) {
217
+ try {
218
+ const stats = await statfs(directory);
219
+ return Number(stats.bavail) * Number(stats.bsize);
220
+ } catch {
221
+ // silent-ok: `statfs` is not everywhere, and a missing disk figure must not
222
+ // cost the memory reading beside it.
223
+ }
224
+ return null;
225
+ }
226
+
227
+ /**
228
+ * Render a size the way a person reads one.
229
+ *
230
+ * @param {number} bytes
231
+ * @returns {string}
232
+ */
233
+ function megabytes(bytes) {
234
+ return `${Math.round(bytes / (1024 * 1024))}MB`;
235
+ }
236
+
237
+ /**
238
+ * One line saying what the process holds and what the machine has left.
239
+ *
240
+ * Pure, so the wording and the arithmetic can be pinned without a running
241
+ * process. Store figures are given in BYTES rather than in pieces: the piece
242
+ * count is meaningless without the piece size, and the piece size differs per
243
+ * torrent — on the film this proxy died under, 63 pieces meant 504 MB.
244
+ *
245
+ * Two scopes, because two things are being asked and only one of them is
246
+ * per-thread. `rss` and the kernel's rollup belong to the PROCESS, so they are
247
+ * read once, on the main thread. The heap, external and arrayBuffer figures
248
+ * belong to an ISOLATE, and the torrent worker's are the ones that matter —
249
+ * the piece pool is a `SharedArrayBuffer` allocated there, which the main
250
+ * isolate cannot see at all. Reporting only the main thread's was half the
251
+ * reason 650 MB of a 893 MB process had no explanation on 2026-08-28.
252
+ *
253
+ * @param {Object} reading
254
+ * @param {"process" | "thread"} [reading.scope]
255
+ * @param {string} [reading.label] - Which thread the isolate figures are of.
256
+ * @param {{ rss: number, heapUsed: number, heapTotal: number, external: number, arrayBuffers: number }} reading.process
257
+ * @param {number} [reading.availableBytes]
258
+ * @param {boolean} [reading.availableMeasured]
259
+ * @param {number | null} [reading.anonymousBytes]
260
+ * @param {ReturnType<typeof summariseMappings> | null} [reading.mappings]
261
+ * @param {number | null} [reading.diskFreeBytes]
262
+ * @param {{ name: string, residentBytes: number, committedBytes: number, spilledBytes: number, budgetBytes: number }[]} [reading.stores]
263
+ * @param {string} [reading.extra] - Figures the caller wants on the same line
264
+ * rather than on one of its own. The piece-buffer counters are read here so
265
+ * that the number of buffers alive and the off-heap mass they should account
266
+ * for are the SAME instant: printed on separate timers they were up to a
267
+ * minute apart, and 950 MB of `arrayBuffers` could not be checked against the
268
+ * 62 buffers a reading half a minute away said were alive (roadmap item 2).
269
+ * @returns {string}
270
+ */
271
+ export function describeMemory({
272
+ scope = "process",
273
+ label = "",
274
+ process: usage,
275
+ availableBytes,
276
+ availableMeasured,
277
+ anonymousBytes = null,
278
+ mappings = null,
279
+ diskFreeBytes = null,
280
+ stores = [],
281
+ extra = ""
282
+ }) {
283
+ const total = (field) => stores.reduce((sum, store) => sum + (store[field] || 0), 0);
284
+ const storeResident = total("residentBytes");
285
+ const storeCommitted = total("committedBytes");
286
+ const storeSpilled = total("spilledBytes");
287
+ const storeBudget = total("budgetBytes");
288
+ // Holding and having taken are different quantities, and the gap between
289
+ // them is the whole of the growth this series exists to find: the pool only
290
+ // grows, so a spilled piece frees a slot and no memory.
291
+ const storesPart = stores.length === 0
292
+ ? "no torrent stores"
293
+ : `${stores.length} torrent store(s) holding ${megabytes(storeResident)}, ` +
294
+ `committed ${megabytes(storeCommitted)} of ${megabytes(storeBudget)} allowed, ` +
295
+ `${megabytes(storeSpilled)} spilled to disk`;
296
+ const isolate =
297
+ `heap=${megabytes(usage.heapUsed)}/${megabytes(usage.heapTotal)}` +
298
+ `${usage.heapLimit ? ` of ${megabytes(usage.heapLimit)} allowed` : ""} ` +
299
+ `external=${megabytes(usage.external)} arrayBuffers=${megabytes(usage.arrayBuffers)}`;
300
+ const tail = extra ? `; ${extra}` : "";
301
+ if (scope === "thread") {
302
+ return `memory (${label || "thread"}): ${isolate}; ${storesPart}${tail}`;
303
+ }
304
+ const shape = mappings === null
305
+ ? ""
306
+ : ` mappings=[heap ${megabytes(mappings.heapBytes)}, ` +
307
+ `${mappings.largeCount} anon ≥2MB = ${megabytes(mappings.largeBytes)} ` +
308
+ `(largest ${megabytes(mappings.largestBytes)}), ` +
309
+ `${mappings.smallCount} anon <2MB = ${megabytes(mappings.smallBytes)}, ` +
310
+ `files ${megabytes(mappings.fileBytes)}]`;
311
+ return (
312
+ `memory: rss=${megabytes(usage.rss)} ${isolate}` +
313
+ `${anonymousBytes === null ? "" : ` anon=${megabytes(anonymousBytes)}`}${shape}; ` +
314
+ `${storesPart}; ` +
315
+ `machine has ${megabytes(availableBytes ?? 0)} available` +
316
+ `${availableMeasured ? "" : " (estimated — /proc/meminfo could not be read)"}` +
317
+ `${diskFreeBytes === null ? "" : `, ${megabytes(diskFreeBytes)} free on disk`}` +
318
+ tail
319
+ );
320
+ }
321
+
322
+ /**
323
+ * The figures whose movement earns a line, each under its own name.
324
+ *
325
+ * Not the same question as what the scope WATCHES for a heap snapshot. A
326
+ * thread's heap is only one of the three ways its isolate holds memory, and on
327
+ * 2026-09-02 it was the one that did not move: `heapTotal` stayed at 31-173 MB
328
+ * through a session where `arrayBuffers` swung between 130 and 950 MB, so the
329
+ * change trigger was watching the one quantity that stood still and every
330
+ * reading of the one that grew came out on the quiet interval, a minute apart.
331
+ *
332
+ * Each figure is compared against its own last written value and any one of
333
+ * them moving is enough. Nothing is added together, because `arrayBuffers` is
334
+ * documented as part of `external` and reads larger than it on this runtime —
335
+ * a contradiction this code has no business resolving.
336
+ *
337
+ * @param {"process" | "thread"} scope
338
+ * @param {{ rss: number, heapTotal: number, external: number, arrayBuffers: number }} memory
339
+ * @returns {Record<string, number>}
340
+ */
341
+ export function watchedFigures(scope, memory) {
342
+ if (scope === "thread") {
343
+ return {
344
+ heap: memory.heapTotal ?? 0,
345
+ external: memory.external ?? 0,
346
+ buffers: memory.arrayBuffers ?? 0
347
+ };
348
+ }
349
+ return { rss: memory.rss ?? 0 };
350
+ }
351
+
352
+ /**
353
+ * Whether this reading is worth writing down, and why.
354
+ *
355
+ * A series taken every second and printed every second is unreadable, and one
356
+ * printed every minute cannot see a rise that takes forty seconds. So the
357
+ * cadence of the READING and the cadence of the LINE are separate: the figure
358
+ * is taken often, and written when it has moved or when the quiet interval has
359
+ * passed. Pure, so the rule can be pinned without a clock.
360
+ *
361
+ * @param {Object} state
362
+ * @param {number} state.watchedBytes - The figure this scope is watching.
363
+ * @param {number} state.lastWrittenBytes
364
+ * @param {number} state.sinceWrittenMs
365
+ * @param {number} state.changeBytes - Movement that earns a line of its own.
366
+ * @param {number} state.quietMs - How long silence may last regardless.
367
+ * @returns {boolean}
368
+ */
369
+ export function readingIsWorthWriting({
370
+ watchedBytes,
371
+ lastWrittenBytes,
372
+ sinceWrittenMs,
373
+ changeBytes,
374
+ quietMs
375
+ }) {
376
+ if (quietMs <= 0 || sinceWrittenMs >= quietMs) {
377
+ return true;
378
+ }
379
+ if (changeBytes <= 0) {
380
+ return false;
381
+ }
382
+ return Math.abs(watchedBytes - lastWrittenBytes) >= changeBytes;
383
+ }
384
+
385
+ /**
386
+ * Report memory on a timer until stopped.
387
+ *
388
+ * @param {Object} options
389
+ * @param {(message: string) => void} options.log
390
+ * @param {() => { name: string, residentBytes: number, budgetBytes: number }[]} [options.readStores]
391
+ * @param {"process" | "thread"} [options.scope] - `thread` leaves out the
392
+ * process-wide figures, so the torrent worker can report its own isolate
393
+ * without reading /proc twice.
394
+ * @param {string} [options.label] - Which thread the isolate figures are of.
395
+ * @param {string} [options.diskPath] - Where pieces spill, for the free-space
396
+ * reading. Omitted, the disk term is left out rather than guessed.
397
+ * @param {number} [options.intervalMs] - How often the figure is READ.
398
+ * @param {number} [options.quietMs] - How long the line may stay silent while
399
+ * nothing moves. Zero writes every reading, which is what the process scope
400
+ * has always done.
401
+ * @param {number} [options.changeBytes] - Movement that earns a line before the
402
+ * quiet interval is up.
403
+ * @param {string} [options.snapshotDir] - Where heap snapshots are written.
404
+ * @param {(bytes: number) => boolean} [options.mayKeep] - Whether the evidence
405
+ * may take this much room. Absent, it may: a process with no owner of the
406
+ * disk — the worker thread, a test — is not told to stop.
407
+ * Defaults to the temporary directory, as the process scope always did.
408
+ * @param {number} [options.snapshotFloorBytes]
409
+ * @param {number} [options.snapshotGrowthBytes]
410
+ * @param {number} [options.keepSnapshots] - Newest to keep; zero keeps all.
411
+ * @param {() => string} [options.readExtra] - Figures to append to the line,
412
+ * read at the same instant as the memory itself.
413
+ * @returns {{ stop: () => void }}
414
+ */
415
+ export function startMemoryReport({
416
+ log,
417
+ readStores,
418
+ readExtra,
419
+ scope = "process",
420
+ label = "",
421
+ diskPath = "",
422
+ intervalMs = MEMORY_REPORT_INTERVAL_MS,
423
+ quietMs = 0,
424
+ changeBytes = 0,
425
+ snapshotDir = "",
426
+ mayKeep = null,
427
+ snapshotFloorBytes = 500 * 1024 * 1024,
428
+ snapshotGrowthBytes = 100 * 1024 * 1024,
429
+ keepSnapshots = 0
430
+ }) {
431
+ let highWater = 0;
432
+ /** @type {Record<string, number>} */
433
+ let lastWritten = {};
434
+ let lastWrittenAt = 0;
435
+ const slug = (label || scope).replace(/[^a-z0-9]+/gi, "-").toLowerCase();
436
+ const directory = snapshotDir || os.tmpdir();
437
+
438
+ /**
439
+ * @param {number} watchedBytes
440
+ * @param {string} why
441
+ * @returns {Promise<void>}
442
+ */
443
+ const takeSnapshot = async (watchedBytes, why) => {
444
+ // A snapshot weighs about what the heap weighs, and it takes room from the
445
+ // product. Asked for rather than taken; refused, it is a line and not a
446
+ // silence — see `storage/Diagnostics.js`.
447
+ if (typeof mayKeep === "function" && !mayKeep(watchedBytes)) {
448
+ return;
449
+ }
450
+ let snapPath = "";
451
+ try {
452
+ snapPath = path.join(directory, `heap-${slug}-${Date.now()}-${watchedBytes}.heapsnapshot`);
453
+ // Synchronous and proportional to the heap, so it stops this thread for
454
+ // as long as it takes to write. That is the price of the only reading
455
+ // that names what is holding the memory, and it is why it is bounded by
456
+ // a floor, by a growth step and by how many are kept.
457
+ v8.writeHeapSnapshot(snapPath);
458
+ log(`memory: wrote heap snapshot of the ${label || scope} to ${snapPath} (${megabytes(watchedBytes)}, ${why})`);
459
+ } catch {
460
+ // silent-ok: no snapshot is worse than a snapshot, and much better than
461
+ // ending the series that leads to the next one.
462
+ return;
463
+ }
464
+ if (keepSnapshots <= 0) {
465
+ return;
466
+ }
467
+ try {
468
+ const prefix = `heap-${slug}-`;
469
+ const mine = (await readdir(directory))
470
+ .filter((name) => name.startsWith(prefix) && name.endsWith(".heapsnapshot"))
471
+ .sort();
472
+ for (const name of mine.slice(0, Math.max(0, mine.length - keepSnapshots))) {
473
+ await rm(path.join(directory, name), { force: true });
474
+ }
475
+ } catch {
476
+ // silent-ok: a snapshot that could not be pruned is a disk-space problem
477
+ // for later, not a reason to lose the one just written.
478
+ }
479
+ };
480
+
481
+ const tick = async () => {
482
+ try {
483
+ let stores = [];
484
+ try {
485
+ stores = typeof readStores === "function" ? readStores() ?? [] : [];
486
+ } catch {
487
+ // silent-ok: a store list that cannot be read must not stop the reading
488
+ // that matters, which is the process's own.
489
+ }
490
+ const processMemory = readProcessMemory();
491
+ const figures = watchedFigures(scope, processMemory);
492
+ const now = Date.now();
493
+ const sinceWrittenMs = lastWrittenAt === 0 ? Number.POSITIVE_INFINITY : now - lastWrittenAt;
494
+ const write = Object.entries(figures).some(([name, bytes]) => readingIsWorthWriting({
495
+ watchedBytes: bytes,
496
+ lastWrittenBytes: lastWritten[name] ?? 0,
497
+ sinceWrittenMs,
498
+ changeBytes,
499
+ quietMs
500
+ }));
501
+
502
+ let anonymousBytes = null;
503
+ if (write) {
504
+ let extra = "";
505
+ try {
506
+ extra = typeof readExtra === "function" ? readExtra() ?? "" : "";
507
+ } catch {
508
+ // silent-ok: a caller's own figures are worth less than the line they
509
+ // would have taken down with them.
510
+ }
511
+ if (scope === "thread") {
512
+ log(describeMemory({ scope, label, process: processMemory, stores, extra }));
513
+ } else {
514
+ // Read only when the line is written. `smaps` is one entry per
515
+ // mapping and a busy process has thousands; the rollup and
516
+ // `/proc/meminfo` are single lines but still walk page tables, and
517
+ // the reading now happens once a second rather than once a minute.
518
+ const { bytes, measured } = await availableMemory();
519
+ anonymousBytes = await readAnonymousMemory();
520
+ log(describeMemory({
521
+ scope,
522
+ label,
523
+ process: processMemory,
524
+ availableBytes: bytes,
525
+ availableMeasured: measured,
526
+ anonymousBytes,
527
+ mappings: await readMappingSummary(),
528
+ diskFreeBytes: diskPath ? await readDiskFree(diskPath) : null,
529
+ stores,
530
+ extra
531
+ }));
532
+ }
533
+ lastWritten = figures;
534
+ lastWrittenAt = now;
535
+ }
536
+
537
+ // A snapshot per high-water, so there is a file to open when the growth
538
+ // has to be named rather than described.
539
+ //
540
+ // Deliberately NOT one taken as the ceiling is approached: a snapshot is
541
+ // written by the isolate itself and is about the size of its heap, so
542
+ // asking for one at 1.9 GB on a machine with 600 MB left is a good way to
543
+ // cause the kill being studied. Whatever holds 1.6 GB is the same thing
544
+ // that holds 2.2 GB, and at one reading a second no step is ever missed.
545
+ //
546
+ // AND IT FOLLOWS THE JS HEAP, whatever this scope's LINE is written about.
547
+ // A snapshot can only ever explain the heap, and the process is killed by
548
+ // two different things: the kernel reads resident memory, V8 reads the
549
+ // heap. Taken on resident memory, 54 snapshots were written in one
550
+ // afternoon on 2026-09-07 for growth that was mostly native — each one
551
+ // stopping the main thread to write a file about the wrong quantity —
552
+ // and when V8 did kill the process at 1.99 GB of old space, no snapshot
553
+ // had ever been taken of the growth that did it.
554
+ const heapWatched = processMemory.heapTotal;
555
+ if (heapWatched > highWater + snapshotGrowthBytes && heapWatched > snapshotFloorBytes) {
556
+ highWater = heapWatched;
557
+ await takeSnapshot(heapWatched, "a new high-water of the heap");
558
+ }
559
+ // Under `write` by construction: `anonymousBytes` is only read when the
560
+ // line is, and at one reading a second an unconditional warning would be
561
+ // a line a second for as long as the process stayed large.
562
+ if (scope !== "thread" && anonymousBytes !== null && processMemory.rss > 800 * 1024 * 1024) {
563
+ log(`memory: high rss=${megabytes(processMemory.rss)} anon=${megabytes(anonymousBytes)} heap=${megabytes(processMemory.heapUsed)} — watch for OOM`);
564
+ }
565
+ } catch {
566
+ // silent-ok: a reading that fails is not worth ending the series over.
567
+ }
568
+ };
569
+ void tick();
570
+ const timer = setInterval(() => { void tick(); }, intervalMs);
571
+ if (typeof timer.unref === "function") {
572
+ timer.unref();
573
+ }
574
+ return { stop: () => clearInterval(timer) };
575
+ }