@balena/pinejs 21.4.0-build-add-actions-example-1ad1a8bf73a68b5d6de8214515769d1e562721ba-1 → 21.4.0-build-add-odata-actions-57ea3eb16fe9ec8e28ea12b969da062ec4374a2d-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 (44) hide show
  1. package/.pinejs-cache.json +1 -1
  2. package/.versionbot/CHANGELOG.yml +4 -18
  3. package/CHANGELOG.md +0 -2
  4. package/out/config-loader/config-loader.js +6 -7
  5. package/out/config-loader/config-loader.js.map +1 -1
  6. package/out/config-loader/env.d.ts +0 -4
  7. package/out/config-loader/env.js +0 -4
  8. package/out/config-loader/env.js.map +1 -1
  9. package/out/sbvr-api/actions.d.ts +2 -9
  10. package/out/sbvr-api/actions.js +4 -0
  11. package/out/sbvr-api/actions.js.map +1 -1
  12. package/out/server-glue/module.js +0 -2
  13. package/out/server-glue/module.js.map +1 -1
  14. package/out/webresource-handler/index.d.ts +0 -9
  15. package/out/webresource-handler/index.js +1 -31
  16. package/out/webresource-handler/index.js.map +1 -1
  17. package/package.json +5 -5
  18. package/src/config-loader/config-loader.ts +8 -8
  19. package/src/config-loader/env.ts +0 -11
  20. package/src/sbvr-api/actions.ts +8 -3
  21. package/src/server-glue/module.ts +0 -2
  22. package/src/webresource-handler/index.ts +0 -48
  23. package/out/webresource-handler/actions/beginUpload.d.ts +0 -3
  24. package/out/webresource-handler/actions/beginUpload.js +0 -98
  25. package/out/webresource-handler/actions/beginUpload.js.map +0 -1
  26. package/out/webresource-handler/actions/canceUpload.d.ts +0 -3
  27. package/out/webresource-handler/actions/canceUpload.js +0 -58
  28. package/out/webresource-handler/actions/canceUpload.js.map +0 -1
  29. package/out/webresource-handler/actions/commitUpload.d.ts +0 -3
  30. package/out/webresource-handler/actions/commitUpload.js +0 -85
  31. package/out/webresource-handler/actions/commitUpload.js.map +0 -1
  32. package/out/webresource-handler/multiparUpload.d.ts +0 -4
  33. package/out/webresource-handler/multiparUpload.js +0 -14
  34. package/out/webresource-handler/multiparUpload.js.map +0 -1
  35. package/out/webresource-handler/webresource.d.ts +0 -42
  36. package/out/webresource-handler/webresource.js +0 -2
  37. package/out/webresource-handler/webresource.js.map +0 -1
  38. package/out/webresource-handler/webresource.sbvr +0 -60
  39. package/src/webresource-handler/actions/beginUpload.ts +0 -160
  40. package/src/webresource-handler/actions/canceUpload.ts +0 -92
  41. package/src/webresource-handler/actions/commitUpload.ts +0 -117
  42. package/src/webresource-handler/multiparUpload.ts +0 -23
  43. package/src/webresource-handler/webresource.sbvr +0 -60
  44. package/src/webresource-handler/webresource.ts +0 -48
