@backstage/plugin-scaffolder-backend 1.12.0-next.1 → 1.12.0

package/CHANGELOG.md

@@ -1,5 +1,54 @@
 # @backstage/plugin-scaffolder-backend
 
+## 1.12.0
+
+### Minor Changes
+
+- 7d724d8ef56: Added the ability to be able to define an actions `input` and `output` schema using `zod` instead of hand writing types and `jsonschema`
+
+### Patch Changes
+
+- 860de10fa67: Make identity valid if subject of token is a backstage server-2-server auth token
+- 65454876fb2: Minor API report tweaks
+- c6c78b4acbe: throw error from catalog:fetch scaffolder action when entity is null and optional is false
+- 9968f455921: catalog write action should allow any shape of object
+- 928a12a9b3e: Internal refactor of `/alpha` exports.
+- 52b0022dab7: Updated dependency `msw` to `^1.0.0`.
+- 7af12854970: Extended scaffolder action `catalog:fetch` to fetch multiple catalog entities by entity references.
+- Updated dependencies
+  - @backstage/plugin-catalog-backend@1.8.0
+  - @backstage/catalog-client@1.4.0
+  - @backstage/plugin-auth-node@0.2.12
+  - @backstage/backend-tasks@0.5.0
+  - @backstage/backend-common@0.18.3
+  - @backstage/errors@1.1.5
+  - @backstage/plugin-catalog-node@1.3.4
+  - @backstage/backend-plugin-api@0.5.0
+  - @backstage/catalog-model@1.2.1
+  - @backstage/integration@1.4.3
+  - @backstage/config@1.0.7
+  - @backstage/types@1.0.2
+  - @backstage/plugin-scaffolder-common@1.2.6
+  - @backstage/plugin-scaffolder-node@0.1.1
+
+## 1.12.0-next.2
+
+### Patch Changes
+
+- 860de10fa67: Make identity valid if subject of token is a backstage server-2-server auth token
+- 65454876fb2: Minor API report tweaks
+- 9968f455921: catalog write action should allow any shape of object
+- Updated dependencies
+  - @backstage/plugin-auth-node@0.2.12-next.2
+  - @backstage/backend-tasks@0.5.0-next.2
+  - @backstage/backend-common@0.18.3-next.2
+  - @backstage/backend-plugin-api@0.4.1-next.2
+  - @backstage/plugin-catalog-backend@1.8.0-next.2
+  - @backstage/plugin-catalog-node@1.3.4-next.2
+  - @backstage/plugin-scaffolder-node@0.1.1-next.2
+  - @backstage/config@1.0.7-next.0
+  - @backstage/integration@1.4.3-next.0
+
 ## 1.12.0-next.1
 
 ### Minor Changes

package/README.md

@@ -1,7 +1,7 @@
 # Scaffolder Backend
 
 This is the backend for the default Backstage [software
-templates](https://backstage.io/docs/features/software-templates/software-templates-index).
+templates](https://backstage.io/docs/features/software-templates/).
 This provides the API for the frontend [scaffolder
 plugin](https://github.com/backstage/backstage/tree/master/plugins/scaffolder),
 as well as the built-in template actions, tasks and stages.

package/alpha/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/plugin-scaffolder-backend",
-  "version": "1.12.0-next.1",
+  "version": "1.12.0",
   "main": "../dist/alpha.cjs.js",
   "types": "../dist/alpha.d.ts"
 }

package/dist/alpha.cjs.js

@@ -326,7 +326,7 @@ function createCatalogWriteAction() {
       input: zod.z.object({
         filePath: zod.z.string().optional().describe("Defaults to catalog-info.yaml"),
         // TODO: this should reference an zod entity validator if it existed.
-        entity: zod.z.object({}).describe(
+        entity: zod.z.object({}).passthrough().describe(
           "You can provide the same values used in the Entity schema."
         )
       })
@@ -361,17 +361,31 @@ const examples$1 = [
         }
       ]
     })
