@torrent-tv/proxy 2.87.10 → 2.87.12

package/routes/api/transcode-sessions/net-report/post.js

@@ -1,129 +1,136 @@
-import { recordViewerReport } from "../../../../services/viewer/report-intake.js";
-
-/**
- * Accept a viewer link report for a transcode session (adaptive bitrate).
- * The browser measures its own data-channel throughput per segment fetch and
- * posts a rolling median + its buffered seconds; the session manager's budget
- * loop uses the latest report as the link-deficit downshift trigger.
- *
- * POST /api/transcode-sessions/:sessionId/net-report
- * Body: { consumerId: string, bufferedAheadSec: number, linkMbps?: number,
- *         positionSeconds?: number, playingHeight?: number, … }
- *
- * `consumerId` and `positionSeconds` say WHO is reporting and WHERE they are.
- * A copied picture is one session shared by every viewer of it, so without them
- * the proxy could only act on whichever viewer reported last. The viewer is
- * required; the position is not.
- *
- * Best-effort telemetry: invalid body → 400, unknown session → 404, ok → 204.
- *
- * @param {import("fastify").FastifyRequest} req
- * @param {import("fastify").FastifyReply} reply
- * @param {{ outputs: { get: (id: string) => object | undefined }, viewers: object, renditions: { viewerPlays: Function, noteViewerReported: Function }, quality: { noteViewerReported: Function } }} deps -
- *   The live outputs, the registry of viewers, and the rungs of a picture. The
- *   VIEWER component takes the statement; which rung a stated height is, is the
- *   encoding component's. This route's whole job is turning a request into
- *   those calls and their answer into a status code.
- * @returns {Promise<void>}
- */
-export async function handleApiTranscodeSessionNetReportPost(req, reply, { outputs, viewers, renditions, quality }) {
-  const sessionId = typeof req.params.sessionId === "string" ? req.params.sessionId : "";
-  const body = req.body && typeof req.body === "object" && !Array.isArray(req.body) ? req.body : {};
-  // WHAT THIS REPORT IS. A statement by one viewer about itself: where the
-  // picture is, how much film it holds, whether it is moving, whether it is
-  // blocked on us, whether the page is on screen — and, when there has been
-  // anything to measure, how fast the link carried it.
-  //
-  // THE LINK FIGURE IS NOT REQUIRED, and requiring it is the fault of
-  // 2026-09-14. A page measures its link from completed transfers, so a page
-  // that has not yet been delivered a segment has no figure; at a cold open
-  // that is every page. Rejected here with 400, the page's own account of
-  // itself never arrived, this proxy filled the silence by assuming the film
-  // was running, and a viewer who had not seen a frame was placed 146 seconds
-  // into it — the soundtrack's encoder went there, and the segment the browser
-  // was actually asking for was ranked last of a hundred and answered 503.
-  const linkMbps = Number(body.linkMbps);
-  const bufferedAheadSec = Number(body.bufferedAheadSec);
-  if (!sessionId || !Number.isFinite(bufferedAheadSec) || bufferedAheadSec < 0) {
-    return reply.code(400).send({ error: "bufferedAheadSec (>=0) is required." });
-  }
-
-  // WHO is reporting is required: a viewer always has a name, and a reading of
-  // a link that belongs to nobody cannot be kept anywhere. The position is not
-  // required — a report without one is still a truthful reading of that link.
-  const consumerId = typeof body.consumerId === "string" ? body.consumerId.trim() : "";
-  if (!consumerId) {
-    return reply.code(400).send({ error: "consumerId is required." });
-  }
-  // Whether the picture is moving. Absent from a page that does not say, and
-  // then nothing is assumed: a statement about somebody else's machine is
-  // theirs to make, and assuming it walked a viewer 146 seconds into a film
-  // they had not begun (2026-09-14).
-  const playing = typeof body.playing === "boolean" ? body.playing : undefined;
-  // Whether this viewer is BLOCKED on material we owe them, which is a
-  // different state from having stopped the picture: the first is the most
-  // urgent viewer there is, the second consumes nothing and can wait. One
-  // boolean could not hold three states and read the first as the second.
-  const waiting = typeof body.waiting === "boolean" ? body.waiting : undefined;
-  // Whether the page is on screen, and whether the picture was pulled out of
-  // it. A hidden tab has its timers throttled, so it asks for nothing and looks
-  // exactly like a viewer holding a full cushion; picture-in-picture is the case
-  // that makes the distinction necessary, because there the tab is hidden and
-  // the viewer is watching. Absent from a page that does not say, and then the
-  // viewer is on screen, as every page meant before it could say otherwise.
-  const onScreen = typeof body.onScreen === "boolean" ? body.onScreen : undefined;
-  const inPictureInPicture =
-    typeof body.inPictureInPicture === "boolean" ? body.inPictureInPicture : undefined;
-  // Whether the size on screen was picked by hand or is the automatic choice.
-  // A size picked by hand is served exactly; the automatic choice may be served
-  // by an output of the same quality or better that is already made.
-  const qualityMode = body.qualityMode === "auto" || body.qualityMode === "manual" ? body.qualityMode : undefined;
-  const positionSeconds = Number(body.positionSeconds);
-  // The picture as the viewer sees it, in physical pixels: the upper bound of
-  // the height of a re-encoded output made for them (roadmap item 98). Sent the
-  // moment it changes; a page that does not say leaves the size as it was.
-  const visiblePicture = body.visiblePicture && typeof body.visiblePicture === "object"
-    ? { width: Number(body.visiblePicture.width), height: Number(body.visiblePicture.height) }
-    : undefined;
-  // WHICH RUNG THE PLAYER IS PLAYING, stated by the page the moment it
-  // switched. Stated before the report is recorded, because the report belongs
-  // to the rung on screen. A page that does not say leaves the rung as it was.
-  const playingHeight = Number(body.playingHeight);
-  if (Number.isInteger(playingHeight) && playingHeight > 0) {
-    renditions.viewerPlays(
-      sessionId,
-      consumerId,
-      playingHeight,
-      Number.isFinite(positionSeconds) && positionSeconds >= 0 ? positionSeconds : undefined
-    );
-  }
-  const recorded = recordViewerReport({
-    outputs,
-    viewers,
-    sessionId,
-    report: {
-      linkMbps: Number.isFinite(linkMbps) && linkMbps > 0 ? linkMbps : undefined,
-      bufferedAheadSec,
-      consumerId,
-      playing,
-      waiting,
-      onScreen,
-      inPictureInPicture,
-      qualityMode,
-      visiblePicture,
-      positionSeconds:
-        Number.isFinite(positionSeconds) && positionSeconds >= 0 ? positionSeconds : undefined
-    }
-  });
-  if (!recorded) {
-    return reply.code(404).send({ error: "Transcode session was not found." });
-  }
-  // After the statement is recorded, so what is judged is what they just said:
-  // a move of theirs to another limit may no longer be wanted.
-  renditions.noteViewerReported(sessionId, consumerId);
-  // And the quality budget judges this viewer now, on what they just said —
-  // their buffer's trend, their link, the picture they see — rather than at
-  // the next tick of a timer.
-  void quality.noteViewerReported(sessionId, consumerId);
-  return reply.code(204).send();
-}
+import { recordViewerReport } from "../../../../services/viewer/report-intake.js";
+
+/**
+ * Accept a viewer link report for a transcode session (adaptive bitrate).
+ * The browser measures its own data-channel throughput per segment fetch and
+ * posts a rolling median + its buffered seconds; the session manager's budget
+ * loop uses the latest report as the link-deficit downshift trigger.
+ *
+ * POST /api/transcode-sessions/:sessionId/net-report
+ * Body: { consumerId: string, bufferedAheadSec: number, linkMbps?: number,
+ *         positionSeconds?: number, playingHeight?: number, … }
+ *
+ * `consumerId` and `positionSeconds` say WHO is reporting and WHERE they are.
+ * A copied picture is one session shared by every viewer of it, so without them
+ * the proxy could only act on whichever viewer reported last. The viewer is
+ * required; the position is not.
+ *
+ * Best-effort telemetry: invalid body → 400, unknown session → 404, ok → 204.
+ *
+ * @param {import("fastify").FastifyRequest} req
+ * @param {import("fastify").FastifyReply} reply
+ * @param {{ outputs: { get: (id: string) => object | undefined }, viewers: object, renditions: { viewerPlays: Function, noteViewerReported: Function }, quality: { noteViewerReported: Function } }} deps -
+ *   The live outputs, the registry of viewers, and the rungs of a picture. The
+ *   VIEWER component takes the statement; which rung a stated height is, is the
+ *   encoding component's. This route's whole job is turning a request into
+ *   those calls and their answer into a status code.
+ * @returns {Promise<void>}
+ */
+export async function handleApiTranscodeSessionNetReportPost(req, reply, { outputs, viewers, renditions, quality }) {
+  const sessionId = typeof req.params.sessionId === "string" ? req.params.sessionId : "";
+  const body = req.body && typeof req.body === "object" && !Array.isArray(req.body) ? req.body : {};
+  // WHAT THIS REPORT IS. A statement by one viewer about itself: where the
+  // picture is, how much film it holds, whether it is moving, whether it is
+  // blocked on us, whether the page is on screen — and, when there has been
+  // anything to measure, how fast the link carried it.
+  //
+  // THE LINK FIGURE IS NOT REQUIRED, and requiring it is the fault of
+  // 2026-09-14. A page measures its link from completed transfers, so a page
+  // that has not yet been delivered a segment has no figure; at a cold open
+  // that is every page. Rejected here with 400, the page's own account of
+  // itself never arrived, this proxy filled the silence by assuming the film
+  // was running, and a viewer who had not seen a frame was placed 146 seconds
+  // into it — the soundtrack's encoder went there, and the segment the browser
+  // was actually asking for was ranked last of a hundred and answered 503.
+  const linkMbps = Number(body.linkMbps);
+  const linkSampleMbps = Number(body.linkSampleMbps);
+  const linkSampleAt = Number(body.linkSampleAt);
+  const bufferedAheadSec = Number(body.bufferedAheadSec);
+  const bufferLimitSeconds = Number(body.bufferLimitSeconds);
+  if (!sessionId || !Number.isFinite(bufferedAheadSec) || bufferedAheadSec < 0) {
+    return reply.code(400).send({ error: "bufferedAheadSec (>=0) is required." });
+  }
+
+  // WHO is reporting is required: a viewer always has a name, and a reading of
+  // a link that belongs to nobody cannot be kept anywhere. The position is not
+  // required — a report without one is still a truthful reading of that link.
+  const consumerId = typeof body.consumerId === "string" ? body.consumerId.trim() : "";
+  if (!consumerId) {
+    return reply.code(400).send({ error: "consumerId is required." });
+  }
+  // Whether the picture is moving. Absent from a page that does not say, and
+  // then nothing is assumed: a statement about somebody else's machine is
+  // theirs to make, and assuming it walked a viewer 146 seconds into a film
+  // they had not begun (2026-09-14).
+  const playing = typeof body.playing === "boolean" ? body.playing : undefined;
+  // Whether this viewer is BLOCKED on material we owe them, which is a
+  // different state from having stopped the picture: the first is the most
+  // urgent viewer there is, the second consumes nothing and can wait. One
+  // boolean could not hold three states and read the first as the second.
+  const waiting = typeof body.waiting === "boolean" ? body.waiting : undefined;
+  // Whether the page is on screen, and whether the picture was pulled out of
+  // it. A hidden tab has its timers throttled, so it asks for nothing and looks
+  // exactly like a viewer holding a full cushion; picture-in-picture is the case
+  // that makes the distinction necessary, because there the tab is hidden and
+  // the viewer is watching. Absent from a page that does not say, and then the
+  // viewer is on screen, as every page meant before it could say otherwise.
+  const onScreen = typeof body.onScreen === "boolean" ? body.onScreen : undefined;
+  const inPictureInPicture =
+    typeof body.inPictureInPicture === "boolean" ? body.inPictureInPicture : undefined;
+  // Whether the size on screen was picked by hand or is the automatic choice.
+  // A size picked by hand is served exactly; the automatic choice may be served
+  // by an output of the same quality or better that is already made.
+  const qualityMode = body.qualityMode === "auto" || body.qualityMode === "manual" ? body.qualityMode : undefined;
+  const positionSeconds = Number(body.positionSeconds);
+  // The picture as the viewer sees it, in physical pixels: the upper bound of
+  // the height of a re-encoded output made for them (roadmap item 98). Sent the
+  // moment it changes; a page that does not say leaves the size as it was.
+  const visiblePicture = body.visiblePicture && typeof body.visiblePicture === "object"
+    ? { width: Number(body.visiblePicture.width), height: Number(body.visiblePicture.height) }
+    : undefined;
+  // WHICH RUNG THE PLAYER IS PLAYING, stated by the page the moment it
+  // switched. Stated before the report is recorded, because the report belongs
+  // to the rung on screen. A page that does not say leaves the rung as it was.
+  const playingHeight = Number(body.playingHeight);
+  if (Number.isInteger(playingHeight) && playingHeight > 0) {
+    renditions.viewerPlays(
+      sessionId,
+      consumerId,
+      playingHeight,
+      Number.isFinite(positionSeconds) && positionSeconds >= 0 ? positionSeconds : undefined
+    );
+  }
+  const recorded = recordViewerReport({
+    outputs,
+    viewers,
+    sessionId,
+    report: {
+      linkMbps: Number.isFinite(linkMbps) && linkMbps > 0 ? linkMbps : undefined,
+      linkSampleMbps: Number.isFinite(linkSampleMbps) && linkSampleMbps > 0 ? linkSampleMbps : undefined,
+      linkSampleAt: Number.isFinite(linkSampleAt) && linkSampleAt > 0 ? linkSampleAt : undefined,
+      bufferedAheadSec,
+      bufferLimitSeconds:
+        Number.isFinite(bufferLimitSeconds) && bufferLimitSeconds > 0 ? bufferLimitSeconds : undefined,
+      consumerId,
+      playing,
+      waiting,
+      onScreen,
+      inPictureInPicture,
+      qualityMode,
+      visiblePicture,
+      positionSeconds:
+        Number.isFinite(positionSeconds) && positionSeconds >= 0 ? positionSeconds : undefined
+    }
+  });
+  if (!recorded) {
+    return reply.code(404).send({ error: "Transcode session was not found." });
+  }
+  // After the statement is recorded, so what is judged is what they just said:
+  // a move of theirs to another limit may no longer be wanted.
+  renditions.noteViewerReported(sessionId, consumerId);
+  // And the quality budget judges this viewer now, on what they just said —
+  // their buffer's trend, their link, the picture they see — rather than at
+  // the next tick of a timer.
+  void quality.noteViewerReported(sessionId, consumerId);
+  return reply.code(204).send();
+}