arocapi 5.0.0-beta.2 → 5.0.0-beta.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +37 -824
- package/dist/app.d.ts +20 -7
- package/dist/app.js +42 -28
- package/dist/app.js.map +1 -1
- package/dist/app.test.js +41 -56
- package/dist/app.test.js.map +1 -1
- package/dist/errorHandling.test.d.ts +1 -0
- package/dist/errorHandling.test.js +222 -0
- package/dist/errorHandling.test.js.map +1 -0
- package/dist/index.dev.js +4 -3
- package/dist/index.dev.js.map +1 -1
- package/dist/routes/capabilities.test.js +8 -8
- package/dist/routes/capabilities.test.js.map +1 -1
- package/dist/routes/crate.test.js +67 -19
- package/dist/routes/crate.test.js.map +1 -1
- package/dist/routes/entities.d.ts +5 -2
- package/dist/routes/entities.js +31 -49
- package/dist/routes/entities.js.map +1 -1
- package/dist/routes/entities.test.js +16 -12
- package/dist/routes/entities.test.js.map +1 -1
- package/dist/routes/entity.d.ts +7 -2
- package/dist/routes/entity.js +14 -29
- package/dist/routes/entity.js.map +1 -1
- package/dist/routes/entity.test.js +19 -13
- package/dist/routes/entity.test.js.map +1 -1
- package/dist/routes/file.d.ts +6 -0
- package/dist/routes/file.js +67 -59
- package/dist/routes/file.js.map +1 -1
- package/dist/routes/file.test.js +135 -25
- package/dist/routes/file.test.js.map +1 -1
- package/dist/routes/files.d.ts +5 -2
- package/dist/routes/files.js +24 -39
- package/dist/routes/files.js.map +1 -1
- package/dist/routes/files.test.js +44 -21
- package/dist/routes/files.test.js.map +1 -1
- package/dist/routes/metadata.d.ts +6 -0
- package/dist/routes/metadata.js +49 -54
- package/dist/routes/metadata.js.map +1 -1
- package/dist/routes/search.d.ts +6 -2
- package/dist/routes/search.js +95 -99
- package/dist/routes/search.js.map +1 -1
- package/dist/routes/search.test.js +85 -39
- package/dist/routes/search.test.js.map +1 -1
- package/dist/test/helpers/fastify.js +2 -3
- package/dist/test/helpers/fastify.js.map +1 -1
- package/dist/test/integration.setup.d.ts +18 -0
- package/dist/test/integration.setup.js +15 -7
- package/dist/test/integration.setup.js.map +1 -1
- package/dist/test/integration.test.js +368 -2
- package/dist/test/integration.test.js.map +1 -1
- package/dist/transformers/default.d.ts +10 -18
- package/dist/transformers/default.js +41 -15
- package/dist/transformers/default.js.map +1 -1
- package/dist/transformers/default.test.js +109 -47
- package/dist/transformers/default.test.js.map +1 -1
- package/dist/transformers/transformer.test.js +12 -34
- package/dist/transformers/transformer.test.js.map +1 -1
- package/dist/types/access.d.ts +9 -0
- package/dist/types/access.js +2 -0
- package/dist/types/access.js.map +1 -0
- package/dist/types/context.d.ts +6 -0
- package/dist/types/context.js +2 -0
- package/dist/types/context.js.map +1 -0
- package/dist/types/fileHandlers.d.ts +5 -9
- package/dist/types/transformers.d.ts +4 -10
- package/dist/types/visibility.d.ts +5 -0
- package/dist/types/visibility.js +2 -0
- package/dist/types/visibility.js.map +1 -0
- package/dist/utils/access.d.ts +17 -0
- package/dist/utils/access.js +41 -0
- package/dist/utils/access.js.map +1 -0
- package/dist/utils/errors.d.ts +13 -4
- package/dist/utils/errors.js +44 -8
- package/dist/utils/errors.js.map +1 -1
- package/dist/utils/errors.test.js +14 -1
- package/dist/utils/errors.test.js.map +1 -1
- package/dist/utils/validation.d.ts +2 -0
- package/dist/utils/validation.js +8 -0
- package/dist/utils/validation.js.map +1 -0
- package/dist/utils/visibility.d.ts +18 -0
- package/dist/utils/visibility.js +16 -0
- package/dist/utils/visibility.js.map +1 -0
- package/package.json +6 -4
- package/src/app.test.ts +45 -66
- package/src/app.ts +85 -54
- package/src/errorHandling.test.ts +288 -0
- package/src/index.dev.ts +6 -4
- package/src/routes/__snapshots__/search.test.ts.snap +2 -2
- package/src/routes/capabilities.test.ts +8 -8
- package/src/routes/crate.test.ts +80 -19
- package/src/routes/entities.test.ts +16 -12
- package/src/routes/entities.ts +40 -59
- package/src/routes/entity.test.ts +19 -13
- package/src/routes/entity.ts +22 -35
- package/src/routes/file.test.ts +156 -25
- package/src/routes/file.ts +84 -62
- package/src/routes/files.test.ts +52 -26
- package/src/routes/files.ts +31 -47
- package/src/routes/metadata.ts +64 -58
- package/src/routes/search.test.ts +88 -39
- package/src/routes/search.ts +123 -119
- package/src/test/helpers/fastify.ts +2 -3
- package/src/test/integration.setup.ts +18 -7
- package/src/test/integration.test.ts +472 -1
- package/src/transformers/default.test.ts +139 -47
- package/src/transformers/default.ts +103 -83
- package/src/transformers/transformer.test.ts +18 -44
- package/src/types/access.ts +20 -0
- package/src/types/context.ts +15 -0
- package/src/types/fileHandlers.ts +5 -13
- package/src/types/transformers.ts +4 -32
- package/src/types/visibility.ts +18 -0
- package/src/utils/access.ts +80 -0
- package/src/utils/errors.test.ts +16 -1
- package/src/utils/errors.ts +67 -10
- package/src/utils/validation.ts +11 -0
- package/src/utils/visibility.ts +56 -0
package/src/routes/file.test.ts
CHANGED
|
@@ -2,8 +2,11 @@ import { createReadStream } from 'node:fs';
|
|
|
2
2
|
import { Readable } from 'node:stream';
|
|
3
3
|
import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';
|
|
4
4
|
import { fastify, fastifyAfter, fastifyBefore, prisma } from '../test/helpers/fastify.js';
|
|
5
|
+
import type { AccessFunction } from '../types/access.js';
|
|
5
6
|
import type { FileHandler, FileResult } from '../types/fileHandlers.js';
|
|
7
|
+
import { AllPublicAccess } from '../utils/access.js';
|
|
6
8
|
import type { StandardErrorResponse } from '../utils/errors.js';
|
|
9
|
+
import { AllVisibleEntityFilter } from '../utils/visibility.js';
|
|
7
10
|
import fileRoute from './file.js';
|
|
8
11
|
|
|
9
12
|
vi.mock('node:fs', () => ({
|
|
@@ -15,11 +18,20 @@ describe('File Route', () => {
|
|
|
15
18
|
get: vi.fn(),
|
|
16
19
|
head: vi.fn(),
|
|
17
20
|
};
|
|
21
|
+
const mockAccess = vi.fn<AccessFunction>();
|
|
18
22
|
|
|
19
23
|
beforeEach(async () => {
|
|
20
24
|
await fastifyBefore();
|
|
21
|
-
await fastify.register(fileRoute, {
|
|
25
|
+
await fastify.register(fileRoute, {
|
|
26
|
+
access: mockAccess,
|
|
27
|
+
entityVisibilityFilter: AllVisibleEntityFilter,
|
|
28
|
+
refusal: { promptLoginForHidden: false },
|
|
29
|
+
prisma,
|
|
30
|
+
fileHandler: mockFileHandler,
|
|
31
|
+
});
|
|
22
32
|
vi.clearAllMocks();
|
|
33
|
+
mockAccess.mockImplementation(AllPublicAccess);
|
|
34
|
+
prisma.entity.findMany.mockResolvedValue([]);
|
|
23
35
|
});
|
|
24
36
|
|
|
25
37
|
afterEach(async () => {
|
|
@@ -34,11 +46,25 @@ describe('File Route', () => {
|
|
|
34
46
|
meta: { storagePath: '/data/files/test.wav' },
|
|
35
47
|
createdAt: new Date(),
|
|
36
48
|
updatedAt: new Date(),
|
|
49
|
+
entity: {
|
|
50
|
+
id: 'http://example.com/file/test.wav',
|
|
51
|
+
name: 'test.wav',
|
|
52
|
+
description: 'A test file',
|
|
53
|
+
entityType: 'http://schema.org/MediaObject',
|
|
54
|
+
memberOf: 'http://example.com/object',
|
|
55
|
+
rootCollection: 'http://example.com/collection',
|
|
56
|
+
metadataLicenseId: 'https://creativecommons.org/licenses/by/4.0/',
|
|
57
|
+
contentLicenseId: 'https://example.com/licence/restricted',
|
|
58
|
+
meta: {},
|
|
59
|
+
createdAt: new Date(),
|
|
60
|
+
updatedAt: new Date(),
|
|
61
|
+
},
|
|
37
62
|
};
|
|
63
|
+
const { entity: _entity, ...handlerFile } = mockFile;
|
|
38
64
|
|
|
39
65
|
describe('GET /file/:id', () => {
|
|
40
66
|
it('should stream file content successfully', async () => {
|
|
41
|
-
prisma.file.
|
|
67
|
+
prisma.file.findFirst.mockResolvedValue(mockFile);
|
|
42
68
|
|
|
43
69
|
const mockStream = Readable.from(['test file content']);
|
|
44
70
|
const mockResult: FileResult = {
|
|
@@ -62,11 +88,11 @@ describe('File Route', () => {
|
|
|
62
88
|
expect(response.headers['content-type']).toBe('audio/wav');
|
|
63
89
|
expect(response.headers['content-length']).toBe('17');
|
|
64
90
|
expect(response.headers.etag).toBe('"abc123"');
|
|
65
|
-
expect(response.headers['content-disposition']).toBe('inline; filename=
|
|
91
|
+
expect(response.headers['content-disposition']).toBe('inline; filename=test.wav');
|
|
66
92
|
expect(response.body).toBe('test file content');
|
|
67
93
|
|
|
68
94
|
expect(mockFileHandler.get).toHaveBeenCalledWith(
|
|
69
|
-
|
|
95
|
+
handlerFile,
|
|
70
96
|
expect.objectContaining({
|
|
71
97
|
request: expect.any(Object),
|
|
72
98
|
fastify: expect.any(Object),
|
|
@@ -75,7 +101,7 @@ describe('File Route', () => {
|
|
|
75
101
|
});
|
|
76
102
|
|
|
77
103
|
it('should handle attachment disposition', async () => {
|
|
78
|
-
prisma.file.
|
|
104
|
+
prisma.file.findFirst.mockResolvedValue(mockFile);
|
|
79
105
|
|
|
80
106
|
const mockStream = Readable.from(['test']);
|
|
81
107
|
const mockResult: FileResult = {
|
|
@@ -94,11 +120,11 @@ describe('File Route', () => {
|
|
|
94
120
|
});
|
|
95
121
|
|
|
96
122
|
expect(response.statusCode).toBe(200);
|
|
97
|
-
expect(response.headers['content-disposition']).toBe('attachment; filename=
|
|
123
|
+
expect(response.headers['content-disposition']).toBe('attachment; filename=test.wav');
|
|
98
124
|
});
|
|
99
125
|
|
|
100
126
|
it('should use custom filename when provided', async () => {
|
|
101
|
-
prisma.file.
|
|
127
|
+
prisma.file.findFirst.mockResolvedValue(mockFile);
|
|
102
128
|
|
|
103
129
|
const mockStream = Readable.from(['test']);
|
|
104
130
|
const mockResult: FileResult = {
|
|
@@ -117,11 +143,47 @@ describe('File Route', () => {
|
|
|
117
143
|
});
|
|
118
144
|
|
|
119
145
|
expect(response.statusCode).toBe(200);
|
|
120
|
-
expect(response.headers['content-disposition']).toBe('inline; filename=
|
|
146
|
+
expect(response.headers['content-disposition']).toBe('inline; filename=custom-name.wav');
|
|
147
|
+
});
|
|
148
|
+
|
|
149
|
+
it.each([
|
|
150
|
+
{
|
|
151
|
+
name: 'a non-Latin stored filename',
|
|
152
|
+
stored: 'ŋaŋa.wav',
|
|
153
|
+
query: '',
|
|
154
|
+
expected: `inline; filename="?a?a.wav"; filename*=UTF-8''%C5%8Ba%C5%8Ba.wav`,
|
|
155
|
+
},
|
|
156
|
+
{
|
|
157
|
+
name: 'quotes in a custom filename',
|
|
158
|
+
stored: 'test.wav',
|
|
159
|
+
query: `?filename=${encodeURIComponent(`a"; filename*=UTF-8''evil.html`)}`,
|
|
160
|
+
expected: `inline; filename="a\\"; filename*=UTF-8''evil.html"`,
|
|
161
|
+
},
|
|
162
|
+
{
|
|
163
|
+
name: 'backslashes in a stored filename',
|
|
164
|
+
stored: 'back\\slash.wav',
|
|
165
|
+
query: '',
|
|
166
|
+
expected: 'inline; filename="back\\\\slash.wav"',
|
|
167
|
+
},
|
|
168
|
+
])('should encode $name', async ({ stored, query, expected }) => {
|
|
169
|
+
prisma.file.findFirst.mockResolvedValue({ ...mockFile, filename: stored });
|
|
170
|
+
vi.mocked(mockFileHandler.get).mockResolvedValue({
|
|
171
|
+
type: 'stream',
|
|
172
|
+
stream: Readable.from(['test']),
|
|
173
|
+
metadata: { contentType: 'audio/wav', contentLength: 4 },
|
|
174
|
+
});
|
|
175
|
+
|
|
176
|
+
const response = await fastify.inject({
|
|
177
|
+
method: 'GET',
|
|
178
|
+
url: `/file/${encodeURIComponent('http://example.com/file/test.wav')}${query}`,
|
|
179
|
+
});
|
|
180
|
+
|
|
181
|
+
expect(response.statusCode).toBe(200);
|
|
182
|
+
expect(response.headers['content-disposition']).toBe(expected);
|
|
121
183
|
});
|
|
122
184
|
|
|
123
185
|
it('should handle redirect response with noRedirect=false (default)', async () => {
|
|
124
|
-
prisma.file.
|
|
186
|
+
prisma.file.findFirst.mockResolvedValue(mockFile);
|
|
125
187
|
|
|
126
188
|
const mockResult: FileResult = {
|
|
127
189
|
type: 'redirect',
|
|
@@ -139,7 +201,7 @@ describe('File Route', () => {
|
|
|
139
201
|
});
|
|
140
202
|
|
|
141
203
|
it('should handle redirect response with noRedirect=true', async () => {
|
|
142
|
-
prisma.file.
|
|
204
|
+
prisma.file.findFirst.mockResolvedValue(mockFile);
|
|
143
205
|
|
|
144
206
|
const mockResult: FileResult = {
|
|
145
207
|
type: 'redirect',
|
|
@@ -158,7 +220,7 @@ describe('File Route', () => {
|
|
|
158
220
|
});
|
|
159
221
|
|
|
160
222
|
it('should handle file path response without nginx X-Accel-Redirect', async () => {
|
|
161
|
-
prisma.file.
|
|
223
|
+
prisma.file.findFirst.mockResolvedValue(mockFile);
|
|
162
224
|
|
|
163
225
|
const mockStream = Readable.from(['file content']);
|
|
164
226
|
vi.mocked(createReadStream).mockReturnValue(mockStream as never);
|
|
@@ -186,7 +248,7 @@ describe('File Route', () => {
|
|
|
186
248
|
});
|
|
187
249
|
|
|
188
250
|
it('should handle file path response with nginx X-Accel-Redirect', async () => {
|
|
189
|
-
prisma.file.
|
|
251
|
+
prisma.file.findFirst.mockResolvedValue(mockFile);
|
|
190
252
|
|
|
191
253
|
const mockResult: FileResult = {
|
|
192
254
|
type: 'file',
|
|
@@ -214,7 +276,7 @@ describe('File Route', () => {
|
|
|
214
276
|
});
|
|
215
277
|
|
|
216
278
|
it('should return 404 when entity not found', async () => {
|
|
217
|
-
prisma.file.
|
|
279
|
+
prisma.file.findFirst.mockResolvedValue(null);
|
|
218
280
|
|
|
219
281
|
const response = await fastify.inject({
|
|
220
282
|
method: 'GET',
|
|
@@ -229,7 +291,7 @@ describe('File Route', () => {
|
|
|
229
291
|
});
|
|
230
292
|
|
|
231
293
|
it('should return 500 when database error occurs', async () => {
|
|
232
|
-
prisma.file.
|
|
294
|
+
prisma.file.findFirst.mockRejectedValue(new Error('Database connection failed'));
|
|
233
295
|
|
|
234
296
|
const response = await fastify.inject({
|
|
235
297
|
method: 'GET',
|
|
@@ -241,8 +303,62 @@ describe('File Route', () => {
|
|
|
241
303
|
expect(body.error.code).toBe('INTERNAL_ERROR');
|
|
242
304
|
});
|
|
243
305
|
|
|
306
|
+
it('should decide access on the file entity without looking up its parents', async () => {
|
|
307
|
+
prisma.file.findFirst.mockResolvedValue(mockFile);
|
|
308
|
+
vi.mocked(mockFileHandler.get).mockResolvedValue({ type: 'redirect', url: 'https://example.com/test.wav' });
|
|
309
|
+
|
|
310
|
+
await fastify.inject({
|
|
311
|
+
method: 'GET',
|
|
312
|
+
url: `/file/${encodeURIComponent('http://example.com/file/test.wav')}`,
|
|
313
|
+
});
|
|
314
|
+
|
|
315
|
+
expect(prisma.file.findFirst).toHaveBeenCalledWith(
|
|
316
|
+
expect.objectContaining({ include: { entity: { omit: { meta: true } } } }),
|
|
317
|
+
);
|
|
318
|
+
expect(mockAccess).toHaveBeenCalledWith(
|
|
319
|
+
expect.objectContaining({
|
|
320
|
+
id: 'http://example.com/file/test.wav',
|
|
321
|
+
contentLicenseId: 'https://example.com/licence/restricted',
|
|
322
|
+
memberOf: 'http://example.com/object',
|
|
323
|
+
rootCollection: 'http://example.com/collection',
|
|
324
|
+
}),
|
|
325
|
+
expect.objectContaining({ request: expect.any(Object), fastify: expect.any(Object) }),
|
|
326
|
+
);
|
|
327
|
+
expect(prisma.entity.findMany).not.toHaveBeenCalled();
|
|
328
|
+
});
|
|
329
|
+
|
|
330
|
+
it('should return 403 when the content is not accessible', async () => {
|
|
331
|
+
prisma.file.findFirst.mockResolvedValue(mockFile);
|
|
332
|
+
mockAccess.mockReturnValue({ metadata: true, content: false });
|
|
333
|
+
|
|
334
|
+
const response = await fastify.inject({
|
|
335
|
+
method: 'GET',
|
|
336
|
+
url: `/file/${encodeURIComponent('http://example.com/file/test.wav')}`,
|
|
337
|
+
});
|
|
338
|
+
const body = JSON.parse(response.body) as { error: { code: string; message: string } };
|
|
339
|
+
|
|
340
|
+
expect(response.statusCode).toBe(403);
|
|
341
|
+
expect(body.error.code).toBe('FORBIDDEN');
|
|
342
|
+
expect(body.error.message).toBe('You do not have permission to access this resource');
|
|
343
|
+
expect(mockFileHandler.get).not.toHaveBeenCalled();
|
|
344
|
+
});
|
|
345
|
+
|
|
346
|
+
it('should serve the content when only the metadata is not accessible', async () => {
|
|
347
|
+
prisma.file.findFirst.mockResolvedValue(mockFile);
|
|
348
|
+
mockAccess.mockReturnValue({ metadata: false, content: true });
|
|
349
|
+
vi.mocked(mockFileHandler.get).mockResolvedValue({ type: 'redirect', url: 'https://example.com/test.wav' });
|
|
350
|
+
|
|
351
|
+
const response = await fastify.inject({
|
|
352
|
+
method: 'GET',
|
|
353
|
+
url: `/file/${encodeURIComponent('http://example.com/file/test.wav')}`,
|
|
354
|
+
});
|
|
355
|
+
|
|
356
|
+
expect(response.statusCode).toBe(302);
|
|
357
|
+
expect(mockFileHandler.get).toHaveBeenCalled();
|
|
358
|
+
});
|
|
359
|
+
|
|
244
360
|
it('should return 500 when fileHandler throws error', async () => {
|
|
245
|
-
prisma.file.
|
|
361
|
+
prisma.file.findFirst.mockResolvedValue(mockFile);
|
|
246
362
|
vi.mocked(mockFileHandler.get).mockRejectedValue(new Error('File not found in storage'));
|
|
247
363
|
|
|
248
364
|
const response = await fastify.inject({
|
|
@@ -263,11 +379,11 @@ describe('File Route', () => {
|
|
|
263
379
|
const body = JSON.parse(response.body) as StandardErrorResponse;
|
|
264
380
|
|
|
265
381
|
expect(response.statusCode).toBe(400);
|
|
266
|
-
expect(body.error).toBe('
|
|
382
|
+
expect(body.error.code).toBe('VALIDATION_ERROR');
|
|
267
383
|
});
|
|
268
384
|
|
|
269
385
|
it('should validate disposition parameter', async () => {
|
|
270
|
-
prisma.file.
|
|
386
|
+
prisma.file.findFirst.mockResolvedValue(mockFile);
|
|
271
387
|
|
|
272
388
|
const response = await fastify.inject({
|
|
273
389
|
method: 'GET',
|
|
@@ -276,11 +392,11 @@ describe('File Route', () => {
|
|
|
276
392
|
const body = JSON.parse(response.body) as StandardErrorResponse;
|
|
277
393
|
|
|
278
394
|
expect(response.statusCode).toBe(400);
|
|
279
|
-
expect(body.error).toBe('
|
|
395
|
+
expect(body.error.code).toBe('VALIDATION_ERROR');
|
|
280
396
|
});
|
|
281
397
|
|
|
282
398
|
it('should return 404 when get handler returns false', async () => {
|
|
283
|
-
prisma.file.
|
|
399
|
+
prisma.file.findFirst.mockResolvedValue(mockFile);
|
|
284
400
|
vi.mocked(mockFileHandler.get).mockResolvedValue(false);
|
|
285
401
|
|
|
286
402
|
const response = await fastify.inject({
|
|
@@ -297,7 +413,7 @@ describe('File Route', () => {
|
|
|
297
413
|
|
|
298
414
|
describe('HEAD /file/:id', () => {
|
|
299
415
|
it('should return headers without body using head handler', async () => {
|
|
300
|
-
prisma.file.
|
|
416
|
+
prisma.file.findFirst.mockResolvedValue(mockFile);
|
|
301
417
|
|
|
302
418
|
const mockMetadata = {
|
|
303
419
|
contentType: 'audio/wav',
|
|
@@ -319,7 +435,7 @@ describe('File Route', () => {
|
|
|
319
435
|
expect(response.body).toBe(''); // No body for HEAD
|
|
320
436
|
|
|
321
437
|
expect(mockFileHandler.head).toHaveBeenCalledWith(
|
|
322
|
-
|
|
438
|
+
handlerFile,
|
|
323
439
|
expect.objectContaining({
|
|
324
440
|
request: expect.any(Object),
|
|
325
441
|
fastify: expect.any(Object),
|
|
@@ -328,7 +444,7 @@ describe('File Route', () => {
|
|
|
328
444
|
});
|
|
329
445
|
|
|
330
446
|
it('should return 404 when file not found', async () => {
|
|
331
|
-
prisma.file.
|
|
447
|
+
prisma.file.findFirst.mockResolvedValue(null);
|
|
332
448
|
|
|
333
449
|
const response = await fastify.inject({
|
|
334
450
|
method: 'HEAD',
|
|
@@ -341,8 +457,21 @@ describe('File Route', () => {
|
|
|
341
457
|
expect(mockFileHandler.get).not.toHaveBeenCalled();
|
|
342
458
|
});
|
|
343
459
|
|
|
460
|
+
it('should return 403 when the content is not accessible', async () => {
|
|
461
|
+
prisma.file.findFirst.mockResolvedValue(mockFile);
|
|
462
|
+
mockAccess.mockReturnValue({ metadata: true, content: false });
|
|
463
|
+
|
|
464
|
+
const response = await fastify.inject({
|
|
465
|
+
method: 'HEAD',
|
|
466
|
+
url: `/file/${encodeURIComponent('http://example.com/file/test.wav')}`,
|
|
467
|
+
});
|
|
468
|
+
|
|
469
|
+
expect(response.statusCode).toBe(403);
|
|
470
|
+
expect(mockFileHandler.head).not.toHaveBeenCalled();
|
|
471
|
+
});
|
|
472
|
+
|
|
344
473
|
it('should return 500 when head handler throws error', async () => {
|
|
345
|
-
prisma.file.
|
|
474
|
+
prisma.file.findFirst.mockResolvedValue(mockFile);
|
|
346
475
|
vi.mocked(mockFileHandler.head).mockRejectedValue(new Error('Failed to get metadata'));
|
|
347
476
|
|
|
348
477
|
const response = await fastify.inject({
|
|
@@ -356,7 +485,7 @@ describe('File Route', () => {
|
|
|
356
485
|
});
|
|
357
486
|
|
|
358
487
|
it('should return 404 when head handler returns false', async () => {
|
|
359
|
-
prisma.file.
|
|
488
|
+
prisma.file.findFirst.mockResolvedValue(mockFile);
|
|
360
489
|
vi.mocked(mockFileHandler.head).mockResolvedValue(false);
|
|
361
490
|
|
|
362
491
|
const response = await fastify.inject({
|
|
@@ -373,7 +502,7 @@ describe('File Route', () => {
|
|
|
373
502
|
|
|
374
503
|
describe('GET /file/:id - exhaustiveness check', () => {
|
|
375
504
|
it('should handle unexpected file result type', async () => {
|
|
376
|
-
prisma.file.
|
|
505
|
+
prisma.file.findFirst.mockResolvedValue(mockFile);
|
|
377
506
|
|
|
378
507
|
// Mock an invalid result type to test exhaustiveness check
|
|
379
508
|
const invalidResult = {
|
|
@@ -390,6 +519,8 @@ describe('File Route', () => {
|
|
|
390
519
|
|
|
391
520
|
expect(response.statusCode).toBe(500);
|
|
392
521
|
expect(body.error.code).toBe('INTERNAL_ERROR');
|
|
522
|
+
expect(response.headers['content-disposition']).toBeUndefined();
|
|
523
|
+
expect(response.headers['content-type']).toContain('application/json');
|
|
393
524
|
});
|
|
394
525
|
});
|
|
395
526
|
});
|
package/src/routes/file.ts
CHANGED
|
@@ -1,11 +1,17 @@
|
|
|
1
1
|
import { createReadStream } from 'node:fs';
|
|
2
|
+
import { create as contentDisposition } from 'content-disposition';
|
|
2
3
|
import type { FastifyPluginAsync } from 'fastify';
|
|
3
4
|
import type { ZodTypeProvider } from 'fastify-type-provider-zod';
|
|
4
5
|
import { z } from 'zod';
|
|
5
6
|
import type { PrismaClient } from '../generated/prisma/client.js';
|
|
7
|
+
import type { AccessFunction } from '../types/access.js';
|
|
8
|
+
import type { RequestContext } from '../types/context.js';
|
|
6
9
|
import type { FileHandler, FileMetadata } from '../types/fileHandlers.js';
|
|
7
|
-
import {
|
|
10
|
+
import type { EntityVisibilityFilter } from '../types/visibility.js';
|
|
11
|
+
import { createAccessGuard } from '../utils/access.js';
|
|
12
|
+
import { createNotFoundError } from '../utils/errors.js';
|
|
8
13
|
import { setFileHeaders } from '../utils/headers.js';
|
|
14
|
+
import { createNotVisibleResponder, type RefusalOptions } from '../utils/visibility.js';
|
|
9
15
|
|
|
10
16
|
const paramsSchema = z.object({
|
|
11
17
|
id: z.url(),
|
|
@@ -20,10 +26,36 @@ const querySchema = z.object({
|
|
|
20
26
|
type FileRouteOptions = {
|
|
21
27
|
prisma: PrismaClient;
|
|
22
28
|
fileHandler: FileHandler;
|
|
29
|
+
access: AccessFunction;
|
|
30
|
+
entityVisibilityFilter: EntityVisibilityFilter;
|
|
31
|
+
refusal: RefusalOptions;
|
|
23
32
|
};
|
|
24
33
|
|
|
25
34
|
const file: FastifyPluginAsync<FileRouteOptions> = async (fastify, opts) => {
|
|
26
|
-
const { prisma, fileHandler } = opts;
|
|
35
|
+
const { prisma, fileHandler, access, entityVisibilityFilter, refusal } = opts;
|
|
36
|
+
|
|
37
|
+
// Split the entity off so handlers receive only the File they're typed for
|
|
38
|
+
const findVisibleFile = async (id: string, context: RequestContext) => {
|
|
39
|
+
const found = await prisma.file.findFirst({
|
|
40
|
+
where: { id, entity: await entityVisibilityFilter(context) },
|
|
41
|
+
include: { entity: { omit: { meta: true } } },
|
|
42
|
+
});
|
|
43
|
+
if (!found) {
|
|
44
|
+
return null;
|
|
45
|
+
}
|
|
46
|
+
|
|
47
|
+
const { entity, ...file } = found;
|
|
48
|
+
|
|
49
|
+
return { file, entity };
|
|
50
|
+
};
|
|
51
|
+
|
|
52
|
+
const denyContent = createAccessGuard({ access, isAuthenticated: refusal.isAuthenticated, level: 'content' });
|
|
53
|
+
|
|
54
|
+
const sendFileNotVisible = createNotVisibleResponder({
|
|
55
|
+
...refusal,
|
|
56
|
+
notFoundMessage: 'The requested file was not found',
|
|
57
|
+
exists: async (id) => (await prisma.file.count({ where: { id } })) > 0,
|
|
58
|
+
});
|
|
27
59
|
|
|
28
60
|
fastify.withTypeProvider<ZodTypeProvider>().head(
|
|
29
61
|
'/file/:id',
|
|
@@ -35,30 +67,27 @@ const file: FastifyPluginAsync<FileRouteOptions> = async (fastify, opts) => {
|
|
|
35
67
|
async (request, reply) => {
|
|
36
68
|
const { id } = request.params;
|
|
37
69
|
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
where: { id },
|
|
41
|
-
});
|
|
70
|
+
const context = { request, fastify };
|
|
71
|
+
const visible = await findVisibleFile(id, context);
|
|
42
72
|
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
73
|
+
if (!visible) {
|
|
74
|
+
return sendFileNotVisible(reply, id, context);
|
|
75
|
+
}
|
|
46
76
|
|
|
47
|
-
|
|
77
|
+
const { file, entity } = visible;
|
|
78
|
+
if (await denyContent(reply, entity, context)) {
|
|
79
|
+
return reply;
|
|
80
|
+
}
|
|
48
81
|
|
|
49
|
-
|
|
50
|
-
return reply.code(404).send(createNotFoundError('The requested file metadata was not found', id));
|
|
51
|
-
}
|
|
82
|
+
const metadata: FileMetadata | false = await fileHandler.head(file, context);
|
|
52
83
|
|
|
53
|
-
|
|
84
|
+
if (!metadata) {
|
|
85
|
+
return reply.code(404).send(createNotFoundError('The requested file metadata was not found', id));
|
|
86
|
+
}
|
|
54
87
|
|
|
55
|
-
|
|
56
|
-
} catch (error) {
|
|
57
|
-
const err = error as Error;
|
|
58
|
-
fastify.log.error(`File metadata retrieval error: ${err.message}`);
|
|
88
|
+
setFileHeaders(reply, metadata);
|
|
59
89
|
|
|
60
|
-
|
|
61
|
-
}
|
|
90
|
+
return reply.code(200).send();
|
|
62
91
|
},
|
|
63
92
|
);
|
|
64
93
|
|
|
@@ -73,61 +102,54 @@ const file: FastifyPluginAsync<FileRouteOptions> = async (fastify, opts) => {
|
|
|
73
102
|
async (request, reply) => {
|
|
74
103
|
const { id } = request.params;
|
|
75
104
|
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
where: { id },
|
|
79
|
-
});
|
|
105
|
+
const context = { request, fastify };
|
|
106
|
+
const visible = await findVisibleFile(id, context);
|
|
80
107
|
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
108
|
+
if (!visible) {
|
|
109
|
+
return sendFileNotVisible(reply, id, context);
|
|
110
|
+
}
|
|
84
111
|
|
|
85
|
-
|
|
112
|
+
const { file, entity } = visible;
|
|
113
|
+
if (await denyContent(reply, entity, context)) {
|
|
114
|
+
return reply;
|
|
115
|
+
}
|
|
86
116
|
|
|
87
|
-
|
|
88
|
-
return reply.code(404).send(createNotFoundError('The requested file could not be retrieved', id));
|
|
89
|
-
}
|
|
117
|
+
const result = await fileHandler.get(file, context);
|
|
90
118
|
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
}
|
|
119
|
+
if (!result) {
|
|
120
|
+
return reply.code(404).send(createNotFoundError('The requested file could not be retrieved', id));
|
|
121
|
+
}
|
|
95
122
|
|
|
96
|
-
|
|
123
|
+
if (result.type === 'redirect') {
|
|
124
|
+
if (request.query.noRedirect) {
|
|
125
|
+
return reply.code(200).send({ location: result.url });
|
|
97
126
|
}
|
|
98
127
|
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
setFileHeaders(reply, result.metadata);
|
|
102
|
-
reply.header('Content-Disposition', `${disposition}; filename="${filename}"`);
|
|
128
|
+
return reply.code(302).redirect(result.url);
|
|
129
|
+
}
|
|
103
130
|
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
}
|
|
131
|
+
const { disposition, filename: customFilename } = request.query;
|
|
132
|
+
setFileHeaders(reply, result.metadata);
|
|
133
|
+
reply.header('Content-Disposition', contentDisposition(customFilename || file.filename, { type: disposition }));
|
|
108
134
|
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
}
|
|
135
|
+
// Handle stream response
|
|
136
|
+
if (result.type === 'stream') {
|
|
137
|
+
return reply.code(200).send(result.stream);
|
|
138
|
+
}
|
|
114
139
|
|
|
115
|
-
|
|
116
|
-
|
|
140
|
+
if (result.type === 'file') {
|
|
141
|
+
if (result.accelPath) {
|
|
142
|
+
reply.header('X-Accel-Redirect', result.accelPath);
|
|
143
|
+
return reply.code(200).send();
|
|
117
144
|
}
|
|
118
145
|
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
reply.removeHeader('Content-Disposition');
|
|
122
|
-
reply.removeHeader('Content-Type');
|
|
123
|
-
reply.removeHeader('Content-Length');
|
|
124
|
-
return reply.code(500).send(createInternalError());
|
|
125
|
-
} catch (error) {
|
|
126
|
-
const err = error as Error;
|
|
127
|
-
fastify.log.error(`File retrieval error: ${err}`);
|
|
128
|
-
|
|
129
|
-
return reply.code(500).send(createInternalError());
|
|
146
|
+
const stream = createReadStream(result.path);
|
|
147
|
+
return reply.code(200).send(stream);
|
|
130
148
|
}
|
|
149
|
+
|
|
150
|
+
// Exhaustiveness check - should never reach here with proper types
|
|
151
|
+
reply.removeHeader('Content-Disposition');
|
|
152
|
+
throw new Error(`Unexpected file result type: ${(result as { type: string }).type}`);
|
|
131
153
|
},
|
|
132
154
|
);
|
|
133
155
|
};
|