@backstage/plugin-scaffolder-backend 0.15.24 → 0.16.0

package/CHANGELOG.md

@@ -1,5 +1,39 @@
 # @backstage/plugin-scaffolder-backend
 
+## 0.16.0
+
+### Minor Changes
+
+- 661594bf43: **BREAKING**: Updated `TemplateAction` and related types to have its type parameter extend `JsonObject` instead of `InputBase`. The `createTemplateAction` has also been updated to pass through the `TInput` type parameter to the return type, meaning the `TemplateAction` retains its type. This can lead to breakages during type checking especially within tests.
+- 8db2b671c6: **BREAKING**: `ctx.token` is now `ctx.secrets.backstageToken` in Actions. Please update any of your Actions that might call out to Backstage API's with this token.
+- 5a1594330e: **BREAKING** - Removed the `CatalogEntityClient` export. This is no longer provider by this package,
+  but you can implement one pretty simply yourself using the `CatalogApi` and applying filters to fetch templates.
+- 7d3471db94: Remove the previously deprecated `scaffolder.provider` config for all providers.
+  This config is no longer used anywhere, and adopters should use [`integrations` config](https://backstage.io/docs/integrations) instead.
+
+### Patch Changes
+
+- 1ed305728b: Bump `node-fetch` to version 2.6.7 and `cross-fetch` to version 3.1.5
+- 3e59f90b51: Fix error handling of the `runCommand` helper to return `Error`
+  instance.
+- c77c5c7eb6: Added `backstage.role` to `package.json`
+- 216725b434: Updated to use new names for `parseLocationRef` and `stringifyLocationRef`
+- e72d371296: Use `TemplateEntityV1beta2` from `@backstage/plugin-scaffolder-common` instead
+  of `@backstage/catalog-model`.
+- 1433045c08: Removed unused `helmet` dependency.
+- 27eccab216: Replaces use of deprecated catalog-model constants.
+- Updated dependencies
+  - @backstage/plugin-scaffolder-common@0.2.0
+  - @backstage/plugin-catalog-backend@0.21.4
+  - @backstage/backend-common@0.10.8
+  - @backstage/catalog-client@0.7.0
+  - @backstage/errors@0.2.1
+  - @backstage/integration@0.7.3
+  - @backstage/catalog-model@0.10.0
+  - @backstage/config@0.1.14
+  - @backstage/types@0.1.2
+  - @backstage/plugin-scaffolder-backend-module-cookiecutter@0.2.0
+
 ## 0.15.24
 
 ### Patch Changes

package/config.d.ts

@@ -28,30 +28,5 @@ export interface Config {
      * The commit message used when new components are created.
      */
     defaultCommitMessage?: string;
-    /**
-     * @deprecated Replaced by parameters for the publish:github action
-     */
-    github?: {
-      [key: string]: string;
-    };
-    /**
-     * @deprecated Use the Gitlab integration instead
-     */
-    gitlab?: {
-      api: { [key: string]: string };
-    };
-    /**
-     * @deprecated Use the Azure integration instead
-     */
-    azure?: {
-      baseUrl: string;
-      api: { [key: string]: string };
-    };
-    /**
-     * @deprecated Use the Bitbucket integration instead
-     */
-    bitbucket?: {
-      api: { [key: string]: string };
-    };
   };
 }

package/dist/index.cjs.js

@@ -685,7 +685,7 @@ const runCommand = async ({
     });
     process.on("close", (code) => {
       if (code !== 0) {
-        return reject(`Command ${command} failed, exit code: ${code}`);
+        return reject(new Error(`Command ${command} failed, exit code: ${code}`));
       }
       return resolve();
     });
