@dxos/echo-pipeline 0.1.36-next.ef27157 → 0.1.36

package/dist/lib/node/index.cjs

@@ -37,7 +37,7 @@ __export(src_exports, {
   DataServiceHost: () => DataServiceHost,
   DataServiceImpl: () => DataServiceImpl,
   DataServiceSubscriptions: () => DataServiceSubscriptions,
-  DatabaseBackendHost: () => DatabaseBackendHost,
+  DatabaseHost: () => DatabaseHost,
   EntityNotFoundError: () => EntityNotFoundError,
   IdentityNotInitializedError: () => IdentityNotInitializedError,
   InvalidInvitationError: () => InvalidInvitationError,
@@ -116,8 +116,10 @@ var UnknownModelError = class extends DBError {
 };
 
 // packages/core/echo/echo-pipeline/src/metadata/metadata-store.ts
+var import_crc_32 = __toESM(require("crc-32"));
 var import_node_assert = __toESM(require("node:assert"));
 var import_async = require("@dxos/async");
+var import_errors = require("@dxos/errors");
 var import_log = require("@dxos/log");
 var import_protocols = require("@dxos/protocols");
 var __decorate = function(decorators, target, key, desc) {
@@ -162,31 +164,35 @@ var MetadataStore = class {
     const file = this._directory.getOrCreateFile("EchoMetadata");
     try {
       const { size: fileLength } = await file.stat();
-      if (fileLength < 4) {
+      if (fileLength < 8) {
         return;
       }
       const dataSize = fromBytesInt32(await file.read(0, 4));
+      const checksum = fromBytesInt32(await file.read(4, 4));
       (0, import_log.log)("loaded", {
-        size: dataSize
+        size: dataSize,
+        checksum
       }, {
         file: "metadata-store.ts",
-        line: 67,
+        line: 70,
         scope: this,
         callSite: (f, a) => f(...a)
       });
-      {
-        if (fileLength < dataSize + 4) {
-          throw new Error("Metadata storage is corrupted");
-        }
+      if (fileLength < dataSize + 8) {
+        throw new import_errors.DataCorruptionError("Metadata size is smaller than expected.");
+      }
+      const data = await file.read(8, dataSize);
+      const calculatedChecksum = import_crc_32.default.buf(data);
+      if (calculatedChecksum !== checksum) {
+        throw new import_errors.DataCorruptionError("Metadata checksum is invalid.");
       }
-      const data = await file.read(4, dataSize);
       this._metadata = import_protocols.schema.getCodecForType("dxos.echo.metadata.EchoMetadata").decode(data);
     } catch (err) {
       import_log.log.error("failed to load metadata", {
         err
       }, {
         file: "metadata-store.ts",
-        line: 79,
+        line: 85,
         scope: this,
         callSite: (f, a) => f(...a)
       });
@@ -206,16 +212,21 @@ var MetadataStore = class {
     const file = this._directory.getOrCreateFile("EchoMetadata");
     try {
       const encoded = Buffer.from(import_protocols.schema.getCodecForType("dxos.echo.metadata.EchoMetadata").encode(data));
-      await file.write(0, toBytesInt32(encoded.length));
+      const checksum = import_crc_32.default.buf(encoded);
+      const result = Buffer.alloc(8 + encoded.length);
+      result.writeInt32LE(encoded.length, 0);
+      result.writeInt32LE(checksum, 4);
+      encoded.copy(result, 8);
+      await file.write(0, result);
       (0, import_log.log)("saved", {
-        size: encoded.length
+        size: encoded.length,
+        checksum
       }, {
         file: "metadata-store.ts",
-        line: 102,
+        line: 116,
         scope: this,
         callSite: (f, a) => f(...a)
       });
-      await file.write(4, encoded);
     } finally {
       await file.close();
     }
@@ -226,7 +237,7 @@ var MetadataStore = class {
   async clear() {
     (0, import_log.log)("clearing all metadata", {}, {
       file: "metadata-store.ts",
-      line: 115,
+      line: 126,
       scope: this,
       callSite: (f, a) => f(...a)
     });
@@ -272,11 +283,6 @@ __decorate([
 __decorate([
   import_async.synchronized
 ], MetadataStore.prototype, "_save", null);
-var toBytesInt32 = (num) => {
-  const buf = Buffer.alloc(4);
-  buf.writeInt32LE(num, 0);
-  return buf;
-};
 var fromBytesInt32 = (buf) => buf.readInt32LE(0);
 
 // packages/core/echo/echo-pipeline/src/pipeline/pipeline.ts
@@ -300,7 +306,7 @@ var createMappedFeedWriter = (mapper, writer) => {
   (0, import_node_assert2.default)(mapper);
   (0, import_node_assert2.default)(writer);
   return {
-    write: async (data) => await writer.write(await mapper(data))
+    write: async (data, options) => await writer.write(await mapper(data), options)
   };
 };
 
@@ -353,17 +359,31 @@ var TimeframeClock = class {
   constructor(_timeframe = new import_timeframe.Timeframe()) {
     this._timeframe = _timeframe;
     this.update = new import_async2.Event();
+    this._pendingTimeframe = _timeframe;
   }
+  /**
+  * Timeframe that was processed by ECHO.
+  */
   get timeframe() {
     return this._timeframe;
   }
-  updateTimeframe(key, seq) {
-    this._timeframe = import_timeframe.Timeframe.merge(this._timeframe, new import_timeframe.Timeframe([
+  /**
+  * Timeframe that is currently being processed by ECHO.
+  * Will be equal to `timeframe` after the processing is complete.
+  */
+  get pendingTimeframe() {
+    return this._pendingTimeframe;
+  }
+  updatePendingTimeframe(key, seq) {
+    this._pendingTimeframe = import_timeframe.Timeframe.merge(this._pendingTimeframe, new import_timeframe.Timeframe([
       [
         key,
         seq
       ]
     ]));
+  }
+  updateTimeframe() {
+    this._timeframe = this._pendingTimeframe;
     this.update.emit(this._timeframe);
   }
   hasGaps(timeframe) {
@@ -376,7 +396,7 @@ var TimeframeClock = class {
       current: this._timeframe
     }, {
       file: "timeframe-clock.ts",
-      line: 48,
+      line: 67,
       scope: this,
       callSite: (f, a) => f(...a)
     });
@@ -387,7 +407,7 @@ var TimeframeClock = class {
         deps: import_timeframe.Timeframe.dependencies(target, this._timeframe)
       }, {
         file: "timeframe-clock.ts",
-        line: 50,
+        line: 69,
         scope: this,
         callSite: (f, a) => f(...a)
       });
@@ -431,6 +451,9 @@ var PipelineState = class {
   get timeframe() {
     return this._timeframeClock.timeframe;
   }
+  get pendingTimeframe() {
+    return this._timeframeClock.pendingTimeframe;
+  }
   get targetTimeframe() {
     return this._targetTimeframe ? this._targetTimeframe : new import_timeframe2.Timeframe();
   }
@@ -458,7 +481,7 @@ var PipelineState = class {
       target: this.targetTimeframe
     }, {
       file: "pipeline.ts",
-      line: 101,
+      line: 105,
       scope: this,
       callSite: (f, a) => f(...a)
     });
@@ -488,7 +511,7 @@ var PipelineState = class {
             dependencies: import_timeframe2.Timeframe.dependencies(this.targetTimeframe, this.timeframe)
           }, {
             file: "pipeline.ts",
-            line: 127,
+            line: 131,
             scope: this,
             callSite: (f, a) => f(...a)
           });
@@ -514,7 +537,7 @@ var Pipeline = class {
     this._feedSetIterator.stalled.on((iterator) => {
       import_log3.log.warn(`Stalled after ${iterator.options.stallTimeout}ms with ${iterator.size} feeds.`, {}, {
         file: "pipeline.ts",
-        line: 203,
+        line: 207,
         scope: this,
         callSite: (f, a) => f(...a)
       });
@@ -549,14 +572,14 @@ var Pipeline = class {
   async start() {
     (0, import_log3.log)("starting...", {}, {
       file: "pipeline.ts",
-      line: 245,
+      line: 249,
       scope: this,
       callSite: (f, a) => f(...a)
     });
     await this._feedSetIterator.open();
     (0, import_log3.log)("started", {}, {
       file: "pipeline.ts",
-      line: 247,
+      line: 251,
       scope: this,
       callSite: (f, a) => f(...a)
     });
@@ -564,7 +587,7 @@ var Pipeline = class {
   async stop() {
     (0, import_log3.log)("stopping...", {}, {
       file: "pipeline.ts",
-      line: 252,
+      line: 256,
       scope: this,
       callSite: (f, a) => f(...a)
     });
@@ -572,7 +595,7 @@ var Pipeline = class {
     await this._processingTrigger.wait();
     (0, import_log3.log)("stopped", {}, {
       file: "pipeline.ts",
-      line: 255,
+      line: 259,
       scope: this,
       callSite: (f, a) => f(...a)
     });
@@ -586,9 +609,10 @@ var Pipeline = class {
     this._isOpen = true;
     for await (const block of this._feedSetIterator) {
       this._processingTrigger.reset();
+      this._timeframeClock.updatePendingTimeframe(import_keys.PublicKey.from(block.feedKey), block.seq);
       yield block;
       this._processingTrigger.wake();
-      this._timeframeClock.updateTimeframe(import_keys.PublicKey.from(block.feedKey), block.seq);
+      this._timeframeClock.updateTimeframe();
     }
     this._isOpen = false;
   }
@@ -1206,10 +1230,11 @@ var SpaceManager = class SpaceManager2 {
   }
   async open() {
     import_log8.log.trace("dxos.echo.space-manager", import_protocols4.trace.begin({
-      id: this._instanceId
+      id: this._instanceId,
+      parentId: this._traceParent
     }), {
       file: "space-manager.ts",
-      line: 65,
+      line: 66,
       scope: this,
       callSite: (f, a) => f(...a)
     });
@@ -1222,7 +1247,7 @@ var SpaceManager = class SpaceManager2 {
       id: this._instanceId
     }), {
       file: "space-manager.ts",
-      line: 71,
+      line: 72,
       scope: this,
       callSite: (f, a) => f(...a)
     });
@@ -1233,7 +1258,7 @@ var SpaceManager = class SpaceManager2 {
       spaceKey: metadata.genesisFeedKey
     }, {
       file: "space-manager.ts",
-      line: 75,
+      line: 76,
       scope: this,
       callSite: (f, a) => f(...a)
     });
@@ -1360,12 +1385,12 @@ var DataServiceHost = class {
       this._itemDemuxer.mutation.on(ctx, (message) => {
         var _a;
         const { batch, meta } = message;
-        (0, import_log9.log)("Object update", {
+        (0, import_log9.log)("message", {
           batch,
           meta
         }, {
           file: "data-service-host.ts",
-          line: 50,
+          line: 49,
           scope: this,
           callSite: (f, a) => f(...a)
         });
@@ -1389,36 +1414,59 @@ var DataServiceHost = class {
     });
   }
   async write(request) {
-    var _a;
+    var _a, _b, _c;
     (0, import_node_assert7.default)(this._writeStream, "Cannot write mutations in readonly mode");
-    const receipt = await this._writeStream.write({
+    (0, import_log9.log)("write", {
+      clientTag: request.clientTag,
+      objectCount: (_b = (_a = request.batch.objects) == null ? void 0 : _a.length) != null ? _b : 0
+    }, {
+      file: "data-service-host.ts",
+      line: 77,
+      scope: this,
+      callSite: (f, a) => f(...a)
+    });
+    const message = {
       batch: {
-        objects: (_a = request.batch.objects) == null ? void 0 : _a.map((object) => {
+        objects: (_c = request.batch.objects) == null ? void 0 : _c.map((object) => {
           var _a2;
           return {
             ...object,
-            mutations: (_a2 = object.mutations) == null ? void 0 : _a2.map((m) => ({
-              ...m,
+            mutations: (_a2 = object.mutations) == null ? void 0 : _a2.map((mutation) => ({
+              ...mutation,
               meta: void 0
             })),
             meta: void 0
           };
         })
       }
+    };
+    const receipt = await this._writeStream.write(message, {
+      afterWrite: async (receipt2) => {
+        if (request.clientTag) {
+          (0, import_log9.log)("tag", {
+            clientTag: request.clientTag,
+            feedKey: receipt2.feedKey,
+            seq: receipt2.seq
+          }, {
+            file: "data-service-host.ts",
+            line: 96,
+            scope: this,
+            callSite: (f, a) => f(...a)
+          });
+          this._clientTagMap.set([
+            receipt2.feedKey,
+            receipt2.seq
+          ], request.clientTag);
+        }
+      }
     });
-    if (request.clientTag) {
-      this._clientTagMap.set([
-        receipt.feedKey,
-        receipt.seq
-      ], request.clientTag);
-    }
     return receipt;
   }
 };
 
-// packages/core/echo/echo-pipeline/src/dbhost/database-backend.ts
+// packages/core/echo/echo-pipeline/src/dbhost/database-host.ts
 var import_echo_db2 = require("@dxos/echo-db");
-var DatabaseBackendHost = class {
+var DatabaseHost = class {
   constructor(_outboundStream, _snapshot) {
     this._outboundStream = _outboundStream;
     this._snapshot = _snapshot;
@@ -1627,7 +1675,8 @@ var DataPipeline = class DataPipeline2 {
     this._ctx = new import_context3.Context();
     this._lastAutomaticSnapshotTimeframe = new import_timeframe3.Timeframe();
     this._isOpen = false;
-    this.onTimeframeReached = new import_async8.Event();
+    this._lastTimeframeSaveTime = 0;
+    this._lastSnapshotSaveTime = 0;
   }
   get isOpen() {
     return this._isOpen;
@@ -1666,64 +1715,14 @@ var DataPipeline = class DataPipeline2 {
     const feedWriter = createMappedFeedWriter((data) => ({
       data
     }), (_c = this._pipeline.writer) != null ? _c : (0, import_debug6.failUndefined)());
-    this.databaseBackend = new DatabaseBackendHost(feedWriter, (_d = this._snapshot) == null ? void 0 : _d.database);
+    this.databaseBackend = new DatabaseHost(feedWriter, (_d = this._snapshot) == null ? void 0 : _d.database);
     this._itemManager = new import_echo_db3.ItemManager(this._params.modelFactory);
     await this.databaseBackend.open(this._itemManager, this._params.modelFactory);
     (0, import_async8.scheduleTask)(this._ctx, async () => {
       await this._consumePipeline();
     });
-    this._createPeriodicSnapshots();
     this._isOpen = true;
   }
-  _createPeriodicSnapshots() {
-    this.onTimeframeReached.debounce(TIMEFRAME_SAVE_DEBOUNCE_INTERVAL).on(this._ctx, async () => {
-      await this._saveLatestTimeframe();
-    });
-    if (!DISABLE_SNAPSHOT_CACHE) {
-      this.onTimeframeReached.debounce(AUTOMATIC_SNAPSHOT_DEBOUNCE_INTERVAL).on(this._ctx, async () => {
-        var _a, _b;
-        const latestTimeframe = (_a = this._pipeline) == null ? void 0 : _a.state.timeframe;
-        if (!latestTimeframe) {
-          return;
-        }
-        if (latestTimeframe.totalMessages() - this._lastAutomaticSnapshotTimeframe.totalMessages() > MESSAGES_PER_SNAPSHOT) {
-          const snapshot = await this._saveSnapshot();
-          this._lastAutomaticSnapshotTimeframe = (_b = snapshot.timeframe) != null ? _b : (0, import_debug6.failUndefined)();
-          (0, import_log11.log)("save", {
-            snapshot
-          }, {
-            file: "data-pipeline.ts",
-            line: 161,
-            scope: this,
-            callSite: (f, a) => f(...a)
-          });
-        }
-      });
-    }
-  }
-  async _saveSnapshot() {
-    const snapshot = await this.createSnapshot();
-    const snapshotKey = await this._params.snapshotManager.store(snapshot);
-    await this._params.metadataStore.setSpaceSnapshot(this._params.spaceKey, snapshotKey);
-    return snapshot;
-  }
-  async _saveLatestTimeframe() {
-    var _a, _b;
-    const latestTimeframe = (_a = this._pipeline) == null ? void 0 : _a.state.timeframe;
-    (0, import_log11.log)("save latest timeframe", {
-      latestTimeframe,
-      spaceKey: this._params.spaceKey
-    }, {
-      file: "data-pipeline.ts",
-      line: 176,
-      scope: this,
-      callSite: (f, a) => f(...a)
-    });
-    if (latestTimeframe) {
-      const newTimeframe = import_timeframe3.Timeframe.merge((_b = this._targetTimeframe) != null ? _b : new import_timeframe3.Timeframe(), latestTimeframe);
-      await this._params.metadataStore.setSpaceLatestTimeframe(this._params.spaceKey, newTimeframe);
-    }
-  }
   async close() {
     var _a, _b, _c;
     if (!this._isOpen) {
@@ -1731,37 +1730,32 @@ var DataPipeline = class DataPipeline2 {
     }
     (0, import_log11.log)("close", {}, {
       file: "data-pipeline.ts",
-      line: 188,
+      line: 145,
       scope: this,
       callSite: (f, a) => f(...a)
     });
     this._isOpen = false;
+    await this._ctx.dispose();
+    await ((_a = this._pipeline) == null ? void 0 : _a.stop());
     try {
-      await this._saveLatestTimeframe();
-      await this._saveSnapshot();
+      if (this._pipeline) {
+        await this._saveTargetTimeframe(this._pipeline.state.timeframe);
+        if (!DISABLE_SNAPSHOT_CACHE) {
+          await this._saveSnapshot(this._pipeline.state.timeframe);
+        }
+      }
     } catch (err) {
       import_log11.log.catch(err, {}, {
         file: "data-pipeline.ts",
-        line: 195,
+        line: 160,
         scope: this,
         callSite: (f, a) => f(...a)
       });
     }
-    await this._ctx.dispose();
-    await ((_a = this._pipeline) == null ? void 0 : _a.stop());
     await ((_b = this.databaseBackend) == null ? void 0 : _b.close());
     await ((_c = this._itemManager) == null ? void 0 : _c.destroy());
     await this._params.snapshotManager.close();
   }
-  createSnapshot() {
-    var _a, _b;
-    (0, import_node_assert9.default)(this.databaseBackend, "Database backend is not initialized.");
-    return {
-      spaceKey: this._params.spaceKey.asUint8Array(),
-      timeframe: (_b = (_a = this._pipeline) == null ? void 0 : _a.state.timeframe) != null ? _b : new import_timeframe3.Timeframe(),
-      database: this.databaseBackend.createSnapshot()
-    };
-  }
   async _consumePipeline() {
     (0, import_node_assert9.default)(this._pipeline, "Pipeline is not initialized.");
     for await (const msg of this._pipeline.consume()) {
@@ -1770,7 +1764,7 @@ var DataPipeline = class DataPipeline2 {
         msg
       }, {
         file: "data-pipeline.ts",
-        line: 217,
+        line: 172,
         scope: this,
         callSite: (f, a) => f(...a)
       });
@@ -1782,7 +1776,7 @@ var DataPipeline = class DataPipeline2 {
               feedKey
             }, {
               file: "data-pipeline.ts",
-              line: 223,
+              line: 178,
               scope: this,
               callSite: (f, a) => f(...a)
             });
@@ -1797,18 +1791,58 @@ var DataPipeline = class DataPipeline2 {
               memberKey: feedInfo.assertion.identityKey
             }
           });
-          this.onTimeframeReached.emit(data.timeframe);
+          await this._noteTargetStateIfNeeded(this._pipeline.state.pendingTimeframe);
         }
       } catch (err) {
         import_log11.log.catch(err, {}, {
           file: "data-pipeline.ts",
-          line: 239,
+          line: 196,
           scope: this,
           callSite: (f, a) => f(...a)
         });
       }
     }
   }
+  _createSnapshot(timeframe) {
+    (0, import_node_assert9.default)(this.databaseBackend, "Database backend is not initialized.");
+    return {
+      spaceKey: this._params.spaceKey.asUint8Array(),
+      timeframe,
+      database: this.databaseBackend.createSnapshot()
+    };
+  }
+  async _saveSnapshot(timeframe) {
+    const snapshot = await this._createSnapshot(timeframe);
+    const snapshotKey = await this._params.snapshotManager.store(snapshot);
+    await this._params.metadataStore.setSpaceSnapshot(this._params.spaceKey, snapshotKey);
+    return snapshot;
+  }
+  async _saveTargetTimeframe(timeframe) {
+    var _a;
+    const newTimeframe = import_timeframe3.Timeframe.merge((_a = this._targetTimeframe) != null ? _a : new import_timeframe3.Timeframe(), timeframe);
+    await this._params.metadataStore.setSpaceLatestTimeframe(this._params.spaceKey, newTimeframe);
+    this._targetTimeframe = newTimeframe;
+  }
+  async _noteTargetStateIfNeeded(timeframe) {
+    var _a;
+    if (Date.now() - this._lastTimeframeSaveTime > TIMEFRAME_SAVE_DEBOUNCE_INTERVAL) {
+      this._lastTimeframeSaveTime = Date.now();
+      await this._saveTargetTimeframe(timeframe);
+    }
+    if (!DISABLE_SNAPSHOT_CACHE && Date.now() - this._lastSnapshotSaveTime > AUTOMATIC_SNAPSHOT_DEBOUNCE_INTERVAL && timeframe.totalMessages() - this._lastAutomaticSnapshotTimeframe.totalMessages() > MESSAGES_PER_SNAPSHOT) {
+      this._lastSnapshotSaveTime = Date.now();
+      const snapshot = await this._saveSnapshot(timeframe);
+      this._lastAutomaticSnapshotTimeframe = (_a = snapshot.timeframe) != null ? _a : (0, import_debug6.failUndefined)();
+      (0, import_log11.log)("save", {
+        snapshot
+      }, {
+        file: "data-pipeline.ts",
+        line: 239,
+        scope: this,
+        callSite: (f, a) => f(...a)
+      });
+    }
+  }
   async waitUntilTimeframe(timeframe) {
     (0, import_node_assert9.default)(this._pipeline, "Pipeline is not initialized.");
     await this._pipeline.state.waitUntilTimeframe(timeframe);
@@ -1838,7 +1872,7 @@ var snapshotTimeframeToStartingTimeframe = (snapshotTimeframe) => {
   DataServiceHost,
   DataServiceImpl,
   DataServiceSubscriptions,
-  DatabaseBackendHost,
+  DatabaseHost,
   EntityNotFoundError,
   IdentityNotInitializedError,
   InvalidInvitationError,