document-drive 1.9.0 → 1.10.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "document-drive",
-  "version": "1.9.0",
+  "version": "1.10.0",
   "license": "AGPL-3.0-only",
   "type": "module",
   "module": "./src/index.ts",
@@ -35,7 +35,7 @@
     "uuid": "^9.0.1",
     "@powerhousedao/scalars": "1.13.0",
     "document-model": "2.11.0",
-    "document-model-libs": "1.121.0"
+    "document-model-libs": "1.121.1"
   },
   "optionalDependencies": {
     "@prisma/client": "^5.18.0",
@@ -67,7 +67,7 @@
     "sanitize-filename": "^1.6.3",
     "uuid": "^9.0.1",
     "document-model": "2.11.0",
-    "document-model-libs": "1.121.0"
+    "document-model-libs": "1.121.1"
   },
   "scripts": {
     "check-types": "tsc --build",

package/src/server/index.ts

@@ -100,7 +100,7 @@ import {
   type SignalResult,
   type SynchronizationUnit,
 } from "./types";
-import { filterOperationsByRevision } from "./utils";
+import { filterOperationsByRevision, isAtRevision } from "./utils";
 
 export * from "./listener";
 export type * from "./types";
@@ -1000,21 +1000,27 @@ export class BaseDocumentDriveServer
   }
 
   async getDrive(drive: string, options?: GetDocumentOptions) {
+    let document: DocumentDriveDocument | undefined;
     try {
-      const document = await this.cache.getDocument("drives", drive); // TODO support GetDocumentOptions
-      if (document && isDocumentDrive(document)) {
-        return document;
+      const cachedDocument = await this.cache.getDocument("drives", drive); // TODO support GetDocumentOptions
+      if (cachedDocument && isDocumentDrive(cachedDocument)) {
+        document = cachedDocument;
+        if (isAtRevision(document, options?.revisions)) {
+          return document;
+        }
       }
     } catch (e) {
       logger.error("Error getting drive from cache", e);
     }
-    const driveStorage = await this.storage.getDrive(drive);
-    const document = this._buildDocument(driveStorage, options);
-    if (!isDocumentDrive(document)) {
+    const driveStorage = document ?? (await this.storage.getDrive(drive));
+    const result = this._buildDocument(driveStorage, options);
+    if (!isDocumentDrive(result)) {
       throw new Error(`Document with id ${drive} is not a Document Drive`);
     } else {
-      this.cache.setDocument("drives", drive, document).catch(logger.error);
-      return document;
+      if (!options?.revisions) {
+        this.cache.setDocument("drives", drive, result).catch(logger.error);
+      }
+      return result;
     }
   }
 
@@ -1039,18 +1045,22 @@ export class BaseDocumentDriveServer
   }
 
   async getDocument(drive: string, id: string, options?: GetDocumentOptions) {
+    let cachedDocument: Document | undefined;
     try {
-      const document = await this.cache.getDocument(drive, id); // TODO support GetDocumentOptions
-      if (document) {
-        return document;
+      cachedDocument = await this.cache.getDocument(drive, id); // TODO support GetDocumentOptions
+      if (cachedDocument && isAtRevision(cachedDocument, options?.revisions)) {
+        return cachedDocument;
       }
     } catch (e) {
       logger.error("Error getting document from cache", e);
     }
-    const documentStorage = await this.storage.getDocument(drive, id);
+    const documentStorage =
+      cachedDocument ?? (await this.storage.getDocument(drive, id));
     const document = this._buildDocument(documentStorage, options);
 
-    this.cache.setDocument(drive, id, document).catch(logger.error);
+    if (!options?.revisions) {
+      this.cache.setDocument(drive, id, document).catch(logger.error);
+    }
     return document;
   }
 
@@ -1293,7 +1303,11 @@ export class BaseDocumentDriveServer
     documentStorage: DocumentStorage<T>,
     options?: GetDocumentOptions,
   ): T {
-    if (documentStorage.state && (!options || options.checkHashes === false)) {
+    if (
+      documentStorage.state &&
+      (!options || options.checkHashes === false) &&
+      isAtRevision(documentStorage as unknown as Document, options?.revisions)
+    ) {
       return documentStorage as T;
     }
 

package/src/server/listener/transmitter/internal.ts

@@ -1,6 +1,7 @@
 import { Document, Operation, OperationScope } from "document-model/document";
 import { logger } from "../../../utils/logger";
 import {
+  GetDocumentOptions,
   IBaseDocumentDriveServer,
   Listener,
   ListenerRevision,
@@ -59,16 +60,21 @@ export class InternalTransmitter implements ITransmitter {
       if (state) {
         return state;
       }
-      const document = await this.drive.getDocument(
-        strand.driveId,
-        strand.documentId,
-        {
-          revisions: {
-            [strand.scope]: index,
-          },
-          checkHashes: false,
+
+      const getDocumentOptions: GetDocumentOptions = {
+        revisions: {
+          [strand.scope]: index,
         },
-      );
+        checkHashes: false,
+      };
+      const document = await (strand.documentId
+        ? this.drive.getDocument(
+            strand.driveId,
+            strand.documentId,
+            getDocumentOptions,
+          )
+        : this.drive.getDrive(strand.driveId, getDocumentOptions));
+
       if (index < 0) {
         stateByIndex.set(index, document.initialState.state[strand.scope]);
       } else {

package/src/server/utils.ts

@@ -15,6 +15,18 @@ export function buildRevisionsFilter(
   }, {});
 }
 
+export function buildDocumentRevisionsFilter(
+  document: Document,
+): RevisionsFilter {
+  return Object.entries(document.operations).reduce<RevisionsFilter>(
+    (acc, [scope, operations]) => {
+      acc[scope as OperationScope] = operations.at(-1)?.index ?? -1;
+      return acc;
+    },
+    {} as RevisionsFilter,
+  );
+}
+
 export function filterOperationsByRevision(
   operations: Document["operations"],
   revisions?: RevisionsFilter,
@@ -24,11 +36,47 @@ export function filterOperationsByRevision(
   }
   return (Object.keys(operations) as OperationScope[]).reduce<
     Document["operations"]
-  >((acc, scope) => {
-    const revision = revisions[scope];
-    if (revision !== undefined) {
-      acc[scope] = operations[scope].filter((op) => op.index <= revision);
-    }
-    return acc;
-  }, operations);
+  >(
+    (acc, scope) => {
+      const revision = revisions[scope];
+      if (revision !== undefined) {
+        acc[scope] = operations[scope].filter((op) => op.index <= revision);
+      }
+      return acc;
+    },
+    { global: [], local: [] } as unknown as Document["operations"],
+  );
+}
+
+export function isAtRevision(
+  document: Document,
+  revisions?: RevisionsFilter,
+): boolean {
+  return (
+    !revisions ||
+    Object.entries(revisions).find(([scope, revision]) => {
+      const operation = document.operations[scope as OperationScope].at(-1);
+      if (revision === -1) {
+        return operation !== undefined;
+      }
+      return operation?.index !== revision;
+    }) === undefined
+  );
+}
+
+export function isAfterRevision(
+  document: Document,
+  revisions?: RevisionsFilter,
+): boolean {
+  return (
+    !revisions ||
+    Object.entries(revisions).every(([scope, revision]) => {
+      const operation = document.operations[scope as OperationScope].at(-1);
+
+      if (revision === -1) {
+        return operation !== undefined;
+      }
+      return operation && operation.index > revision;
+    })
+  );
 }