@peerbit/pubsub 4.1.4-cb91e7b → 5.0.0

package/src/index.ts

@@ -17,6 +17,7 @@ import {
 	SubscriptionEvent,
 	TopicRootCandidates,
 	UnsubcriptionEvent,
+	type UnsubscriptionReason,
 	Unsubscribe,
 } from "@peerbit/pubsub-interface";
 import {
@@ -36,6 +37,7 @@ import {
 	MessageHeader,
 	NotStartedError,
 	type PriorityOptions,
+	type RouteHint,
 	SilentDelivery,
 	type WithExtraSigners,
 	deliveryModeHasReceiver,
@@ -228,6 +230,8 @@ export class TopicControlPlane
 	public peerToTopic: Map<string, Set<string>>;
 	// Local topic -> reference count.
 	public subscriptions: Map<string, { counter: number }>;
+	// Local topics requested via debounced subscribe, not yet applied in `subscriptions`.
+	private pendingSubscriptions: Set<string>;
 	public lastSubscriptionMessages: Map<string, Map<string, bigint>> = new Map();
 	public dispatchEventOnSelfPublish: boolean;
 	public readonly topicRootControlPlane: TopicRootControlPlane;
@@ -289,6 +293,7 @@ export class TopicControlPlane
 	) {
 		super(components, ["/peerbit/topic-control-plane/2.0.0"], props);
 		this.subscriptions = new Map();
+		this.pendingSubscriptions = new Set();
 		this.topics = new Map();
 		this.peerToTopic = new Map();
 
@@ -448,6 +453,7 @@ export class TopicControlPlane
 		this.autoCandidatesGossipUntil = 0;
 
 		this.subscriptions.clear();
+		this.pendingSubscriptions.clear();
 		this.topics.clear();
 		this.peerToTopic.clear();
 		this.lastSubscriptionMessages.clear();
@@ -760,11 +766,24 @@ export class TopicControlPlane
 		const subscriptions: string[] = [];
 		if (topics) {
 			for (const topic of topics) {
-				if (this.subscriptions.get(topic)) subscriptions.push(topic);
+				if (
+					this.subscriptions.get(topic) ||
+					this.pendingSubscriptions.has(topic)
+				) {
+					subscriptions.push(topic);
+				}
 			}
 			return subscriptions;
 		}
-		for (const [topic] of this.subscriptions) subscriptions.push(topic);
+		const seen = new Set<string>();
+		for (const [topic] of this.subscriptions) {
+			subscriptions.push(topic);
+			seen.add(topic);
+		}
+		for (const topic of this.pendingSubscriptions) {
+			if (seen.has(topic)) continue;
+			subscriptions.push(topic);
+		}
 		return subscriptions;
 	}
 
@@ -1098,6 +1117,10 @@ export class TopicControlPlane
 	}
 
 	async subscribe(topic: string) {
+		this.pendingSubscriptions.add(topic);
+		// `subscribe()` is debounced; start tracking immediately to avoid dropping
+		// inbound subscription traffic during the debounce window.
+		this.initializeTopic(topic);
 		return this.debounceSubscribeAggregator.add({ key: topic });
 	}
 
@@ -1111,10 +1134,12 @@ export class TopicControlPlane
 			let prev = this.subscriptions.get(topic);
 			if (prev) {
 				prev.counter += counter;
+				this.pendingSubscriptions.delete(topic);
 				continue;
 			}
 			this.subscriptions.set(topic, { counter });
 			this.initializeTopic(topic);
+			this.pendingSubscriptions.delete(topic);
 
 			const shardTopic = this.getShardTopicForUserTopic(topic);
 			byShard.set(shardTopic, [...(byShard.get(shardTopic) ?? []), topic]);
@@ -1156,8 +1181,13 @@ export class TopicControlPlane
 			data?: Uint8Array;
 		},
 	) {
+		this.pendingSubscriptions.delete(topic);
+
 		if (this.debounceSubscribeAggregator.has(topic)) {
 			this.debounceSubscribeAggregator.delete(topic);
+			if (!this.subscriptions.has(topic)) {
+				this.untrackTopic(topic);
+			}
 			return false;
 		}
 
@@ -1252,6 +1282,39 @@ export class TopicControlPlane
 		return ret;
 	}
 
