@backstage/plugin-scaffolder-backend 1.3.0-next.1 → 1.4.0-next.0

package/CHANGELOG.md

@@ -1,5 +1,101 @@
 # @backstage/plugin-scaffolder-backend
 
+## 1.4.0-next.0
+
+### Minor Changes
+
+- 3500c13a33: Added a new `/v2/dry-run` endpoint that allows for a synchronous dry run of a provided template. A `supportsDryRun` option has been added to `createTemplateAction`, which signals whether the action should be executed during dry runs. When enabled, the action context will have the new `isDryRun` property set to signal if the action is being executed during a dry run.
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/backend-common@0.14.1-next.0
+  - @backstage/catalog-model@1.1.0-next.0
+  - @backstage/integration@1.2.2-next.0
+  - @backstage/plugin-catalog-backend@1.2.1-next.0
+  - @backstage/catalog-client@1.0.4-next.0
+  - @backstage/plugin-scaffolder-common@1.1.2-next.0
+
+## 1.3.0
+
+### Minor Changes
+
+- 35a26131b3: **DEPRECATION**: The `projectid` input parameters to the `publish:gitlab:merge-request`, it's no longer required as it can be decoded from the `repoUrl` input parameter.
+  **DEPRECATION**: The `projectid` output of the action in favour of `projectPath`
+- 72dfcbc8bf: A new scaffolder action has been added: `gerrit:publish`
+- ce0d8d7eb1: Fixed a bug in `publish:github` action that didn't permit to add users as collaborators.
+  This fix required changing the way parameters are passed to the action.
+  In order to add a team as collaborator, now you must use the `team` field instead of `username`.
+  In order to add a user as collaborator, you must use the `user` field.
+
+  It's still possible to use the field `username` but is deprecated in favor of `team`.
+
+  ```yaml
+  - id: publish
+    name: Publish
+    action: publish:github
+    input:
+      repoUrl: ...
+      collaborators:
+        - access: ...
+          team: my_team
+        - access: ...
+          user: my_username
+  ```
+
+- 582003a059: - Added an optional `list` method on the `TaskBroker` and `TaskStore` interface to list tasks by an optional `userEntityRef`
+  - Implemented a `list` method on the `DatabaseTaskStore` class to list tasks by an optional `userEntityRef`
+  - Added a route under `/v2/tasks` to list tasks by a `userEntityRef` using the `createdBy` query parameter
+- c042c5eaff: Add an option to not protect the default branch.
+- f93af969cd: Added the ability to support running of templates that are not in the `default` namespace
+
+### Patch Changes
+
+- 8f7b1835df: Updated dependency `msw` to `^0.41.0`.
+- 6901f6be4a: Adds more of an explanation when the `publish:github` scaffolder action fails to create a repository.
+- Updated dependencies
+  - @backstage/plugin-catalog-backend@1.2.0
+  - @backstage/backend-common@0.14.0
+  - @backstage/integration@1.2.1
+  - @backstage/catalog-client@1.0.3
+  - @backstage/catalog-model@1.0.3
+  - @backstage/plugin-scaffolder-common@1.1.1
+
+## 1.3.0-next.2
+
+### Minor Changes
+
+- ce0d8d7eb1: Fixed a bug in `publish:github` action that didn't permit to add users as collaborators.
+  This fix required changing the way parameters are passed to the action.
+  In order to add a team as collaborator, now you must use the `team` field instead of `username`.
+  In order to add a user as collaborator, you must use the `user` field.
+
+  It's still possible to use the field `username` but is deprecated in favor of `team`.
+
+  ```yaml
+  - id: publish
+    name: Publish
+    action: publish:github
+    input:
+      repoUrl: ...
+      collaborators:
+        - access: ...
+          team: my_team
+        - access: ...
+          user: my_username
+  ```
+
+- 582003a059: - Added an optional `list` method on the `TaskBroker` and `TaskStore` interface to list tasks by an optional `userEntityRef`
+  - Implemented a `list` method on the `DatabaseTaskStore` class to list tasks by an optional `userEntityRef`
+  - Added a route under `/v2/tasks` to list tasks by a `userEntityRef` using the `createdBy` query parameter
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/backend-common@0.14.0-next.2
+  - @backstage/integration@1.2.1-next.2
+  - @backstage/plugin-catalog-backend@1.2.0-next.2
+
 ## 1.3.0-next.1
 
 ### Minor Changes

package/dist/index.cjs.js

