loro-repo 0.5.2 → 0.5.3

package/dist/index.d.ts

@@ -17,6 +17,7 @@ declare class LoroRepo<Meta extends JsonObject = JsonObject> {
   private readonly flockHydrator;
   private readonly state;
   private readonly syncRunner;
+  private readonly metaPersister;
   private constructor();
   static create<Meta extends JsonObject = JsonObject>(options: LoroRepoOptions): Promise<LoroRepo<Meta>>;
   /**
@@ -85,7 +86,6 @@ declare class LoroRepo<Meta extends JsonObject = JsonObject> {
   listAssets(docId: string): Promise<RepoAssetMetadata[]>;
   ensureAsset(assetId: AssetId): Promise<AssetDownload>;
   gcAssets(options?: GarbageCollectionOptions): Promise<number>;
-  private persistMeta;
   get destroyed(): boolean;
   destroy(): Promise<void>;
 }

package/dist/index.js

@@ -65,7 +65,6 @@ var DocManager = class {
 	docFrontierDebounceMs;
 	getMetaFlock;
 	eventBus;
-	persistMeta;
 	docs = /* @__PURE__ */ new Map();
 	docSubscriptions = /* @__PURE__ */ new Map();
 	docFrontierUpdates = /* @__PURE__ */ new Map();
@@ -75,7 +74,6 @@ var DocManager = class {
 		this.docFrontierDebounceMs = options.docFrontierDebounceMs;
 		this.getMetaFlock = options.getMetaFlock;
 		this.eventBus = options.eventBus;
-		this.persistMeta = options.persistMeta;
 	}
 	async openPersistedDoc(docId) {
 		return await this.ensureDoc(docId);
@@ -136,16 +134,13 @@ var DocManager = class {
 			], f.counter);
 			mutated = true;
 		}
