@testpulse.run/reporter 0.1.3 → 0.1.4

package/README.md

@@ -1,6 +1,6 @@
 # @testpulse.run/reporter
 
-Playwright reporter for streaming TestPulse runs and optional live browser capture.
+Playwright reporter for streaming TestPulse runs and live browser capture.
 
 ## Install
 
@@ -35,4 +35,4 @@ test("streams automatically when page is used", async ({ page }) => {
 });
 ```
 
-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`.
+Live streaming is always on when the reporter is configured and 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, pass `ffmpegPath` in the fixture options.

package/dist/fixtures/createTestPulseTest.js

@@ -5,16 +5,14 @@ export function createAutoLiveCapturePageFixture(options = {}, startCapture = st
     return async ({ page }, use, testInfo) => {
         const resolved = resolveTestPulseFixturesOptions(options);
         let capture = null;
-        if (resolved.enabled) {
-            try {
-                capture = await startCapture(page, resolved.captureOptions);
-            }
-            catch (error) {
-                if (!resolved.swallowErrors) {
-                    throw error;
-                }
-                console.warn(`[TestPulse] Auto live capture skipped for test "${testInfo.title}": ${error instanceof Error ? error.message : String(error)}`);
+        try {
+            capture = await startCapture(page, resolved.captureOptions);
+        }
+        catch (error) {
+            if (!resolved.swallowErrors) {
+                throw error;
             }
+            console.warn(`[TestPulse] Auto live capture skipped for test "${testInfo.title}": ${error instanceof Error ? error.message : String(error)}`);
         }
         try {
             await use(page);

package/dist/fixtures/options.d.ts

@@ -1,2 +1,2 @@
 import type { ResolvedTestPulseFixturesOptions, TestPulseFixturesOptions } from "./types.js";
-export declare function resolveTestPulseFixturesOptions(options?: TestPulseFixturesOptions, environment?: NodeJS.ProcessEnv): ResolvedTestPulseFixturesOptions;
+export declare function resolveTestPulseFixturesOptions(options?: TestPulseFixturesOptions): ResolvedTestPulseFixturesOptions;

package/dist/fixtures/options.js

@@ -1,45 +1,33 @@
 import { resolveTestPulseEndpoint } from "../shared/endpoint.js";
-export function resolveTestPulseFixturesOptions(options = {}, environment = process.env) {
-    const enabled = options.enabled ?? parseOptionalBoolean(environment.TESTPULSE_ENABLE_LIVE_STREAMING) ?? true;
+export function resolveTestPulseFixturesOptions(options = {}) {
     const swallowErrors = options.swallowErrors ?? true;
     return {
-        enabled,
         swallowErrors,
         captureOptions: {
-            endpoint: resolveTestPulseEndpoint(options.endpoint, environment),
-            runId: options.runId ?? trim(environment.TESTPULSE_RUN_ID),
-            streamPublisherToken: options.streamPublisherToken ?? trim(environment.TESTPULSE_STREAM_PUBLISHER_TOKEN),
-            sessionKey: options.sessionKey ?? trim(environment.TESTPULSE_LIVE_CAPTURE_SESSION_KEY),
-            stateDirectory: options.stateDirectory ?? trim(environment.TESTPULSE_LIVE_CAPTURE_STATE_DIRECTORY),
-            intervalMs: options.intervalMs ?? parseOptionalNumber(environment.TESTPULSE_LIVE_CAPTURE_INTERVAL_MS),
-            profile: options.profile ?? parseProfile(environment.TESTPULSE_LIVE_CAPTURE_PROFILE)
+            endpoint: resolveTestPulseEndpoint(options.endpoint),
+            projectId: trim(options.projectId),
+            apiKey: trim(options.apiKey),
+            runId: trim(options.runId),
+            streamPublisherToken: trim(options.streamPublisherToken),
+            sessionKey: trim(options.sessionKey),
+            stateDirectory: trim(options.stateDirectory),
+            intervalMs: normalizeOptionalNumber(options.intervalMs),
+            profile: parseProfile(options.profile),
+            ffmpegPath: trim(options.ffmpegPath)
         }
     };
 }
-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;
 }
-function parseOptionalNumber(value) {
-    const trimmed = value?.trim();
-    if (!trimmed) {
+function normalizeOptionalNumber(value) {
+    if (value === undefined) {
         return undefined;
     }
-    const parsed = Number(trimmed);
-    return Number.isFinite(parsed) && parsed > 0 ? parsed : undefined;
+    return Number.isFinite(value) && value > 0
+        ? value
+        : undefined;
 }
 function parseProfile(value) {
     return value === "focus" || value === "grid"

package/dist/fixtures/types.d.ts

@@ -1,10 +1,8 @@
 import type { LiveCaptureOptions } from "../live/types.js";
 export interface TestPulseFixturesOptions extends LiveCaptureOptions {
-    enabled?: boolean;
     swallowErrors?: boolean;
 }
 export interface ResolvedTestPulseFixturesOptions {
-    enabled: boolean;
     swallowErrors: boolean;
     captureOptions: LiveCaptureOptions;
 }

package/dist/live/EncoderProcess.d.ts

@@ -1,5 +1,5 @@
 import type { ChildProcessWithoutNullStreams } from "node:child_process";
 import type { StreamDescriptor } from "./types.js";
-export declare function startEncoderProcess(descriptor: StreamDescriptor): ChildProcessWithoutNullStreams;
-export declare function resolveFfmpegPath(): string;
+export declare function startEncoderProcess(descriptor: StreamDescriptor, ffmpegPath?: string): ChildProcessWithoutNullStreams;
+export declare function resolveFfmpegPath(ffmpegPath?: string): string;
 export declare function waitForEncoder(encoder: ChildProcessWithoutNullStreams): Promise<void>;

package/dist/live/EncoderProcess.js

@@ -2,9 +2,9 @@ import { spawn } from "node:child_process";
 import { once } from "node:events";
 import { createRequire } from "node:module";
 const require = createRequire(import.meta.url);
-export function startEncoderProcess(descriptor) {
+export function startEncoderProcess(descriptor, ffmpegPath) {
     const gopFrames = Math.max(1, Math.round(descriptor.framesPerSecond * descriptor.gopDurationMs / 1000));
-    const ffmpeg = spawn(resolveFfmpegPath(), [
+    const ffmpeg = spawn(resolveFfmpegPath(ffmpegPath), [
         "-loglevel", "error",
         "-f", "image2pipe",
         "-r", String(descriptor.framesPerSecond),
@@ -36,8 +36,8 @@ export function startEncoderProcess(descriptor) {
     });
     return ffmpeg;
 }
-export function resolveFfmpegPath() {
-    const configuredPath = process.env.TESTPULSE_FFMPEG_PATH?.trim();
+export function resolveFfmpegPath(ffmpegPath) {
+    const configuredPath = ffmpegPath?.trim();
     if (configuredPath) {
         return configuredPath;
     }

package/dist/live/LiveCaptureService.js

@@ -14,7 +14,7 @@ export async function startLiveCapture(page, options = {}) {
     const streamId = randomUUID();
     const captureStartedAt = Date.now();
     const logTimingOnce = createTimingLogger(captureStartedAt);
-    const encoder = startEncoderProcess(descriptor);
+    const encoder = startEncoderProcess(descriptor, options.ffmpegPath);
     const uploader = new StreamUploader(session, streamId, descriptor, captureStartedAt);
     const uploadQueue = new SegmentQueue((error) => {
         console.warn(`[TestPulse] Live streaming disabled for run ${session.runId}: ${error.message}`);

package/dist/live/types.d.ts

@@ -33,6 +33,7 @@ export interface LiveCaptureOptions {
     stateDirectory?: string;
     intervalMs?: number;
     profile?: StreamProfile;
+    ffmpegPath?: string;
 }
 export interface LiveCaptureHandle {
     stop(): Promise<void>;

package/dist/reporter/GitRuntimeMetadataResolver.js

@@ -2,7 +2,6 @@ import { execFile } from "node:child_process";
 import { promisify } from "node:util";
 const execFileAsync = promisify(execFile);
 const branchEnvironmentVariables = [
-    "TESTPULSE_BRANCH",
     "GITHUB_HEAD_REF",
     "GITHUB_REF_NAME",
     "CI_COMMIT_REF_NAME",
@@ -10,7 +9,6 @@ const branchEnvironmentVariables = [
     "BRANCH_NAME"
 ];
 const commitEnvironmentVariables = [
-    "TESTPULSE_COMMIT_SHA",
     "GITHUB_SHA",
     "CI_COMMIT_SHA",
     "BUILD_SOURCEVERSION",

package/dist/reporter/PlaywrightReporter.d.ts

@@ -3,6 +3,7 @@ import type { TestPulseReporterOptions } from "./types.js";
 export default class TestPulseReporter implements Reporter {
     private readonly options;
     private runId;
+    private isListOnly;
     private metadataPromise;
     private readonly eventQueue;
     private readonly runClient;

package/dist/reporter/PlaywrightReporter.js

@@ -7,6 +7,7 @@ import { RunClient } from "./RunClient.js";
 export default class TestPulseReporter {
     options;
     runId = null;
+    isListOnly = false;
     metadataPromise = null;
     eventQueue = new EventQueue();
     runClient;
@@ -16,16 +17,22 @@ export default class TestPulseReporter {
         this.options = options;
         this.resolvedOptions = {
             ...options,
-            endpoint: resolveTestPulseEndpoint(options.endpoint),
-            liveStreamingEnabled: options.liveStreamingEnabled ?? true
+            endpoint: resolveTestPulseEndpoint(options.endpoint)
         };
         this.runClient = new RunClient(this.resolvedOptions);
         this.artifactUploader = new ArtifactUploader(this.eventQueue, () => this.ensureRunStarted(), this.runClient);
     }
     async onBegin(_config, _suite) {
+        this.isListOnly = Boolean(_config.cliListOnly);
+        if (this.isListOnly) {
+            return;
+        }
         await this.ensureRunStarted();
     }
     onTestBegin(test) {
+        if (this.isListOnly) {
+            return;
+        }
         this.enqueueEvent("test.started", {
             testId: test.id,
             testName: test.title,
@@ -33,6 +40,9 @@ export default class TestPulseReporter {
         });
     }
     onTestEnd(test, result) {
+        if (this.isListOnly) {
+            return;
+        }
         const eventType = result.status === "passed"
             ? "test.passed"
             : result.status === "skipped"
@@ -55,6 +65,9 @@ export default class TestPulseReporter {
         this.artifactUploader.enqueueArtifacts(test, result, eventSequence);
     }
     onStdOut(chunk, test) {
+        if (this.isListOnly) {
+            return;
+        }
         this.enqueueEvent("log", {
             level: "info",
             message: chunk.toString(),
@@ -62,6 +75,9 @@ export default class TestPulseReporter {
         });
     }
     onStdErr(chunk, test) {
+        if (this.isListOnly) {
+            return;
+        }
         this.enqueueEvent("log", {
             level: "error",
             message: chunk.toString(),
@@ -69,15 +85,16 @@ export default class TestPulseReporter {
         });
     }
     async onEnd(result) {
+        if (this.isListOnly || !this.runId) {
+            return;
+        }
         const runId = await this.ensureRunStarted();
         await this.eventQueue.flush();
         try {
             await this.runClient.completeRun(runId, result.status === "failed" ? "Failed" : "Completed");
         }
         finally {
-            if (this.resolvedOptions.liveStreamingEnabled) {
-                await deleteLiveCaptureState(this.options.liveStreamSessionKey, this.options.liveCaptureStateDirectory);
-            }
+            await deleteLiveCaptureState(this.options.liveStreamSessionKey, this.options.liveCaptureStateDirectory);
         }
     }
     printsToStdio() {
@@ -108,20 +125,18 @@ export default class TestPulseReporter {
         const metadata = await this.metadataPromise;
         const payload = await this.runClient.startRun(metadata);
         this.runId = payload.runId;
-        if (this.resolvedOptions.liveStreamingEnabled) {
-            if (!payload.streamPublisherToken) {
-                throw new Error("TestPulse live streaming token was not returned by the backend.");
-            }
-            await writeLiveCaptureState({
-                endpoint: this.resolvedOptions.endpoint,
-                projectId: this.options.projectId,
-                apiKey: this.options.apiKey,
-                runId: this.runId,
-                streamPublisherToken: payload.streamPublisherToken,
-                createdAt: new Date().toISOString(),
-                intervalMs: this.options.liveCaptureIntervalMs
-            }, this.options.liveStreamSessionKey, this.options.liveCaptureStateDirectory);
+        if (!payload.streamPublisherToken) {
+            throw new Error("TestPulse live streaming token was not returned by the backend.");
         }
+        await writeLiveCaptureState({
+            endpoint: this.resolvedOptions.endpoint,
+            projectId: this.options.projectId,
+            apiKey: this.options.apiKey,
+            runId: this.runId,
+            streamPublisherToken: payload.streamPublisherToken,
+            createdAt: new Date().toISOString(),
+            intervalMs: this.options.liveCaptureIntervalMs
+        }, this.options.liveStreamSessionKey, this.options.liveCaptureStateDirectory);
         return this.runId;
     }
 }

package/dist/reporter/types.d.ts

@@ -5,7 +5,6 @@ export interface TestPulseReporterOptions {
     runName?: string;
     branch?: string;
     commitSha?: string;
-    liveStreamingEnabled?: boolean;
     liveCaptureIntervalMs?: number;
     liveStreamSessionKey?: string;
     liveCaptureStateDirectory?: string;
@@ -21,7 +20,6 @@ export type StartRunResponse = {
     runId: string;
     streamPublisherToken?: string;
 };
-export interface ResolvedTestPulseReporterOptions extends Omit<TestPulseReporterOptions, "endpoint" | "liveStreamingEnabled"> {
+export interface ResolvedTestPulseReporterOptions extends Omit<TestPulseReporterOptions, "endpoint"> {
     endpoint: string;
-    liveStreamingEnabled: boolean;
 }

package/dist/shared/endpoint.d.ts

@@ -1 +1 @@
-export declare function resolveTestPulseEndpoint(endpoint: string | undefined, environment?: NodeJS.ProcessEnv): string;
+export declare function resolveTestPulseEndpoint(endpoint: string | undefined): string;

package/dist/shared/endpoint.js

@@ -1,20 +1,6 @@
-const defaultEndpoints = {
-    production: "https://testpulse.mevodo.com",
-    staging: "https://testpulse.staging.mevodo.com",
-    local: "http://localhost:5123"
-};
-export function resolveTestPulseEndpoint(endpoint, environment = process.env) {
-    const explicitEndpoint = trim(endpoint) ?? trim(environment.TESTPULSE_ENDPOINT);
-    if (explicitEndpoint) {
-        return trimTrailingSlash(explicitEndpoint);
-    }
-    return defaultEndpoints[parseEnvironment(environment.TESTPULSE_ENV)];
-}
-function parseEnvironment(value) {
-    const normalized = value?.trim().toLowerCase();
-    return normalized === "local" || normalized === "staging"
-        ? normalized
-        : "production";
+const defaultEndpoint = "https://testpulse.mevodo.com";
+export function resolveTestPulseEndpoint(endpoint) {
+    return trimTrailingSlash(trim(endpoint) ?? defaultEndpoint);
 }
 function trim(value) {
     const trimmed = value?.trim();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@testpulse.run/reporter",
-  "version": "0.1.3",
+  "version": "0.1.4",
   "description": "Playwright reporter for streaming TestPulse runs and optional live browser capture",
   "type": "module",
   "main": "./dist/index.js",
@@ -53,7 +53,8 @@
     "@playwright/test": ">=1.40.0"
   },
   "dependencies": {
-    "ffmpeg-static": "^5.3.0"
+    "ffmpeg-static": "^5.3.0",
+    "mv-testpulse-demo": "file:../../demo"
   },
   "devDependencies": {
     "@playwright/test": "^1.54.2",