Merge pull request #25503 from acierto/clean-workspace-fix

Fixed the issue for cleaning the scaffolder workspace.

.changeset/five-tigers-share.md

@@ -0,0 +1,5 @@
+---
+'@backstage/plugin-scaffolder-backend': patch
+---
+
+Found the issue during testing the clean up of the workspace for the database implementation.

plugins/scaffolder-backend/src/scaffolder/tasks/DatabaseTaskStore.ts

@@ -532,8 +532,8 @@ export class DatabaseTaskStore implements TaskStore {
   }
 
   async cleanWorkspace({ taskId }: { taskId: string }): Promise<void> {
-    await this.db<RawDbTaskRow>('tasks').where({ id: taskId }).update({
-      workspace: undefined,
+    await this.db('tasks').where({ id: taskId }).update({
+      workspace: null,
     });
   }
 
@@ -542,10 +542,11 @@ export class DatabaseTaskStore implements TaskStore {
     taskId: string;
   }): Promise<void> {
     if (options.path) {
+      const workspace = (await serializeWorkspace(options)).contents;
       await this.db<RawDbTaskRow>('tasks')
         .where({ id: options.taskId })
         .update({
-          workspace: (await serializeWorkspace(options)).contents,
+          workspace,
         });
     }
   }

plugins/scaffolder-backend/src/scaffolder/tasks/DatabaseWorkspaceProvider.ts

@@ -29,7 +29,7 @@ export class DatabaseWorkspaceProvider implements WorkspaceProvider {
     path: string;
     taskId: string;
   }): Promise<void> {
-    this.storage.serializeWorkspace?.(options);
+    await this.storage.serializeWorkspace?.(options);
   }
 
   public async rehydrateWorkspace(options: {

plugins/scaffolder-backend/src/scaffolder/tasks/NunjucksWorkflowRunner.ts

@@ -509,11 +509,11 @@ export class NunjucksWorkflowRunner implements WorkflowRunner {
 
       const output = this.render(task.spec.output, context, renderTemplate);
       await taskTrack.markSuccessful();
+      await task.cleanWorkspace?.();
 
       return { output };
     } finally {
       if (workspacePath) {
-        await task.cleanWorkspace?.();
         await fs.remove(workspacePath);
       }
     }