The minimalistic document archiving platform.
feat(documents): added document.trashed internal event (#671)
Corentin Thomassetf488e63c38a8
diff --git a/apps/papra-server/src/modules/app/events/events.handlers.ts b/apps/papra-server/src/modules/app/events/events.handlers.tsindex ca41ea5b..5810454d 100644--- a/apps/papra-server/src/modules/app/events/events.handlers.ts+++ b/apps/papra-server/src/modules/app/events/events.handlers.ts@@ -2,8 +2,10 @@ 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 { registerInsertActivityLogOnDocumentTrashedHandler } from '../../documents/events/activity-log.document-trashed';import { registerTrackDocumentCreatedHandler } from '../../documents/events/tracking.document-created';import { registerTriggerWebhooksOnDocumentCreatedHandler } from '../../documents/events/webhook.document-created';+import { registerTriggerWebhooksOnDocumentTrashedHandler } from '../../documents/events/webhook.document-trashed';import { registerTrackingUserCreatedEventHandler } from '../../users/event-handlers/tracking.user-created';export function registerEventHandlers(deps: { trackingServices: TrackingServices; eventServices: EventServices; db: Database }) {@@ -11,4 +13,6 @@ export function registerEventHandlers(deps: { trackingServices: TrackingServicesregisterTriggerWebhooksOnDocumentCreatedHandler(deps);registerInsertActivityLogOnDocumentCreatedHandler(deps);registerTrackDocumentCreatedHandler(deps);+ registerTriggerWebhooksOnDocumentTrashedHandler(deps);+ registerInsertActivityLogOnDocumentTrashedHandler(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 85fd106c..ecb43e79 100644--- a/apps/papra-server/src/modules/documents/documents.events.types.ts+++ b/apps/papra-server/src/modules/documents/documents.events.types.ts@@ -2,4 +2,5 @@ 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};diff --git a/apps/papra-server/src/modules/documents/documents.routes.ts b/apps/papra-server/src/modules/documents/documents.routes.tsindex 3a4e0736..4a3dfc61 100644--- a/apps/papra-server/src/modules/documents/documents.routes.ts+++ b/apps/papra-server/src/modules/documents/documents.routes.ts@@ -16,7 +16,7 @@ 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 } from './documents.usecases';+import { createDocumentCreationUsecase, deleteAllTrashDocuments, deleteTrashDocument, ensureDocumentExists, getDocumentOrThrow, trashDocument } from './documents.usecases';export function registerDocumentsRoutes(context: RouteDefinitionContext) {setupCreateDocumentRoute(context);@@ -177,7 +177,7 @@ function setupGetDocumentRoute({ app, db }: RouteDefinitionContext) {);}-function setupDeleteDocumentRoute({ app, db }: RouteDefinitionContext) {+function setupDeleteDocumentRoute({ app, db, eventServices }: RouteDefinitionContext) {app.delete('/api/organizations/:organizationId/documents/:documentId',requireAuthentication({ apiKeyPermissions: ['documents:delete'] }),@@ -192,26 +192,16 @@ function setupDeleteDocumentRoute({ app, db }: RouteDefinitionContext) {const documentsRepository = createDocumentsRepository({ db });const organizationsRepository = createOrganizationsRepository({ db });- const webhookRepository = createWebhookRepository({ db });- const documentActivityRepository = createDocumentActivityRepository({ db });await ensureUserIsInOrganization({ userId, organizationId, organizationsRepository });await ensureDocumentExists({ documentId, organizationId, documentsRepository });- await documentsRepository.softDeleteDocument({ documentId, organizationId, userId });-- deferTriggerWebhooks({- webhookRepository,- organizationId,- event: 'document:deleted',- payload: { documentId, organizationId },- });-- deferRegisterDocumentActivityLog({+ await trashDocument({documentId,- event: 'deleted',+ organizationId,userId,- documentActivityRepository,+ documentsRepository,+ eventServices,});return context.json({diff --git a/apps/papra-server/src/modules/documents/documents.usecases.test.ts b/apps/papra-server/src/modules/documents/documents.usecases.test.tsindex 8430fed9..7cce4e6c 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 } from './documents.usecases';+import { createDocumentCreationUsecase, extractAndSaveDocumentFileContent, trashDocument } from './documents.usecases';import { createDocumentStorageService } from './storage/documents.storage.services';import { inMemoryStorageDriverFactory } from './storage/drivers/memory/memory.storage-driver';@@ -577,4 +577,83 @@ describe('documents usecases', () => {});});});++ describe('trashDocument', () => {+ test('users can soft delete a document by moving it to the trash', 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',+ }],+ });++ const documentsRepository = createDocumentsRepository({ db });++ await trashDocument({+ 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: true,+ deletedBy: 'user-1',+ });+ });++ test('when a document is trashed, a "document.trashed" 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',+ }],+ });++ const documentsRepository = createDocumentsRepository({ db });+ const eventServices = createTestEventServices();++ await trashDocument({+ documentId: 'document-1',+ organizationId: 'organization-1',+ userId: 'user-1',+ documentsRepository,+ eventServices,+ });++ const emittedEvents = eventServices.getEmittedEvents();++ expect(emittedEvents.length).to.eql(1);+ const { eventName, payload } = emittedEvents[0]!;++ expect(eventName).to.eql('document.trashed');+ expect(payload).to.deep.include({+ documentId: 'document-1',+ organizationId: 'organization-1',+ trashedBy: 'user-1',+ });+ });+ });});diff --git a/apps/papra-server/src/modules/documents/documents.usecases.ts b/apps/papra-server/src/modules/documents/documents.usecases.tsindex 921824a5..d917d3bf 100644--- a/apps/papra-server/src/modules/documents/documents.usecases.ts+++ b/apps/papra-server/src/modules/documents/documents.usecases.ts@@ -507,3 +507,24 @@ export async function extractAndSaveDocumentFileContent({return { document: updatedDocument };}++export async function trashDocument({+ documentId,+ organizationId,+ userId,+ documentsRepository,+ eventServices,+}: {+ documentId: string;+ organizationId: string;+ userId: string;+ documentsRepository: DocumentsRepository;+ eventServices: EventServices;+}) {+ await documentsRepository.softDeleteDocument({ documentId, organizationId, userId });++ eventServices.emitEvent({+ eventName: 'document.trashed',+ payload: { documentId, organizationId, trashedBy: userId },+ });+}diff --git a/apps/papra-server/src/modules/documents/events/activity-log.document-trashed.ts b/apps/papra-server/src/modules/documents/events/activity-log.document-trashed.tsnew file mode 100644index 00000000..acb06728--- /dev/null+++ b/apps/papra-server/src/modules/documents/events/activity-log.document-trashed.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 registerInsertActivityLogOnDocumentTrashedHandler({+ eventServices,+ db,+}: {+ eventServices: EventServices;+ db: Database;+}) {+ const documentActivityRepository = createDocumentActivityRepository({ db });++ eventServices.onEvent({+ eventName: 'document.trashed',+ handlerName: 'insert-activity-log',+ async handler({ documentId, trashedBy }) {+ await registerDocumentActivityLog({+ documentId,+ event: 'deleted',+ userId: trashedBy,+ documentActivityRepository,+ });+ },+ });+}diff --git a/apps/papra-server/src/modules/documents/events/webhook.document-trashed.ts b/apps/papra-server/src/modules/documents/events/webhook.document-trashed.tsnew file mode 100644index 00000000..e02e2776--- /dev/null+++ b/apps/papra-server/src/modules/documents/events/webhook.document-trashed.ts@@ -0,0 +1,30 @@+import type { Database } from '../../app/database/database.types';+import type { EventServices } from '../../app/events/events.services';+import { createWebhookRepository } from '../../webhooks/webhook.repository';+import { triggerWebhooks } from '../../webhooks/webhook.usecases';++export function registerTriggerWebhooksOnDocumentTrashedHandler({+ eventServices,+ db,+}: {+ eventServices: EventServices;+ db: Database;+}) {+ const webhookRepository = createWebhookRepository({ db });++ eventServices.onEvent({+ eventName: 'document.trashed',+ handlerName: 'trigger-webhooks',+ async handler({ documentId, organizationId }) {+ await triggerWebhooks({+ webhookRepository,+ organizationId,+ event: 'document:deleted',+ payload: {+ documentId,+ organizationId,+ },+ });+ },+ });+}