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
|
@@ -0,0 +1,102 @@
|
|
|
1
|
+
import { afterEach, describe, expect, it, vi } from 'vitest';
|
|
2
|
+
|
|
3
|
+
import app, { AllPublicAccess, AllVisibleEntityFilter, AllVisibleSearchFilter, type Options } from '../app.js';
|
|
4
|
+
import { fastify, fastifyAfter, fastifyBefore, opensearch, prisma } from '../test/helpers/fastify.js';
|
|
5
|
+
import { OpensearchQueryBuilder, type SearchCapability } from '../utils/queryBuilder.js';
|
|
6
|
+
|
|
7
|
+
const registerApp = async (options: Partial<Options> = {}) => {
|
|
8
|
+
await fastifyBefore();
|
|
9
|
+
await fastify.register(app, {
|
|
10
|
+
prisma,
|
|
11
|
+
opensearch,
|
|
12
|
+
access: AllPublicAccess,
|
|
13
|
+
fileHandler: { get: vi.fn(), head: vi.fn() },
|
|
14
|
+
roCrateHandler: { get: vi.fn(), head: vi.fn() },
|
|
15
|
+
entityVisibilityFilter: AllVisibleEntityFilter,
|
|
16
|
+
searchVisibilityFilter: AllVisibleSearchFilter,
|
|
17
|
+
...options,
|
|
18
|
+
});
|
|
19
|
+
};
|
|
20
|
+
|
|
21
|
+
const getCapabilities = async () => {
|
|
22
|
+
const response = await fastify.inject({ method: 'GET', url: '/capabilities' });
|
|
23
|
+
|
|
24
|
+
return { statusCode: response.statusCode, body: response.json<{ search: SearchCapability }>() };
|
|
25
|
+
};
|
|
26
|
+
|
|
27
|
+
describe('Capabilities Route', () => {
|
|
28
|
+
afterEach(async () => {
|
|
29
|
+
await fastifyAfter();
|
|
30
|
+
});
|
|
31
|
+
|
|
32
|
+
describe('GET /capabilities', () => {
|
|
33
|
+
it('should declare the default capabilities', async () => {
|
|
34
|
+
await registerApp();
|
|
35
|
+
|
|
36
|
+
const { statusCode, body } = await getCapabilities();
|
|
37
|
+
|
|
38
|
+
expect(statusCode).toBe(200);
|
|
39
|
+
expect(body).toMatchSnapshot();
|
|
40
|
+
});
|
|
41
|
+
|
|
42
|
+
it('should declare every facet as a filter', async () => {
|
|
43
|
+
await registerApp();
|
|
44
|
+
|
|
45
|
+
const { body } = await getCapabilities();
|
|
46
|
+
|
|
47
|
+
expect(Object.keys(body.search.filters)).toEqual(expect.arrayContaining(Object.keys(body.search.facets)));
|
|
48
|
+
});
|
|
49
|
+
|
|
50
|
+
it('should declare only terms aggregations', async () => {
|
|
51
|
+
await registerApp({
|
|
52
|
+
queryBuilderOptions: {
|
|
53
|
+
aggregations: {
|
|
54
|
+
inLanguage: { terms: { size: 20 } },
|
|
55
|
+
dateCreated: { date_histogram: { field: 'dateCreated', calendar_interval: 'year' } },
|
|
56
|
+
},
|
|
57
|
+
},
|
|
58
|
+
});
|
|
59
|
+
|
|
60
|
+
const { body } = await getCapabilities();
|
|
61
|
+
|
|
62
|
+
expect(body.search).toEqual({
|
|
63
|
+
filters: { inLanguage: { type: 'string' } },
|
|
64
|
+
facets: { inLanguage: {} },
|
|
65
|
+
});
|
|
66
|
+
});
|
|
67
|
+
|
|
68
|
+
it('should use an overridden searchCapabilities', async () => {
|
|
69
|
+
const labelled: SearchCapability = {
|
|
70
|
+
filters: {
|
|
71
|
+
inLanguage: { type: 'string', label: 'Language' },
|
|
72
|
+
dateCreated: { type: 'date', label: 'Date created' },
|
|
73
|
+
},
|
|
74
|
+
facets: { inLanguage: { label: 'Language' } },
|
|
75
|
+
};
|
|
76
|
+
class LabelledQueryBuilder extends OpensearchQueryBuilder {
|
|
77
|
+
searchCapabilities() {
|
|
78
|
+
return labelled;
|
|
79
|
+
}
|
|
80
|
+
}
|
|
81
|
+
|
|
82
|
+
await registerApp({ queryBuilderClass: LabelledQueryBuilder });
|
|
83
|
+
|
|
84
|
+
const { body } = await getCapabilities();
|
|
85
|
+
|
|
86
|
+
expect(body.search).toEqual(labelled);
|
|
87
|
+
});
|
|
88
|
+
|
|
89
|
+
it('should not run the access function', async () => {
|
|
90
|
+
const access = vi.fn(() => {
|
|
91
|
+
throw new Error('Unauthorised');
|
|
92
|
+
});
|
|
93
|
+
|
|
94
|
+
await registerApp({ access });
|
|
95
|
+
|
|
96
|
+
const { statusCode } = await getCapabilities();
|
|
97
|
+
|
|
98
|
+
expect(statusCode).toBe(200);
|
|
99
|
+
expect(access).not.toHaveBeenCalled();
|
|
100
|
+
});
|
|
101
|
+
});
|
|
102
|
+
});
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
import type { FastifyPluginAsync } from 'fastify';
|
|
2
|
+
import type { OpensearchQueryBuilder } from '../utils/queryBuilder.js';
|
|
3
|
+
|
|
4
|
+
const SPEC_VERSION = '0.4.0';
|
|
5
|
+
|
|
6
|
+
type CapabilitiesRouteOptions = {
|
|
7
|
+
queryBuilder: OpensearchQueryBuilder;
|
|
8
|
+
};
|
|
9
|
+
|
|
10
|
+
const capabilities: FastifyPluginAsync<CapabilitiesRouteOptions> = async (fastify, opts) => {
|
|
11
|
+
const document = {
|
|
12
|
+
apiVersion: SPEC_VERSION,
|
|
13
|
+
deposit: { supported: false },
|
|
14
|
+
tombstonePolicy: '404',
|
|
15
|
+
extensions: {},
|
|
16
|
+
search: opts.queryBuilder.searchCapabilities(),
|
|
17
|
+
};
|
|
18
|
+
|
|
19
|
+
fastify.get('/capabilities', async () => document);
|
|
20
|
+
};
|
|
21
|
+
|
|
22
|
+
export default capabilities;
|
package/src/routes/crate.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 { FileResult, RoCrateHandler } 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 metadataRoute from './metadata.js';
|
|
8
11
|
|
|
9
12
|
vi.mock('node:fs', () => ({
|
|
@@ -15,11 +18,20 @@ describe('Crate 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(metadataRoute, {
|
|
25
|
+
await fastify.register(metadataRoute, {
|
|
26
|
+
access: mockAccess,
|
|
27
|
+
entityVisibilityFilter: AllVisibleEntityFilter,
|
|
28
|
+
refusal: { promptLoginForHidden: false },
|
|
29
|
+
prisma,
|
|
30
|
+
roCrateHandler: mockRoCrateHandler,
|
|
31
|
+
});
|
|
22
32
|
vi.clearAllMocks();
|
|
33
|
+
mockAccess.mockImplementation(AllPublicAccess);
|
|
34
|
+
prisma.entity.findMany.mockResolvedValue([]);
|
|
23
35
|
});
|
|
24
36
|
|
|
25
37
|
afterEach(async () => {
|
|
@@ -60,7 +72,7 @@ describe('Crate Route', () => {
|
|
|
60
72
|
|
|
61
73
|
describe('GET /entity/:id/metadata', () => {
|
|
62
74
|
it('should stream RO-Crate metadata for File entity', async () => {
|
|
63
|
-
prisma.entity.
|
|
75
|
+
prisma.entity.findFirst.mockResolvedValue(mockFileEntity);
|
|
64
76
|
|
|
65
77
|
const mockStream = Readable.from(['{"@context": "https://w3id.org/ro/crate/1.1/context"}']);
|
|
66
78
|
const mockResult: FileResult = {
|
|
@@ -96,7 +108,7 @@ describe('Crate Route', () => {
|
|
|
96
108
|
});
|
|
97
109
|
|
|
98
110
|
it('should stream RO-Crate metadata for Collection entity', async () => {
|
|
99
|
-
prisma.entity.
|
|
111
|
+
prisma.entity.findFirst.mockResolvedValue(mockCollectionEntity);
|
|
100
112
|
|
|
101
113
|
const mockStream = Readable.from(['{"@context": "https://w3id.org/ro/crate/1.1/context"}']);
|
|
102
114
|
const mockResult: FileResult = {
|
|
@@ -120,7 +132,7 @@ describe('Crate Route', () => {
|
|
|
120
132
|
});
|
|
121
133
|
|
|
122
134
|
it('should stream RO-Crate metadata for Object entity', async () => {
|
|
123
|
-
prisma.entity.
|
|
135
|
+
prisma.entity.findFirst.mockResolvedValue(mockObjectEntity);
|
|
124
136
|
|
|
125
137
|
const mockStream = Readable.from(['{"@context": "https://w3id.org/ro/crate/1.1/context"}']);
|
|
126
138
|
const mockResult: FileResult = {
|
|
@@ -144,7 +156,7 @@ describe('Crate Route', () => {
|
|
|
144
156
|
});
|
|
145
157
|
|
|
146
158
|
it('should handle redirect response', async () => {
|
|
147
|
-
prisma.entity.
|
|
159
|
+
prisma.entity.findFirst.mockResolvedValue(mockFileEntity);
|
|
148
160
|
|
|
149
161
|
const mockResult: FileResult = {
|
|
150
162
|
type: 'redirect',
|
|
@@ -162,7 +174,7 @@ describe('Crate Route', () => {
|
|
|
162
174
|
});
|
|
163
175
|
|
|
164
176
|
it('should handle file path response without nginx X-Accel-Redirect', async () => {
|
|
165
|
-
prisma.entity.
|
|
177
|
+
prisma.entity.findFirst.mockResolvedValue(mockCollectionEntity);
|
|
166
178
|
|
|
167
179
|
const mockStream = Readable.from(['rocrate content']);
|
|
168
180
|
vi.mocked(createReadStream).mockReturnValue(mockStream as never);
|
|
@@ -190,7 +202,7 @@ describe('Crate Route', () => {
|
|
|
190
202
|
});
|
|
191
203
|
|
|
192
204
|
it('should handle file path response with nginx X-Accel-Redirect', async () => {
|
|
193
|
-
prisma.entity.
|
|
205
|
+
prisma.entity.findFirst.mockResolvedValue(mockFileEntity);
|
|
194
206
|
|
|
195
207
|
const mockResult: FileResult = {
|
|
196
208
|
type: 'file',
|
|
@@ -215,7 +227,7 @@ describe('Crate Route', () => {
|
|
|
215
227
|
});
|
|
216
228
|
|
|
217
229
|
it('should return 404 when entity not found', async () => {
|
|
218
|
-
prisma.entity.
|
|
230
|
+
prisma.entity.findFirst.mockResolvedValue(null);
|
|
219
231
|
|
|
220
232
|
const response = await fastify.inject({
|
|
221
233
|
method: 'GET',
|
|
@@ -229,8 +241,44 @@ describe('Crate Route', () => {
|
|
|
229
241
|
expect(mockRoCrateHandler.get).not.toHaveBeenCalled();
|
|
230
242
|
});
|
|
231
243
|
|
|
244
|
+
it('should decide access on the entity without looking up its parents', async () => {
|
|
245
|
+
prisma.entity.findFirst.mockResolvedValue(mockObjectEntity);
|
|
246
|
+
vi.mocked(mockRoCrateHandler.get).mockResolvedValue({ type: 'redirect', url: 'https://example.com/ro-crate' });
|
|
247
|
+
|
|
248
|
+
await fastify.inject({
|
|
249
|
+
method: 'GET',
|
|
250
|
+
url: `/entity/${encodeURIComponent('http://example.com/object')}/metadata`,
|
|
251
|
+
});
|
|
252
|
+
|
|
253
|
+
expect(mockAccess).toHaveBeenCalledWith(
|
|
254
|
+
expect.objectContaining({
|
|
255
|
+
id: 'http://example.com/object',
|
|
256
|
+
memberOf: 'http://example.com/collection',
|
|
257
|
+
rootCollection: 'http://example.com/collection',
|
|
258
|
+
}),
|
|
259
|
+
expect.objectContaining({ request: expect.any(Object), fastify: expect.any(Object) }),
|
|
260
|
+
);
|
|
261
|
+
expect(prisma.entity.findMany).not.toHaveBeenCalled();
|
|
262
|
+
});
|
|
263
|
+
|
|
264
|
+
it('should return 403 when the metadata is not accessible', async () => {
|
|
265
|
+
prisma.entity.findFirst.mockResolvedValue(mockFileEntity);
|
|
266
|
+
mockAccess.mockReturnValue({ metadata: false, content: true });
|
|
267
|
+
|
|
268
|
+
const response = await fastify.inject({
|
|
269
|
+
method: 'GET',
|
|
270
|
+
url: `/entity/${encodeURIComponent('http://example.com/entity/file.wav')}/metadata`,
|
|
271
|
+
});
|
|
272
|
+
const body = JSON.parse(response.body) as { error: { code: string; message: string } };
|
|
273
|
+
|
|
274
|
+
expect(response.statusCode).toBe(403);
|
|
275
|
+
expect(body.error.code).toBe('FORBIDDEN');
|
|
276
|
+
expect(body.error.message).toBe('You do not have permission to access this resource');
|
|
277
|
+
expect(mockRoCrateHandler.get).not.toHaveBeenCalled();
|
|
278
|
+
});
|
|
279
|
+
|
|
232
280
|
it('should return 404 when handler returns false', async () => {
|
|
233
|
-
prisma.entity.
|
|
281
|
+
prisma.entity.findFirst.mockResolvedValue(mockFileEntity);
|
|
234
282
|
vi.mocked(mockRoCrateHandler.get).mockResolvedValue(false);
|
|
235
283
|
|
|
236
284
|
const response = await fastify.inject({
|
|
@@ -245,7 +293,7 @@ describe('Crate Route', () => {
|
|
|
245
293
|
});
|
|
246
294
|
|
|
247
295
|
it('should return 500 when database error occurs', async () => {
|
|
248
|
-
prisma.entity.
|
|
296
|
+
prisma.entity.findFirst.mockRejectedValue(new Error('Database connection failed'));
|
|
249
297
|
|
|
250
298
|
const response = await fastify.inject({
|
|
251
299
|
method: 'GET',
|
|
@@ -258,7 +306,7 @@ describe('Crate Route', () => {
|
|
|
258
306
|
});
|
|
259
307
|
|
|
260
308
|
it('should return 500 when roCrateHandler throws error', async () => {
|
|
261
|
-
prisma.entity.
|
|
309
|
+
prisma.entity.findFirst.mockResolvedValue(mockFileEntity);
|
|
262
310
|
vi.mocked(mockRoCrateHandler.get).mockRejectedValue(new Error('RO-Crate error'));
|
|
263
311
|
|
|
264
312
|
const response = await fastify.inject({
|
|
@@ -279,13 +327,13 @@ describe('Crate Route', () => {
|
|
|
279
327
|
const body = JSON.parse(response.body) as StandardErrorResponse;
|
|
280
328
|
|
|
281
329
|
expect(response.statusCode).toBe(400);
|
|
282
|
-
expect(body.error).toBe('
|
|
330
|
+
expect(body.error.code).toBe('VALIDATION_ERROR');
|
|
283
331
|
});
|
|
284
332
|
});
|
|
285
333
|
|
|
286
334
|
describe('HEAD /entity/:id/metadata', () => {
|
|
287
335
|
it('should return RO-Crate metadata headers for File entity', async () => {
|
|
288
|
-
prisma.entity.
|
|
336
|
+
prisma.entity.findFirst.mockResolvedValue(mockFileEntity);
|
|
289
337
|
|
|
290
338
|
const mockMetadata = {
|
|
291
339
|
contentType: 'application/ld+json',
|
|
@@ -316,7 +364,7 @@ describe('Crate Route', () => {
|
|
|
316
364
|
});
|
|
317
365
|
|
|
318
366
|
it('should return RO-Crate metadata headers for Collection entity', async () => {
|
|
319
|
-
prisma.entity.
|
|
367
|
+
prisma.entity.findFirst.mockResolvedValue(mockCollectionEntity);
|
|
320
368
|
|
|
321
369
|
const mockMetadata = {
|
|
322
370
|
contentType: 'text/plain',
|
|
@@ -336,7 +384,7 @@ describe('Crate Route', () => {
|
|
|
336
384
|
});
|
|
337
385
|
|
|
338
386
|
it('should return RO-Crate metadata headers for Object entity', async () => {
|
|
339
|
-
prisma.entity.
|
|
387
|
+
prisma.entity.findFirst.mockResolvedValue(mockObjectEntity);
|
|
340
388
|
|
|
341
389
|
const mockMetadata = {
|
|
342
390
|
contentType: 'application/json',
|
|
@@ -356,7 +404,7 @@ describe('Crate Route', () => {
|
|
|
356
404
|
});
|
|
357
405
|
|
|
358
406
|
it('should return 404 when entity not found', async () => {
|
|
359
|
-
prisma.entity.
|
|
407
|
+
prisma.entity.findFirst.mockResolvedValue(null);
|
|
360
408
|
|
|
361
409
|
const response = await fastify.inject({
|
|
362
410
|
method: 'HEAD',
|
|
@@ -369,8 +417,21 @@ describe('Crate Route', () => {
|
|
|
369
417
|
expect(mockRoCrateHandler.head).not.toHaveBeenCalled();
|
|
370
418
|
});
|
|
371
419
|
|
|
420
|
+
it('should return 403 when the metadata is not accessible', async () => {
|
|
421
|
+
prisma.entity.findFirst.mockResolvedValue(mockFileEntity);
|
|
422
|
+
mockAccess.mockReturnValue({ metadata: false, content: true });
|
|
423
|
+
|
|
424
|
+
const response = await fastify.inject({
|
|
425
|
+
method: 'HEAD',
|
|
426
|
+
url: `/entity/${encodeURIComponent('http://example.com/entity/file.wav')}/metadata`,
|
|
427
|
+
});
|
|
428
|
+
|
|
429
|
+
expect(response.statusCode).toBe(403);
|
|
430
|
+
expect(mockRoCrateHandler.head).not.toHaveBeenCalled();
|
|
431
|
+
});
|
|
432
|
+
|
|
372
433
|
it('should return 404 when head handler returns false', async () => {
|
|
373
|
-
prisma.entity.
|
|
434
|
+
prisma.entity.findFirst.mockResolvedValue(mockFileEntity);
|
|
374
435
|
vi.mocked(mockRoCrateHandler.head).mockResolvedValue(false);
|
|
375
436
|
|
|
376
437
|
const response = await fastify.inject({
|
|
@@ -385,7 +446,7 @@ describe('Crate Route', () => {
|
|
|
385
446
|
});
|
|
386
447
|
|
|
387
448
|
it('should return 500 when head handler throws error', async () => {
|
|
388
|
-
prisma.entity.
|
|
449
|
+
prisma.entity.findFirst.mockResolvedValue(mockFileEntity);
|
|
389
450
|
vi.mocked(mockRoCrateHandler.head).mockRejectedValue(new Error('Metadata error'));
|
|
390
451
|
|
|
391
452
|
const response = await fastify.inject({
|
|
@@ -401,7 +462,7 @@ describe('Crate Route', () => {
|
|
|
401
462
|
|
|
402
463
|
describe('GET /entity/:id/metadata - exhaustiveness check', () => {
|
|
403
464
|
it('should handle unexpected RO-Crate result type', async () => {
|
|
404
|
-
prisma.entity.
|
|
465
|
+
prisma.entity.findFirst.mockResolvedValue(mockFileEntity);
|
|
405
466
|
|
|
406
467
|
// Mock an invalid result type to test exhaustiveness check
|
|
407
468
|
const invalidResult = {
|
|
@@ -1,13 +1,18 @@
|
|
|
1
1
|
import { afterEach, beforeEach, describe, expect, it } from 'vitest';
|
|
2
2
|
|
|
3
3
|
import { fastify, fastifyAfter, fastifyBefore, prisma } from '../test/helpers/fastify.js';
|
|
4
|
-
import {
|
|
4
|
+
import { AllPublicAccess } from '../utils/access.js';
|
|
5
|
+
import { AllVisibleEntityFilter } from '../utils/visibility.js';
|
|
5
6
|
import entitiesRoute from './entities.js';
|
|
6
7
|
|
|
7
8
|
describe('Entities Route', () => {
|
|
8
9
|
beforeEach(async () => {
|
|
9
10
|
await fastifyBefore();
|
|
10
|
-
await fastify.register(entitiesRoute, {
|
|
11
|
+
await fastify.register(entitiesRoute, {
|
|
12
|
+
entityVisibilityFilter: AllVisibleEntityFilter,
|
|
13
|
+
prisma,
|
|
14
|
+
access: AllPublicAccess,
|
|
15
|
+
});
|
|
11
16
|
});
|
|
12
17
|
|
|
13
18
|
afterEach(async () => {
|
|
@@ -59,7 +64,7 @@ describe('Entities Route', () => {
|
|
|
59
64
|
expect(response.statusCode).toBe(200);
|
|
60
65
|
expect(body).toMatchSnapshot();
|
|
61
66
|
expect(prisma.entity.findMany).toHaveBeenCalledWith({
|
|
62
|
-
where: {},
|
|
67
|
+
where: { AND: [{}, {}] },
|
|
63
68
|
include: { file: { select: { id: true } } },
|
|
64
69
|
orderBy: { id: 'asc' },
|
|
65
70
|
skip: 0,
|
|
@@ -81,7 +86,7 @@ describe('Entities Route', () => {
|
|
|
81
86
|
|
|
82
87
|
expect(response.statusCode).toBe(200);
|
|
83
88
|
expect(prisma.entity.findMany).toHaveBeenCalledWith({
|
|
84
|
-
where: { memberOf: 'http://example.com/collection/1' },
|
|
89
|
+
where: { AND: [{ memberOf: 'http://example.com/collection/1' }, {}] },
|
|
85
90
|
include: { file: { select: { id: true } } },
|
|
86
91
|
orderBy: { id: 'asc' },
|
|
87
92
|
skip: 0,
|
|
@@ -103,7 +108,7 @@ describe('Entities Route', () => {
|
|
|
103
108
|
|
|
104
109
|
expect(response.statusCode).toBe(200);
|
|
105
110
|
expect(prisma.entity.findMany).toHaveBeenCalledWith({
|
|
106
|
-
where: { entityType: { in: ['http://pcdm.org/models#Collection'] } },
|
|
111
|
+
where: { AND: [{ entityType: { in: ['http://pcdm.org/models#Collection'] } }, {}] },
|
|
107
112
|
include: { file: { select: { id: true } } },
|
|
108
113
|
orderBy: { id: 'asc' },
|
|
109
114
|
skip: 0,
|
|
@@ -126,9 +131,7 @@ describe('Entities Route', () => {
|
|
|
126
131
|
expect(response.statusCode).toBe(200);
|
|
127
132
|
expect(prisma.entity.findMany).toHaveBeenCalledWith({
|
|
128
133
|
where: {
|
|
129
|
-
entityType: {
|
|
130
|
-
in: ['http://pcdm.org/models#Collection', 'http://pcdm.org/models#Object'],
|
|
131
|
-
},
|
|
134
|
+
AND: [{ entityType: { in: ['http://pcdm.org/models#Collection', 'http://pcdm.org/models#Object'] } }, {}],
|
|
132
135
|
},
|
|
133
136
|
include: { file: { select: { id: true } } },
|
|
134
137
|
orderBy: { id: 'asc' },
|
|
@@ -152,7 +155,7 @@ describe('Entities Route', () => {
|
|
|
152
155
|
|
|
153
156
|
expect(response.statusCode).toBe(200);
|
|
154
157
|
expect(prisma.entity.findMany).toHaveBeenCalledWith({
|
|
155
|
-
where: {},
|
|
158
|
+
where: { AND: [{}, {}] },
|
|
156
159
|
include: { file: { select: { id: true } } },
|
|
157
160
|
orderBy: { id: 'asc' },
|
|
158
161
|
skip: 10,
|
|
@@ -175,7 +178,7 @@ describe('Entities Route', () => {
|
|
|
175
178
|
|
|
176
179
|
expect(response.statusCode).toBe(200);
|
|
177
180
|
expect(prisma.entity.findMany).toHaveBeenCalledWith({
|
|
178
|
-
where: {},
|
|
181
|
+
where: { AND: [{}, {}] },
|
|
179
182
|
include: { file: { select: { id: true } } },
|
|
180
183
|
orderBy: { name: 'desc' },
|
|
181
184
|
skip: 0,
|
|
@@ -197,7 +200,7 @@ describe('Entities Route', () => {
|
|
|
197
200
|
|
|
198
201
|
expect(response.statusCode).toBe(200);
|
|
199
202
|
expect(prisma.entity.findMany).toHaveBeenCalledWith({
|
|
200
|
-
where: {},
|
|
203
|
+
where: { AND: [{}, {}] },
|
|
201
204
|
include: { file: { select: { id: true } } },
|
|
202
205
|
orderBy: { id: 'asc' },
|
|
203
206
|
skip: 0,
|
|
@@ -251,8 +254,9 @@ describe('Entities Route', () => {
|
|
|
251
254
|
|
|
252
255
|
await fastifyBefore();
|
|
253
256
|
await fastify.register(entitiesRoute, {
|
|
257
|
+
entityVisibilityFilter: AllVisibleEntityFilter,
|
|
254
258
|
prisma,
|
|
255
|
-
|
|
259
|
+
access: AllPublicAccess,
|
|
256
260
|
entityTransformers: [customTransformer],
|
|
257
261
|
});
|
|
258
262
|
|
package/src/routes/entities.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, authoriseEntities } from '../transformers/default.js';
|
|
6
|
+
import type { AccessFunction } from '../types/access.js';
|
|
7
|
+
import type { EntityTransformer } 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(),
|
|
@@ -25,12 +26,13 @@ const querySchema = z.object({
|
|
|
25
26
|
|
|
26
27
|
type EntitiesRouteOptions = {
|
|
27
28
|
prisma: PrismaClient;
|
|
28
|
-
|
|
29
|
+
access: AccessFunction;
|
|
29
30
|
entityTransformers?: EntityTransformer[];
|
|
31
|
+
entityVisibilityFilter: EntityVisibilityFilter;
|
|
30
32
|
};
|
|
31
33
|
|
|
32
34
|
const entities: FastifyPluginAsync<EntitiesRouteOptions> = async (fastify, opts) => {
|
|
33
|
-
const { prisma,
|
|
35
|
+
const { prisma, access, entityTransformers = [], entityVisibilityFilter } = opts;
|
|
34
36
|
fastify.withTypeProvider<ZodTypeProvider>().get(
|
|
35
37
|
'/entities',
|
|
36
38
|
{
|
|
@@ -38,68 +40,47 @@ const entities: FastifyPluginAsync<EntitiesRouteOptions> = async (fastify, opts)
|
|
|
38
40
|
querystring: querySchema,
|
|
39
41
|
},
|
|
40
42
|
},
|
|
41
|
-
async (request
|
|
43
|
+
async (request) => {
|
|
42
44
|
const { memberOf, entityType, limit, offset, sort, order } = request.query;
|
|
43
45
|
|
|
44
|
-
|
|
45
|
-
const where: NonNullable<Parameters<typeof prisma.entity.findMany>[0]>['where'] = {};
|
|
46
|
+
const where: NonNullable<Parameters<typeof prisma.entity.findMany>[0]>['where'] = {};
|
|
46
47
|
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
if (entityType && entityType.length > 0) {
|
|
52
|
-
where.entityType = {
|
|
53
|
-
in: entityType,
|
|
54
|
-
};
|
|
55
|
-
}
|
|
56
|
-
|
|
57
|
-
const [dbEntities, total] = await Promise.all([
|
|
58
|
-
prisma.entity.findMany({
|
|
59
|
-
where,
|
|
60
|
-
include: { file: { select: { id: true } } },
|
|
61
|
-
orderBy: {
|
|
62
|
-
[sort]: order,
|
|
63
|
-
},
|
|
64
|
-
skip: offset,
|
|
65
|
-
take: limit,
|
|
66
|
-
}),
|
|
67
|
-
prisma.entity.count({ where }),
|
|
68
|
-
]);
|
|
69
|
-
|
|
70
|
-
// Resolve memberOf and rootCollection references
|
|
71
|
-
const refMap = await resolveEntityReferences(dbEntities, prisma);
|
|
48
|
+
if (memberOf) {
|
|
49
|
+
where.memberOf = memberOf;
|
|
50
|
+
}
|
|
72
51
|
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
...base,
|
|
79
|
-
memberOf: base.memberOf ? (refMap.get(base.memberOf) ?? null) : null,
|
|
80
|
-
rootCollection: base.rootCollection ? (refMap.get(base.rootCollection) ?? null) : null,
|
|
81
|
-
};
|
|
82
|
-
const authorisedEntity = await accessTransformer(standardEntity, { request, fastify });
|
|
52
|
+
if (entityType && entityType.length > 0) {
|
|
53
|
+
where.entityType = {
|
|
54
|
+
in: entityType,
|
|
55
|
+
};
|
|
56
|
+
}
|
|
83
57
|
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
}
|
|
58
|
+
const context = { request, fastify };
|
|
59
|
+
const visibilityWhere = await entityVisibilityFilter(context);
|
|
60
|
+
const visibleWhere = { AND: [where, visibilityWhere] };
|
|
88
61
|
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
62
|
+
const [dbEntities, total] = await Promise.all([
|
|
63
|
+
prisma.entity.findMany({
|
|
64
|
+
where: visibleWhere,
|
|
65
|
+
include: { file: { select: { id: true } } },
|
|
66
|
+
orderBy: {
|
|
67
|
+
[sort]: order,
|
|
68
|
+
},
|
|
69
|
+
skip: offset,
|
|
70
|
+
take: limit,
|
|
71
|
+
}),
|
|
72
|
+
prisma.entity.count({ where: visibleWhere }),
|
|
73
|
+
]);
|
|
92
74
|
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
} catch (error) {
|
|
98
|
-
const err = error as Error;
|
|
99
|
-
fastify.log.error(`Database error: ${err.message}`);
|
|
75
|
+
const authorisedEntities = await authoriseEntities(dbEntities, prisma, access, context);
|
|
76
|
+
const entities = await Promise.all(
|
|
77
|
+
authorisedEntities.map((entity) => applyTransformers(entity, entityTransformers, context)),
|
|
78
|
+
);
|
|
100
79
|
|
|
101
|
-
|
|
102
|
-
|
|
80
|
+
return {
|
|
81
|
+
total,
|
|
82
|
+
entities,
|
|
83
|
+
};
|
|
103
84
|
},
|
|
104
85
|
);
|
|
105
86
|
};
|