@backstage/plugin-scaffolder-backend-module-gcp 0.2.14-next.1 → 0.2.15-next.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CHANGELOG.md CHANGED
@@ -1,5 +1,28 @@
1
1
  # @backstage/plugin-scaffolder-backend-module-gcp
2
2
 
3
+ ## 0.2.15-next.0
4
+
5
+ ### Patch Changes
6
+
7
+ - 05f60e1: Refactored constructor parameter properties to explicit property declarations for compatibility with TypeScript's `erasableSyntaxOnly` setting. This internal refactoring maintains all existing functionality while ensuring TypeScript compilation compatibility.
8
+ - Updated dependencies
9
+ - @backstage/config@1.3.6-next.0
10
+ - @backstage/integration@1.18.2-next.0
11
+ - @backstage/plugin-scaffolder-node@0.12.1-next.0
12
+ - @backstage/backend-plugin-api@1.4.5-next.0
13
+ - @backstage/errors@1.2.7
14
+
15
+ ## 0.2.14
16
+
17
+ ### Patch Changes
18
+
19
+ - baf1cab: Fix documentation strings to mention GCP instead of Azure
20
+ - Updated dependencies
21
+ - @backstage/integration@1.18.1
22
+ - @backstage/plugin-scaffolder-node@0.12.0
23
+ - @backstage/config@1.3.5
24
+ - @backstage/backend-plugin-api@1.4.4
25
+
3
26
  ## 0.2.14-next.1
4
27
 
5
28
  ### Patch Changes
@@ -9,14 +9,17 @@ function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'defau
9
9
  var getRawBody__default = /*#__PURE__*/_interopDefaultCompat(getRawBody);
10
10
 
11
11
  class GcpBucketWorkspaceProvider {
12
+ storage;
13
+ logger;
14
+ config;
15
+ static create(logger, config) {
16
+ return new GcpBucketWorkspaceProvider(new storage.Storage(), logger, config);
17
+ }
12
18
  constructor(storage, logger, config) {
13
19
  this.storage = storage;
14
20
  this.logger = logger;
15
21
  this.config = config;
16
22
  }
17
- static create(logger, config) {
18
- return new GcpBucketWorkspaceProvider(new storage.Storage(), logger, config);
19
- }
20
23
  async cleanWorkspace(options) {
21
24
  const file = this.storage.bucket(this.getGcpBucketName()).file(options.taskId);
22
25
  const result = await file.exists();
@@ -1 +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 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"],"names":["Storage","serializeWorkspace","getRawBody","restoreWorkspace"],"mappings":";;;;;;;;;;AA4BO,MAAM,0BAAA,CAAwD;AAAA,EAK3D,WAAA,CACW,OAAA,EACA,MAAA,EACA,MAAA,EACjB;AAHiB,IAAA,IAAA,CAAA,OAAA,GAAA,OAAA;AACA,IAAA,IAAA,CAAA,MAAA,GAAA,MAAA;AACA,IAAA,IAAA,CAAA,MAAA,GAAA,MAAA;AAAA,EAChB;AAAA,EARH,OAAO,MAAA,CAAO,MAAA,EAAuB,MAAA,EAAiB;AACpD,IAAA,OAAO,IAAI,0BAAA,CAA2B,IAAIA,eAAA,EAAQ,EAAG,QAAQ,MAAM,CAAA;AAAA,EACrE;AAAA,EAQA,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;;;;"}
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;;;;"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@backstage/plugin-scaffolder-backend-module-gcp",
3
- "version": "0.2.14-next.1",
3
+ "version": "0.2.15-next.0",
4
4
  "description": "The GCP Bucket module for @backstage/plugin-scaffolder-backend",
5
5
  "backstage": {
6
6
  "role": "backend-plugin-module",
@@ -51,17 +51,17 @@
51
51
  "test": "backstage-cli package test"
52
52
  },
53
53
  "dependencies": {
54
- "@backstage/backend-plugin-api": "1.4.4-next.0",
55
- "@backstage/config": "1.3.4-next.0",
54
+ "@backstage/backend-plugin-api": "1.4.5-next.0",
55
+ "@backstage/config": "1.3.6-next.0",
56
56
  "@backstage/errors": "1.2.7",
57
- "@backstage/integration": "1.18.1-next.1",
58
- "@backstage/plugin-scaffolder-node": "0.12.0-next.1",
57
+ "@backstage/integration": "1.18.2-next.0",
58
+ "@backstage/plugin-scaffolder-node": "0.12.1-next.0",
59
59
  "@google-cloud/storage": "^7.0.0",
60
60
  "raw-body": "^2.4.1"
61
61
  },
62
62
  "devDependencies": {
63
- "@backstage/cli": "0.34.4-next.1",
64
- "@backstage/plugin-scaffolder-node-test-utils": "0.3.4-next.1"
63
+ "@backstage/cli": "0.34.5-next.0",
64
+ "@backstage/plugin-scaffolder-node-test-utils": "0.3.5-next.0"
65
65
  },
66
66
  "configSchema": "config.d.ts"
67
67
  }