@antelopejs/dms-media 0.6.0 → 0.6.1

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 (74) hide show
  1. package/README.md +3 -3
  2. package/dist/db/models/mediaFolders.model.d.ts +0 -3
  3. package/dist/db/models/mediaFolders.model.js +0 -29
  4. package/dist/db/models/mediaFolders.model.js.map +1 -1
  5. package/dist/db/tables/mediaDeclarations.table.d.ts +0 -4
  6. package/dist/db/tables/mediaDeclarations.table.js +0 -16
  7. package/dist/db/tables/mediaDeclarations.table.js.map +1 -1
  8. package/dist/declared/assets.d.ts +0 -2
  9. package/dist/declared/assets.js +12 -140
  10. package/dist/declared/assets.js.map +1 -1
  11. package/dist/declared/folders.d.ts +1 -5
  12. package/dist/declared/folders.js +14 -80
  13. package/dist/declared/folders.js.map +1 -1
  14. package/dist/declared/index.d.ts +0 -2
  15. package/dist/declared/index.js +0 -2
  16. package/dist/declared/index.js.map +1 -1
  17. package/dist/declared/records.d.ts +2 -30
  18. package/dist/declared/records.js +3 -33
  19. package/dist/declared/records.js.map +1 -1
  20. package/dist/derivatives.js +5 -17
  21. package/dist/derivatives.js.map +1 -1
  22. package/dist/implementations/interface-dms-media/index.d.ts +1 -3
  23. package/dist/implementations/interface-dms-media/index.js +0 -2
  24. package/dist/implementations/interface-dms-media/index.js.map +1 -1
  25. package/dist/routes/media/delivery-stream.js +7 -21
  26. package/dist/routes/media/delivery-stream.js.map +1 -1
  27. package/dist/routes/media/upload.js +2 -5
  28. package/dist/routes/media/upload.js.map +1 -1
  29. package/dist/test/antelope.test.js +4 -4
  30. package/dist/test/integration/media-declared-content.test.js +17 -317
  31. package/dist/test/integration/media-declared-content.test.js.map +1 -1
  32. package/dist/test/integration/media-linked-subfolders.test.js +2 -2
  33. package/dist/test/integration/media-linked-subfolders.test.js.map +1 -1
  34. package/dist/test/integration/media-storage-origin-unreachable.test.js +79 -0
  35. package/dist/test/integration/media-storage-origin-unreachable.test.js.map +1 -0
  36. package/dist/test/unit/declared.test.js +0 -66
  37. package/dist/test/unit/declared.test.js.map +1 -1
  38. package/dist/test/unit/library/realtime.test.js +1 -0
  39. package/dist/test/unit/library/realtime.test.js.map +1 -1
  40. package/dist/validation/declared.schema.d.ts +7 -36
  41. package/dist/validation/declared.schema.js +1 -12
  42. package/dist/validation/declared.schema.js.map +1 -1
  43. package/frontend-vue/package.json +1 -1
  44. package/package.json +8 -8
  45. package/skills/dms-media/SKILL.md +11 -24
  46. package/src/db/models/mediaFolders.model.ts +0 -44
  47. package/src/db/tables/mediaDeclarations.table.ts +3 -19
  48. package/src/declared/assets.ts +19 -210
  49. package/src/declared/folders.ts +22 -135
  50. package/src/declared/index.ts +0 -2
  51. package/src/declared/records.ts +8 -82
  52. package/src/derivatives.ts +7 -17
  53. package/src/implementations/interface-dms-media/index.ts +1 -8
  54. package/src/routes/media/delivery-stream.ts +12 -28
  55. package/src/routes/media/upload.ts +4 -6
  56. package/src/test/antelope.test.ts +4 -4
  57. package/src/test/integration/media-declared-content.test.ts +17 -360
  58. package/src/test/integration/media-linked-subfolders.test.ts +2 -2
  59. package/src/test/integration/media-storage-origin-unreachable.test.ts +110 -0
  60. package/src/test/unit/declared.test.ts +0 -87
  61. package/src/test/unit/library/realtime.test.ts +2 -0
  62. package/src/validation/declared.schema.ts +0 -13
  63. package/dist/declared/readiness.d.ts +0 -2
  64. package/dist/declared/readiness.js +0 -52
  65. package/dist/declared/readiness.js.map +0 -1
  66. package/dist/declared/retire.d.ts +0 -3
  67. package/dist/declared/retire.js +0 -118
  68. package/dist/declared/retire.js.map +0 -1
  69. package/dist/test/integration/media-declared-retire.test.js +0 -186
  70. package/dist/test/integration/media-declared-retire.test.js.map +0 -1
  71. package/src/declared/readiness.ts +0 -64
  72. package/src/declared/retire.ts +0 -206
  73. package/src/test/integration/media-declared-retire.test.ts +0 -257
  74. /package/dist/test/integration/{media-declared-retire.test.d.ts → media-storage-origin-unreachable.test.d.ts} +0 -0
