The minimalistic document archiving platform.
feat(documents): add document.deleted event (#684)
Corentin Thomasset5bdb7c06bff6
diff --git a/apps/papra-server/src/modules/documents/documents.events.types.ts b/apps/papra-server/src/modules/documents/documents.events.types.tsindex 60695e0f..e3e3660c 100644--- a/apps/papra-server/src/modules/documents/documents.events.types.ts+++ b/apps/papra-server/src/modules/documents/documents.events.types.ts@@ -13,4 +13,5 @@ export type DocumentEvents = {content?: string;};};+ 'document.deleted': { documentId: string; organizationId: string }; // Hard deleted from trash};diff --git a/apps/papra-server/src/modules/documents/documents.repository.ts b/apps/papra-server/src/modules/documents/documents.repository.tsindex 06acd3af..fa888715 100644--- a/apps/papra-server/src/modules/documents/documents.repository.ts+++ b/apps/papra-server/src/modules/documents/documents.repository.ts@@ -294,6 +294,7 @@ async function getExpiredDeletedDocuments({ db, expirationDelayInDays, now = newconst documents = await db.select({id: documentsTable.id,originalStorageKey: documentsTable.originalStorageKey,+ organizationId: documentsTable.organizationId,}).from(documentsTable).where(and(eq(documentsTable.isDeleted, true),@@ -343,6 +344,7 @@ async function getAllOrganizationTrashDocuments({ organizationId, db }: { organiconst documents = await db.select({id: documentsTable.id,originalStorageKey: documentsTable.originalStorageKey,+ organizationId: documentsTable.organizationId,}).from(documentsTable).where(and(eq(documentsTable.organizationId, organizationId),diff --git a/apps/papra-server/src/modules/documents/documents.routes.ts b/apps/papra-server/src/modules/documents/documents.routes.tsindex ef3dc64b..b1faca09 100644--- a/apps/papra-server/src/modules/documents/documents.routes.ts+++ b/apps/papra-server/src/modules/documents/documents.routes.ts@@ -361,7 +361,7 @@ function setupGetOrganizationDocumentsStatsRoute({ app, db }: RouteDefinitionCon);}-function setupDeleteTrashDocumentRoute({ app, db, documentsStorageService }: RouteDefinitionContext) {+function setupDeleteTrashDocumentRoute({ app, db, documentsStorageService, eventServices }: RouteDefinitionContext) {app.delete('/api/organizations/:organizationId/documents/trash/:documentId',requireAuthentication(),@@ -379,7 +379,7 @@ function setupDeleteTrashDocumentRoute({ app, db, documentsStorageService }: Rouawait ensureUserIsInOrganization({ userId, organizationId, organizationsRepository });- await deleteTrashDocument({ documentId, organizationId, documentsRepository, documentsStorageService });+ await deleteTrashDocument({ documentId, organizationId, documentsRepository, documentsStorageService, eventServices });return context.json({success: true,@@ -388,7 +388,7 @@ function setupDeleteTrashDocumentRoute({ app, db, documentsStorageService }: Rou);}-function setupDeleteAllTrashDocumentsRoute({ app, db, documentsStorageService }: RouteDefinitionContext) {+function setupDeleteAllTrashDocumentsRoute({ app, db, documentsStorageService, eventServices }: RouteDefinitionContext) {app.delete('/api/organizations/:organizationId/documents/trash',requireAuthentication(),@@ -405,7 +405,7 @@ function setupDeleteAllTrashDocumentsRoute({ app, db, documentsStorageService }:await ensureUserIsInOrganization({ userId, organizationId, organizationsRepository });- await deleteAllTrashDocuments({ organizationId, documentsRepository, documentsStorageService });+ await deleteAllTrashDocuments({ organizationId, documentsRepository, documentsStorageService, eventServices });return context.body(null, 204);},diff --git a/apps/papra-server/src/modules/documents/documents.usecases.ts b/apps/papra-server/src/modules/documents/documents.usecases.tsindex 73dedd15..b7c04922 100644--- a/apps/papra-server/src/modules/documents/documents.usecases.ts+++ b/apps/papra-server/src/modules/documents/documents.usecases.ts@@ -368,26 +368,35 @@ export async function hardDeleteDocument({document,documentsRepository,documentsStorageService,+ eventServices,}: {- document: Pick<Document, 'id' | 'originalStorageKey'>;+ document: Pick<Document, 'id' | 'originalStorageKey' | 'organizationId'>;documentsRepository: DocumentsRepository;documentsStorageService: DocumentStorageService;+ eventServices: EventServices;}) {await Promise.all([documentsRepository.hardDeleteDocument({ documentId: document.id }),documentsStorageService.deleteFile({ storageKey: document.originalStorageKey }),]);++ eventServices.emitEvent({+ eventName: 'document.deleted',+ payload: { documentId: document.id, organizationId: document.organizationId },+ });}export async function deleteExpiredDocuments({documentsRepository,documentsStorageService,+ eventServices,config,now = new Date(),logger = createLogger({ namespace: 'documents:deleteExpiredDocuments' }),}: {documentsRepository: DocumentsRepository;documentsStorageService: DocumentStorageService;+ eventServices: EventServices;config: Config;now?: Date;logger?: Logger;@@ -401,7 +410,7 @@ export async function deleteExpiredDocuments({await Promise.all(documents.map(async document => limit(async () => {- const [, error] = await safely(hardDeleteDocument({ document, documentsRepository, documentsStorageService }));+ const [, error] = await safely(hardDeleteDocument({ document, documentsRepository, documentsStorageService, eventServices }));if (error) {logger.error({ document, error }, 'Error while deleting expired document');@@ -419,11 +428,13 @@ export async function deleteTrashDocument({organizationId,documentsRepository,documentsStorageService,+ eventServices,}: {documentId: string;organizationId: string;documentsRepository: DocumentsRepository;documentsStorageService: DocumentStorageService;+ eventServices: EventServices;}) {const { document } = await documentsRepository.getDocumentById({ documentId, organizationId });@@ -435,17 +446,19 @@ export async function deleteTrashDocument({throw createDocumentNotDeletedError();}- await hardDeleteDocument({ document, documentsRepository, documentsStorageService });+ await hardDeleteDocument({ document, documentsRepository, documentsStorageService, eventServices });}export async function deleteAllTrashDocuments({organizationId,documentsRepository,documentsStorageService,+ eventServices,}: {organizationId: string;documentsRepository: DocumentsRepository;documentsStorageService: DocumentStorageService;+ eventServices: EventServices;}) {const { documents } = await documentsRepository.getAllOrganizationTrashDocuments({ organizationId });@@ -454,7 +467,9 @@ export async function deleteAllTrashDocuments({const limit = pLimit(10);await Promise.all(- documents.map(async document => limit(async () => hardDeleteDocument({ document, documentsRepository, documentsStorageService }))),+ documents.map(async document => limit(async () => {+ await hardDeleteDocument({ document, documentsRepository, documentsStorageService, eventServices });+ })),);}diff --git a/apps/papra-server/src/modules/documents/tasks/hard-delete-expired-documents.task.ts b/apps/papra-server/src/modules/documents/tasks/hard-delete-expired-documents.task.tsindex 4f881d17..01a18c0a 100644--- a/apps/papra-server/src/modules/documents/tasks/hard-delete-expired-documents.task.ts+++ b/apps/papra-server/src/modules/documents/tasks/hard-delete-expired-documents.task.ts@@ -1,4 +1,5 @@import type { Database } from '../../app/database/database.types';+import type { EventServices } from '../../app/events/events.services';import type { Config } from '../../config/config.types';import type { TaskServices } from '../../tasks/tasks.services';import type { DocumentStorageService } from '../storage/documents.storage.services';@@ -8,7 +9,7 @@ import { deleteExpiredDocuments } from '../documents.usecases';const logger = createLogger({ namespace: 'documents:tasks:hardDeleteExpiredDocuments' });-export async function registerHardDeleteExpiredDocumentsTask({ taskServices, db, config, documentsStorageService }: { taskServices: TaskServices; db: Database; config: Config; documentsStorageService: DocumentStorageService }) {+export async function registerHardDeleteExpiredDocumentsTask({ taskServices, db, config, documentsStorageService, eventServices }: { taskServices: TaskServices; db: Database; config: Config; documentsStorageService: DocumentStorageService; eventServices: EventServices }) {const taskName = 'hard-delete-expired-documents';const { cron, runOnStartup } = config.tasks.hardDeleteExpiredDocuments;@@ -21,6 +22,7 @@ export async function registerHardDeleteExpiredDocumentsTask({ taskServices, db,config,documentsRepository,documentsStorageService,+ eventServices,});logger.info({ deletedDocumentsCount }, 'Expired documents deleted');