Skip to content

armgit / papra

Public Imported from GitHub
0

The minimalistic document archiving platform.

feat(document-activity): add bulk activity logging support (#1063)

Corentin Thomassetbad01299481e
diff --git a/apps/papra-server/src/modules/documents/document-activity/document-activity.repository.ts b/apps/papra-server/src/modules/documents/document-activity/document-activity.repository.ts
index 97f791fb..eeb01eb8 100644
--- a/apps/papra-server/src/modules/documents/document-activity/document-activity.repository.ts
+++ b/apps/papra-server/src/modules/documents/document-activity/document-activity.repository.ts
@@ -10,10 +10,19 @@ import { documentActivityLogTable } from './document-activity.table';
export type DocumentActivityRepository = ReturnType<typeof createDocumentActivityRepository>;
+export type DocumentActivityInput = {
+ documentId: string;
+ event: DocumentActivityEvent;
+ eventData?: Record<string, unknown>;
+ userId?: string | null;
+ tagId?: string;
+};
+
export function createDocumentActivityRepository({ db }: { db: Database }) {
return injectArguments(
{
saveDocumentActivity,
+ saveDocumentActivities,
getOrganizationDocumentActivities,
},
{ db },
@@ -27,14 +36,7 @@ async function saveDocumentActivity({
userId,
tagId,
db,
-}: {
- documentId: string;
- event: DocumentActivityEvent;
- eventData?: Record<string, unknown>;
- userId?: string | null;
- tagId?: string;
- db: Database;
-}) {
+}: DocumentActivityInput & { db: Database }) {
const [activity] = await db
.insert(documentActivityLogTable)
.values({
@@ -49,6 +51,25 @@ async function saveDocumentActivity({
return { activity };
}
+async function saveDocumentActivities({
+ activities,
+ db,
+}: {
+ activities: DocumentActivityInput[];
+ db: Database;
+}) {
+ if (activities.length === 0) {
+ return { activities: [] };
+ }
+
+ const inserted = await db
+ .insert(documentActivityLogTable)
+ .values(activities)
+ .returning();
+
+ return { activities: inserted };
+}
+
async function getOrganizationDocumentActivities({
organizationId,
documentId,
diff --git a/apps/papra-server/src/modules/documents/document-activity/document-activity.usecases.test.ts b/apps/papra-server/src/modules/documents/document-activity/document-activity.usecases.test.ts
new file mode 100644
index 00000000..399e1215
--- /dev/null
+++ b/apps/papra-server/src/modules/documents/document-activity/document-activity.usecases.test.ts
@@ -0,0 +1,126 @@
+import { createNoopLogger } from '@crowlog/logger';
+import { describe, expect, test } from 'vitest';
+import { createInMemoryDatabase } from '../../app/database/database.test-utils';
+import { createDocumentActivityRepository } from './document-activity.repository';
+import { documentActivityLogTable } from './document-activity.table';
+import { registerDocumentActivityLog, registerDocumentsActivityLog } from './document-activity.usecases';
+
+describe('document-activity usecases', () => {
+ describe('registerDocumentActivityLog', () => {
+ test('inserts a single activity log entry for the given document', async () => {
+ const { db } = await createInMemoryDatabase({
+ users: [{ id: 'user-1', email: '[email protected]' }],
+ organizations: [{ id: 'org-1', name: 'Org 1' }],
+ documents: [{ id: 'doc-1', organizationId: 'org-1', name: 'Doc 1', originalName: 'Doc 1', originalStorageKey: 'doc-1', originalSha256Hash: 'doc-1', mimeType: 'text/plain' }],
+ });
+
+ const documentActivityRepository = createDocumentActivityRepository({ db });
+
+ await registerDocumentActivityLog({
+ documentId: 'doc-1',
+ event: 'updated',
+ userId: 'user-1',
+ eventData: { updatedFields: ['name'] },
+ documentActivityRepository,
+ logger: createNoopLogger(),
+ });
+
+ const rows = await db.select().from(documentActivityLogTable);
+
+ expect(rows).toHaveLength(1);
+ expect(rows[0]).toMatchObject({
+ documentId: 'doc-1',
+ event: 'updated',
+ userId: 'user-1',
+ eventData: { updatedFields: ['name'] },
+ });
+ });
+ });
+
+ describe('registerDocumentsActivityLog', () => {
+ test('inserts one activity log entry per input in a single bulk insert', async () => {
+ const { db } = await createInMemoryDatabase({
+ users: [{ id: 'user-1', email: '[email protected]' }],
+ organizations: [{ id: 'org-1', name: 'Org 1' }],
+ documents: [
+ { id: 'doc-1', organizationId: 'org-1', name: 'Doc 1', originalName: 'Doc 1', originalStorageKey: 'doc-1', originalSha256Hash: 'doc-1', mimeType: 'text/plain' },
+ { id: 'doc-2', organizationId: 'org-1', name: 'Doc 2', originalName: 'Doc 2', originalStorageKey: 'doc-2', originalSha256Hash: 'doc-2', mimeType: 'text/plain' },
+ { id: 'doc-3', organizationId: 'org-1', name: 'Doc 3', originalName: 'Doc 3', originalStorageKey: 'doc-3', originalSha256Hash: 'doc-3', mimeType: 'text/plain' },
+ ],
+ });
+
+ const documentActivityRepository = createDocumentActivityRepository({ db });
+
+ await registerDocumentsActivityLog({
+ activities: [
+ { documentId: 'doc-1', event: 'deleted', userId: 'user-1' },
+ { documentId: 'doc-2', event: 'deleted', userId: 'user-1' },
+ { documentId: 'doc-3', event: 'deleted', userId: 'user-1' },
+ ],
+ documentActivityRepository,
+ logger: createNoopLogger(),
+ });
+
+ const rows = await db.select().from(documentActivityLogTable);
+
+ expect(rows).toHaveLength(3);
+ expect(rows.map(row => row.documentId).sort()).toEqual(['doc-1', 'doc-2', 'doc-3']);
+ expect(rows.every(row => row.event === 'deleted' && row.userId === 'user-1')).toBe(true);
+ });
+
+ test('preserves per-entry differences in event, userId, and eventData', async () => {
+ const { db } = await createInMemoryDatabase({
+ users: [
+ { id: 'user-1', email: '[email protected]' },
+ { id: 'user-2', email: '[email protected]' },
+ ],
+ organizations: [{ id: 'org-1', name: 'Org 1' }],
+ documents: [
+ { id: 'doc-1', organizationId: 'org-1', name: 'Doc 1', originalName: 'Doc 1', originalStorageKey: 'doc-1', originalSha256Hash: 'doc-1', mimeType: 'text/plain' },
+ { id: 'doc-2', organizationId: 'org-1', name: 'Doc 2', originalName: 'Doc 2', originalStorageKey: 'doc-2', originalSha256Hash: 'doc-2', mimeType: 'text/plain' },
+ ],
+ });
+
+ const documentActivityRepository = createDocumentActivityRepository({ db });
+
+ await registerDocumentsActivityLog({
+ activities: [
+ { documentId: 'doc-1', event: 'updated', userId: 'user-1', eventData: { updatedFields: ['name'] } },
+ { documentId: 'doc-2', event: 'restored', userId: 'user-2' },
+ ],
+ documentActivityRepository,
+ logger: createNoopLogger(),
+ });
+
+ const rows = await db.select().from(documentActivityLogTable).orderBy(documentActivityLogTable.documentId);
+
+ expect(rows).toHaveLength(2);
+ expect(rows[0]).toMatchObject({
+ documentId: 'doc-1',
+ event: 'updated',
+ userId: 'user-1',
+ eventData: { updatedFields: ['name'] },
+ });
+ expect(rows[1]).toMatchObject({
+ documentId: 'doc-2',
+ event: 'restored',
+ userId: 'user-2',
+ eventData: null,
+ });
+ });
+
+ test('is a no-op when the activities array is empty', async () => {
+ const { db } = await createInMemoryDatabase();
+ const documentActivityRepository = createDocumentActivityRepository({ db });
+
+ await registerDocumentsActivityLog({
+ activities: [],
+ documentActivityRepository,
+ logger: createNoopLogger(),
+ });
+
+ const rows = await db.select().from(documentActivityLogTable);
+ expect(rows).toHaveLength(0);
+ });
+ });
+});
diff --git a/apps/papra-server/src/modules/documents/document-activity/document-activity.usecases.ts b/apps/papra-server/src/modules/documents/document-activity/document-activity.usecases.ts
index 3a801bea..f96b9e59 100644
--- a/apps/papra-server/src/modules/documents/document-activity/document-activity.usecases.ts
+++ b/apps/papra-server/src/modules/documents/document-activity/document-activity.usecases.ts
@@ -1,5 +1,5 @@
import type { Logger } from '@crowlog/logger';
-import type { DocumentActivityRepository } from './document-activity.repository';
+import type { DocumentActivityInput, DocumentActivityRepository } from './document-activity.repository';
import type { DocumentActivityEvent } from './document-activity.types';
import { createDeferable } from '../../shared/async/defer';
import { createLogger } from '../../shared/logger/logger';
@@ -38,4 +38,22 @@ export async function registerDocumentActivityLog({
}, 'Document activity log registered');
}
+export async function registerDocumentsActivityLog({
+ activities,
+ documentActivityRepository,
+ logger = createLogger({ namespace: 'document-activity-log' }),
+}: {
+ activities: DocumentActivityInput[];
+ documentActivityRepository: DocumentActivityRepository;
+ logger?: Logger;
+}) {
+ if (activities.length === 0) {
+ return;
+ }
+
+ await documentActivityRepository.saveDocumentActivities({ activities });
+
+ logger.info({ count: activities.length }, 'Document activity logs registered');
+}
+
export const deferRegisterDocumentActivityLog = createDeferable(registerDocumentActivityLog);