+  },
+  {
+    description: "Fetch multiple entities by referencse",
+    example: yaml__default["default"].stringify({
+      steps: [
+        {
+          action: id$1,
+          id: "fetchMultiple",
+          name: "Fetch catalog entities",
+          input: {
+            entityRefs: ["component:default/name"]
+          }
+        }
+      ]
+    })
   }
 ];
 function createFetchCatalogEntityAction(options) {
   const { catalogClient } = options;
   return pluginScaffolderNode.createTemplateAction({
     id: id$1,
-    description: "Returns entity from the catalog by entity reference",
+    description: "Returns entity or entities from the catalog by entity reference(s)",
     examples: examples$1,
     schema: {
       input: {
-        required: ["entityRef"],
         type: "object",
         properties: {
           entityRef: {
@@ -379,9 +393,14 @@ function createFetchCatalogEntityAction(options) {
             title: "Entity reference",
             description: "Entity reference of the entity to get"
           },
+          entityRefs: {
+            type: "array",
+            title: "Entity references",
+            description: "Entity references of the entities to get"
+          },
           optional: {
             title: "Optional",
-            description: "Permit the entity to optionally exist. Default: false",
+            description: "Allow the entity or entities to optionally exist. Default: false",
             type: "boolean"
           }
         }
@@ -392,28 +411,50 @@ function createFetchCatalogEntityAction(options) {
           entity: {
             title: "Entity found by the entity reference",
             type: "object",
-            description: "Object containing same values used in the Entity schema."
+            description: "Object containing same values used in the Entity schema. Only when used with `entityRef` parameter."
+          },
+          entities: {
+            title: "Entities found by the entity references",
+            type: "array",
+            items: { type: "object" },
+            description: "Array containing objects with same values used in the Entity schema. Only when used with `entityRefs` parameter."
           }
         }
       }
     },
     async handler(ctx) {
-      var _a;
-      const { entityRef, optional } = ctx.input;
-      let entity;
-      try {
-        entity = await catalogClient.getEntityByRef(entityRef, {
+      var _a, _b;
+      const { entityRef, entityRefs, optional } = ctx.input;
+      if (!entityRef && !entityRefs) {
+        if (optional) {
+          return;
+        }
+        throw new Error("Missing entity reference or references");
+      }
+      if (entityRef) {
+        const entity = await catalogClient.getEntityByRef(entityRef, {
           token: (_a = ctx.secrets) == null ? void 0 : _a.backstageToken
         });
-      } catch (e) {
-        if (!optional) {
-          throw e;
+        if (!entity && !optional) {
+          throw new Error(`Entity ${entityRef} not found`);
         }
+        ctx.output("entity", entity != null ? entity : null);
       }
-      if (!entity && !optional) {
-        throw new Error(`Entity ${entityRef} not found`);
+      if (entityRefs) {
+        const entities = await catalogClient.getEntitiesByRefs(
+          { entityRefs },
+          {
+            token: (_b = ctx.secrets) == null ? void 0 : _b.backstageToken
+          }
+        );
+        const finalEntities = entities.items.map((e, i) => {
+          if (!e && !optional) {
+            throw new Error(`Entity ${entityRefs[i]} not found`);
+          }
+          return e != null ? e : null;
+        });
+        ctx.output("entities", finalEntities);
       }
-      ctx.output("entity", entity != null ? entity : null);
     }
   });
 }
@@ -3528,11 +3569,12 @@ const defaultClientFactory = async ({
     ...{ throttle: { enabled: false } }
   });
 };
-const createPublishGithubPullRequestAction = ({
-  integrations,
-  githubCredentialsProvider,
-  clientFactory = defaultClientFactory
-}) => {
+const createPublishGithubPullRequestAction = (options) => {
+  const {
+    integrations,
+    githubCredentialsProvider,
+    clientFactory = defaultClientFactory
+  } = options;
   return pluginScaffolderNode.createTemplateAction({
     id: "publish:github:pull-request",
     schema: {
@@ -4428,7 +4470,8 @@ class DatabaseTaskStore {
     });
     return { events };
   }
-  async shutdownTask({ taskId }) {
+  async shutdownTask(options) {
+    const { taskId } = options;
     const message = `This task was marked as stale as it exceeded its timeout`;
     const statusStepEvents = (await this.listEvents({ taskId })).events.filter(
       ({ body }) => body == null ? void 0 : body.stepId
@@ -5233,13 +5276,12 @@ async function findTemplate(options) {
 function isSupportedTemplate(entity) {
   return entity.apiVersion === "scaffolder.backstage.io/v1beta3";
 }
-function buildDefaultIdentityClient({
-  logger
-}) {
+function buildDefaultIdentityClient(options) {
   return {
     getIdentity: async ({ request }) => {
       var _a;
       const header = request.headers.authorization;
+      const { logger } = options;
       if (!header) {
         return void 0;
       }
@@ -5259,6 +5301,9 @@ function buildDefaultIdentityClient({
         if (typeof sub !== "string") {
           throw new TypeError("Expected string sub claim");
         }
+        if (sub === "backstage-server") {
+          return void 0;
+        }
         catalogModel.parseEntityRef(sub);
         return {
           identity: {
@@ -5292,7 +5337,7 @@ async function createRouter(options) {
     additionalTemplateGlobals
   } = options;
   const logger = parentLogger.child({ plugin: "scaffolder" });
-  const identity = options.identity || buildDefaultIdentityClient({ logger });
+  const identity = options.identity || buildDefaultIdentityClient(options);
   const workingDirectory = await getWorkingDirectory(config, logger);
   const integrations = integration.ScmIntegrations.fromConfig(config);
   let taskBroker;