@balena/pinejs 21.3.1-build-webresource-delete-reliable-7d16043f72b2a015f309d0e0a504d9ce22844008-1 → 21.3.2-build-renovate-minio-mc-2025-x-da1cec8047050b0fc2defc6939dbe2b5e5302ab4-1

package/src/webresource-handler/index.ts

@@ -15,8 +15,6 @@ import { errors, permissions } from '../server-glue/module.js';
 import type { WebResourceType as WebResource } from '@balena/sbvr-types';
 import { TypedError } from 'typed-error';
 import type { Resolvable } from '../sbvr-api/common-types.js';
-import type { Tx } from '../database-layer/db.js';
-import { isPineTasksAvailable } from '../tasks/index.js';
 
 export * from './handlers/index.js';
 
@@ -318,34 +316,12 @@ export const getWebResourceFields = (
 		.map((f) => sqlNameToODataName(f.fieldName));
 };
 
-const deleteOnStorage = async (keysToDelete: string[], tx?: Tx) => {
-	if (isPineTasksAvailable()) {
-		await Promise.all(
-			keysToDelete.map(async (fileKey) => {
-				return await sbvrUtils.api.tasks.post({
-					resource: 'task',
-					passthrough: {
-						req: permissions.root,
-						tx,
-					},
-					body: {
-						key: crypto.randomUUID(),
-						is_executed_by__handler: 'delete_webresource_file',
-						is_executed_with__parameter_set: {
-							fileKey: fileKey,
-						},
-						attempt_limit: 2 ** 31 - 1,
-					},
-				});
-			}),
-		);
-	} else {
-		await Promise.all(
-			keysToDelete.map(async (fileKey) => {
-				return await configuredWebResourceHandler?.removeFile(fileKey);
-			}),
-		);
-	}
+const deleteFiles = async (
+	keysToDelete: string[],
+	webResourceHandler: WebResourceHandler,
+) => {
+	const promises = keysToDelete.map((r) => webResourceHandler.removeFile(r));
+	await Promise.all(promises);
 };
 
 const throwIfWebresourceNotInMultipart = (
@@ -362,22 +338,18 @@ const throwIfWebresourceNotInMultipart = (
 	}
 };
 
-const getCreateWebResourceHooks = (): sbvrUtils.Hooks => {
+const getCreateWebResourceHooks = (
+	webResourceHandler: WebResourceHandler,
+): sbvrUtils.Hooks => {
 	return {
 		PRERUN: (hookArgs) => {
 			const webResourceFields = getWebResourceFields(hookArgs.request);
 			throwIfWebresourceNotInMultipart(webResourceFields, hookArgs);
 		},
-		'POSTRUN-ERROR': async ({ request }) => {
-			const fields = getWebResourceFields(request);
-
-			if (fields.length === 0) {
-				return;
-			}
-
-			const keysToDelete = getWebResourcesKeysFromRequest(fields, request);
-			// Explicitely not passing tx as it will be rolledback as it is an error hook
-			await deleteOnStorage(keysToDelete);
+		'POSTRUN-ERROR': ({ tx, request }) => {
+			tx.on('rollback', () => {
+				void deleteRollbackPendingFields(request, webResourceHandler);
+			});
 		},
 	};
 };
@@ -406,12 +378,21 @@ const getWebResourcesKeysFromRequest = (
 		.filter((href) => href != null);
 };
 
-const getRemoveWebResourceHooks = (): sbvrUtils.Hooks => {
+const getRemoveWebResourceHooks = (
+	webResourceHandler: WebResourceHandler,
+): sbvrUtils.Hooks => {
 	return {
 		PRERUN: async (args) => {
 			const { api, request, tx } = args;
 			let webResourceFields = getWebResourceFields(request);
 
+			throwIfWebresourceNotInMultipart(webResourceFields, args);
+
+			// Request failed on DB roundtrip (e.g. DB constraint) and pending files need to be deleted
+			tx.on('rollback', () => {
+				void deleteRollbackPendingFields(request, webResourceHandler);
+			});
+
 			if (request.method === 'PATCH') {
 				webResourceFields = Object.entries(request.values)
 					.filter(
@@ -420,8 +401,6 @@ const getRemoveWebResourceHooks = (): sbvrUtils.Hooks => {
 					)
 					.map(([key]) => key);
 			}
-			request.custom.webResourceFields = webResourceFields;
-			throwIfWebresourceNotInMultipart(webResourceFields, args);
 
 			if (webResourceFields.length === 0) {
 				// No need to delete anything as no file is in the wire
@@ -432,32 +411,43 @@ const getRemoveWebResourceHooks = (): sbvrUtils.Hooks => {
 			// This can only be validated here because we need to first ensure the
 			// request is actually modifying a webresource before erroring out
 			if (request.method === 'PATCH' && request.odataQuery?.key == null) {
+				// When we get here, files have already been uploaded. We need to mark them for deletion.
+				const keysToDelete = getWebResourcesKeysFromRequest(
+					webResourceFields,
+					request,
+				);
+
+				// Set deletion of files on the wire as request will throw
+				tx.on('end', () => {
+					deletePendingFiles(keysToDelete, request, webResourceHandler);
+				});
+
 				throw new errors.BadRequestError(
 					'WebResources can only be updated when providing a resource key.',
 				);
 			}
 
+			// This can be > 1 in both DELETE requests or PATCH requests to not accessible IDs.
 			const ids = await sbvrUtils.getAffectedIds(args);
 			if (ids.length === 0) {
 				// Set deletion of files on the wire as no resource was affected
-				request.custom.onPostRunDelete = getWebResourcesKeysFromRequest(
+				// Note that for DELETE requests it should not find any request on the wire
+				const keysToDelete = getWebResourcesKeysFromRequest(
 					webResourceFields,
 					request,
 				);
+				deletePendingFiles(keysToDelete, request, webResourceHandler);
 				return;
 			}
 
-			// If it reaches here, it means that it will try to patch/delete the webresource
-			// So we need (before postrun) get what are the current keys to be deleted
-			// if post run succeeds
 			const webResources = (await api.get({
 				resource: request.resourceName,
 				passthrough: {
-					tx,
+					tx: args.tx,
 					req: permissions.root,
 				},
 				options: {
-					$select: request.custom.webResourceFields,
+					$select: webResourceFields,
 					$filter: {
 						id: {
 							$in: ids,
@@ -465,34 +455,60 @@ const getRemoveWebResourceHooks = (): sbvrUtils.Hooks => {
 					},
 				},
 			})) as WebResourcesDbResponse[] | undefined | null;
-			request.custom.onPostRunDelete = getWebResourcesHrefs(webResources);
-		},
 
-		POSTRUN: async ({ request, tx }) => {
-			// Either patch or delete worked. In either case, schedule the previous existing files to delete
-			await deleteOnStorage(request.custom.onPostRunDelete ?? [], tx);
-		},
-		'POSTRUN-ERROR': async ({ request }) => {
-			const keysToDelete = getWebResourcesKeysFromRequest(
-				request.custom.webResourceFields,
-				request,
-			);
-			// Explicitely not passing tx as it will be rolledback as it is an error hook
-			await deleteOnStorage(keysToDelete);
+			// Deletes previous stored resources in case they were patched or the whole entity was deleted
+			tx.on('end', () => {
+				deletePendingFiles(
+					getWebResourcesHrefs(webResources),
+					request,
+					webResourceHandler,
+				);
+			});
 		},
 	};
 };
 
+const deleteRollbackPendingFields = async (
+	request: uriParser.ODataRequest,
+	webResourceHandler: WebResourceHandler,
+) => {
+	const fields = getWebResourceFields(request);
+
+	if (fields.length === 0) {
+		return;
+	}
+
+	const keysToDelete = getWebResourcesKeysFromRequest(fields, request);
+	await deleteFiles(keysToDelete, webResourceHandler);
+};
+
+const deletePendingFiles = (
+	keysToDelete: string[],
+	request: uriParser.ODataRequest,
+	webResourceHandler: WebResourceHandler,
+): void => {
+	// on purpose does not await for this promise to resolve
+	try {
+		void deleteFiles(keysToDelete, webResourceHandler);
+	} catch (err) {
+		getLogger(request.vocabulary).error(`Failed to delete pending files`, err);
+	}
+};
+
 export const getDefaultHandler = (): WebResourceHandler => {
 	return new NoopHandler();
 };
 
-export const setupUploadHooks = (apiRoot: string, resourceName: string) => {
+export const setupUploadHooks = (
+	handler: WebResourceHandler,
+	apiRoot: string,
+	resourceName: string,
+) => {
 	sbvrUtils.addPureHook(
 		'DELETE',
 		apiRoot,
 		resourceName,
-		getRemoveWebResourceHooks(),
+		getRemoveWebResourceHooks(handler),
 	);
 
 	sbvrUtils.addPureHook(
@@ -500,13 +516,13 @@ export const setupUploadHooks = (apiRoot: string, resourceName: string) => {
 		apiRoot,
 		resourceName,
 		// PATCH also needs to remove the old resource in case a webresource was modified
-		getRemoveWebResourceHooks(),
+		getRemoveWebResourceHooks(handler),
 	);
 
 	sbvrUtils.addPureHook(
 		'POST',
 		apiRoot,
 		resourceName,
-		getCreateWebResourceHooks(),
+		getCreateWebResourceHooks(handler),
 	);
 };

package/out/tasks/pine-tasks.d.ts

@@ -1 +0,0 @@
-export declare const addPineTaskHandlers: () => void;

package/out/tasks/pine-tasks.js

@@ -1,7 +0,0 @@
-import { tasks } from '../server-glue/module.js';
-import { addDeleteFileTaskHandler } from '../webresource-handler/delete-file-task.js';
-export const addPineTaskHandlers = () => {
-    addDeleteFileTaskHandler();
-    void tasks.worker?.start();
-};
-//# sourceMappingURL=pine-tasks.js.map

package/out/tasks/pine-tasks.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"pine-tasks.js","sourceRoot":"","sources":["../../src/tasks/pine-tasks.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,0BAA0B,CAAC;AACjD,OAAO,EAAE,wBAAwB,EAAE,MAAM,4CAA4C,CAAC;AAEtF,MAAM,CAAC,MAAM,mBAAmB,GAAG,GAAG,EAAE;IACvC,wBAAwB,EAAE,CAAC;IAC3B,KAAK,KAAK,CAAC,MAAM,EAAE,KAAK,EAAE,CAAC;AAC5B,CAAC,CAAC"}

package/out/webresource-handler/delete-file-task.d.ts

@@ -1 +0,0 @@
-export declare const addDeleteFileTaskHandler: () => void;

package/out/webresource-handler/delete-file-task.js

@@ -1,37 +0,0 @@
-import { addTaskHandler } from '../tasks/index.js';
-import { getWebresourceHandler } from './index.js';
-const deleteFileSchema = {
-    type: 'object',
-    properties: {
-        fileKey: {
-            type: 'string',
-        },
-    },
-    required: ['fileKey'],
-    additionalProperties: false,
-};
-export const addDeleteFileTaskHandler = () => {
-    addTaskHandler('delete_webresource_file', async (task) => {
-        const handler = getWebresourceHandler();
-        if (!handler) {
-            return {
-                error: 'Webresource handler not available',
-                status: 'failed',
-            };
-        }
-        try {
-            await handler.removeFile(task.params.fileKey);
-            return {
-                status: 'succeeded',
-            };
-        }
-        catch (error) {
-            console.error('Error deleting file:', error);
-            return {
-                error: `${error}`,
-                status: 'failed',
-            };
-        }
-    }, deleteFileSchema);
-};
-//# sourceMappingURL=delete-file-task.js.map

package/out/webresource-handler/delete-file-task.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"delete-file-task.js","sourceRoot":"","sources":["../../src/webresource-handler/delete-file-task.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC;AACnD,OAAO,EAAE,qBAAqB,EAAE,MAAM,YAAY,CAAC;AAEnD,MAAM,gBAAgB,GAAG;IACxB,IAAI,EAAE,QAAQ;IACd,UAAU,EAAE;QACX,OAAO,EAAE;YACR,IAAI,EAAE,QAAQ;SACd;KACD;IACD,QAAQ,EAAE,CAAC,SAAS,CAAC;IACrB,oBAAoB,EAAE,KAAK;CAClB,CAAC;AAEX,MAAM,CAAC,MAAM,wBAAwB,GAAG,GAAG,EAAE;IAC5C,cAAc,CACb,yBAAyB,EACzB,KAAK,EAAE,IAAI,EAAE,EAAE;QACd,MAAM,OAAO,GAAG,qBAAqB,EAAE,CAAC;QACxC,IAAI,CAAC,OAAO,EAAE,CAAC;YACd,OAAO;gBACN,KAAK,EAAE,mCAAmC;gBAC1C,MAAM,EAAE,QAAQ;aAChB,CAAC;QACH,CAAC;QAED,IAAI,CAAC;YACJ,MAAM,OAAO,CAAC,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;YAC9C,OAAO;gBACN,MAAM,EAAE,WAAW;aACnB,CAAC;QACH,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YAChB,OAAO,CAAC,KAAK,CAAC,sBAAsB,EAAE,KAAK,CAAC,CAAC;YAC7C,OAAO;gBACN,KAAK,EAAE,GAAG,KAAK,EAAE;gBACjB,MAAM,EAAE,QAAQ;aAChB,CAAC;QACH,CAAC;IACF,CAAC,EACD,gBAAgB,CAChB,CAAC;AACH,CAAC,CAAC"}

package/src/tasks/pine-tasks.ts

@@ -1,7 +0,0 @@
-import { tasks } from '../server-glue/module.js';
-import { addDeleteFileTaskHandler } from '../webresource-handler/delete-file-task.js';
-
-export const addPineTaskHandlers = () => {
-	addDeleteFileTaskHandler();
-	void tasks.worker?.start();
-};

package/src/webresource-handler/delete-file-task.ts

@@ -1,42 +0,0 @@
-import { addTaskHandler } from '../tasks/index.js';
-import { getWebresourceHandler } from './index.js';
-
-const deleteFileSchema = {
-	type: 'object',
-	properties: {
-		fileKey: {
-			type: 'string',
-		},
-	},
-	required: ['fileKey'],
-	additionalProperties: false,
-} as const;
-
-export const addDeleteFileTaskHandler = () => {
-	addTaskHandler(
-		'delete_webresource_file',
-		async (task) => {
-			const handler = getWebresourceHandler();
-			if (!handler) {
-				return {
-					error: 'Webresource handler not available',
-					status: 'failed',
-				};
-			}
-
-			try {
-				await handler.removeFile(task.params.fileKey);
-				return {
-					status: 'succeeded',
-				};
-			} catch (error) {
-				console.error('Error deleting file:', error);
-				return {
-					error: `${error}`,
-					status: 'failed',
-				};
-			}
-		},
-		deleteFileSchema,
-	);
-};