@backstage/plugin-scaffolder-backend-module-gcp 0.1.0-next.2

package/CHANGELOG.md

@@ -0,0 +1,18 @@
+# @backstage/plugin-scaffolder-backend-module-gcp
+
+## 0.1.0-next.2
+
+### Minor Changes
+
+- 0b52438: Serialization of the scaffolder workspace into GCP bucket
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/backend-plugin-api@0.6.21-next.0
+  - @backstage/integration@1.13.0-next.0
+  - @backstage/plugin-scaffolder-node@0.4.7-next.0
+  - @backstage/config@1.2.0
+  - @backstage/errors@1.2.4
+
+## 0.0.1

package/README.md

@@ -0,0 +1,5 @@
+# @backstage/plugin-scaffolder-backend-module-gcp
+
+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_

package/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;
+  };
+}

package/dist/index.cjs.js

@@ -0,0 +1,88 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var backendPluginApi = require('@backstage/backend-plugin-api');
+var alpha = require('@backstage/plugin-scaffolder-node/alpha');
+var getRawBody = require('raw-body');
+var storage = require('@google-cloud/storage');
+
+function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
+
+var getRawBody__default = /*#__PURE__*/_interopDefaultCompat(getRawBody);
+
+class GcpBucketWorkspaceProvider {
+  constructor(storage, logger, config) {
+    this.storage = storage;
+    this.logger = logger;
+    this.config = config;
+  }
+  static create(logger, config) {
+    return new GcpBucketWorkspaceProvider(new storage.Storage(), logger, config);
+  }
+  async cleanWorkspace(options) {
+    const file = this.storage.bucket(this.getGcpBucketName()).file(options.taskId);
+    const result = await file.exists();
+    if (result[0]) {
+      await file.delete();
+    }
+  }
+  async serializeWorkspace(options) {
+    const fileCloud = this.storage.bucket(this.getGcpBucketName()).file(options.taskId);
+    const { contents: workspace } = await alpha.serializeWorkspace(options);
+    try {
+      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()}`
+      );
+    }
+    this.logger.info(
+      `Workspace for task ${options.taskId} has been serialized.`
+    );
+  }
+  async rehydrateWorkspace(options) {
+    const bucket = this.storage.bucket(this.getGcpBucketName());
+    const file = bucket.file(options.taskId);
+    const result = await file.exists();
+    if (result[0]) {
+      const workspace = await getRawBody__default.default(file.createReadStream());
+      await alpha.restoreWorkspace({ path: options.targetPath, buffer: workspace });
+    }
+  }
+  getGcpBucketName() {
+    const bucketName = this.config?.getOptionalString(
+      "scaffolder.EXPERIMENTAL_workspaceSerializationGcpBucketName"
+    );
+    if (!bucketName) {
+      throw new Error(
+        `You've missed to configure scaffolder.EXPERIMENTAL_workspaceSerializationGcpBucketName in app-config.yaml file`
+      );
+    }
+    return bucketName;
+  }
+}
+
+const gcpBucketModule = backendPluginApi.createBackendModule({
+  moduleId: "gcp",
+  pluginId: "scaffolder",
+  register({ registerInit }) {
+    registerInit({
+      deps: {
+        scaffolderWorkspaceProviders: alpha.scaffolderWorkspaceProviderExtensionPoint,
+        config: backendPluginApi.coreServices.rootConfig,
+        logger: backendPluginApi.coreServices.logger
+      },
+      async init({ config, logger, scaffolderWorkspaceProviders }) {
+        scaffolderWorkspaceProviders.addProviders({
+          gcpBucket: GcpBucketWorkspaceProvider.create(logger, config)
+        });
+      }
+    });
+  }
+});
+
+exports.default = gcpBucketModule;
+//# sourceMappingURL=index.cjs.js.map