-		if (mutated) {
-			for (const [peer, counter] of existingFrontiers) {
-				const docCounterEnd = vv.get(peer);
-				if (docCounterEnd != null && docCounterEnd > counter) metaFlock.delete([
-					"f",
-					docId,
-					peer
-				]);
-			}
-			await this.persistMeta();
+		if (mutated) for (const [peer, counter] of existingFrontiers) {
+			const docCounterEnd = vv.get(peer);
+			if (docCounterEnd != null && docCounterEnd > counter) metaFlock.delete([
+				"f",
+				docId,
+				peer
+			]);
 		}
 		const by = this.eventBus.resolveEventBy(defaultBy);
 		this.eventBus.emit({
@@ -499,12 +494,10 @@ function matchesQuery(docId, _metadata, query) {
 var MetadataManager = class {
 	getMetaFlock;
 	eventBus;
-	persistMeta;
 	state;
 	constructor(options) {
 		this.getMetaFlock = options.getMetaFlock;
 		this.eventBus = options.eventBus;
-		this.persistMeta = options.persistMeta;
 		this.state = options.state;
 	}
 	getDocIds() {
@@ -561,7 +554,6 @@ var MetadataManager = class {
 			if (rawValue === void 0) continue;
 			if (jsonEquals(base ? base[key] : void 0, rawValue)) continue;
 			const storageKey = key === "tombstone" ? "$tombstone" : key;
-			console.log("upserting", rawValue);
 			this.metaFlock.put([
 				"m",
 				docId,
@@ -576,7 +568,6 @@ var MetadataManager = class {
 			return;
 		}
 		this.state.metadata.set(docId, next);
-		await this.persistMeta();
 		this.eventBus.emit({
 			kind: "doc-metadata",
 			docId,
@@ -702,7 +693,6 @@ var AssetManager = class {
 	assetTransport;
 	getMetaFlock;
 	eventBus;
-	persistMeta;
 	state;
 	get docAssets() {
 		return this.state.docAssets;
@@ -721,7 +711,6 @@ var AssetManager = class {
 		this.assetTransport = options.assetTransport;
 		this.getMetaFlock = options.getMetaFlock;
 		this.eventBus = options.eventBus;
-		this.persistMeta = options.persistMeta;
 		this.state = options.state;
 	}
 	async uploadAsset(params) {
@@ -758,7 +747,6 @@ var AssetManager = class {
 			if (metadataMutated) {
 				existing.metadata = metadata$1;
 				this.metaFlock.put(["a", assetId], assetMetaToJson(metadata$1));
-				await this.persistMeta();
 				this.eventBus.emit({
 					kind: "asset-metadata",
 					asset: this.createAssetDownload(assetId, metadata$1, bytes),
@@ -795,7 +783,6 @@ var AssetManager = class {
 		this.markAssetAsOrphan(assetId, metadata);
 		this.updateDocAssetMetadata(assetId, metadata);
 		this.metaFlock.put(["a", assetId], assetMetaToJson(metadata));
-		await this.persistMeta();
 		this.eventBus.emit({
 			kind: "asset-metadata",
 			asset: this.createAssetDownload(assetId, metadata, storedBytes),
@@ -854,7 +841,6 @@ var AssetManager = class {
 				existing.metadata = nextMetadata;
 				metadata = nextMetadata;
 				this.metaFlock.put(["a", assetId], assetMetaToJson(metadata));
-				await this.persistMeta();
 				this.eventBus.emit({
 					kind: "asset-metadata",
 					asset: this.createAssetDownload(assetId, metadata, bytes),
@@ -901,7 +887,6 @@ var AssetManager = class {
 			docId,
 			assetId
 		], true);
-		await this.persistMeta();
 		this.eventBus.emit({
 			kind: "asset-link",
 			docId,
@@ -926,7 +911,6 @@ var AssetManager = class {
 			assetId
 		]);
 		this.removeDocAssetReference(assetId, docId);
-		await this.persistMeta();
 		this.eventBus.emit({
 			kind: "asset-unlink",
 			docId,
@@ -1210,7 +1194,6 @@ var AssetManager = class {
 		this.assets.set(assetId, { metadata });
 		this.updateDocAssetMetadata(assetId, metadata);
 		this.metaFlock.put(["a", assetId], assetMetaToJson(metadata));
-		await this.persistMeta();
 		if (this.storage) await this.storage.save({
 			type: "asset",
 			assetId,
@@ -1366,7 +1349,6 @@ var SyncRunner = class {
 	flockHydrator;
 	getMetaFlock;
 	replaceMetaFlock;
-	persistMeta;
 	readyPromise;
 	metaRoomSubscription;
 	unsubscribeMetaFlock;
@@ -1381,7 +1363,6 @@ var SyncRunner = class {
 		this.flockHydrator = options.flockHydrator;
 		this.getMetaFlock = options.getMetaFlock;
 		this.replaceMetaFlock = options.mergeFlock;
-		this.persistMeta = options.persistMeta;
 	}
 	async ready() {
 		if (!this.readyPromise) this.readyPromise = this.initialize();
@@ -1403,7 +1384,6 @@ var SyncRunner = class {
 				if (!(await this.transport.syncMeta(this.metaFlock)).ok) throw new Error("Metadata sync failed");
 				if (recordedEvents.length > 0) this.flockHydrator.applyEvents(recordedEvents, "sync");
 				else this.flockHydrator.hydrateAll("sync");
-				await this.persistMeta();
 			} finally {
 				unsubscribe();
 				this.eventBus.popEventBy();
@@ -1449,7 +1429,6 @@ var SyncRunner = class {
 		subscription.firstSyncedWithRemote.then(async () => {
 			const by = this.eventBus.resolveEventBy("live");
 			this.flockHydrator.hydrateAll(by);
-			await this.persistMeta();
 		}).catch(logAsyncError("meta room first sync"));
 		return wrapped;
 	}
@@ -1505,7 +1484,6 @@ var SyncRunner = class {
 			const by = this.eventBus.resolveEventBy("live");
 			(async () => {
 				this.flockHydrator.applyEvents(batch.events, by);
-				await this.persistMeta();
 			})().catch(logAsyncError("meta live monitor sync"));
 		});
 	}
@@ -1527,8 +1505,154 @@ function createRepoState() {
 }
 
 //#endregion
-//#region src/index.ts
+//#region src/internal/meta-persister.ts
 const textEncoder = new TextEncoder();
+const DEFAULT_META_PERSIST_DEBOUNCE_MS = 5e3;
+var MetaPersister = class {
+	getMetaFlock;
+	storage;
+	debounceMs;
+	lastPersistedVersion;
+	unsubscribe;
+	flushPromise = Promise.resolve();
+	flushTimer;
+	forceFullOnNextFlush = false;
+	destroyed = false;
+	constructor(options) {
+		this.getMetaFlock = options.getMetaFlock;
+		this.storage = options.storage;
+		const configuredDebounce = options.debounceMs;
+		this.debounceMs = typeof configuredDebounce === "number" && Number.isFinite(configuredDebounce) && configuredDebounce >= 0 ? configuredDebounce : DEFAULT_META_PERSIST_DEBOUNCE_MS;
+	}
+	start(initialVersion) {
+		this.lastPersistedVersion = initialVersion;
+		if (this.unsubscribe) return;
+		this.unsubscribe = this.metaFlock.subscribe(() => {
+			this.scheduleFlush();
+		});
+	}
+	async destroy() {
+		this.destroyed = true;
+		if (this.flushTimer) {
+			clearTimeout(this.flushTimer);
+			this.flushTimer = void 0;
+		}
+		if (this.unsubscribe) {
+			this.unsubscribe();
+			this.unsubscribe = void 0;
+		}
+		await this.flushNow();
+	}
+	async flushNow(forceFull = false) {
+		if (this.flushTimer) {
+			clearTimeout(this.flushTimer);
+			this.flushTimer = void 0;
+		}
+		await this.flush(forceFull);
+	}
+	scheduleFlush() {
+		if (this.destroyed) return;
+		if (this.debounceMs === 0) {
+			this.flush();
+			return;
+		}
+		if (this.flushTimer) clearTimeout(this.flushTimer);
+		this.flushTimer = setTimeout(() => {
+			this.flushTimer = void 0;
+			this.flush();
+		}, this.debounceMs);
+	}
+	async flush(forceFull = false) {
+		if (forceFull) this.forceFullOnNextFlush = true;
+		const run = this.flushPromise.catch(() => {}).then(() => this.flushInternal());
+		this.flushPromise = run;
+		await run;
+	}
+	async flushInternal() {
+		const flock = this.metaFlock;
+		const currentVersion = flock.version();
+		if (this.lastPersistedVersion && this.versionsEqual(currentVersion, this.lastPersistedVersion)) {
+			this.forceFullOnNextFlush = false;
+			return;
+		}
+		const baseline = this.forceFullOnNextFlush ? void 0 : this.lastPersistedVersion;
+		const rawBundle = baseline ? flock.exportJson(baseline) : flock.exportJson();
+		const bundle = baseline ? this.stripUnchangedEntries(rawBundle, baseline) : rawBundle;
+		if (Object.keys(bundle.entries).length === 0) {
+			this.forceFullOnNextFlush = false;
+			this.lastPersistedVersion = currentVersion;
+			return;
+		}
+		const encoded = textEncoder.encode(JSON.stringify(bundle));
+		if (!this.storage) {
+			this.lastPersistedVersion = currentVersion;
+			this.forceFullOnNextFlush = false;
+			return;
+		}
+		try {
+			await this.storage.save({
+				type: "meta",
+				update: encoded
+			});
+		} catch (error) {
+			throw error;
+		}
+		this.lastPersistedVersion = currentVersion;
+		this.forceFullOnNextFlush = false;
+	}
+	get metaFlock() {
+		return this.getMetaFlock();
+	}
+	stripUnchangedEntries(bundle, baseline) {
+		const entries = {};
+		for (const [key, record] of Object.entries(bundle.entries)) {
+			const clock = this.parseClock(record.c);
+			if (!clock) {
+				entries[key] = record;
+				continue;
+			}
+			const baselineEntry = baseline[clock.peerIdHex];
+			if (!baselineEntry) {
+				entries[key] = record;
+				continue;
+			}
+			if (clock.physicalTime > baselineEntry.physicalTime || clock.physicalTime === baselineEntry.physicalTime && clock.logicalCounter > baselineEntry.logicalCounter) entries[key] = record;
+		}
+		return {
+			version: bundle.version,
+			entries
+		};
+	}
+	parseClock(raw) {
+		if (typeof raw !== "string") return void 0;
+		const [physicalTimeStr, logicalCounterStr, peerIdHex] = raw.split(",");
+		if (!physicalTimeStr || !logicalCounterStr || !peerIdHex) return void 0;
+		const physicalTime = Number(physicalTimeStr);
+		const logicalCounter = Number(logicalCounterStr);
+		if (!Number.isFinite(physicalTime) || !Number.isFinite(logicalCounter)) return void 0;
+		return {
+			physicalTime,
+			logicalCounter,
+			peerIdHex
+		};
+	}
+	versionsEqual(a, b) {
+		if (!a || !b) return false;
+		const aKeys = Object.keys(a);
+		const bKeys = Object.keys(b);
+		if (aKeys.length !== bKeys.length) return false;
+		for (const key of aKeys) {
+			const aEntry = a[key];
+			const bEntry = b[key];
+			if (!aEntry || !bEntry) return false;
+			if (aEntry.physicalTime !== bEntry.physicalTime || aEntry.logicalCounter !== bEntry.logicalCounter) return false;
+		}
+		return true;
+	}
+};
+
+//#endregion
+//#region src/index.ts
 const DEFAULT_DOC_FRONTIER_DEBOUNCE_MS = 1e3;
 var LoroRepo = class LoroRepo {
 	options;
@@ -1544,6 +1668,7 @@ var LoroRepo = class LoroRepo {
 	flockHydrator;
 	state;
 	syncRunner;
+	metaPersister;
 	constructor(options) {
 		this.options = options;
 		this.transport = options.transportAdapter;
@@ -1557,13 +1682,11 @@ var LoroRepo = class LoroRepo {
 			storage: this.storage,
 			docFrontierDebounceMs,
 			getMetaFlock: () => this.metaFlock,
-			eventBus: this.eventBus,
-			persistMeta: () => this.persistMeta()
+			eventBus: this.eventBus
 		});
 		this.metadataManager = new MetadataManager({
 			getMetaFlock: () => this.metaFlock,
 			eventBus: this.eventBus,
-			persistMeta: () => this.persistMeta(),
 			state: this.state
 		});
 		this.assetManager = new AssetManager({
@@ -1571,9 +1694,13 @@ var LoroRepo = class LoroRepo {
 			assetTransport: this.assetTransport,
 			getMetaFlock: () => this.metaFlock,
 			eventBus: this.eventBus,
-			persistMeta: () => this.persistMeta(),
 			state: this.state
 		});
+		this.metaPersister = new MetaPersister({
+			getMetaFlock: () => this.metaFlock,
+			storage: this.storage,
+			debounceMs: options.metaPersistDebounceMs
+		});
 		this.flockHydrator = new FlockHydrator({
 			getMetaFlock: () => this.metaFlock,
 			metadataManager: this.metadataManager,
@@ -1591,8 +1718,7 @@ var LoroRepo = class LoroRepo {
 			getMetaFlock: () => this.metaFlock,
 			mergeFlock: (snapshot) => {
 				this.metaFlock.merge(snapshot);
-			},
-			persistMeta: () => this.persistMeta()
+			}
 		});
 	}
 	static async create(options) {
@@ -1609,6 +1735,7 @@ var LoroRepo = class LoroRepo {
 	*/
 	async ready() {
 		await this.syncRunner.ready();
+		this.metaPersister.start(this.metaFlock.version());
 	}
 	/**
 	* Sync selected data via the transport adaptor
@@ -1624,7 +1751,16 @@ var LoroRepo = class LoroRepo {
 	* @returns 
 	*/
 	async joinMetaRoom(params) {
-		return this.syncRunner.joinMetaRoom(params);
+		const subscription = await this.syncRunner.joinMetaRoom(params);
+		return {
+			unsubscribe: subscription.unsubscribe,
+			get connected() {
+				return subscription.connected;
+			},
+			firstSyncedWithRemote: subscription.firstSyncedWithRemote.then(async () => {
+				await this.metaPersister.flushNow();
+			})
+		};
 	}
 	/**
 	* Start syncing the given doc. It will establish a realtime connection to the transport adaptor.
@@ -1696,6 +1832,7 @@ var LoroRepo = class LoroRepo {
 	}
 	async flush() {
 		await this.docManager.flush();
+		await this.metaPersister.flushNow();
 	}
 	async uploadAsset(params) {
 		return this.assetManager.uploadAsset(params);
@@ -1718,21 +1855,13 @@ var LoroRepo = class LoroRepo {
 	async gcAssets(options = {}) {
 		return this.assetManager.gcAssets(options);
 	}
-	async persistMeta() {
-		if (!this.storage) return;
-		const bundle = this.metaFlock.exportJson();
-		const encoded = textEncoder.encode(JSON.stringify(bundle));
-		await this.storage.save({
-			type: "meta",
-			update: encoded
-		});
-	}
 	get destroyed() {
 		return this._destroyed;
 	}
 	async destroy() {
 		if (this._destroyed) return;
 		this._destroyed = true;
+		await this.metaPersister.destroy();
 		await this.syncRunner.destroy();
 		this.assetTransport?.close?.();
 		this.storage?.close?.();