+	/**
+	 * Returns best-effort route hints for a target peer by combining:
+	 * - DirectStream ACK-learned routes
+	 * - Fanout route tokens for the topic's shard overlay
+	 */
+	getUnifiedRouteHints(topic: string, targetHash: string): RouteHint[] {
+		const hints: RouteHint[] = [];
+		const directHint = this.getBestRouteHint(targetHash);
+		if (directHint) {
+			hints.push(directHint);
+		}
+
+		const topicString = topic.toString();
+		const shardTopic = topicString.startsWith(this.shardTopicPrefix)
+			? topicString
+			: this.getShardTopicForUserTopic(topicString);
+		const shard = this.fanoutChannels.get(shardTopic);
+		if (!shard) {
+			return hints;
+		}
+
+		const fanoutHint = this.fanout.getRouteHint(
+			shardTopic,
+			shard.root,
+			targetHash,
+		);
+		if (fanoutHint) {
+			hints.push(fanoutHint);
+		}
+
+		return hints;
+	}
+
 	async requestSubscribers(
 		topic: string | string[],
 		to?: PublicSignKey,
@@ -1434,16 +1497,19 @@ export class TopicControlPlane
 	}
 
 	public onPeerSession(key: PublicSignKey, _session: number): void {
-		this.removeSubscriptions(key);
+		this.removeSubscriptions(key, "peer-session-reset");
 	}
 
 	public override onPeerUnreachable(publicKeyHash: string) {
 		super.onPeerUnreachable(publicKeyHash);
 		const key = this.peerKeyHashToPublicKey.get(publicKeyHash);
-		if (key) this.removeSubscriptions(key);
+		if (key) this.removeSubscriptions(key, "peer-unreachable");
 	}
 
-	private removeSubscriptions(publicKey: PublicSignKey) {
+	private removeSubscriptions(
+		publicKey: PublicSignKey,
+		reason: UnsubscriptionReason,
+	) {
 		const peerHash = publicKey.hashcode();
 		const peerTopics = this.peerToTopic.get(peerHash);
 		const changed: string[] = [];
@@ -1462,7 +1528,7 @@ export class TopicControlPlane
 		if (changed.length > 0) {
 			this.dispatchEvent(
 				new CustomEvent<UnsubcriptionEvent>("unsubscribe", {
-					detail: new UnsubcriptionEvent(publicKey, changed),
+					detail: new UnsubcriptionEvent(publicKey, changed, reason),
 				}),
 			);
 		}
@@ -1504,6 +1570,21 @@ export class TopicControlPlane
 	) {
 		const st = this.fanoutChannels.get(shardTopic);
 		if (!st) return;
+		const hints = this.getUnifiedRouteHints(shardTopic, targetHash);
+		const fanoutHint = hints.find(
+			(hint): hint is Extract<RouteHint, { kind: "fanout-token" }> =>
+				hint.kind === "fanout-token",
+		);
+		if (fanoutHint) {
+			try {
+				await st.channel.unicastAck(fanoutHint.route, payload, {
+					timeoutMs: 5_000,
+				});
+				return;
+			} catch {
+				// ignore and fall back
+			}
+		}
 		try {
 			await st.channel.unicastToAck(targetHash, payload, { timeoutMs: 5_000 });
 			return;
@@ -1664,7 +1745,11 @@ export class TopicControlPlane
 				if (changed.length > 0) {
 					this.dispatchEvent(
 						new CustomEvent<UnsubcriptionEvent>("unsubscribe", {
-							detail: new UnsubcriptionEvent(sender, changed),
+							detail: new UnsubcriptionEvent(
+								sender,
+								changed,
+								"remote-unsubscribe",
+							),
 						}),
 					);
 				}
@@ -1736,7 +1821,7 @@ export class TopicControlPlane
 
 		if (pubsubMessage instanceof PubSubData) {
 			const wantsTopic = pubsubMessage.topics.some((t) =>
-				this.subscriptions.has(t),
+				this.subscriptions.has(t) || this.pendingSubscriptions.has(t),
 			);
 			isForMe = pubsubMessage.strict ? isForMe && wantsTopic : wantsTopic;
 		}