@@ -1862,22 +1862,36 @@ function createPublishGithubAction(options) {
           },
           collaborators: {
             title: "Collaborators",
-            description: "Provide additional users with permissions",
+            description: "Provide additional users or teams with permissions",
             type: "array",
             items: {
               type: "object",
-              required: ["username", "access"],
+              additionalProperties: false,
+              required: ["access"],
               properties: {
                 access: {
                   type: "string",
                   description: "The type of access for the user",
                   enum: ["push", "pull", "admin", "maintain", "triage"]
                 },
+                user: {
+                  type: "string",
+                  description: "The name of the user that will be added as a collaborator"
+                },
                 username: {
                   type: "string",
-                  description: "The username or group"
+                  description: "Deprecated. Use the `team` or `user` field instead."
+                },
+                team: {
+                  type: "string",
+                  description: "The name of the team that will be added as a collaborator"
                 }
-              }
+              },
+              oneOf: [
+                { required: ["user"] },
+                { required: ["username"] },
+                { required: ["team"] }
+              ]
             }
           },
           token: {
@@ -1990,21 +2004,37 @@ function createPublishGithubAction(options) {
         });
       }
       if (collaborators) {
-        for (const {
-          access: permission,
-          username: team_slug
-        } of collaborators) {
+        for (const collaborator of collaborators) {
           try {
-            await client.rest.teams.addOrUpdateRepoPermissionsInOrg({
-              org: owner,
-              team_slug,
-              owner,
-              repo,
-              permission
-            });
+            if ("user" in collaborator) {
+              await client.rest.repos.addCollaborator({
+                owner,
+                repo,
+                username: collaborator.user,
+                permission: collaborator.access
+              });
+            } else if ("username" in collaborator) {
+              ctx.logger.warn("The field `username` is deprecated in favor of `team` and will be removed in the future.");
+              await client.rest.teams.addOrUpdateRepoPermissionsInOrg({
+                org: owner,
+                team_slug: collaborator.username,
+                owner,
+                repo,
+                permission: collaborator.access
+              });
+            } else if ("team" in collaborator) {
+              await client.rest.teams.addOrUpdateRepoPermissionsInOrg({
+                org: owner,
+                team_slug: collaborator.team,
+                owner,
+                repo,
+                permission: collaborator.access
+              });
+            }
           } catch (e) {
             errors.assertError(e);
-            ctx.logger.warn(`Skipping ${permission} access for ${team_slug}, ${e.message}`);
+            const name = extractCollaboratorName(collaborator);
+            ctx.logger.warn(`Skipping ${collaborator.access} access for ${name}, ${e.message}`);
           }
         }
       }
@@ -2059,6 +2089,13 @@ function createPublishGithubAction(options) {
     }
   });
 }
