From 4df96964b2014956d8b0f1dcbc12a50be4ef925f Mon Sep 17 00:00:00 2001
From: bnechyporenko <bnechyporenko@bol.com>
Date: Tue, 4 Jun 2024 10:54:22 +0200
Subject: [PATCH 01/13] Storing the serialized workspace into google cloud
 bucket

Signed-off-by: bnechyporenko <bnechyporenko@bol.com>
---
 .../src/scaffolder/tasks/StorageTaskBroker.ts | 28 ++----
 .../src/scaffolder/tasks/WorkspaceService.ts  | 90 +++++++++++++++++++
 2 files changed, 96 insertions(+), 22 deletions(-)
 create mode 100644 plugins/scaffolder-backend/src/scaffolder/tasks/WorkspaceService.ts

diff --git a/plugins/scaffolder-backend/src/scaffolder/tasks/StorageTaskBroker.ts b/plugins/scaffolder-backend/src/scaffolder/tasks/StorageTaskBroker.ts
index 03a2833938..4177780e06 100644
--- a/plugins/scaffolder-backend/src/scaffolder/tasks/StorageTaskBroker.ts
+++ b/plugins/scaffolder-backend/src/scaffolder/tasks/StorageTaskBroker.ts
@@ -34,6 +34,7 @@ import {
   AuthService,
   BackstageCredentials,
 } from '@backstage/backend-plugin-api';
