arocapi 5.0.0-beta.1 → 5.0.0-beta.3
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 -802
- package/dist/app.d.ts +22 -9
- package/dist/app.js +46 -30
- 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.d.ts +7 -0
- package/dist/routes/capabilities.js +13 -0
- package/dist/routes/capabilities.js.map +1 -0
- package/dist/routes/capabilities.test.d.ts +1 -0
- package/dist/routes/capabilities.test.js +81 -0
- package/dist/routes/capabilities.test.js.map +1 -0
- 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 +99 -22
- 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 +8 -5
- package/dist/routes/search.js +95 -101
- package/dist/routes/search.js.map +1 -1
- package/dist/routes/search.test.js +92 -39
- package/dist/routes/search.test.js.map +1 -1
- package/dist/test/helpers/fastify.d.ts +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 +19 -1
- 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 +19 -10
- 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/queryBuilder.d.ts +12 -0
- package/dist/utils/queryBuilder.js +9 -0
- package/dist/utils/queryBuilder.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 +34 -33
- package/src/app.test.ts +45 -66
- package/src/app.ts +92 -58
- package/src/errorHandling.test.ts +288 -0
- package/src/index.dev.ts +6 -4
- package/src/routes/__snapshots__/capabilities.test.ts.snap +34 -0
- package/src/routes/__snapshots__/search.test.ts.snap +2 -2
- package/src/routes/capabilities.test.ts +102 -0
- package/src/routes/capabilities.ts +22 -0
- 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 +117 -22
- 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 +95 -39
- package/src/routes/search.ts +120 -125
- 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 +68 -11
- package/src/utils/queryBuilder.ts +25 -0
- package/src/utils/validation.ts +11 -0
- package/src/utils/visibility.ts +56 -0
package/src/routes/file.ts
CHANGED
|
@@ -3,9 +3,14 @@ import type { FastifyPluginAsync } from 'fastify';
|
|
|
3
3
|
import type { ZodTypeProvider } from 'fastify-type-provider-zod';
|
|
4
4
|
import { z } from 'zod';
|
|
5
5
|
import type { PrismaClient } from '../generated/prisma/client.js';
|
|
6
|
+
import type { AccessFunction } from '../types/access.js';
|
|
7
|
+
import type { RequestContext } from '../types/context.js';
|
|
6
8
|
import type { FileHandler, FileMetadata } from '../types/fileHandlers.js';
|
|
7
|
-
import {
|
|
9
|
+
import type { EntityVisibilityFilter } from '../types/visibility.js';
|
|
10
|
+
import { createAccessGuard } from '../utils/access.js';
|
|
11
|
+
import { createNotFoundError } from '../utils/errors.js';
|
|
8
12
|
import { setFileHeaders } from '../utils/headers.js';
|
|
13
|
+
import { createNotVisibleResponder, type RefusalOptions } from '../utils/visibility.js';
|
|
9
14
|
|
|
10
15
|
const paramsSchema = z.object({
|
|
11
16
|
id: z.url(),
|
|
@@ -20,10 +25,36 @@ const querySchema = z.object({
|
|
|
20
25
|
type FileRouteOptions = {
|
|
21
26
|
prisma: PrismaClient;
|
|
22
27
|
fileHandler: FileHandler;
|
|
28
|
+
access: AccessFunction;
|
|
29
|
+
entityVisibilityFilter: EntityVisibilityFilter;
|
|
30
|
+
refusal: RefusalOptions;
|
|
23
31
|
};
|
|
24
32
|
|
|
25
33
|
const file: FastifyPluginAsync<FileRouteOptions> = async (fastify, opts) => {
|
|
26
|
-
const { prisma, fileHandler } = opts;
|
|
34
|
+
const { prisma, fileHandler, access, entityVisibilityFilter, refusal } = opts;
|
|
35
|
+
|
|
36
|
+
// Split the entity off so handlers receive only the File they're typed for
|
|
37
|
+
const findVisibleFile = async (id: string, context: RequestContext) => {
|
|
38
|
+
const found = await prisma.file.findFirst({
|
|
39
|
+
where: { id, entity: await entityVisibilityFilter(context) },
|
|
40
|
+
include: { entity: { omit: { meta: true } } },
|
|
41
|
+
});
|
|
42
|
+
if (!found) {
|
|
43
|
+
return null;
|
|
44
|
+
}
|
|
45
|
+
|
|
46
|
+
const { entity, ...file } = found;
|
|
47
|
+
|
|
48
|
+
return { file, entity };
|
|
49
|
+
};
|
|
50
|
+
|
|
51
|
+
const denyContent = createAccessGuard({ access, isAuthenticated: refusal.isAuthenticated, level: 'content' });
|
|
52
|
+
|
|
53
|
+
const sendFileNotVisible = createNotVisibleResponder({
|
|
54
|
+
...refusal,
|
|
55
|
+
notFoundMessage: 'The requested file was not found',
|
|
56
|
+
exists: async (id) => (await prisma.file.count({ where: { id } })) > 0,
|
|
57
|
+
});
|
|
27
58
|
|
|
28
59
|
fastify.withTypeProvider<ZodTypeProvider>().head(
|
|
29
60
|
'/file/:id',
|
|
@@ -35,30 +66,27 @@ const file: FastifyPluginAsync<FileRouteOptions> = async (fastify, opts) => {
|
|
|
35
66
|
async (request, reply) => {
|
|
36
67
|
const { id } = request.params;
|
|
37
68
|
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
where: { id },
|
|
41
|
-
});
|
|
69
|
+
const context = { request, fastify };
|
|
70
|
+
const visible = await findVisibleFile(id, context);
|
|
42
71
|
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
72
|
+
if (!visible) {
|
|
73
|
+
return sendFileNotVisible(reply, id, context);
|
|
74
|
+
}
|
|
46
75
|
|
|
47
|
-
|
|
76
|
+
const { file, entity } = visible;
|
|
77
|
+
if (await denyContent(reply, entity, context)) {
|
|
78
|
+
return reply;
|
|
79
|
+
}
|
|
48
80
|
|
|
49
|
-
|
|
50
|
-
return reply.code(404).send(createNotFoundError('The requested file metadata was not found', id));
|
|
51
|
-
}
|
|
81
|
+
const metadata: FileMetadata | false = await fileHandler.head(file, context);
|
|
52
82
|
|
|
53
|
-
|
|
83
|
+
if (!metadata) {
|
|
84
|
+
return reply.code(404).send(createNotFoundError('The requested file metadata was not found', id));
|
|
85
|
+
}
|
|
54
86
|
|
|
55
|
-
|
|
56
|
-
} catch (error) {
|
|
57
|
-
const err = error as Error;
|
|
58
|
-
fastify.log.error(`File metadata retrieval error: ${err.message}`);
|
|
87
|
+
setFileHeaders(reply, metadata);
|
|
59
88
|
|
|
60
|
-
|
|
61
|
-
}
|
|
89
|
+
return reply.code(200).send();
|
|
62
90
|
},
|
|
63
91
|
);
|
|
64
92
|
|
|
@@ -73,61 +101,55 @@ const file: FastifyPluginAsync<FileRouteOptions> = async (fastify, opts) => {
|
|
|
73
101
|
async (request, reply) => {
|
|
74
102
|
const { id } = request.params;
|
|
75
103
|
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
where: { id },
|
|
79
|
-
});
|
|
104
|
+
const context = { request, fastify };
|
|
105
|
+
const visible = await findVisibleFile(id, context);
|
|
80
106
|
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
107
|
+
if (!visible) {
|
|
108
|
+
return sendFileNotVisible(reply, id, context);
|
|
109
|
+
}
|
|
84
110
|
|
|
85
|
-
|
|
111
|
+
const { file, entity } = visible;
|
|
112
|
+
if (await denyContent(reply, entity, context)) {
|
|
113
|
+
return reply;
|
|
114
|
+
}
|
|
86
115
|
|
|
87
|
-
|
|
88
|
-
return reply.code(404).send(createNotFoundError('The requested file could not be retrieved', id));
|
|
89
|
-
}
|
|
116
|
+
const result = await fileHandler.get(file, context);
|
|
90
117
|
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
}
|
|
118
|
+
if (!result) {
|
|
119
|
+
return reply.code(404).send(createNotFoundError('The requested file could not be retrieved', id));
|
|
120
|
+
}
|
|
95
121
|
|
|
96
|
-
|
|
122
|
+
if (result.type === 'redirect') {
|
|
123
|
+
if (request.query.noRedirect) {
|
|
124
|
+
return reply.code(200).send({ location: result.url });
|
|
97
125
|
}
|
|
98
126
|
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
setFileHeaders(reply, result.metadata);
|
|
102
|
-
reply.header('Content-Disposition', `${disposition}; filename="${filename}"`);
|
|
127
|
+
return reply.code(302).redirect(result.url);
|
|
128
|
+
}
|
|
103
129
|
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
130
|
+
const { disposition, filename: customFilename } = request.query;
|
|
131
|
+
const filename = customFilename || file.filename;
|
|
132
|
+
setFileHeaders(reply, result.metadata);
|
|
133
|
+
reply.header('Content-Disposition', `${disposition}; filename="${filename}"`);
|
|
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
|
};
|
package/src/routes/files.test.ts
CHANGED
|
@@ -1,14 +1,33 @@
|
|
|
1
1
|
import { afterEach, beforeEach, describe, expect, it } from 'vitest';
|
|
2
|
-
import type {
|
|
2
|
+
import type { AccessFunction, FileTransformer } from '../app.js';
|
|
3
3
|
import { fastify, fastifyAfter, fastifyBefore, prisma } from '../test/helpers/fastify.js';
|
|
4
|
-
import {
|
|
4
|
+
import { AllPublicAccess } from '../utils/access.js';
|
|
5
5
|
import type { StandardErrorResponse } from '../utils/errors.js';
|
|
6
|
+
import { AllVisibleEntityFilter } from '../utils/visibility.js';
|
|
6
7
|
import filesRoute from './files.js';
|
|
7
8
|
|
|
8
9
|
describe('Files Route', () => {
|
|
10
|
+
const mockEntity = (id: string, name: string) => ({
|
|
11
|
+
id,
|
|
12
|
+
name,
|
|
13
|
+
description: '',
|
|
14
|
+
entityType: 'http://schema.org/MediaObject',
|
|
15
|
+
memberOf: null,
|
|
16
|
+
rootCollection: null,
|
|
17
|
+
metadataLicenseId: 'https://creativecommons.org/licenses/by/4.0/',
|
|
18
|
+
contentLicenseId: 'https://creativecommons.org/licenses/by/4.0/',
|
|
19
|
+
meta: {},
|
|
20
|
+
createdAt: new Date('2025-01-01'),
|
|
21
|
+
updatedAt: new Date('2025-01-01'),
|
|
22
|
+
});
|
|
23
|
+
|
|
9
24
|
beforeEach(async () => {
|
|
10
25
|
await fastifyBefore();
|
|
11
|
-
await fastify.register(filesRoute, {
|
|
26
|
+
await fastify.register(filesRoute, {
|
|
27
|
+
entityVisibilityFilter: AllVisibleEntityFilter,
|
|
28
|
+
prisma,
|
|
29
|
+
access: AllPublicAccess,
|
|
30
|
+
});
|
|
12
31
|
});
|
|
13
32
|
|
|
14
33
|
afterEach(async () => {
|
|
@@ -23,6 +42,7 @@ describe('Files Route', () => {
|
|
|
23
42
|
meta: {},
|
|
24
43
|
createdAt: new Date('2025-01-01'),
|
|
25
44
|
updatedAt: new Date('2025-01-01'),
|
|
45
|
+
entity: mockEntity('http://example.com/file1.wav', 'file1.wav'),
|
|
26
46
|
};
|
|
27
47
|
|
|
28
48
|
const mockFile2 = {
|
|
@@ -33,6 +53,7 @@ describe('Files Route', () => {
|
|
|
33
53
|
meta: {},
|
|
34
54
|
createdAt: new Date('2025-01-02'),
|
|
35
55
|
updatedAt: new Date('2025-01-02'),
|
|
56
|
+
entity: mockEntity('http://example.com/file2.txt', 'file2.txt'),
|
|
36
57
|
};
|
|
37
58
|
|
|
38
59
|
describe('GET /files', () => {
|
|
@@ -58,6 +79,9 @@ describe('Files Route', () => {
|
|
|
58
79
|
content: true,
|
|
59
80
|
},
|
|
60
81
|
});
|
|
82
|
+
expect(prisma.file.findMany).toHaveBeenCalledWith(
|
|
83
|
+
expect.objectContaining({ include: { entity: { omit: { meta: true } } } }),
|
|
84
|
+
);
|
|
61
85
|
});
|
|
62
86
|
|
|
63
87
|
it('should filter files by memberOf', async () => {
|
|
@@ -79,7 +103,7 @@ describe('Files Route', () => {
|
|
|
79
103
|
});
|
|
80
104
|
expect(prisma.file.findMany).toHaveBeenCalledWith(
|
|
81
105
|
expect.objectContaining({
|
|
82
|
-
where: { entity: { memberOf: 'http://example.com/collection/1' } },
|
|
106
|
+
where: { entity: { AND: [{ memberOf: 'http://example.com/collection/1' }, {}] } },
|
|
83
107
|
}),
|
|
84
108
|
);
|
|
85
109
|
});
|
|
@@ -175,7 +199,7 @@ describe('Files Route', () => {
|
|
|
175
199
|
const body = JSON.parse(response.body) as StandardErrorResponse;
|
|
176
200
|
|
|
177
201
|
expect(response.statusCode).toBe(400);
|
|
178
|
-
expect(body.error).toBe('
|
|
202
|
+
expect(body.error.code).toBe('VALIDATION_ERROR');
|
|
179
203
|
});
|
|
180
204
|
|
|
181
205
|
it('should validate memberOf parameter format', async () => {
|
|
@@ -186,7 +210,7 @@ describe('Files Route', () => {
|
|
|
186
210
|
const body = JSON.parse(response.body) as StandardErrorResponse;
|
|
187
211
|
|
|
188
212
|
expect(response.statusCode).toBe(400);
|
|
189
|
-
expect(body.error).toBe('
|
|
213
|
+
expect(body.error.code).toBe('VALIDATION_ERROR');
|
|
190
214
|
});
|
|
191
215
|
|
|
192
216
|
it('should validate sort parameter', async () => {
|
|
@@ -197,7 +221,7 @@ describe('Files Route', () => {
|
|
|
197
221
|
const body = JSON.parse(response.body) as StandardErrorResponse;
|
|
198
222
|
|
|
199
223
|
expect(response.statusCode).toBe(400);
|
|
200
|
-
expect(body.error).toBe('
|
|
224
|
+
expect(body.error.code).toBe('VALIDATION_ERROR');
|
|
201
225
|
});
|
|
202
226
|
});
|
|
203
227
|
|
|
@@ -213,8 +237,9 @@ describe('Files Route', () => {
|
|
|
213
237
|
});
|
|
214
238
|
|
|
215
239
|
await fastify.register(filesRoute, {
|
|
240
|
+
entityVisibilityFilter: AllVisibleEntityFilter,
|
|
216
241
|
prisma,
|
|
217
|
-
|
|
242
|
+
access: AllPublicAccess,
|
|
218
243
|
fileTransformers: [customTransformer],
|
|
219
244
|
});
|
|
220
245
|
|
|
@@ -238,25 +263,27 @@ describe('Files Route', () => {
|
|
|
238
263
|
await fastifyAfter();
|
|
239
264
|
});
|
|
240
265
|
|
|
241
|
-
it('should
|
|
266
|
+
it('should attach the content access of each file entity', async () => {
|
|
242
267
|
await fastifyBefore();
|
|
243
268
|
|
|
244
|
-
|
|
245
|
-
|
|
246
|
-
|
|
247
|
-
|
|
248
|
-
|
|
249
|
-
|
|
250
|
-
|
|
251
|
-
|
|
269
|
+
const access: AccessFunction = (entity) =>
|
|
270
|
+
entity.id === 'http://example.com/file1.wav'
|
|
271
|
+
? {
|
|
272
|
+
metadata: false,
|
|
273
|
+
content: false,
|
|
274
|
+
metadataAuthorizationUrl: 'https://example.com/request-metadata',
|
|
275
|
+
contentAuthorizationUrl: 'https://example.com/request-access',
|
|
276
|
+
}
|
|
277
|
+
: { metadata: true, content: true };
|
|
252
278
|
|
|
253
279
|
await fastify.register(filesRoute, {
|
|
280
|
+
entityVisibilityFilter: AllVisibleEntityFilter,
|
|
254
281
|
prisma,
|
|
255
|
-
|
|
282
|
+
access,
|
|
256
283
|
});
|
|
257
284
|
|
|
258
|
-
prisma.file.findMany.mockResolvedValue([mockFile1]);
|
|
259
|
-
prisma.file.count.mockResolvedValue(
|
|
285
|
+
prisma.file.findMany.mockResolvedValue([mockFile1, mockFile2]);
|
|
286
|
+
prisma.file.count.mockResolvedValue(2);
|
|
260
287
|
|
|
261
288
|
const response = await fastify.inject({
|
|
262
289
|
method: 'GET',
|
|
@@ -264,13 +291,12 @@ describe('Files Route', () => {
|
|
|
264
291
|
});
|
|
265
292
|
|
|
266
293
|
expect(response.statusCode).toBe(200);
|
|
267
|
-
const body = JSON.parse(response.body) as { files: unknown
|
|
268
|
-
expect(body.files[0]).
|
|
269
|
-
|
|
270
|
-
|
|
271
|
-
contentAuthorizationUrl: 'https://example.com/request-access',
|
|
272
|
-
},
|
|
294
|
+
const body = JSON.parse(response.body) as { files: Array<{ access: unknown }> };
|
|
295
|
+
expect(body.files[0].access).toEqual({
|
|
296
|
+
content: false,
|
|
297
|
+
contentAuthorizationUrl: 'https://example.com/request-access',
|
|
273
298
|
});
|
|
299
|
+
expect(body.files[1].access).toEqual({ content: true });
|
|
274
300
|
|
|
275
301
|
await fastifyAfter();
|
|
276
302
|
});
|
package/src/routes/files.ts
CHANGED
|
@@ -2,9 +2,10 @@ import type { FastifyPluginAsync } from 'fastify';
|
|
|
2
2
|
import type { ZodTypeProvider } from 'fastify-type-provider-zod';
|
|
3
3
|
import { z } from 'zod';
|
|
4
4
|
import type { PrismaClient } from '../generated/prisma/client.js';
|
|
5
|
-
import {
|
|
6
|
-
import type {
|
|
7
|
-
import {
|
|
5
|
+
import { applyTransformers, authoriseFiles } from '../transformers/default.js';
|
|
6
|
+
import type { AccessFunction } from '../types/access.js';
|
|
7
|
+
import type { FileTransformer } from '../types/transformers.js';
|
|
8
|
+
import type { EntityVisibilityFilter } from '../types/visibility.js';
|
|
8
9
|
|
|
9
10
|
const querySchema = z.object({
|
|
10
11
|
memberOf: z.url().optional(),
|
|
@@ -16,12 +17,13 @@ const querySchema = z.object({
|
|
|
16
17
|
|
|
17
18
|
type FilesRouteOptions = {
|
|
18
19
|
prisma: PrismaClient;
|
|
19
|
-
|
|
20
|
+
access: AccessFunction;
|
|
20
21
|
fileTransformers?: FileTransformer[];
|
|
22
|
+
entityVisibilityFilter: EntityVisibilityFilter;
|
|
21
23
|
};
|
|
22
24
|
|
|
23
25
|
const files: FastifyPluginAsync<FilesRouteOptions> = async (fastify, opts) => {
|
|
24
|
-
const { prisma,
|
|
26
|
+
const { prisma, access, fileTransformers = [], entityVisibilityFilter } = opts;
|
|
25
27
|
|
|
26
28
|
fastify.withTypeProvider<ZodTypeProvider>().get(
|
|
27
29
|
'/files',
|
|
@@ -30,53 +32,35 @@ const files: FastifyPluginAsync<FilesRouteOptions> = async (fastify, opts) => {
|
|
|
30
32
|
querystring: querySchema,
|
|
31
33
|
},
|
|
32
34
|
},
|
|
33
|
-
async (request
|
|
35
|
+
async (request) => {
|
|
34
36
|
const { memberOf, limit, offset, sort, order } = request.query;
|
|
35
37
|
|
|
36
|
-
|
|
37
|
-
|
|
38
|
+
const context = { request, fastify };
|
|
39
|
+
const visibilityWhere = await entityVisibilityFilter(context);
|
|
40
|
+
const where = { entity: { AND: [{ memberOf }, visibilityWhere] } };
|
|
38
41
|
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
+
const [dbFiles, total] = await Promise.all([
|
|
43
|
+
prisma.file.findMany({
|
|
44
|
+
where,
|
|
45
|
+
include: { entity: { omit: { meta: true } } },
|
|
46
|
+
orderBy: {
|
|
47
|
+
[sort]: order,
|
|
48
|
+
},
|
|
49
|
+
skip: offset,
|
|
50
|
+
take: limit,
|
|
51
|
+
}),
|
|
52
|
+
prisma.file.count({ where }),
|
|
53
|
+
]);
|
|
42
54
|
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
[sort]: order,
|
|
48
|
-
},
|
|
49
|
-
skip: offset,
|
|
50
|
-
take: limit,
|
|
51
|
-
}),
|
|
52
|
-
prisma.file.count({ where }),
|
|
53
|
-
]);
|
|
55
|
+
const authorisedFiles = await authoriseFiles(dbFiles, access, context);
|
|
56
|
+
const filesWithAccess = await Promise.all(
|
|
57
|
+
authorisedFiles.map((file) => applyTransformers(file, fileTransformers, context)),
|
|
58
|
+
);
|
|
54
59
|
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
const authorisedFile = await fileAccessTransformer(standardFile, { request, fastify });
|
|
60
|
-
|
|
61
|
-
let result = authorisedFile;
|
|
62
|
-
for (const transformer of fileTransformers) {
|
|
63
|
-
result = await transformer(result, { request, fastify });
|
|
64
|
-
}
|
|
65
|
-
|
|
66
|
-
return result;
|
|
67
|
-
}),
|
|
68
|
-
);
|
|
69
|
-
|
|
70
|
-
return {
|
|
71
|
-
total,
|
|
72
|
-
files: filesWithAccess,
|
|
73
|
-
};
|
|
74
|
-
} catch (error) {
|
|
75
|
-
const err = error as Error;
|
|
76
|
-
fastify.log.error(`Database error: ${err.message}`);
|
|
77
|
-
|
|
78
|
-
return reply.code(500).send(createInternalError());
|
|
79
|
-
}
|
|
60
|
+
return {
|
|
61
|
+
total,
|
|
62
|
+
files: filesWithAccess,
|
|
63
|
+
};
|
|
80
64
|
},
|
|
81
65
|
);
|
|
82
66
|
};
|
package/src/routes/metadata.ts
CHANGED
|
@@ -3,9 +3,14 @@ import type { FastifyPluginAsync } from 'fastify';
|
|
|
3
3
|
import type { ZodTypeProvider } from 'fastify-type-provider-zod';
|
|
4
4
|
import { z } from 'zod';
|
|
5
5
|
import type { PrismaClient } from '../generated/prisma/client.js';
|
|
6
|
+
import type { AccessFunction } from '../types/access.js';
|
|
7
|
+
import type { RequestContext } from '../types/context.js';
|
|
6
8
|
import type { FileMetadata, RoCrateHandler } from '../types/fileHandlers.js';
|
|
7
|
-
import {
|
|
9
|
+
import type { EntityVisibilityFilter } from '../types/visibility.js';
|
|
10
|
+
import { createAccessGuard } from '../utils/access.js';
|
|
11
|
+
import { createNotFoundError } from '../utils/errors.js';
|
|
8
12
|
import { setFileHeaders } from '../utils/headers.js';
|
|
13
|
+
import { createEntityNotVisibleResponder, type RefusalOptions } from '../utils/visibility.js';
|
|
9
14
|
|
|
10
15
|
const paramsSchema = z.object({
|
|
11
16
|
id: z.url(),
|
|
@@ -14,10 +19,19 @@ const paramsSchema = z.object({
|
|
|
14
19
|
type CrateRouteOptions = {
|
|
15
20
|
prisma: PrismaClient;
|
|
16
21
|
roCrateHandler: RoCrateHandler;
|
|
22
|
+
access: AccessFunction;
|
|
23
|
+
entityVisibilityFilter: EntityVisibilityFilter;
|
|
24
|
+
refusal: RefusalOptions;
|
|
17
25
|
};
|
|
18
26
|
|
|
19
27
|
const crate: FastifyPluginAsync<CrateRouteOptions> = async (fastify, opts) => {
|
|
20
|
-
const { prisma, roCrateHandler } = opts;
|
|
28
|
+
const { prisma, roCrateHandler, access, entityVisibilityFilter, refusal } = opts;
|
|
29
|
+
|
|
30
|
+
const findVisibleEntity = async (id: string, context: RequestContext) =>
|
|
31
|
+
prisma.entity.findFirst({ where: { AND: [{ id }, await entityVisibilityFilter(context)] } });
|
|
32
|
+
|
|
33
|
+
const sendEntityNotVisible = createEntityNotVisibleResponder(prisma, refusal);
|
|
34
|
+
const denyMetadata = createAccessGuard({ access, isAuthenticated: refusal.isAuthenticated, level: 'metadata' });
|
|
21
35
|
|
|
22
36
|
fastify.withTypeProvider<ZodTypeProvider>().head(
|
|
23
37
|
'/entity/:id/metadata',
|
|
@@ -29,30 +43,26 @@ const crate: FastifyPluginAsync<CrateRouteOptions> = async (fastify, opts) => {
|
|
|
29
43
|
async (request, reply) => {
|
|
30
44
|
const { id } = request.params;
|
|
31
45
|
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
where: { id },
|
|
35
|
-
});
|
|
46
|
+
const context = { request, fastify };
|
|
47
|
+
const entity = await findVisibleEntity(id, context);
|
|
36
48
|
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
49
|
+
if (!entity) {
|
|
50
|
+
return sendEntityNotVisible(reply, id, context);
|
|
51
|
+
}
|
|
40
52
|
|
|
41
|
-
|
|
53
|
+
if (await denyMetadata(reply, entity, context)) {
|
|
54
|
+
return reply;
|
|
55
|
+
}
|
|
42
56
|
|
|
43
|
-
|
|
44
|
-
return reply.code(404).send(createNotFoundError('The requested RO-Crate metadata was not found', id));
|
|
45
|
-
}
|
|
57
|
+
const metadata: FileMetadata | false = await roCrateHandler.head(entity, context);
|
|
46
58
|
|
|
47
|
-
|
|
59
|
+
if (!metadata) {
|
|
60
|
+
return reply.code(404).send(createNotFoundError('The requested RO-Crate metadata was not found', id));
|
|
61
|
+
}
|
|
48
62
|
|
|
49
|
-
|
|
50
|
-
} catch (error) {
|
|
51
|
-
const err = error as Error;
|
|
52
|
-
fastify.log.error(`RO-Crate metadata retrieval error: ${err}`);
|
|
63
|
+
setFileHeaders(reply, metadata);
|
|
53
64
|
|
|
54
|
-
|
|
55
|
-
}
|
|
65
|
+
return reply.code(200).send();
|
|
56
66
|
},
|
|
57
67
|
);
|
|
58
68
|
|
|
@@ -66,56 +76,52 @@ const crate: FastifyPluginAsync<CrateRouteOptions> = async (fastify, opts) => {
|
|
|
66
76
|
async (request, reply) => {
|
|
67
77
|
const { id } = request.params;
|
|
68
78
|
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
where: { id },
|
|
72
|
-
});
|
|
79
|
+
const context = { request, fastify };
|
|
80
|
+
const entity = await findVisibleEntity(id, context);
|
|
73
81
|
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
82
|
+
if (!entity) {
|
|
83
|
+
return sendEntityNotVisible(reply, id, context);
|
|
84
|
+
}
|
|
77
85
|
|
|
78
|
-
|
|
86
|
+
if (await denyMetadata(reply, entity, context)) {
|
|
87
|
+
return reply;
|
|
88
|
+
}
|
|
79
89
|
|
|
80
|
-
|
|
81
|
-
return reply.code(404).send(createNotFoundError('The requested RO-Crate could not be retrieved', id));
|
|
82
|
-
}
|
|
90
|
+
const result = await roCrateHandler.get(entity, context);
|
|
83
91
|
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
92
|
+
if (!result) {
|
|
93
|
+
return reply.code(404).send(createNotFoundError('The requested RO-Crate could not be retrieved', id));
|
|
94
|
+
}
|
|
87
95
|
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
contentType: 'application/ld+json',
|
|
92
|
-
};
|
|
96
|
+
if (result.type === 'redirect') {
|
|
97
|
+
return reply.code(302).redirect(result.url);
|
|
98
|
+
}
|
|
93
99
|
|
|
94
|
-
|
|
100
|
+
// Set content type to application/ld+json for RO-Crate
|
|
101
|
+
const metadata = {
|
|
102
|
+
...result.metadata,
|
|
103
|
+
contentType: 'application/ld+json',
|
|
104
|
+
};
|
|
95
105
|
|
|
96
|
-
|
|
97
|
-
if (result.type === 'stream') {
|
|
98
|
-
return reply.code(200).send(result.stream);
|
|
99
|
-
}
|
|
106
|
+
setFileHeaders(reply, metadata);
|
|
100
107
|
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
}
|
|
108
|
+
// Handle stream response
|
|
109
|
+
if (result.type === 'stream') {
|
|
110
|
+
return reply.code(200).send(result.stream);
|
|
111
|
+
}
|
|
106
112
|
|
|
107
|
-
|
|
108
|
-
|
|
113
|
+
if (result.type === 'file') {
|
|
114
|
+
if (result.accelPath) {
|
|
115
|
+
reply.header('X-Accel-Redirect', result.accelPath);
|
|
116
|
+
return reply.code(200).send();
|
|
109
117
|
}
|
|
110
118
|
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
} catch (error) {
|
|
114
|
-
const err = error as Error;
|
|
115
|
-
fastify.log.error(`RO-Crate retrieval error: ${err.message}`);
|
|
116
|
-
|
|
117
|
-
return reply.code(500).send(createInternalError());
|
|
119
|
+
const stream = createReadStream(result.path);
|
|
120
|
+
return reply.code(200).send(stream);
|
|
118
121
|
}
|
|
122
|
+
|
|
123
|
+
// Exhaustiveness check - should never reach here with proper types
|
|
124
|
+
throw new Error(`Unexpected RO-Crate result type: ${(result as { type: string }).type}`);
|
|
119
125
|
},
|
|
120
126
|
);
|
|
121
127
|
};
|