document-drive 1.0.0-alpha.57 → 1.0.0-alpha.59

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "document-drive",
-    "version": "1.0.0-alpha.57",
+    "version": "1.0.0-alpha.59",
     "license": "AGPL-3.0-only",
     "type": "module",
     "module": "./src/index.ts",

package/src/queue/base.ts

@@ -10,7 +10,6 @@ export class MemoryQueue<T, R> implements IQueue<T, R> {
     private blocked = false;
     private deleted = false;
     private items: IJob<T>[] = [];
-    private results = new Map<JobId, R>();
     private dependencies = new Array<IJob<OperationJob>>();
 
     constructor(id: string) {
@@ -25,15 +24,6 @@ export class MemoryQueue<T, R> implements IQueue<T, R> {
         return this.deleted;
     }
 
-    async setResult(jobId: string, result: R): Promise<void> {
-        this.results.set(jobId, result);
-        return Promise.resolve();
-    }
-
-    async getResult(jobId: string): Promise<R | undefined> {
-        return Promise.resolve(this.results.get(jobId));
-    }
-
     async addJob(data: IJob<T>) {
         this.items.push(data);
         return Promise.resolve();
@@ -157,11 +147,6 @@ export class BaseQueueManager implements IQueueManager {
         return jobId;
     }
 
-    async getResult(driveId: string, documentId: string, jobId: JobId): Promise<IOperationResult | undefined> {
-        const queue = this.getQueue(driveId, documentId);
-        return queue.getResult(jobId);
-    }
-
     getQueue(driveId: string, documentId?: string) {
         const queueId = this.getQueueId(driveId, documentId);
         let queue = this.queues.find((q) => q.getId() === queueId);
@@ -237,7 +222,6 @@ export class BaseQueueManager implements IQueueManager {
 
         try {
             const result = await this.delegate.processOperationJob(nextJob);
-            await queue.setResult(nextJob.jobId, result);
 
             // unblock the document queues of each add_file operation
             const addFileOperations = nextJob.operations.filter((op) => op.type === "ADD_FILE");

package/src/queue/redis.ts

@@ -13,17 +13,6 @@ export class RedisQueue<T, R> implements IQueue<T, R> {
 
     }
 
-    async setResult(jobId: string, result: any): Promise<void> {
-        await this.client.hSet(this.id + "-results", jobId, JSON.stringify(result));
-    }
-    async getResult(jobId: string): Promise<any> {
-        const results = await this.client.hGet(this.id + "-results", jobId);
-        if (!results) {
-            return null;
-        }
-        return JSON.parse(results);
-    }
-
     async addJob(data: any) {
         await this.client.lPush(this.id + "-jobs", JSON.stringify(data));
     }

package/src/queue/types.ts

@@ -23,7 +23,6 @@ export interface IServerDelegate {
 
 export interface IQueueManager {
     addJob(job: OperationJob): Promise<JobId>;
-    getResult(driveId: string, documentId: string, jobId: JobId): Promise<IOperationResult | undefined>;
     getQueue(driveId: string, document?: string): IQueue<OperationJob, IOperationResult>;
     removeQueue(driveId: string, documentId?: string): void;
     getQueueByIndex(index: number): IQueue<OperationJob, IOperationResult> | null;
@@ -47,8 +46,6 @@ export interface IQueue<T, R> {
     isBlocked(): Promise<boolean>;
     isDeleted(): Promise<boolean>;
     setDeleted(deleted: boolean): Promise<void>;
-    setResult(jobId: JobId, result: R): Promise<void>;
-    getResult(jobId: JobId): Promise<R | undefined>;
     getJobs(): Promise<IJob<T>[]>;
     addDependencies(job: IJob<OperationJob>): Promise<void>;
     removeDependencies(job: IJob<OperationJob>): Promise<void>;

package/src/server/index.ts

@@ -425,7 +425,8 @@ export class DocumentDriveServer extends BaseDocumentDriveServer {
             type: operation.type,
             input: operation.input as object,
             skip: operation.skip,
-            context: operation.context
+            context: operation.context,
+            id: operation.id
         }));
     }
 

package/src/server/listener/transmitter/pull-responder.ts

@@ -1,4 +1,4 @@
-import { ListenerFilter, Trigger, z } from 'document-model-libs/document-drive';
+import { ListenerFilter, Trigger } from 'document-model-libs/document-drive';
 import { Operation, OperationScope } from 'document-model/document';
 import { PULL_DRIVE_INTERVAL } from '../..';
 import { generateUUID } from '../../../utils';
@@ -153,6 +153,7 @@ export class PullResponderTransmitter implements IPullResponderTransmitter {
                                 scope
                                 branch
                                 operations {
+                                    id
                                     timestamp
                                     skip
                                     type
@@ -237,13 +238,11 @@ export class PullResponderTransmitter implements IPullResponderTransmitter {
             const listenerRevisions: ListenerRevisionWithError[] = [];
 
             for (const strand of strands) {
-                const operations: Operation[] = strand.operations.map(
-                    (op) => ({
-                        ...op,
-                        scope: strand.scope,
-                        branch: strand.branch
-                    })
-                );
+                const operations: Operation[] = strand.operations.map(op => ({
+                    ...op,
+                    scope: strand.scope,
+                    branch: strand.branch
+                }));
 
                 let error: Error | undefined = undefined;
                 try {

package/src/server/types.ts

@@ -117,6 +117,7 @@ export type OperationUpdate = {
     input: object;
     hash: string;
     context?: ActionContext;
+    id?: string;
 };
 
 export type StrandUpdate = {

package/src/storage/prisma.ts

@@ -1,6 +1,5 @@
-import { PrismaClient, Prisma } from '@prisma/client';
+import { Prisma, PrismaClient } from '@prisma/client';
 import { PrismaClientKnownRequestError } from '@prisma/client/runtime/library';
-import { backOff, IBackOffOptions } from "exponential-backoff";
 import {
     DocumentDriveAction,
     DocumentDriveLocalState,
@@ -15,14 +14,22 @@ import type {
     OperationScope,
     State
 } from 'document-model/document';
+import { IBackOffOptions, backOff } from 'exponential-backoff';
 import { ConflictOperationError } from '../server/error';
 import { logger } from '../utils/logger';
 import { DocumentDriveStorage, DocumentStorage, IDriveStorage } from './types';
 
-type Transaction = Omit<
-    PrismaClient<Prisma.PrismaClientOptions, never>,
-    '$connect' | '$disconnect' | '$on' | '$transaction' | '$use' | '$extends'
-> | ExtendedPrismaClient;
+type Transaction =
+    | Omit<
+          PrismaClient<Prisma.PrismaClientOptions, never>,
+          | '$connect'
+          | '$disconnect'
+          | '$on'
+          | '$transaction'
+          | '$use'
+          | '$extends'
+      >
+    | ExtendedPrismaClient;
 
 function storageToOperation(
     op: Prisma.$OperationPayload['scalars']
@@ -35,7 +42,8 @@ function storageToOperation(
         input: JSON.parse(op.input),
         type: op.type,
         scope: op.scope as OperationScope,
-        resultingState: op.resultingState ? op.resultingState : undefined
+        resultingState: op.resultingState ? op.resultingState : undefined,
+        id: op.opId || undefined
         // attachments: fileRegistry
     };
     if (op.context) {
@@ -46,27 +54,32 @@ function storageToOperation(
 
 export type PrismaStorageOptions = {
     transactionRetryBackoff?: IBackOffOptions;
-}
+};
 
-function getRetryTransactionsClient<T extends PrismaClient>(prisma: T, backOffOptions?: Partial<IBackOffOptions>) {
+function getRetryTransactionsClient<T extends PrismaClient>(
+    prisma: T,
+    backOffOptions?: Partial<IBackOffOptions>
+) {
     return prisma.$extends({
         client: {
-            $transaction: (...args: Parameters<T["$transaction"]>) => {
+            $transaction: (...args: Parameters<T['$transaction']>) => {
                 // eslint-disable-next-line prefer-spread
                 return backOff(() => prisma.$transaction.apply(prisma, args), {
-                    retry: (e) => {
+                    retry: e => {
                         // Retry the transaction only if the error was due to a write conflict or deadlock
                         // See: https://www.prisma.io/docs/reference/api-reference/error-reference#p2034
-                        return (e as { code: string }).code === "P2034";
+                        return (e as { code: string }).code === 'P2034';
                     },
-                    ...backOffOptions,
+                    ...backOffOptions
                 });
             }
         }
     });
 }
 
-type ExtendedPrismaClient = ReturnType<typeof getRetryTransactionsClient<PrismaClient>>;
+type ExtendedPrismaClient = ReturnType<
+    typeof getRetryTransactionsClient<PrismaClient>
+>;
 
 export class PrismaStorage implements IDriveStorage {
     private db: ExtendedPrismaClient;
@@ -75,9 +88,8 @@ export class PrismaStorage implements IDriveStorage {
         const backOffOptions = options?.transactionRetryBackoff;
         this.db = getRetryTransactionsClient(db, {
             ...backOffOptions,
-            jitter: backOffOptions?.jitter ?? "full"
+            jitter: backOffOptions?.jitter ?? 'full'
         });
-
     }
 
     async createDrive(id: string, drive: DocumentDriveStorage): Promise<void> {
@@ -138,7 +150,7 @@ export class PrismaStorage implements IDriveStorage {
                 initialState: JSON.stringify(document.initialState),
                 lastModified: document.lastModified,
                 revision: JSON.stringify(document.revision),
-                id,
+                id
             }
         });
     }
@@ -169,7 +181,10 @@ export class PrismaStorage implements IDriveStorage {
                     branch: 'main',
                     skip: op.skip,
                     context: op.context,
-                    resultingState: op.resultingState ? JSON.stringify(op.resultingState) : undefined
+                    opId: op.id,
+                    resultingState: op.resultingState
+                        ? JSON.stringify(op.resultingState)
+                        : undefined
                 }))
             });
 
@@ -180,7 +195,7 @@ export class PrismaStorage implements IDriveStorage {
                 },
                 data: {
                     lastModified: header.lastModified,
-                    revision: JSON.stringify(header.revision),
+                    revision: JSON.stringify(header.revision)
                 }
             });
         } catch (e) {
@@ -228,7 +243,7 @@ export class PrismaStorage implements IDriveStorage {
         callback: (document: DocumentStorage) => Promise<{
             operations: Operation[];
             header: DocumentHeader;
-            newState?: State<any, any> | undefined
+            newState?: State<any, any> | undefined;
         }>
     ) {
         let result: {
@@ -237,23 +252,25 @@ export class PrismaStorage implements IDriveStorage {
             newState?: State<any, any> | undefined;
         } | null = null;
 
-        await this.db.$transaction(async tx => {
-            const document = await this.getDocument(drive, id, tx);
-            if (!document) {
-                throw new Error(`Document with id ${id} not found`);
-            }
-            result = await callback(document);
-
-            const { operations, header, newState } = result;
-            return this._addDocumentOperations(
-                tx,
-                drive,
-                id,
-                operations,
-                header,
-            );
-        }, { isolationLevel: "Serializable" });
+        await this.db.$transaction(
+            async tx => {
+                const document = await this.getDocument(drive, id, tx);
+                if (!document) {
+                    throw new Error(`Document with id ${id} not found`);
+                }
+                result = await callback(document);
 
+                const { operations, header, newState } = result;
+                return this._addDocumentOperations(
+                    tx,
+                    drive,
+                    id,
+                    operations,
+                    header
+                );
+            },
+            { isolationLevel: 'Serializable' }
+        );
 
         // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
         if (!result) {
@@ -267,14 +284,14 @@ export class PrismaStorage implements IDriveStorage {
         drive: string,
         id: string,
         operations: Operation[],
-        header: DocumentHeader,
+        header: DocumentHeader
     ): Promise<void> {
         return this._addDocumentOperations(
             this.db,
             drive,
             id,
             operations,
-            header,
+            header
         );
     }
 
@@ -298,7 +315,7 @@ export class PrismaStorage implements IDriveStorage {
             where: {
                 id: id,
                 driveId: driveId
-            },
+            }
         });
         return count > 0;
     }
@@ -347,7 +364,10 @@ export class PrismaStorage implements IDriveStorage {
             clipboard: dbDoc.operations
                 .filter(op => op.clipboard)
                 .map(storageToOperation),
-            revision: JSON.parse(dbDoc.revision) as Record<OperationScope, number>,
+            revision: JSON.parse(dbDoc.revision) as Record<
+                OperationScope,
+                number
+            >,
             attachments: {}
         };
 

package/src/storage/sequelize.ts

@@ -25,8 +25,8 @@ export class SequelizeStorage implements IDriveStorage {
                 type: DataTypes.STRING,
                 primaryKey: true
             },
-            id: DataTypes.STRING,
-        })
+            id: DataTypes.STRING
+        });
         const Document = this.db.define('document', {
             id: {
                 type: DataTypes.STRING,
@@ -155,7 +155,7 @@ export class SequelizeStorage implements IDriveStorage {
         drive: string,
         id: string,
         operations: Operation[],
-        header: DocumentHeader,
+        header: DocumentHeader
     ): Promise<void> {
         const document = await this.getDocument(drive, id);
         if (!document) {
@@ -177,7 +177,8 @@ export class SequelizeStorage implements IDriveStorage {
                 timestamp: op.timestamp,
                 type: op.type,
                 scope: op.scope,
-                branch: 'main'
+                branch: 'main',
+                opId: op.id
             }))
         );
 
@@ -284,8 +285,8 @@ export class SequelizeStorage implements IDriveStorage {
             where: {
                 id: id,
                 driveId: driveId
-            },
-        })
+            }
+        });
 
         return count > 0;
     }
@@ -323,6 +324,7 @@ export class SequelizeStorage implements IDriveStorage {
                     input: JSON;
                     type: string;
                     scope: string;
+                    opId?: string;
                 }
             ];
             revision: Required<Record<OperationScope, number>>;
@@ -348,13 +350,15 @@ export class SequelizeStorage implements IDriveStorage {
                 input: JSON;
                 type: string;
                 scope: string;
+                opId?: string;
             }) => ({
                 hash: op.hash,
                 index: op.index,
                 timestamp: new Date(op.timestamp).toISOString(),
                 input: op.input,
                 type: op.type,
-                scope: op.scope as OperationScope
+                scope: op.scope as OperationScope,
+                id: op.opId
                 // attachments: fileRegistry
             })
         );