+import { DefaultWorkspaceService, WorkspaceService } from './WorkspaceService';
 
 type TaskState = {
   checkpoints: {
@@ -71,8 +72,8 @@ export class TaskManager implements TaskContext {
       storage,
       abortSignal,
       logger,
+      DefaultWorkspaceService.create(task, storage, config),
       auth,
-      config,
     );
     agent.startTimeout();
     return agent;
@@ -84,8 +85,8 @@ export class TaskManager implements TaskContext {
     private readonly storage: TaskStore,
     private readonly signal: AbortSignal,
     private readonly logger: Logger,
+    private readonly workspaceService: WorkspaceService,
     private readonly auth?: AuthService,
-    private readonly config?: Config,
   ) {}
 
   get spec() {
@@ -112,9 +113,7 @@ export class TaskManager implements TaskContext {
     taskId: string;
     targetPath: string;
   }): Promise<void> {
-    if (this.isWorkspaceSerializationEnabled()) {
-      this.storage.rehydrateWorkspace?.(options);
-    }
+    await this.workspaceService.rehydrateWorkspace(options);
   }
 
   get done() {
@@ -163,18 +162,11 @@ export class TaskManager implements TaskContext {
   }
 
   async serializeWorkspace?(options: { path: string }): Promise<void> {
-    if (this.isWorkspaceSerializationEnabled()) {
-      await this.storage.serializeWorkspace?.({
-        path: options.path,
-        taskId: this.task.taskId,
-      });
-    }
+    await this.workspaceService.serializeWorkspace(options);
   }
 
   async cleanWorkspace?(): Promise<void> {
-    if (this.isWorkspaceSerializationEnabled()) {
-      await this.storage.cleanWorkspace?.({ taskId: this.task.taskId });
-    }
+    await this.workspaceService.cleanWorkspace();
   }
 
   async complete(
@@ -211,14 +203,6 @@ export class TaskManager implements TaskContext {
     }, 1000);
   }
 
-  private isWorkspaceSerializationEnabled(): boolean {
-    return (
-      this.config?.getOptionalBoolean(
-        'scaffolder.EXPERIMENTAL_workspaceSerialization',
-      ) ?? false
-    );
-  }
-
   async getInitiatorCredentials(): Promise<BackstageCredentials> {
     const secrets = this.task.secrets as InternalTaskSecrets;
 
diff --git a/plugins/scaffolder-backend/src/scaffolder/tasks/WorkspaceService.ts b/plugins/scaffolder-backend/src/scaffolder/tasks/WorkspaceService.ts
new file mode 100644
index 0000000000..15de15859d
--- /dev/null
+++ b/plugins/scaffolder-backend/src/scaffolder/tasks/WorkspaceService.ts
@@ -0,0 +1,90 @@
+/*
+ * Copyright 2021 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import { TaskStore } from './types';
+
+import { CurrentClaimedTask } from './StorageTaskBroker';
+import { Config } from '@backstage/config';
+
+type WorkspaceSerializationProvider = 'database' | 'googleCloudBucket';
+
+export interface WorkspaceService {
+  serializeWorkspace(options: { path: string }): Promise<void>;
+
+  cleanWorkspace(): Promise<void>;
+
+  rehydrateWorkspace(options: {
+    taskId: string;
+    targetPath: string;
+  }): Promise<void>;
+}
+
+export class DefaultWorkspaceService implements WorkspaceService {
+  static create(task: CurrentClaimedTask, storage: TaskStore, config?: Config) {
+    return new DefaultWorkspaceService(task, storage, config);
+  }
+
+  private constructor(
+    private readonly task: CurrentClaimedTask,
+    private readonly storage: TaskStore,
+    private readonly config?: Config,
+  ) {}
+
+  public async serializeWorkspace(options: { path: string }): Promise<void> {
+    if (this.isWorkspaceSerializationEnabled()) {
+      const provider = this.getWorkspaceSerializationProvider();
+      switch (provider) {
+        case 'database':
+          this.storage.serializeWorkspace?.({
+            path: options.path,
+            taskId: this.task.taskId,
+          });
+          return;
+        case 'googleCloudBucket':
+          return;
+        default:
+          throw new Error(
+            `Workspace serialization provider ${provider} is not supported`,
+          );
+      }
+    }
+  }
+
+  public async rehydrateWorkspace(options: {
+    taskId: string;
+    targetPath: string;
+  }): Promise<void> {
+    if (this.isWorkspaceSerializationEnabled()) {
+      this.storage.rehydrateWorkspace?.(options);
+    }
+  }
+
+  public async cleanWorkspace(): Promise<void> {}
+
+  private isWorkspaceSerializationEnabled(): boolean {
+    return (
+      this.config?.getOptionalBoolean(
+        'scaffolder.EXPERIMENTAL_workspaceSerialization',
+      ) ?? false
+    );
+  }
+
+  private getWorkspaceSerializationProvider(): WorkspaceSerializationProvider {
+    return (this.config?.getOptionalString(
+      'scaffolder.EXPERIMENTAL_workspaceSerializationProvider',
+    ) ?? 'database') as WorkspaceSerializationProvider;
+  }
+}

From 38875ed1c18cb8ec29720a95789411c5b986d819 Mon Sep 17 00:00:00 2001
From: bnechyporenko <bnechyporenko@bol.com>
Date: Sun, 9 Jun 2024 23:03:25 +0200
Subject: [PATCH 02/13] Storing the serialized workspace into google cloud
 bucket

Signed-off-by: bnechyporenko <bnechyporenko@bol.com>
---
 .../.eslintrc.js                              |  1 +
 .../CHANGELOG.md                              |  3 +
 .../README.md                                 |  5 +
 .../catalog-info.yaml                         | 10 ++
 .../knip-report.md                            |  2 +
 .../package.json                              | 55 +++++++++++
 .../src/index.ts                              | 23 +++++
 .../src/module.ts                             | 44 +++++++++
 .../providers/GcpBucketWorkspaceProvider.ts   | 93 +++++++++++++++++++
 plugins/scaffolder-backend/config.d.ts        |  9 ++
 .../src/ScaffolderPlugin.ts                   | 10 ++
 .../src/scaffolder/tasks/DatabaseTaskStore.ts |  5 +-
 .../tasks/DatabaseWorkspaceProvider.ts        | 45 +++++++++
 .../src/scaffolder/tasks/StorageTaskBroker.ts | 16 +++-
 .../src/scaffolder/tasks/WorkspaceService.ts  | 64 +++++++------
 .../scaffolder-backend/src/service/router.ts  | 15 ++-
 plugins/scaffolder-node/api-report-alpha.md   | 28 ++++++
 plugins/scaffolder-node/api-report.md         |  6 ++
 plugins/scaffolder-node/package.json          |  2 +
 plugins/scaffolder-node/src/alpha.ts          | 44 ++++++++-
 plugins/scaffolder-node/src/tasks/index.ts    |  2 +
 .../src}/tasks/serializer.test.ts             |  0
 .../src}/tasks/serializer.ts                  | 13 ++-
 yarn.lock                                     | 43 +++++----
 24 files changed, 482 insertions(+), 56 deletions(-)
 create mode 100644 plugins/scaffolder-backend-module-gcp-bucket/.eslintrc.js
 create mode 100644 plugins/scaffolder-backend-module-gcp-bucket/CHANGELOG.md
 create mode 100644 plugins/scaffolder-backend-module-gcp-bucket/README.md
 create mode 100644 plugins/scaffolder-backend-module-gcp-bucket/catalog-info.yaml
 create mode 100644 plugins/scaffolder-backend-module-gcp-bucket/knip-report.md
 create mode 100644 plugins/scaffolder-backend-module-gcp-bucket/package.json
 create mode 100644 plugins/scaffolder-backend-module-gcp-bucket/src/index.ts
 create mode 100644 plugins/scaffolder-backend-module-gcp-bucket/src/module.ts
 create mode 100644 plugins/scaffolder-backend-module-gcp-bucket/src/providers/GcpBucketWorkspaceProvider.ts
 create mode 100644 plugins/scaffolder-backend/src/scaffolder/tasks/DatabaseWorkspaceProvider.ts
 rename plugins/{scaffolder-backend/src/scaffolder => scaffolder-node/src}/tasks/serializer.test.ts (100%)
 rename plugins/{scaffolder-backend/src/scaffolder => scaffolder-node/src}/tasks/serializer.ts (84%)

diff --git a/plugins/scaffolder-backend-module-gcp-bucket/.eslintrc.js b/plugins/scaffolder-backend-module-gcp-bucket/.eslintrc.js
new file mode 100644
index 0000000000..e2a53a6ad2
--- /dev/null
+++ b/plugins/scaffolder-backend-module-gcp-bucket/.eslintrc.js
@@ -0,0 +1 @@
+module.exports = require('@backstage/cli/config/eslint-factory')(__dirname);
diff --git a/plugins/scaffolder-backend-module-gcp-bucket/CHANGELOG.md b/plugins/scaffolder-backend-module-gcp-bucket/CHANGELOG.md
new file mode 100644
index 0000000000..b659b67db4
--- /dev/null
+++ b/plugins/scaffolder-backend-module-gcp-bucket/CHANGELOG.md
@@ -0,0 +1,3 @@
+# @backstage/plugin-scaffolder-backend-module-gcp-bucket
+
+## 0.0.1
diff --git a/plugins/scaffolder-backend-module-gcp-bucket/README.md b/plugins/scaffolder-backend-module-gcp-bucket/README.md
new file mode 100644
index 0000000000..683dd70c01
--- /dev/null
+++ b/plugins/scaffolder-backend-module-gcp-bucket/README.md
@@ -0,0 +1,5 @@
+# @backstage/plugin-scaffolder-backend-module-gcp-bucket
+
+The GCP bucket module for [@backstage/plugin-scaffolder-backend](https://www.npmjs.com/package/@backstage/plugin-scaffolder-backend).
+
+_This plugin was created through the Backstage CLI_
diff --git a/plugins/scaffolder-backend-module-gcp-bucket/catalog-info.yaml b/plugins/scaffolder-backend-module-gcp-bucket/catalog-info.yaml
new file mode 100644
index 0000000000..8fac6a1a2b
--- /dev/null
+++ b/plugins/scaffolder-backend-module-gcp-bucket/catalog-info.yaml
@@ -0,0 +1,10 @@
+apiVersion: backstage.io/v1alpha1
+kind: Component
+metadata:
+  name: backstage-plugin-scaffolder-backend-module-gcp-bucket
+  title: '@backstage/plugin-scaffolder-backend-module-gcp-bucket'
+  description: The GCP bucket module for @backstage/plugin-scaffolder-backend
+spec:
+  lifecycle: experimental
+  type: backstage-backend-plugin-module
+  owner: maintainers
diff --git a/plugins/scaffolder-backend-module-gcp-bucket/knip-report.md b/plugins/scaffolder-backend-module-gcp-bucket/knip-report.md
new file mode 100644
index 0000000000..2661c35327
--- /dev/null
+++ b/plugins/scaffolder-backend-module-gcp-bucket/knip-report.md
@@ -0,0 +1,2 @@
+# Knip report
+
diff --git a/plugins/scaffolder-backend-module-gcp-bucket/package.json b/plugins/scaffolder-backend-module-gcp-bucket/package.json
new file mode 100644
index 0000000000..426d43df16
--- /dev/null
+++ b/plugins/scaffolder-backend-module-gcp-bucket/package.json
@@ -0,0 +1,55 @@
+{
+  "name": "@backstage/plugin-scaffolder-backend-module-gcp-bucket",
+  "version": "0.0.1",
+  "description": "The GCP Bucket module for @backstage/plugin-scaffolder-backend",
+  "backstage": {
+    "role": "backend-plugin-module"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/backstage/backstage",
+    "directory": "plugins/scaffolder-backend-module-gcp-bucket"
+  },
+  "license": "Apache-2.0",
+  "exports": {
+    ".": "./src/index.ts",
+    "./package.json": "./package.json"
+  },
+  "main": "src/index.ts",
+  "types": "src/index.ts",
+  "typesVersions": {
+    "*": {
+      "package.json": [
+        "package.json"
+      ]
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "backstage-cli package build",
+    "clean": "backstage-cli package clean",
+    "lint": "backstage-cli package lint",
+    "prepack": "backstage-cli package prepack",
+    "postpack": "backstage-cli package postpack",
+    "start": "backstage-cli package start",
+    "test": "backstage-cli package test"
+  },
+  "dependencies": {
+    "@backstage/backend-plugin-api": "workspace:^",
+    "@backstage/config": "workspace:^",
+    "@backstage/errors": "workspace:^",
+    "@backstage/integration": "workspace:^",
+    "@backstage/plugin-scaffolder-node": "workspace:^",
+    "@google-cloud/storage": "^7.11.2",
+    "raw-body": "^2.4.1"
+  },
+  "devDependencies": {
+    "@backstage/cli": "workspace:^",
+    "@backstage/plugin-scaffolder-node-test-utils": "workspace:^"
+  }
+}
diff --git a/plugins/scaffolder-backend-module-gcp-bucket/src/index.ts b/plugins/scaffolder-backend-module-gcp-bucket/src/index.ts
new file mode 100644
index 0000000000..05498e3edd
--- /dev/null
+++ b/plugins/scaffolder-backend-module-gcp-bucket/src/index.ts
@@ -0,0 +1,23 @@
+/*
+ * Copyright 2023 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/**
+ * A module for the scaffolder backend that lets you interact with azure
+ *
+ * @packageDocumentation
+ */
+
+export { gcpBucketModule as default } from './module';
diff --git a/plugins/scaffolder-backend-module-gcp-bucket/src/module.ts b/plugins/scaffolder-backend-module-gcp-bucket/src/module.ts
new file mode 100644
index 0000000000..3d48b7f708
--- /dev/null
+++ b/plugins/scaffolder-backend-module-gcp-bucket/src/module.ts
@@ -0,0 +1,44 @@
+/*
+ * Copyright 2024 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import {
+  coreServices,
+  createBackendModule,
+} from '@backstage/backend-plugin-api';
+import { scaffolderWorkspaceProviderExtensionPoint } from '@backstage/plugin-scaffolder-node/alpha';
+import { GcpBucketWorkspaceProvider } from './providers/GcpBucketWorkspaceProvider';
+
+/**
+ * @public
+ * The Azure Module for the Scaffolder Backend
+ */
+export const gcpBucketModule = createBackendModule({
+  moduleId: 'gcp-bucket',
+  pluginId: 'scaffolder',
+  register({ registerInit }) {
+    registerInit({
+      deps: {
+        scaffolderWorkspaceProviders: scaffolderWorkspaceProviderExtensionPoint,
+        config: coreServices.rootConfig,
+        logger: coreServices.logger,
+      },
+      async init({ config, logger, scaffolderWorkspaceProviders }) {
+        scaffolderWorkspaceProviders.addProviders({
+          gcpBucket: GcpBucketWorkspaceProvider.create(logger, config),
+        });
+      },
+    });
+  },
+});
diff --git a/plugins/scaffolder-backend-module-gcp-bucket/src/providers/GcpBucketWorkspaceProvider.ts b/plugins/scaffolder-backend-module-gcp-bucket/src/providers/GcpBucketWorkspaceProvider.ts
new file mode 100644
index 0000000000..8c132e0374
--- /dev/null
+++ b/plugins/scaffolder-backend-module-gcp-bucket/src/providers/GcpBucketWorkspaceProvider.ts
@@ -0,0 +1,93 @@
+/*
+ * Copyright 2021 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import { Config } from '@backstage/config';
+import { WorkspaceProvider } from '@backstage/plugin-scaffolder-node/alpha';
+
+import getRawBody from 'raw-body';
+import { Storage } from '@google-cloud/storage';
+import { LoggerService } from '@backstage/backend-plugin-api';
+
+import {
+  serializeWorkspace,
+  restoreWorkspace,
+} from '@backstage/plugin-scaffolder-node';
+
+export class GcpBucketWorkspaceProvider implements WorkspaceProvider {
+  static create(logger: LoggerService, config?: Config) {
+    return new GcpBucketWorkspaceProvider(new Storage(), logger, config);
+  }
+
+  private constructor(
+    private readonly storage: Storage,
+    private readonly logger: LoggerService,
+    private readonly config?: Config,
+  ) {}
+
+  public async cleanWorkspace(options: { taskId: string }): Promise<void> {
+    await this.storage
+      .bucket(this.getGcpBucketName())
+      .file(options.taskId)
+      .delete();
+  }
+
+  public async serializeWorkspace(options: {
+    path: string;
+    taskId: string;
+  }): Promise<void> {
+    const fileCloud = this.storage
+      .bucket(this.getGcpBucketName())
+      .file(options.taskId);
+    const workspace = await serializeWorkspace(options.path);
+    fileCloud.save(
+      workspace,
+      {
+        contentType: 'application/x-tar',
+      },
+      err => {
+        if (err) {
+          this.logger.error(
+            `An error occurred during uploading the workspace of task ${
+              options.taskId
+            } into GCP bucket ${this.getGcpBucketName()}`,
+          );
+        }
+      },
+    );
+  }
+
+  public async rehydrateWorkspace(options: {
+    taskId: string;
+    targetPath: string;
+  }): Promise<void> {
+    const bucket = this.storage.bucket(this.getGcpBucketName());
+    const file = bucket.file(options.taskId);
+    const workspace = getRawBody(file.createReadStream());
+    await restoreWorkspace(options.targetPath, await workspace);
+  }
+
+  private getGcpBucketName(): string {
+    const bucketName = this.config?.getOptionalString(
+      'scaffolder.EXPERIMENTAL_gcpBucketName',
+    );
+    if (!bucketName) {
+      throw new Error(
+        `You've missed to configure scaffolder.EXPERIMENTAL_gcpBucketName in app-config.yaml file`,
+      );
+    }
+    return bucketName;
+  }
+}
diff --git a/plugins/scaffolder-backend/config.d.ts b/plugins/scaffolder-backend/config.d.ts
index 754eedb55b..2e36922355 100644
--- a/plugins/scaffolder-backend/config.d.ts
+++ b/plugins/scaffolder-backend/config.d.ts
@@ -52,6 +52,15 @@ export interface Config {
      */
     EXPERIMENTAL_workspaceSerialization?: boolean;
 
+    /**
+     * Sets the provider for workspace serialization.
+     *
+     * By default, it is your database.
+     */
+    EXPERIMENTAL_workspaceSerializationProvider?:
+      | 'database'
+      | 'googleCloudBucket';
+
     /**
      * Every task which is in progress state and having a last heartbeat longer than a specified timeout is going to
      * be attempted to recover.
diff --git a/plugins/scaffolder-backend/src/ScaffolderPlugin.ts b/plugins/scaffolder-backend/src/ScaffolderPlugin.ts
index c83c6d437d..50e0dff9c0 100644
--- a/plugins/scaffolder-backend/src/ScaffolderPlugin.ts
+++ b/plugins/scaffolder-backend/src/ScaffolderPlugin.ts
@@ -33,6 +33,8 @@ import {
   scaffolderAutocompleteExtensionPoint,
   scaffolderTaskBrokerExtensionPoint,
   scaffolderTemplatingExtensionPoint,
+  scaffolderWorkspaceProviderExtensionPoint,
+  WorkspaceProvider,
 } from '@backstage/plugin-scaffolder-node/alpha';
 import {
   createCatalogRegisterAction,
@@ -84,10 +86,17 @@ export const scaffolderPlugin = createBackendPlugin({
       },
     });
 
+<<<<<<< HEAD
     const autocompleteHandlers: Record<string, AutocompleteHandler> = {};
     env.registerExtensionPoint(scaffolderAutocompleteExtensionPoint, {
       addAutocompleteProvider(provider) {
         autocompleteHandlers[provider.id] = provider.handler;
+=======
+    const additionalWorkspaceProviders: Record<string, WorkspaceProvider> = {};
+    env.registerExtensionPoint(scaffolderWorkspaceProviderExtensionPoint, {
+      addProviders(provider) {
+        Object.assign(additionalWorkspaceProviders, provider);
+>>>>>>> 801e5ff2007a (Storing the serialized workspace into google cloud bucket)
       },
     });
 
@@ -172,6 +181,7 @@ export const scaffolderPlugin = createBackendPlugin({
           discovery,
           permissions,
           autocompleteHandlers,
+          additionalWorkspaceProviders,
         });
         httpRouter.use(router);
       },
diff --git a/plugins/scaffolder-backend/src/scaffolder/tasks/DatabaseTaskStore.ts b/plugins/scaffolder-backend/src/scaffolder/tasks/DatabaseTaskStore.ts
index 9c95c11017..02b657032a 100644
--- a/plugins/scaffolder-backend/src/scaffolder/tasks/DatabaseTaskStore.ts
+++ b/plugins/scaffolder-backend/src/scaffolder/tasks/DatabaseTaskStore.ts
@@ -40,7 +40,10 @@ import { DateTime, Duration } from 'luxon';
 import { TaskRecovery, TaskSpec } from '@backstage/plugin-scaffolder-common';
 import { trimEventsTillLastRecovery } from './taskRecoveryHelper';
 import { intervalFromNowTill } from './dbUtil';
-import { restoreWorkspace, serializeWorkspace } from './serializer';
+import {
+  restoreWorkspace,
+  serializeWorkspace,
+} from '@backstage/plugin-scaffolder-node';
 
 const migrationsDir = resolvePackagePath(
   '@backstage/plugin-scaffolder-backend',
diff --git a/plugins/scaffolder-backend/src/scaffolder/tasks/DatabaseWorkspaceProvider.ts b/plugins/scaffolder-backend/src/scaffolder/tasks/DatabaseWorkspaceProvider.ts
new file mode 100644
index 0000000000..69f90b3d7e
--- /dev/null
+++ b/plugins/scaffolder-backend/src/scaffolder/tasks/DatabaseWorkspaceProvider.ts
@@ -0,0 +1,45 @@
+/*
+ * Copyright 2021 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import { TaskStore } from './types';
+
+import { WorkspaceProvider } from '@backstage/plugin-scaffolder-node/alpha';
+
+export class DatabaseWorkspaceProvider implements WorkspaceProvider {
+  static create(storage: TaskStore) {
+    return new DatabaseWorkspaceProvider(storage);
+  }
+
+  private constructor(private readonly storage: TaskStore) {}
+
+  public async serializeWorkspace(options: {
+    path: string;
+    taskId: string;
+  }): Promise<void> {
+    this.storage.serializeWorkspace?.(options);
+  }
+
+  public async rehydrateWorkspace(options: {
+    taskId: string;
+    targetPath: string;
+  }): Promise<void> {
+    return this.storage.rehydrateWorkspace?.(options);
+  }
+
+  public async cleanWorkspace(options: { taskId: string }): Promise<void> {
+    return this.storage.cleanWorkspace?.(options);
+  }
+}
diff --git a/plugins/scaffolder-backend/src/scaffolder/tasks/StorageTaskBroker.ts b/plugins/scaffolder-backend/src/scaffolder/tasks/StorageTaskBroker.ts
index 4177780e06..f4946e6652 100644
--- a/plugins/scaffolder-backend/src/scaffolder/tasks/StorageTaskBroker.ts
+++ b/plugins/scaffolder-backend/src/scaffolder/tasks/StorageTaskBroker.ts
@@ -35,6 +35,7 @@ import {
   BackstageCredentials,
 } from '@backstage/backend-plugin-api';
 import { DefaultWorkspaceService, WorkspaceService } from './WorkspaceService';
+import { WorkspaceProvider } from '@backstage/plugin-scaffolder-node/alpha';
 
 type TaskState = {
   checkpoints: {
@@ -66,13 +67,21 @@ export class TaskManager implements TaskContext {
     logger: Logger,
     auth?: AuthService,
     config?: Config,
+    additionalWorkspaceProviders?: Record<string, WorkspaceProvider>,
   ) {
+    const workspaceService = DefaultWorkspaceService.create(
+      task,
+      storage,
+      additionalWorkspaceProviders,
+      config,
+    );
+
     const agent = new TaskManager(
       task,
       storage,
       abortSignal,
       logger,
-      DefaultWorkspaceService.create(task, storage, config),
+      workspaceService,
       auth,
     );
     agent.startTimeout();
@@ -262,6 +271,10 @@ export class StorageTaskBroker implements TaskBroker {
     private readonly logger: Logger,
     private readonly config?: Config,
     private readonly auth?: AuthService,
+    private readonly additionalWorkspaceProviders?: Record<
+      string,
+      WorkspaceProvider
+    >,
   ) {}
 
   async list(options?: {
@@ -350,6 +363,7 @@ export class StorageTaskBroker implements TaskBroker {
           this.logger,
           this.auth,
           this.config,
+          this.additionalWorkspaceProviders,
         );
       }
 
diff --git a/plugins/scaffolder-backend/src/scaffolder/tasks/WorkspaceService.ts b/plugins/scaffolder-backend/src/scaffolder/tasks/WorkspaceService.ts
index 15de15859d..69deb1c333 100644
--- a/plugins/scaffolder-backend/src/scaffolder/tasks/WorkspaceService.ts
+++ b/plugins/scaffolder-backend/src/scaffolder/tasks/WorkspaceService.ts
@@ -1,5 +1,5 @@
 /*
- * Copyright 2021 The Backstage Authors
+ * Copyright 2024 The Backstage Authors
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -14,12 +14,11 @@
  * limitations under the License.
  */
 
-import { TaskStore } from './types';
-
-import { CurrentClaimedTask } from './StorageTaskBroker';
 import { Config } from '@backstage/config';
-
-type WorkspaceSerializationProvider = 'database' | 'googleCloudBucket';
+import { CurrentClaimedTask } from './StorageTaskBroker';
+import { WorkspaceProvider } from '@backstage/plugin-scaffolder-node/alpha';
+import { DatabaseWorkspaceProvider } from './DatabaseWorkspaceProvider';
+import { TaskStore } from './types';
 
 export interface WorkspaceService {
   serializeWorkspace(options: { path: string }): Promise<void>;
@@ -33,33 +32,40 @@ export interface WorkspaceService {
 }
 
 export class DefaultWorkspaceService implements WorkspaceService {
-  static create(task: CurrentClaimedTask, storage: TaskStore, config?: Config) {
-    return new DefaultWorkspaceService(task, storage, config);
+  static create(
+    task: CurrentClaimedTask,
+    storage: TaskStore,
+    additionalWorkspaceProviders?: Record<string, WorkspaceProvider>,
+    config?: Config,
+  ) {
+    const workspaceProviderName =
+      config?.getOptionalString(
+        'scaffolder.EXPERIMENTAL_workspaceSerializationProvider',
+      ) ?? 'database';
+    const workspaceProvider =
+      additionalWorkspaceProviders?.[workspaceProviderName] ??
+      DatabaseWorkspaceProvider.create(storage);
+    return new DefaultWorkspaceService(task, workspaceProvider);
   }
 
   private constructor(
     private readonly task: CurrentClaimedTask,
-    private readonly storage: TaskStore,
+    private readonly workspaceProvider: WorkspaceProvider,
     private readonly config?: Config,
   ) {}
 
   public async serializeWorkspace(options: { path: string }): Promise<void> {
     if (this.isWorkspaceSerializationEnabled()) {
-      const provider = this.getWorkspaceSerializationProvider();
-      switch (provider) {
-        case 'database':
-          this.storage.serializeWorkspace?.({
-            path: options.path,
-            taskId: this.task.taskId,
-          });
-          return;
-        case 'googleCloudBucket':
-          return;
-        default:
-          throw new Error(
-            `Workspace serialization provider ${provider} is not supported`,
-          );
-      }
+      await this.workspaceProvider.serializeWorkspace({
+        path: options.path,
+        taskId: this.task.taskId,
+      });
+    }
+  }
+
+  public async cleanWorkspace(): Promise<void> {
+    if (this.isWorkspaceSerializationEnabled()) {
+      await this.workspaceProvider.cleanWorkspace({ taskId: this.task.taskId });
     }
   }
 
@@ -68,12 +74,10 @@ export class DefaultWorkspaceService implements WorkspaceService {
     targetPath: string;
   }): Promise<void> {
     if (this.isWorkspaceSerializationEnabled()) {
-      this.storage.rehydrateWorkspace?.(options);
+      await this.workspaceProvider.rehydrateWorkspace(options);
     }
   }
 
-  public async cleanWorkspace(): Promise<void> {}
-
   private isWorkspaceSerializationEnabled(): boolean {
     return (
       this.config?.getOptionalBoolean(
@@ -81,10 +85,4 @@ export class DefaultWorkspaceService implements WorkspaceService {
       ) ?? false
     );
   }
-
-  private getWorkspaceSerializationProvider(): WorkspaceSerializationProvider {
-    return (this.config?.getOptionalString(
-      'scaffolder.EXPERIMENTAL_workspaceSerializationProvider',
-    ) ?? 'database') as WorkspaceSerializationProvider;
-  }
 }
diff --git a/plugins/scaffolder-backend/src/service/router.ts b/plugins/scaffolder-backend/src/service/router.ts
index 3d5e49b400..769a042a78 100644
--- a/plugins/scaffolder-backend/src/service/router.ts
+++ b/plugins/scaffolder-backend/src/service/router.ts
@@ -94,7 +94,10 @@ import {
 } from '@backstage/plugin-auth-node';
 import { InternalTaskSecrets } from '../scaffolder/tasks/types';
 import { checkPermission } from '../util/checkPermissions';
-import { AutocompleteHandler } from '@backstage/plugin-scaffolder-node/alpha';
+import {
+  AutocompleteHandler,
+  WorkspaceProvider,
+} from '@backstage/plugin-scaffolder-node/alpha';
 
 /**
  *
@@ -159,6 +162,7 @@ export interface RouterOptions {
   taskBroker?: TaskBroker;
   additionalTemplateFilters?: Record<string, TemplateFilter>;
   additionalTemplateGlobals?: Record<string, TemplateGlobal>;
+  additionalWorkspaceProviders?: Record<string, WorkspaceProvider>;
   permissions?: PermissionsService;
   permissionRules?: Array<
     TemplatePermissionRuleInput | ActionPermissionRuleInput
@@ -272,6 +276,7 @@ export async function createRouter(
     scheduler,
     additionalTemplateFilters,
     additionalTemplateGlobals,
+    additionalWorkspaceProviders,
     permissions,
     permissionRules,
     discovery = HostDiscovery.fromConfig(config),
@@ -297,7 +302,13 @@ export async function createRouter(
   let taskBroker: TaskBroker;
   if (!options.taskBroker) {
     const databaseTaskStore = await DatabaseTaskStore.create({ database });
-    taskBroker = new StorageTaskBroker(databaseTaskStore, logger, config, auth);
+    taskBroker = new StorageTaskBroker(
+      databaseTaskStore,
+      logger,
+      config,
+      auth,
+      additionalWorkspaceProviders,
+    );
 
     if (scheduler && databaseTaskStore.listStaleTasks) {
       await scheduler.scheduleTask({
diff --git a/plugins/scaffolder-node/api-report-alpha.md b/plugins/scaffolder-node/api-report-alpha.md
index aae32d7203..9601d73215 100644
--- a/plugins/scaffolder-node/api-report-alpha.md
+++ b/plugins/scaffolder-node/api-report-alpha.md
@@ -68,5 +68,33 @@ export interface ScaffolderTemplatingExtensionPoint {
 // @alpha
 export const scaffolderTemplatingExtensionPoint: ExtensionPoint<ScaffolderTemplatingExtensionPoint>;
 
+// @alpha
+export interface ScaffolderWorkspaceProviderExtensionPoint {
+  // (undocumented)
+  addProviders(providers: Record<string, WorkspaceProvider>): void;
+}
+
+// @alpha
+export const scaffolderWorkspaceProviderExtensionPoint: ExtensionPoint<ScaffolderWorkspaceProviderExtensionPoint>;
+
+// @alpha
+export interface WorkspaceProvider {
+  // (undocumented)
+  cleanWorkspace(options: { taskId: string }): Promise<void>;
+  // (undocumented)
+  rehydrateWorkspace(options: {
+    taskId: string;
+    targetPath: string;
+  }): Promise<void>;
+  // (undocumented)
+  serializeWorkspace({
+    path,
+    taskId,
+  }: {
+    path: string;
+    taskId: string;
+  }): Promise<void>;
+}
+
 // (No @packageDocumentation comment for this package)
 ```
diff --git a/plugins/scaffolder-node/api-report.md b/plugins/scaffolder-node/api-report.md
index 66e8ccd678..9e9a31a991 100644
--- a/plugins/scaffolder-node/api-report.md
+++ b/plugins/scaffolder-node/api-report.md
@@ -256,6 +256,9 @@ export const parseRepoUrl: (
   project?: string | undefined;
 };
 
+// @public
+export const restoreWorkspace: (path: string, buffer?: Buffer) => Promise<void>;
+
 // @public (undocumented)
 export interface SerializedFile {
   // (undocumented)
@@ -298,6 +301,9 @@ export type SerializedTaskEvent = {
   createdAt: string;
 };
 
+// @public
+export const serializeWorkspace: (path: string) => Promise<Buffer>;
+
 // @public
 export interface TaskBroker {
   // (undocumented)
diff --git a/plugins/scaffolder-node/package.json b/plugins/scaffolder-node/package.json
index ed3c016257..29dc022be1 100644
--- a/plugins/scaffolder-node/package.json
+++ b/plugins/scaffolder-node/package.json
@@ -61,11 +61,13 @@
     "@backstage/integration": "workspace:^",
     "@backstage/plugin-scaffolder-common": "workspace:^",
     "@backstage/types": "workspace:^",
+    "concat-stream": "^2.0.0",
     "fs-extra": "^11.2.0",
     "globby": "^11.0.0",
     "isomorphic-git": "^1.23.0",
     "jsonschema": "^1.2.6",
     "p-limit": "^3.1.0",
+    "tar": "^6.1.12",
     "winston": "^3.2.1",
     "zod": "^3.22.4",
     "zod-to-json-schema": "^3.20.4"
diff --git a/plugins/scaffolder-node/src/alpha.ts b/plugins/scaffolder-node/src/alpha.ts
index ef4d5ab289..1bb013832c 100644
--- a/plugins/scaffolder-node/src/alpha.ts
+++ b/plugins/scaffolder-node/src/alpha.ts
@@ -67,6 +67,7 @@ export const scaffolderTaskBrokerExtensionPoint =
  */
 export interface ScaffolderTemplatingExtensionPoint {
   addTemplateFilters(filters: Record<string, TemplateFilter>): void;
+
   addTemplateGlobals(filters: Record<string, TemplateGlobal>): void;
 }
 
@@ -109,7 +110,7 @@ export interface ScaffolderAutocompleteExtensionPoint {
 }
 
 /**
- * Extension point for adding template filters and globals.
+ * Extension point for adding autocomplete handlers.
  *
  * @alpha
  */
@@ -117,3 +118,44 @@ export const scaffolderAutocompleteExtensionPoint =
   createExtensionPoint<ScaffolderAutocompleteExtensionPoint>({
     id: 'scaffolder.autocomplete',
   });
+
+/**
+ * This provider has to be implemented to make it possible to serialize/deserialize scaffolder workspace.
+ *
+ * @alpha
+ */
+export interface WorkspaceProvider {
+  serializeWorkspace({
+    path,
+    taskId,
+  }: {
+    path: string;
+    taskId: string;
+  }): Promise<void>;
+
+  cleanWorkspace(options: { taskId: string }): Promise<void>;
+
+  rehydrateWorkspace(options: {
+    taskId: string;
+    targetPath: string;
+  }): Promise<void>;
+}
+
+/**
+ * Extension point for adding workspace providers.
+ *
+ * @alpha
+ */
+export interface ScaffolderWorkspaceProviderExtensionPoint {
+  addProviders(providers: Record<string, WorkspaceProvider>): void;
+}
+
+/**
+ * Extension point for adding workspace providers.
+ *
+ * @alpha
+ */
+export const scaffolderWorkspaceProviderExtensionPoint =
+  createExtensionPoint<ScaffolderWorkspaceProviderExtensionPoint>({
+    id: 'scaffolder.workspace.provider',
+  });
diff --git a/plugins/scaffolder-node/src/tasks/index.ts b/plugins/scaffolder-node/src/tasks/index.ts
index 930de95237..b1754a1f78 100644
--- a/plugins/scaffolder-node/src/tasks/index.ts
+++ b/plugins/scaffolder-node/src/tasks/index.ts
@@ -26,3 +26,5 @@ export type {
   TaskEventType,
   TaskStatus,
 } from './types';
+
+export * from './serializer';
diff --git a/plugins/scaffolder-backend/src/scaffolder/tasks/serializer.test.ts b/plugins/scaffolder-node/src/tasks/serializer.test.ts
similarity index 100%
rename from plugins/scaffolder-backend/src/scaffolder/tasks/serializer.test.ts
rename to plugins/scaffolder-node/src/tasks/serializer.test.ts
diff --git a/plugins/scaffolder-backend/src/scaffolder/tasks/serializer.ts b/plugins/scaffolder-node/src/tasks/serializer.ts
similarity index 84%
rename from plugins/scaffolder-backend/src/scaffolder/tasks/serializer.ts
rename to plugins/scaffolder-node/src/tasks/serializer.ts
index 69c48fb769..f9a55a68f4 100644
--- a/plugins/scaffolder-backend/src/scaffolder/tasks/serializer.ts
+++ b/plugins/scaffolder-node/src/tasks/serializer.ts
@@ -20,13 +20,22 @@ import { promisify } from 'util';
 import { pipeline as pipelineCb, Readable } from 'stream';
 
 const pipeline = promisify(pipelineCb);
-
+/**
+ * Serializes provided path into tar archive
+ *
+ * @public
+ */
 export const serializeWorkspace = async (path: string): Promise<Buffer> => {
-  return await new Promise<Buffer>(async resolve => {
+  return new Promise<Buffer>(async resolve => {
     await pipeline(tar.create({ cwd: path }, ['']), concatStream(resolve));
   });
 };
 
+/**
+ * Rehydrates the provided buffer of tar archive into the provide destination path
+ *
+ * @public
+ */
 export const restoreWorkspace = async (path: string, buffer?: Buffer) => {
   if (buffer) {
     await pipeline(
diff --git a/yarn.lock b/yarn.lock
index e3cec34102..8a1a84b970 100644
--- a/yarn.lock
+++ b/yarn.lock
@@ -6779,6 +6779,22 @@ __metadata:
   languageName: unknown
   linkType: soft
 
+"@backstage/plugin-scaffolder-backend-module-gcp-bucket@workspace:plugins/scaffolder-backend-module-gcp-bucket":
+  version: 0.0.0-use.local
+  resolution: "@backstage/plugin-scaffolder-backend-module-gcp-bucket@workspace:plugins/scaffolder-backend-module-gcp-bucket"
+  dependencies:
+    "@backstage/backend-plugin-api": "workspace:^"
+    "@backstage/cli": "workspace:^"
+    "@backstage/config": "workspace:^"
+    "@backstage/errors": "workspace:^"
+    "@backstage/integration": "workspace:^"
+    "@backstage/plugin-scaffolder-node": "workspace:^"
+    "@backstage/plugin-scaffolder-node-test-utils": "workspace:^"
+    "@google-cloud/storage": ^7.11.2
+    raw-body: ^2.4.1
+  languageName: unknown
+  linkType: soft
+
 "@backstage/plugin-scaffolder-backend-module-gerrit@workspace:^, @backstage/plugin-scaffolder-backend-module-gerrit@workspace:plugins/scaffolder-backend-module-gerrit":
   version: 0.0.0-use.local
   resolution: "@backstage/plugin-scaffolder-backend-module-gerrit@workspace:plugins/scaffolder-backend-module-gerrit"
@@ -7042,11 +7058,13 @@ __metadata:
     "@backstage/integration": "workspace:^"
     "@backstage/plugin-scaffolder-common": "workspace:^"
     "@backstage/types": "workspace:^"
+    concat-stream: ^2.0.0
     fs-extra: ^11.2.0
     globby: ^11.0.0
     isomorphic-git: ^1.23.0
     jsonschema: ^1.2.6
     p-limit: ^3.1.0
+    tar: ^6.1.12
     winston: ^3.2.1
     zod: ^3.22.4
     zod-to-json-schema: ^3.20.4
@@ -9354,9 +9372,9 @@ __metadata:
   languageName: node
   linkType: hard
 
-"@google-cloud/storage@npm:^7.0.0":
-  version: 7.10.1
-  resolution: "@google-cloud/storage@npm:7.10.1"
+"@google-cloud/storage@npm:^7.0.0, @google-cloud/storage@npm:^7.11.2":
+  version: 7.11.2
+  resolution: "@google-cloud/storage@npm:7.11.2"
   dependencies:
     "@google-cloud/paginator": ^5.0.0
     "@google-cloud/projectify": ^4.0.0
@@ -9364,16 +9382,16 @@ __metadata:
     abort-controller: ^3.0.0
     async-retry: ^1.3.3
     duplexify: ^4.1.3
-    ent: ^2.2.0
     fast-xml-parser: ^4.3.0
     gaxios: ^6.0.2
     google-auth-library: ^9.6.3
+    html-entities: ^2.5.2
     mime: ^3.0.0
     p-limit: ^3.0.1
     retry-request: ^7.0.0
     teeny-request: ^9.0.0
     uuid: ^8.0.0
-  checksum: 0605f8abf67cde98bc48b05c749b569416af821fcc3eb8ed3fac6dc5ade9c1f2f3210404c85e30525260ea4f34785d7436f7684e6eacd083613237669badff25
+  checksum: 763cd560245006e11a060fdbd5edff5d6bfe22b0c0b06dfe88af43b7b14458598c00a71c4e1b079e9ab09096d7d262bdc27fa77d76a8969af0765f23c93f8405
   languageName: node
   linkType: hard
 
@@ -25281,13 +25299,6 @@ __metadata:
   languageName: node
   linkType: hard
 
-"ent@npm:^2.2.0":
-  version: 2.2.0
-  resolution: "ent@npm:2.2.0"
-  checksum: f588b5707d6fef36011ea10d530645912a69530a1eb0831f8708c498ac028363a7009f45cfadd28ceb4dafd9ac17ec15213f88d09ce239cd033cfe1328dd7d7d
-  languageName: node
-  linkType: hard
-
 "entities@npm:^2.0.0":
   version: 2.2.0
   resolution: "entities@npm:2.2.0"
@@ -28821,10 +28832,10 @@ __metadata:
   languageName: node
   linkType: hard
 
-"html-entities@npm:^2.1.0, html-entities@npm:^2.4.0":
-  version: 2.4.0
-  resolution: "html-entities@npm:2.4.0"
-  checksum: 25bea32642ce9ebd0eedc4d24381883ecb0335ccb8ac26379a0958b9b16652fdbaa725d70207ce54a51db24103436a698a8e454397d3ba8ad81460224751f1dc
+"html-entities@npm:^2.1.0, html-entities@npm:^2.4.0, html-entities@npm:^2.5.2":
+  version: 2.5.2
+  resolution: "html-entities@npm:2.5.2"
+  checksum: b23f4a07d33d49ade1994069af4e13d31650e3fb62621e92ae10ecdf01d1a98065c78fd20fdc92b4c7881612210b37c275f2c9fba9777650ab0d6f2ceb3b99b6
   languageName: node
   linkType: hard
 

From 34e70a0fbcdd9c5b6d3880711cb19fb676d3daad Mon Sep 17 00:00:00 2001
From: bnechyporenko <bnechyporenko@bol.com>
Date: Mon, 10 Jun 2024 08:44:03 +0200
Subject: [PATCH 03/13] Storing the serialized workspace into google cloud
 bucket

Signed-off-by: bnechyporenko <bnechyporenko@bol.com>
---
 .../api-report.md                                     | 11 +++++++++++
 plugins/scaffolder-backend/api-report.md              |  4 ++++
 2 files changed, 15 insertions(+)
 create mode 100644 plugins/scaffolder-backend-module-gcp-bucket/api-report.md

diff --git a/plugins/scaffolder-backend-module-gcp-bucket/api-report.md b/plugins/scaffolder-backend-module-gcp-bucket/api-report.md
new file mode 100644
index 0000000000..b7fbc1cec1
--- /dev/null
+++ b/plugins/scaffolder-backend-module-gcp-bucket/api-report.md
@@ -0,0 +1,11 @@
+## API Report File for "@backstage/plugin-scaffolder-backend-module-gcp-bucket"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+import { BackendFeature } from '@backstage/backend-plugin-api';
+
+// @public
+const gcpBucketModule: () => BackendFeature;
+export default gcpBucketModule;
+```
diff --git a/plugins/scaffolder-backend/api-report.md b/plugins/scaffolder-backend/api-report.md
index 4d75ed8421..a3beee2b53 100644
--- a/plugins/scaffolder-backend/api-report.md
+++ b/plugins/scaffolder-backend/api-report.md
@@ -64,6 +64,7 @@ import { TemplateFilter as TemplateFilter_2 } from '@backstage/plugin-scaffolder
 import { TemplateGlobal as TemplateGlobal_2 } from '@backstage/plugin-scaffolder-node';
 import { TemplateParametersV1beta3 } from '@backstage/plugin-scaffolder-common';
 import { UrlReader } from '@backstage/backend-common';
+import { WorkspaceProvider } from '@backstage/plugin-scaffolder-node/alpha';
 import { ZodType } from 'zod';
 import { ZodTypeDef } from 'zod';
 
@@ -477,6 +478,8 @@ export interface RouterOptions {
   // (undocumented)
   additionalTemplateGlobals?: Record<string, TemplateGlobal_2>;
   // (undocumented)
+  additionalWorkspaceProviders?: Record<string, WorkspaceProvider>;
+  // (undocumented)
   auth?: AuthService;
   // (undocumented)
   autocompleteHandlers?: Record<string, AutocompleteHandler>;
@@ -559,6 +562,7 @@ export class TaskManager implements TaskContext_2 {
     logger: Logger,
     auth?: AuthService,
     config?: Config,
+    additionalWorkspaceProviders?: Record<string, WorkspaceProvider>,
   ): TaskManager;
   // (undocumented)
   get createdBy(): string | undefined;

From 80ca08eba2cdf560c25c09d1cd5833b923574a63 Mon Sep 17 00:00:00 2001
From: bnechyporenko <bnechyporenko@bol.com>
Date: Tue, 11 Jun 2024 22:32:54 +0200
Subject: [PATCH 04/13] wip

Signed-off-by: bnechyporenko <bnechyporenko@bol.com>
---
 .../scaffolder-backend/src/scaffolder/tasks/WorkspaceService.ts | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/plugins/scaffolder-backend/src/scaffolder/tasks/WorkspaceService.ts b/plugins/scaffolder-backend/src/scaffolder/tasks/WorkspaceService.ts
index 69deb1c333..ab424806bf 100644
--- a/plugins/scaffolder-backend/src/scaffolder/tasks/WorkspaceService.ts
+++ b/plugins/scaffolder-backend/src/scaffolder/tasks/WorkspaceService.ts
@@ -45,7 +45,7 @@ export class DefaultWorkspaceService implements WorkspaceService {
     const workspaceProvider =
       additionalWorkspaceProviders?.[workspaceProviderName] ??
       DatabaseWorkspaceProvider.create(storage);
-    return new DefaultWorkspaceService(task, workspaceProvider);
+    return new DefaultWorkspaceService(task, workspaceProvider, config);
   }
 
   private constructor(

From 182f6f78c1de4140a15fbf2718513dc87e010dcc Mon Sep 17 00:00:00 2001
From: bnechyporenko <bnechyporenko@bol.com>
Date: Tue, 11 Jun 2024 23:03:42 +0200
Subject: [PATCH 05/13] wip

Signed-off-by: bnechyporenko <bnechyporenko@bol.com>
---
 .../providers/GcpBucketWorkspaceProvider.ts   | 42 +++++++++++--------
 1 file changed, 24 insertions(+), 18 deletions(-)

diff --git a/plugins/scaffolder-backend-module-gcp-bucket/src/providers/GcpBucketWorkspaceProvider.ts b/plugins/scaffolder-backend-module-gcp-bucket/src/providers/GcpBucketWorkspaceProvider.ts
index 8c132e0374..5afa267041 100644
--- a/plugins/scaffolder-backend-module-gcp-bucket/src/providers/GcpBucketWorkspaceProvider.ts
+++ b/plugins/scaffolder-backend-module-gcp-bucket/src/providers/GcpBucketWorkspaceProvider.ts
@@ -38,10 +38,14 @@ export class GcpBucketWorkspaceProvider implements WorkspaceProvider {
   ) {}
 
   public async cleanWorkspace(options: { taskId: string }): Promise<void> {
-    await this.storage
+    const file = this.storage
       .bucket(this.getGcpBucketName())
-      .file(options.taskId)
-      .delete();
+      .file(options.taskId);
+
+    const result = await file.exists();
+    if (result[0]) {
+      await file.delete();
+    }
   }
 
   public async serializeWorkspace(options: {
@@ -52,20 +56,19 @@ export class GcpBucketWorkspaceProvider implements WorkspaceProvider {
       .bucket(this.getGcpBucketName())
       .file(options.taskId);
     const workspace = await serializeWorkspace(options.path);
-    fileCloud.save(
-      workspace,
-      {
+    try {
+      await fileCloud.save(workspace, {
         contentType: 'application/x-tar',
-      },
-      err => {
-        if (err) {
-          this.logger.error(
-            `An error occurred during uploading the workspace of task ${
-              options.taskId
-            } into GCP bucket ${this.getGcpBucketName()}`,
-          );
-        }
-      },
+      });
+    } catch (err) {
+      this.logger.error(
+        `An error occurred during uploading the workspace of task ${
+          options.taskId
+        } into GCP bucket ${this.getGcpBucketName()}`,
+      );
+    }
+    this.logger.info(
+      `Workspace for task ${options.taskId} has been serialized.`,
     );
   }
 
@@ -75,8 +78,11 @@ export class GcpBucketWorkspaceProvider implements WorkspaceProvider {
   }): Promise<void> {
     const bucket = this.storage.bucket(this.getGcpBucketName());
     const file = bucket.file(options.taskId);
-    const workspace = getRawBody(file.createReadStream());
-    await restoreWorkspace(options.targetPath, await workspace);
+    const result = await file.exists();
+    if (result[0]) {
+      const workspace = getRawBody(file.createReadStream());
+      await restoreWorkspace(options.targetPath, await workspace);
+    }
   }
 
   private getGcpBucketName(): string {

From 0b52438d36160776339a5ac677b7f8b56c122dc9 Mon Sep 17 00:00:00 2001
From: bnechyporenko <bnechyporenko@bol.com>
Date: Tue, 11 Jun 2024 23:13:13 +0200
Subject: [PATCH 06/13] wip

Signed-off-by: bnechyporenko <bnechyporenko@bol.com>
---
 .changeset/tough-lies-mate.md | 7 +++++++
 1 file changed, 7 insertions(+)
 create mode 100644 .changeset/tough-lies-mate.md

diff --git a/.changeset/tough-lies-mate.md b/.changeset/tough-lies-mate.md
new file mode 100644
index 0000000000..cbe228a65f
--- /dev/null
+++ b/.changeset/tough-lies-mate.md
@@ -0,0 +1,7 @@
+---
+'@backstage/plugin-scaffolder-backend-module-gcp-bucket': minor
+'@backstage/plugin-scaffolder-backend': minor
+'@backstage/plugin-scaffolder-node': patch
+---
+
+Serialization of the scaffolder workspace into GCP bucket

From f61f26d60899306adc7e41a110c478b42666bd12 Mon Sep 17 00:00:00 2001
From: bnechyporenko <bnechyporenko@bol.com>
Date: Thu, 13 Jun 2024 18:02:07 +0200
Subject: [PATCH 07/13] wip

Signed-off-by: bnechyporenko <bnechyporenko@bol.com>
---
 .changeset/tough-lies-mate.md                        |  2 +-
 .../CHANGELOG.md                                     |  3 ---
 .../catalog-info.yaml                                | 10 ----------
 .../.eslintrc.js                                     |  0
 plugins/scaffolder-backend-module-gcp/CHANGELOG.md   |  3 +++
 .../README.md                                        |  2 +-
 .../api-report.md                                    |  2 +-
 .../scaffolder-backend-module-gcp/catalog-info.yaml  | 10 ++++++++++
 .../knip-report.md                                   |  0
 .../package.json                                     | 12 +++++++-----
 .../src/index.ts                                     |  0
 .../src/module.ts                                    |  2 +-
 .../src/providers/GcpBucketWorkspaceProvider.ts      |  0
 plugins/scaffolder-backend/config.d.ts               |  4 +---
 yarn.lock                                            |  8 ++++----
 15 files changed, 29 insertions(+), 29 deletions(-)
 delete mode 100644 plugins/scaffolder-backend-module-gcp-bucket/CHANGELOG.md
 delete mode 100644 plugins/scaffolder-backend-module-gcp-bucket/catalog-info.yaml
 rename plugins/{scaffolder-backend-module-gcp-bucket => scaffolder-backend-module-gcp}/.eslintrc.js (100%)
 create mode 100644 plugins/scaffolder-backend-module-gcp/CHANGELOG.md
 rename plugins/{scaffolder-backend-module-gcp-bucket => scaffolder-backend-module-gcp}/README.md (76%)
 rename plugins/{scaffolder-backend-module-gcp-bucket => scaffolder-backend-module-gcp}/api-report.md (95%)
 create mode 100644 plugins/scaffolder-backend-module-gcp/catalog-info.yaml
 rename plugins/{scaffolder-backend-module-gcp-bucket => scaffolder-backend-module-gcp}/knip-report.md (100%)
 rename plugins/{scaffolder-backend-module-gcp-bucket => scaffolder-backend-module-gcp}/package.json (80%)
 rename plugins/{scaffolder-backend-module-gcp-bucket => scaffolder-backend-module-gcp}/src/index.ts (100%)
 rename plugins/{scaffolder-backend-module-gcp-bucket => scaffolder-backend-module-gcp}/src/module.ts (98%)
 rename plugins/{scaffolder-backend-module-gcp-bucket => scaffolder-backend-module-gcp}/src/providers/GcpBucketWorkspaceProvider.ts (100%)

diff --git a/.changeset/tough-lies-mate.md b/.changeset/tough-lies-mate.md
index cbe228a65f..99edcf3616 100644
--- a/.changeset/tough-lies-mate.md
+++ b/.changeset/tough-lies-mate.md
@@ -1,5 +1,5 @@
 ---
-'@backstage/plugin-scaffolder-backend-module-gcp-bucket': minor
+'@backstage/plugin-scaffolder-backend-module-gcp': minor
 '@backstage/plugin-scaffolder-backend': minor
 '@backstage/plugin-scaffolder-node': patch
 ---
diff --git a/plugins/scaffolder-backend-module-gcp-bucket/CHANGELOG.md b/plugins/scaffolder-backend-module-gcp-bucket/CHANGELOG.md
deleted file mode 100644
index b659b67db4..0000000000
--- a/plugins/scaffolder-backend-module-gcp-bucket/CHANGELOG.md
+++ /dev/null
@@ -1,3 +0,0 @@
-# @backstage/plugin-scaffolder-backend-module-gcp-bucket
-
-## 0.0.1
diff --git a/plugins/scaffolder-backend-module-gcp-bucket/catalog-info.yaml b/plugins/scaffolder-backend-module-gcp-bucket/catalog-info.yaml
deleted file mode 100644
index 8fac6a1a2b..0000000000
--- a/plugins/scaffolder-backend-module-gcp-bucket/catalog-info.yaml
+++ /dev/null
@@ -1,10 +0,0 @@
-apiVersion: backstage.io/v1alpha1
-kind: Component
-metadata:
-  name: backstage-plugin-scaffolder-backend-module-gcp-bucket
-  title: '@backstage/plugin-scaffolder-backend-module-gcp-bucket'
-  description: The GCP bucket module for @backstage/plugin-scaffolder-backend
-spec:
-  lifecycle: experimental
-  type: backstage-backend-plugin-module
-  owner: maintainers
diff --git a/plugins/scaffolder-backend-module-gcp-bucket/.eslintrc.js b/plugins/scaffolder-backend-module-gcp/.eslintrc.js
similarity index 100%
rename from plugins/scaffolder-backend-module-gcp-bucket/.eslintrc.js
rename to plugins/scaffolder-backend-module-gcp/.eslintrc.js
diff --git a/plugins/scaffolder-backend-module-gcp/CHANGELOG.md b/plugins/scaffolder-backend-module-gcp/CHANGELOG.md
new file mode 100644
index 0000000000..f633c5b8cd
--- /dev/null
+++ b/plugins/scaffolder-backend-module-gcp/CHANGELOG.md
@@ -0,0 +1,3 @@
+# @backstage/plugin-scaffolder-backend-module-gcp
+
+## 0.0.1
diff --git a/plugins/scaffolder-backend-module-gcp-bucket/README.md b/plugins/scaffolder-backend-module-gcp/README.md
similarity index 76%
rename from plugins/scaffolder-backend-module-gcp-bucket/README.md
rename to plugins/scaffolder-backend-module-gcp/README.md
index 683dd70c01..a9ce86cc6b 100644
--- a/plugins/scaffolder-backend-module-gcp-bucket/README.md
+++ b/plugins/scaffolder-backend-module-gcp/README.md
@@ -1,4 +1,4 @@
-# @backstage/plugin-scaffolder-backend-module-gcp-bucket
+# @backstage/plugin-scaffolder-backend-module-gcp
 
 The GCP bucket module for [@backstage/plugin-scaffolder-backend](https://www.npmjs.com/package/@backstage/plugin-scaffolder-backend).
 
diff --git a/plugins/scaffolder-backend-module-gcp-bucket/api-report.md b/plugins/scaffolder-backend-module-gcp/api-report.md
similarity index 95%
rename from plugins/scaffolder-backend-module-gcp-bucket/api-report.md
rename to plugins/scaffolder-backend-module-gcp/api-report.md
index b7fbc1cec1..4a3b9ebee4 100644
--- a/plugins/scaffolder-backend-module-gcp-bucket/api-report.md
+++ b/plugins/scaffolder-backend-module-gcp/api-report.md
@@ -1,4 +1,4 @@
-## API Report File for "@backstage/plugin-scaffolder-backend-module-gcp-bucket"
+## API Report File for "@backstage/plugin-scaffolder-backend-module-gcp"
 
 > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
 
diff --git a/plugins/scaffolder-backend-module-gcp/catalog-info.yaml b/plugins/scaffolder-backend-module-gcp/catalog-info.yaml
new file mode 100644
index 0000000000..175f9860d1
--- /dev/null
+++ b/plugins/scaffolder-backend-module-gcp/catalog-info.yaml
@@ -0,0 +1,10 @@
+apiVersion: backstage.io/v1alpha1
+kind: Component
+metadata:
+  name: backstage-plugin-scaffolder-backend-module-gcp
+  title: '@backstage/plugin-scaffolder-backend-module-gcp'
+  description: The GCP module for @backstage/plugin-scaffolder-backend
+spec:
+  lifecycle: experimental
+  type: backstage-backend-plugin-module
+  owner: maintainers
diff --git a/plugins/scaffolder-backend-module-gcp-bucket/knip-report.md b/plugins/scaffolder-backend-module-gcp/knip-report.md
similarity index 100%
rename from plugins/scaffolder-backend-module-gcp-bucket/knip-report.md
rename to plugins/scaffolder-backend-module-gcp/knip-report.md
diff --git a/plugins/scaffolder-backend-module-gcp-bucket/package.json b/plugins/scaffolder-backend-module-gcp/package.json
similarity index 80%
rename from plugins/scaffolder-backend-module-gcp-bucket/package.json
rename to plugins/scaffolder-backend-module-gcp/package.json
index 426d43df16..9cb86801ef 100644
--- a/plugins/scaffolder-backend-module-gcp-bucket/package.json
+++ b/plugins/scaffolder-backend-module-gcp/package.json
@@ -1,9 +1,11 @@
 {
-  "name": "@backstage/plugin-scaffolder-backend-module-gcp-bucket",
-  "version": "0.0.1",
+  "name": "@backstage/plugin-scaffolder-backend-module-gcp",
+  "version": "0.0.1-next.1",
   "description": "The GCP Bucket module for @backstage/plugin-scaffolder-backend",
   "backstage": {
-    "role": "backend-plugin-module"
+    "role": "backend-plugin-module",
+    "pluginId": "scaffolder",
+    "pluginPackage": "@backstage/plugin-scaffolder-backend"
   },
   "publishConfig": {
     "access": "public"
@@ -11,7 +13,7 @@
   "repository": {
     "type": "git",
     "url": "https://github.com/backstage/backstage",
-    "directory": "plugins/scaffolder-backend-module-gcp-bucket"
+    "directory": "plugins/scaffolder-backend-module-gcp"
   },
   "license": "Apache-2.0",
   "exports": {
@@ -45,7 +47,7 @@
     "@backstage/errors": "workspace:^",
     "@backstage/integration": "workspace:^",
     "@backstage/plugin-scaffolder-node": "workspace:^",
-    "@google-cloud/storage": "^7.11.2",
+    "@google-cloud/storage": "^7.0.0",
     "raw-body": "^2.4.1"
   },
   "devDependencies": {
diff --git a/plugins/scaffolder-backend-module-gcp-bucket/src/index.ts b/plugins/scaffolder-backend-module-gcp/src/index.ts
similarity index 100%
rename from plugins/scaffolder-backend-module-gcp-bucket/src/index.ts
rename to plugins/scaffolder-backend-module-gcp/src/index.ts
diff --git a/plugins/scaffolder-backend-module-gcp-bucket/src/module.ts b/plugins/scaffolder-backend-module-gcp/src/module.ts
similarity index 98%
rename from plugins/scaffolder-backend-module-gcp-bucket/src/module.ts
rename to plugins/scaffolder-backend-module-gcp/src/module.ts
index 3d48b7f708..0f2f37f5af 100644
--- a/plugins/scaffolder-backend-module-gcp-bucket/src/module.ts
+++ b/plugins/scaffolder-backend-module-gcp/src/module.ts
@@ -25,7 +25,7 @@ import { GcpBucketWorkspaceProvider } from './providers/GcpBucketWorkspaceProvid
  * The Azure Module for the Scaffolder Backend
  */
 export const gcpBucketModule = createBackendModule({
-  moduleId: 'gcp-bucket',
+  moduleId: 'gcp',
   pluginId: 'scaffolder',
   register({ registerInit }) {
     registerInit({
diff --git a/plugins/scaffolder-backend-module-gcp-bucket/src/providers/GcpBucketWorkspaceProvider.ts b/plugins/scaffolder-backend-module-gcp/src/providers/GcpBucketWorkspaceProvider.ts
similarity index 100%
rename from plugins/scaffolder-backend-module-gcp-bucket/src/providers/GcpBucketWorkspaceProvider.ts
rename to plugins/scaffolder-backend-module-gcp/src/providers/GcpBucketWorkspaceProvider.ts
diff --git a/plugins/scaffolder-backend/config.d.ts b/plugins/scaffolder-backend/config.d.ts
index 2e36922355..f6b9522575 100644
--- a/plugins/scaffolder-backend/config.d.ts
+++ b/plugins/scaffolder-backend/config.d.ts
@@ -57,9 +57,7 @@ export interface Config {
      *
      * By default, it is your database.
      */
-    EXPERIMENTAL_workspaceSerializationProvider?:
-      | 'database'
-      | 'googleCloudBucket';
+    EXPERIMENTAL_workspaceSerializationProvider?: string;
 
     /**
      * Every task which is in progress state and having a last heartbeat longer than a specified timeout is going to
diff --git a/yarn.lock b/yarn.lock
index 8a1a84b970..3671d290fc 100644
--- a/yarn.lock
+++ b/yarn.lock
@@ -6779,9 +6779,9 @@ __metadata:
   languageName: unknown
   linkType: soft
 
-"@backstage/plugin-scaffolder-backend-module-gcp-bucket@workspace:plugins/scaffolder-backend-module-gcp-bucket":
+"@backstage/plugin-scaffolder-backend-module-gcp@workspace:plugins/scaffolder-backend-module-gcp":
   version: 0.0.0-use.local
-  resolution: "@backstage/plugin-scaffolder-backend-module-gcp-bucket@workspace:plugins/scaffolder-backend-module-gcp-bucket"
+  resolution: "@backstage/plugin-scaffolder-backend-module-gcp@workspace:plugins/scaffolder-backend-module-gcp"
   dependencies:
     "@backstage/backend-plugin-api": "workspace:^"
     "@backstage/cli": "workspace:^"
@@ -6790,7 +6790,7 @@ __metadata:
     "@backstage/integration": "workspace:^"
     "@backstage/plugin-scaffolder-node": "workspace:^"
     "@backstage/plugin-scaffolder-node-test-utils": "workspace:^"
-    "@google-cloud/storage": ^7.11.2
+    "@google-cloud/storage": ^7.0.0
     raw-body: ^2.4.1
   languageName: unknown
   linkType: soft
@@ -9372,7 +9372,7 @@ __metadata:
   languageName: node
   linkType: hard
 
-"@google-cloud/storage@npm:^7.0.0, @google-cloud/storage@npm:^7.11.2":
+"@google-cloud/storage@npm:^7.0.0":
   version: 7.11.2
   resolution: "@google-cloud/storage@npm:7.11.2"
   dependencies:

From c1ce17501144d5a74e70762ca9728b61d57aa33e Mon Sep 17 00:00:00 2001
From: bnechyporenko <bnechyporenko@bol.com>
Date: Sun, 16 Jun 2024 10:15:20 +0200
Subject: [PATCH 08/13] wip

Signed-off-by: bnechyporenko <bnechyporenko@bol.com>
---
 .../scaffolder-backend-module-gcp/config.d.ts | 25 +++++++++++++++++++
 .../package.json                              |  3 ++-
 .../providers/GcpBucketWorkspaceProvider.ts   |  4 +--
 3 files changed, 29 insertions(+), 3 deletions(-)
 create mode 100644 plugins/scaffolder-backend-module-gcp/config.d.ts

diff --git a/plugins/scaffolder-backend-module-gcp/config.d.ts b/plugins/scaffolder-backend-module-gcp/config.d.ts
new file mode 100644
index 0000000000..acd3eebdd9
--- /dev/null
+++ b/plugins/scaffolder-backend-module-gcp/config.d.ts
@@ -0,0 +1,25 @@
+/*
+ * Copyright 2020 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+export interface Config {
+  /** Configuration options for the scaffolder plugin */
+  scaffolder?: {
+    /**
+     * Sets GCP bucket name to store serialized workspace for scaffolder tasks.
+     */
+    EXPERIMENTAL_workspaceSerializationGcpBucketName?: string;
+  };
+}
diff --git a/plugins/scaffolder-backend-module-gcp/package.json b/plugins/scaffolder-backend-module-gcp/package.json
index 9cb86801ef..9d5efa2891 100644
--- a/plugins/scaffolder-backend-module-gcp/package.json
+++ b/plugins/scaffolder-backend-module-gcp/package.json
@@ -30,7 +30,8 @@
     }
   },
   "files": [
-    "dist"
+    "dist",
+    "config.d.ts"
   ],
   "scripts": {
     "build": "backstage-cli package build",
diff --git a/plugins/scaffolder-backend-module-gcp/src/providers/GcpBucketWorkspaceProvider.ts b/plugins/scaffolder-backend-module-gcp/src/providers/GcpBucketWorkspaceProvider.ts
index 5afa267041..cd2beb2073 100644
--- a/plugins/scaffolder-backend-module-gcp/src/providers/GcpBucketWorkspaceProvider.ts
+++ b/plugins/scaffolder-backend-module-gcp/src/providers/GcpBucketWorkspaceProvider.ts
@@ -87,11 +87,11 @@ export class GcpBucketWorkspaceProvider implements WorkspaceProvider {
 
   private getGcpBucketName(): string {
     const bucketName = this.config?.getOptionalString(
-      'scaffolder.EXPERIMENTAL_gcpBucketName',
+      'scaffolder.EXPERIMENTAL_workspaceSerializationGcpBucketName',
     );
     if (!bucketName) {
       throw new Error(
-        `You've missed to configure scaffolder.EXPERIMENTAL_gcpBucketName in app-config.yaml file`,
+        `You've missed to configure scaffolder.EXPERIMENTAL_workspaceSerializationGcpBucketName in app-config.yaml file`,
       );
     }
     return bucketName;

From e27d30c99c64356d68e70bd60049d255f88e6c92 Mon Sep 17 00:00:00 2001
From: bnechyporenko <bnechyporenko@bol.com>
Date: Sun, 16 Jun 2024 11:45:48 +0200
Subject: [PATCH 09/13] wip

Signed-off-by: bnechyporenko <bnechyporenko@bol.com>
---
 .../src/scaffolder/tasks/NunjucksWorkflowRunner.ts              | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/plugins/scaffolder-backend/src/scaffolder/tasks/NunjucksWorkflowRunner.ts b/plugins/scaffolder-backend/src/scaffolder/tasks/NunjucksWorkflowRunner.ts
index e9b1d78e36..3b88fd0f10 100644
--- a/plugins/scaffolder-backend/src/scaffolder/tasks/NunjucksWorkflowRunner.ts
+++ b/plugins/scaffolder-backend/src/scaffolder/tasks/NunjucksWorkflowRunner.ts
@@ -443,7 +443,6 @@ export class NunjucksWorkflowRunner implements WorkflowRunner {
         throw new Error(`Step ${step.name} has been cancelled.`);
       }
 
-      await task.cleanWorkspace?.();
       await stepTrack.markSuccessful();
     } catch (err) {
       await taskTrack.markFailed(step, err);
@@ -513,6 +512,7 @@ export class NunjucksWorkflowRunner implements WorkflowRunner {
       return { output };
     } finally {
       if (workspacePath) {
+        await task.cleanWorkspace?.();
         await fs.remove(workspacePath);
       }
     }

From d9a907b062fb018ae976c548ba9d5c2cd8876128 Mon Sep 17 00:00:00 2001
From: bnechyporenko <bnechyporenko@bol.com>
Date: Mon, 24 Jun 2024 20:14:34 +0200
Subject: [PATCH 10/13] wip

Signed-off-by: bnechyporenko <bnechyporenko@bol.com>
---
 plugins/scaffolder-backend-module-gcp/package.json | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/plugins/scaffolder-backend-module-gcp/package.json b/plugins/scaffolder-backend-module-gcp/package.json
index 9d5efa2891..7fb3e08b34 100644
--- a/plugins/scaffolder-backend-module-gcp/package.json
+++ b/plugins/scaffolder-backend-module-gcp/package.json
@@ -54,5 +54,6 @@
   "devDependencies": {
     "@backstage/cli": "workspace:^",
     "@backstage/plugin-scaffolder-node-test-utils": "workspace:^"
-  }
+  },
+  "configSchema": "config.d.ts"
 }

From a190944647549e0444902e267c0474ef45ed0879 Mon Sep 17 00:00:00 2001
From: blam <ben@blam.sh>
Date: Tue, 25 Jun 2024 10:25:52 +0200
Subject: [PATCH 11/13] chore: fixing api reports

Signed-off-by: blam <ben@blam.sh>
---
 plugins/scaffolder-backend-module-gcp/api-report.md | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/plugins/scaffolder-backend-module-gcp/api-report.md b/plugins/scaffolder-backend-module-gcp/api-report.md
index 4a3b9ebee4..d75a6ce155 100644
--- a/plugins/scaffolder-backend-module-gcp/api-report.md
+++ b/plugins/scaffolder-backend-module-gcp/api-report.md
@@ -3,9 +3,9 @@
 > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
 
 ```ts
-import { BackendFeature } from '@backstage/backend-plugin-api';
+import { BackendFeatureCompat } from '@backstage/backend-plugin-api';
 
 // @public
-const gcpBucketModule: () => BackendFeature;
+const gcpBucketModule: BackendFeatureCompat;
 export default gcpBucketModule;
 ```

From 47b7ac5adefd8c9039e12d3850b5e0c500286930 Mon Sep 17 00:00:00 2001
From: bnechyporenko <bnechyporenko@bol.com>
Date: Tue, 25 Jun 2024 11:43:45 +0200
Subject: [PATCH 12/13] wip

Signed-off-by: bnechyporenko <bnechyporenko@bol.com>
---
 .../providers/GcpBucketWorkspaceProvider.ts   |  6 ++---
 .../src/scaffolder/tasks/DatabaseTaskStore.ts |  7 ++++--
 .../src/tasks/serializer.test.ts              |  7 ++++--
 .../scaffolder-node/src/tasks/serializer.ts   | 23 ++++++++++++++-----
 4 files changed, 30 insertions(+), 13 deletions(-)

diff --git a/plugins/scaffolder-backend-module-gcp/src/providers/GcpBucketWorkspaceProvider.ts b/plugins/scaffolder-backend-module-gcp/src/providers/GcpBucketWorkspaceProvider.ts
index cd2beb2073..3d269f690e 100644
--- a/plugins/scaffolder-backend-module-gcp/src/providers/GcpBucketWorkspaceProvider.ts
+++ b/plugins/scaffolder-backend-module-gcp/src/providers/GcpBucketWorkspaceProvider.ts
@@ -55,7 +55,7 @@ export class GcpBucketWorkspaceProvider implements WorkspaceProvider {
     const fileCloud = this.storage
       .bucket(this.getGcpBucketName())
       .file(options.taskId);
-    const workspace = await serializeWorkspace(options.path);
+    const { contents: workspace } = await serializeWorkspace(options);
     try {
       await fileCloud.save(workspace, {
         contentType: 'application/x-tar',
@@ -80,8 +80,8 @@ export class GcpBucketWorkspaceProvider implements WorkspaceProvider {
     const file = bucket.file(options.taskId);
     const result = await file.exists();
     if (result[0]) {
-      const workspace = getRawBody(file.createReadStream());
-      await restoreWorkspace(options.targetPath, await workspace);
+      const workspace = await getRawBody(file.createReadStream());
+      await restoreWorkspace({ path: options.targetPath, buffer: workspace });
     }
   }
 
diff --git a/plugins/scaffolder-backend/src/scaffolder/tasks/DatabaseTaskStore.ts b/plugins/scaffolder-backend/src/scaffolder/tasks/DatabaseTaskStore.ts
index 02b657032a..a4447c5dc0 100644
--- a/plugins/scaffolder-backend/src/scaffolder/tasks/DatabaseTaskStore.ts
+++ b/plugins/scaffolder-backend/src/scaffolder/tasks/DatabaseTaskStore.ts
@@ -520,7 +520,10 @@ export class DatabaseTaskStore implements TaskStore {
       .where({ id: options.taskId })
       .select('workspace');
 
-    await restoreWorkspace(options.targetPath, result.workspace);
+    await restoreWorkspace({
+      path: options.targetPath,
+      buffer: result.workspace,
+    });
   }
 
   async cleanWorkspace({ taskId }: { taskId: string }): Promise<void> {
@@ -537,7 +540,7 @@ export class DatabaseTaskStore implements TaskStore {
       await this.db<RawDbTaskRow>('tasks')
         .where({ id: options.taskId })
         .update({
-          workspace: await serializeWorkspace(options.path),
+          workspace: (await serializeWorkspace(options)).contents,
         });
     }
   }
diff --git a/plugins/scaffolder-node/src/tasks/serializer.test.ts b/plugins/scaffolder-node/src/tasks/serializer.test.ts
index bec5398e28..a0ddfa624d 100644
--- a/plugins/scaffolder-node/src/tasks/serializer.test.ts
+++ b/plugins/scaffolder-node/src/tasks/serializer.test.ts
@@ -72,8 +72,11 @@ describe('serializer', () => {
   const restoredWorkspaceDir = createMockDirectory();
 
   it('should be able to archive and restore the workspace', async () => {
-    const workspaceBuffer = await serializeWorkspace(workspaceDir.path);
-    await restoreWorkspace(restoredWorkspaceDir.path, workspaceBuffer);
+    const workspaceBuffer = await serializeWorkspace(workspaceDir);
+    await restoreWorkspace({
+      path: restoredWorkspaceDir.path,
+      buffer: workspaceBuffer.contents,
+    });
 
     expect(
       fs.existsSync(`${restoredWorkspaceDir.path}/\$\{ESCAPE_ME\}.txt`),
diff --git a/plugins/scaffolder-node/src/tasks/serializer.ts b/plugins/scaffolder-node/src/tasks/serializer.ts
index f9a55a68f4..baf1b42157 100644
--- a/plugins/scaffolder-node/src/tasks/serializer.ts
+++ b/plugins/scaffolder-node/src/tasks/serializer.ts
@@ -23,20 +23,31 @@ const pipeline = promisify(pipelineCb);
 /**
  * Serializes provided path into tar archive
  *
- * @public
+ * @alpha
  */
-export const serializeWorkspace = async (path: string): Promise<Buffer> => {
-  return new Promise<Buffer>(async resolve => {
-    await pipeline(tar.create({ cwd: path }, ['']), concatStream(resolve));
+export const serializeWorkspace = async (opts: {
+  path: string;
+}): Promise<{ contents: Buffer }> => {
+  return new Promise<{ contents: Buffer }>(async resolve => {
+    await pipeline(
+      tar.create({ cwd: opts.path }, ['']),
+      concatStream(buffer => {
+        return resolve({ contents: buffer });
+      }),
+    );
   });
 };
 
 /**
  * Rehydrates the provided buffer of tar archive into the provide destination path
  *
- * @public
+ * @alpha
  */
-export const restoreWorkspace = async (path: string, buffer?: Buffer) => {
+export const restoreWorkspace = async (opts: {
+  path: string;
+  buffer?: Buffer;
+}): Promise<void> => {
+  const { buffer, path } = opts;
   if (buffer) {
     await pipeline(
       Readable.from(buffer),

From b61503b2ba0ca8c75045db71713611586c143cec Mon Sep 17 00:00:00 2001
From: blam <ben@blam.sh>
Date: Tue, 25 Jun 2024 14:41:42 +0200
Subject: [PATCH 13/13] feat: fix up the branch Signed-off-by: blam
 <ben@blam.sh>

---
 .../src/providers/GcpBucketWorkspaceProvider.ts  |  2 +-
 .../scaffolder-backend/src/ScaffolderPlugin.ts   |  6 +++---
 .../src/scaffolder/tasks/DatabaseTaskStore.ts    |  2 +-
 plugins/scaffolder-node/api-report-alpha.md      | 13 +++++++++++++
 plugins/scaffolder-node/api-report.md            |  6 ------
 plugins/scaffolder-node/src/alpha.ts             |  2 ++
 plugins/scaffolder-node/src/tasks/alpha.ts       | 16 ++++++++++++++++
 plugins/scaffolder-node/src/tasks/index.ts       |  2 --
 8 files changed, 36 insertions(+), 13 deletions(-)
 create mode 100644 plugins/scaffolder-node/src/tasks/alpha.ts

diff --git a/plugins/scaffolder-backend-module-gcp/src/providers/GcpBucketWorkspaceProvider.ts b/plugins/scaffolder-backend-module-gcp/src/providers/GcpBucketWorkspaceProvider.ts
index 3d269f690e..3529073648 100644
--- a/plugins/scaffolder-backend-module-gcp/src/providers/GcpBucketWorkspaceProvider.ts
+++ b/plugins/scaffolder-backend-module-gcp/src/providers/GcpBucketWorkspaceProvider.ts
@@ -24,7 +24,7 @@ import { LoggerService } from '@backstage/backend-plugin-api';
 import {
   serializeWorkspace,
   restoreWorkspace,
-} from '@backstage/plugin-scaffolder-node';
+} from '@backstage/plugin-scaffolder-node/alpha';
 
 export class GcpBucketWorkspaceProvider implements WorkspaceProvider {
   static create(logger: LoggerService, config?: Config) {
diff --git a/plugins/scaffolder-backend/src/ScaffolderPlugin.ts b/plugins/scaffolder-backend/src/ScaffolderPlugin.ts
index 50e0dff9c0..27b4f6b196 100644
--- a/plugins/scaffolder-backend/src/ScaffolderPlugin.ts
+++ b/plugins/scaffolder-backend/src/ScaffolderPlugin.ts
@@ -86,17 +86,17 @@ export const scaffolderPlugin = createBackendPlugin({
       },
     });
 
-<<<<<<< HEAD
     const autocompleteHandlers: Record<string, AutocompleteHandler> = {};
     env.registerExtensionPoint(scaffolderAutocompleteExtensionPoint, {
       addAutocompleteProvider(provider) {
         autocompleteHandlers[provider.id] = provider.handler;
-=======
+      },
+    });
+
     const additionalWorkspaceProviders: Record<string, WorkspaceProvider> = {};
     env.registerExtensionPoint(scaffolderWorkspaceProviderExtensionPoint, {
       addProviders(provider) {
         Object.assign(additionalWorkspaceProviders, provider);
->>>>>>> 801e5ff2007a (Storing the serialized workspace into google cloud bucket)
       },
     });
 
diff --git a/plugins/scaffolder-backend/src/scaffolder/tasks/DatabaseTaskStore.ts b/plugins/scaffolder-backend/src/scaffolder/tasks/DatabaseTaskStore.ts
index a4447c5dc0..fe62572af9 100644
--- a/plugins/scaffolder-backend/src/scaffolder/tasks/DatabaseTaskStore.ts
+++ b/plugins/scaffolder-backend/src/scaffolder/tasks/DatabaseTaskStore.ts
@@ -43,7 +43,7 @@ import { intervalFromNowTill } from './dbUtil';
 import {
   restoreWorkspace,
   serializeWorkspace,
-} from '@backstage/plugin-scaffolder-node';
+} from '@backstage/plugin-scaffolder-node/alpha';
 
 const migrationsDir = resolvePackagePath(
   '@backstage/plugin-scaffolder-backend',
diff --git a/plugins/scaffolder-node/api-report-alpha.md b/plugins/scaffolder-node/api-report-alpha.md
index 9601d73215..c9b8130f0e 100644
--- a/plugins/scaffolder-node/api-report-alpha.md
+++ b/plugins/scaffolder-node/api-report-alpha.md
@@ -3,6 +3,8 @@
 > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
 
 ```ts
+/// <reference types="node" />
+
 import { ExtensionPoint } from '@backstage/backend-plugin-api';
 import { TaskBroker } from '@backstage/plugin-scaffolder-node';
 import { TemplateAction } from '@backstage/plugin-scaffolder-node';
@@ -24,6 +26,12 @@ export type AutocompleteHandler = ({
   }[];
 }>;
 
+// @alpha
+export const restoreWorkspace: (opts: {
+  path: string;
+  buffer?: Buffer;
+}) => Promise<void>;
+
 // @alpha
 export interface ScaffolderActionsExtensionPoint {
   // (undocumented)
@@ -77,6 +85,11 @@ export interface ScaffolderWorkspaceProviderExtensionPoint {
 // @alpha
 export const scaffolderWorkspaceProviderExtensionPoint: ExtensionPoint<ScaffolderWorkspaceProviderExtensionPoint>;
 
+// @alpha
+export const serializeWorkspace: (opts: { path: string }) => Promise<{
+  contents: Buffer;
+}>;
+
 // @alpha
 export interface WorkspaceProvider {
   // (undocumented)
diff --git a/plugins/scaffolder-node/api-report.md b/plugins/scaffolder-node/api-report.md
index 9e9a31a991..66e8ccd678 100644
--- a/plugins/scaffolder-node/api-report.md
+++ b/plugins/scaffolder-node/api-report.md
@@ -256,9 +256,6 @@ export const parseRepoUrl: (
   project?: string | undefined;
 };
 
-// @public
-export const restoreWorkspace: (path: string, buffer?: Buffer) => Promise<void>;
-
 // @public (undocumented)
 export interface SerializedFile {
   // (undocumented)
@@ -301,9 +298,6 @@ export type SerializedTaskEvent = {
   createdAt: string;
 };
 
-// @public
-export const serializeWorkspace: (path: string) => Promise<Buffer>;
-
 // @public
 export interface TaskBroker {
   // (undocumented)
diff --git a/plugins/scaffolder-node/src/alpha.ts b/plugins/scaffolder-node/src/alpha.ts
index 1bb013832c..6a0e34faf7 100644
--- a/plugins/scaffolder-node/src/alpha.ts
+++ b/plugins/scaffolder-node/src/alpha.ts
@@ -22,6 +22,8 @@ import {
   TaskBroker,
 } from '@backstage/plugin-scaffolder-node';
 
+export * from './tasks/alpha';
+
 /**
  * Extension point for managing scaffolder actions.
  *
diff --git a/plugins/scaffolder-node/src/tasks/alpha.ts b/plugins/scaffolder-node/src/tasks/alpha.ts
new file mode 100644
index 0000000000..fb6b09026c
--- /dev/null
+++ b/plugins/scaffolder-node/src/tasks/alpha.ts
@@ -0,0 +1,16 @@
+/*
+ * Copyright 2024 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+export * from './serializer';
diff --git a/plugins/scaffolder-node/src/tasks/index.ts b/plugins/scaffolder-node/src/tasks/index.ts
index b1754a1f78..930de95237 100644
--- a/plugins/scaffolder-node/src/tasks/index.ts
+++ b/plugins/scaffolder-node/src/tasks/index.ts
@@ -26,5 +26,3 @@ export type {
   TaskEventType,
   TaskStatus,
 } from './types';
-
-export * from './serializer';