@antelopejs/dms-media 0.8.2 → 0.8.3-next.167.g8bd8349
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/dist/test/antelope.test.js +1 -0
- package/dist/test/antelope.test.js.map +1 -1
- package/dist/test/helpers/config.d.ts +2 -0
- package/dist/test/helpers/config.js +16 -0
- package/dist/test/helpers/config.js.map +1 -0
- package/dist/test/helpers/delivery.d.ts +9 -0
- package/dist/test/helpers/delivery.js +47 -0
- package/dist/test/helpers/delivery.js.map +1 -0
- package/dist/test/helpers/derivative-storage.d.ts +3 -0
- package/dist/test/helpers/derivative-storage.js +22 -0
- package/dist/test/helpers/derivative-storage.js.map +1 -0
- package/dist/test/helpers/media-config.d.ts +2 -0
- package/dist/test/helpers/media-config.js +16 -0
- package/dist/test/helpers/media-config.js.map +1 -0
- package/dist/test/helpers/member-rights.d.ts +99 -0
- package/dist/test/helpers/member-rights.js +85 -0
- package/dist/test/helpers/member-rights.js.map +1 -0
- package/dist/test/helpers/png.d.ts +1 -0
- package/dist/test/helpers/png.js +15 -0
- package/dist/test/helpers/png.js.map +1 -0
- package/dist/test/helpers/renderings.d.ts +27 -0
- package/dist/test/helpers/renderings.js +106 -0
- package/dist/test/helpers/renderings.js.map +1 -0
- package/dist/test/helpers/uploads.d.ts +26 -0
- package/dist/test/helpers/uploads.js +48 -0
- package/dist/test/helpers/uploads.js.map +1 -0
- package/dist/test/helpers/zip.d.ts +6 -0
- package/dist/test/helpers/zip.js +50 -0
- package/dist/test/helpers/zip.js.map +1 -0
- package/dist/test/integration/media-activity-overview.test.js +109 -0
- package/dist/test/integration/media-activity-overview.test.js.map +1 -1
- package/dist/test/integration/media-api.test.js +101 -0
- package/dist/test/integration/media-api.test.js.map +1 -1
- package/dist/test/integration/media-bindings.test.js +259 -0
- package/dist/test/integration/media-bindings.test.js.map +1 -1
- package/dist/test/integration/media-bulk-writes.test.d.ts +1 -0
- package/dist/test/integration/media-bulk-writes.test.js +159 -0
- package/dist/test/integration/media-bulk-writes.test.js.map +1 -0
- package/dist/test/integration/media-declared-rules.test.d.ts +1 -0
- package/dist/test/integration/media-declared-rules.test.js +297 -0
- package/dist/test/integration/media-declared-rules.test.js.map +1 -0
- package/dist/test/integration/media-declared-sources.test.d.ts +1 -0
- package/dist/test/integration/media-declared-sources.test.js +194 -0
- package/dist/test/integration/media-declared-sources.test.js.map +1 -0
- package/dist/test/integration/media-delivery-active-content.test.d.ts +1 -0
- package/dist/test/integration/media-delivery-active-content.test.js +138 -0
- package/dist/test/integration/media-delivery-active-content.test.js.map +1 -0
- package/dist/test/integration/media-delivery-editing.test.js +41 -51
- package/dist/test/integration/media-delivery-editing.test.js.map +1 -1
- package/dist/test/integration/media-delivery.test.js +145 -0
- package/dist/test/integration/media-delivery.test.js.map +1 -1
- package/dist/test/integration/media-explorer-writes.test.js +173 -18
- package/dist/test/integration/media-explorer-writes.test.js.map +1 -1
- package/dist/test/integration/media-file-reads.test.d.ts +1 -0
- package/dist/test/integration/media-file-reads.test.js +147 -0
- package/dist/test/integration/media-file-reads.test.js.map +1 -0
- package/dist/test/integration/media-guards.test.js +1 -0
- package/dist/test/integration/media-guards.test.js.map +1 -1
- package/dist/test/integration/media-library-views.test.d.ts +1 -0
- package/dist/test/integration/media-library-views.test.js +377 -0
- package/dist/test/integration/media-library-views.test.js.map +1 -0
- package/dist/test/integration/media-linked-subfolders.test.js +2 -0
- package/dist/test/integration/media-linked-subfolders.test.js.map +1 -1
- package/dist/test/integration/media-member-access.test.js +96 -0
- package/dist/test/integration/media-member-access.test.js.map +1 -1
- package/dist/test/integration/media-permissions.test.js +7 -0
- package/dist/test/integration/media-permissions.test.js.map +1 -1
- package/dist/test/integration/media-preset-delivery.test.d.ts +1 -0
- package/dist/test/integration/media-preset-delivery.test.js +161 -0
- package/dist/test/integration/media-preset-delivery.test.js.map +1 -0
- package/dist/test/integration/media-presets.test.d.ts +1 -0
- package/dist/test/integration/media-presets.test.js +223 -0
- package/dist/test/integration/media-presets.test.js.map +1 -0
- package/dist/test/integration/media-transform.test.js +105 -10
- package/dist/test/integration/media-transform.test.js.map +1 -1
- package/dist/test/integration/media-upload-content.test.d.ts +1 -0
- package/dist/test/integration/media-upload-content.test.js +142 -0
- package/dist/test/integration/media-upload-content.test.js.map +1 -0
- package/dist/test/integration/media-upload-policy.test.js +13 -12
- package/dist/test/integration/media-upload-policy.test.js.map +1 -1
- package/dist/test/integration/media-upload-types.test.d.ts +1 -0
- package/dist/test/integration/media-upload-types.test.js +176 -0
- package/dist/test/integration/media-upload-types.test.js.map +1 -0
- package/dist/test/integration/permission-levels.d.ts +1 -0
- package/dist/test/integration/permission-levels.js +207 -0
- package/dist/test/integration/permission-levels.js.map +1 -0
- package/dist/test/integration/permission-reach.d.ts +1 -0
- package/dist/test/integration/permission-reach.js +209 -0
- package/dist/test/integration/permission-reach.js.map +1 -0
- package/dist/test/integration/permissions-management.js +7 -0
- package/dist/test/integration/permissions-management.js.map +1 -1
- package/dist/test/unit/asset-type.test.d.ts +1 -0
- package/dist/test/unit/asset-type.test.js +63 -0
- package/dist/test/unit/asset-type.test.js.map +1 -0
- package/frontend-vue/package.json +1 -1
- package/frontend-vue/pnpm-lock.yaml +11 -11
- package/package.json +10 -8
- package/src/test/antelope.test.ts +1 -0
- package/src/test/helpers/config.ts +14 -0
- package/src/test/helpers/delivery.ts +83 -0
- package/src/test/helpers/derivative-storage.ts +25 -0
- package/src/test/helpers/media-config.ts +16 -0
- package/src/test/helpers/member-rights.ts +116 -0
- package/src/test/helpers/png.ts +10 -0
- package/src/test/helpers/renderings.ts +147 -0
- package/src/test/helpers/uploads.ts +92 -0
- package/src/test/helpers/zip.ts +62 -0
- package/src/test/integration/media-activity-overview.test.ts +170 -0
- package/src/test/integration/media-api.test.ts +135 -1
- package/src/test/integration/media-bindings.test.ts +316 -2
- package/src/test/integration/media-bulk-writes.test.ts +180 -0
- package/src/test/integration/media-declared-rules.test.ts +405 -0
- package/src/test/integration/media-declared-sources.test.ts +228 -0
- package/src/test/integration/media-delivery-active-content.test.ts +185 -0
- package/src/test/integration/media-delivery-editing.test.ts +24 -46
- package/src/test/integration/media-delivery.test.ts +217 -1
- package/src/test/integration/media-explorer-writes.test.ts +253 -23
- package/src/test/integration/media-file-reads.test.ts +226 -0
- package/src/test/integration/media-guards.test.ts +1 -0
- package/src/test/integration/media-library-views.test.ts +478 -0
- package/src/test/integration/media-linked-subfolders.test.ts +2 -0
- package/src/test/integration/media-member-access.test.ts +146 -0
- package/src/test/integration/media-permissions.test.ts +10 -1
- package/src/test/integration/media-preset-delivery.test.ts +261 -0
- package/src/test/integration/media-presets.test.ts +304 -0
- package/src/test/integration/media-transform.test.ts +152 -10
- package/src/test/integration/media-upload-content.test.ts +192 -0
- package/src/test/integration/media-upload-policy.test.ts +20 -18
- package/src/test/integration/media-upload-types.test.ts +267 -0
- package/src/test/integration/permission-levels.ts +332 -0
- package/src/test/integration/permission-reach.ts +302 -0
- package/src/test/integration/permissions-management.ts +7 -0
- package/src/test/unit/asset-type.test.ts +87 -0
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { assert, expect } from "chai";
|
|
2
2
|
import { z } from "zod";
|
|
3
|
-
import { rawGet, uploadTextAsset } from "../helpers/assets";
|
|
3
|
+
import { ONE_PIXEL_PNG, rawGet, uploadTextAsset } from "../helpers/assets";
|
|
4
4
|
import { readBody } from "../helpers/bodies";
|
|
5
5
|
|
|
6
6
|
import {
|
|
@@ -19,6 +19,8 @@ import {
|
|
|
19
19
|
setUpPermissionsWorld,
|
|
20
20
|
tearDownPermissionsWorld,
|
|
21
21
|
} from "../helpers/permissions-world";
|
|
22
|
+
import { permissionLevelSuites } from "./permission-levels";
|
|
23
|
+
import { permissionReachSuites } from "./permission-reach";
|
|
22
24
|
import {
|
|
23
25
|
folderManagementSuites,
|
|
24
26
|
laterPermissionSuites,
|
|
@@ -419,6 +421,11 @@ function describeDelivery(): void {
|
|
|
419
421
|
const allowed = await rawGet(path, sessions.secretMember.accessToken);
|
|
420
422
|
expect(allowed.status).to.equal(HTTP_FOUND);
|
|
421
423
|
expect(allowed.cacheControl).to.equal("no-store");
|
|
424
|
+
assert.isNotNull(allowed.location);
|
|
425
|
+
const stored = await fetch(allowed.location);
|
|
426
|
+
expect(
|
|
427
|
+
Buffer.from(await stored.arrayBuffer()).equals(ONE_PIXEL_PNG),
|
|
428
|
+
).to.equal(true);
|
|
422
429
|
});
|
|
423
430
|
|
|
424
431
|
it("serves linked-folder assets to the consumer permission holder", async () => {
|
|
@@ -456,6 +463,8 @@ describe("[integration] media permissions — multi-actor ACL enforcement", () =
|
|
|
456
463
|
describeAssetWriteRights();
|
|
457
464
|
describeTransformRights();
|
|
458
465
|
folderManagementSuites();
|
|
466
|
+
permissionReachSuites();
|
|
467
|
+
permissionLevelSuites();
|
|
459
468
|
describeDelivery();
|
|
460
469
|
laterPermissionSuites();
|
|
461
470
|
});
|
|
@@ -0,0 +1,261 @@
|
|
|
1
|
+
import type { AxiosInstance } from "axios";
|
|
2
|
+
import { assert, expect } from "chai";
|
|
3
|
+
import { z } from "zod";
|
|
4
|
+
import { configureMediaModule, type DmsMediaConfig } from "../../config";
|
|
5
|
+
import { type UploadedAsset, uploadAsset } from "../helpers/assets";
|
|
6
|
+
import { createdBody, readBody } from "../helpers/bodies";
|
|
7
|
+
import { snapshotConfig } from "../helpers/config";
|
|
8
|
+
import { withUnwritableDerivatives } from "../helpers/derivative-storage";
|
|
9
|
+
import { authorizedClient } from "../helpers/http";
|
|
10
|
+
import { ensureOwnerSession } from "../helpers/owner";
|
|
11
|
+
import {
|
|
12
|
+
expectRendering,
|
|
13
|
+
noisyImage,
|
|
14
|
+
render,
|
|
15
|
+
withPresets,
|
|
16
|
+
} from "../helpers/renderings";
|
|
17
|
+
|
|
18
|
+
const HTTP_OK = 200;
|
|
19
|
+
const HTTP_NOT_FOUND = 404;
|
|
20
|
+
const HTTP_SERVICE_UNAVAILABLE = 503;
|
|
21
|
+
const THUMB_SIZE = 300;
|
|
22
|
+
const PREVIEW_WIDTH = 1600;
|
|
23
|
+
|
|
24
|
+
const presetsBody = z.object({
|
|
25
|
+
presets: z.array(
|
|
26
|
+
z.object({
|
|
27
|
+
id: z.string(),
|
|
28
|
+
cacheKey: z.string(),
|
|
29
|
+
rendered: z.number(),
|
|
30
|
+
exampleUrl: z.string().nullable(),
|
|
31
|
+
examplePreviewUrl: z.string().nullable(),
|
|
32
|
+
}),
|
|
33
|
+
),
|
|
34
|
+
});
|
|
35
|
+
const cacheBody = z.object({
|
|
36
|
+
items: z.array(
|
|
37
|
+
z.object({
|
|
38
|
+
id: z.string(),
|
|
39
|
+
value: z.unknown(),
|
|
40
|
+
detail: z.unknown().optional(),
|
|
41
|
+
}),
|
|
42
|
+
),
|
|
43
|
+
});
|
|
44
|
+
const lifetimeValue = z.object({
|
|
45
|
+
key: z.string(),
|
|
46
|
+
params: z.object({ count: z.object({ value: z.number() }) }),
|
|
47
|
+
});
|
|
48
|
+
|
|
49
|
+
let client: AxiosInstance;
|
|
50
|
+
let token: string;
|
|
51
|
+
let folderId: string;
|
|
52
|
+
let initialConfig: DmsMediaConfig;
|
|
53
|
+
|
|
54
|
+
function upload(
|
|
55
|
+
name: string,
|
|
56
|
+
mimetype: string,
|
|
57
|
+
body: Buffer,
|
|
58
|
+
): Promise<UploadedAsset> {
|
|
59
|
+
return uploadAsset(client, folderId, name, mimetype, body);
|
|
60
|
+
}
|
|
61
|
+
|
|
62
|
+
async function readPresets() {
|
|
63
|
+
const response = await client.get("/api/media/presets");
|
|
64
|
+
expect(response.status).to.equal(HTTP_OK);
|
|
65
|
+
return readBody(response, presetsBody).presets;
|
|
66
|
+
}
|
|
67
|
+
|
|
68
|
+
function presetRow(
|
|
69
|
+
presets: Awaited<ReturnType<typeof readPresets>>,
|
|
70
|
+
id: string,
|
|
71
|
+
) {
|
|
72
|
+
const row = presets.find((candidate) => candidate.id === id);
|
|
73
|
+
assert.isDefined(row, id);
|
|
74
|
+
return row;
|
|
75
|
+
}
|
|
76
|
+
|
|
77
|
+
function describeRenderings(): void {
|
|
78
|
+
describe("renderings on request", () => {
|
|
79
|
+
it("renders thumb and preview on first request, never upscales, and counts the renderings", async () => {
|
|
80
|
+
const small = await upload(
|
|
81
|
+
"petite été.jpg",
|
|
82
|
+
"image/jpeg",
|
|
83
|
+
await noisyImage(800, 600, "jpeg"),
|
|
84
|
+
);
|
|
85
|
+
const large = await upload(
|
|
86
|
+
"large.png",
|
|
87
|
+
"image/png",
|
|
88
|
+
await noisyImage(2000, 1000, "png"),
|
|
89
|
+
);
|
|
90
|
+
const before = await readPresets();
|
|
91
|
+
const thumb = await render(token, small, "thumb");
|
|
92
|
+
const preview = await render(token, small, "preview");
|
|
93
|
+
const largePreview = await render(token, large, "preview");
|
|
94
|
+
const after = await readPresets();
|
|
95
|
+
await expectRendering(
|
|
96
|
+
thumb,
|
|
97
|
+
{ format: "webp", width: THUMB_SIZE, height: THUMB_SIZE },
|
|
98
|
+
"thumb",
|
|
99
|
+
);
|
|
100
|
+
await expectRendering(
|
|
101
|
+
preview,
|
|
102
|
+
{ format: "webp", width: 800, height: 600 },
|
|
103
|
+
"preview of a small image",
|
|
104
|
+
);
|
|
105
|
+
await expectRendering(
|
|
106
|
+
largePreview,
|
|
107
|
+
{ format: "webp", width: PREVIEW_WIDTH, height: 800 },
|
|
108
|
+
"preview of a large image",
|
|
109
|
+
);
|
|
110
|
+
expect(presetRow(after, "thumb").rendered).to.equal(
|
|
111
|
+
presetRow(before, "thumb").rendered + 1,
|
|
112
|
+
);
|
|
113
|
+
expect(presetRow(after, "preview").rendered).to.equal(
|
|
114
|
+
presetRow(before, "preview").rendered + 2,
|
|
115
|
+
);
|
|
116
|
+
});
|
|
117
|
+
|
|
118
|
+
it("renders a changed size again from the same link, under a new cache key", async () => {
|
|
119
|
+
const photo = await upload(
|
|
120
|
+
"changed.png",
|
|
121
|
+
"image/png",
|
|
122
|
+
await noisyImage(500, 400, "png"),
|
|
123
|
+
);
|
|
124
|
+
const before = await render(token, photo, "thumb");
|
|
125
|
+
const keyBefore = presetRow(await readPresets(), "thumb").cacheKey;
|
|
126
|
+
await withPresets(
|
|
127
|
+
initialConfig,
|
|
128
|
+
[{ id: "thumb", width: 100, height: 100, fit: "cover", format: "png" }],
|
|
129
|
+
async () => {
|
|
130
|
+
const after = await render(token, photo, "thumb");
|
|
131
|
+
const keyAfter = presetRow(await readPresets(), "thumb").cacheKey;
|
|
132
|
+
await expectRendering(
|
|
133
|
+
before,
|
|
134
|
+
{ format: "webp", width: THUMB_SIZE, height: THUMB_SIZE },
|
|
135
|
+
"before",
|
|
136
|
+
);
|
|
137
|
+
await expectRendering(
|
|
138
|
+
after,
|
|
139
|
+
{ format: "png", width: 100, height: 100 },
|
|
140
|
+
"after",
|
|
141
|
+
);
|
|
142
|
+
expect(keyAfter).to.match(/^thumb\./);
|
|
143
|
+
expect(keyAfter).to.not.equal(keyBefore);
|
|
144
|
+
},
|
|
145
|
+
);
|
|
146
|
+
});
|
|
147
|
+
|
|
148
|
+
it("answers 404 for a size of a file that is not an image", async () => {
|
|
149
|
+
const pdf = await upload(
|
|
150
|
+
"doc.pdf",
|
|
151
|
+
"application/pdf",
|
|
152
|
+
Buffer.from("%PDF-1.4\n%%EOF\n"),
|
|
153
|
+
);
|
|
154
|
+
expect((await render(token, pdf, "thumb")).status).to.equal(
|
|
155
|
+
HTTP_NOT_FOUND,
|
|
156
|
+
);
|
|
157
|
+
});
|
|
158
|
+
|
|
159
|
+
it("answers 503 for a rendering the storage cannot write", async () => {
|
|
160
|
+
const photo = await upload(
|
|
161
|
+
"locked.png",
|
|
162
|
+
"image/png",
|
|
163
|
+
await noisyImage(20, 20, "png"),
|
|
164
|
+
);
|
|
165
|
+
await withUnwritableDerivatives(photo, async () => {
|
|
166
|
+
expect((await render(token, photo, "thumb")).status).to.equal(
|
|
167
|
+
HTTP_SERVICE_UNAVAILABLE,
|
|
168
|
+
);
|
|
169
|
+
});
|
|
170
|
+
});
|
|
171
|
+
});
|
|
172
|
+
}
|
|
173
|
+
|
|
174
|
+
function describeSizesApi(): void {
|
|
175
|
+
describe("the image sizes API", () => {
|
|
176
|
+
it("gives the signed link lifetimes and the clean-up's last and next run", async () => {
|
|
177
|
+
const response = await client.get("/api/media/presets/cache");
|
|
178
|
+
expect(response.status).to.equal(HTTP_OK);
|
|
179
|
+
const items = new Map(
|
|
180
|
+
readBody(response, cacheBody).items.map((item) => [item.id, item]),
|
|
181
|
+
);
|
|
182
|
+
const lifetime = (id: string) => {
|
|
183
|
+
const value = lifetimeValue.parse(items.get(id)?.value);
|
|
184
|
+
return `${value.key.split(".").pop()} ${value.params.count.value}`;
|
|
185
|
+
};
|
|
186
|
+
expect(lifetime("public")).to.equal("hours 1");
|
|
187
|
+
expect(lifetime("private")).to.equal("minutes 5");
|
|
188
|
+
const sweep = JSON.stringify(items.get("sweep"));
|
|
189
|
+
expect(sweep).to.match(/sweep_(never|last)/);
|
|
190
|
+
expect(sweep).to.contain('"type":"datetime"');
|
|
191
|
+
});
|
|
192
|
+
|
|
193
|
+
it("names every size in the config block", async () => {
|
|
194
|
+
const response = await client.get("/api/media/presets/config");
|
|
195
|
+
const { code } = readBody(response, z.object({ code: z.string() }));
|
|
196
|
+
for (const word of ["presets", "thumb", "preview"]) {
|
|
197
|
+
expect(code).to.contain(word);
|
|
198
|
+
}
|
|
199
|
+
});
|
|
200
|
+
|
|
201
|
+
it("builds the example on the public photo, even when a private one is newer", async () => {
|
|
202
|
+
const publicFolder = readBody(
|
|
203
|
+
await client.post("/api/media/folders", { name: "Examples" }),
|
|
204
|
+
createdBody,
|
|
205
|
+
).id;
|
|
206
|
+
try {
|
|
207
|
+
const name = "exemple été.png";
|
|
208
|
+
const publicPhoto = await uploadAsset(
|
|
209
|
+
client,
|
|
210
|
+
publicFolder,
|
|
211
|
+
name,
|
|
212
|
+
"image/png",
|
|
213
|
+
await noisyImage(50, 40, "png"),
|
|
214
|
+
);
|
|
215
|
+
const flip = await client.post(
|
|
216
|
+
`/api/media/folders/${publicFolder}/visibility`,
|
|
217
|
+
{ visibility: "public" },
|
|
218
|
+
);
|
|
219
|
+
expect(flip.status).to.equal(HTTP_OK);
|
|
220
|
+
await upload(
|
|
221
|
+
"newer private.png",
|
|
222
|
+
"image/png",
|
|
223
|
+
await noisyImage(50, 40, "png"),
|
|
224
|
+
);
|
|
225
|
+
const path = `/media/${publicPhoto.id}/thumb/${encodeURIComponent(name)}`;
|
|
226
|
+
const thumb = presetRow(await readPresets(), "thumb");
|
|
227
|
+
expect(thumb.examplePreviewUrl).to.equal(path);
|
|
228
|
+
expect(thumb.exampleUrl).to.match(/^https?:\/\//);
|
|
229
|
+
expect(thumb.exampleUrl?.endsWith(path)).to.equal(true);
|
|
230
|
+
} finally {
|
|
231
|
+
await client.delete(`/api/media/folders/${publicFolder}`);
|
|
232
|
+
}
|
|
233
|
+
});
|
|
234
|
+
});
|
|
235
|
+
}
|
|
236
|
+
|
|
237
|
+
describe("[integration] media presets — renderings and the image sizes API", () => {
|
|
238
|
+
before(async function () {
|
|
239
|
+
this.timeout(40_000);
|
|
240
|
+
initialConfig = snapshotConfig();
|
|
241
|
+
token = (await ensureOwnerSession()).accessToken;
|
|
242
|
+
client = authorizedClient(token);
|
|
243
|
+
const folder = await client.post("/api/media/folders", {
|
|
244
|
+
name: "Preset delivery",
|
|
245
|
+
});
|
|
246
|
+
expect(folder.status).to.equal(HTTP_OK);
|
|
247
|
+
folderId = readBody(folder, createdBody).id;
|
|
248
|
+
});
|
|
249
|
+
|
|
250
|
+
after(async () => {
|
|
251
|
+
configureMediaModule(initialConfig);
|
|
252
|
+
await client.delete(`/api/media/folders/${folderId}`);
|
|
253
|
+
});
|
|
254
|
+
|
|
255
|
+
afterEach(() => {
|
|
256
|
+
configureMediaModule(initialConfig);
|
|
257
|
+
});
|
|
258
|
+
|
|
259
|
+
describeRenderings();
|
|
260
|
+
describeSizesApi();
|
|
261
|
+
});
|
|
@@ -0,0 +1,304 @@
|
|
|
1
|
+
import type { AxiosInstance } from "axios";
|
|
2
|
+
import { expect } from "chai";
|
|
3
|
+
import sharp from "sharp";
|
|
4
|
+
import { configureMediaModule, type DmsMediaConfig } from "../../config";
|
|
5
|
+
import { DEFAULT_PRESETS, type MediaPresetConfig } from "../../presets";
|
|
6
|
+
import { type UploadedAsset, uploadAsset } from "../helpers/assets";
|
|
7
|
+
import { createdBody, readBody } from "../helpers/bodies";
|
|
8
|
+
import { snapshotConfig } from "../helpers/config";
|
|
9
|
+
import { authorizedClient } from "../helpers/http";
|
|
10
|
+
import { ensureOwnerSession } from "../helpers/owner";
|
|
11
|
+
import {
|
|
12
|
+
decodeFrame,
|
|
13
|
+
expectRendering,
|
|
14
|
+
litOnMiddleRow,
|
|
15
|
+
near,
|
|
16
|
+
noisyImage,
|
|
17
|
+
paintedPng,
|
|
18
|
+
render,
|
|
19
|
+
withPresets,
|
|
20
|
+
} from "../helpers/renderings";
|
|
21
|
+
|
|
22
|
+
const HTTP_OK = 200;
|
|
23
|
+
const HTTP_NOT_FOUND = 404;
|
|
24
|
+
const PHOTO_WIDTH = 400;
|
|
25
|
+
const PHOTO_HEIGHT = 300;
|
|
26
|
+
const BAND_SIZE = 300;
|
|
27
|
+
const THUMB_SIZE = 300;
|
|
28
|
+
const PREVIEW_WIDTH = 1600;
|
|
29
|
+
const BOX_WIDTH = 100;
|
|
30
|
+
const BOX_HEIGHT = 50;
|
|
31
|
+
const CONTAIN_LIT_WIDTH = 67;
|
|
32
|
+
const RED = [220, 30, 30];
|
|
33
|
+
const GREEN = [30, 200, 30];
|
|
34
|
+
const BLUE = [30, 30, 220];
|
|
35
|
+
const WHITE = [240, 240, 240];
|
|
36
|
+
const BLACK = [0, 0, 0];
|
|
37
|
+
const SVG_SOURCE =
|
|
38
|
+
'<svg xmlns="http://www.w3.org/2000/svg" width="100" height="100"><rect width="100" height="100" fill="#cc3366"/></svg>';
|
|
39
|
+
|
|
40
|
+
const CONFIGURED_SIZES: MediaPresetConfig[] = [
|
|
41
|
+
{
|
|
42
|
+
id: "thumb",
|
|
43
|
+
width: THUMB_SIZE,
|
|
44
|
+
height: THUMB_SIZE,
|
|
45
|
+
fit: "cover",
|
|
46
|
+
format: "webp",
|
|
47
|
+
quality: 80,
|
|
48
|
+
},
|
|
49
|
+
{ id: "wide", width: 200, format: "jpeg", quality: 30 },
|
|
50
|
+
{ id: "sharp", width: 200, format: "jpeg", quality: 95 },
|
|
51
|
+
{
|
|
52
|
+
id: "box",
|
|
53
|
+
width: BOX_WIDTH,
|
|
54
|
+
height: BOX_HEIGHT,
|
|
55
|
+
fit: "contain",
|
|
56
|
+
format: "png",
|
|
57
|
+
},
|
|
58
|
+
{ id: "fit", width: BOX_WIDTH, height: BOX_HEIGHT, fit: "inside" },
|
|
59
|
+
{ id: "tall", height: 120 },
|
|
60
|
+
{ id: "same" },
|
|
61
|
+
{ id: "cov", width: 50, height: 50, format: "png" },
|
|
62
|
+
{ id: "vector" },
|
|
63
|
+
{ id: "vecwebp", width: 80, format: "webp" },
|
|
64
|
+
{ id: "noq", width: 200 },
|
|
65
|
+
{ id: "q30", width: 200, quality: 30 },
|
|
66
|
+
];
|
|
67
|
+
|
|
68
|
+
let client: AxiosInstance;
|
|
69
|
+
let token: string;
|
|
70
|
+
let folderId: string;
|
|
71
|
+
let initialConfig: DmsMediaConfig;
|
|
72
|
+
|
|
73
|
+
function upload(
|
|
74
|
+
name: string,
|
|
75
|
+
mimetype: string,
|
|
76
|
+
body: Buffer,
|
|
77
|
+
): Promise<UploadedAsset> {
|
|
78
|
+
return uploadAsset(client, folderId, name, mimetype, body);
|
|
79
|
+
}
|
|
80
|
+
|
|
81
|
+
function describeDefaultSettings(): void {
|
|
82
|
+
describe("the default sizes", () => {
|
|
83
|
+
it("uses the documented settings, byte for byte, and not a neighbouring quality", async () => {
|
|
84
|
+
const source = await sharp({
|
|
85
|
+
create: {
|
|
86
|
+
width: 2400,
|
|
87
|
+
height: 1200,
|
|
88
|
+
channels: 3,
|
|
89
|
+
background: "#808080",
|
|
90
|
+
noise: { type: "gaussian", mean: 128, sigma: 60 },
|
|
91
|
+
},
|
|
92
|
+
})
|
|
93
|
+
.jpeg()
|
|
94
|
+
.toBuffer();
|
|
95
|
+
const asset = await upload("grand.jpg", "image/jpeg", source);
|
|
96
|
+
const documented = [
|
|
97
|
+
{
|
|
98
|
+
preset: "thumb",
|
|
99
|
+
width: THUMB_SIZE,
|
|
100
|
+
height: THUMB_SIZE,
|
|
101
|
+
fit: "cover",
|
|
102
|
+
quality: 80,
|
|
103
|
+
},
|
|
104
|
+
{
|
|
105
|
+
preset: "preview",
|
|
106
|
+
width: PREVIEW_WIDTH,
|
|
107
|
+
height: undefined,
|
|
108
|
+
fit: "inside",
|
|
109
|
+
quality: 82,
|
|
110
|
+
},
|
|
111
|
+
] as const;
|
|
112
|
+
for (const size of documented) {
|
|
113
|
+
const expected = (quality: number) =>
|
|
114
|
+
sharp(source, { animated: false })
|
|
115
|
+
.autoOrient()
|
|
116
|
+
.resize({
|
|
117
|
+
width: size.width,
|
|
118
|
+
height: size.height,
|
|
119
|
+
fit: size.fit,
|
|
120
|
+
withoutEnlargement: true,
|
|
121
|
+
})
|
|
122
|
+
.webp({ quality })
|
|
123
|
+
.toBuffer();
|
|
124
|
+
const served = await render(token, asset, size.preset);
|
|
125
|
+
const wanted = await expected(size.quality);
|
|
126
|
+
const neighbour = await expected(size.quality - 2);
|
|
127
|
+
expect(
|
|
128
|
+
served.bytes.equals(wanted),
|
|
129
|
+
`${size.preset} is WebP ${size.quality}`,
|
|
130
|
+
).to.equal(true);
|
|
131
|
+
expect(
|
|
132
|
+
wanted.equals(neighbour),
|
|
133
|
+
`${size.preset} differs from WebP ${size.quality - 2}`,
|
|
134
|
+
).to.equal(false);
|
|
135
|
+
expect(served.bytes.equals(neighbour), size.preset).to.equal(false);
|
|
136
|
+
}
|
|
137
|
+
});
|
|
138
|
+
});
|
|
139
|
+
}
|
|
140
|
+
|
|
141
|
+
function describeConfiguredSizes(): void {
|
|
142
|
+
describe("configured sizes", () => {
|
|
143
|
+
it("follows each field of a presets list, which replaces the defaults", async () => {
|
|
144
|
+
await withPresets(initialConfig, CONFIGURED_SIZES, async () => {
|
|
145
|
+
const photo = await upload(
|
|
146
|
+
"photo.jpg",
|
|
147
|
+
"image/jpeg",
|
|
148
|
+
await noisyImage(PHOTO_WIDTH, PHOTO_HEIGHT, "jpeg"),
|
|
149
|
+
);
|
|
150
|
+
const logo = await upload(
|
|
151
|
+
"logo.svg",
|
|
152
|
+
"image/svg+xml",
|
|
153
|
+
Buffer.from(SVG_SOURCE),
|
|
154
|
+
);
|
|
155
|
+
const wide = await render(token, photo, "wide");
|
|
156
|
+
const sharper = await render(token, photo, "sharp");
|
|
157
|
+
await expectRendering(
|
|
158
|
+
wide,
|
|
159
|
+
{ format: "jpeg", width: 200, height: 150 },
|
|
160
|
+
"wide",
|
|
161
|
+
);
|
|
162
|
+
expect(
|
|
163
|
+
sharper.bytes.byteLength,
|
|
164
|
+
"quality 95 is heavier than 30",
|
|
165
|
+
).to.be.greaterThan(wide.bytes.byteLength);
|
|
166
|
+
const fittedSizes = [
|
|
167
|
+
["box", "png", BOX_WIDTH, BOX_HEIGHT],
|
|
168
|
+
["fit", "jpeg", CONTAIN_LIT_WIDTH, BOX_HEIGHT],
|
|
169
|
+
["tall", "jpeg", 160, 120],
|
|
170
|
+
["same", "jpeg", PHOTO_WIDTH, PHOTO_HEIGHT],
|
|
171
|
+
["cov", "png", 50, 50],
|
|
172
|
+
] as const;
|
|
173
|
+
for (const [preset, format, width, height] of fittedSizes) {
|
|
174
|
+
await expectRendering(
|
|
175
|
+
await render(token, photo, preset),
|
|
176
|
+
{ format, width, height },
|
|
177
|
+
preset,
|
|
178
|
+
);
|
|
179
|
+
}
|
|
180
|
+
const vector = await render(token, logo, "vector");
|
|
181
|
+
expect(vector.contentType, "an SVG without a format").to.equal(
|
|
182
|
+
"image/png",
|
|
183
|
+
);
|
|
184
|
+
expect((await sharp(vector.bytes).metadata()).format).to.equal("png");
|
|
185
|
+
const vectorWebp = await render(token, logo, "vecwebp");
|
|
186
|
+
expect(vectorWebp.contentType, "an SVG with a format").to.equal(
|
|
187
|
+
"image/webp",
|
|
188
|
+
);
|
|
189
|
+
expect((await sharp(vectorWebp.bytes).metadata()).width).to.equal(80);
|
|
190
|
+
expect(
|
|
191
|
+
(await render(token, photo, "preview")).status,
|
|
192
|
+
"the list replaced the defaults",
|
|
193
|
+
).to.equal(HTTP_NOT_FOUND);
|
|
194
|
+
const noQuality = await render(token, photo, "noq");
|
|
195
|
+
const qualityOnly = await render(token, photo, "q30");
|
|
196
|
+
expect(
|
|
197
|
+
noQuality.bytes.equals(qualityOnly.bytes),
|
|
198
|
+
"quality without a format changes nothing",
|
|
199
|
+
).to.equal(true);
|
|
200
|
+
const info = await sharp(noQuality.bytes).metadata();
|
|
201
|
+
expect([info.format, info.width]).to.deep.equal(["jpeg", 200]);
|
|
202
|
+
});
|
|
203
|
+
});
|
|
204
|
+
});
|
|
205
|
+
}
|
|
206
|
+
|
|
207
|
+
function describeCropping(): void {
|
|
208
|
+
describe("cover and contain", () => {
|
|
209
|
+
it("crops a cover size around the centre", async () => {
|
|
210
|
+
const bands = await paintedPng(BAND_SIZE * 3, BAND_SIZE, (x) =>
|
|
211
|
+
x < BAND_SIZE ? RED : x < BAND_SIZE * 2 ? GREEN : BLUE,
|
|
212
|
+
);
|
|
213
|
+
const asset = await upload("bandes.png", "image/png", bands);
|
|
214
|
+
const frame = await decodeFrame(
|
|
215
|
+
(await render(token, asset, "thumb")).bytes,
|
|
216
|
+
);
|
|
217
|
+
const row = Math.floor(frame.height / 2);
|
|
218
|
+
for (const fraction of [0.02, 0.5, 0.98]) {
|
|
219
|
+
const x = Math.min(Math.floor(frame.width * fraction), frame.width - 1);
|
|
220
|
+
expect(near(frame.at(x, row), GREEN), `green at ${fraction}`).to.equal(
|
|
221
|
+
true,
|
|
222
|
+
);
|
|
223
|
+
}
|
|
224
|
+
});
|
|
225
|
+
|
|
226
|
+
it("keeps the whole image in a contain size and fills the box with a cover size", async () => {
|
|
227
|
+
const framed = await paintedPng(PHOTO_WIDTH, PHOTO_HEIGHT, (x, y) =>
|
|
228
|
+
y < 30 ? RED : y >= 270 ? BLUE : x < 40 ? GREEN : WHITE,
|
|
229
|
+
);
|
|
230
|
+
const box = {
|
|
231
|
+
width: BOX_WIDTH,
|
|
232
|
+
height: BOX_HEIGHT,
|
|
233
|
+
format: "png",
|
|
234
|
+
} as const;
|
|
235
|
+
await withPresets(
|
|
236
|
+
initialConfig,
|
|
237
|
+
[
|
|
238
|
+
{ id: "boxcontain", fit: "contain", ...box },
|
|
239
|
+
{ id: "boxcover", fit: "cover", ...box },
|
|
240
|
+
],
|
|
241
|
+
async () => {
|
|
242
|
+
const asset = await upload("framed.png", "image/png", framed);
|
|
243
|
+
const contain = await decodeFrame(
|
|
244
|
+
(await render(token, asset, "boxcontain")).bytes,
|
|
245
|
+
);
|
|
246
|
+
expect([contain.width, contain.height]).to.deep.equal([
|
|
247
|
+
BOX_WIDTH,
|
|
248
|
+
BOX_HEIGHT,
|
|
249
|
+
]);
|
|
250
|
+
expect(litOnMiddleRow(contain)).to.be.closeTo(CONTAIN_LIT_WIDTH, 1);
|
|
251
|
+
expect(near(contain.at(2, 25), BLACK), "left bar").to.equal(true);
|
|
252
|
+
expect(near(contain.at(97, 25), BLACK), "right bar").to.equal(true);
|
|
253
|
+
expect(near(contain.at(50, 1), RED), "top band kept").to.equal(true);
|
|
254
|
+
expect(near(contain.at(50, 48), BLUE), "bottom band kept").to.equal(
|
|
255
|
+
true,
|
|
256
|
+
);
|
|
257
|
+
const cover = await decodeFrame(
|
|
258
|
+
(await render(token, asset, "boxcover")).bytes,
|
|
259
|
+
);
|
|
260
|
+
expect([cover.width, cover.height]).to.deep.equal([
|
|
261
|
+
BOX_WIDTH,
|
|
262
|
+
BOX_HEIGHT,
|
|
263
|
+
]);
|
|
264
|
+
expect(litOnMiddleRow(cover)).to.equal(BOX_WIDTH);
|
|
265
|
+
expect(near(cover.at(2, 25), GREEN), "left band fills").to.equal(
|
|
266
|
+
true,
|
|
267
|
+
);
|
|
268
|
+
expect(near(cover.at(50, 1), WHITE), "top band cropped").to.equal(
|
|
269
|
+
true,
|
|
270
|
+
);
|
|
271
|
+
expect(near(cover.at(50, 48), WHITE), "bottom band cropped").to.equal(
|
|
272
|
+
true,
|
|
273
|
+
);
|
|
274
|
+
},
|
|
275
|
+
);
|
|
276
|
+
});
|
|
277
|
+
});
|
|
278
|
+
}
|
|
279
|
+
|
|
280
|
+
describe("[integration] media presets — default and configured image sizes", () => {
|
|
281
|
+
before(async function () {
|
|
282
|
+
this.timeout(40_000);
|
|
283
|
+
initialConfig = snapshotConfig();
|
|
284
|
+
expect(initialConfig.presets).to.deep.equal(DEFAULT_PRESETS);
|
|
285
|
+
token = (await ensureOwnerSession()).accessToken;
|
|
286
|
+
client = authorizedClient(token);
|
|
287
|
+
const folder = await client.post("/api/media/folders", { name: "Presets" });
|
|
288
|
+
expect(folder.status).to.equal(HTTP_OK);
|
|
289
|
+
folderId = readBody(folder, createdBody).id;
|
|
290
|
+
});
|
|
291
|
+
|
|
292
|
+
after(async () => {
|
|
293
|
+
configureMediaModule(initialConfig);
|
|
294
|
+
await client.delete(`/api/media/folders/${folderId}`);
|
|
295
|
+
});
|
|
296
|
+
|
|
297
|
+
afterEach(() => {
|
|
298
|
+
configureMediaModule(initialConfig);
|
|
299
|
+
});
|
|
300
|
+
|
|
301
|
+
describeDefaultSettings();
|
|
302
|
+
describeConfiguredSizes();
|
|
303
|
+
describeCropping();
|
|
304
|
+
});
|