@antelopejs/dms-media 0.7.3 → 0.8.0

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.
Files changed (141) hide show
  1. package/README.md +10 -10
  2. package/dist/acl/entries.js +20 -2
  3. package/dist/acl/entries.js.map +1 -1
  4. package/dist/asset-lifecycle.js +5 -1
  5. package/dist/asset-lifecycle.js.map +1 -1
  6. package/dist/bindings.d.ts +1 -0
  7. package/dist/bindings.js +36 -25
  8. package/dist/bindings.js.map +1 -1
  9. package/dist/db/models/mediaAssets.model.d.ts +3 -3
  10. package/dist/db/models/mediaDeclarations.model.d.ts +3 -3
  11. package/dist/db/models/mediaEvents.model.d.ts +3 -3
  12. package/dist/db/models/mediaFavorites.model.d.ts +3 -3
  13. package/dist/db/models/mediaFolders.model.d.ts +3 -3
  14. package/dist/db/models/mediaUploads.model.d.ts +3 -3
  15. package/dist/declared/assets.js +39 -25
  16. package/dist/declared/assets.js.map +1 -1
  17. package/dist/declared/folders.js +27 -14
  18. package/dist/declared/folders.js.map +1 -1
  19. package/dist/declared/records.d.ts +1 -0
  20. package/dist/declared/records.js +18 -1
  21. package/dist/declared/records.js.map +1 -1
  22. package/dist/fixed-id.d.ts +1 -0
  23. package/dist/fixed-id.js +16 -0
  24. package/dist/fixed-id.js.map +1 -0
  25. package/dist/routes/media/assets.d.ts +3 -2
  26. package/dist/routes/media/assets.js +11 -6
  27. package/dist/routes/media/assets.js.map +1 -1
  28. package/dist/routes/media/storage-keys.js +10 -1
  29. package/dist/routes/media/storage-keys.js.map +1 -1
  30. package/dist/test/helpers/assets.d.ts +2 -2
  31. package/dist/test/helpers/folders.d.ts +6 -6
  32. package/dist/test/helpers/permissions-world.d.ts +6 -6
  33. package/dist/test/integration/binding-folder-race.test.d.ts +1 -0
  34. package/dist/test/integration/binding-folder-race.test.js +66 -0
  35. package/dist/test/integration/binding-folder-race.test.js.map +1 -0
  36. package/dist/test/integration/declared-asset-race.test.d.ts +1 -0
  37. package/dist/test/integration/declared-asset-race.test.js +78 -0
  38. package/dist/test/integration/declared-asset-race.test.js.map +1 -0
  39. package/dist/test/integration/declared-folder-race.test.d.ts +1 -0
  40. package/dist/test/integration/declared-folder-race.test.js +43 -0
  41. package/dist/test/integration/declared-folder-race.test.js.map +1 -0
  42. package/dist/test/integration/media-activity-overview.test.js +27 -22
  43. package/dist/test/integration/media-activity-overview.test.js.map +1 -1
  44. package/dist/test/integration/media-api.test.js +9 -5
  45. package/dist/test/integration/media-api.test.js.map +1 -1
  46. package/dist/test/integration/media-bindings.test.js +16 -13
  47. package/dist/test/integration/media-bindings.test.js.map +1 -1
  48. package/dist/test/integration/media-cleanup.test.js +14 -5
  49. package/dist/test/integration/media-cleanup.test.js.map +1 -1
  50. package/dist/test/integration/media-declared-content.test.js +107 -91
  51. package/dist/test/integration/media-declared-content.test.js.map +1 -1
  52. package/dist/test/integration/media-delivery-editing.test.js +238 -215
  53. package/dist/test/integration/media-delivery-editing.test.js.map +1 -1
  54. package/dist/test/integration/media-explorer-writes.test.js +131 -112
  55. package/dist/test/integration/media-explorer-writes.test.js.map +1 -1
  56. package/dist/test/integration/media-guards.test.js +38 -37
  57. package/dist/test/integration/media-guards.test.js.map +1 -1
  58. package/dist/test/integration/media-library.test.js +244 -224
  59. package/dist/test/integration/media-library.test.js.map +1 -1
  60. package/dist/test/integration/media-linked-subfolders.test.js +173 -158
  61. package/dist/test/integration/media-linked-subfolders.test.js.map +1 -1
  62. package/dist/test/integration/media-permissions.test.js +31 -11
  63. package/dist/test/integration/media-permissions.test.js.map +1 -1
  64. package/dist/test/integration/media-search-query.test.js +8 -6
  65. package/dist/test/integration/media-search-query.test.js.map +1 -1
  66. package/dist/test/integration/media-search-views.test.js +12 -8
  67. package/dist/test/integration/media-search-views.test.js.map +1 -1
  68. package/dist/test/integration/media-upload-policy.test.js +228 -200
  69. package/dist/test/integration/media-upload-policy.test.js.map +1 -1
  70. package/dist/test/stack-modules.json +5 -5
  71. package/dist/test/unit/acl/entries.test.js +19 -0
  72. package/dist/test/unit/acl/entries.test.js.map +1 -1
  73. package/dist/test/unit/acl/resolver.test.js +9 -1
  74. package/dist/test/unit/acl/resolver.test.js.map +1 -1
  75. package/dist/test/unit/asset-lifecycle.test.d.ts +1 -0
  76. package/dist/test/unit/asset-lifecycle.test.js +18 -0
  77. package/dist/test/unit/asset-lifecycle.test.js.map +1 -0
  78. package/dist/test/unit/routes/storage-keys.test.d.ts +1 -0
  79. package/dist/test/unit/routes/storage-keys.test.js +18 -0
  80. package/dist/test/unit/routes/storage-keys.test.js.map +1 -0
  81. package/dist/test/unit/transform-ops.test.js +19 -0
  82. package/dist/test/unit/transform-ops.test.js.map +1 -1
  83. package/dist/transform-ops.js +25 -1
  84. package/dist/transform-ops.js.map +1 -1
  85. package/dist/validation/declared.schema.d.ts +6 -6
  86. package/dist/validation/library.schema.d.ts +4 -4
  87. package/dist/validation/media.schema.d.ts +4 -4
  88. package/frontend-vue/app/components/Explorer.vue +2 -0
  89. package/frontend-vue/app/components/FileProperties.vue +1 -1
  90. package/frontend-vue/app/components/ImageEditor.vue +5 -5
  91. package/frontend-vue/app/components/RecentFiles.vue +2 -2
  92. package/frontend-vue/app/components/UploadQueue.vue +4 -4
  93. package/frontend-vue/app/components/dialogs/DeleteFilesDialog.vue +1 -1
  94. package/frontend-vue/app/components/dialogs/ShortcutsDialog.vue +1 -1
  95. package/frontend-vue/app/components/dialogs/VisibilityDialog.vue +1 -1
  96. package/frontend-vue/app/components/explorer/ExplorerInspector.vue +1 -1
  97. package/frontend-vue/app/components/explorer/ExplorerSidebar.vue +2 -2
  98. package/frontend-vue/app/components/explorer/FolderStrip.vue +1 -1
  99. package/frontend-vue/app/components/explorer/GridView.vue +1 -1
  100. package/frontend-vue/app/components/shared/AltTextField.vue +2 -2
  101. package/frontend-vue/build/backend-boundary.ts +8 -3
  102. package/frontend-vue/eslint.config.mjs +0 -1
  103. package/frontend-vue/package.json +2 -2
  104. package/frontend-vue/pnpm-lock.yaml +45 -14
  105. package/frontend-vue/tests/backend-boundary.test.ts +6 -4
  106. package/frontend-vue/tests/fixtures/serverRender.ts +3 -3
  107. package/frontend-vue/tests/registration.test.ts +5 -0
  108. package/package.json +15 -15
  109. package/src/acl/entries.ts +30 -7
  110. package/src/asset-lifecycle.ts +6 -2
  111. package/src/bindings.ts +41 -38
  112. package/src/declared/assets.ts +45 -28
  113. package/src/declared/folders.ts +30 -21
  114. package/src/declared/records.ts +31 -2
  115. package/src/fixed-id.ts +18 -0
  116. package/src/routes/media/assets.ts +14 -6
  117. package/src/routes/media/storage-keys.ts +14 -2
  118. package/src/test/integration/binding-folder-race.test.ts +82 -0
  119. package/src/test/integration/declared-asset-race.test.ts +115 -0
  120. package/src/test/integration/declared-folder-race.test.ts +50 -0
  121. package/src/test/integration/media-activity-overview.test.ts +40 -27
  122. package/src/test/integration/media-api.test.ts +9 -5
  123. package/src/test/integration/media-bindings.test.ts +17 -13
  124. package/src/test/integration/media-cleanup.test.ts +17 -5
  125. package/src/test/integration/media-declared-content.test.ts +129 -112
  126. package/src/test/integration/media-delivery-editing.test.ts +323 -299
  127. package/src/test/integration/media-explorer-writes.test.ts +161 -135
  128. package/src/test/integration/media-guards.test.ts +40 -38
  129. package/src/test/integration/media-library.test.ts +325 -296
  130. package/src/test/integration/media-linked-subfolders.test.ts +207 -186
  131. package/src/test/integration/media-permissions.test.ts +33 -14
  132. package/src/test/integration/media-search-query.test.ts +24 -8
  133. package/src/test/integration/media-search-views.test.ts +39 -32
  134. package/src/test/integration/media-upload-policy.test.ts +283 -254
  135. package/src/test/stack-modules.json +5 -5
  136. package/src/test/unit/acl/entries.test.ts +23 -0
  137. package/src/test/unit/acl/resolver.test.ts +9 -1
  138. package/src/test/unit/asset-lifecycle.test.ts +21 -0
  139. package/src/test/unit/routes/storage-keys.test.ts +23 -0
  140. package/src/test/unit/transform-ops.test.ts +29 -1
  141. package/src/transform-ops.ts +32 -2
