@red-hat-developer-hub/backstage-plugin-orchestrator-backend 8.0.6 → 8.1.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,11 @@
1
1
  ### Dependencies
2
2
 
3
+ ## 8.1.0
4
+
5
+ ### Minor Changes
6
+
7
+ - 1a519f8: removal of @backstage/backend-common
8
+
3
9
  ## 8.0.6
4
10
 
5
11
  ### Patch Changes
@@ -1,12 +1,10 @@
1
1
  'use strict';
2
2
 
3
- var backendCommon = require('@backstage/backend-common');
4
3
  var integration = require('@backstage/integration');
5
4
  var pluginScaffolderBackend = require('@backstage/plugin-scaffolder-backend');
6
5
  var fs = require('fs-extra');
7
6
  var crypto = require('crypto');
8
7
  var path = require('path');
9
- var stream = require('stream');
10
8
  var Helper = require('./Helper.cjs.js');
11
9
 
12
10
  function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
@@ -23,7 +21,6 @@ class ScaffolderService {
23
21
  this.actionRegistry = new pluginScaffolderBackend.TemplateActionRegistry();
24
22
  }
25
23
  actionRegistry;
26
- streamLogger = new stream.PassThrough();
27
24
  loadActions() {
28
25
  const actions = [
29
26
  ...pluginScaffolderBackend.createBuiltinActions({
@@ -66,10 +63,7 @@ class ScaffolderService {
66
63
  const actionContext = {
67
64
  input: actionExecutionContext.input,
68
65
  workspacePath,
69
- // TODO: Move this to LoggerService after scaffolder-node moves to LoggerService
70
- // https://github.com/backstage/backstage/issues/26933
71
- logger: backendCommon.loggerToWinstonLogger(this.logger),
72
- logStream: this.streamLogger,
66
+ logger: this.logger,
73
67
  createTemporaryDirectory: async () => await fs__default.default.mkdtemp(`${workspacePath}_step-${0}-`),
74
68
  output(name, value) {
75
69
  stepOutput[name] = value;
@@ -1 +1 @@
1
- {"version":3,"file":"ScaffolderService.cjs.js","sources":["../../src/service/ScaffolderService.ts"],"sourcesContent":["/*\n * Copyright Red Hat, Inc.\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 { loggerToWinstonLogger } from '@backstage/backend-common';\nimport type {\n LoggerService,\n UrlReaderService,\n} from '@backstage/backend-plugin-api';\nimport type { CatalogApi } from '@backstage/catalog-client';\nimport type { Config } from '@backstage/config';\nimport { ScmIntegrations } from '@backstage/integration';\nimport {\n createBuiltinActions,\n TemplateActionRegistry,\n} from '@backstage/plugin-scaffolder-backend';\nimport {\n ActionContext,\n TemplateAction,\n} from '@backstage/plugin-scaffolder-node';\nimport type { JsonObject, JsonValue } from '@backstage/types';\n\nimport fs from 'fs-extra';\n\nimport { randomUUID } from 'crypto';\nimport path from 'path';\nimport { PassThrough } from 'stream';\n\nimport { getWorkingDirectory } from './Helper';\n\nexport interface ActionExecutionContext {\n actionId: string;\n instanceId: string | undefined;\n input: JsonObject;\n}\n\nexport class ScaffolderService {\n private actionRegistry: TemplateActionRegistry;\n private streamLogger = new PassThrough();\n\n constructor(\n private readonly logger: LoggerService,\n private readonly config: Config,\n private readonly catalogApi: CatalogApi,\n private readonly urlReader: UrlReaderService,\n ) {\n this.actionRegistry = new TemplateActionRegistry();\n }\n\n public loadActions(): void {\n const actions = [\n ...createBuiltinActions({\n integrations: ScmIntegrations.fromConfig(this.config),\n catalogClient: this.catalogApi,\n reader: this.urlReader,\n config: this.config,\n }),\n ];\n actions.forEach(a => this.actionRegistry.register(a));\n }\n\n public getAction(id: string): TemplateAction {\n return this.actionRegistry.get(id);\n }\n\n public async executeAction(\n actionExecutionContext: ActionExecutionContext,\n ): Promise<JsonValue> {\n if (this.actionRegistry.list().length === 0) {\n this.loadActions();\n }\n\n const action: TemplateAction = this.getAction(\n actionExecutionContext.actionId,\n );\n const stepOutput: { [outputName: string]: JsonValue } = {};\n\n let workspacePath: string;\n try {\n const workingDirectory = await getWorkingDirectory(\n this.config,\n this.logger,\n );\n workspacePath = path.join(\n workingDirectory,\n actionExecutionContext.instanceId ?? randomUUID(),\n );\n } catch (err: unknown) {\n this.logger.error(\n `Error getting working directory to execute action ${actionExecutionContext.actionId}`,\n err as Error,\n );\n throw err;\n }\n const actionContext: ActionContext<JsonObject> = {\n input: actionExecutionContext.input,\n workspacePath: workspacePath,\n // TODO: Move this to LoggerService after scaffolder-node moves to LoggerService\n // https://github.com/backstage/backstage/issues/26933\n logger: loggerToWinstonLogger(this.logger),\n logStream: this.streamLogger,\n createTemporaryDirectory: async () =>\n await fs.mkdtemp(`${workspacePath}_step-${0}-`),\n output(name: string, value: JsonValue) {\n stepOutput[name] = value;\n },\n getInitiatorCredentials: async () => {\n return {\n $$type: '@backstage/BackstageCredentials',\n principal: 'mock-principal',\n };\n },\n checkpoint: async ({ key, fn }) => {\n this.logger.info(`Orchestrator ScaffolderService checkpoint ${key}`);\n return fn();\n },\n task: {\n id: 'task-orchestrator',\n },\n };\n await action.handler(actionContext);\n\n return stepOutput;\n }\n}\n"],"names":["TemplateActionRegistry","PassThrough","createBuiltinActions","ScmIntegrations","getWorkingDirectory","path","randomUUID","loggerToWinstonLogger","fs"],"mappings":";;;;;;;;;;;;;;;;AAgDO,MAAM,iBAAA,CAAkB;AAAA,EAI7B,WAAA,CACmB,MAAA,EACA,MAAA,EACA,UAAA,EACA,SAAA,EACjB;AAJiB,IAAA,IAAA,CAAA,MAAA,GAAA,MAAA;AACA,IAAA,IAAA,CAAA,MAAA,GAAA,MAAA;AACA,IAAA,IAAA,CAAA,UAAA,GAAA,UAAA;AACA,IAAA,IAAA,CAAA,SAAA,GAAA,SAAA;AAEjB,IAAA,IAAA,CAAK,cAAA,GAAiB,IAAIA,8CAAA,EAAuB;AAAA,EACnD;AAAA,EAVQ,cAAA;AAAA,EACA,YAAA,GAAe,IAAIC,kBAAA,EAAY;AAAA,EAWhC,WAAA,GAAoB;AACzB,IAAA,MAAM,OAAA,GAAU;AAAA,MACd,GAAGC,4CAAA,CAAqB;AAAA,QACtB,YAAA,EAAcC,2BAAA,CAAgB,UAAA,CAAW,IAAA,CAAK,MAAM,CAAA;AAAA,QACpD,eAAe,IAAA,CAAK,UAAA;AAAA,QACpB,QAAQ,IAAA,CAAK,SAAA;AAAA,QACb,QAAQ,IAAA,CAAK;AAAA,OACd;AAAA,KACH;AACA,IAAA,OAAA,CAAQ,QAAQ,CAAA,CAAA,KAAK,IAAA,CAAK,cAAA,CAAe,QAAA,CAAS,CAAC,CAAC,CAAA;AAAA,EACtD;AAAA,EAEO,UAAU,EAAA,EAA4B;AAC3C,IAAA,OAAO,IAAA,CAAK,cAAA,CAAe,GAAA,CAAI,EAAE,CAAA;AAAA,EACnC;AAAA,EAEA,MAAa,cACX,sBAAA,EACoB;AACpB,IAAA,IAAI,IAAA,CAAK,cAAA,CAAe,IAAA,EAAK,CAAE,WAAW,CAAA,EAAG;AAC3C,MAAA,IAAA,CAAK,WAAA,EAAY;AAAA,IACnB;AAEA,IAAA,MAAM,SAAyB,IAAA,CAAK,SAAA;AAAA,MAClC,sBAAA,CAAuB;AAAA,KACzB;AACA,IAAA,MAAM,aAAkD,EAAC;AAEzD,IAAA,IAAI,aAAA;AACJ,IAAA,IAAI;AACF,MAAA,MAAM,mBAAmB,MAAMC,0BAAA;AAAA,QAC7B,IAAA,CAAK,MAAA;AAAA,QACL,IAAA,CAAK;AAAA,OACP;AACA,MAAA,aAAA,GAAgBC,qBAAA,CAAK,IAAA;AAAA,QACnB,gBAAA;AAAA,QACA,sBAAA,CAAuB,cAAcC,iBAAA;AAAW,OAClD;AAAA,IACF,SAAS,GAAA,EAAc;AACrB,MAAA,IAAA,CAAK,MAAA,CAAO,KAAA;AAAA,QACV,CAAA,kDAAA,EAAqD,uBAAuB,QAAQ,CAAA,CAAA;AAAA,QACpF;AAAA,OACF;AACA,MAAA,MAAM,GAAA;AAAA,IACR;AACA,IAAA,MAAM,aAAA,GAA2C;AAAA,MAC/C,OAAO,sBAAA,CAAuB,KAAA;AAAA,MAC9B,aAAA;AAAA;AAAA;AAAA,MAGA,MAAA,EAAQC,mCAAA,CAAsB,IAAA,CAAK,MAAM,CAAA;AAAA,MACzC,WAAW,IAAA,CAAK,YAAA;AAAA,MAChB,wBAAA,EAA0B,YACxB,MAAMC,mBAAA,CAAG,QAAQ,CAAA,EAAG,aAAa,CAAA,MAAA,EAAS,CAAC,CAAA,CAAA,CAAG,CAAA;AAAA,MAChD,MAAA,CAAO,MAAc,KAAA,EAAkB;AACrC,QAAA,UAAA,CAAW,IAAI,CAAA,GAAI,KAAA;AAAA,MACrB,CAAA;AAAA,MACA,yBAAyB,YAAY;AACnC,QAAA,OAAO;AAAA,UACL,MAAA,EAAQ,iCAAA;AAAA,UACR,SAAA,EAAW;AAAA,SACb;AAAA,MACF,CAAA;AAAA,MACA,UAAA,EAAY,OAAO,EAAE,GAAA,EAAK,IAAG,KAAM;AACjC,QAAA,IAAA,CAAK,MAAA,CAAO,IAAA,CAAK,CAAA,0CAAA,EAA6C,GAAG,CAAA,CAAE,CAAA;AACnE,QAAA,OAAO,EAAA,EAAG;AAAA,MACZ,CAAA;AAAA,MACA,IAAA,EAAM;AAAA,QACJ,EAAA,EAAI;AAAA;AACN,KACF;AACA,IAAA,MAAM,MAAA,CAAO,QAAQ,aAAa,CAAA;AAElC,IAAA,OAAO,UAAA;AAAA,EACT;AACF;;;;"}
1
+ {"version":3,"file":"ScaffolderService.cjs.js","sources":["../../src/service/ScaffolderService.ts"],"sourcesContent":["/*\n * Copyright Red Hat, Inc.\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 type {\n LoggerService,\n UrlReaderService,\n} from '@backstage/backend-plugin-api';\nimport type { CatalogApi } from '@backstage/catalog-client';\nimport type { Config } from '@backstage/config';\nimport { ScmIntegrations } from '@backstage/integration';\nimport {\n createBuiltinActions,\n TemplateActionRegistry,\n} from '@backstage/plugin-scaffolder-backend';\nimport {\n ActionContext,\n TemplateAction,\n} from '@backstage/plugin-scaffolder-node';\nimport type { JsonObject, JsonValue } from '@backstage/types';\n\nimport fs from 'fs-extra';\n\nimport { randomUUID } from 'crypto';\nimport path from 'path';\n\nimport { getWorkingDirectory } from './Helper';\n\nexport interface ActionExecutionContext {\n actionId: string;\n instanceId: string | undefined;\n input: JsonObject;\n}\n\nexport class ScaffolderService {\n private actionRegistry: TemplateActionRegistry;\n\n constructor(\n private readonly logger: LoggerService,\n private readonly config: Config,\n private readonly catalogApi: CatalogApi,\n private readonly urlReader: UrlReaderService,\n ) {\n this.actionRegistry = new TemplateActionRegistry();\n }\n\n public loadActions(): void {\n const actions = [\n ...createBuiltinActions({\n integrations: ScmIntegrations.fromConfig(this.config),\n catalogClient: this.catalogApi,\n reader: this.urlReader,\n config: this.config,\n }),\n ];\n actions.forEach(a => this.actionRegistry.register(a));\n }\n\n public getAction(id: string): TemplateAction {\n return this.actionRegistry.get(id);\n }\n\n public async executeAction(\n actionExecutionContext: ActionExecutionContext,\n ): Promise<JsonValue> {\n if (this.actionRegistry.list().length === 0) {\n this.loadActions();\n }\n\n const action: TemplateAction = this.getAction(\n actionExecutionContext.actionId,\n );\n const stepOutput: { [outputName: string]: JsonValue } = {};\n\n let workspacePath: string;\n try {\n const workingDirectory = await getWorkingDirectory(\n this.config,\n this.logger,\n );\n workspacePath = path.join(\n workingDirectory,\n actionExecutionContext.instanceId ?? randomUUID(),\n );\n } catch (err: unknown) {\n this.logger.error(\n `Error getting working directory to execute action ${actionExecutionContext.actionId}`,\n err as Error,\n );\n throw err;\n }\n const actionContext: ActionContext<JsonObject> = {\n input: actionExecutionContext.input,\n workspacePath: workspacePath,\n logger: this.logger,\n createTemporaryDirectory: async () =>\n await fs.mkdtemp(`${workspacePath}_step-${0}-`),\n output(name: string, value: JsonValue) {\n stepOutput[name] = value;\n },\n getInitiatorCredentials: async () => {\n return {\n $$type: '@backstage/BackstageCredentials',\n principal: 'mock-principal',\n };\n },\n checkpoint: async ({ key, fn }) => {\n this.logger.info(`Orchestrator ScaffolderService checkpoint ${key}`);\n return fn();\n },\n task: {\n id: 'task-orchestrator',\n },\n };\n await action.handler(actionContext);\n\n return stepOutput;\n }\n}\n"],"names":["TemplateActionRegistry","createBuiltinActions","ScmIntegrations","getWorkingDirectory","path","randomUUID","fs"],"mappings":";;;;;;;;;;;;;;AA8CO,MAAM,iBAAA,CAAkB;AAAA,EAG7B,WAAA,CACmB,MAAA,EACA,MAAA,EACA,UAAA,EACA,SAAA,EACjB;AAJiB,IAAA,IAAA,CAAA,MAAA,GAAA,MAAA;AACA,IAAA,IAAA,CAAA,MAAA,GAAA,MAAA;AACA,IAAA,IAAA,CAAA,UAAA,GAAA,UAAA;AACA,IAAA,IAAA,CAAA,SAAA,GAAA,SAAA;AAEjB,IAAA,IAAA,CAAK,cAAA,GAAiB,IAAIA,8CAAA,EAAuB;AAAA,EACnD;AAAA,EATQ,cAAA;AAAA,EAWD,WAAA,GAAoB;AACzB,IAAA,MAAM,OAAA,GAAU;AAAA,MACd,GAAGC,4CAAA,CAAqB;AAAA,QACtB,YAAA,EAAcC,2BAAA,CAAgB,UAAA,CAAW,IAAA,CAAK,MAAM,CAAA;AAAA,QACpD,eAAe,IAAA,CAAK,UAAA;AAAA,QACpB,QAAQ,IAAA,CAAK,SAAA;AAAA,QACb,QAAQ,IAAA,CAAK;AAAA,OACd;AAAA,KACH;AACA,IAAA,OAAA,CAAQ,QAAQ,CAAA,CAAA,KAAK,IAAA,CAAK,cAAA,CAAe,QAAA,CAAS,CAAC,CAAC,CAAA;AAAA,EACtD;AAAA,EAEO,UAAU,EAAA,EAA4B;AAC3C,IAAA,OAAO,IAAA,CAAK,cAAA,CAAe,GAAA,CAAI,EAAE,CAAA;AAAA,EACnC;AAAA,EAEA,MAAa,cACX,sBAAA,EACoB;AACpB,IAAA,IAAI,IAAA,CAAK,cAAA,CAAe,IAAA,EAAK,CAAE,WAAW,CAAA,EAAG;AAC3C,MAAA,IAAA,CAAK,WAAA,EAAY;AAAA,IACnB;AAEA,IAAA,MAAM,SAAyB,IAAA,CAAK,SAAA;AAAA,MAClC,sBAAA,CAAuB;AAAA,KACzB;AACA,IAAA,MAAM,aAAkD,EAAC;AAEzD,IAAA,IAAI,aAAA;AACJ,IAAA,IAAI;AACF,MAAA,MAAM,mBAAmB,MAAMC,0BAAA;AAAA,QAC7B,IAAA,CAAK,MAAA;AAAA,QACL,IAAA,CAAK;AAAA,OACP;AACA,MAAA,aAAA,GAAgBC,qBAAA,CAAK,IAAA;AAAA,QACnB,gBAAA;AAAA,QACA,sBAAA,CAAuB,cAAcC,iBAAA;AAAW,OAClD;AAAA,IACF,SAAS,GAAA,EAAc;AACrB,MAAA,IAAA,CAAK,MAAA,CAAO,KAAA;AAAA,QACV,CAAA,kDAAA,EAAqD,uBAAuB,QAAQ,CAAA,CAAA;AAAA,QACpF;AAAA,OACF;AACA,MAAA,MAAM,GAAA;AAAA,IACR;AACA,IAAA,MAAM,aAAA,GAA2C;AAAA,MAC/C,OAAO,sBAAA,CAAuB,KAAA;AAAA,MAC9B,aAAA;AAAA,MACA,QAAQ,IAAA,CAAK,MAAA;AAAA,MACb,wBAAA,EAA0B,YACxB,MAAMC,mBAAA,CAAG,QAAQ,CAAA,EAAG,aAAa,CAAA,MAAA,EAAS,CAAC,CAAA,CAAA,CAAG,CAAA;AAAA,MAChD,MAAA,CAAO,MAAc,KAAA,EAAkB;AACrC,QAAA,UAAA,CAAW,IAAI,CAAA,GAAI,KAAA;AAAA,MACrB,CAAA;AAAA,MACA,yBAAyB,YAAY;AACnC,QAAA,OAAO;AAAA,UACL,MAAA,EAAQ,iCAAA;AAAA,UACR,SAAA,EAAW;AAAA,SACb;AAAA,MACF,CAAA;AAAA,MACA,UAAA,EAAY,OAAO,EAAE,GAAA,EAAK,IAAG,KAAM;AACjC,QAAA,IAAA,CAAK,MAAA,CAAO,IAAA,CAAK,CAAA,0CAAA,EAA6C,GAAG,CAAA,CAAE,CAAA;AACnE,QAAA,OAAO,EAAA,EAAG;AAAA,MACZ,CAAA;AAAA,MACA,IAAA,EAAM;AAAA,QACJ,EAAA,EAAI;AAAA;AACN,KACF;AACA,IAAA,MAAM,MAAA,CAAO,QAAQ,aAAa,CAAA;AAElC,IAAA,OAAO,UAAA;AAAA,EACT;AACF;;;;"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@red-hat-developer-hub/backstage-plugin-orchestrator-backend",
3
- "version": "8.0.6",
3
+ "version": "8.1.0",
4
4
  "license": "Apache-2.0",
5
5
  "main": "./dist/index.cjs.js",
6
6
  "types": "./dist/index.d.ts",
@@ -73,7 +73,6 @@
73
73
  "export-dynamic": "janus-cli package export-dynamic-plugin"
74
74
  },
75
75
  "dependencies": {
76
- "@backstage/backend-common": "^0.25.0",
77
76
  "@backstage/backend-defaults": "^0.10.0",
78
77
  "@backstage/backend-plugin-api": "^1.3.1",
79
78
  "@backstage/backend-tasks": "^0.6.1",
@@ -85,7 +84,7 @@
85
84
  "@backstage/plugin-permission-common": "^0.9.0",
86
85
  "@backstage/plugin-permission-node": "^0.10.0",
87
86
  "@backstage/plugin-scaffolder-backend": "^1.33.0",
88
- "@backstage/plugin-scaffolder-node": "^0.8.2",
87
+ "@backstage/plugin-scaffolder-node": "^0.9.0",
89
88
  "@red-hat-developer-hub/backstage-plugin-orchestrator-common": "^3.0.6",
90
89
  "@urql/core": "^4.1.4",
91
90
  "ajv-formats": "^2.1.1",