cross-tab-worker-databus 0.21.25 → 0.21.26

package/dist/cjs/centrifuge.cjs

@@ -2125,7 +2125,9 @@ var ReplayManager = class {
   trace;
   onPersistenceError;
   onDispatchError;
-  /** Bumped on suspend/stop so in-flight persistence retries are cancelled. */
+  /** Bumped by exactly one statement, in `suspend()` below — which is where the
+   * `generation !== this.retryGeneration` tests throughout this file look for a
+   * cancellation. This class's own `stop()` does not touch the field. */
   retryGeneration = 0;
   pendingReplayPersistence = [];
   persistenceFlushScheduled = false;
@@ -2284,13 +2286,19 @@ var ReplayManager = class {
       this.scheduleRetentionCleanup(this.now() - this.retentionMs);
     }, this.retentionSweepMs);
   }
-  /** Stop the periodic retention sweep. */
+  /** Stop the periodic retention sweep. Its only caller in `src/` is `suspend()`,
+   * which chains it at its end — the class is internal (`ReplayManager` appears
+   * nowhere in the barrel), so no consumer reaches this method directly. It
+   * cancels no in-flight work: that is the `retryGeneration` bump in `suspend()`. */
   stop() {
     if (this.retentionTimer) clearInterval(this.retentionTimer);
     this.retentionTimer = null;
   }
-  /** Suspend the manager: cancel in-flight persistence retries (so a hidden tab
-   * or stopped bus does not keep hammering the store) and stop the sweep. */
+  /** Cancel in-flight persistence retries by superseding their generation, so a
+   * hidden tab or a stopped bus does not keep hammering the store. This is the
+   * field's only writer; the bus reaches it from its two `replayManager.suspend()`
+   * call sites (the cluster's `onSuspend` handler, and `beginStop()`), and this
+   * class's own `stop()` only clears the sweep timer. */
   suspend() {
     this.retryGeneration += 1;
     if (this.hydration) {
@@ -2464,7 +2472,7 @@ var ReplayManager = class {
     });
   }
   /** Run a persistence operation with exponential backoff on transient failure.
-   * Bumped `retryGeneration` (suspend/stop) cancels the loop early; a
+   * The `suspend()` bump of `retryGeneration` cancels the loop early; a
    * structurally failing operation throws after `persistenceRetryMaxAttempts`,
    * leaving the ring buffer intact so the bus keeps working. */
   async withPersistenceRetry(persistenceOperation, operation) {
@@ -2620,7 +2628,7 @@ var SDK_VERSION = (
   // declaration's type is `string | undefined` and the export's is `string`
   // (dropping the conditional is TS2322, measured). Recorded here so the leg reads
   // as a shape the harness cannot reach rather than as a case nobody exercised.
-  true ? "0.21.25" : ""
+  true ? "0.21.26" : ""
 );
 
 // src/core/data-bus.ts