@@ -1,98 +0,0 @@
1
- import { api } from '../../sbvr-api/sbvr-utils.js';
2
- import { getMultipartUploadHandler } from '../multiparUpload.js';
3
- import { getWebResourceFields } from '../index.js';
4
- import { BadRequestError, NotImplementedError } from '../../sbvr-api/errors.js';
5
- import { permissions, sbvrUtils } from '../../server-glue/module.js';
6
- import { TransactionClosedError } from '../../database-layer/db.js';
7
- import { randomUUID } from 'crypto';
8
- export const beginUploadAction = async ({ request, tx, id, req, }) => {
9
- if (typeof id !== 'number') {
10
- throw new NotImplementedError('multipart upload do not yet support non-numeric ids');
11
- }
12
- const handler = getMultipartUploadHandler();
13
- const { fieldName, beginUploadPayload } = parseBeginUpload(request, handler);
14
- await runFakeDbPatch(request, {
15
- [fieldName]: { ...beginUploadPayload, href: 'fake_patch' },
16
- });
17
- const { fileKey, uploadId, uploadParts } = await handler.multipartUpload.begin(fieldName, beginUploadPayload);
18
- const uuid = randomUUID();
19
- await api.webresource.post({
20
- resource: 'multipart_upload',
21
- body: {
22
- uuid,
23
- resource_name: request.resourceName,
24
- field_name: fieldName,
25
- resource_id: id,
26
- upload_id: uploadId,
27
- file_key: fileKey,
28
- status: 'pending',
29
- ...beginUploadPayload,
30
- expiry_date: Date.now() + 7 * 24 * 60 * 60 * 1000,
31
- is_created_by__actor: req.user?.actor,
32
- },
33
- passthrough: {
34
- req: permissions.root,
35
- tx,
36
- },
37
- });
38
- return {
39
- body: { [fieldName]: { uuid, uploadParts } },
40
- statusCode: 200,
41
- };
42
- };
43
- const parseBeginUpload = (request, webResourceHandler) => {
44
- const fieldNames = Object.keys(request.values);
45
- if (fieldNames.length !== 1) {
46
- throw new BadRequestError('You can only get upload url for one field at a time');
47
- }
48
- const [fieldName] = fieldNames;
49
- const webResourceFields = getWebResourceFields(request, false);
50
- if (!webResourceFields.includes(fieldName)) {
51
- throw new BadRequestError(`The provided field '${fieldName}' is not a valid webresource`);
52
- }
53
- const beginUploadPayload = parseBeginUploadPayload(request.values[fieldName], webResourceHandler);
54
- if (beginUploadPayload == null) {
55
- throw new BadRequestError('Invalid file metadata');
56
- }
57
- return {
58
- beginUploadPayload,
59
- fieldName,
60
- };
61
- };
62
- const parseBeginUploadPayload = (payload, webResourceHandler) => {
63
- if (payload == null || typeof payload !== 'object') {
64
- return null;
65
- }
66
- let { filename, content_type, size, chunk_size } = payload;
67
- if (typeof filename !== 'string' ||
68
- typeof content_type !== 'string' ||
69
- typeof size !== 'number' ||
70
- (chunk_size != null && typeof chunk_size !== 'number') ||
71
- (chunk_size != null &&
72
- chunk_size < webResourceHandler.multipartUpload.getMinimumPartSize())) {
73
- return null;
74
- }
75
- chunk_size ??= webResourceHandler.multipartUpload.getDefaultPartSize();
76
- return { filename, content_type, size, chunk_size };
77
- };
78
- const runFakeDbPatch = async (request, fakeDbPatch) => {
79
- try {
80
- await sbvrUtils.db.transaction(async (fakeTx) => {
81
- const newUrl = request.url.slice(1).replace(/\/beginUpload$/, '');
82
- await api[request.vocabulary].request({
83
- method: 'PATCH',
84
- url: newUrl,
85
- body: fakeDbPatch,
86
- passthrough: { tx: fakeTx, req: permissions.root },
87
- });
88
- await fakeTx.rollback();
89
- });
90
- }
91
- catch (e) {
92
- if (!(e instanceof TransactionClosedError &&
93
- e.message === 'Transaction has been rolled back.')) {
94
- throw e;
95
- }
96
- }
97
- };
98
- //# sourceMappingURL=beginUpload.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"beginUpload.js","sourceRoot":"","sources":["../../../src/webresource-handler/actions/beginUpload.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,GAAG,EAAiB,MAAM,8BAA8B,CAAC;AAElE,OAAO,EAAE,yBAAyB,EAAE,MAAM,sBAAsB,CAAC;AAEjE,OAAO,EAAE,oBAAoB,EAAE,MAAM,aAAa,CAAC;AACnD,OAAO,EAAE,eAAe,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAC;AAChF,OAAO,EAAE,WAAW,EAAE,SAAS,EAAE,MAAM,6BAA6B,CAAC;AACrE,OAAO,EAAE,sBAAsB,EAAE,MAAM,4BAA4B,CAAC;AACpE,OAAO,EAAE,UAAU,EAAE,MAAM,QAAQ,CAAC;AAapC,MAAM,CAAC,MAAM,iBAAiB,GAAG,KAAK,EAAE,EACvC,OAAO,EACP,EAAE,EACF,EAAE,EACF,GAAG,GACc,EAAqB,EAAE;IACxC,IAAI,OAAO,EAAE,KAAK,QAAQ,EAAE,CAAC;QAC5B,MAAM,IAAI,mBAAmB,CAC5B,qDAAqD,CACrD,CAAC;IACH,CAAC;IAED,MAAM,OAAO,GAAG,yBAAyB,EAAE,CAAC;IAC5C,MAAM,EAAE,SAAS,EAAE,kBAAkB,EAAE,GAAG,gBAAgB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IAE7E,MAAM,cAAc,CAAC,OAAO,EAAE;QAC7B,CAAC,SAAS,CAAC,EAAE,EAAE,GAAG,kBAAkB,EAAE,IAAI,EAAE,YAAY,EAAE;KAC1D,CAAC,CAAC;IAEH,MAAM,EAAE,OAAO,EAAE,QAAQ,EAAE,WAAW,EAAE,GACvC,MAAM,OAAO,CAAC,eAAe,CAAC,KAAK,CAAC,SAAS,EAAE,kBAAkB,CAAC,CAAC;IACpE,MAAM,IAAI,GAAG,UAAU,EAAE,CAAC;IAC1B,MAAM,GAAG,CAAC,WAAW,CAAC,IAAI,CAAC;QAC1B,QAAQ,EAAE,kBAAkB;QAC5B,IAAI,EAAE;YACL,IAAI;YACJ,aAAa,EAAE,OAAO,CAAC,YAAY;YACnC,UAAU,EAAE,SAAS;YACrB,WAAW,EAAE,EAAE;YACf,SAAS,EAAE,QAAQ;YACnB,QAAQ,EAAE,OAAO;YACjB,MAAM,EAAE,SAAS;YACjB,GAAG,kBAAkB;YACrB,WAAW,EAAE,IAAI,CAAC,GAAG,EAAE,GAAG,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,IAAI;YACjD,oBAAoB,EAAE,GAAG,CAAC,IAAI,EAAE,KAAK;SACrC;QACD,WAAW,EAAE;YACZ,GAAG,EAAE,WAAW,CAAC,IAAI;YACrB,EAAE;SACF;KACD,CAAC,CAAC;IAEH,OAAO;QACN,IAAI,EAAE,EAAE,CAAC,SAAS,CAAC,EAAE,EAAE,IAAI,EAAE,WAAW,EAAE,EAAE;QAC5C,UAAU,EAAE,GAAG;KACf,CAAC;AACH,CAAC,CAAC;AAEF,MAAM,gBAAgB,GAAG,CACxB,OAA2B,EAC3B,kBAA0C,EACzC,EAAE;IACH,MAAM,UAAU,GAAG,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IAC/C,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC7B,MAAM,IAAI,eAAe,CACxB,qDAAqD,CACrD,CAAC;IACH,CAAC;IAED,MAAM,CAAC,SAAS,CAAC,GAAG,UAAU,CAAC;IAC/B,MAAM,iBAAiB,GAAG,oBAAoB,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;IAC/D,IAAI,CAAC,iBAAiB,CAAC,QAAQ,CAAC,SAAS,CAAC,EAAE,CAAC;QAC5C,MAAM,IAAI,eAAe,CACxB,uBAAuB,SAAS,8BAA8B,CAC9D,CAAC;IACH,CAAC;IAED,MAAM,kBAAkB,GAAG,uBAAuB,CACjD,OAAO,CAAC,MAAM,CAAC,SAAS,CAAC,EACzB,kBAAkB,CAClB,CAAC;IACF,IAAI,kBAAkB,IAAI,IAAI,EAAE,CAAC;QAChC,MAAM,IAAI,eAAe,CAAC,uBAAuB,CAAC,CAAC;IACpD,CAAC;IAED,OAAO;QACN,kBAAkB;QAClB,SAAS;KACT,CAAC;AACH,CAAC,CAAC;AAEF,MAAM,uBAAuB,GAAG,CAC/B,OAAkB,EAClB,kBAA0C,EACL,EAAE;IACvC,IAAI,OAAO,IAAI,IAAI,IAAI,OAAO,OAAO,KAAK,QAAQ,EAAE,CAAC;QACpD,OAAO,IAAI,CAAC;IACb,CAAC;IAED,IAAI,EAAE,QAAQ,EAAE,YAAY,EAAE,IAAI,EAAE,UAAU,EAAE,GAAG,OAAO,CAAC;IAC3D,IACC,OAAO,QAAQ,KAAK,QAAQ;QAC5B,OAAO,YAAY,KAAK,QAAQ;QAChC,OAAO,IAAI,KAAK,QAAQ;QACxB,CAAC,UAAU,IAAI,IAAI,IAAI,OAAO,UAAU,KAAK,QAAQ,CAAC;QACtD,CAAC,UAAU,IAAI,IAAI;YAClB,UAAU,GAAG,kBAAkB,CAAC,eAAe,CAAC,kBAAkB,EAAE,CAAC,EACrE,CAAC;QACF,OAAO,IAAI,CAAC;IACb,CAAC;IAED,UAAU,KAAK,kBAAkB,CAAC,eAAe,CAAC,kBAAkB,EAAE,CAAC;IAEvE,OAAO,EAAE,QAAQ,EAAE,YAAY,EAAE,IAAI,EAAE,UAAU,EAAE,CAAC;AACrD,CAAC,CAAC;AAGF,MAAM,cAAc,GAAG,KAAK,EAC3B,OAA2B,EAC3B,WAAiC,EAChC,EAAE;IACH,IAAI,CAAC;QACJ,MAAM,SAAS,CAAC,EAAE,CAAC,WAAW,CAAC,KAAK,EAAE,MAAM,EAAE,EAAE;YAC/C,MAAM,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,gBAAgB,EAAE,EAAE,CAAC,CAAC;YAClE,MAAM,GAAG,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,OAAO,CAAC;gBACrC,MAAM,EAAE,OAAO;gBACf,GAAG,EAAE,MAAM;gBACX,IAAI,EAAE,WAAW;gBAEjB,WAAW,EAAE,EAAE,EAAE,EAAE,MAAM,EAAE,GAAG,EAAE,WAAW,CAAC,IAAI,EAAE;aAClD,CAAC,CAAC;YAEH,MAAM,MAAM,CAAC,QAAQ,EAAE,CAAC;QACzB,CAAC,CAAC,CAAC;IACJ,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC;QACZ,IAGC,CAAC,CACA,CAAC,YAAY,sBAAsB;YACnC,CAAC,CAAC,OAAO,KAAK,mCAAmC,CACjD,EACA,CAAC;YACF,MAAM,CAAC,CAAC;QACT,CAAC;IACF,CAAC;AACF,CAAC,CAAC"}
@@ -1,3 +0,0 @@
1
- import type { ODataActionArgs } from '../../sbvr-api/actions.js';
2
- import { type Response } from '../../sbvr-api/sbvr-utils.js';
3
- export declare const cancelUploadAction: ({ request, tx, id: resourceId, }: ODataActionArgs) => Promise<Response>;
@@ -1,58 +0,0 @@
1
- import { BadRequestError, NotImplementedError, UnauthorizedError, } from '../../sbvr-api/errors.js';
2
- import { api } from '../../sbvr-api/sbvr-utils.js';
3
- import { permissions } from '../../server-glue/module.js';
4
- import { getMultipartUploadHandler } from '../multiparUpload.js';
5
- export const cancelUploadAction = async ({ request, tx, id: resourceId, }) => {
6
- if (typeof resourceId !== 'number') {
7
- throw new NotImplementedError('multipart upload do not yet support non-numeric ids');
8
- }
9
- const { id, fileKey, uploadId } = await getOngoingUpload(request, resourceId, tx);
10
- const handler = getMultipartUploadHandler();
11
- await api.webresource.patch({
12
- resource: 'multipart_upload',
13
- body: {
14
- status: 'cancelled',
15
- },
16
- id,
17
- passthrough: {
18
- tx: tx,
19
- req: permissions.root,
20
- },
21
- });
22
- await handler.multipartUpload.cancel({ fileKey, uploadId });
23
- return {
24
- statusCode: 204,
25
- };
26
- };
27
- const getOngoingUpload = async (request, affectedId, tx) => {
28
- const { uuid } = request.values;
29
- if (!uuid || typeof uuid !== 'string') {
30
- throw new BadRequestError('Invalid uuid type');
31
- }
32
- const [multipartUpload] = await api.webresource.get({
33
- resource: 'multipart_upload',
34
- options: {
35
- $select: ['id', 'file_key', 'upload_id'],
36
- $filter: {
37
- uuid,
38
- status: 'pending',
39
- expiry_date: { $gt: { $now: {} } },
40
- resource_name: request.resourceName,
41
- resource_id: affectedId,
42
- },
43
- },
44
- passthrough: {
45
- tx,
46
- req: permissions.rootRead,
47
- },
48
- });
49
- if (multipartUpload == null) {
50
- throw new UnauthorizedError();
51
- }
52
- return {
53
- id: multipartUpload.id,
54
- fileKey: multipartUpload.file_key,
55
- uploadId: multipartUpload.upload_id,
56
- };
57
- };
58
- //# sourceMappingURL=canceUpload.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"canceUpload.js","sourceRoot":"","sources":["../../../src/webresource-handler/actions/canceUpload.ts"],"names":[],"mappings":"AAKA,OAAO,EACN,eAAe,EACf,mBAAmB,EACnB,iBAAiB,GACjB,MAAM,0BAA0B,CAAC;AAClC,OAAO,EAAE,GAAG,EAAiB,MAAM,8BAA8B,CAAC;AAClE,OAAO,EAAE,WAAW,EAAE,MAAM,6BAA6B,CAAC;AAC1D,OAAO,EAAE,yBAAyB,EAAE,MAAM,sBAAsB,CAAC;AAEjE,MAAM,CAAC,MAAM,kBAAkB,GAAG,KAAK,EAAE,EACxC,OAAO,EACP,EAAE,EACF,EAAE,EAAE,UAAU,GACG,EAAqB,EAAE;IACxC,IAAI,OAAO,UAAU,KAAK,QAAQ,EAAE,CAAC;QACpC,MAAM,IAAI,mBAAmB,CAC5B,qDAAqD,CACrD,CAAC;IACH,CAAC;IACD,MAAM,EAAE,EAAE,EAAE,OAAO,EAAE,QAAQ,EAAE,GAAG,MAAM,gBAAgB,CACvD,OAAO,EACP,UAAU,EACV,EAAE,CACF,CAAC;IACF,MAAM,OAAO,GAAG,yBAAyB,EAAE,CAAC;IAE5C,MAAM,GAAG,CAAC,WAAW,CAAC,KAAK,CAAC;QAC3B,QAAQ,EAAE,kBAAkB;QAC5B,IAAI,EAAE;YACL,MAAM,EAAE,WAAW;SACnB;QACD,EAAE;QACF,WAAW,EAAE;YACZ,EAAE,EAAE,EAAE;YACN,GAAG,EAAE,WAAW,CAAC,IAAI;SACrB;KACD,CAAC,CAAC;IAKH,MAAM,OAAO,CAAC,eAAe,CAAC,MAAM,CAAC,EAAE,OAAO,EAAE,QAAQ,EAAE,CAAC,CAAC;IAE5D,OAAO;QACN,UAAU,EAAE,GAAG;KACf,CAAC;AACH,CAAC,CAAC;AAEF,MAAM,gBAAgB,GAAG,KAAK,EAC7B,OAA2B,EAC3B,UAAkB,EAClB,EAAM,EACL,EAAE;IACH,MAAM,EAAE,IAAI,EAAE,GAAG,OAAO,CAAC,MAAM,CAAC;IAChC,IAAI,CAAC,IAAI,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;QACvC,MAAM,IAAI,eAAe,CAAC,mBAAmB,CAAC,CAAC;IAChD,CAAC;IAED,MAAM,CAAC,eAAe,CAAC,GAAG,MAAM,GAAG,CAAC,WAAW,CAAC,GAAG,CAAC;QACnD,QAAQ,EAAE,kBAAkB;QAC5B,OAAO,EAAE;YACR,OAAO,EAAE,CAAC,IAAI,EAAE,UAAU,EAAE,WAAW,CAAC;YACxC,OAAO,EAAE;gBAER,IAAI;gBACJ,MAAM,EAAE,SAAS;gBACjB,WAAW,EAAE,EAAE,GAAG,EAAE,EAAE,IAAI,EAAE,EAAE,EAAE,EAAE;gBAClC,aAAa,EAAE,OAAO,CAAC,YAAY;gBACnC,WAAW,EAAE,UAAU;aACvB;SACD;QACD,WAAW,EAAE;YACZ,EAAE;YACF,GAAG,EAAE,WAAW,CAAC,QAAQ;SACzB;KACD,CAAC,CAAC;IAEH,IAAI,eAAe,IAAI,IAAI,EAAE,CAAC;QAC7B,MAAM,IAAI,iBAAiB,EAAE,CAAC;IAC/B,CAAC;IAED,OAAO;QACN,EAAE,EAAE,eAAe,CAAC,EAAE;QACtB,OAAO,EAAE,eAAe,CAAC,QAAQ;QACjC,QAAQ,EAAE,eAAe,CAAC,SAAS;KACnC,CAAC;AACH,CAAC,CAAC"}
@@ -1,3 +0,0 @@
1
- import type { ODataActionArgs } from '../../sbvr-api/actions.js';
2
- import type { Response } from '../../sbvr-api/sbvr-utils.js';
3
- export declare const commitUploadAction: ({ request, tx, id, api: applicationApi, }: ODataActionArgs) => Promise<Response>;
@@ -1,85 +0,0 @@
1
- import { BadRequestError, NotImplementedError, UnauthorizedError, } from '../../sbvr-api/errors.js';
2
- import { api } from '../../sbvr-api/sbvr-utils.js';
3
- import { permissions } from '../../server-glue/module.js';
4
- import { getMultipartUploadHandler } from '../multiparUpload.js';
5
- export const commitUploadAction = async ({ request, tx, id, api: applicationApi, }) => {
6
- if (typeof id !== 'number') {
7
- throw new NotImplementedError('multipart upload do not yet support non-numeric ids');
8
- }
9
- const multipartUpload = await getOngoingUpload(request, id, tx);
10
- const handler = getMultipartUploadHandler();
11
- const webresource = await handler.multipartUpload.commit({
12
- fileKey: multipartUpload.fileKey,
13
- uploadId: multipartUpload.uploadId,
14
- filename: multipartUpload.filename,
15
- providerCommitData: multipartUpload.providerCommitData,
16
- });
17
- await Promise.all([
18
- api.webresource.patch({
19
- resource: 'multipart_upload',
20
- body: {
21
- status: 'completed',
22
- },
23
- options: {
24
- $filter: {
25
- uuid: multipartUpload.uuid,
26
- },
27
- },
28
- passthrough: {
29
- tx: tx,
30
- req: permissions.root,
31
- },
32
- }),
33
- applicationApi.patch({
34
- resource: request.resourceName,
35
- id,
36
- body: {
37
- [multipartUpload.fieldName]: webresource,
38
- },
39
- passthrough: {
40
- tx: tx,
41
- req: permissions.root,
42
- },
43
- }),
44
- ]);
45
- const body = await handler.onPreRespond(webresource);
46
- return {
47
- body,
48
- statusCode: 200,
49
- };
50
- };
51
- const getOngoingUpload = async (request, affectedId, tx) => {
52
- const { uuid, providerCommitData } = request.values;
53
- if (!uuid || typeof uuid !== 'string') {
54
- throw new BadRequestError('Invalid uuid type');
55
- }
56
- const [multipartUpload] = await api.webresource.get({
57
- resource: 'multipart_upload',
58
- options: {
59
- $select: ['id', 'file_key', 'upload_id', 'field_name', 'filename'],
60
- $filter: {
61
- uuid,
62
- status: 'pending',
63
- expiry_date: { $gt: { $now: {} } },
64
- resource_name: request.resourceName,
65
- resource_id: affectedId,
66
- },
67
- },
68
- passthrough: {
69
- tx,
70
- req: permissions.rootRead,
71
- },
72
- });
73
- if (multipartUpload == null) {
74
- throw new UnauthorizedError();
75
- }
76
- return {
77
- uuid,
78
- providerCommitData,
79
- fileKey: multipartUpload.file_key,
80
- uploadId: multipartUpload.upload_id,
81
- filename: multipartUpload.filename,
82
- fieldName: multipartUpload.field_name,
83
- };
84
- };
85
- //# sourceMappingURL=commitUpload.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"commitUpload.js","sourceRoot":"","sources":["../../../src/webresource-handler/actions/commitUpload.ts"],"names":[],"mappings":"AAKA,OAAO,EACN,eAAe,EACf,mBAAmB,EACnB,iBAAiB,GACjB,MAAM,0BAA0B,CAAC;AAElC,OAAO,EAAE,GAAG,EAAE,MAAM,8BAA8B,CAAC;AACnD,OAAO,EAAE,WAAW,EAAE,MAAM,6BAA6B,CAAC;AAC1D,OAAO,EAAE,yBAAyB,EAAE,MAAM,sBAAsB,CAAC;AAEjE,MAAM,CAAC,MAAM,kBAAkB,GAAG,KAAK,EAAE,EACxC,OAAO,EACP,EAAE,EACF,EAAE,EACF,GAAG,EAAE,cAAc,GACF,EAAqB,EAAE;IACxC,IAAI,OAAO,EAAE,KAAK,QAAQ,EAAE,CAAC;QAC5B,MAAM,IAAI,mBAAmB,CAC5B,qDAAqD,CACrD,CAAC;IACH,CAAC;IAED,MAAM,eAAe,GAAG,MAAM,gBAAgB,CAAC,OAAO,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC;IAChE,MAAM,OAAO,GAAG,yBAAyB,EAAE,CAAC;IAE5C,MAAM,WAAW,GAAG,MAAM,OAAO,CAAC,eAAe,CAAC,MAAM,CAAC;QACxD,OAAO,EAAE,eAAe,CAAC,OAAO;QAChC,QAAQ,EAAE,eAAe,CAAC,QAAQ;QAClC,QAAQ,EAAE,eAAe,CAAC,QAAQ;QAClC,kBAAkB,EAAE,eAAe,CAAC,kBAAkB;KACtD,CAAC,CAAC;IAEH,MAAM,OAAO,CAAC,GAAG,CAAC;QACjB,GAAG,CAAC,WAAW,CAAC,KAAK,CAAC;YACrB,QAAQ,EAAE,kBAAkB;YAC5B,IAAI,EAAE;gBACL,MAAM,EAAE,WAAW;aACnB;YACD,OAAO,EAAE;gBACR,OAAO,EAAE;oBACR,IAAI,EAAE,eAAe,CAAC,IAAI;iBAC1B;aACD;YACD,WAAW,EAAE;gBACZ,EAAE,EAAE,EAAE;gBACN,GAAG,EAAE,WAAW,CAAC,IAAI;aACrB;SACD,CAAC;QACF,cAAc,CAAC,KAAK,CAAC;YACpB,QAAQ,EAAE,OAAO,CAAC,YAAY;YAC9B,EAAE;YACF,IAAI,EAAE;gBACL,CAAC,eAAe,CAAC,SAAS,CAAC,EAAE,WAAW;aACxC;YACD,WAAW,EAAE;gBACZ,EAAE,EAAE,EAAE;gBAEN,GAAG,EAAE,WAAW,CAAC,IAAI;aACrB;SACD,CAAC;KACF,CAAC,CAAC;IAEH,MAAM,IAAI,GAAG,MAAM,OAAO,CAAC,YAAY,CAAC,WAAW,CAAC,CAAC;IAErD,OAAO;QACN,IAAI;QACJ,UAAU,EAAE,GAAG;KACf,CAAC;AACH,CAAC,CAAC;AAEF,MAAM,gBAAgB,GAAG,KAAK,EAC7B,OAA2B,EAC3B,UAAkB,EAClB,EAAM,EACL,EAAE;IACH,MAAM,EAAE,IAAI,EAAE,kBAAkB,EAAE,GAAG,OAAO,CAAC,MAAM,CAAC;IACpD,IAAI,CAAC,IAAI,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;QACvC,MAAM,IAAI,eAAe,CAAC,mBAAmB,CAAC,CAAC;IAChD,CAAC;IAED,MAAM,CAAC,eAAe,CAAC,GAAG,MAAM,GAAG,CAAC,WAAW,CAAC,GAAG,CAAC;QACnD,QAAQ,EAAE,kBAAkB;QAC5B,OAAO,EAAE;YACR,OAAO,EAAE,CAAC,IAAI,EAAE,UAAU,EAAE,WAAW,EAAE,YAAY,EAAE,UAAU,CAAC;YAClE,OAAO,EAAE;gBAER,IAAI;gBACJ,MAAM,EAAE,SAAS;gBACjB,WAAW,EAAE,EAAE,GAAG,EAAE,EAAE,IAAI,EAAE,EAAE,EAAE,EAAE;gBAClC,aAAa,EAAE,OAAO,CAAC,YAAY;gBACnC,WAAW,EAAE,UAAU;aACvB;SACD;QACD,WAAW,EAAE;YACZ,EAAE;YACF,GAAG,EAAE,WAAW,CAAC,QAAQ;SACzB;KACD,CAAC,CAAC;IAEH,IAAI,eAAe,IAAI,IAAI,EAAE,CAAC;QAC7B,MAAM,IAAI,iBAAiB,EAAE,CAAC;IAC/B,CAAC;IAED,OAAO;QACN,IAAI;QACJ,kBAAkB;QAClB,OAAO,EAAE,eAAe,CAAC,QAAQ;QACjC,QAAQ,EAAE,eAAe,CAAC,SAAS;QACnC,QAAQ,EAAE,eAAe,CAAC,QAAQ;QAClC,SAAS,EAAE,eAAe,CAAC,UAAU;KACrC,CAAC;AACH,CAAC,CAAC"}
@@ -1,4 +0,0 @@
1
- import type { WebResourceHandler } from './index.js';
2
- export type MultipartUploadHandler = WebResourceHandler & Required<Pick<WebResourceHandler, 'multipartUpload'>>;
3
- export declare const isMultipartUploadAvailable: (handler: WebResourceHandler | undefined) => handler is MultipartUploadHandler;
4
- export declare const getMultipartUploadHandler: () => MultipartUploadHandler;
@@ -1,14 +0,0 @@
1
- import { webResource as webResourceEnv } from '../config-loader/env.js';
2
- import { NotImplementedError } from '../sbvr-api/errors.js';
3
- import { getWebresourceHandler } from './index.js';
4
- export const isMultipartUploadAvailable = (handler) => {
5
- return (webResourceEnv.multipartUploadEnabled && handler?.multipartUpload != null);
6
- };
7
- export const getMultipartUploadHandler = () => {
8
- const handler = getWebresourceHandler();
9
- if (!isMultipartUploadAvailable(handler)) {
10
- throw new NotImplementedError('Multipart uploads not available');
11
- }
12
- return handler;
13
- };
14
- //# sourceMappingURL=multiparUpload.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"multiparUpload.js","sourceRoot":"","sources":["../../src/webresource-handler/multiparUpload.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,IAAI,cAAc,EAAE,MAAM,yBAAyB,CAAC;AACxE,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAE5D,OAAO,EAAE,qBAAqB,EAAE,MAAM,YAAY,CAAC;AAKnD,MAAM,CAAC,MAAM,0BAA0B,GAAG,CACzC,OAAuC,EACH,EAAE;IACtC,OAAO,CACN,cAAc,CAAC,sBAAsB,IAAI,OAAO,EAAE,eAAe,IAAI,IAAI,CACzE,CAAC;AACH,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,yBAAyB,GAAG,GAAG,EAAE;IAC7C,MAAM,OAAO,GAAG,qBAAqB,EAAE,CAAC;IACxC,IAAI,CAAC,0BAA0B,CAAC,OAAO,CAAC,EAAE,CAAC;QAC1C,MAAM,IAAI,mBAAmB,CAAC,iCAAiC,CAAC,CAAC;IAClE,CAAC;IACD,OAAO,OAAO,CAAC;AAChB,CAAC,CAAC"}
@@ -1,42 +0,0 @@
1
- import type { Types } from '@balena/abstract-sql-to-typescript';
2
- export interface MultipartUpload {
3
- Read: {
4
- created_at: Types['Date Time']['Read'];
5
- modified_at: Types['Date Time']['Read'];
6
- id: Types['Serial']['Read'];
7
- uuid: Types['Short Text']['Read'];
8
- resource_name: Types['Short Text']['Read'];
9
- field_name: Types['Short Text']['Read'];
10
- resource_id: Types['Integer']['Read'];
11
- upload_id: Types['Short Text']['Read'];
12
- file_key: Types['Short Text']['Read'];
13
- status: 'pending' | 'completed' | 'cancelled';
14
- filename: Types['Short Text']['Read'];
15
- content_type: Types['Short Text']['Read'];
16
- size: Types['Integer']['Read'];
17
- chunk_size: Types['Integer']['Read'];
18
- expiry_date: Types['Date Time']['Read'];
19
- is_created_by__actor: Types['Integer']['Read'] | null;
20
- };
21
- Write: {
22
- created_at: Types['Date Time']['Write'];
23
- modified_at: Types['Date Time']['Write'];
24
- id: Types['Serial']['Write'];
25
- uuid: Types['Short Text']['Write'];
26
- resource_name: Types['Short Text']['Write'];
27
- field_name: Types['Short Text']['Write'];
28
- resource_id: Types['Integer']['Write'];
29
- upload_id: Types['Short Text']['Write'];
30
- file_key: Types['Short Text']['Write'];
31
- status: 'pending' | 'completed' | 'cancelled';
32
- filename: Types['Short Text']['Write'];
33
- content_type: Types['Short Text']['Write'];
34
- size: Types['Integer']['Write'];
35
- chunk_size: Types['Integer']['Write'];
36
- expiry_date: Types['Date Time']['Write'];
37
- is_created_by__actor: Types['Integer']['Write'] | null;
38
- };
39
- }
40
- export default interface $Model {
41
- multipart_upload: MultipartUpload;
42
- }
@@ -1,2 +0,0 @@
1
- export {};
2
- //# sourceMappingURL=webresource.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"webresource.js","sourceRoot":"","sources":["../../src/webresource-handler/webresource.ts"],"names":[],"mappings":""}
@@ -1,60 +0,0 @@
1
- Vocabulary: webresource
2
-
3
- Term: actor
4
- Concept Type: Integer (Type)
5
- Term: expiry date
6
- Concept Type: Date Time (Type)
7
- Term: uuid
8
- Concept Type: Short Text (Type)
9
- Term: resource name
10
- Concept Type: Short Text (Type)
11
- Term: field name
12
- Concept Type: Short Text (Type)
13
- Term: resource id
14
- Concept Type: Integer (Type)
15
- Term: upload id
16
- Concept Type: Short Text (Type)
17
- Term: file key
18
- Concept Type: Short Text (Type)
19
- Term: status
20
- Concept Type: Short Text (Type)
21
- Term: filename
22
- Concept Type: Short Text (Type)
23
- Term: content type
24
- Concept Type: Short Text (Type)
25
- Term: size
26
- Concept Type: Integer (Type)
27
- Term: chunk size
28
- Concept Type: Integer (Type)
29
- Term: valid until date
30
- Concept Type: Date Time (Type)
31
-
32
- Term: multipart upload
33
- Fact type: multipart upload has uuid
34
- Necessity: each multipart upload has exactly one uuid
35
- Necessity: each uuid is of exactly one multipart upload
36
- Fact type: multipart upload has resource name
37
- Necessity: each multipart upload has exactly one resource name
38
- Fact type: multipart upload has field name
39
- Necessity: each multipart upload has exactly one field name
40
- Fact type: multipart upload has resource id
41
- Necessity: each multipart upload has exactly one resource id
42
- Fact type: multipart upload has upload id
43
- Necessity: each multipart upload has exactly one upload id
44
- Fact type: multipart upload has file key
45
- Necessity: each multipart upload has exactly one file key
46
- Fact type: multipart upload has status
47
- Necessity: each multipart upload has exactly one status
48
- Definition: "pending" or "completed" or "cancelled"
49
- Fact type: multipart upload has filename
50
- Necessity: each multipart upload has exactly one filename
51
- Fact type: multipart upload has content type
52
- Necessity: each multipart upload has exactly one content type
53
- Fact type: multipart upload has size
54
- Necessity: each multipart upload has exactly one size
55
- Fact type: multipart upload has chunk size
56
- Necessity: each multipart upload has exactly one chunk size
57
- Fact type: multipart upload has expiry date
58
- Necessity: each multipart upload has exactly one expiry date
59
- Fact type: multipart upload is created by actor
60
- Necessity: each multipart upload is created by at most one actor
@@ -1,160 +0,0 @@
1
- import type { AnyObject } from 'pinejs-client-core';
2
-
3
- import { api, type Response } from '../../sbvr-api/sbvr-utils.js';
4
- import type { MultipartUploadHandler } from '../multiparUpload.js';
5
- import { getMultipartUploadHandler } from '../multiparUpload.js';
6
- import type { BeginMultipartUploadPayload } from '../index.js';
7
- import { getWebResourceFields } from '../index.js';
8
- import { BadRequestError, NotImplementedError } from '../../sbvr-api/errors.js';
9
- import { permissions, sbvrUtils } from '../../server-glue/module.js';
10
- import { TransactionClosedError } from '../../database-layer/db.js';
11
- import { randomUUID } from 'crypto';
12
- import type { WebResourceType as WebResource } from '@balena/sbvr-types';
13
- import type {
14
- ODataActionArgs,
15
- ODataActionRequest,
16
- } from '../../sbvr-api/actions.js';
17
-
18
- type FakeWebResourcePatch = {
19
- [key: string]: Omit<WebResource, 'href'> & {
20
- href: 'fake_patch';
21
- };
22
- };
23
-
24
- export const beginUploadAction = async ({
25
- request,
26
- tx,
27
- id,
28
- req,
29
- }: ODataActionArgs): Promise<Response> => {
30
- if (typeof id !== 'number') {
31
- throw new NotImplementedError(
32
- 'multipart upload do not yet support non-numeric ids',
33
- );
34
- }
35
-
36
- const handler = getMultipartUploadHandler();
37
- const { fieldName, beginUploadPayload } = parseBeginUpload(request, handler);
38
-
39
- await runFakeDbPatch(request, {
40
- [fieldName]: { ...beginUploadPayload, href: 'fake_patch' },
41
- });
42
-
43
- const { fileKey, uploadId, uploadParts } =
44
- await handler.multipartUpload.begin(fieldName, beginUploadPayload);
45
- const uuid = randomUUID();
46
- await api.webresource.post({
47
- resource: 'multipart_upload',
48
- body: {
49
- uuid,
50
- resource_name: request.resourceName,
51
- field_name: fieldName,
52
- resource_id: id,
53
- upload_id: uploadId,
54
- file_key: fileKey,
55
- status: 'pending',
56
- ...beginUploadPayload,
57
- expiry_date: Date.now() + 7 * 24 * 60 * 60 * 1000, // 7 days in ms
58
- is_created_by__actor: req.user?.actor,
59
- },
60
- passthrough: {
61
- req: permissions.root,
62
- tx,
63
- },
64
- });
65
-
66
- return {
67
- body: { [fieldName]: { uuid, uploadParts } },
68
- statusCode: 200,
69
- };
70
- };
71
-
72
- const parseBeginUpload = (
73
- request: ODataActionRequest,
74
- webResourceHandler: MultipartUploadHandler,
75
- ) => {
76
- const fieldNames = Object.keys(request.values);
77
- if (fieldNames.length !== 1) {
78
- throw new BadRequestError(
79
- 'You can only get upload url for one field at a time',
80
- );
81
- }
82
-
83
- const [fieldName] = fieldNames;
84
- const webResourceFields = getWebResourceFields(request, false);
85
- if (!webResourceFields.includes(fieldName)) {
86
- throw new BadRequestError(
87
- `The provided field '${fieldName}' is not a valid webresource`,
88
- );
89
- }
90
-
91
- const beginUploadPayload = parseBeginUploadPayload(
92
- request.values[fieldName],
93
- webResourceHandler,
94
- );
95
- if (beginUploadPayload == null) {
96
- throw new BadRequestError('Invalid file metadata');
97
- }
98
-
99
- return {
100
- beginUploadPayload,
101
- fieldName,
102
- };
103
- };
104
-
105
- const parseBeginUploadPayload = (
106
- payload: AnyObject,
107
- webResourceHandler: MultipartUploadHandler,
108
- ): BeginMultipartUploadPayload | null => {
109
- if (payload == null || typeof payload !== 'object') {
110
- return null;
111
- }
112
-
113
- let { filename, content_type, size, chunk_size } = payload;
114
- if (
115
- typeof filename !== 'string' ||
116
- typeof content_type !== 'string' ||
117
- typeof size !== 'number' ||
118
- (chunk_size != null && typeof chunk_size !== 'number') ||
119
- (chunk_size != null &&
120
- chunk_size < webResourceHandler.multipartUpload.getMinimumPartSize())
121
- ) {
122
- return null;
123
- }
124
-
125
- chunk_size ??= webResourceHandler.multipartUpload.getDefaultPartSize();
126
-
127
- return { filename, content_type, size, chunk_size };
128
- };
129
-
130
- // TODO: comment explaining why run this fake transaction is important
131
- const runFakeDbPatch = async (
132
- request: ODataActionRequest,
133
- fakeDbPatch: FakeWebResourcePatch,
134
- ) => {
135
- try {
136
- await sbvrUtils.db.transaction(async (fakeTx) => {
137
- const newUrl = request.url.slice(1).replace(/\/beginUpload$/, '');
138
- await api[request.vocabulary].request({
139
- method: 'PATCH',
140
- url: newUrl,
141
- body: fakeDbPatch,
142
- // TODO: comment explaining why root is necessary
143
- passthrough: { tx: fakeTx, req: permissions.root },
144
- });
145
-
146
- await fakeTx.rollback();
147
- });
148
- } catch (e) {
149
- if (
150
- // calling rollback() always makes it throw, so we capture and move on in case
151
- // the error was just because the tx was (on purpose) rolledback
152
- !(
153
- e instanceof TransactionClosedError &&
154
- e.message === 'Transaction has been rolled back.'
155
- )
156
- ) {
157
- throw e;
158
- }
159
- }
160
- };
@@ -1,92 +0,0 @@
1
- import type {
2
- ODataActionArgs,
3
- ODataActionRequest,
4
- } from '../../sbvr-api/actions.js';
5
- import type { Tx } from '../../database-layer/db.js';
6
- import {
7
- BadRequestError,
8
- NotImplementedError,
9
- UnauthorizedError,
10
- } from '../../sbvr-api/errors.js';
11
- import { api, type Response } from '../../sbvr-api/sbvr-utils.js';
12
- import { permissions } from '../../server-glue/module.js';
13
- import { getMultipartUploadHandler } from '../multiparUpload.js';
14
-
15
- export const cancelUploadAction = async ({
16
- request,
17
- tx,
18
- id: resourceId,
19
- }: ODataActionArgs): Promise<Response> => {
20
- if (typeof resourceId !== 'number') {
21
- throw new NotImplementedError(
22
- 'multipart upload do not yet support non-numeric ids',
23
- );
24
- }
25
- const { id, fileKey, uploadId } = await getOngoingUpload(
26
- request,
27
- resourceId,
28
- tx,
29
- );
30
- const handler = getMultipartUploadHandler();
31
-
32
- await api.webresource.patch({
33
- resource: 'multipart_upload',
34
- body: {
35
- status: 'cancelled',
36
- },
37
- id,
38
- passthrough: {
39
- tx: tx,
40
- req: permissions.root,
41
- },
42
- });
43
-
44
- // Note that different then beginUpload/commitUpload where we first do the action on the external service
45
- // and then reflect it on the DB, for cancel upload it is the other way around
46
- // as the worst case scenario is having a canceled upload which is marked on the DB as something else
47
- await handler.multipartUpload.cancel({ fileKey, uploadId });
48
-
49
- return {
50
- statusCode: 204,
51
- };
52
- };
53
-
54
- const getOngoingUpload = async (
55
- request: ODataActionRequest,
56
- affectedId: number,
57
- tx: Tx,
58
- ) => {
59
- const { uuid } = request.values;
60
- if (!uuid || typeof uuid !== 'string') {
61
- throw new BadRequestError('Invalid uuid type');
62
- }
63
-
64
- const [multipartUpload] = await api.webresource.get({
65
- resource: 'multipart_upload',
66
- options: {
67
- $select: ['id', 'file_key', 'upload_id'],
68
- $filter: {
69
- // TODO: swap this into the ID to see if it works
70
- uuid,
71
- status: 'pending',
72
- expiry_date: { $gt: { $now: {} } },
73
- resource_name: request.resourceName,
74
- resource_id: affectedId,
75
- },
76
- },
77
- passthrough: {
78
- tx,
79
- req: permissions.rootRead,
80
- },
81
- });
82
-
83
- if (multipartUpload == null) {
84
- throw new UnauthorizedError();
85
- }
86
-
87
- return {
88
- id: multipartUpload.id,
89
- fileKey: multipartUpload.file_key,
90
- uploadId: multipartUpload.upload_id,
91
- };
92
- };