document-drive 5.0.0-staging.9 → 5.0.1-staging.2

package/dist/src/server/base-server.js

@@ -1,19 +1,8 @@
-import { removeListener, removeTrigger, setSharingType, } from "#drive-document-model/gen/creators";
-import { createDocumentDriveDocument } from "#drive-document-model/gen/ph-factories";
-import { isActionJob, isDocumentJob, isOperationJob, } from "#queue/types";
-import { ReadModeServer } from "#read-mode/server";
-import { DefaultDrivesManager, } from "#utils/default-drives-manager";
-import { requestPublicDriveWithTokenFromReactor } from "#utils/graphql";
-import { isDocumentDrive, runAsapAsync } from "#utils/misc";
-import { RunAsap } from "#utils/run-asap";
-import { DocumentAlreadyExistsError, childLogger, } from "document-drive";
-import { attachBranch, createPresignedHeader, garbageCollect, garbageCollectDocumentOperations, groupOperationsByScope, merge, precedes, removeExistingOperations, replayDocument, reshuffleByTimestamp, skipHeaderOperations, sortOperations, validateHeader, } from "document-model";
+import { ConflictOperationError, DefaultDrivesManager, DefaultListenerManagerOptions, DocumentAlreadyExistsError, OperationError, PullResponderTransmitter, ReadModeServer, SwitchboardPushTransmitter, childLogger, driveCreateDocument, driveCreateState, filterOperationsByRevision, isActionJob, isAtRevision, isDocumentDrive, isDocumentJob, isOperationJob, removeListener, removeTrigger, requestPublicDriveWithTokenFromReactor, resolveCreateDocumentInput, setSharingType, } from "document-drive";
+import { runAsap, runAsapAsync } from "document-drive/run-asap";
+import {} from "document-model";
+import { attachBranch, createPresignedHeader, defaultBaseState, garbageCollect, garbageCollectDocumentOperations, groupOperationsByScope, hashDocumentStateForScope, merge, precedes, removeExistingOperations, replayDocument, reshuffleByTimestamp, skipHeaderOperations, sortOperations, validateHeader, } from "document-model/core";
 import { ClientError } from "graphql-request";