@@ -2414,7 +2414,7 @@ class HandlebarsWorkflowRunner {
     this.handlebars.registerHelper("eq", (a, b) => a === b);
   }
   async execute(task) {
-    var _a, _b, _c;
+    var _a, _b;
     if (!isValidTaskSpec$1(task.spec)) {
       throw new errors.InputError(`Task spec is not a valid v1beta2 task spec`);
     }
@@ -2517,8 +2517,7 @@ class HandlebarsWorkflowRunner {
             logger: taskLogger,
             logStream: stream$1,
             input,
-            token: (_b = task.secrets) == null ? void 0 : _b.token,
-            secrets: (_c = task.secrets) != null ? _c : {},
+            secrets: (_b = task.secrets) != null ? _b : {},
             workspacePath,
             async createTemporaryDirectory() {
               const tmpDir = await fs__default["default"].mkdtemp(`${workspacePath}_step-${step.id}-`);
@@ -2644,7 +2643,7 @@ class NunjucksWorkflowRunner {
     });
   }
   async execute(task) {
-    var _a, _b, _c, _d, _e;
+    var _a, _b, _c, _d;
     if (!isValidTaskSpec(task.spec)) {
       throw new errors.InputError("Wrong template version executed with the workflow engine");
     }
@@ -2688,14 +2687,10 @@ class NunjucksWorkflowRunner {
           }
           const tmpDirs = new Array();
           const stepOutput = {};
-          if (!task.spec.metadata) {
-            console.warn("DEPRECATION NOTICE: metadata is undefined. metadata will be required in the future.");
-          }
           await action.handler({
             baseUrl: task.spec.baseUrl,
             input,
-            token: (_d = task.secrets) == null ? void 0 : _d.token,
-            secrets: (_e = task.secrets) != null ? _e : {},
+            secrets: (_d = task.secrets) != null ? _d : {},
             logger: taskLogger,
             logStream: streamLogger,
             workspacePath,
@@ -2787,28 +2782,6 @@ class TaskWorker {
   }
 }
 
-class CatalogEntityClient {
-  constructor(catalogClient) {
-    this.catalogClient = catalogClient;
-  }
-  async findTemplate(templateName, options) {
-    const { items: templates } = await this.catalogClient.getEntities({
-      filter: {
-        kind: "template",
-        "metadata.name": templateName
-      }
-    }, options);
-    if (templates.length !== 1) {
-      if (templates.length > 1) {
-        throw new errors.ConflictError("Templates lookup resulted in multiple matches");
-      } else {
-        throw new errors.NotFoundError("Template not found");
-      }
-    }
-    return templates[0];
-  }
-}
-
 async function getWorkingDirectory(config, logger) {
   if (!config.has("backend.workingDirectory")) {
     return os__default["default"].tmpdir();
@@ -2826,14 +2799,14 @@ async function getWorkingDirectory(config, logger) {
 }
 function getEntityBaseUrl(entity) {
   var _a, _b;
-  let location = (_a = entity.metadata.annotations) == null ? void 0 : _a[catalogModel.SOURCE_LOCATION_ANNOTATION];
+  let location = (_a = entity.metadata.annotations) == null ? void 0 : _a[catalogModel.ANNOTATION_SOURCE_LOCATION];
   if (!location) {
-    location = (_b = entity.metadata.annotations) == null ? void 0 : _b[catalogModel.LOCATION_ANNOTATION];
+    location = (_b = entity.metadata.annotations) == null ? void 0 : _b[catalogModel.ANNOTATION_LOCATION];
   }
   if (!location) {
     return void 0;
   }
-  const { type, target } = catalogModel.parseLocationReference(location);
+  const { type, target } = catalogModel.parseLocationRef(location);
   if (type === "url") {
     return target;
   } else if (type === "file") {
@@ -2841,6 +2814,34 @@ function getEntityBaseUrl(entity) {
   }
   return void 0;
 }
+async function findTemplate({
+  entityRef,
+  token,
+  catalogApi
+}) {
+  const parsedEntityRef = catalogModel.parseEntityRef(entityRef, {
+    defaultKind: "template",
+    defaultNamespace: "default"
+  });
+  const { items } = await catalogApi.getEntities({
+    filter: {
+      kind: "template",
+      "metadata.name": parsedEntityRef.name,
+      "metadata.namespace": parsedEntityRef.namespace
+    }
+  }, {
+    token
+  });
+  const templates = items.filter((entity) => entity.kind === "Template");
+  if (templates.length !== 1) {
+    if (templates.length > 1) {
+      throw new errors.ConflictError("Templates lookup resulted in multiple matches");
+    } else {
+      throw new errors.NotFoundError("Template not found");
+    }
+  }
+  return templates[0];
+}
 
 function isSupportedTemplate(entity) {
   return entity.apiVersion === "backstage.io/v1beta2" || entity.apiVersion === "scaffolder.backstage.io/v1beta3";
@@ -2861,7 +2862,6 @@ async function createRouter(options) {
   } = options;
   const logger = parentLogger.child({ plugin: "scaffolder" });
   const workingDirectory = await getWorkingDirectory(config, logger);
-  const entityClient = new CatalogEntityClient(catalogClient);
   const integrations = integration.ScmIntegrations.fromConfig(config);
   let taskBroker;
   if (!options.taskBroker) {
@@ -2904,7 +2904,9 @@ async function createRouter(options) {
     if (kind.toLowerCase() !== "template") {
       throw new errors.InputError(`Invalid kind, only 'Template' kind is supported`);
     }
-    const template = await entityClient.findTemplate(name, {
+    const template = await findTemplate({
+      catalogApi: catalogClient,
+      entityRef: { kind, namespace, name },
       token: getBearerToken(req.headers.authorization)
     });
     if (isSupportedTemplate(template)) {
@@ -2936,11 +2938,18 @@ async function createRouter(options) {
     const templateName = req.body.templateName;
     const values = req.body.values;
     const token = getBearerToken(req.headers.authorization);
-    const template = await entityClient.findTemplate(templateName, {
-      token
+    const template = await findTemplate({
+      catalogApi: catalogClient,
+      entityRef: {
+        name: templateName
+      },
+      token: getBearerToken(req.headers.authorization)
     });
     let taskSpec;
     if (isSupportedTemplate(template)) {
+      if (template.apiVersion === "backstage.io/v1beta2") {
+        logger.warn(`Scaffolding ${catalogModel.stringifyEntityRef(template)} with deprecated apiVersion ${template.apiVersion}. Please migrate the template to backstage.io/v1beta3. https://backstage.io/docs/features/software-templates/migrating-from-v1beta2-to-v1beta3`);
+      }
       for (const parameters of [(_a = template.spec.parameters) != null ? _a : []].flat()) {
         const result2 = jsonschema.validate(values, parameters);
         if (!result2.valid) {
@@ -3061,13 +3070,11 @@ function getBearerToken(header) {
 
 class ScaffolderEntitiesProcessor {
   constructor() {
-    this.validators = [
-      catalogModel.entityKindSchemaValidator(pluginScaffolderCommon.templateEntityV1beta3Schema)
-    ];
+    this.validators = [pluginScaffolderCommon.templateEntityV1beta3Validator];
   }
   async validateEntityKind(entity) {
     for (const validator of this.validators) {
-      if (validator(entity)) {
+      if (await validator.check(entity)) {
         return true;
       }
     }
@@ -3111,7 +3118,6 @@ Object.defineProperty(exports, 'createFetchCookiecutterAction', {
   enumerable: true,
   get: function () { return pluginScaffolderBackendModuleCookiecutter.createFetchCookiecutterAction; }
 });
-exports.CatalogEntityClient = CatalogEntityClient;
 exports.DatabaseTaskStore = DatabaseTaskStore;
 exports.OctokitProvider = OctokitProvider;
 exports.ScaffolderEntitiesProcessor = ScaffolderEntitiesProcessor;