Skip to content

armgit / papra

Public Imported from GitHub
0

The minimalistic document archiving platform.

refactor(storage): replace generic error messages with specific file not found errors (#264)

Corentin Thomassetf613198cbd06
diff --git a/apps/papra-server/src/modules/documents/storage/document-storage.errors.ts b/apps/papra-server/src/modules/documents/storage/document-storage.errors.ts
new file mode 100644
index 00000000..ae21d4c4
--- /dev/null
+++ b/apps/papra-server/src/modules/documents/storage/document-storage.errors.ts
@@ -0,0 +1,7 @@
+import { createErrorFactory } from '../../shared/errors/errors';
+
+export const createFileNotFoundError = createErrorFactory({
+ message: 'File not found',
+ code: 'documents.storage.file_not_found',
+ statusCode: 404,
+});
diff --git a/apps/papra-server/src/modules/documents/storage/drivers/fs/fs.storage-driver.test.ts b/apps/papra-server/src/modules/documents/storage/drivers/fs/fs.storage-driver.test.ts
index 2d873c6a..a985fbe9 100644
--- a/apps/papra-server/src/modules/documents/storage/drivers/fs/fs.storage-driver.test.ts
+++ b/apps/papra-server/src/modules/documents/storage/drivers/fs/fs.storage-driver.test.ts
@@ -3,6 +3,7 @@ import fs from 'node:fs';
import { tmpdir } from 'node:os';
import path, { join } from 'node:path';
import { afterEach, beforeEach, describe, expect, test } from 'vitest';
+import { createFileNotFoundError } from '../../document-storage.errors';
import { fsStorageDriverFactory } from './fs.storage-driver';
import { createFileAlreadyExistsError } from './fs.storage-driver.errors';
@@ -114,7 +115,7 @@ describe('storage driver', () => {
const fsStorageDriver = await fsStorageDriverFactory({ config });
- await expect(fsStorageDriver.getFileStream({ storageKey: 'org_1/text-file.txt' })).rejects.toThrow('File not found');
+ await expect(fsStorageDriver.getFileStream({ storageKey: 'org_1/text-file.txt' })).rejects.toThrow(createFileNotFoundError());
});
});
@@ -162,7 +163,7 @@ describe('storage driver', () => {
const fsStorageDriver = await fsStorageDriverFactory({ config });
- await expect(fsStorageDriver.deleteFile({ storageKey: 'org_1/text-file.txt' })).rejects.toThrow('File not found');
+ await expect(fsStorageDriver.deleteFile({ storageKey: 'org_1/text-file.txt' })).rejects.toThrow(createFileNotFoundError());
});
});
});
diff --git a/apps/papra-server/src/modules/documents/storage/drivers/fs/fs.storage-driver.ts b/apps/papra-server/src/modules/documents/storage/drivers/fs/fs.storage-driver.ts
index c7cef015..9b3cda75 100644
--- a/apps/papra-server/src/modules/documents/storage/drivers/fs/fs.storage-driver.ts
+++ b/apps/papra-server/src/modules/documents/storage/drivers/fs/fs.storage-driver.ts
@@ -3,6 +3,7 @@ import { dirname, join } from 'node:path';
import stream from 'node:stream';
import { get } from 'lodash-es';
import { checkFileExists, deleteFile, ensureDirectoryExists } from '../../../../shared/fs/fs.services';
+import { createFileNotFoundError } from '../../document-storage.errors';
import { defineStorageDriver } from '../drivers.models';
import { createFileAlreadyExistsError } from './fs.storage-driver.errors';
@@ -47,7 +48,7 @@ export const fsStorageDriverFactory = defineStorageDriver(async ({ config }) =>
const fileExists = await checkFileExists({ path: storagePath });
if (!fileExists) {
- throw new Error('File not found');
+ throw createFileNotFoundError();
}
const readStream = fs.createReadStream(storagePath);
@@ -62,7 +63,7 @@ export const fsStorageDriverFactory = defineStorageDriver(async ({ config }) =>
await deleteFile({ filePath: storagePath });
} catch (error) {
if (get(error, 'code') === 'ENOENT') {
- throw new Error('File not found');
+ throw createFileNotFoundError();
}
throw error;
diff --git a/apps/papra-server/src/modules/documents/storage/drivers/memory/memory.storage-driver.test.ts b/apps/papra-server/src/modules/documents/storage/drivers/memory/memory.storage-driver.test.ts
index 367e1bd3..ed758998 100644
--- a/apps/papra-server/src/modules/documents/storage/drivers/memory/memory.storage-driver.test.ts
+++ b/apps/papra-server/src/modules/documents/storage/drivers/memory/memory.storage-driver.test.ts
@@ -1,4 +1,5 @@
import { describe, expect, test } from 'vitest';
+import { createFileNotFoundError } from '../../document-storage.errors';
import { inMemoryStorageDriverFactory } from './memory.storage-driver';
describe('memory storage-driver', () => {
@@ -25,7 +26,7 @@ describe('memory storage-driver', () => {
await inMemoryStorageDriver.deleteFile({ storageKey: 'org_1/text-file.txt' });
- await expect(inMemoryStorageDriver.getFileStream({ storageKey: 'org_1/text-file.txt' })).rejects.toThrow('File not found');
+ await expect(inMemoryStorageDriver.getFileStream({ storageKey: 'org_1/text-file.txt' })).rejects.toThrow(createFileNotFoundError());
});
test('mainly for testing purposes, a _getStorage() method is available to access the internal storage map', async () => {
diff --git a/apps/papra-server/src/modules/documents/storage/drivers/memory/memory.storage-driver.ts b/apps/papra-server/src/modules/documents/storage/drivers/memory/memory.storage-driver.ts
index e7b111eb..b8e84d2f 100644
--- a/apps/papra-server/src/modules/documents/storage/drivers/memory/memory.storage-driver.ts
+++ b/apps/papra-server/src/modules/documents/storage/drivers/memory/memory.storage-driver.ts
@@ -1,3 +1,4 @@
+import { createFileNotFoundError } from '../../document-storage.errors';
import { defineStorageDriver } from '../drivers.models';
export const IN_MEMORY_STORAGE_DRIVER_NAME = 'in-memory' as const;
@@ -18,7 +19,7 @@ export const inMemoryStorageDriverFactory = defineStorageDriver(async () => {
const fileEntry = storage.get(storageKey);
if (!fileEntry) {
- throw new Error('File not found');
+ throw createFileNotFoundError();
}
return {
diff --git a/apps/papra-server/src/modules/documents/storage/drivers/s3/s3.storage-driver.ts b/apps/papra-server/src/modules/documents/storage/drivers/s3/s3.storage-driver.ts
index d5f4fd8a..08f422e3 100644
--- a/apps/papra-server/src/modules/documents/storage/drivers/s3/s3.storage-driver.ts
+++ b/apps/papra-server/src/modules/documents/storage/drivers/s3/s3.storage-driver.ts
@@ -1,6 +1,7 @@
import { DeleteObjectCommand, GetObjectCommand, S3Client } from '@aws-sdk/client-s3';
import { Upload } from '@aws-sdk/lib-storage';
+import { createFileNotFoundError } from '../../document-storage.errors';
import { defineStorageDriver } from '../drivers.models';
export const S3_STORAGE_DRIVER_NAME = 's3' as const;
@@ -41,7 +42,7 @@ export const s3StorageDriverFactory = defineStorageDriver(async ({ config }) =>
}));
if (!Body) {
- throw new Error('File not found or has no content');
+ throw createFileNotFoundError();
}
return { fileStream: Body.transformToWebStream() };