@madewithremy/admin 0.1.40 → 0.1.42

package/README.md

@@ -1,6 +1,6 @@
 # @madewithremy/admin
 
-Admin SDK + CLI for managing production Remy apps: request logs, analytics, releases, users, secrets, database, files, email (including custom sending/receiving domains), scheduled jobs, QA replays, and more. Almost every operation wraps the same management API the dashboard uses, so anything answerable in the console is answerable here — from the terminal or from code. The exception is `qa-recordings export`, which renders a video on the dev box and therefore only runs inside a sandbox.
+Admin SDK + CLI for managing production Remy apps: request logs, analytics, releases, users, secrets, database, files, email (including custom sending/receiving domains), scheduled jobs, QA replays, and more. Almost every operation wraps the same management API the dashboard uses, so anything answerable in the console is answerable here — from the terminal or from code. The exception is `qa-recordings export`, which the dev box that recorded the replay packages for the platform to render, and which therefore only runs inside a sandbox.
 
 One surface, two skins: every CLI command (`remy-admin <group> <sub>`) is also a typed client method (`admin.<group>.<sub>()`). Both are thin layers over the same ops core.
 

package/dist/index.d.ts

@@ -7378,7 +7378,7 @@ declare namespace prerender {
  *   roles/http/routes/Apps/develop/recordings.ts
  *   customerApps/AppDevBoxes/recordings/sessions.ts
  *
- * Export is the exception — it renders on the dev box (see ../ops/recordings).
+ * Export is the exception — the dev box packages it (see ../ops/qaRecordings).
  */
 /** One document lifetime within a session: a page load and everything after it
  *  until the next one. Its lowest-seq chunk carries the rrweb FullSnapshot. */
@@ -7430,13 +7430,13 @@ interface QaRecordingsExportResult {
  * own.
  *
  * `export` is the one operation in this SDK that does NOT go through the
- * management API. Rendering a replay means playing it in a real browser and
- * encoding the frames, and the only machine set up to do that is the dev box
- * the recording was made on: it already has the headless Chrome, the rrweb
- * replayer and ffmpeg. So this talks to the sandbox's local sidecar, and says
- * so plainly when there isn't one. (CLI-only paths are established here —
+ * management API. A replay names the app's own files as the dev box that
+ * recorded it served them, signed in, so that box is what packages it for the
+ * platform to render: it has the proxy those files come from and the browser
+ * session they need. So this talks to the sandbox's local sidecar, and says so
+ * plainly when there isn't one. (CLI-only paths are established here —
  * `methods invoke --stream`, `jewels export --file` — but this is the first
- * that needs local compute rather than local disk.)
+ * that needs the local box rather than local disk.)
  */
 
 /** The app store QA replay chunks are written to (private). */
@@ -7468,13 +7468,19 @@ interface QaRecordingsExportParams {
     access?: 'public' | 'private';
     /** Milliseconds to wait for the render. */
     timeoutMs?: number;
+    /**
+     * How far the render is, as it runs: a line when it moves to a new phase
+     * and every 10% after, e.g. `Rendering the replay… 40%`.
+     */
+    onProgress?: (message: string) => void;
 }
 /**
- * Render a window of a recording session to an mp4 on the dev box.
+ * Render a window of a recording session to an mp4.
  *
- * Blocks for the whole render — the clip plays in real time, then encodes and
- * uploads — and answers with where the video landed. Runs only on a Remy dev
- * box, since that is where the browser and ffmpeg are.
+ * Blocks for the whole render — the box packages the replay, the platform
+ * renders it, which takes minutes for a long clip — and answers with where
+ * the video landed. Runs only on a Remy dev box, since the replay's own files
+ * are served by the box that recorded it.
  *
  * @example
  * const { url } = await admin.qaRecordings.exportVideo({

package/dist/index.js

@@ -2727,7 +2727,12 @@ function seqOf(key) {
   );
   return Number.isFinite(n) ? n : 0;
 }
-var DEFAULT_EXPORT_TIMEOUT_MS = 66e4;
+var DEFAULT_EXPORT_TIMEOUT_MS = 33 * 6e4;
+var EXPORT_PHASE_LABEL = {
+  loading: "Preparing the replay",
+  rendering: "Rendering the replay",
+  encoding: "Encoding the video"
+};
 async function exportVideo(_ctx, params) {
   const body = {
     recordingSessionId: params.sessionId,
@@ -2740,7 +2745,12 @@ async function exportVideo(_ctx, params) {
   try {
     res = await fetch(`${SIDECAR_URL}/export-recording`, {
       method: "POST",
-      headers: { "Content-Type": "application/json" },
+      // A line per progress event, then the answer (the sidecar's
+      // streamRecordingExport).
+      headers: {
+        "Content-Type": "application/json",
+        Accept: "application/x-ndjson"
+      },
       body: JSON.stringify(body),
       signal: AbortSignal.timeout(
         params.timeoutMs ?? DEFAULT_EXPORT_TIMEOUT_MS
@@ -2751,12 +2761,53 @@ async function exportVideo(_ctx, params) {
       `Could not reach the sandbox at ${SIDECAR_URL} (${err instanceof Error ? err.message : String(err)}). Rendering a replay needs the dev box that recorded it \u2014 this command only works inside a Remy sandbox.`
     );
   }
-  const payload = await res.json().catch(() => ({}));
-  if (!res.ok) {
+  if (!res.ok || !res.body) {
+    const refused = await res.json().catch(() => ({}));
     throw new Error(
-      typeof payload.error === "string" ? payload.error : `The sandbox refused the export (HTTP ${res.status}).`
+      typeof refused.error === "string" ? refused.error : `The sandbox refused the export (HTTP ${res.status}).`
     );
   }
+  let payload = {};
+  let shown = null;
+  const decoder = new TextDecoder();
+  let buffer = "";
+  const read = (text) => {
+    if (!text.trim()) {
+      return;
+    }
+    let value;
+    try {
+      value = JSON.parse(text);
+    } catch {
+      return;
+    }
+    const progress = value.progress;
+    if (!progress) {
+      payload = value;
+      return;
+    }
+    const phase = progress.phase ?? "rendering";
+    const percent = Math.round(progress.percent ?? 0);
+    const step = Math.floor(percent / 10);
+    if (shown?.phase !== phase || step > shown.step) {
+      shown = { phase, step };
+      params.onProgress?.(
+        `${EXPORT_PHASE_LABEL[phase] ?? EXPORT_PHASE_LABEL.rendering}\u2026 ${percent}%`
+      );
+    }
+  };
+  for await (const chunk of res.body) {
+    buffer += decoder.decode(chunk, { stream: true });
+    let end;
+    while ((end = buffer.indexOf("\n")) !== -1) {
+      read(buffer.slice(0, end));
+      buffer = buffer.slice(end + 1);
+    }
+  }
+  read(buffer);
+  if (typeof payload.error === "string") {
+    throw new Error(payload.error);
+  }
   const status2 = payload.export;
   if (!status2) {
     throw new Error(