@testpulse.run/reporter 0.1.1 → 0.1.3

package/README.md

@@ -35,4 +35,4 @@ test("streams automatically when page is used", async ({ page }) => {
 });
 ```
 
-When `liveStreamingEnabled` is enabled on the reporter, the fixture automatically starts and stops live capture for tests that use the `page` fixture. The package bundles `ffmpeg` automatically. To override the encoder path, set `TESTPULSE_FFMPEG_PATH`.
+Live streaming is enabled by default on the reporter, and the fixture automatically starts and stops live capture for tests that use the `page` fixture. Set `liveStreamingEnabled: false` to opt out. The package bundles `ffmpeg` automatically. To override the encoder path, set `TESTPULSE_FFMPEG_PATH`.

package/dist/fixtures/options.js

@@ -1,6 +1,6 @@
 import { resolveTestPulseEndpoint } from "../shared/endpoint.js";
 export function resolveTestPulseFixturesOptions(options = {}, environment = process.env) {
-    const enabled = options.enabled ?? environment.TESTPULSE_ENABLE_LIVE_STREAMING === "1";
+    const enabled = options.enabled ?? parseOptionalBoolean(environment.TESTPULSE_ENABLE_LIVE_STREAMING) ?? true;
     const swallowErrors = options.swallowErrors ?? true;
     return {
         enabled,
@@ -16,6 +16,19 @@ export function resolveTestPulseFixturesOptions(options = {}, environment = proc
         }
     };
 }
+function parseOptionalBoolean(value) {
+    const normalized = value?.trim().toLowerCase();
+    if (!normalized) {
+        return undefined;
+    }
+    if (normalized === "1" || normalized === "true") {
+        return true;
+    }
+    if (normalized === "0" || normalized === "false") {
+        return false;
+    }
+    return undefined;
+}
 function trim(value) {
     const trimmed = value?.trim();
     return trimmed ? trimmed : undefined;

package/dist/live/LiveSessionResolver.js

@@ -1,4 +1,4 @@
-import { readdir, readFile } from "node:fs/promises";
+import { access, readdir, readFile } from "node:fs/promises";
 import { getLiveCaptureStateDirectory, getLiveCaptureStatePath } from "./LiveSessionState.js";
 export async function resolveLiveCaptureSession(options, now = () => Date.now(), wait = (ms) => new Promise((resolve) => setTimeout(resolve, ms))) {
     if (options.endpoint && options.projectId && options.apiKey && options.runId && options.streamPublisherToken) {
@@ -11,6 +11,12 @@ export async function resolveLiveCaptureSession(options, now = () => Date.now(),
             createdAt: new Date(now()).toISOString()
         };
     }
+    if (!await shouldWaitForState(options)) {
+        const path = options.sessionKey
+            ? getLiveCaptureStatePath(options.sessionKey, options.stateDirectory)
+            : getLiveCaptureStateDirectory(options.stateDirectory);
+        throw new Error(`TestPulse live streaming session state was not found at ${path}.`);
+    }
     const deadline = now() + 30_000;
     while (now() < deadline) {
         const session = options.sessionKey
@@ -26,6 +32,20 @@ export async function resolveLiveCaptureSession(options, now = () => Date.now(),
         : getLiveCaptureStateDirectory(options.stateDirectory);
     throw new Error(`TestPulse live streaming session state was not found at ${path}.`);
 }
+async function shouldWaitForState(options) {
+    if (options.sessionKey) {
+        return true;
+    }
+    try {
+        const directory = getLiveCaptureStateDirectory(options.stateDirectory);
+        await access(directory);
+        const entries = await readdir(directory);
+        return entries.some((entry) => entry.endsWith(".json"));
+    }
+    catch {
+        return false;
+    }
+}
 async function tryReadLatestStateFile(stateDirectory, now) {
     try {
         const directory = getLiveCaptureStateDirectory(stateDirectory);

package/dist/reporter/PlaywrightReporter.js

@@ -16,7 +16,8 @@ export default class TestPulseReporter {
         this.options = options;
         this.resolvedOptions = {
             ...options,
-            endpoint: resolveTestPulseEndpoint(options.endpoint)
+            endpoint: resolveTestPulseEndpoint(options.endpoint),
+            liveStreamingEnabled: options.liveStreamingEnabled ?? true
         };
         this.runClient = new RunClient(this.resolvedOptions);
         this.artifactUploader = new ArtifactUploader(this.eventQueue, () => this.ensureRunStarted(), this.runClient);
@@ -74,7 +75,7 @@ export default class TestPulseReporter {
             await this.runClient.completeRun(runId, result.status === "failed" ? "Failed" : "Completed");
         }
         finally {
-            if (this.options.liveStreamingEnabled) {
+            if (this.resolvedOptions.liveStreamingEnabled) {
                 await deleteLiveCaptureState(this.options.liveStreamSessionKey, this.options.liveCaptureStateDirectory);
             }
         }
@@ -107,7 +108,7 @@ export default class TestPulseReporter {
         const metadata = await this.metadataPromise;
         const payload = await this.runClient.startRun(metadata);
         this.runId = payload.runId;
-        if (this.options.liveStreamingEnabled) {
+        if (this.resolvedOptions.liveStreamingEnabled) {
             if (!payload.streamPublisherToken) {
                 throw new Error("TestPulse live streaming token was not returned by the backend.");
             }

package/dist/reporter/types.d.ts

@@ -21,6 +21,7 @@ export type StartRunResponse = {
     runId: string;
     streamPublisherToken?: string;
 };
-export interface ResolvedTestPulseReporterOptions extends Omit<TestPulseReporterOptions, "endpoint"> {
+export interface ResolvedTestPulseReporterOptions extends Omit<TestPulseReporterOptions, "endpoint" | "liveStreamingEnabled"> {
     endpoint: string;
+    liveStreamingEnabled: boolean;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@testpulse.run/reporter",
-  "version": "0.1.1",
+  "version": "0.1.3",
   "description": "Playwright reporter for streaming TestPulse runs and optional live browser capture",
   "type": "module",
   "main": "./dist/index.js",