stream-doctor 0.0.3 → 0.0.4

package/README.md

@@ -0,0 +1,11 @@
+# stream-doctor
+
+Automated end-to-end testing for video infrastructure: publish a stream into
+your pipeline, watch what comes out the other end and assert on the metrics.
+An early proof of concept, currently a single RTMP to HLS scenario with a
+single metric, the audio/video drift.
+
+This is the TypeScript client for the StreamDoctor daemon. It brings the
+daemon binary along, as an optional dependency on `@stream-doctor/<platform>`.
+Setup, usage and the roadmap are described in the
+[StreamDoctor repository](https://github.com/membraneframework-labs/stream_doctor).

package/dist/stream_doctor.d.ts

@@ -6,7 +6,7 @@ export interface StreamerStatus {
     rtmp_url: string;
     status: Status;
     error: string | null;
-    frames_sent: number;
+    live: boolean;
 }
 export interface AvDrift {
     drift_ms: number | null;
@@ -35,7 +35,8 @@ export declare function session({ server, binary, }?: {
 declare class Session {
     server: string;
     child: ChildProcess | null;
-    constructor(server: string, child: ChildProcess | null);
+    logFile: string | null;
+    constructor(server: string, child: ChildProcess | null, logFile?: string | null);
     publish(rtmpUrl: string, { file }?: {
         file?: string;
     }): Streamer;

package/dist/stream_doctor.js

@@ -1,9 +1,11 @@
 // Client for the stream_doctor server. `session()` spawns the binary (the one
 // bundled for this platform, or `binary`) when no server is listening;
-// `session.close()` stops it.
+// `session.close()` stops it. The daemon's output goes to `session.logFile`.
 import { spawn } from "node:child_process";
 import fs from "node:fs";
 import { createRequire } from "node:module";
+import os from "node:os";
+import path from "node:path";
 const DEFAULT_SERVER = "http://localhost:4040";
 const PLATFORM_PACKAGES = {
     "darwin-arm64": "@stream-doctor/darwin-arm64",
@@ -48,23 +50,41 @@ export async function session({ server = DEFAULT_SERVER, binary, } = {}) {
         return new Session(server, null);
     }
     catch (e) {
-        binary ??= bundledBinary() ?? undefined;
+        let installDir;
+        const logFile = path.join(os.tmpdir(), "stream_doctor.log");
         if (!binary) {
-            throw new Error(`${e.message}; no stream_doctor binary bundled for ${process.platform}-${process.arch}, pass one with \`binary\``);
+            binary = bundledBinary() ?? undefined;
+            if (!binary) {
+                throw new Error(`${e.message}; no stream_doctor binary bundled for ${process.platform}-${process.arch}, pass one with \`binary\``);
+            }
+            // Burrito unpacks the payload once per release name + ERTS + app version,
+            // none of which change between npm releases, so its default cache under
+            // ~/.local/share would keep serving the previous package's daemon.
+            installDir = path.join(path.dirname(binary), "..", ".burrito");
         }
+        const child = await spawnServer(binary, server, logFile, installDir);
+        return new Session(server, child, logFile);
     }
-    return new Session(server, await spawnServer(binary, server));
 }
-async function spawnServer(binary, server) {
+async function spawnServer(binary, server, logFile, installDir) {
     if (!fs.existsSync(binary)) {
         throw new Error(`${binary} not found, build it with: MIX_ENV=prod mix release`);
     }
-    console.log(`starting ${binary}`);
+    const env = {
+        ...process.env,
+        // the daemon quits once its stdin (the pipe below) breaks, i.e. when this
+        // process dies, however it dies
+        STREAM_DOCTOR_EXIT_ON_STDIN_EOF: "1",
+        ...(installDir ? { STREAM_DOCTOR_INSTALL_DIR: installDir } : {}),
+    };
+    const log = fs.openSync(logFile, "a");
     // own process group, so that killing the burrito launcher takes the BEAM with it
-    const child = spawn(binary, [], { stdio: ["ignore", "inherit", "inherit"], detached: true });
+    const child = spawn(binary, [], { stdio: ["pipe", log, log], detached: true, env });
+    child.on("exit", () => fs.closeSync(log));
     for (const deadline = Date.now() + 120_000; Date.now() < deadline;) {
-        if (child.exitCode !== null)
-            throw new Error(`server exited with ${child.exitCode}`);
+        if (child.exitCode !== null) {
+            throw new Error(`server exited with ${child.exitCode}, see ${logFile}`);
+        }
         await sleep(1000);
         try {
             await api("GET", "/status", null, server);
@@ -72,14 +92,16 @@ async function spawnServer(binary, server) {
         }
         catch { }
     }
-    throw new Error("server didn't come up in 2 minutes");
+    throw new Error(`server didn't come up in 2 minutes, see ${logFile}`);
 }
 class Session {
     server;
     child;
-    constructor(server, child) {
+    logFile;
+    constructor(server, child, logFile = null) {
         this.server = server;
         this.child = child;
+        this.logFile = logFile;
     }
     publish(rtmpUrl, { file = "test.mp4" } = {}) {
         const ready = api("POST", "/streamer", { input: file, rtmp_url: rtmpUrl }, this.server);
@@ -120,7 +142,7 @@ class Streamer {
         const deadline = Date.now() + timeoutMs;
         for (;;) {
             const streamer = await api("GET", "/streamer", null, this.server);
-            if (streamer.frames_sent > 0)
+            if (streamer.live)
                 return streamer;
             if (TERMINAL_STATUSES.includes(streamer.status)) {
                 throw new Error(`streamer ${streamer.status} before going live${streamer.error ? `: ${streamer.error}` : ""}`);

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "stream-doctor",
-  "version": "0.0.3",
-  "description": "Measures the audio/video drift of a live stream, end to end",
+  "version": "0.0.4",
+  "description": "Automated end-to-end testing for video infrastructure (early proof of concept)",
   "license": "Apache-2.0",
   "repository": {
     "type": "git",
@@ -20,8 +20,8 @@
     "build": "tsc -p tsconfig.build.json",
     "prepack": "npm run build",
     "test": "node --test src/*.test.ts",
-    "lint": "tsc --noEmit && eslint src examples && prettier --check src examples",
-    "format": "prettier --write src examples"
+    "lint": "tsc --noEmit && eslint src && prettier --check src",
+    "format": "prettier --write src"
   },
   "devDependencies": {
     "@eslint/js": "^9.0.0",
@@ -33,8 +33,8 @@
     "typescript-eslint": "^8.70.0"
   },
   "optionalDependencies": {
-    "@stream-doctor/darwin-arm64": "0.0.3",
-    "@stream-doctor/linux-arm64": "0.0.3",
-    "@stream-doctor/linux-x64": "0.0.3"
+    "@stream-doctor/darwin-arm64": "0.0.4",
+    "@stream-doctor/linux-arm64": "0.0.4",
+    "@stream-doctor/linux-x64": "0.0.4"
   }
 }