document-drive 0.0.29 → 0.0.30

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "document-drive",
-    "version": "0.0.29",
+    "version": "0.0.30",
     "license": "AGPL-3.0-only",
     "type": "module",
     "module": "./src/index.ts",
@@ -29,7 +29,7 @@
     },
     "peerDependencies": {
         "@prisma/client": "5.8.1",
-        "document-model": "^1.0.28",
+        "document-model": "^1.0.29",
         "document-model-libs": "^1.1.44",
         "localforage": "^1.10.0",
         "sequelize": "^6.35.2",
@@ -39,6 +39,7 @@
         "graphql": "^16.8.1",
         "graphql-request": "^6.1.0",
         "json-stringify-deterministic": "^1.0.12",
+        "nanoevents": "^9.0.0",
         "sanitize-filename": "^1.6.3"
     },
     "devDependencies": {
@@ -48,7 +49,7 @@
         "@typescript-eslint/eslint-plugin": "^6.18.1",
         "@typescript-eslint/parser": "^6.18.1",
         "@vitest/coverage-v8": "^0.34.6",
-        "document-model": "^1.0.28",
+        "document-model": "^1.0.29",
         "document-model-libs": "^1.1.44",
         "eslint": "^8.56.0",
         "eslint-config-prettier": "^9.1.0",

package/src/server/index.ts

@@ -3,19 +3,20 @@ import {
     DocumentDriveDocument,
     DocumentDriveState,
     FileNode,
-    Trigger,
     isFileNode,
+    Trigger,
     utils
 } from 'document-model-libs/document-drive';
 import {
     Action,
     BaseAction,
+    utils as baseUtils,
     Document,
     DocumentModel,
     Operation,
-    OperationScope,
-    utils as baseUtils
+    OperationScope
 } from 'document-model/document';
+import { createNanoEvents, Unsubscribe } from 'nanoevents';
 import { MemoryStorage } from '../storage/memory';
 import type { DocumentStorage, IDriveStorage } from '../storage/types';
 import { generateUUID, isDocumentDrive, isNoopUpdate } from '../utils';
@@ -26,7 +27,9 @@ import { PullResponderTransmitter } from './listener/transmitter';
 import type { ITransmitter } from './listener/transmitter/types';
 import {
     BaseDocumentDriveServer,
+    DriveEvents,
     IOperationResult,
+    ListenerState,
     RemoteDriveOptions,
     StrandUpdate,
     SyncStatus,
@@ -43,6 +46,7 @@ export type * from './types';
 export const PULL_DRIVE_INTERVAL = 5000;
 
 export class DocumentDriveServer extends BaseDocumentDriveServer {
+    private emitter = createNanoEvents<DriveEvents>();
     private documentModels: DocumentModel[];
     private storage: IDriveStorage;
     private listenerStateManager: ListenerManager;
@@ -62,6 +66,15 @@ export class DocumentDriveServer extends BaseDocumentDriveServer {
         this.storage = storage;
     }
 
+    private updateSyncStatus(
+        driveId: string,
+        status: SyncStatus,
+        error?: Error
+    ) {
+        this.syncStatus.set(driveId, status);
+        this.emit('syncStatus', driveId, status, error);
+    }
+
     private async saveStrand(strand: StrandUpdate) {
         const operations: Operation[] = strand.operations.map(
             ({ index, type, hash, input, skip, timestamp }) => ({
@@ -86,10 +99,27 @@ export class DocumentDriveServer extends BaseDocumentDriveServer {
                   strand.documentId,
                   operations
               ));
-        this.syncStatus.set(strand.driveId, result.status);
+
+        this.updateSyncStatus(strand.driveId, result.status);
+        this.emit('strandUpdate', strand);
         return result;
     }
 
+    private handleListenerError(
+        error: Error,
+        driveId: string,
+        listener: ListenerState
+    ) {
+        console.error(
+            `Listener ${listener.listener.label ?? listener.listener.listenerId} error: ${error.message}`
+        );
+        this.updateSyncStatus(
+            driveId,
+            error instanceof OperationError ? error.status : 'ERROR',
+            error
+        );
+    }
+
     private shouldSyncRemoteDrive(drive: DocumentDriveDocument) {
         return (
             drive.state.local.availableOffline &&
@@ -108,7 +138,7 @@ export class DocumentDriveServer extends BaseDocumentDriveServer {
 
             if (!driveTriggers) {
                 driveTriggers = new Map();
-                this.syncStatus.set(driveId, 'SYNCING');
+                this.updateSyncStatus(driveId, 'SYNCING');
             }
 
             if (PullResponderTransmitter.isPullResponderTrigger(trigger)) {
@@ -117,7 +147,7 @@ export class DocumentDriveServer extends BaseDocumentDriveServer {
                     trigger,
                     this.saveStrand.bind(this),
                     error => {
-                        this.syncStatus.set(
+                        this.updateSyncStatus(
                             driveId,
                             error instanceof OperationError
                                 ? error.status
@@ -265,7 +295,7 @@ export class DocumentDriveServer extends BaseDocumentDriveServer {
                 (filter.since !== undefined &&
                     filter.since <= operation.timestamp) ||
                 (filter.fromRevision !== undefined &&
-                    operation.index >= filter.fromRevision)
+                    operation.index > filter.fromRevision)
         );
 
         return filteredOperations.map(operation => ({
@@ -456,6 +486,12 @@ export class DocumentDriveServer extends BaseDocumentDriveServer {
     }
 
     async deleteDocument(driveId: string, id: string) {
+        try {
+            const syncUnits = await this.getSynchronizationUnits(driveId, [id]);
+            this.listenerStateManager.removeSyncUnits(syncUnits);
+        } catch {
+            /* empty */
+        }
         return this.storage.deleteDocument(driveId, id);
     }
 
@@ -664,10 +700,10 @@ export class DocumentDriveServer extends BaseDocumentDriveServer {
             );
         }
 
-        const results = await Promise.all(
-            operationSignals.map(handler => handler())
-        );
-        signalResults.push(...results);
+        for (const signalHandler of operationSignals) {
+            const result = await signalHandler();
+            signalResults.push(result);
+        }
 
         return {
             document: newDocument,
@@ -749,10 +785,15 @@ export class DocumentDriveServer extends BaseDocumentDriveServer {
                         drive,
                         syncUnit.syncId,
                         syncUnit.revision,
-                        syncUnit.lastUpdated
+                        syncUnit.lastUpdated,
+                        this.handleListenerError.bind(this)
                     )
                     .catch(error => {
-                        console.error('Error updating sync revision', error);
+                        console.error(
+                            'Non handled error updating sync revision',
+                            error
+                        );
+                        this.updateSyncStatus(drive, 'ERROR', error as Error);
                     });
             }
 
@@ -875,10 +916,15 @@ export class DocumentDriveServer extends BaseDocumentDriveServer {
                         drive,
                         '0',
                         lastOperation.index,
-                        lastOperation.timestamp
+                        lastOperation.timestamp,
+                        this.handleListenerError.bind(this)
                     )
                     .catch(error => {
-                        console.error('Error updating sync revision', error);
+                        console.error(
+                            'Non handled error updating sync revision',
+                            error
+                        );
+                        this.updateSyncStatus(drive, 'ERROR', error as Error);
                     });
             }
 
@@ -935,4 +981,15 @@ export class DocumentDriveServer extends BaseDocumentDriveServer {
         }
         return status;
     }
+
+    on<K extends keyof DriveEvents>(event: K, cb: DriveEvents[K]): Unsubscribe {
+        return this.emitter.on(event, cb);
+    }
+
+    protected emit<K extends keyof DriveEvents>(
+        event: K,
+        ...args: Parameters<DriveEvents[K]>
+    ): void {
+        return this.emitter.emit(event, ...args);
+    }
 }

package/src/server/listener/manager.ts

@@ -9,6 +9,7 @@ import {
     ErrorStatus,
     Listener,
     ListenerState,
+    OperationUpdate,
     StrandUpdate,
     SynchronizationUnit
 } from '../types';
@@ -120,7 +121,12 @@ export class ListenerManager extends BaseListenerManager {
         driveId: string,
         syncId: string,
         syncRev: number,
-        lastUpdated: string
+        lastUpdated: string,
+        onError?: (
+            error: Error,
+            driveId: string,
+            listener: ListenerState
+        ) => void
     ) {
         const drive = this.listenerState.get(driveId);
         if (!drive) {
@@ -148,7 +154,7 @@ export class ListenerManager extends BaseListenerManager {
         }
 
         if (newRevision) {
-            return this.triggerUpdate();
+            return this.triggerUpdate(onError);
         }
     }
 
@@ -202,6 +208,19 @@ export class ListenerManager extends BaseListenerManager {
         }
     }
 
+    removeSyncUnits(syncUnits: SynchronizationUnit[]) {
+        for (const [driveId, drive] of this.listenerState) {
+            const syncIds = syncUnits
+                .filter(s => s.driveId === driveId)
+                .map(s => s.syncId);
+            for (const [, listenerState] of drive) {
+                listenerState.syncUnits = listenerState.syncUnits.filter(
+                    s => !syncIds.includes(s.syncId)
+                );
+            }
+        }
+    }
+
     async updateListenerRevision(
         listenerId: string,
         driveId: string,
@@ -225,7 +244,13 @@ export class ListenerManager extends BaseListenerManager {
         }
     }
 
-    async triggerUpdate() {
+    async triggerUpdate(
+        onError?: (
+            error: Error,
+            driveId: string,
+            listener: ListenerState
+        ) => void
+    ) {
         for (const [driveId, drive] of this.listenerState) {
             for (const [id, listener] of drive) {
                 const transmitter = await this.getTransmitter(driveId, id);
@@ -248,13 +273,19 @@ export class ListenerManager extends BaseListenerManager {
                         continue;
                     }
 
-                    const opData = await this.drive.getOperationData(
-                        driveId,
-                        syncId,
-                        {
-                            fromRevision: listenerRev
-                        }
-                    );
+                    const opData: OperationUpdate[] = [];
+                    try {
+                        const data = await this.drive.getOperationData(
+                            driveId,
+                            syncId,
+                            {
+                                fromRevision: listenerRev
+                            }
+                        );
+                        opData.push(...data);
+                    } catch (e) {
+                        console.error(e);
+                    }
 
                     if (!opData.length) {
                         continue;
@@ -309,9 +340,9 @@ export class ListenerManager extends BaseListenerManager {
                     listener.listenerStatus = 'SUCCESS';
                 } catch (e) {
                     // TODO: Handle error based on listener params (blocking, retry, etc)
+                    onError?.(e as Error, driveId, listener);
                     listener.listenerStatus =
                         e instanceof OperationError ? e.status : 'ERROR';
-                    throw e;
                 }
             }
         }

package/src/server/types.ts

@@ -15,6 +15,7 @@ import type {
     Signal,
     State
 } from 'document-model/document';
+import { Unsubscribe } from 'nanoevents';
 import { OperationError } from './error';
 import { ITransmitter } from './listener/transmitter/types';
 
@@ -114,6 +115,11 @@ export type StrandUpdate = {
 
 export type SyncStatus = 'SYNCING' | UpdateStatus;
 
+export interface DriveEvents {
+    syncStatus: (driveId: string, status: SyncStatus, error?: Error) => void;
+    strandUpdate: (update: StrandUpdate) => void;
+}
+
 export abstract class BaseDocumentDriveServer {
     /** Public methods **/
     abstract getDrives(): Promise<string[]>;
@@ -132,12 +138,12 @@ export abstract class BaseDocumentDriveServer {
         drive: string,
         id: string,
         operation: Operation
-    ): Promise<IOperationResult<Document>>;
+    ): Promise<IOperationResult>;
     abstract addOperations(
         drive: string,
         id: string,
         operations: Operation[]
-    ): Promise<IOperationResult<Document>>;
+    ): Promise<IOperationResult>;
 
     abstract addDriveOperation(
         drive: string,
@@ -183,12 +189,23 @@ export abstract class BaseDocumentDriveServer {
         driveId: string,
         listenerId: string
     ): Promise<ITransmitter | undefined>;
+
+    /** Event methods **/
+    protected abstract emit<K extends keyof DriveEvents>(
+        this: this,
+        event: K,
+        ...args: Parameters<DriveEvents[K]>
+    ): void;
+    abstract on<K extends keyof DriveEvents>(
+        this: this,
+        event: K,
+        cb: DriveEvents[K]
+    ): Unsubscribe;
 }
 
 export abstract class BaseListenerManager {
     protected drive: BaseDocumentDriveServer;
-    protected listenerState: Map<string, Map<string, ListenerState>> =
-        new Map();
+    protected listenerState = new Map<string, Map<string, ListenerState>>();
     protected transmitters: Record<
         DocumentDriveState['id'],
         Record<Listener['listenerId'], ITransmitter>
@@ -196,7 +213,7 @@ export abstract class BaseListenerManager {
 
     constructor(
         drive: BaseDocumentDriveServer,
-        listenerState: Map<string, Map<string, ListenerState>> = new Map()
+        listenerState = new Map<string, Map<string, ListenerState>>()
     ) {
         this.drive = drive;
         this.listenerState = listenerState;