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

package/CHANGELOG.md

@@ -1,5 +1,40 @@
 # @backstage/plugin-scaffolder-backend
 
+## 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) => {
@@ -2834,6 +2871,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 +2887,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 +2921,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 +3059,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 +3142,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();
@@ -3682,6 +3752,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);