@@ -1,5 +1,6 @@
1
1
  import { randomUUID } from "node:crypto";
2
2
  import { readFile } from "node:fs/promises";
3
+ import { IsDuplicateKeyError } from "@antelopejs/interface-database";
3
4
  import { DeleteFile } from "@antelopejs/interface-file-storage";
4
5
  import type {
5
6
  MediaAssetDeclaration,
@@ -7,7 +8,7 @@ import type {
7
8
  } from "@antelopejs/interface-dms-media";
8
9
  import { feedingBinding } from "../bindings";
9
10
  import { getMediaConfig } from "../config";
10
- import type { MediaAsset, MediaFolder } from "../db";
11
+ import type { MediaFolder } from "../db";
11
12
  import { uploadStorageBytes } from "../derivatives";
12
13
  import { recordMediaEvent } from "../library/events";
13
14
  import {
@@ -27,6 +28,7 @@ import {
27
28
  import { findBoundFolder, findDeclaredFolder } from "./folders";
28
29
  import {
29
30
  DECLARED_CONTENT_AUTHOR,
31
+ declaredId,
30
32
  type DeclaredModels,
31
33
  declaredModels,
32
34
  MediaDeclarationError,
@@ -146,50 +148,65 @@ function writeFile(
146
148
  );
147
149
  }
148
150
 
151
+ /** Inserts the asset under its fixed id. False when another process inserted it first. */
149
152
  async function insertAsset(
150
153
  { models, declaration, folder }: AssetTarget,
154
+ id: string,
151
155
  file: PreparedFile,
152
156
  storageKey: string,
153
- ): Promise<MediaAsset | undefined> {
154
- const [assetId] = await models.assetModel.insert({
155
- folderId: folder._id,
156
- mediaRevision: randomUUID(),
157
- json_retiredFiles: "[]",
158
- name: declaration.name,
159
- mimetype: file.mimetype,
160
- size: file.bytes.byteLength,
161
- storageKey,
162
- storage: getMediaConfig().storage,
163
- width: file.image.width,
164
- height: file.image.height,
165
- alt: declaration.alt,
166
- visibility: "inherit",
167
- createdBy: DECLARED_CONTENT_AUTHOR._id,
168
- });
169
- return models.assetModel.get(assetId);
157
+ ): Promise<boolean> {
158
+ try {
159
+ await models.assetModel.insert({
160
+ _id: id,
161
+ folderId: folder._id,
162
+ mediaRevision: randomUUID(),
163
+ json_retiredFiles: "[]",
164
+ name: declaration.name,
165
+ mimetype: file.mimetype,
166
+ size: file.bytes.byteLength,
167
+ storageKey,
168
+ storage: getMediaConfig().storage,
169
+ width: file.image.width,
170
+ height: file.image.height,
171
+ alt: declaration.alt,
172
+ visibility: "inherit",
173
+ createdBy: DECLARED_CONTENT_AUTHOR._id,
174
+ });
175
+ return true;
176
+ } catch (error) {
177
+ if (!IsDuplicateKeyError(error)) throw error;
178
+ return false;
179
+ }
170
180
  }
171
181
 
182
+ /**
183
+ * Stores the file and inserts its asset. A process that loses the insert to
184
+ * another one importing the same key deletes its own file and keeps theirs.
185
+ */
172
186
  async function createAsset(
173
187
  target: AssetTarget,
174
188
  file: PreparedFile,
175
- ): Promise<MediaAsset> {
189
+ ): Promise<MediaDeclarationResult> {
190
+ const { models, declaration } = target;
191
+ const id = declaredId(models.tenantId, "asset", declaration.key);
176
192
  const storageKey = await writeFile(target, file);
177
193
  const discardFile = () =>
178
194
  DeleteFile(storageKey, getMediaConfig().storage).catch(() => undefined);
179
- const asset = await insertAsset(target, file, storageKey).catch(
195
+ const inserted = await insertAsset(target, id, file, storageKey).catch(
180
196
  async (error: unknown) => {
181
197
  await discardFile();
182
198
  throw error;
183
199
  },
184
200
  );
185
- if (!asset) {
186
- await discardFile();
201
+ const asset = await models.assetModel.get(id);
202
+ if (!inserted || !asset) await discardFile();
203
+ if (!asset)
187
204
  throw new MediaDeclarationError(
188
205
  "asset",
189
- target.declaration.key,
206
+ declaration.key,
190
207
  "the file could not be created",
191
208
  );
192
- }
209
+ if (!inserted) return { status: "kept", id };
193
210
  await recordMediaEvent(
194
211
  { tenantId: target.models.tenantId, user: DECLARED_CONTENT_AUTHOR },
195
212
  {
@@ -200,7 +217,7 @@ async function createAsset(
200
217
  size: asset.size,
201
218
  },
202
219
  );
203
- return asset;
220
+ return { status: "created", id };
204
221
  }
205
222
 
206
223
  async function applyAssetDeclaration(
@@ -223,9 +240,9 @@ async function applyAssetDeclaration(
223
240
  fieldBinding: await fieldBindingOf(models, folder),
224
241
  };
225
242
  const file = await prepareFile(target, await readSource(declaration, fail));
226
- const asset = await createAsset(target, file);
227
- await rememberDeclaration(models, "asset", declaration.key, asset._id);
228
- return { status: "created", id: asset._id };
243
+ const result = await createAsset(target, file);
244
+ await rememberDeclaration(models, "asset", declaration.key, result.id);
245
+ return result;
229
246
  }
230
247
 
231
248
  /** Implements `ImportMediaAsset`. */
@@ -11,8 +11,10 @@ import {
11
11
  declaredFolderSchema,
12
12
  type DeclaredFolderInput,
13
13
  } from "../validation/declared.schema";
14
+ import { IsDuplicateKeyError } from "@antelopejs/interface-database";
14
15
  import {
15
16
  DECLARED_CONTENT_AUTHOR,
17
+ declaredId,
16
18
  type DeclaredModels,
17
19
  declaredModels,
18
20
  MediaDeclarationError,
@@ -86,29 +88,36 @@ async function createFolder(
86
88
  models: DeclaredModels,
87
89
  declaration: DeclaredFolderInput,
88
90
  parent: MediaFolder | undefined,
89
- ): Promise<MediaFolder> {
91
+ ): Promise<MediaDeclarationResult> {
92
+ const id = declaredId(models.tenantId, "folder", declaration.key);
93
+ const missing = new MediaDeclarationError(
94
+ "folder",
95
+ declaration.key,
96
+ "the folder could not be created",
97
+ );
90
98
  const folders = await models.folderModel.getAll();
91
- if (hasSiblingNamed(folders, declaration.name, parent?._id))
99
+ if (hasSiblingNamed(folders, declaration.name, parent?._id, id))
92
100
  throw new MediaDeclarationError(
93
101
  "folder",
94
102
  declaration.key,
95
103
  `a folder named '${declaration.name}' already exists there`,
96
104
  );
97
- // oxlint-disable-next-line antelopejs/no-read-then-insert -- EnsureMediaFolder runs only from Hook.TENANT_BEING_PROVISIONED, which the DMS fires once per tenant, and withDeclarationLock serializes declarations within the process; fixed-id upsert if that changes: https://github.com/AntelopeJS/dms-media/issues/165
98
- const [folderId] = await models.folderModel.insert({
99
- name: declaration.name,
100
- parentId: parent?._id,
101
- path: buildChildPath(parent),
102
- visibility: declaration.visibility,
103
- json_acl: serializeAcl(declaration.acl),
104
- });
105
- const folder = await models.folderModel.get(folderId);
106
- if (!folder)
107
- throw new MediaDeclarationError(
108
- "folder",
109
- declaration.key,
110
- "the folder could not be created",
111
- );
105
+ try {
106
+ await models.folderModel.insert({
107
+ _id: id,
108
+ name: declaration.name,
109
+ parentId: parent?._id,
110
+ path: buildChildPath(parent),
111
+ visibility: declaration.visibility,
112
+ json_acl: serializeAcl(declaration.acl),
113
+ });
114
+ } catch (error) {
115
+ if (!IsDuplicateKeyError(error)) throw error;
116
+ if (!(await models.folderModel.get(id))) throw missing;
117
+ return { status: "kept", id };
118
+ }
119
+ const folder = await models.folderModel.get(id);
120
+ if (!folder) throw missing;
112
121
  await recordMediaEvent(
113
122
  { tenantId: models.tenantId, user: DECLARED_CONTENT_AUTHOR },
114
123
  {
@@ -118,7 +127,7 @@ async function createFolder(
118
127
  details: { targetId: folder._id },
119
128
  },
120
129
  );
121
- return folder;
130
+ return { status: "created", id };
122
131
  }
123
132
 
124
133
  async function applyFolderDeclaration(
@@ -136,9 +145,9 @@ async function applyFolderDeclaration(
136
145
  const parent = declaration.parent
137
146
  ? await findParentFolder(models, declaration.parent, fail)
138
147
  : undefined;
139
- const folder = await createFolder(models, declaration, parent);
140
- await rememberDeclaration(models, "folder", declaration.key, folder._id);
141
- return { status: "created", id: folder._id };
148
+ const result = await createFolder(models, declaration, parent);
149
+ await rememberDeclaration(models, "folder", declaration.key, result.id);
150
+ return result;
142
151
  }
143
152
 
144
153
  /** Implements `EnsureMediaFolder`. */
@@ -1,9 +1,11 @@
1
+ import { IsDuplicateKeyError } from "@antelopejs/interface-database";
1
2
  import { GetModel } from "@antelopejs/interface-database-decorators";
2
3
  import type {
3
4
  MediaAssetDeclaration,
4
5
  MediaFolderDeclaration,
5
6
  } from "@antelopejs/interface-dms-media";
6
7
  import type { ZodType, ZodTypeDef } from "zod";
8
+ import { fixedId } from "../fixed-id";
7
9
  import { isObjectLike, isString } from "../guards";
8
10
  import {
9
11
  MediaAssetModel,
@@ -105,12 +107,39 @@ export async function settlePendingDeclaration(
105
107
  await pendingDeclarations.get(lockKey(tenantId, kind, key));
106
108
  }
107
109
 
108
- /** Remembers the folder or file a declaration created, under its kind and key. */
110
+ /**
111
+ * The id of the folder or file declared under `key`, the same in every
112
+ * process: two processes declaring one key at once write one row and one
113
+ * record instead of two. The tenant is part of it because ids are unique
114
+ * across tenant instances.
115
+ */
116
+ export function declaredId(
117
+ tenantId: string,
118
+ kind: MediaDeclarationKind,
119
+ key: string,
120
+ ): string {
121
+ return fixedId(`dms-media:declared-${kind}`, tenantId, key);
122
+ }
123
+
124
+ /**
125
+ * Records the folder or file declared under `key`. The record takes the
126
+ * target's fixed id, so a record another process wrote first is this same
127
+ * record.
128
+ */
109
129
  export async function rememberDeclaration(
110
130
  models: DeclaredModels,
111
131
  kind: MediaDeclarationKind,
112
132
  key: string,
113
133
  targetId: string,
114
134
  ): Promise<void> {
115
- await models.declarationModel.insert({ kind, key, targetId });
135
+ try {
136
+ await models.declarationModel.insert({
137
+ _id: targetId,
138
+ kind,
139
+ key,
140
+ targetId,
141
+ });
142
+ } catch (error) {
143
+ if (!IsDuplicateKeyError(error)) throw error;
144
+ }
116
145
  }
@@ -0,0 +1,18 @@
1
+ import { createHash } from "node:crypto";
2
+
3
+ /**
4
+ * An id derived from `parts`, the same in every process, so two processes
5
+ * writing the row for the same parts write one row. Shaped as a version 8
6
+ * UUID, like the ids the database gives other rows.
7
+ */
8
+ export function fixedId(...parts: string[]): string {
9
+ const hex = createHash("sha256").update(JSON.stringify(parts)).digest("hex");
10
+ const variant = ((Number.parseInt(hex.charAt(16), 16) % 4) + 8).toString(16);
11
+ return [
12
+ hex.slice(0, 8),
13
+ hex.slice(8, 12),
14
+ `8${hex.slice(13, 16)}`,
15
+ `${variant}${hex.slice(17, 20)}`,
16
+ hex.slice(20, 32),
17
+ ].join("-");
18
+ }
@@ -12,6 +12,7 @@ import {
12
12
  MultiParameter,
13
13
  Parameter,
14
14
  Post,
15
+ type QueryValue,
15
16
  } from "@antelopejs/interface-api";
16
17
  import { assert } from "@antelopejs/interface-api-util";
17
18
  import { CreateReadUrl } from "@antelopejs/interface-file-storage";
@@ -41,6 +42,11 @@ const MAX_LISTING_RESULTS = 1000;
41
42
  const THUMB_PRESET_ID = "thumb";
42
43
  const UNCROPPED_PRESET_ID = "preview";
43
44
 
45
+ /** The text of a query value: `?name` and `?name=` give `true`, which reads as empty, like an absent value. */
46
+ function queryText(value: QueryValue): string {
47
+ return value === true ? "" : (value ?? "");
48
+ }
49
+
44
50
  /** The presets library thumbnails are rendered with: the square crop, and an uncropped size when configured. */
45
51
  interface PreviewPresets {
46
52
  thumb: MediaPresetConfig;
@@ -156,11 +162,12 @@ export class MediaAssetsController extends MediaApiController {
156
162
 
157
163
  @Get("/assets/search")
158
164
  async search(
159
- @Parameter("q", "query") q?: string,
160
- @Parameter("mime", "query") mime?: string,
161
- @Parameter("folderId", "query") folderId?: string,
165
+ @Parameter("q", "query") q: QueryValue,
166
+ @Parameter("mime", "query") mime: QueryValue,
167
+ @Parameter("folderId", "query") folderIdQuery: QueryValue,
162
168
  ) {
163
169
  const context = await this.resolveContext();
170
+ const folderId = queryText(folderIdQuery);
164
171
  const searchedFolders = folderId
165
172
  ? [requireFolderRight(context, folderId, "read")._id]
166
173
  : [...context.access.readable];
@@ -169,8 +176,8 @@ export class MediaAssetsController extends MediaApiController {
169
176
  searchedFolders.length === 1 ? searchedFolders[0] : searchedFolders,
170
177
  "folderId",
171
178
  );
172
- const term = (q ?? "").trim().toLowerCase();
173
- const mimePrefix = (mime ?? "").trim().toLowerCase();
179
+ const term = queryText(q).trim().toLowerCase();
180
+ const mimePrefix = queryText(mime).trim().toLowerCase();
174
181
  const assets: ReturnType<typeof buildAssetDto>[] = [];
175
182
  for await (const row of candidates) {
176
183
  const asset = MediaAssetModel.fromDatabase(row);
@@ -191,8 +198,9 @@ export class MediaAssetsController extends MediaApiController {
191
198
  @Get("/assets/:assetId/read-url")
192
199
  async readUrl(
193
200
  @Parameter("assetId", "param") assetId: string,
194
- @Parameter("preset", "query") presetId?: string,
201
+ @Parameter("preset", "query") preset: QueryValue,
195
202
  ) {
203
+ const presetId = queryText(preset);
196
204
  const context = await this.resolveContext();
197
205
  const asset = await requireReadableAsset(context, assetId);
198
206
  let storageKey = asset.storageKey;
@@ -1,9 +1,21 @@
1
1
  import type { MediaAsset } from "../../db";
2
+ import { isObject, isString } from "../../guards";
3
+
4
+ function isStringMap(value: unknown): value is Record<string, string> {
5
+ return (
6
+ isObject(value) &&
7
+ !Array.isArray(value) &&
8
+ Object.values(value).every(isString)
9
+ );
10
+ }
2
11
 
3
12
  export function parseDerivatives(asset: MediaAsset): Record<string, string> {
4
13
  if (!asset.json_derivatives) return {};
5
- // SAFETY: json_derivatives is written only as "" or the JSON.stringify of a map from cache key to storage key (transform.ts, derivatives.ts, crons/sweep-derivatives.ts), so a non-empty value is that string map; a schema parse of a stored row on read is excluded by ruling.
6
- return JSON.parse(asset.json_derivatives) as Record<string, string>;
14
+ const parsed: unknown = JSON.parse(asset.json_derivatives);
15
+ if (isStringMap(parsed)) return parsed;
16
+ throw new Error(
17
+ `Media asset '${asset._id}' has image sizes that are not a map of storage keys`,
18
+ );
7
19
  }
8
20
 
9
21
  export function collectAssetStorageKeys(asset: MediaAsset): string[] {
@@ -0,0 +1,82 @@
1
+ import { GetModel } from "@antelopejs/interface-database-decorators";
2
+ import { Schema } from "@antelopejs/interface-database";
3
+ import { TENANT_SCHEMA_NAME } from "@antelopejs/interface-dms/constants";
4
+ import { expect } from "chai";
5
+ import {
6
+ addAssetBinding,
7
+ bindingFolderId,
8
+ CONTENT_ROOT_BINDING,
9
+ ensureTenantBindings,
10
+ removeAssetBinding,
11
+ } from "../../bindings";
12
+ import { type MediaFolder, MediaFolderModel } from "../../db";
13
+
14
+ const TENANT_ID = "binding-folder-race";
15
+ const BINDING = "race.cover";
16
+ const READ_PERMISSION = "race.cover.read";
17
+
18
+ /** A folder model whose `getAll` answers as it did before another process wrote. */
19
+ class StaleReadFolderModel extends MediaFolderModel {
20
+ override getAll(): Promise<MediaFolder[]> {
21
+ return Promise.resolve([]);
22
+ }
23
+ }
24
+
25
+ describe("[integration] media bindings — two processes provisioning one tenant", () => {
26
+ before(async () => {
27
+ const schema = Schema.get(TENANT_SCHEMA_NAME);
28
+ if (!schema) throw new Error("Tenant schema is missing");
29
+ await schema.createInstance(TENANT_ID).run();
30
+ });
31
+
32
+ after(() => removeAssetBinding(BINDING));
33
+
34
+ it("keeps the content root and linked folder another process inserted after this one read, and applies the binding ACL", async () => {
35
+ const folders = GetModel(MediaFolderModel, TENANT_ID);
36
+ const rootId = bindingFolderId(TENANT_ID, CONTENT_ROOT_BINDING);
37
+ const folderId = bindingFolderId(TENANT_ID, BINDING);
38
+ await folders.insert({
39
+ _id: rootId,
40
+ name: "Content",
41
+ path: [],
42
+ binding: CONTENT_ROOT_BINDING,
43
+ json_acl: "[]",
44
+ visibility: "private",
45
+ });
46
+ await folders.insert({
47
+ _id: folderId,
48
+ name: "Race covers",
49
+ parentId: rootId,
50
+ path: [rootId],
51
+ binding: BINDING,
52
+ json_acl: "[]",
53
+ visibility: "private",
54
+ });
55
+
56
+ addAssetBinding(BINDING, {
57
+ id: BINDING,
58
+ folderName: "Race covers",
59
+ permissionMapping: { read: [READ_PERMISSION] },
60
+ });
61
+ await ensureTenantBindings(
62
+ TENANT_ID,
63
+ GetModel(StaleReadFolderModel, TENANT_ID),
64
+ );
65
+
66
+ const stored = await folders.getAll();
67
+ const idsOf = (binding: string) =>
68
+ stored
69
+ .filter((folder) => folder.binding === binding)
70
+ .map((folder) => folder._id);
71
+ expect(idsOf(CONTENT_ROOT_BINDING)).to.deep.equal([rootId]);
72
+ expect(idsOf(BINDING)).to.deep.equal([folderId]);
73
+ expect((await folders.get(folderId))?.json_acl).to.equal(
74
+ JSON.stringify([
75
+ {
76
+ subject: { kind: "permission", id: READ_PERMISSION },
77
+ rights: ["read"],
78
+ },
79
+ ]),
80
+ );
81
+ });
82
+ });
@@ -0,0 +1,115 @@
1
+ import { randomUUID } from "node:crypto";
2
+ import { GetModel } from "@antelopejs/interface-database-decorators";
3
+ import { DEFAULT_TENANT_ID } from "@antelopejs/interface-dms/constants";
4
+ import {
5
+ EnsureMediaFolder,
6
+ ImportMediaAsset,
7
+ } from "@antelopejs/interface-dms-media";
8
+ import { FileExists } from "@antelopejs/interface-file-storage";
9
+ import { expect } from "chai";
10
+ import {
11
+ MediaAssetModel,
12
+ MediaDeclarationModel,
13
+ MediaEventModel,
14
+ MediaFolderModel,
15
+ } from "../../db";
16
+ import { uploadStorageBytes } from "../../derivatives";
17
+ import { ONE_PIXEL_PNG, PNG_MIMETYPE } from "../helpers/assets";
18
+ import { patchMethod } from "../helpers/prototype";
19
+
20
+ const KEY = "declared.race.logo";
21
+ const FOLDER_KEY = "declared.race.assets";
22
+ const NAME = "race-logo.png";
23
+
24
+ function assetModel() {
25
+ return GetModel(MediaAssetModel, DEFAULT_TENANT_ID);
26
+ }
27
+
28
+ function declarationModel() {
29
+ return GetModel(MediaDeclarationModel, DEFAULT_TENANT_ID);
30
+ }
31
+
32
+ /**
33
+ * Lets another process importing the same key insert its asset, pointing at
34
+ * `winnerKey`, just before this process's own insert runs.
35
+ */
36
+ function insertAnotherProcessFirst(
37
+ winnerKey: string,
38
+ loserKeys: string[],
39
+ ): () => void {
40
+ const restore = patchMethod<MediaAssetModel, "insert">(
41
+ MediaAssetModel.prototype,
42
+ "insert",
43
+ (original) =>
44
+ async function (this: MediaAssetModel, obj, options) {
45
+ restore();
46
+ if (Array.isArray(obj) || obj.storageKey === undefined)
47
+ throw new Error("Expected one asset insert from the import");
48
+ loserKeys.push(obj.storageKey);
49
+ await original.call(this, { ...obj, storageKey: winnerKey }, options);
50
+ return original.call(this, obj, options);
51
+ },
52
+ );
53
+ return restore;
54
+ }
55
+
56
+ describe("[integration] media declared assets — two processes importing one key", () => {
57
+ let restoreInsert: (() => void) | undefined;
58
+ let folderId: string | undefined;
59
+
60
+ after(async () => {
61
+ restoreInsert?.();
62
+ if (folderId) {
63
+ for (const asset of await assetModel().getBy("folderId", folderId))
64
+ await assetModel().delete(asset._id);
65
+ await GetModel(MediaFolderModel, DEFAULT_TENANT_ID).delete(folderId);
66
+ }
67
+ for (const key of [KEY, FOLDER_KEY])
68
+ for (const record of await declarationModel().getBy("key", key))
69
+ await declarationModel().delete(record._id);
70
+ });
71
+
72
+ it("keeps the asset another process inserted between this one's checks and its insert", async () => {
73
+ folderId = (
74
+ await EnsureMediaFolder({
75
+ tenantId: DEFAULT_TENANT_ID,
76
+ key: FOLDER_KEY,
77
+ name: "Race assets",
78
+ })
79
+ ).id;
80
+ const winnerKey = await uploadStorageBytes(
81
+ ONE_PIXEL_PNG,
82
+ NAME,
83
+ PNG_MIMETYPE,
84
+ `media/${DEFAULT_TENANT_ID}/${folderId}/${randomUUID()}`,
85
+ undefined,
86
+ );
87
+ const loserKeys: string[] = [];
88
+ restoreInsert = insertAnotherProcessFirst(winnerKey, loserKeys);
89
+
90
+ const result = await ImportMediaAsset({
91
+ tenantId: DEFAULT_TENANT_ID,
92
+ key: KEY,
93
+ folder: { key: FOLDER_KEY },
94
+ name: NAME,
95
+ mimetype: PNG_MIMETYPE,
96
+ source: { bytes: ONE_PIXEL_PNG },
97
+ });
98
+
99
+ const stored = await assetModel().getBy("folderId", folderId);
100
+ expect(stored.map((asset) => asset.storageKey)).to.deep.equal([winnerKey]);
101
+ expect(result).to.deep.equal({ status: "kept", id: stored[0]?._id });
102
+ const records = await declarationModel().getBy("key", KEY);
103
+ expect(records.map((record) => record.targetId)).to.deep.equal([
104
+ stored[0]?._id,
105
+ ]);
106
+ expect(loserKeys).to.have.length(1);
107
+ expect(await FileExists(loserKeys[0] ?? "")).to.equal(false);
108
+ expect(await FileExists(winnerKey)).to.equal(true);
109
+ const events = await GetModel(
110
+ MediaEventModel,
111
+ DEFAULT_TENANT_ID,
112
+ ).listByAsset(stored[0]?._id ?? "");
113
+ expect(events.map((event) => event.kind)).to.deep.equal([]);
114
+ });
115
+ });
@@ -0,0 +1,50 @@
1
+ import { GetModel } from "@antelopejs/interface-database-decorators";
2
+ import { DEFAULT_TENANT_ID } from "@antelopejs/interface-dms/constants";
3
+ import { EnsureMediaFolder } from "@antelopejs/interface-dms-media";
4
+ import { expect } from "chai";
5
+ import { MediaDeclarationModel, MediaFolderModel } from "../../db";
6
+ import { declaredId } from "../../declared/records";
7
+
8
+ const KEY = "declared.race.reports";
9
+ const NAME = "Race reports";
10
+
11
+ function folderModel() {
12
+ return GetModel(MediaFolderModel, DEFAULT_TENANT_ID);
13
+ }
14
+
15
+ function declarationModel() {
16
+ return GetModel(MediaDeclarationModel, DEFAULT_TENANT_ID);
17
+ }
18
+
19
+ describe("[integration] media declared folders — two processes declaring one key", () => {
20
+ const id = declaredId(DEFAULT_TENANT_ID, "folder", KEY);
21
+
22
+ after(async () => {
23
+ await folderModel().delete(id);
24
+ for (const record of await declarationModel().getBy("key", KEY))
25
+ await declarationModel().delete(record._id);
26
+ });
27
+
28
+ it("keeps the folder another process inserted between this one's checks and its insert", async () => {
29
+ await folderModel().insert({
30
+ _id: id,
31
+ name: NAME,
32
+ path: [],
33
+ visibility: "private",
34
+ });
35
+
36
+ const result = await EnsureMediaFolder({
37
+ tenantId: DEFAULT_TENANT_ID,
38
+ key: KEY,
39
+ name: NAME,
40
+ });
41
+
42
+ expect(result).to.deep.equal({ status: "kept", id });
43
+ const named = (await folderModel().getAll()).filter(
44
+ (folder) => folder.name === NAME,
45
+ );
46
+ expect(named.map((folder) => folder._id)).to.deep.equal([id]);
47
+ const records = await declarationModel().getBy("key", KEY);
48
+ expect(records.map((record) => record.targetId)).to.deep.equal([id]);
49
+ });
50
+ });