+function extractCollaboratorName(collaborator) {
+  if ("username" in collaborator)
+    return collaborator.username;
+  if ("user" in collaborator)
+    return collaborator.user;
+  return collaborator.team;
+}
 
 const DEFAULT_GLOB_PATTERNS = ["./**", "!.git"];
 const isExecutable = (fileMode) => {
@@ -2379,7 +2416,7 @@ const createPublishGitlabMergeRequestAction = (options) => {
     id: "publish:gitlab:merge-request",
     schema: {
       input: {
-        required: ["projectid", "repoUrl", "targetPath", "branchName"],
+        required: ["repoUrl", "targetPath", "branchName"],
         type: "object",
         properties: {
           repoUrl: {
@@ -2426,6 +2463,10 @@ const createPublishGitlabMergeRequestAction = (options) => {
             title: "Gitlab Project id/Name(slug)",
             type: "string"
           },
+          projectPath: {
+            title: "Gitlab Project path",
+            type: "string"
+          },
           mergeRequestURL: {
             title: "MergeRequest(MR) URL",
             type: "string",
@@ -2437,7 +2478,13 @@ const createPublishGitlabMergeRequestAction = (options) => {
     async handler(ctx) {
       var _a;
       const repoUrl = ctx.input.repoUrl;
-      const { host } = parseRepoUrl(repoUrl, integrations);
+      const { host, owner, repo } = parseRepoUrl(repoUrl, integrations);
+      const projectPath = `${owner}/${repo}`;
+      if (ctx.input.projectid) {
+        const deprecationWarning = `Property "projectid" is deprecated and no longer to needed to create a MR`;
+        ctx.logger.warn(deprecationWarning);
+        console.warn(deprecationWarning);
+      }
       const integrationConfig = integrations.gitlab.byHost(host);
       const destinationBranch = ctx.input.branchName;
       if (!integrationConfig) {
@@ -2463,23 +2510,24 @@ const createPublishGitlabMergeRequestAction = (options) => {
         content: file.content.toString("base64"),
         execute_filemode: file.executable
       }));
-      const projects = await api.Projects.show(ctx.input.projectid);
+      const projects = await api.Projects.show(projectPath);
       const { default_branch: defaultBranch } = projects;
       try {
-        await api.Branches.create(ctx.input.projectid, destinationBranch, String(defaultBranch));
+        await api.Branches.create(projectPath, destinationBranch, String(defaultBranch));
       } catch (e) {
         throw new errors.InputError(`The branch creation failed ${e}`);
       }
       try {
-        await api.Commits.create(ctx.input.projectid, destinationBranch, ctx.input.title, actions);
+        await api.Commits.create(projectPath, destinationBranch, ctx.input.title, actions);
       } catch (e) {
         throw new errors.InputError(`Committing the changes to ${destinationBranch} failed ${e}`);
       }
       try {
-        const mergeRequestUrl = await api.MergeRequests.create(ctx.input.projectid, destinationBranch, String(defaultBranch), ctx.input.title, { description: ctx.input.description }).then((mergeRequest) => {
+        const mergeRequestUrl = await api.MergeRequests.create(projectPath, destinationBranch, String(defaultBranch), ctx.input.title, { description: ctx.input.description }).then((mergeRequest) => {
           return mergeRequest.web_url;
         });
-        ctx.output("projectid", ctx.input.projectid);
+        ctx.output("projectid", projectPath);
+        ctx.output("projectPath", projectPath);
         ctx.output("mergeRequestUrl", mergeRequestUrl);
       } catch (e) {
         throw new errors.InputError(`Merge request creation failed${e}`);
@@ -2834,6 +2882,12 @@ class TemplateActionRegistry {
 }
 
 const migrationsDir = backendCommon.resolvePackagePath("@backstage/plugin-scaffolder-backend", "migrations");
+const parseSqlDateToIsoString = (input) => {
+  if (typeof input === "string") {
+    return luxon.DateTime.fromSQL(input, { zone: "UTC" }).toISO();
+  }
+  return input;
+};
 class DatabaseTaskStore {
   static async create(options) {
     await options.database.migrate.latest({
@@ -2844,6 +2898,27 @@ class DatabaseTaskStore {
   constructor(options) {
     this.db = options.database;
   }
+  async list(options) {
+    const queryBuilder = this.db("tasks");
+    if (options.createdBy) {
+      queryBuilder.where({
+        created_by: options.createdBy
+      });
+    }
+    const results = await queryBuilder.orderBy("created_at", "desc").select();
+    const tasks = results.map((result) => {
+      var _a;
+      return {
+        id: result.id,
+        spec: JSON.parse(result.spec),
+        status: result.status,
+        createdBy: (_a = result.created_by) != null ? _a : void 0,
+        lastHeartbeatAt: parseSqlDateToIsoString(result.last_heartbeat_at),
+        createdAt: parseSqlDateToIsoString(result.created_at)
+      };
+    });
+    return { tasks };
+  }
   async getTask(taskId) {
     var _a;
     const [result] = await this.db("tasks").where({ id: taskId }).select();
@@ -2857,8 +2932,8 @@ class DatabaseTaskStore {
         id: result.id,
         spec,
         status: result.status,
-        lastHeartbeatAt: result.last_heartbeat_at,
-        createdAt: result.created_at,
+        lastHeartbeatAt: parseSqlDateToIsoString(result.last_heartbeat_at),
+        createdAt: parseSqlDateToIsoString(result.created_at),
         createdBy: (_a = result.created_by) != null ? _a : void 0,
         secrets
       };
@@ -2995,7 +3070,7 @@ class DatabaseTaskStore {
           taskId,
           body,
           type: event.event_type,
-          createdAt: typeof event.created_at === "string" ? luxon.DateTime.fromSQL(event.created_at, { zone: "UTC" }).toISO() : event.created_at
+          createdAt: parseSqlDateToIsoString(event.created_at)
         };
       } catch (error) {
         throw new Error(`Failed to parse event body from event taskId=${taskId} id=${event.id}, ${error}`);
@@ -3078,6 +3153,12 @@ class StorageTaskBroker {
     this.logger = logger;
     this.deferredDispatch = defer();
   }
+  async list(options) {
+    if (!this.storage.list) {
+      throw new Error("TaskStore does not implement the list method. Please implement the list method to be able to list tasks");
+    }
+    return await this.storage.list({ createdBy: options == null ? void 0 : options.createdBy });
+  }
   async claim() {
     for (; ; ) {
       const pendingTask = await this.storage.claimTask();
@@ -3520,9 +3601,6 @@ function getEntityBaseUrl(entity) {
 }
 async function findTemplate(options) {
   const { entityRef, token, catalogApi } = options;
-  if (entityRef.namespace.toLocaleLowerCase("en-US") !== catalogModel.DEFAULT_NAMESPACE) {
-    throw new errors.InputError(`Invalid namespace, only '${catalogModel.DEFAULT_NAMESPACE}' namespace is supported`);
-  }
   if (entityRef.kind.toLocaleLowerCase("en-US") !== "template") {
     throw new errors.InputError(`Invalid kind, only 'Template' kind is supported`);
   }
@@ -3682,6 +3760,18 @@ async function createRouter(options) {
       }
     });
     res.status(201).json({ id: result.taskId });
+  }).get("/v2/tasks", async (req, res) => {
+    const [userEntityRef] = [req.query.createdBy].flat();
+    if (typeof userEntityRef !== "string" && typeof userEntityRef !== "undefined") {
+      throw new errors.InputError("createdBy query parameter must be a string");
+    }
+    if (!taskBroker.list) {
+      throw new Error("TaskBroker does not support listing tasks, please implement the list method on the TaskBroker.");
+    }
+    const tasks = await taskBroker.list({
+      createdBy: userEntityRef
+    });
+    res.status(200).json(tasks);
   }).get("/v2/tasks/:taskId", async (req, res) => {
     const { taskId } = req.params;
     const task = await taskBroker.get(taskId);