-import { ConflictOperationError, OperationError, } from "./error.js";
-import { PullResponderTransmitter, } from "./listener/transmitter/pull-responder.js";
-import { SwitchboardPushTransmitter } from "./listener/transmitter/switchboard-push.js";
-import { DefaultListenerManagerOptions, } from "./types.js";
-import { filterOperationsByRevision, isAtRevision, resolveCreateDocumentInput, } from "./utils.js";
 export class BaseDocumentDriveServer {
     logger = childLogger(["BaseDocumentDriveServer"]);
     // external dependencies
@@ -96,6 +85,7 @@ export class BaseDocumentDriveServer {
     // internal state
     triggerMap = new Map();
     initializePromise;
+    enableDualActionCreate;
     constructor(documentModelModules, storage, documentStorage, cache, queueManager, eventEmitter, synchronizationManager, listenerManager, options) {
         this.documentModelModules = documentModelModules;
         this.legacyStorage = storage;
@@ -118,9 +108,17 @@ export class BaseDocumentDriveServer {
                 ? () => Promise.resolve("")
                 : options.jwtHandler,
             taskQueueMethod: options?.taskQueueMethod === undefined
-                ? RunAsap.runAsap
+                ? runAsap
                 : options.taskQueueMethod,
+            featureFlags: {
+                ...options?.featureFlags,
+            },
         };
+        this.enableDualActionCreate =
+            options?.featureFlags?.enableDualActionCreate ?? false;
+        if (this.enableDualActionCreate) {
+            this.logger.warn("Dual action create is enabled.");
+        }
         // todo: move to external dependencies
         this.defaultDrivesManager = new DefaultDrivesManager(this, this.defaultDrivesManagerDelegate, options);
         this.initializePromise = this._initialize();
@@ -137,7 +135,7 @@ export class BaseDocumentDriveServer {
         await this.listenerManager.initialize(this.handleListenerError.bind(this));
         await this.queueManager.init(this.queueDelegate, (error) => {
             this.logger.error(`Error initializing queue manager`, error);
-            errors.push(error);
+            // errors.push(error);
         });
         try {
             await this.defaultDrivesManager.removeOldremoteDrives();
@@ -329,7 +327,7 @@ export class BaseDocumentDriveServer {
         }
     }
     getDocumentModelModule(documentType) {
-        const documentModelModule = this.documentModelModules.find((module) => module.documentModel.id === documentType);
+        const documentModelModule = this.documentModelModules.find((module) => module.documentModel.global.id === documentType);
         if (!documentModelModule) {
             throw new Error(`Document type ${documentType} not supported`);
         }
@@ -346,9 +344,19 @@ export class BaseDocumentDriveServer {
     }
     async addDrive(input, preferredEditor) {
         // Create document with custom global and local state
-        const document = createDocumentDriveDocument({
-            global: input.global,
-            local: input.local,
+        const { global } = driveCreateState();
+        const document = driveCreateDocument({
+            global: {
+                ...global,
+                name: input.global.name ?? global.name,
+                icon: input.global.icon ?? global.icon,
+            },
+            local: {
+                availableOffline: input.local?.availableOffline ?? false,
+                sharingType: input.local?.sharingType ?? "public",
+                listeners: input.local?.listeners ?? [],
+                triggers: input.local?.triggers ?? [],
+            },
         });
         if (input.id && input.id.length > 0) {
             document.header.id = input.id;
@@ -546,6 +554,14 @@ export class BaseDocumentDriveServer {
         }
     }
     async createDocument(input, source, meta) {
+        if (this.enableDualActionCreate) {
+            return this.createDocumentDualAction(input, source, meta);
+        }
+        else {
+            return this.createDocumentLegacy(input, source, meta);
+        }
+    }
+    async createDocumentLegacy(input, source, meta) {
         const { documentType, document: inputDocument } = resolveCreateDocumentInput(input);
         // if a document was provided then checks if it's valid
         let state = undefined;
@@ -608,11 +624,9 @@ export class BaseDocumentDriveServer {
         // stores document information
         const documentStorage = {
             header,
-            history: document.history,
             operations: { global: [], local: [] },
             initialState: document.initialState,
             clipboard: [],
-            attachments: document.attachments,
             state: state ?? document.state,
         };
         await this.documentStorage.create(documentStorage);
@@ -647,6 +661,180 @@ export class BaseDocumentDriveServer {
         }
         return await this.getDocument(documentStorage.header.id);
     }
+    async createDocumentDualAction(input, source, meta) {
+        const { documentType, document: inputDocument } = resolveCreateDocumentInput(input);
+        // if a document was provided then checks if it's valid
+        let state = undefined;
+        if (inputDocument) {
+            if ("documentType" in input &&
+                documentType !== inputDocument.header.documentType) {
+                throw new Error(`Provided document is not ${documentType}`);
+            }
+            const doc = this._buildDocument(inputDocument);
+            state = doc.state;
+        }
+        // if no document was provided then create a new one
+        const document = inputDocument ??
+            this.getDocumentModelModule(documentType).utils.createDocument(state);
+        // get the header
+        let header;
+        // handle the legacy case where an id is provided
+        let isSigned = false;
+        if ("id" in input && input.id) {
+            if (inputDocument) {
+                header = document.header;
+                document.header.id = input.id;
+                this.logger.warn("Assigning an id to a document is deprecated. Use the header field instead.");
+            }
+            else {
+                this.logger.warn("Creating a document with an id is deprecated. Use the header field instead.");
+                header = createPresignedHeader(input.id, documentType);
+            }
+        }
+        else if ("header" in input) {
+            // validate the header passed in
+            await validateHeader(input.header);
+            isSigned = true;
+            header = input.header;
+        }
+        else if (inputDocument?.header) {
+            if (!inputDocument.header.id) {
+                throw new Error("Document header id is required");
+            }
+            if (!inputDocument.header.documentType) {
+                throw new Error("Document header documentType is required");
+            }
+            if (!inputDocument.header.createdAtUtcIso) {
+                throw new Error("Document header createdAtUtcIso is required");
+            }
+            if (!inputDocument.header.sig.nonce) {
+                this.logger.warn("Creating a document with an unsigned id is deprecated. Use createSignedHeaderForSigner.");
+                // throw new Error("Document header sig nonce is required"); TODO: uncomment when ready to enforce signed documents
+            }
+            else {
+                await validateHeader(inputDocument.header);
+                isSigned = true;
+            }
+            header = inputDocument.header;
+        }
+        else {
+            // otherwise, generate a header
+            header = createPresignedHeader(undefined, documentType);
+            isSigned = false;
+        }
+        if (meta) {
+            header.meta = { ...header.meta, ...meta };
+        }
+        const currentVersion = "0.1.0";
+        // Get initial state from input or model's defaultState
+        const initialState = state ?? document.state;
+        // Check if the input document already has operations
+        const existingOperations = Object.values(document.operations).flat();
+        const shouldCreateOperations = existingOperations.length === 0;
+        let operations = [];
+        if (shouldCreateOperations) {
+            const timestampUtcMs = new Date().toISOString();
+            // Determine if this is a signed document
+            const signing = isSigned
+                ? {
+                    signature: header.id, // The document ID is the signature
+                    publicKey: header.sig.publicKey,
+                    nonce: header.sig.nonce,
+                    createdAtUtcIso: header.createdAtUtcIso,
+                    documentType: header.documentType,
+                }
+                : undefined;
+            // Create actions for CREATE_DOCUMENT and UPGRADE_DOCUMENT
+            const createDocumentInput = {
+                model: documentType,
+                version: "0.0.0",
+                documentId: header.id,
+                signing,
+            };
+            const createDocumentAction = {
+                id: `${header.id}-create`,
+                type: "CREATE_DOCUMENT",
+                timestampUtcMs,
+                input: createDocumentInput,
+                scope: "document",
+            };
+            const upgradeDocumentInput = {
+                model: documentType,
+                fromVersion: "0.0.0",
+                toVersion: currentVersion,
+                documentId: header.id,
+                initialState,
+            };
+            const upgradeDocumentAction = {
+                id: `${header.id}-upgrade`,
+                type: "UPGRADE_DOCUMENT",
+                timestampUtcMs,
+                input: upgradeDocumentInput,
+                scope: "document",
+            };
+            // we need to create hashes for later verification
+            const baseState = defaultBaseState();
+            const createStateForHash = {
+                state: baseState,
+            };
+            const createHash = hashDocumentStateForScope(createStateForHash, "document");
+            const upgradeStateForHash = {
+                state: initialState,
+            };
+            const upgradeHash = hashDocumentStateForScope(upgradeStateForHash, "document");
+            // Create operations from actions with computed hashes
+            operations = [
+                {
+                    index: 0,
+                    skip: 0,
+                    hash: createHash,
+                    timestampUtcMs,
+                    action: createDocumentAction,
+                },
+                {
+                    index: 1,
+                    skip: 0,
+                    hash: upgradeHash,
+                    timestampUtcMs,
+                    action: upgradeDocumentAction,
+                },
+            ];
+        }
+        else {
+            // Use existing operations from the input document
+            operations = existingOperations;
+        }
+        // Group operations by scope before storing
+        const groupedOps = groupOperationsByScope(operations);
+        // Ensure backward compatibility by initializing missing scopes
+        if (!groupedOps.header) {
+            groupedOps.header = [];
+        }
+        if (!groupedOps.document) {
+            groupedOps.document = [];
+        }
+        if (!groupedOps.global) {
+            groupedOps.global = [];
+        }
+        if (!groupedOps.local) {
+            groupedOps.local = [];
+        }
+        // After initialization, it's safe to treat as DocumentOperations
+        const operationsByScope = groupedOps;
+        // stores document information with operations
+        const documentToStore = {
+            header,
+            operations: operationsByScope,
+            initialState,
+            clipboard: [],
+            state: initialState,
+        };
+        await this.documentStorage.create(documentToStore);
+        // Force rebuild to ensure operations are properly merged
+        return await this.getDocument(documentToStore.header.id, {
+            checkHashes: true,
+        });
+    }
     async deleteDocument(documentId) {
         try {
             const syncUnits = await this.synchronizationManager.getSynchronizationUnitsIds(undefined, [documentId]);
@@ -675,7 +863,7 @@ export class BaseDocumentDriveServer {
         let error; // TODO: replace with an array of errors/consistency issues
         const operationsByScope = groupOperationsByScope(operations);
         for (const scope of Object.keys(operationsByScope)) {
-            const storageDocumentOperations = documentStorage.operations[scope];
+            const storageDocumentOperations = documentStorage.operations[scope] || [];
             // TODO two equal operations done by two clients will be considered the same, ie: { type: "INCREMENT" }
             const branch = removeExistingOperations(operationsByScope[scope] || [], storageDocumentOperations);
             // No operations to apply
@@ -735,7 +923,11 @@ export class BaseDocumentDriveServer {
             : document.operations;
         const documentOperations = garbageCollectDocumentOperations(operations);
         for (const scope of Object.keys(documentOperations)) {
-            const lastRemainingOperation = documentOperations[scope].at(-1);
+            const scopeOps = documentOperations[scope];
+            if (!scopeOps) {
+                continue;
+            }
+            const lastRemainingOperation = scopeOps.at(-1);
             // if the latest operation doesn't have a resulting state then tries
             // to retrieve it from the db to avoid rerunning all the operations
             if (lastRemainingOperation && !lastRemainingOperation.resultingState) {
@@ -760,22 +952,74 @@ export class BaseDocumentDriveServer {
             ? filterOperationsByRevision(documentStorage.operations, options.revisions)
             : documentStorage.operations;
         const operations = garbageCollectDocumentOperations(revisionOperations);
-        return replayDocument(documentStorage.initialState, operations, documentModelModule.reducer, undefined, documentStorage.header, undefined, {
+        // Get all scopes from operations
+        const allScopes = Object.keys(operations);
+        // Initialize with all scopes found in operations, plus global and local for backward compatibility
+        const scopesToInitialize = new Set([...allScopes, "global", "local"]);
+        const headerOperations = {};
+        const operationsToReplay = {};
+        for (const scope of scopesToInitialize) {
+            headerOperations[scope] = [];
+            operationsToReplay[scope] = [];
+        }
+        // Filter out CREATE_DOCUMENT and UPGRADE_DOCUMENT operations
+        // (these don't currently have reducers and should not be replayed)
+        for (const [scope, scopeOps] of Object.entries(operations)) {
+            if (!scopeOps) {
+                continue;
+            }
+            for (const op of scopeOps) {
+                if (op.action.type === "CREATE_DOCUMENT" ||
+                    op.action.type === "UPGRADE_DOCUMENT") {
+                    const headerOps = headerOperations[scope];
+                    if (headerOps) {
+                        headerOps.push(op);
+                    }
+                }
+                else {
+                    const replayOps = operationsToReplay[scope];
+                    if (replayOps) {
+                        replayOps.push(op);
+                    }
+                }
+            }
+        }
+        const replayed = replayDocument(documentStorage.initialState, operationsToReplay, documentModelModule.reducer, undefined, documentStorage.header, undefined, {
             ...options,
             checkHashes: options?.checkHashes ?? true,
             reuseOperationResultingState: options?.checkHashes ?? true,
         });
+        // merge header operations back into the result
+        // Include ALL scopes from input operations, header operations, and replayed operations
+        const allScopesForMerge = new Set([
+            ...Object.keys(operations), // From input storage
+            ...Object.keys(headerOperations),
+            ...Object.keys(replayed.operations),
+        ]);
+        const finalOperations = {};
+        for (const scope of allScopesForMerge) {
+            finalOperations[scope] = [
+                ...(headerOperations[scope] || []),
+                ...(replayed.operations[scope] || []),
+            ];
+        }
+        return {
+            ...replayed,
+            operations: finalOperations,
+        };
     }
     async _performOperation(documentId, document, operation, skipHashValidation = false) {
         const documentModelModule = this.getDocumentModelModule(document.header.documentType);
         const signalResults = [];
         let newDocument = document;
         const scope = operation.action.scope;
+        const currentScopeOperations = document.operations[scope] || [];
         const documentOperations = garbageCollectDocumentOperations({
             ...document.operations,
-            [scope]: skipHeaderOperations(document.operations[scope], operation),
+            [scope]: skipHeaderOperations(currentScopeOperations, operation),
         });
-        const lastRemainingOperation = documentOperations[scope].at(-1);
+        const remainingScopeOps = documentOperations[scope];
+        const lastRemainingOperation = remainingScopeOps?.at(-1);
         // if the latest operation doesn't have a resulting state then tries
         // to retrieve it from the db to avoid rerunning all the operations
         if (lastRemainingOperation && !lastRemainingOperation.resultingState) {
@@ -805,7 +1049,11 @@ export class BaseDocumentDriveServer {
             reuseOperationResultingState: true,
             replayOptions: { operation },
         });
-        const appliedOperations = newDocument.operations[operation.action.scope].filter((op) => op.index == operation.index && op.skip == operation.skip);
+        const newDocScopeOperations = newDocument.operations[operation.action.scope];
+        if (!newDocScopeOperations) {
+            throw new OperationError("ERROR", operation, `No operations found for scope: ${operation.action.scope}`);
+        }
+        const appliedOperations = newDocScopeOperations.filter((op) => op.index == operation.index && op.skip == operation.skip);
         const appliedOperation = appliedOperations.at(0);
         if (!appliedOperation) {
             throw new OperationError("ERROR", operation, `Operation with index ${operation.index}:${operation.skip} was not applied.`);
@@ -924,11 +1172,19 @@ export class BaseDocumentDriveServer {
     async resultIfExistingOperations(id, operations) {
         try {
             const document = await this.getDocument(id);
-            const newOperation = operations.find((op) => !op.id ||
-                !document.operations[op.action.scope].find((existingOp) => existingOp.id === op.id &&
+            const newOperation = operations.find((op) => {
+                if (!op.id) {
+                    return true;
+                }
+                const scopeOps = document.operations[op.action.scope];
+                if (!scopeOps) {
+                    return true;
+                }
+                return !scopeOps.find((existingOp) => existingOp.id === op.id &&
                     existingOp.index === op.index &&
                     existingOp.action.type === op.action.type &&
-                    existingOp.hash === op.hash));
+                    existingOp.hash === op.hash);
+            });
             if (!newOperation) {
                 return {
                     status: "SUCCESS",
@@ -1280,11 +1536,19 @@ export class BaseDocumentDriveServer {
     async resultIfExistingDriveOperations(driveId, operations) {
         try {
             const drive = await this.getDrive(driveId);
-            const newOperation = operations.find((op) => !op.id ||
-                !drive.operations[op.action.scope].find((existingOp) => existingOp.id === op.id &&
+            const newOperation = operations.find((op) => {
+                if (!op.id) {
+                    return true;
+                }
+                const scopeOps = drive.operations[op.action.scope];
+                if (!scopeOps) {
+                    return true;
+                }
+                return !scopeOps.find((existingOp) => existingOp.id === op.id &&
                     existingOp.index === op.index &&
                     existingOp.action.type === op.action.type &&
-                    existingOp.hash === op.hash));
+                    existingOp.hash === op.hash);
+            });
             if (!newOperation) {
                 return {
                     status: "SUCCESS",
@@ -1457,7 +1721,11 @@ export class BaseDocumentDriveServer {
         const { reducer } = this.getDocumentModelModule(documentId.header.documentType);
         for (const action of actions) {
             documentId = reducer(documentId, action);
-            const operation = documentId.operations[action.scope].slice().pop();
+            const scopeOps = documentId.operations[action.scope];
+            if (!scopeOps) {
+                throw new Error(`No operations found for scope: ${action.scope}`);
+            }
+            const operation = scopeOps.slice().pop();
             if (!operation) {
                 throw new Error("Error creating operations");
             }