package/dist/index.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.cjs.js","sources":["../src/providers/GcpBucketWorkspaceProvider.ts","../src/module.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  static create(logger: LoggerService, config?: Config) {\n    return new GcpBucketWorkspaceProvider(new Storage(), logger, config);\n  }\n\n  private constructor(\n    private readonly storage: Storage,\n    private readonly logger: LoggerService,\n    private readonly 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","/*\n * Copyright 2024 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 */\nimport {\n  coreServices,\n  createBackendModule,\n} from '@backstage/backend-plugin-api';\nimport { scaffolderWorkspaceProviderExtensionPoint } from '@backstage/plugin-scaffolder-node/alpha';\nimport { GcpBucketWorkspaceProvider } from './providers/GcpBucketWorkspaceProvider';\n\n/**\n * @public\n * The Azure Module for the Scaffolder Backend\n */\nexport const gcpBucketModule = createBackendModule({\n  moduleId: 'gcp',\n  pluginId: 'scaffolder',\n  register({ registerInit }) {\n    registerInit({\n      deps: {\n        scaffolderWorkspaceProviders: scaffolderWorkspaceProviderExtensionPoint,\n        config: coreServices.rootConfig,\n        logger: coreServices.logger,\n      },\n      async init({ config, logger, scaffolderWorkspaceProviders }) {\n        scaffolderWorkspaceProviders.addProviders({\n          gcpBucket: GcpBucketWorkspaceProvider.create(logger, config),\n        });\n      },\n    });\n  },\n});\n"],"names":["Storage","serializeWorkspace","getRawBody","restoreWorkspace","createBackendModule","scaffolderWorkspaceProviderExtensionPoint","coreServices"],"mappings":";;;;;;;;;;;;;AA4BO,MAAM,0BAAwD,CAAA;AAAA,EAK3D,WAAA,CACW,OACA,EAAA,MAAA,EACA,MACjB,EAAA;AAHiB,IAAA,IAAA,CAAA,OAAA,GAAA,OAAA,CAAA;AACA,IAAA,IAAA,CAAA,MAAA,GAAA,MAAA,CAAA;AACA,IAAA,IAAA,CAAA,MAAA,GAAA,MAAA,CAAA;AAAA,GAChB;AAAA,EARH,OAAO,MAAO,CAAA,MAAA,EAAuB,MAAiB,EAAA;AACpD,IAAA,OAAO,IAAI,0BAA2B,CAAA,IAAIA,eAAQ,EAAA,EAAG,QAAQ,MAAM,CAAA,CAAA;AAAA,GACrE;AAAA,EAQA,MAAa,eAAe,OAA4C,EAAA;AACtE,IAAM,MAAA,IAAA,GAAO,IAAK,CAAA,OAAA,CACf,MAAO,CAAA,IAAA,CAAK,kBAAkB,CAAA,CAC9B,IAAK,CAAA,OAAA,CAAQ,MAAM,CAAA,CAAA;AAEtB,IAAM,MAAA,MAAA,GAAS,MAAM,IAAA,CAAK,MAAO,EAAA,CAAA;AACjC,IAAI,IAAA,MAAA,CAAO,CAAC,CAAG,EAAA;AACb,MAAA,MAAM,KAAK,MAAO,EAAA,CAAA;AAAA,KACpB;AAAA,GACF;AAAA,EAEA,MAAa,mBAAmB,OAGd,EAAA;AAChB,IAAM,MAAA,SAAA,GAAY,IAAK,CAAA,OAAA,CACpB,MAAO,CAAA,IAAA,CAAK,kBAAkB,CAAA,CAC9B,IAAK,CAAA,OAAA,CAAQ,MAAM,CAAA,CAAA;AACtB,IAAA,MAAM,EAAE,QAAU,EAAA,SAAA,EAAc,GAAA,MAAMC,yBAAmB,OAAO,CAAA,CAAA;AAChE,IAAI,IAAA;AACF,MAAM,MAAA,SAAA,CAAU,KAAK,SAAW,EAAA;AAAA,QAC9B,WAAa,EAAA,mBAAA;AAAA,OACd,CAAA,CAAA;AAAA,aACM,GAAK,EAAA;AACZ,MAAA,IAAA,CAAK,MAAO,CAAA,KAAA;AAAA,QACV,4DACE,OAAQ,CAAA,MACV,CAAoB,iBAAA,EAAA,IAAA,CAAK,kBAAkB,CAAA,CAAA;AAAA,OAC7C,CAAA;AAAA,KACF;AACA,IAAA,IAAA,CAAK,MAAO,CAAA,IAAA;AAAA,MACV,CAAA,mBAAA,EAAsB,QAAQ,MAAM,CAAA,qBAAA,CAAA;AAAA,KACtC,CAAA;AAAA,GACF;AAAA,EAEA,MAAa,mBAAmB,OAGd,EAAA;AAChB,IAAA,MAAM,SAAS,IAAK,CAAA,OAAA,CAAQ,MAAO,CAAA,IAAA,CAAK,kBAAkB,CAAA,CAAA;AAC1D,IAAA,MAAM,IAAO,GAAA,MAAA,CAAO,IAAK,CAAA,OAAA,CAAQ,MAAM,CAAA,CAAA;AACvC,IAAM,MAAA,MAAA,GAAS,MAAM,IAAA,CAAK,MAAO,EAAA,CAAA;AACjC,IAAI,IAAA,MAAA,CAAO,CAAC,CAAG,EAAA;AACb,MAAA,MAAM,SAAY,GAAA,MAAMC,2BAAW,CAAA,IAAA,CAAK,kBAAkB,CAAA,CAAA;AAC1D,MAAA,MAAMC,uBAAiB,EAAE,IAAA,EAAM,QAAQ,UAAY,EAAA,MAAA,EAAQ,WAAW,CAAA,CAAA;AAAA,KACxE;AAAA,GACF;AAAA,EAEQ,gBAA2B,GAAA;AACjC,IAAM,MAAA,UAAA,GAAa,KAAK,MAAQ,EAAA,iBAAA;AAAA,MAC9B,6DAAA;AAAA,KACF,CAAA;AACA,IAAA,IAAI,CAAC,UAAY,EAAA;AACf,MAAA,MAAM,IAAI,KAAA;AAAA,QACR,CAAA,8GAAA,CAAA;AAAA,OACF,CAAA;AAAA,KACF;AACA,IAAO,OAAA,UAAA,CAAA;AAAA,GACT;AACF;;ACxEO,MAAM,kBAAkBC,oCAAoB,CAAA;AAAA,EACjD,QAAU,EAAA,KAAA;AAAA,EACV,QAAU,EAAA,YAAA;AAAA,EACV,QAAA,CAAS,EAAE,YAAA,EAAgB,EAAA;AACzB,IAAa,YAAA,CAAA;AAAA,MACX,IAAM,EAAA;AAAA,QACJ,4BAA8B,EAAAC,+CAAA;AAAA,QAC9B,QAAQC,6BAAa,CAAA,UAAA;AAAA,QACrB,QAAQA,6BAAa,CAAA,MAAA;AAAA,OACvB;AAAA,MACA,MAAM,IAAK,CAAA,EAAE,MAAQ,EAAA,MAAA,EAAQ,8BAAgC,EAAA;AAC3D,QAAA,4BAAA,CAA6B,YAAa,CAAA;AAAA,UACxC,SAAW,EAAA,0BAAA,CAA2B,MAAO,CAAA,MAAA,EAAQ,MAAM,CAAA;AAAA,SAC5D,CAAA,CAAA;AAAA,OACH;AAAA,KACD,CAAA,CAAA;AAAA,GACH;AACF,CAAC;;;;"}

package/dist/index.d.ts

@@ -0,0 +1,9 @@
+import * as _backstage_backend_plugin_api from '@backstage/backend-plugin-api';
+
+/**
+ * @public
+ * The Azure Module for the Scaffolder Backend
+ */
+declare const gcpBucketModule: _backstage_backend_plugin_api.BackendFeatureCompat;
+
+export { gcpBucketModule as default };

package/package.json

@@ -0,0 +1,56 @@
+{
+  "name": "@backstage/plugin-scaffolder-backend-module-gcp",
+  "version": "0.1.0-next.2",
+  "description": "The GCP Bucket module for @backstage/plugin-scaffolder-backend",
+  "backstage": {
+    "role": "backend-plugin-module",
+    "pluginId": "scaffolder",
+    "pluginPackage": "@backstage/plugin-scaffolder-backend"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/backstage/backstage",
+    "directory": "plugins/scaffolder-backend-module-gcp"
+  },
+  "license": "Apache-2.0",
+  "exports": {
+    ".": {
+      "require": "./dist/index.cjs.js",
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.cjs.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "main": "./dist/index.cjs.js",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist",
+    "config.d.ts"
+  ],
+  "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": "^0.6.21-next.0",
+    "@backstage/config": "^1.2.0",
+    "@backstage/errors": "^1.2.4",
+    "@backstage/integration": "^1.13.0-next.0",
+    "@backstage/plugin-scaffolder-node": "^0.4.7-next.0",
+    "@google-cloud/storage": "^7.0.0",
+    "raw-body": "^2.4.1"
+  },
+  "devDependencies": {
+    "@backstage/cli": "^0.26.10-next.0",
+    "@backstage/plugin-scaffolder-node-test-utils": "^0.1.8-next.0"
+  },
+  "configSchema": "config.d.ts"
+}