cross-tab-worker-databus 0.7.0 → 0.10.0

package/dist/cjs/index.cjs

@@ -339,6 +339,13 @@ function writeJson(storage, key, value) {
   } catch {
   }
 }
+function publicationMetadata(messageId, timestamp) {
+  if (messageId === void 0 && timestamp === void 0) return void 0;
+  return {
+    ...messageId === void 0 ? {} : { messageId },
+    ...timestamp === void 0 ? {} : { timestamp }
+  };
+}
 function listKeys(storage, prefix) {
   try {
     return Array.from({ length: storage.length }, (_, index) => storage.key(index)).filter(
@@ -568,26 +575,21 @@ var WorkerClusterRuntime = class {
       this.sendRouteReleased(owner.workerId, topic, topicKey, generation);
     }
   }
-  /**
-   * Publish a message to `topic`, routing through the owning Worker (or self if
-   * no owner is found). Returns false when the control message could not be
-   * posted to a remote owner, so the caller can surface the failure instead of
-   * silently dropping the publication.
-   */
-  publish(topic, data) {
+  publish(topic, data, metadataOrMessageId) {
+    const metadata = typeof metadataOrMessageId === "string" ? { messageId: metadataOrMessageId } : metadataOrMessageId;
     const topicKey = this.rememberTopic(topic);
     if (this.assignedTopics.has(topicKey)) {
-      return this.sendControl(this.workerId, "PUBLISH", topic, topicKey, data);
+      return this.sendControl(this.workerId, "PUBLISH", topic, topicKey, data, metadata);
     }
     for (const pattern of this.assignedTopics.values()) {
       if (pattern !== topic && topicMatchesPattern(pattern, topic)) {
-        return this.sendControl(this.workerId, "PUBLISH", topic, topicKey, data);
+        return this.sendControl(this.workerId, "PUBLISH", topic, topicKey, data, metadata);
       }
     }
     const workers = this.readWorkers();
     const route = this.readRoute(topicKey);
     const target = this.routeOwnerIsLive(route, workers) ? route?.workerId ?? this.workerId : this.workerId;
-    return this.sendControl(target, "PUBLISH", topic, topicKey, data);
+    return this.sendControl(target, "PUBLISH", topic, topicKey, data, metadata);
   }
   /** True when `route` exists and its owner worker is among `workers`.
    * Shared by subscribe (skip re-assignment) and publish (route to owner).
@@ -709,7 +711,15 @@ var WorkerClusterRuntime = class {
       default:
         break;
     }
-    this.handlers.onControl(message.action, message.topic, message.data);
+    const metadata = publicationMetadata(message.messageId, message.timestamp);
+    if (metadata) this.handlers.onControl(
+      message.action,
+      message.topic,
+      message.data,
+      metadata.messageId,
+      metadata.timestamp
+    );
+    else this.handlers.onControl(message.action, message.topic, message.data);
     if (message.action !== "PUBLISH") this.updateLoad();
   }
   /**
@@ -826,7 +836,7 @@ var WorkerClusterRuntime = class {
    * Local execution updates the assignment map and route synchronously, bypassing
    * the BroadcastChannel latency.
    */
-  sendControl(targetWorkerId, action, topic, topicKey, data) {
+  sendControl(targetWorkerId, action, topic, topicKey, data, metadata) {
     if (targetWorkerId === this.workerId) {
       switch (action) {
         case "SUBSCRIBE":
@@ -840,7 +850,14 @@ var WorkerClusterRuntime = class {
         default:
           break;
       }
-      this.handlers.onControl(action, topic, data);
+      if (metadata) this.handlers.onControl(
+        action,
+        topic,
+        data,
+        metadata.messageId,
+        metadata.timestamp
+      );
+      else this.handlers.onControl(action, topic, data);
       if (action !== "PUBLISH") this.updateLoad();
       return true;
     }
@@ -851,7 +868,9 @@ var WorkerClusterRuntime = class {
       action,
       topic,
       topicKey,
-      ...data === void 0 ? {} : { data }
+      ...data === void 0 ? {} : { data },
+      ...metadata?.messageId === void 0 ? {} : { messageId: metadata.messageId },
+      ...metadata?.timestamp === void 0 ? {} : { timestamp: metadata.timestamp }
     });
   }
   /** Post a message on the BroadcastChannel. Returns false on postMessage failure. */
@@ -1246,6 +1265,8 @@ var CrossTabDataBus = class _CrossTabDataBus {
   dedupTtlMs;
   dedupEnabled;
   seenMessageIds = /* @__PURE__ */ new Map();
+  dedupSuppressed = 0;
+  dedupAccepted = 0;
   activeConfig;
   status = "disconnected";
   started = false;
@@ -1303,7 +1324,7 @@ var CrossTabDataBus = class _CrossTabDataBus {
       handlers: {
         // The cluster calls `onControl` when it receives a SUBSCRIBE/UNSUBSCRIBE/PUBLISH
         // control message — meaning the owning Worker has delegated the action to us.
-        onControl: (action, topic, data) => {
+        onControl: (action, topic, data, messageId, timestamp) => {
           switch (action) {
             case "SUBSCRIBE":
               if (this.subscribeTransport(topic)) this.traceSubscription("subscribe", topic);
@@ -1312,7 +1333,14 @@ var CrossTabDataBus = class _CrossTabDataBus {
               if (this.unsubscribeTransport(topic)) this.traceSubscription("unsubscribe", topic);
               break;
             case "PUBLISH":
-              this.runTransport(() => this.transport.publish(topic, data));
+              this.runTransport(() => this.transport.publish(
+                topic,
+                data,
+                messageId === void 0 && timestamp === void 0 ? void 0 : {
+                  ...messageId === void 0 ? {} : { messageId },
+                  ...timestamp === void 0 ? {} : { timestamp }
+                }
+              ));
               break;
             default:
               break;
@@ -1491,10 +1519,61 @@ var CrossTabDataBus = class _CrossTabDataBus {
     }
     this.cluster.unsubscribe(topic);
   }
+  /** Clear all in-memory replay buffers and, when supported, durable history. */
+  async clearReplay() {
+    this.replayBuffers?.clear();
+    if (this.replayPersistence?.clear) {
+      try {
+        await this.replayPersistence.clear();
+      } catch (error) {
+        this.reportError(error);
+        throw error;
+      }
+    }
+  }
+  /** Clear replay history for one exact topic, including durable storage. */
+  async clearReplayTopic(topic) {
+    this.replayBuffers?.delete(topic);
+    if (this.replayPersistence?.clearTopic) {
+      try {
+        await this.replayPersistence.clearTopic(topic);
+      } catch (error) {
+        this.reportError(error);
+        throw error;
+      }
+    }
+  }
+  /** Remove replay entries older than an epoch-millisecond cutoff. */
+  async clearReplayBefore(timestamp) {
+    if (!Number.isFinite(timestamp)) throw new TypeError("timestamp must be finite.");
+    if (this.replayBuffers) {
+      for (const [topic, messages] of this.replayBuffers) {
+        const kept = messages.filter((message) => (message.timestamp ?? 0) >= timestamp);
+        if (kept.length) this.replayBuffers.set(topic, kept);
+        else this.replayBuffers.delete(topic);
+      }
+    }
+    if (this.replayPersistence?.clearBefore) await this.replayPersistence.clearBefore(timestamp);
+  }
+  /** Return bounded deduplication counters for diagnostics and health checks. */
+  getDedupStats() {
+    return {
+      enabled: this.dedupEnabled,
+      tracked: this.seenMessageIds.size,
+      suppressed: this.dedupSuppressed,
+      accepted: this.dedupAccepted
+    };
+  }
+  /** Drop all remembered IDs and reset dedup counters. */
+  resetDedup() {
+    this.seenMessageIds.clear();
+    this.dedupSuppressed = 0;
+    this.dedupAccepted = 0;
+  }
   /** Publish a message to `topic`. The owning Worker delivers it to the transport. */
-  publish(topic, data) {
+  publish(topic, data, options) {
     this.ensureStarted();
-    if (!this.cluster.publish(topic, data)) {
+    if (!this.cluster.publish(topic, data, options)) {
       this.reportError(
         new Error("Failed to send the publish control message to the owning worker.")
       );
@@ -1581,8 +1660,13 @@ var CrossTabDataBus = class _CrossTabDataBus {
     for (const [id, timestamp] of this.seenMessageIds) {
       if (now - timestamp > this.dedupTtlMs) this.seenMessageIds.delete(id);
     }
-    if (this.seenMessageIds.has(message.messageId)) return true;
+    if (this.seenMessageIds.has(message.messageId)) {
+      this.trace.event({ type: "reliability", operation: "dedup_suppressed", topic: message.topic });
+      this.dedupSuppressed += 1;
+      return true;
+    }
     this.seenMessageIds.set(message.messageId, now);
+    this.dedupAccepted += 1;
     while (this.seenMessageIds.size > this.dedupMaxEntries) {
       const oldest = this.seenMessageIds.keys().next().value;
       if (oldest === void 0) break;
@@ -1612,10 +1696,11 @@ var CrossTabDataBus = class _CrossTabDataBus {
       buffer = [];
       this.replayBuffers.set(message.topic, buffer);
     }
-    buffer.push(message);
+    const storedMessage = message;
+    buffer.push(storedMessage);
     if (buffer.length > this.replayMaxPerTopic) buffer.shift();
     if (this.replayPersistence) {
-      void this.replayPersistence.append(message).catch((error) => this.reportError(error));
+      void this.replayPersistence.append(storedMessage).catch((error) => this.reportError(error));
     }
   }
   async hydrateReplay() {
@@ -1892,10 +1977,48 @@ function createIndexedDbReplayPersistence(options) {
         transaction.oncomplete = () => resolve();
         transaction.onerror = () => reject(transaction.error ?? new Error("Failed to clear topic replay history."));
       });
+    },
+    async clearBefore(timestamp) {
+      const db = await open();
+      await new Promise((resolve, reject) => {
+        const transaction = db.transaction(storeName, "readwrite");
+        const store = transaction.objectStore(storeName);
+        const request = store.getAll();
+        request.onsuccess = () => {
+          for (const record of request.result) {
+            const messages = record.messages.filter((message) => (message.timestamp ?? 0) >= timestamp);
+            if (messages.length === 0) store.delete(record.topic);
+            else if (messages.length !== record.messages.length) store.put({ topic: record.topic, messages });
+          }
+        };
+        request.onerror = () => reject(request.error ?? new Error("Failed to read replay history."));
+        transaction.oncomplete = () => resolve();
+        transaction.onerror = () => reject(transaction.error ?? new Error("Failed to prune replay history."));
+      });
     }
   };
 }
 
+// src/core/publication.ts
+function parseDataBusPublication(value, fallbackTopic) {
+  if (!value || typeof value !== "object") {
+    return fallbackTopic ? { topic: fallbackTopic, data: value } : null;
+  }
+  const frame = value;
+  const nested = frame.publication && typeof frame.publication === "object" ? frame.publication : null;
+  const publication = nested ?? frame;
+  const topic = typeof publication.topic === "string" ? publication.topic : fallbackTopic;
+  if (!topic) return null;
+  const hasMetadataEnvelope = fallbackTopic !== void 0 && Object.prototype.hasOwnProperty.call(publication, "data") && (typeof publication.messageId === "string" || typeof publication.timestamp === "number");
+  const data = nested || fallbackTopic === void 0 || hasMetadataEnvelope ? publication.data : value;
+  return {
+    topic,
+    data,
+    ...typeof publication.messageId === "string" ? { messageId: publication.messageId } : {},
+    ...typeof publication.timestamp === "number" ? { timestamp: publication.timestamp } : {}
+  };
+}
+
 // src/websocket.ts
 var WS_OPEN = 1;
 var WebSocketTransport = class {
@@ -1943,12 +2066,18 @@ var WebSocketTransport = class {
     this.sendFrame({ op: "unsubscribe", topic });
   }
   /** Publish `data` to `topic` as a JSON frame. Requires an open socket. */
-  publish(topic, data) {
+  publish(topic, data, options) {
     if (data instanceof ArrayBuffer) {
-      this.sendBinaryFrame(topic, data);
+      this.sendBinaryFrame(topic, data, options?.messageId, options?.timestamp);
       return;
     }
-    this.sendFrame({ op: "publish", topic, data });
+    this.sendFrame({
+      op: "publish",
+      topic,
+      data,
+      ...options?.messageId === void 0 ? {} : { messageId: options.messageId },
+      ...options?.timestamp === void 0 ? {} : { timestamp: options.timestamp }
+    });
   }
   /** Close the socket and drop all state. Safe to call multiple times. */
   stop() {
@@ -1968,7 +2097,17 @@ var WebSocketTransport = class {
     }
     this.socket.send(JSON.stringify(payload));
   }
-  sendBinaryFrame(topic, data) {
+  sendBinaryFrame(topic, data, messageId, timestamp) {
+    if (messageId !== void 0 || timestamp !== void 0) {
+      this.sendFrame({
+        op: "publish",
+        topic,
+        data: Array.from(new Uint8Array(data)),
+        ...messageId === void 0 ? {} : { messageId },
+        ...timestamp === void 0 ? {} : { timestamp }
+      });
+      return;
+    }
     if (this.socket?.readyState !== WS_OPEN) {
       this.handlers?.onError(new Error('WebSocket is not open; dropped "publish" frame.'));
       return;
@@ -2008,9 +2147,8 @@ var WebSocketTransport = class {
       return;
     }
     if (!parsed || typeof parsed !== "object") return;
-    const frame = parsed;
-    if (typeof frame.topic !== "string") return;
-    this.handlers?.onMessage({ topic: frame.topic, data: frame.data });
+    const publication = parseDataBusPublication(parsed);
+    if (publication) this.handlers?.onMessage(publication);
   }
 };
 function defaultWebSocketFactory(url, protocols) {