@@ -1,206 +0,0 @@
1
- import type {
2
- MediaContentKind,
3
- MediaDeclarationPrune,
4
- MediaDeclarationRetirement,
5
- MediaRetirementResult,
6
- } from "@antelopejs/interface-dms-media";
7
- import { cleanupAssetFiles, updateAssetMedia } from "../asset-lifecycle";
8
- import type { MediaDeclaration, MediaFolder } from "../db";
9
- import { recordMediaEvent } from "../library/events";
10
- import { forgetFavorites } from "../library/favorites";
11
- import {
12
- declarationPruneSchema,
13
- declarationRetirementSchema,
14
- describeDeclarationIssues,
15
- } from "../validation/declared.schema";
16
- import { assetStateHash } from "./assets";
17
- import { folderStateHash } from "./folders";
18
- import { waitForTenant } from "./readiness";
19
- import {
20
- DECLARED_CONTENT_AUTHOR,
21
- type DeclaredModels,
22
- declaredModels,
23
- judgeMemberChange,
24
- parseDeclaration,
25
- withDeclarationLock,
26
- } from "./records";
27
-
28
- /** A retirement's outcome before it is labelled with the kind and key. */
29
- type RetirementOutcome = Omit<MediaRetirementResult, "kind" | "key">;
30
-
31
- /** Deletes a declared file still as declared, the way a member's delete does. */
32
- async function retireAsset(
33
- models: DeclaredModels,
34
- record: MediaDeclaration,
35
- ): Promise<RetirementOutcome> {
36
- const { assetModel } = models;
37
- const stored = await assetModel.get(record.targetId);
38
- const asset = stored && !stored.isDeleting ? stored : undefined;
39
- const change = judgeMemberChange(
40
- record,
41
- asset,
42
- asset && assetStateHash(asset),
43
- );
44
- if (change || !asset) return change ?? { status: "deleted" };
45
- // Tombstoned only while untouched, so a member edit racing it wins.
46
- const isTombstoned = await updateAssetMedia(
47
- assetModel,
48
- asset,
49
- { isDeleting: true },
50
- { preserveDetails: true },
51
- );
52
- if (!isTombstoned) {
53
- const current = await assetModel.get(asset._id);
54
- return current && !current.isDeleting
55
- ? { status: "preserved", id: asset._id }
56
- : { status: "deleted" };
57
- }
58
- await cleanupAssetFiles(assetModel, asset._id);
59
- await forgetFavorites(models.tenantId, [asset._id]);
60
- await recordMediaEvent(
61
- { tenantId: models.tenantId, user: DECLARED_CONTENT_AUTHOR },
62
- {
63
- kind: "asset.delete",
64
- targetName: asset.name,
65
- folderId: asset.folderId,
66
- assetId: asset._id,
67
- size: asset.size,
68
- },
69
- );
70
- return { status: "removed", id: asset._id };
71
- }
72
-
73
- async function holdsContent(
74
- models: DeclaredModels,
75
- folder: MediaFolder,
76
- ): Promise<boolean> {
77
- const [children, assets] = await Promise.all([
78
- models.folderModel.getChildren(folder._id),
79
- models.assetModel.getByFolder(folder._id),
80
- ]);
81
- return children.length > 0 || assets.length > 0;
82
- }
83
-
84
- /**
85
- * Deletes a declared folder still as declared and empty. A folder holding
86
- * anything else, members' files or folders still declared, is never deleted
87
- * with its content: it stays, and is no longer the code's.
88
- */
89
- async function retireFolder(
90
- models: DeclaredModels,
91
- record: MediaDeclaration,
92
- ): Promise<RetirementOutcome> {
93
- const { folderModel } = models;
94
- const folder = await folderModel.get(record.targetId);
95
- const change = judgeMemberChange(
96
- record,
97
- folder,
98
- folder && folderStateHash(folder),
99
- );
100
- if (change || !folder) return change ?? { status: "deleted" };
101
- if (await holdsContent(models, folder))
102
- return { status: "preserved", id: folder._id };
103
- if (!(await folderModel.deleteDeclared(folder))) {
104
- const current = await folderModel.get(folder._id);
105
- return current
106
- ? { status: "preserved", id: folder._id }
107
- : { status: "deleted" };
108
- }
109
- await forgetFavorites(models.tenantId, [folder._id]);
110
- await recordMediaEvent(
111
- { tenantId: models.tenantId, user: DECLARED_CONTENT_AUTHOR },
112
- {
113
- kind: "folder.delete",
114
- targetName: folder.name,
115
- folderId: folder.parentId,
116
- count: 0,
117
- size: 0,
118
- details: { files: 0, folders: 1 },
119
- },
120
- );
121
- return { status: "removed", id: folder._id };
122
- }
123
-
124
- const RETIRERS: Record<
125
- MediaContentKind,
126
- (
127
- models: DeclaredModels,
128
- record: MediaDeclaration,
129
- ) => Promise<RetirementOutcome>
130
- > = {
131
- asset: retireAsset,
132
- folder: retireFolder,
133
- };
134
-
135
- /** Retires one declaration under its key's lock; whatever stays is the members' from now on. */
136
- function retireKey(
137
- models: DeclaredModels,
138
- kind: MediaContentKind,
139
- key: string,
140
- ): Promise<MediaRetirementResult> {
141
- return withDeclarationLock(models.tenantId, kind, key, async () => {
142
- const record = await models.declarationModel.findByKey(kind, key);
143
- if (!record) return { kind, key, status: "unknown" };
144
- const outcome = await RETIRERS[kind](models, record);
145
- await models.declarationModel.delete(record._id);
146
- return { kind, key, ...outcome };
147
- });
148
- }
149
-
150
- /** Implements `RetireMediaDeclaration`. */
151
- export async function retireDeclaration(
152
- input: MediaDeclarationRetirement,
153
- ): Promise<MediaRetirementResult> {
154
- const kind = (input as { kind?: unknown } | undefined)?.kind;
155
- const retirement = parseDeclaration(
156
- kind === "folder" ? "folder" : "asset",
157
- input,
158
- declarationRetirementSchema,
159
- );
160
- await waitForTenant(retirement.tenantId);
161
- return retireKey(
162
- declaredModels(retirement.tenantId),
163
- retirement.kind,
164
- retirement.key,
165
- );
166
- }
167
-
168
- /** Files first, then folders from the deepest, so a folder is empty of its declared content when its turn comes. */
169
- async function retirementOrder(
170
- models: DeclaredModels,
171
- records: MediaDeclaration[],
172
- ): Promise<MediaDeclaration[]> {
173
- const depths = new Map<string, number>();
174
- for (const record of records) {
175
- if (record.kind !== "folder") continue;
176
- const folder = await models.folderModel.get(record.targetId);
177
- depths.set(record._id, folder?.path.length ?? 0);
178
- }
179
- const assets = records.filter((record) => record.kind === "asset");
180
- const folders = records
181
- .filter((record) => record.kind === "folder")
182
- .sort((a, b) => (depths.get(b._id) ?? 0) - (depths.get(a._id) ?? 0));
183
- return [...assets, ...folders];
184
- }
185
-
186
- /** Implements `PruneMediaDeclarations`. */
187
- export async function pruneDeclarations(
188
- input: MediaDeclarationPrune,
189
- ): Promise<MediaRetirementResult[]> {
190
- const parsed = declarationPruneSchema.safeParse(input);
191
- if (!parsed.success)
192
- throw new Error(
193
- `Media declarations prune: ${describeDeclarationIssues(parsed.error)}`,
194
- );
195
- const { prefix, tenantId } = parsed.data;
196
- const keep = new Set(parsed.data.keep);
197
- await waitForTenant(tenantId);
198
- const models = declaredModels(tenantId);
199
- const stale = (await models.declarationModel.getAll()).filter(
200
- (record) => record.key.startsWith(prefix) && !keep.has(record.key),
201
- );
202
- const results: MediaRetirementResult[] = [];
203
- for (const record of await retirementOrder(models, stale))
204
- results.push(await retireKey(models, record.kind, record.key));
205
- return results;
206
- }
@@ -1,257 +0,0 @@
1
- import { GetModel } from "@antelopejs/interface-database-decorators";
2
- import { DEFAULT_TENANT_ID } from "@antelopejs/interface-dms/constants";
3
- import {
4
- EnsureMediaFolder,
5
- ImportMediaAsset,
6
- PruneMediaDeclarations,
7
- RetireMediaDeclaration,
8
- } from "@antelopejs/interface-dms-media";
9
- import type { AxiosInstance } from "axios";
10
- import { expect } from "chai";
11
- import {
12
- MediaAssetModel,
13
- MediaDeclarationModel,
14
- MediaEventModel,
15
- MediaFolderModel,
16
- } from "../../db";
17
- import { authorizedClient } from "../helpers/http";
18
- import { ensureOwnerSession } from "../helpers/owner";
19
-
20
- const HTTP_OK = 200;
21
- const PREFIX = "retire.";
22
- const ROOT_KEY = "retire.root";
23
- const tenantId = DEFAULT_TENANT_ID;
24
-
25
- function folders() {
26
- return GetModel(MediaFolderModel, tenantId);
27
- }
28
-
29
- function assets() {
30
- return GetModel(MediaAssetModel, tenantId);
31
- }
32
-
33
- function declarations() {
34
- return GetModel(MediaDeclarationModel, tenantId);
35
- }
36
-
37
- async function rejectionOf(promise: Promise<unknown>): Promise<Error> {
38
- try {
39
- await promise;
40
- } catch (error) {
41
- return error as Error;
42
- }
43
- throw new Error("Expected the call to be refused");
44
- }
45
-
46
- function textFile(key: string, folderKey: string, text: string) {
47
- return ImportMediaAsset({
48
- tenantId,
49
- key,
50
- folder: { key: folderKey },
51
- name: `${key.slice(PREFIX.length)}.txt`,
52
- mimetype: "text/plain",
53
- source: { bytes: Buffer.from(text) },
54
- });
55
- }
56
-
57
- /** The library rows still standing, deleting tombstones aside. */
58
- async function liveAsset(id: string | undefined) {
59
- const asset = await assets().get(id as string);
60
- return asset && !asset.isDeleting ? asset : undefined;
61
- }
62
-
63
- describe("[integration] media declared content — retiring what the code no longer declares", () => {
64
- let client: AxiosInstance;
65
-
66
- before(async () => {
67
- client = authorizedClient((await ensureOwnerSession()).accessToken);
68
- await EnsureMediaFolder({ tenantId, key: ROOT_KEY, name: "Retired" });
69
- });
70
-
71
- after(async () => {
72
- const all = await folders().getAll();
73
- const root = all.find((folder) => folder.name === "Retired");
74
- if (root) await client.delete(`/api/media/folders/${root._id}`);
75
- const records = (await declarations().getAll()).filter((record) =>
76
- record.key.startsWith(PREFIX),
77
- );
78
- await Promise.all(
79
- records.map((record) => declarations().delete(record._id)),
80
- );
81
- });
82
-
83
- it("removes a file still as declared, once, and forgets its key", async () => {
84
- const file = await textFile("retire.untouched", ROOT_KEY, "Untouched");
85
- const retired = await RetireMediaDeclaration({
86
- tenantId,
87
- kind: "asset",
88
- key: "retire.untouched",
89
- });
90
- expect(retired).to.deep.equal({
91
- kind: "asset",
92
- key: "retire.untouched",
93
- status: "removed",
94
- id: file.id,
95
- });
96
- expect(await liveAsset(file.id)).to.equal(undefined);
97
- expect(
98
- await declarations().findByKey("asset", "retire.untouched"),
99
- ).to.equal(undefined);
100
- const events = await GetModel(MediaEventModel, tenantId).getBy(
101
- "kind",
102
- "asset.delete",
103
- );
104
- expect(events.some((event) => event.assetId === file.id)).to.equal(true);
105
- expect(
106
- (
107
- await RetireMediaDeclaration({
108
- tenantId,
109
- kind: "asset",
110
- key: "retire.untouched",
111
- })
112
- ).status,
113
- ).to.equal("unknown");
114
- // Declared again, the key creates new content.
115
- const again = await textFile("retire.untouched", ROOT_KEY, "Untouched");
116
- expect(again.status).to.equal("created");
117
- expect(again.id).to.not.equal(file.id);
118
- });
119
-
120
- it("leaves a file a member changed, and hands it over to them", async () => {
121
- const file = await textFile("retire.edited", ROOT_KEY, "Edited");
122
- const rename = await client.post(`/api/media/assets/${file.id}/update`, {
123
- name: "kept-by-member.txt",
124
- });
125
- expect(rename.status).to.equal(HTTP_OK);
126
- const retired = await RetireMediaDeclaration({
127
- tenantId,
128
- kind: "asset",
129
- key: "retire.edited",
130
- });
131
- expect(retired.status).to.equal("preserved");
132
- expect((await liveAsset(file.id))?.name).to.equal("kept-by-member.txt");
133
- expect(await declarations().findByKey("asset", "retire.edited")).to.equal(
134
- undefined,
135
- );
136
- });
137
-
138
- it("reports a file a member already deleted", async () => {
139
- const file = await textFile("retire.gone", ROOT_KEY, "Gone");
140
- await client.delete(`/api/media/assets/${file.id}`);
141
- expect(
142
- (
143
- await RetireMediaDeclaration({
144
- tenantId,
145
- kind: "asset",
146
- key: "retire.gone",
147
- })
148
- ).status,
149
- ).to.equal("deleted");
150
- });
151
-
152
- it("keeps a declared folder holding a member's file", async () => {
153
- const folder = await EnsureMediaFolder({
154
- tenantId,
155
- key: "retire.shared",
156
- name: "Shared",
157
- parent: ROOT_KEY,
158
- });
159
- await textFile("retire.shared-file", "retire.shared", "Shared");
160
- const memberFolder = await client.post("/api/media/folders", {
161
- name: "Member's",
162
- parentId: folder.id,
163
- });
164
- expect(memberFolder.status).to.equal(HTTP_OK);
165
- const results = await PruneMediaDeclarations({
166
- tenantId,
167
- prefix: "retire.shared",
168
- keep: [],
169
- });
170
- expect(
171
- results.map(({ kind, key, status }) => ({ kind, key, status })),
172
- ).to.deep.equal([
173
- { kind: "asset", key: "retire.shared-file", status: "removed" },
174
- { kind: "folder", key: "retire.shared", status: "preserved" },
175
- ]);
176
- expect(await folders().get(folder.id as string)).to.not.equal(undefined);
177
- });
178
-
179
- it("prunes the stale declarations of a prefix, files first and deepest folders first", async () => {
180
- await EnsureMediaFolder({
181
- tenantId,
182
- key: "retire.v1",
183
- name: "Version 1",
184
- parent: ROOT_KEY,
185
- });
186
- const nested = await EnsureMediaFolder({
187
- tenantId,
188
- key: "retire.v1.nested",
189
- name: "Nested",
190
- parent: "retire.v1",
191
- });
192
- const kept = await textFile("retire.v1.kept", "retire.v1", "Kept");
193
- const stale = await textFile("retire.v1.stale", "retire.v1", "Stale");
194
- const deep = await textFile("retire.v1.deep", "retire.v1.nested", "Deep");
195
- const results = await PruneMediaDeclarations({
196
- tenantId,
197
- prefix: "retire.v1",
198
- keep: ["retire.v1", "retire.v1.kept"],
199
- });
200
- expect(
201
- results.map(({ kind, key, status }) => ({ kind, key, status })),
202
- ).to.have.deep.members([
203
- { kind: "asset", key: "retire.v1.stale", status: "removed" },
204
- { kind: "asset", key: "retire.v1.deep", status: "removed" },
205
- { kind: "folder", key: "retire.v1.nested", status: "removed" },
206
- ]);
207
- expect(results.at(-1)?.kind).to.equal("folder");
208
- expect(await liveAsset(stale.id)).to.equal(undefined);
209
- expect(await liveAsset(deep.id)).to.equal(undefined);
210
- expect(await folders().get(nested.id as string)).to.equal(undefined);
211
- expect(await liveAsset(kept.id)).to.not.equal(undefined);
212
- // Pruning again finds nothing left to retire.
213
- expect(
214
- await PruneMediaDeclarations({
215
- tenantId,
216
- prefix: "retire.v1",
217
- keep: ["retire.v1", "retire.v1.kept"],
218
- }),
219
- ).to.deep.equal([]);
220
- expect(
221
- (await textFile("retire.v1.kept", "retire.v1", "Kept")).status,
222
- ).to.equal("unchanged");
223
- });
224
-
225
- it("refuses a blank prefix, an unknown kind and a missing tenant", async () => {
226
- expect(
227
- (
228
- await rejectionOf(
229
- PruneMediaDeclarations({ tenantId, prefix: " ", keep: [] }),
230
- )
231
- ).message,
232
- ).to.contain("prefix");
233
- expect(
234
- (
235
- await rejectionOf(
236
- RetireMediaDeclaration({
237
- tenantId,
238
- // @ts-expect-error A JavaScript caller can pass any kind.
239
- kind: "page",
240
- key: "retire.page",
241
- }),
242
- )
243
- ).message,
244
- ).to.contain("kind");
245
- expect(
246
- (
247
- await rejectionOf(
248
- RetireMediaDeclaration({
249
- tenantId: "",
250
- kind: "asset",
251
- key: "retire.no-tenant",
252
- }),
253
- )
254
- ).message,
255
- ).to.contain("tenantId");
256
- });
257
- });