The minimalistic document archiving platform.
refactor(server): add restore document usecase with event (#681)
Corentin Thomasset2872c979fa6f
diff --git a/apps/papra-server/src/modules/app/events/events.handlers.ts b/apps/papra-server/src/modules/app/events/events.handlers.tsindex 1678e1c0..2629e35d 100644--- a/apps/papra-server/src/modules/app/events/events.handlers.ts+++ b/apps/papra-server/src/modules/app/events/events.handlers.ts@@ -2,6 +2,7 @@ import type { TrackingServices } from '../../tracking/tracking.services';import type { Database } from '../database/database.types';import type { EventServices } from './events.services';import { registerInsertActivityLogOnDocumentCreatedHandler } from '../../documents/events/activity-log.document-created';+import { registerInsertActivityLogOnDocumentRestoredHandler } from '../../documents/events/activity-log.document-restored';import { registerInsertActivityLogOnDocumentTrashedHandler } from '../../documents/events/activity-log.document-trashed';import { registerInsertActivityLogOnDocumentUpdatedHandler } from '../../documents/events/activity-log.document-updated';import { registerTrackDocumentCreatedHandler } from '../../documents/events/tracking.document-created';@@ -17,6 +18,7 @@ export function registerEventHandlers(deps: { trackingServices: TrackingServicesregisterTrackDocumentCreatedHandler(deps);registerTriggerWebhooksOnDocumentTrashedHandler(deps);registerInsertActivityLogOnDocumentTrashedHandler(deps);+ registerInsertActivityLogOnDocumentRestoredHandler(deps);registerTriggerWebhooksOnDocumentUpdatedHandler(deps);registerInsertActivityLogOnDocumentUpdatedHandler(deps);}diff --git a/apps/papra-server/src/modules/documents/documents.events.types.ts b/apps/papra-server/src/modules/documents/documents.events.types.tsindex 8b4adf5f..60695e0f 100644--- a/apps/papra-server/src/modules/documents/documents.events.types.ts+++ b/apps/papra-server/src/modules/documents/documents.events.types.ts@@ -3,6 +3,7 @@ import type { Document } from './documents.types';export type DocumentEvents = {'document.created': { document: Document };'document.trashed': { documentId: string; organizationId: string; trashedBy: string }; // Soft deleted by moving to trash+ 'document.restored': { documentId: string; organizationId: string; restoredBy: string };'document.updated': {documentId: string;organizationId: string;diff --git a/apps/papra-server/src/modules/documents/documents.routes.ts b/apps/papra-server/src/modules/documents/documents.routes.tsindex 3e2e7d1d..ef3dc64b 100644--- a/apps/papra-server/src/modules/documents/documents.routes.ts+++ b/apps/papra-server/src/modules/documents/documents.routes.ts@@ -8,13 +8,11 @@ import { createOrganizationsRepository } from '../organizations/organizations.reimport { ensureUserIsInOrganization } from '../organizations/organizations.usecases';import { getFileStreamFromMultipartForm } from '../shared/streams/file-upload';import { validateJsonBody, validateParams, validateQuery } from '../shared/validation/validation';-import { createDocumentActivityRepository } from './document-activity/document-activity.repository';-import { deferRegisterDocumentActivityLog } from './document-activity/document-activity.usecases';import { createDocumentIsNotDeletedError } from './documents.errors';import { formatDocumentForApi, formatDocumentsForApi, isDocumentSizeLimitEnabled } from './documents.models';import { createDocumentsRepository } from './documents.repository';import { documentIdSchema } from './documents.schemas';-import { createDocumentCreationUsecase, deleteAllTrashDocuments, deleteTrashDocument, ensureDocumentExists, getDocumentOrThrow, trashDocument, updateDocument } from './documents.usecases';+import { createDocumentCreationUsecase, deleteAllTrashDocuments, deleteTrashDocument, ensureDocumentExists, getDocumentOrThrow, restoreDocument, trashDocument, updateDocument } from './documents.usecases';export function registerDocumentsRoutes(context: RouteDefinitionContext) {setupCreateDocumentRoute(context);@@ -209,7 +207,7 @@ function setupDeleteDocumentRoute({ app, db, eventServices }: RouteDefinitionCon);}-function setupRestoreDocumentRoute({ app, db }: RouteDefinitionContext) {+function setupRestoreDocumentRoute({ app, db, eventServices }: RouteDefinitionContext) {app.post('/api/organizations/:organizationId/documents/:documentId/restore',requireAuthentication(),@@ -224,7 +222,6 @@ function setupRestoreDocumentRoute({ app, db }: RouteDefinitionContext) {const documentsRepository = createDocumentsRepository({ db });const organizationsRepository = createOrganizationsRepository({ db });- const documentActivityRepository = createDocumentActivityRepository({ db });await ensureUserIsInOrganization({ userId, organizationId, organizationsRepository });@@ -234,13 +231,12 @@ function setupRestoreDocumentRoute({ app, db }: RouteDefinitionContext) {throw createDocumentIsNotDeletedError();}- await documentsRepository.restoreDocument({ documentId, organizationId });-- deferRegisterDocumentActivityLog({+ await restoreDocument({documentId,- event: 'restored',+ organizationId,userId,- documentActivityRepository,+ documentsRepository,+ eventServices,});return context.body(null, 204);diff --git a/apps/papra-server/src/modules/documents/documents.usecases.test.ts b/apps/papra-server/src/modules/documents/documents.usecases.test.tsindex a5c98a90..be30976d 100644--- a/apps/papra-server/src/modules/documents/documents.usecases.test.ts+++ b/apps/papra-server/src/modules/documents/documents.usecases.test.ts@@ -16,7 +16,7 @@ import { createDocumentActivityRepository } from './document-activity/document-aimport { createDocumentAlreadyExistsError, createDocumentSizeTooLargeError } from './documents.errors';import { createDocumentsRepository } from './documents.repository';import { documentsTable } from './documents.table';-import { createDocumentCreationUsecase, extractAndSaveDocumentFileContent, trashDocument, updateDocument } from './documents.usecases';+import { createDocumentCreationUsecase, extractAndSaveDocumentFileContent, restoreDocument, trashDocument, updateDocument } from './documents.usecases';import { createDocumentStorageService } from './storage/documents.storage.services';import { inMemoryStorageDriverFactory } from './storage/drivers/memory/memory.storage-driver';@@ -723,6 +723,89 @@ describe('documents usecases', () => {});});+ describe('restoreDocument', () => {+ test('users can restore a document from the trash, the document is no longer marked as deleted and the deletedBy and deletedAt fields are cleared', async () => {+ const { db } = await createInMemoryDatabase({+ users: [{ id: 'user-1', email: '[email protected]' }],+ organizations: [{ id: 'organization-1', name: 'Organization 1' }],+ organizationMembers: [{ organizationId: 'organization-1', userId: 'user-1', role: ORGANIZATION_ROLES.OWNER }],+ documents: [{+ id: 'document-1',+ organizationId: 'organization-1',+ mimeType: 'text/plain',+ originalStorageKey: 'organization-1/originals/document-1.txt',+ name: 'file-1.txt',+ originalName: 'file-1.txt',+ originalSha256Hash: 'hash',+ isDeleted: true,+ deletedBy: 'user-1',+ }],+ });++ const documentsRepository = createDocumentsRepository({ db });++ await restoreDocument({+ documentId: 'document-1',+ organizationId: 'organization-1',+ userId: 'user-1',+ documentsRepository,+ eventServices: createTestEventServices(),+ });++ const documentRecords = await db.select().from(documentsTable);++ expect(documentRecords.length).to.eql(1);+ expect(documentRecords[0]).to.deep.include({+ id: 'document-1',+ organizationId: 'organization-1',+ isDeleted: false,+ deletedBy: null,+ deletedAt: null,+ });+ });++ test('when a document is restored, a "document.restored" event is triggered', async () => {+ const { db } = await createInMemoryDatabase({+ users: [{ id: 'user-1', email: '[email protected]' }],+ organizations: [{ id: 'organization-1', name: 'Organization 1' }],+ organizationMembers: [{ organizationId: 'organization-1', userId: 'user-1', role: ORGANIZATION_ROLES.OWNER }],+ documents: [{+ id: 'document-1',+ organizationId: 'organization-1',+ mimeType: 'text/plain',+ originalStorageKey: 'organization-1/originals/document-1.txt',+ name: 'file-1.txt',+ originalName: 'file-1.txt',+ originalSha256Hash: 'hash',+ isDeleted: true,+ deletedBy: 'user-1',+ }],+ });++ const documentsRepository = createDocumentsRepository({ db });+ const eventServices = createTestEventServices();++ await restoreDocument({+ documentId: 'document-1',+ organizationId: 'organization-1',+ userId: 'user-1',+ documentsRepository,+ eventServices,+ });++ expect(+ eventServices.getEmittedEvents(),+ ).to.eql([{+ eventName: 'document.restored',+ payload: {+ documentId: 'document-1',+ organizationId: 'organization-1',+ restoredBy: 'user-1',+ },+ }]);+ });+ });+describe('updateDocument', () => {test('when a document is updated, a "document.updated" event is triggered', async () => {const { db } = await createInMemoryDatabase({diff --git a/apps/papra-server/src/modules/documents/documents.usecases.ts b/apps/papra-server/src/modules/documents/documents.usecases.tsindex 067c5afc..73dedd15 100644--- a/apps/papra-server/src/modules/documents/documents.usecases.ts+++ b/apps/papra-server/src/modules/documents/documents.usecases.ts@@ -531,6 +531,27 @@ export async function trashDocument({});}+export async function restoreDocument({+ documentId,+ organizationId,+ userId,+ documentsRepository,+ eventServices,+}: {+ documentId: string;+ organizationId: string;+ userId: string;+ documentsRepository: DocumentsRepository;+ eventServices: EventServices;+}) {+ await documentsRepository.restoreDocument({ documentId, organizationId });++ eventServices.emitEvent({+ eventName: 'document.restored',+ payload: { documentId, organizationId, restoredBy: userId },+ });+}+export async function updateDocument({documentId,organizationId,diff --git a/apps/papra-server/src/modules/documents/events/activity-log.document-restored.ts b/apps/papra-server/src/modules/documents/events/activity-log.document-restored.tsnew file mode 100644index 00000000..98118f64--- /dev/null+++ b/apps/papra-server/src/modules/documents/events/activity-log.document-restored.ts@@ -0,0 +1,27 @@+import type { Database } from '../../app/database/database.types';+import type { EventServices } from '../../app/events/events.services';+import { createDocumentActivityRepository } from '../document-activity/document-activity.repository';+import { registerDocumentActivityLog } from '../document-activity/document-activity.usecases';++export function registerInsertActivityLogOnDocumentRestoredHandler({+ eventServices,+ db,+}: {+ eventServices: EventServices;+ db: Database;+}) {+ const documentActivityRepository = createDocumentActivityRepository({ db });++ eventServices.onEvent({+ eventName: 'document.restored',+ handlerName: 'insert-activity-log',+ async handler({ documentId, restoredBy }) {+ await registerDocumentActivityLog({+ documentId,+ event: 'restored',+ userId: restoredBy,+ documentActivityRepository,+ });+ },+ });+}