The minimalistic document archiving platform.
feat(documents): support bulk document trash operations (#1066)
Corentin Thomasset7a30e14c63ab
diff --git a/apps/papra-server/src/modules/app/events/events.handlers.ts b/apps/papra-server/src/modules/app/events/events.handlers.tsindex 97e9aa11..434d83cb 100644--- a/apps/papra-server/src/modules/app/events/events.handlers.ts+++ b/apps/papra-server/src/modules/app/events/events.handlers.ts@@ -7,12 +7,12 @@ import type { EventServices } from './events.services';import { registerSyncDocumentSearchEventHandlers } from '../../documents/document-search/events/sync-document-search.handlers';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 { registerInsertActivityLogOnDocumentsTrashedHandler } from '../../documents/events/activity-log.documents-trashed';import { registerTrackDocumentCreatedHandler } from '../../documents/events/tracking.document-created';import { registerTriggerWebhooksOnDocumentCreatedHandler } from '../../documents/events/webhooks.document-created';-import { registerTriggerWebhooksOnDocumentTrashedHandler } from '../../documents/events/webhooks.document-trashed';import { registerTriggerWebhooksOnDocumentUpdatedHandler } from '../../documents/events/webhooks.document-updated';+import { registerTriggerWebhooksOnDocumentsTrashedHandler } from '../../documents/events/webhooks.documents-trashed';import { registerFirstUserAdminEventHandler } from '../../roles/event-handlers/first-user-admin.user-created';import { registerTrackingUserCreatedEventHandler } from '../../users/event-handlers/tracking.user-created';@@ -22,8 +22,8 @@ export function registerEventHandlers(deps: { trackingServices: TrackingServicesregisterTriggerWebhooksOnDocumentCreatedHandler(deps);registerInsertActivityLogOnDocumentCreatedHandler(deps);registerTrackDocumentCreatedHandler(deps);- registerTriggerWebhooksOnDocumentTrashedHandler(deps);- registerInsertActivityLogOnDocumentTrashedHandler(deps);+ registerTriggerWebhooksOnDocumentsTrashedHandler(deps);+ registerInsertActivityLogOnDocumentsTrashedHandler(deps);registerInsertActivityLogOnDocumentRestoredHandler(deps);registerTriggerWebhooksOnDocumentUpdatedHandler(deps);registerInsertActivityLogOnDocumentUpdatedHandler(deps);diff --git a/apps/papra-server/src/modules/documents/document-search/events/sync-document-search.handlers.test.ts b/apps/papra-server/src/modules/documents/document-search/events/sync-document-search.handlers.test.tsindex 86b36ebf..31853029 100644--- a/apps/papra-server/src/modules/documents/document-search/events/sync-document-search.handlers.test.ts+++ b/apps/papra-server/src/modules/documents/document-search/events/sync-document-search.handlers.test.ts@@ -137,7 +137,7 @@ describe('sync-document-search event handlers', () => {});});- test('when document.trashed event fires, the document is marked as deleted in the search service', async () => {+ test('when documents.trashed event fires, the documents are marked as deleted in the search service', async () => {const eventServices = createEventServices({ logger: createNoopLogger() });const documentSearchServices = createTestSearchServices();@@ -145,9 +145,9 @@ describe('sync-document-search event handlers', () => {registerSyncDocumentSearchEventHandlers({ eventServices, documentSearchServices });eventServices.emitEvent({- eventName: 'document.trashed',+ eventName: 'documents.trashed',payload: {- documentId: 'doc-1',+ documentIds: ['doc-1'],organizationId: 'organization-1',trashedBy: 'user-1',},@@ -269,9 +269,9 @@ describe('sync-document-search event handlers', () => {});eventServices.emitEvent({- eventName: 'document.trashed',+ eventName: 'documents.trashed',payload: {- documentId: 'doc-1',+ documentIds: ['doc-1'],organizationId: 'organization-1',trashedBy: 'user-1',},diff --git a/apps/papra-server/src/modules/documents/document-search/events/sync-document-search.handlers.ts b/apps/papra-server/src/modules/documents/document-search/events/sync-document-search.handlers.tsindex fad6fff2..064c8056 100644--- a/apps/papra-server/src/modules/documents/document-search/events/sync-document-search.handlers.ts+++ b/apps/papra-server/src/modules/documents/document-search/events/sync-document-search.handlers.ts@@ -25,10 +25,10 @@ export function registerSyncDocumentSearchEventHandlers({ eventServices, documen});eventServices.onEvent({- eventName: 'document.trashed',- handlerName: 'mark-document-deleted-in-search-service',- async handler({ documentId }) {- await documentSearchServices.updateDocuments({ updates: [{ documentId, document: { isDeleted: true } }] });+ eventName: 'documents.trashed',+ handlerName: 'mark-documents-deleted-in-search-service',+ async handler({ documentIds }) {+ await documentSearchServices.updateDocuments({ updates: documentIds.map(documentId => ({ documentId, document: { isDeleted: true } })) });},});diff --git a/apps/papra-server/src/modules/documents/documents.events.types.ts b/apps/papra-server/src/modules/documents/documents.events.types.tsindex 07c28762..dff50949 100644--- a/apps/papra-server/src/modules/documents/documents.events.types.ts+++ b/apps/papra-server/src/modules/documents/documents.events.types.ts@@ -2,7 +2,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+ 'documents.trashed': { documentIds: string[]; organizationId: string; trashedBy: string }; // Soft deleted by moving to trash'document.restored': { documentId: string; organizationId: string; restoredBy: string };'document.updated': {userId?: string;diff --git a/apps/papra-server/src/modules/documents/documents.usecases.test.ts b/apps/papra-server/src/modules/documents/documents.usecases.test.tsindex 9f24903b..6f3a7f23 100644--- a/apps/papra-server/src/modules/documents/documents.usecases.test.ts+++ b/apps/papra-server/src/modules/documents/documents.usecases.test.ts@@ -761,7 +761,7 @@ describe('documents usecases', () => {});});- test('when a document is trashed, a "document.trashed" event is triggered', async () => {+ test('when a document is trashed, a "documents.trashed" event is triggered', async () => {const { db } = await createInMemoryDatabase({users: [{ id: 'user-1', email: '[email protected]' }],organizations: [{ id: 'organization-1', name: 'Organization 1' }],@@ -793,9 +793,9 @@ describe('documents usecases', () => {expect(emittedEvents.length).to.eql(1);const { eventName, payload } = emittedEvents[0]!;- expect(eventName).to.eql('document.trashed');+ expect(eventName).to.eql('documents.trashed');expect(payload).to.deep.include({- documentId: 'document-1',+ documentIds: ['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 3a125661..cd1be9a6 100644--- a/apps/papra-server/src/modules/documents/documents.usecases.ts+++ b/apps/papra-server/src/modules/documents/documents.usecases.ts@@ -568,8 +568,8 @@ export async function trashDocument({await documentsRepository.softDeleteDocument({ documentId, organizationId, userId });eventServices.emitEvent({- eventName: 'document.trashed',- payload: { documentId, organizationId, trashedBy: userId },+ eventName: 'documents.trashed',+ payload: { documentIds: [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.documents-trashed.tssimilarity index 54%rename from apps/papra-server/src/modules/documents/events/activity-log.document-trashed.tsrename to apps/papra-server/src/modules/documents/events/activity-log.documents-trashed.tsindex acb06728..b426707b 100644--- a/apps/papra-server/src/modules/documents/events/activity-log.document-trashed.ts+++ b/apps/papra-server/src/modules/documents/events/activity-log.documents-trashed.ts@@ -1,9 +1,9 @@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';+import { registerDocumentsActivityLog } from '../document-activity/document-activity.usecases';-export function registerInsertActivityLogOnDocumentTrashedHandler({+export function registerInsertActivityLogOnDocumentsTrashedHandler({eventServices,db,}: {@@ -13,13 +13,15 @@ export function registerInsertActivityLogOnDocumentTrashedHandler({const documentActivityRepository = createDocumentActivityRepository({ db });eventServices.onEvent({- eventName: 'document.trashed',+ eventName: 'documents.trashed',handlerName: 'insert-activity-log',- async handler({ documentId, trashedBy }) {- await registerDocumentActivityLog({- documentId,- event: 'deleted',- userId: trashedBy,+ async handler({ documentIds, trashedBy }) {+ await registerDocumentsActivityLog({+ activities: documentIds.map(documentId => ({+ documentId,+ event: 'deleted',+ userId: trashedBy,+ })),documentActivityRepository,});},diff --git a/apps/papra-server/src/modules/documents/events/webhooks.document-trashed.ts b/apps/papra-server/src/modules/documents/events/webhooks.document-trashed.tsdeleted file mode 100644index b2964097..00000000--- a/apps/papra-server/src/modules/documents/events/webhooks.document-trashed.ts+++ /dev/null@@ -1,25 +0,0 @@-import type { EventServices } from '../../app/events/events.services';-import type { WebhookTriggerServices } from '../../webhooks/webhooks.trigger.services';--export function registerTriggerWebhooksOnDocumentTrashedHandler({- eventServices,- webhookTriggerServices,-}: {- eventServices: EventServices;- webhookTriggerServices: WebhookTriggerServices;-}) {- eventServices.onEvent({- eventName: 'document.trashed',- handlerName: 'trigger-webhooks',- async handler({ documentId, organizationId }) {- await webhookTriggerServices.triggerWebhooks({- organizationId,- event: 'document:deleted',- payload: {- documentId,- organizationId,- },- });- },- });-}diff --git a/apps/papra-server/src/modules/documents/events/webhooks.documents-trashed.ts b/apps/papra-server/src/modules/documents/events/webhooks.documents-trashed.tsnew file mode 100644index 00000000..06451ddb--- /dev/null+++ b/apps/papra-server/src/modules/documents/events/webhooks.documents-trashed.ts@@ -0,0 +1,34 @@+import type { EventServices } from '../../app/events/events.services';+import type { WebhookTriggerServices } from '../../webhooks/webhooks.trigger.services';+import pLimit from 'p-limit';++export function registerTriggerWebhooksOnDocumentsTrashedHandler({+ eventServices,+ webhookTriggerServices,+}: {+ eventServices: EventServices;+ webhookTriggerServices: WebhookTriggerServices;+}) {+ eventServices.onEvent({+ eventName: 'documents.trashed',+ handlerName: 'trigger-webhooks',+ async handler({ documentIds, organizationId }) {+ const limit = pLimit(10);++ await Promise.all(+ documentIds.map(async documentId =>+ limit(async () =>+ webhookTriggerServices.triggerWebhooks({+ organizationId,+ event: 'document:deleted',+ payload: {+ documentId,+ organizationId,+ },+ }),+ ),+ ),+ );+ },+ });+}