@peerbit/shared-log 14.0.0 → 15.0.0

package/src/replication-announcement.ts

@@ -10,6 +10,7 @@ import { TimeoutError, debounceFixedInterval } from "@peerbit/time";
 import { isNotStartedError } from "./errors.js";
 import type { TransportMessage } from "./message.js";
 import type { ReplicationRangeIndexable } from "./ranges.js";
+import type { ReplicationInfoMutation } from "./replication-info-mutation.js";
 import {
 	AddedReplicationSegmentMessage,
 	AllReplicatingSegmentsMessage,
@@ -206,14 +207,34 @@ export type ReplicationAnnouncementDeps<R extends "u32" | "u64"> = {
 	queueCurrentReplicationStateAnnouncementRetry: (error: unknown) => boolean;
 	// V2 is always current. Legacy publication is enabled only for an explicit
 	// compatibility open and retains its exact rejection/retry semantics there.
-	enqueueReplicationInfoV2: (message: LegacyReplicationInfoMessage) => void;
+	enqueueReplicationInfoV2: (mutation: ReplicationInfoMutation) => void;
 	isLegacyReplicationInfoEnabled: () => boolean;
 };
 
-type LegacyReplicationInfoMessage =
+/**
+ * The dormant legacy tail still broadcasts the retired wire classes when an
+ * explicit compatibility open enabled it (impossible since B12 stage 1; the
+ * tail is deleted in stage 3). Materialize the frame from the neutral
+ * mutation locally so the tail keeps its exact byte semantics until then.
+ */
+const toLegacyReplicationInfoFrame = (
+	mutation: ReplicationInfoMutation,
+):
 	| AllReplicatingSegmentsMessage
 	| AddedReplicationSegmentMessage
-	| StoppedReplicating;
+	| StoppedReplicating => {
+	if ("full" in mutation) {
+		return new AllReplicatingSegmentsMessage({
+			segments: mutation.full.segments,
+		});
+	}
+	if ("added" in mutation) {
+		return new AddedReplicationSegmentMessage({
+			segments: mutation.added.segments,
+		});
+	}
+	return new StoppedReplicating({ segmentIds: mutation.stopped.segmentIds });
+};
 
 export class ReplicationAnnouncementCoordinator<R extends "u32" | "u64"> {
 	replicationAnnouncementRetryDebounced:
@@ -627,7 +648,7 @@ export class ReplicationAnnouncementCoordinator<R extends "u32" | "u64"> {
 	}
 
 	async sendReplicationAnnouncement(
-		message: LegacyReplicationInfoMessage,
+		mutation: ReplicationInfoMutation,
 		ownershipLifecycleController = this.deps.captureReplicationOwnershipLifecycle(),
 		options?: { shouldSend?: () => boolean },
 	): Promise<void> {
@@ -652,12 +673,12 @@ export class ReplicationAnnouncementCoordinator<R extends "u32" | "u64"> {
 				// after that stale send settles.
 				this.rotateAnnouncementSession();
 				this.advanceCurrentReplicationStateAnnouncementRepairGeneration();
-				this.deps.enqueueReplicationInfoV2(message);
+				this.deps.enqueueReplicationInfoV2(mutation);
 				if (!this.deps.isLegacyReplicationInfoEnabled()) {
 					return;
 				}
 				try {
-					await this.deps.getRpc().send(message, {
+					await this.deps.getRpc().send(toLegacyReplicationInfoFrame(mutation), {
 						priority: CONVERGENCE_MESSAGE_PRIORITY,
 						signal: ownershipLifecycleController.signal,
 					});

package/src/replication-info-mutation.ts

@@ -0,0 +1,34 @@
+import type { ReplicationRangeMessage } from "./ranges.js";
+
+/**
+ * Neutral internal representation of a local replication-state mutation.
+ *
+ * Producers (replicate/unreplicate/join and their corrective snapshot paths)
+ * hand these plain tagged objects to the announcement coordinator, which maps
+ * them onto the directed V2 wire messages:
+ *
+ * - `full`    -> FullReplicationInfoV2Message (authoritative snapshot)
+ * - `added`   -> AddedReplicationInfoV2Message (incremental delta)
+ * - `stopped` -> StoppedReplicationInfoV2Message (retired segment ids)
+ *
+ * The retired legacy announcement classes (AllReplicatingSegmentsMessage,
+ * AddedReplicationSegmentMessage, StoppedReplicating) remain registered
+ * decode tombstones on the wire surface but are no longer the internal
+ * currency between mutation producers and the V2 sender.
+ */
+export type FullReplicationInfoMutation = {
+	full: { segments: ReplicationRangeMessage<any>[] };
+};
+
+export type AddedReplicationInfoMutation = {
+	added: { segments: ReplicationRangeMessage<any>[] };
+};
+
+export type StoppedReplicationInfoMutation = {
+	stopped: { segmentIds: Uint8Array[] };
+};
+
+export type ReplicationInfoMutation =
+	| FullReplicationInfoMutation
+	| AddedReplicationInfoMutation
+	| StoppedReplicationInfoMutation;

package/src/replication-info-v2-send.ts

@@ -8,13 +8,11 @@ import {
 import type { TransportMessage } from "./message.js";
 import type { ReplicationRangeIndexable } from "./ranges.js";
 import { deriveReplicationInfoV2ReceiverBinding } from "./replication-info-v2-binding.js";
+import type { ReplicationInfoMutation } from "./replication-info-mutation.js";
 import {
 	AddedReplicationInfoV2Message,
-	AddedReplicationSegmentMessage,
-	AllReplicatingSegmentsMessage,
 	FullReplicationInfoV2Message,
 	RequestReplicationInfoV2Message,
-	StoppedReplicating,
 	StoppedReplicationInfoV2Message,
 } from "./replication.js";
 
@@ -27,14 +25,9 @@ const MAX_BACKOFF_EXPONENT = 20;
 
 export { deriveReplicationInfoV2ReceiverBinding } from "./replication-info-v2-binding.js";
 
-export type LegacyReplicationInfoMessage =
-	| AllReplicatingSegmentsMessage
-	| AddedReplicationSegmentMessage
-	| StoppedReplicating;
-
 type SendRequest =
 	| { kind: "snapshot" }
-	| { kind: "message"; message: LegacyReplicationInfoMessage };
+	| { kind: "mutation"; mutation: ReplicationInfoMutation };
 
 export type ReplicationInfoV2SendState = {
 	peerHash: string;
@@ -393,9 +386,9 @@ export class ReplicationInfoV2SendCoordinator<R extends "u32" | "u64"> {
 		return true;
 	}
 
-	enqueue(message: LegacyReplicationInfoMessage): void {
+	enqueue(mutation: ReplicationInfoMutation): void {
 		for (const state of [...this._sendStates.values()]) {
-			this.enqueueState(state, { kind: "message", message });
+			this.enqueueState(state, { kind: "mutation", mutation });
 		}
 	}
 
@@ -538,20 +531,21 @@ export class ReplicationInfoV2SendCoordinator<R extends "u32" | "u64"> {
 			this.deps.validatePersistedReplicationRangeSnapshot(segments);
 			return new FullReplicationInfoV2Message({ ...common, segments });
 		}
-		if (request.message instanceof AllReplicatingSegmentsMessage) {
-			const segments = request.message.segments;
+		const { mutation } = request;
+		if ("full" in mutation) {
+			const segments = mutation.full.segments;
 			this.deps.validatePersistedReplicationRangeSnapshot(segments);
 			return new FullReplicationInfoV2Message({ ...common, segments });
 		}
-		if (request.message instanceof AddedReplicationSegmentMessage) {
+		if ("added" in mutation) {
 			return new AddedReplicationInfoV2Message({
 				...common,
-				segments: request.message.segments,
+				segments: mutation.added.segments,
 			});
 		}
 		return new StoppedReplicationInfoV2Message({
 			...common,
-			segmentIds: request.message.segmentIds,
+			segmentIds: mutation.stopped.segmentIds,
 		});
 	}