@backstage/plugin-scaffolder-backend-module-gcp 0.2.24 → 0.2.25-next.0

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # @backstage/plugin-scaffolder-backend-module-gcp
 
+## 0.2.25-next.0
+
+### Patch Changes
+
+- e95b649: Added new config path `scaffolder.taskRecovery.gcsBucket.name` for GCS workspace provider. The previous `EXPERIMENTAL_workspaceSerializationGcpBucketName` config is still supported as a fallback. Workspace upload failures are now propagated so that a task does not record a completed step without its corresponding workspace.
+- Updated dependencies
+  - @backstage/plugin-scaffolder-node@0.13.7-next.0
+
 ## 0.2.24
 
 ### Patch Changes

package/config.schema.json

@@ -5,9 +5,30 @@
     "scaffolder": {
       "type": "object",
       "properties": {
+        "taskRecovery": {
+          "type": "object",
+          "properties": {
+            "gcsBucket": {
+              "type": "object",
+              "properties": {
+                "name": {
+                  "type": "string",
+                  "description": "The GCS bucket name to store serialized workspaces.",
+                  "visibility": "backend"
+                }
+              },
+              "required": [
+                "name"
+              ],
+              "description": "GCS bucket configuration for workspace serialization. Only used when workspaceProvider is set to 'gcpBucket'."
+            }
+          },
+          "description": "Task recovery configuration"
+        },
         "EXPERIMENTAL_workspaceSerializationGcpBucketName": {
           "type": "string",
-          "description": "Sets GCP bucket name to store serialized workspace for scaffolder tasks."
+          "description": "Sets GCP bucket name to store serialized workspace for scaffolder tasks.",
+          "deprecated": "Use scaffolder.taskRecovery.gcsBucket.name instead."
         }
       },
       "description": "Configuration options for the scaffolder plugin"

package/dist/providers/GcpBucketWorkspaceProvider.cjs.js

@@ -1,5 +1,6 @@
 'use strict';
 
+var errors = require('@backstage/errors');
 var getRawBody = require('raw-body');
 var storage = require('@google-cloud/storage');
 var alpha = require('@backstage/plugin-scaffolder-node/alpha');
@@ -34,9 +35,10 @@ class GcpBucketWorkspaceProvider {
       await fileCloud.save(workspace, {
         contentType: "application/x-tar"
       });
-    } catch (err) {
-      this.logger.error(
-        `An error occurred during uploading the workspace of task ${options.taskId} into GCP bucket ${this.getGcpBucketName()}`
+    } catch (error) {
+      throw new errors.ForwardedError(
+        `Failed to upload workspace for task '${options.taskId}' to GCS`,
+        error
       );
     }
     this.logger.info(
@@ -54,11 +56,13 @@ class GcpBucketWorkspaceProvider {
   }
   getGcpBucketName() {
     const bucketName = this.config?.getOptionalString(
+      "scaffolder.taskRecovery.gcsBucket.name"
+    ) ?? this.config?.getOptionalString(
       "scaffolder.EXPERIMENTAL_workspaceSerializationGcpBucketName"
     );
     if (!bucketName) {
       throw new Error(
-        `You've missed to configure scaffolder.EXPERIMENTAL_workspaceSerializationGcpBucketName in app-config.yaml file`
+        `Missing GCS bucket configuration. Set scaffolder.taskRecovery.gcsBucket.name in app-config.yaml`
       );
     }
     return bucketName;

package/dist/providers/GcpBucketWorkspaceProvider.cjs.js.map

@@ -1 +1 @@
-{"version":3,"file":"GcpBucketWorkspaceProvider.cjs.js","sources":["../../src/providers/GcpBucketWorkspaceProvider.ts"],"sourcesContent":["/*\n * Copyright 2021 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { Config } from '@backstage/config';\nimport { WorkspaceProvider } from '@backstage/plugin-scaffolder-node/alpha';\n\nimport getRawBody from 'raw-body';\nimport { Storage } from '@google-cloud/storage';\nimport { LoggerService } from '@backstage/backend-plugin-api';\n\nimport {\n  serializeWorkspace,\n  restoreWorkspace,\n} from '@backstage/plugin-scaffolder-node/alpha';\n\nexport class GcpBucketWorkspaceProvider implements WorkspaceProvider {\n  private readonly storage: Storage;\n  private readonly logger: LoggerService;\n  private readonly config?: Config;\n\n  static create(logger: LoggerService, config?: Config) {\n    return new GcpBucketWorkspaceProvider(new Storage(), logger, config);\n  }\n\n  private constructor(\n    storage: Storage,\n    logger: LoggerService,\n    config?: Config,\n  ) {\n    this.storage = storage;\n    this.logger = logger;\n    this.config = config;\n  }\n\n  public async cleanWorkspace(options: { taskId: string }): Promise<void> {\n    const file = this.storage\n      .bucket(this.getGcpBucketName())\n      .file(options.taskId);\n\n    const result = await file.exists();\n    if (result[0]) {\n      await file.delete();\n    }\n  }\n\n  public async serializeWorkspace(options: {\n    path: string;\n    taskId: string;\n  }): Promise<void> {\n    const fileCloud = this.storage\n      .bucket(this.getGcpBucketName())\n      .file(options.taskId);\n    const { contents: workspace } = await serializeWorkspace(options);\n    try {\n      await fileCloud.save(workspace, {\n        contentType: 'application/x-tar',\n      });\n    } catch (err) {\n      this.logger.error(\n        `An error occurred during uploading the workspace of task ${\n          options.taskId\n        } into GCP bucket ${this.getGcpBucketName()}`,\n      );\n    }\n    this.logger.info(\n      `Workspace for task ${options.taskId} has been serialized.`,\n    );\n  }\n\n  public async rehydrateWorkspace(options: {\n    taskId: string;\n    targetPath: string;\n  }): Promise<void> {\n    const bucket = this.storage.bucket(this.getGcpBucketName());\n    const file = bucket.file(options.taskId);\n    const result = await file.exists();\n    if (result[0]) {\n      const workspace = await getRawBody(file.createReadStream());\n      await restoreWorkspace({ path: options.targetPath, buffer: workspace });\n    }\n  }\n\n  private getGcpBucketName(): string {\n    const bucketName = this.config?.getOptionalString(\n      'scaffolder.EXPERIMENTAL_workspaceSerializationGcpBucketName',\n    );\n    if (!bucketName) {\n      throw new Error(\n        `You've missed to configure scaffolder.EXPERIMENTAL_workspaceSerializationGcpBucketName in app-config.yaml file`,\n      );\n    }\n    return bucketName;\n  }\n}\n"],"names":["Storage","serializeWorkspace","getRawBody","restoreWorkspace"],"mappings":";;;;;;;;;;AA4BO,MAAM,0BAAA,CAAwD;AAAA,EAClD,OAAA;AAAA,EACA,MAAA;AAAA,EACA,MAAA;AAAA,EAEjB,OAAO,MAAA,CAAO,MAAA,EAAuB,MAAA,EAAiB;AACpD,IAAA,OAAO,IAAI,0BAAA,CAA2B,IAAIA,eAAA,EAAQ,EAAG,QAAQ,MAAM,CAAA;AAAA,EACrE;AAAA,EAEQ,WAAA,CACN,OAAA,EACA,MAAA,EACA,MAAA,EACA;AACA,IAAA,IAAA,CAAK,OAAA,GAAU,OAAA;AACf,IAAA,IAAA,CAAK,MAAA,GAAS,MAAA;AACd,IAAA,IAAA,CAAK,MAAA,GAAS,MAAA;AAAA,EAChB;AAAA,EAEA,MAAa,eAAe,OAAA,EAA4C;AACtE,IAAA,MAAM,IAAA,GAAO,IAAA,CAAK,OAAA,CACf,MAAA,CAAO,IAAA,CAAK,kBAAkB,CAAA,CAC9B,IAAA,CAAK,OAAA,CAAQ,MAAM,CAAA;AAEtB,IAAA,MAAM,MAAA,GAAS,MAAM,IAAA,CAAK,MAAA,EAAO;AACjC,IAAA,IAAI,MAAA,CAAO,CAAC,CAAA,EAAG;AACb,MAAA,MAAM,KAAK,MAAA,EAAO;AAAA,IACpB;AAAA,EACF;AAAA,EAEA,MAAa,mBAAmB,OAAA,EAGd;AAChB,IAAA,MAAM,SAAA,GAAY,IAAA,CAAK,OAAA,CACpB,MAAA,CAAO,IAAA,CAAK,kBAAkB,CAAA,CAC9B,IAAA,CAAK,OAAA,CAAQ,MAAM,CAAA;AACtB,IAAA,MAAM,EAAE,QAAA,EAAU,SAAA,EAAU,GAAI,MAAMC,yBAAmB,OAAO,CAAA;AAChE,IAAA,IAAI;AACF,MAAA,MAAM,SAAA,CAAU,KAAK,SAAA,EAAW;AAAA,QAC9B,WAAA,EAAa;AAAA,OACd,CAAA;AAAA,IACH,SAAS,GAAA,EAAK;AACZ,MAAA,IAAA,CAAK,MAAA,CAAO,KAAA;AAAA,QACV,4DACE,OAAA,CAAQ,MACV,CAAA,iBAAA,EAAoB,IAAA,CAAK,kBAAkB,CAAA;AAAA,OAC7C;AAAA,IACF;AACA,IAAA,IAAA,CAAK,MAAA,CAAO,IAAA;AAAA,MACV,CAAA,mBAAA,EAAsB,QAAQ,MAAM,CAAA,qBAAA;AAAA,KACtC;AAAA,EACF;AAAA,EAEA,MAAa,mBAAmB,OAAA,EAGd;AAChB,IAAA,MAAM,SAAS,IAAA,CAAK,OAAA,CAAQ,MAAA,CAAO,IAAA,CAAK,kBAAkB,CAAA;AAC1D,IAAA,MAAM,IAAA,GAAO,MAAA,CAAO,IAAA,CAAK,OAAA,CAAQ,MAAM,CAAA;AACvC,IAAA,MAAM,MAAA,GAAS,MAAM,IAAA,CAAK,MAAA,EAAO;AACjC,IAAA,IAAI,MAAA,CAAO,CAAC,CAAA,EAAG;AACb,MAAA,MAAM,SAAA,GAAY,MAAMC,2BAAA,CAAW,IAAA,CAAK,kBAAkB,CAAA;AAC1D,MAAA,MAAMC,uBAAiB,EAAE,IAAA,EAAM,QAAQ,UAAA,EAAY,MAAA,EAAQ,WAAW,CAAA;AAAA,IACxE;AAAA,EACF;AAAA,EAEQ,gBAAA,GAA2B;AACjC,IAAA,MAAM,UAAA,GAAa,KAAK,MAAA,EAAQ,iBAAA;AAAA,MAC9B;AAAA,KACF;AACA,IAAA,IAAI,CAAC,UAAA,EAAY;AACf,MAAA,MAAM,IAAI,KAAA;AAAA,QACR,CAAA,8GAAA;AAAA,OACF;AAAA,IACF;AACA,IAAA,OAAO,UAAA;AAAA,EACT;AACF;;;;"}
+{"version":3,"file":"GcpBucketWorkspaceProvider.cjs.js","sources":["../../src/providers/GcpBucketWorkspaceProvider.ts"],"sourcesContent":["/*\n * Copyright 2021 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { Config } from '@backstage/config';\nimport { ForwardedError } from '@backstage/errors';\nimport { WorkspaceProvider } from '@backstage/plugin-scaffolder-node/alpha';\n\nimport getRawBody from 'raw-body';\nimport { Storage } from '@google-cloud/storage';\nimport { LoggerService } from '@backstage/backend-plugin-api';\n\nimport {\n  serializeWorkspace,\n  restoreWorkspace,\n} from '@backstage/plugin-scaffolder-node/alpha';\n\nexport class GcpBucketWorkspaceProvider implements WorkspaceProvider {\n  private readonly storage: Storage;\n  private readonly logger: LoggerService;\n  private readonly config?: Config;\n\n  static create(logger: LoggerService, config?: Config) {\n    return new GcpBucketWorkspaceProvider(new Storage(), logger, config);\n  }\n\n  private constructor(\n    storage: Storage,\n    logger: LoggerService,\n    config?: Config,\n  ) {\n    this.storage = storage;\n    this.logger = logger;\n    this.config = config;\n  }\n\n  public async cleanWorkspace(options: { taskId: string }): Promise<void> {\n    const file = this.storage\n      .bucket(this.getGcpBucketName())\n      .file(options.taskId);\n\n    const result = await file.exists();\n    if (result[0]) {\n      await file.delete();\n    }\n  }\n\n  public async serializeWorkspace(options: {\n    path: string;\n    taskId: string;\n  }): Promise<void> {\n    const fileCloud = this.storage\n      .bucket(this.getGcpBucketName())\n      .file(options.taskId);\n    const { contents: workspace } = await serializeWorkspace(options);\n    try {\n      await fileCloud.save(workspace, {\n        contentType: 'application/x-tar',\n      });\n    } catch (error) {\n      throw new ForwardedError(\n        `Failed to upload workspace for task '${options.taskId}' to GCS`,\n        error,\n      );\n    }\n    this.logger.info(\n      `Workspace for task ${options.taskId} has been serialized.`,\n    );\n  }\n\n  public async rehydrateWorkspace(options: {\n    taskId: string;\n    targetPath: string;\n  }): Promise<void> {\n    const bucket = this.storage.bucket(this.getGcpBucketName());\n    const file = bucket.file(options.taskId);\n    const result = await file.exists();\n    if (result[0]) {\n      const workspace = await getRawBody(file.createReadStream());\n      await restoreWorkspace({ path: options.targetPath, buffer: workspace });\n    }\n  }\n\n  private getGcpBucketName(): string {\n    // New config path with fallback to old experimental flag\n    const bucketName =\n      this.config?.getOptionalString(\n        'scaffolder.taskRecovery.gcsBucket.name',\n      ) ??\n      this.config?.getOptionalString(\n        'scaffolder.EXPERIMENTAL_workspaceSerializationGcpBucketName',\n      );\n    if (!bucketName) {\n      throw new Error(\n        `Missing GCS bucket configuration. Set scaffolder.taskRecovery.gcsBucket.name in app-config.yaml`,\n      );\n    }\n    return bucketName;\n  }\n}\n"],"names":["Storage","serializeWorkspace","ForwardedError","getRawBody","restoreWorkspace"],"mappings":";;;;;;;;;;;AA6BO,MAAM,0BAAA,CAAwD;AAAA,EAClD,OAAA;AAAA,EACA,MAAA;AAAA,EACA,MAAA;AAAA,EAEjB,OAAO,MAAA,CAAO,MAAA,EAAuB,MAAA,EAAiB;AACpD,IAAA,OAAO,IAAI,0BAAA,CAA2B,IAAIA,eAAA,EAAQ,EAAG,QAAQ,MAAM,CAAA;AAAA,EACrE;AAAA,EAEQ,WAAA,CACN,OAAA,EACA,MAAA,EACA,MAAA,EACA;AACA,IAAA,IAAA,CAAK,OAAA,GAAU,OAAA;AACf,IAAA,IAAA,CAAK,MAAA,GAAS,MAAA;AACd,IAAA,IAAA,CAAK,MAAA,GAAS,MAAA;AAAA,EAChB;AAAA,EAEA,MAAa,eAAe,OAAA,EAA4C;AACtE,IAAA,MAAM,IAAA,GAAO,IAAA,CAAK,OAAA,CACf,MAAA,CAAO,IAAA,CAAK,kBAAkB,CAAA,CAC9B,IAAA,CAAK,OAAA,CAAQ,MAAM,CAAA;AAEtB,IAAA,MAAM,MAAA,GAAS,MAAM,IAAA,CAAK,MAAA,EAAO;AACjC,IAAA,IAAI,MAAA,CAAO,CAAC,CAAA,EAAG;AACb,MAAA,MAAM,KAAK,MAAA,EAAO;AAAA,IACpB;AAAA,EACF;AAAA,EAEA,MAAa,mBAAmB,OAAA,EAGd;AAChB,IAAA,MAAM,SAAA,GAAY,IAAA,CAAK,OAAA,CACpB,MAAA,CAAO,IAAA,CAAK,kBAAkB,CAAA,CAC9B,IAAA,CAAK,OAAA,CAAQ,MAAM,CAAA;AACtB,IAAA,MAAM,EAAE,QAAA,EAAU,SAAA,EAAU,GAAI,MAAMC,yBAAmB,OAAO,CAAA;AAChE,IAAA,IAAI;AACF,MAAA,MAAM,SAAA,CAAU,KAAK,SAAA,EAAW;AAAA,QAC9B,WAAA,EAAa;AAAA,OACd,CAAA;AAAA,IACH,SAAS,KAAA,EAAO;AACd,MAAA,MAAM,IAAIC,qBAAA;AAAA,QACR,CAAA,qCAAA,EAAwC,QAAQ,MAAM,CAAA,QAAA,CAAA;AAAA,QACtD;AAAA,OACF;AAAA,IACF;AACA,IAAA,IAAA,CAAK,MAAA,CAAO,IAAA;AAAA,MACV,CAAA,mBAAA,EAAsB,QAAQ,MAAM,CAAA,qBAAA;AAAA,KACtC;AAAA,EACF;AAAA,EAEA,MAAa,mBAAmB,OAAA,EAGd;AAChB,IAAA,MAAM,SAAS,IAAA,CAAK,OAAA,CAAQ,MAAA,CAAO,IAAA,CAAK,kBAAkB,CAAA;AAC1D,IAAA,MAAM,IAAA,GAAO,MAAA,CAAO,IAAA,CAAK,OAAA,CAAQ,MAAM,CAAA;AACvC,IAAA,MAAM,MAAA,GAAS,MAAM,IAAA,CAAK,MAAA,EAAO;AACjC,IAAA,IAAI,MAAA,CAAO,CAAC,CAAA,EAAG;AACb,MAAA,MAAM,SAAA,GAAY,MAAMC,2BAAA,CAAW,IAAA,CAAK,kBAAkB,CAAA;AAC1D,MAAA,MAAMC,uBAAiB,EAAE,IAAA,EAAM,QAAQ,UAAA,EAAY,MAAA,EAAQ,WAAW,CAAA;AAAA,IACxE;AAAA,EACF;AAAA,EAEQ,gBAAA,GAA2B;AAEjC,IAAA,MAAM,UAAA,GACJ,KAAK,MAAA,EAAQ,iBAAA;AAAA,MACX;AAAA,KACF,IACA,KAAK,MAAA,EAAQ,iBAAA;AAAA,MACX;AAAA,KACF;AACF,IAAA,IAAI,CAAC,UAAA,EAAY;AACf,MAAA,MAAM,IAAI,KAAA;AAAA,QACR,CAAA,+FAAA;AAAA,OACF;AAAA,IACF;AACA,IAAA,OAAO,UAAA;AAAA,EACT;AACF;;;;"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/plugin-scaffolder-backend-module-gcp",
-  "version": "0.2.24",
+  "version": "0.2.25-next.0",
   "description": "The GCP Bucket module for @backstage/plugin-scaffolder-backend",
   "backstage": {
     "role": "backend-plugin-module",
@@ -51,17 +51,18 @@
     "test": "backstage-cli package test"
   },
   "dependencies": {
-    "@backstage/backend-plugin-api": "^1.10.0",
-    "@backstage/config": "^1.3.8",
-    "@backstage/errors": "^1.3.1",
-    "@backstage/integration": "^2.1.0",
-    "@backstage/plugin-scaffolder-node": "^0.13.6",
+    "@backstage/backend-plugin-api": "1.10.0",
+    "@backstage/config": "1.3.8",
+    "@backstage/errors": "1.3.1",
+    "@backstage/integration": "2.1.0",
+    "@backstage/plugin-scaffolder-node": "0.13.7-next.0",
     "@google-cloud/storage": "^7.0.0",
     "raw-body": "^2.4.1"
   },
   "devDependencies": {
-    "@backstage/cli": "^0.36.5",
-    "@backstage/plugin-scaffolder-node-test-utils": "^0.3.14"
+    "@backstage/backend-test-utils": "1.11.6",
+    "@backstage/cli": "0.36.6-next.0",
+    "@backstage/plugin-scaffolder-node-test-utils": "0.3.15-next.0"
   },
   "configSchema": "config.schema.json"
 }