@piwitests/reporter 0.47.0 → 0.48.0

package/dist/cli/index.js

@@ -490,7 +490,7 @@ var DEFAULTS = {
   defaultCapture: true,
   checkBaseUrl: false,
   streaming: true,
-  streamingBatchSize: 5,
+  streamingBatchSize: 20,
   streamingBatchDelay: 2e3,
   maxStreamBufferBytes: 100 * 1024 * 1024,
   submitTimeout: 15 * 60 * 1e3,

package/dist/global-setup-module.js

@@ -90,7 +90,7 @@ var DEFAULTS = {
   defaultCapture: true,
   checkBaseUrl: false,
   streaming: true,
-  streamingBatchSize: 5,
+  streamingBatchSize: 20,
   streamingBatchDelay: 2e3,
   maxStreamBufferBytes: 100 * 1024 * 1024,
   submitTimeout: 15 * 60 * 1e3,

package/dist/index.d.ts

@@ -205,7 +205,11 @@ interface PiwiDashboardOptions {
     pickLocatorOnFailure?: boolean;
     /** Enable live streaming of results (falls back to batch if unsupported). Defaults to `true`. */
     streaming?: boolean;
-    /** Number of test results to batch before sending during streaming. Defaults to `5`. */
+    /**
+     * Number of queued events that triggers a send during streaming: test starts
+     * and results, and live steps while someone has the run open on the
+     * dashboard. Defaults to `20`.
+     */
     streamingBatchSize?: number;
     /** Max delay (ms) before flushing pending events during streaming. Defaults to `2000`. */
     streamingBatchDelay?: number;

package/dist/index.js

@@ -91,7 +91,7 @@ var DEFAULTS = {
   defaultCapture: true,
   checkBaseUrl: false,
   streaming: true,
-  streamingBatchSize: 5,
+  streamingBatchSize: 20,
   streamingBatchDelay: 2e3,
   maxStreamBufferBytes: 100 * 1024 * 1024,
   submitTimeout: 15 * 60 * 1e3,
@@ -1865,6 +1865,20 @@ var StreamManager = class {
     this.heartbeatStopped = false;
     this.lastActivityAt = 0;
     this.heartbeatInterval = 15e3;
+    /**
+     * The heartbeat interval while nobody watches the run: during a long test no
+     * other request goes out, so the heartbeat's answer is how the reporter learns
+     * that someone opened the run.
+     */
+    this.unwatchedHeartbeatInterval = 5e3;
+    /**
+     * Whether anyone has the run open live on the dashboard, from the `watched`
+     * flag of the last answer to an events or heartbeat request; `null` until the
+     * dashboard says, and for a dashboard that does not. Step events are live
+     * progress only (each `complete` event carries its test's steps), so none are
+     * queued while it is `false`.
+     */
+    this.watched = null;
     /** Tracks cases whose files have already been uploaded live, so `uploadRemaining` can skip them. */
     this.uploadedCaseFiles = /* @__PURE__ */ new WeakSet();
     /** Set when a test-result event left the live stream undelivered: too large to send, or still queued when the drain gave up. */
@@ -2035,8 +2049,13 @@ var StreamManager = class {
       this.pendingBeginEvents.enqueue(event);
     }
   }
-  /** Queue a test-case event. Triggers an immediate flush when the batch size is reached, otherwise schedules a timer-based flush. */
+  /**
+   * Queue a test-case event. Triggers an immediate flush when the batch size is
+   * reached, otherwise schedules a timer-based flush. A step event is dropped
+   * while nobody watches the run.
+   */
   queueEvent(event) {
+    if (this.watched === false && (event.type === "step-begin" || event.type === "step-end")) return;
     this.pendingEvents.enqueue(event);
     if (this.pendingEvents.length >= this.options.streamingBatchSize) {
       this.flush();
@@ -2064,11 +2083,12 @@ var StreamManager = class {
     while (chunks.length > 0) {
       const chunk = chunks.shift();
       try {
-        await this.httpClient.postJSON(
+        const response = await this.httpClient.postJSON(
           `/api/test-runs/${this._runId}/events`,
           { streamToken: this._token, testCases: chunk },
           this._auth
         );
+        this.noteWatched(response);
         this.retryCount = 0;
         this.lastActivityAt = Date.now();
       } catch (error) {
@@ -2142,13 +2162,29 @@ var StreamManager = class {
       if (this.pendingEvents.length > 0) this.flush();
     }, delay);
   }
+  // Take the dashboard's answer on whether anyone watches the run. An answer
+  // without the flag (an older dashboard) keeps step events flowing.
+  noteWatched(response) {
+    const watched = response?.watched;
+    const next = typeof watched === "boolean" ? watched : null;
+    if (next !== null && next !== this.watched) {
+      this.logger.debug(
+        next ? "The run is open on the dashboard: streaming live steps." : "Nobody is watching the run: live steps are not sent."
+      );
+    }
+    this.watched = next;
+  }
+  // Idle time after which a heartbeat goes out.
+  heartbeatDelay() {
+    return this.watched === false ? this.unwatchedHeartbeatInterval : this.heartbeatInterval;
+  }
   // Schedule the next idle heartbeat. Self-rescheduling; cleared by stopHeartbeat.
   scheduleHeartbeat() {
     if (this.heartbeatStopped || this.heartbeatTimer) return;
     this.heartbeatTimer = setTimeout(() => {
       this.heartbeatTimer = null;
       void this.sendHeartbeat();
-    }, this.heartbeatInterval);
+    }, this.heartbeatDelay());
   }
   // Ping the server only when the run has actually been idle. Real event traffic
   // already bumps the server's activity timestamp, so a recent flush (or pending
@@ -2156,16 +2192,17 @@ var StreamManager = class {
   async sendHeartbeat() {
     if (this.heartbeatStopped || !this._enabled || !this._runId || !this._token) return;
     const idleFor = Date.now() - this.lastActivityAt;
-    if (idleFor < this.heartbeatInterval || this.pendingEvents.length > 0) {
+    if (idleFor < this.heartbeatDelay() || this.pendingEvents.length > 0) {
       this.scheduleHeartbeat();
       return;
     }
     try {
-      await this.httpClient.postJSON(
+      const response = await this.httpClient.postJSON(
         `/api/test-runs/${this._runId}/heartbeat`,
         { streamToken: this._token },
         this._auth
       );
+      this.noteWatched(response);
       this.lastActivityAt = Date.now();
     } catch (error) {
       this.logger.debug(`Heartbeat failed: ${errorMessage(error)}`);

package/dist/internal/capture/capture-fixtures.js

@@ -2158,7 +2158,7 @@ var DEFAULTS = {
   defaultCapture: true,
   checkBaseUrl: false,
   streaming: true,
-  streamingBatchSize: 5,
+  streamingBatchSize: 20,
   streamingBatchDelay: 2e3,
   maxStreamBufferBytes: 100 * 1024 * 1024,
   submitTimeout: 15 * 60 * 1e3,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@piwitests/reporter",
-  "version": "0.47.0",
+  "version": "0.48.0",
   "description": "Playwright reporter that streams results, traces and HTML reports to a Piwi Dashboard instance",
   "url": "https://github.com/PiwiTests/platform",
   "homepage": "https://piwitests.dev",