Max assignments

README.md

@@ -38,7 +38,10 @@ To configure your Ubiquibot to run this plugin, add the following to the `.ubiqu
   with:
     reviewDelayTolerance: "3 Days"
     taskStaleTimeoutDuration: "30 Days"
-    maxConcurrentTasks: 3
+    maxConcurrentTasks: # Default concurrent task limits per role.
+      admin: 10
+      member: 5
+      contributor: 3
     startRequiresWallet: true # default is true
     emptyWalletText: "Please set your wallet address with the /wallet command first and try again."
 ```

src/handlers/shared/get-user-task-limit-and-role.ts

@@ -0,0 +1,33 @@
+import { Context } from "../../types";
+
+interface MatchingUserProps {
+  role: string;
+  limit: number;
+}
+
+export async function getUserRoleAndTaskLimit(context: Context, user: string): Promise<MatchingUserProps> {
+  const orgLogin = context.payload.organization?.login;
+  const { config, logger } = context;
+  const { maxConcurrentTasks } = config;
+
+  const smallestTask = Object.entries(maxConcurrentTasks).reduce(
+    (minTask, [role, limit]) => (limit < minTask.limit ? { role, limit } : minTask),
+    { role: "", limit: Infinity } as MatchingUserProps
+  );
+
+  try {
+    const response = await context.octokit.orgs.getMembershipForUser({
+      org: orgLogin as string,
+      username: user,
+    });
+
+    const role = response.data.role.toLowerCase()
+    const limit = maxConcurrentTasks[role];
+
+   return limit ? { role, limit } : smallestTask;
+
+  } catch (err) {
+    logger.error("Could not get user role", { err });
+    return smallestTask;
+  }
+}

src/handlers/shared/start.ts

@@ -1,15 +1,16 @@
 import { Context, ISSUE_TYPE, Label } from "../../types";
-import { addAssignees, addCommentToIssue, getAssignedIssues, getAvailableOpenedPullRequests, getTimeValue, isParentIssue } from "../../utils/issue";
-import { HttpStatusCode, Result } from "../result-types";
-import { hasUserBeenUnassigned } from "./check-assignments";
+import { isParentIssue, getAvailableOpenedPullRequests, getAssignedIssues, addAssignees, addCommentToIssue, getTimeValue } from "../../utils/issue";
 import { checkTaskStale } from "./check-task-stale";
+import { hasUserBeenUnassigned } from "./check-assignments";
+import { getUserRoleAndTaskLimit } from "./get-user-task-limit-and-role";
+import { HttpStatusCode, Result } from "../result-types";
 import { generateAssignmentComment, getDeadline } from "./generate-assignment-comment";
 import structuredMetadata from "./structured-metadata";
 import { assignTableComment } from "./table";
 
 export async function start(context: Context, issue: Context["payload"]["issue"], sender: Context["payload"]["sender"], teammates: string[]): Promise<Result> {
   const { logger, config } = context;
-  const { maxConcurrentTasks, taskStaleTimeoutDuration } = config;
+  const { taskStaleTimeoutDuration } = config;
 
   // is it a child issue?
   if (issue.body && isParentIssue(issue.body)) {
@@ -57,7 +58,7 @@ export async function start(context: Context, issue: Context["payload"]["issue"]
   const toAssign = [];
   // check max assigned issues
   for (const user of teammates) {
-    if (await handleTaskLimitChecks(user, context, maxConcurrentTasks, logger, sender.login)) {
+    if (await handleTaskLimitChecks(user, context, logger, sender.login)) {
       toAssign.push(user);
     }
   }
@@ -134,19 +135,26 @@ async function fetchUserIds(context: Context, username: string[]) {
   return ids;
 }
 
-async function handleTaskLimitChecks(username: string, context: Context, maxConcurrentTasks: number, logger: Context["logger"], sender: string) {
+async function handleTaskLimitChecks(username: string, context: Context, logger: Context["logger"], sender: string) {
   const openedPullRequests = await getAvailableOpenedPullRequests(context, username);
   const assignedIssues = await getAssignedIssues(context, username);
+  const { limit } = await getUserRoleAndTaskLimit(context, username);
 
   // check for max and enforce max
+  if (Math.abs(assignedIssues.length - openedPullRequests.length) >= limit) {
+    if (username !== sender) {
+      const logMessage = `${username} has reached their max task limit`;
+      const log = logger.error(logMessage, {
+        assignedIssues: assignedIssues.length,
+        openedPullRequests: openedPullRequests.length,
+        limit,
+      });
+
+      if (log.logMessage?.diff) {
+        await addCommentToIssue(context, log.logMessage.diff as string);
+      }
+    }
 
-  if (Math.abs(assignedIssues.length - openedPullRequests.length) >= maxConcurrentTasks) {
-    const log = logger.error(username === sender ? "You have reached your max task limit" : `${username} has reached their max task limit`, {
-      assignedIssues: assignedIssues.length,
-      openedPullRequests: openedPullRequests.length,
-      maxConcurrentTasks,
-    });
-    await addCommentToIssue(context, log?.logMessage.diff as string);
     return false;
   }
 

src/plugin.ts

@@ -45,5 +45,8 @@ export async function startStopTask(inputs: PluginInputs, env: Env) {
 }
 
 function sanitizeMetadata(obj: LogReturn["metadata"]): string {
-  return JSON.stringify(obj, null, 2).replace(/</g, "&lt;").replace(/>/g, "&gt;").replace(/--/g, "&#45;&#45;");
+  return JSON.stringify(obj, null, 2)
+    .replace(/</g, "&lt;")
+    .replace(/>/g, "&gt;")
+    .replace(/--/g, "&#45;&#45;")
 }

src/types/payload.ts

@@ -7,6 +7,7 @@ export type TimelineEventResponse = RestEndpointMethodTypes["issues"]["listEvent
 export type TimelineEvents = RestEndpointMethodTypes["issues"]["listEventsForTimeline"]["response"]["data"][0];
 export type Assignee = Issue["assignee"];
 export type GitHubIssueSearch = RestEndpointMethodTypes["search"]["issuesAndPullRequests"]["response"]["data"];
+
 export type Sender = { login: string; id: number };
 
 export const ISSUE_TYPE = {

src/types/plugin-input.ts

@@ -15,14 +15,14 @@ export const startStopSchema = T.Object(
   {
     reviewDelayTolerance: T.String({ default: "1 Day" }),
     taskStaleTimeoutDuration: T.String({ default: "30 Days" }),
-    maxConcurrentTasks: T.Number({ default: 3 }),
     startRequiresWallet: T.Boolean({ default: true }),
+    maxConcurrentTasks: T.Record(T.String(), T.Integer(), { default: { admin: 20, member: 10, contributor: 2 } }),
     emptyWalletText: T.String({ default: "Please set your wallet address with the /wallet command first and try again." }),
   },
   {
-    default: {},
+    default: {}
   }
 );
 
 export type StartStopSettings = StaticDecode<typeof startStopSchema>;
-export const startStopSettingsValidator = new StandardValidator(startStopSchema);
+export const startStopSettingsValidator = new StandardValidator(startStopSchema);

src/utils/issue.ts

@@ -8,18 +8,31 @@ export function isParentIssue(body: string) {
   return body.match(parentPattern);
 }
 
-export async function getAssignedIssues(context: Context, username: string): Promise<Issue[]> {
-  const { payload } = context;
+export async function getAssignedIssues(context: Context, username: string): Promise<GitHubIssueSearch["items"]> {
+  const payload = context.payload;
 
   try {
-    return (await context.octokit.paginate(context.octokit.rest.search.issuesAndPullRequests, {
-      q: `is:issue is:open assignee:${username} org:${payload.repository.owner.login}`,
-    })) as Issue[];
+    return await context.octokit
+      .paginate(context.octokit.search.issuesAndPullRequests, {
+        q: `org:${payload.repository.owner.login} assignee:${username} is:open is:issue`,
+        per_page: 100,
+        order: "desc",
+        sort: "created",
+      })
+      .then((issues) =>
+        issues.filter((issue) => {
+          return (
+            issue.state === "open" &&
+            (issue.assignee?.login === username || issue.assignees?.some((assignee) => assignee.login === username))
+          );
+        })
+      );
   } catch (err: unknown) {
     throw new Error(context.logger.error("Fetching assigned issues failed!", { error: err as Error }).logMessage.raw);
   }
 }
 
+
 export async function addCommentToIssue(context: Context, message: string | null) {
   const { payload, logger } = context;
   if (!message) {

tests/__mocks__/db.ts

@@ -7,6 +7,7 @@ export const db = factory({
   users: {
     id: primaryKey(Number),
     login: String,
+    role: String,
   },
   issue: {
     id: primaryKey(Number),

tests/__mocks__/handlers.ts

@@ -14,6 +14,15 @@ export const handlers = [
     }
     return HttpResponse.json(item);
   }),
+  //get member
+  http.get("https://api.github.com/orgs/:org/memberships/:username", ({ params: { username } }) => {
+    const user = db.users.findFirst({ where: { login: { equals: username as string } } });
+    if (user) {
+      return HttpResponse.json({ role: user.role });
+    } else {
+      return HttpResponse.json({ role: "collaborator" });
+    }
+  }),
   // get issue
   http.get("https://api.github.com/repos/:owner/:repo/issues", ({ params: { owner, repo } }: { params: { owner: string; repo: string } }) =>
     HttpResponse.json(db.issue.findMany({ where: { owner: { equals: owner }, repo: { equals: repo } } }))
@@ -34,15 +43,13 @@ export const handlers = [
     HttpResponse.json({ owner, repo, issueNumber })
   ),
   // get commit
-  http.get("https://api.github.com/repos/:owner/:repo/commits/:ref", () => {
-    const res = {
+  http.get("https://api.github.com/repos/:owner/:repo/commits/:ref", () =>
+    HttpResponse.json({
       data: {
         sha: "commitHash",
       },
-    };
-
-    return HttpResponse.json(res);
-  }),
+    })
+  ),
   // list pull requests
   http.get("https://api.github.com/repos/:owner/:repo/pulls", ({ params: { owner, repo } }: { params: { owner: string; repo: string } }) =>
     HttpResponse.json(db.pull.findMany({ where: { owner: { equals: owner }, repo: { equals: repo } } }))
@@ -93,10 +100,15 @@ export const handlers = [
   http.delete("https://api.github.com/repos/:owner/:repo/issues/:issue_number/assignees", ({ params: { owner, repo, issue_number: issueNumber } }) =>
     HttpResponse.json({ owner, repo, issueNumber })
   ),
-  // search issues
-  http.get("https://api.github.com/search/issues", () => {
-    const issues = [db.issue.findFirst({ where: { number: { equals: 1 } } })];
-    return HttpResponse.json({ items: issues });
+  http.get("https://api.github.com/search/issues", ({ request }) => {
+    const params = new URL(request.url).searchParams;
+    const query = params.get("q");
+    const hasAssignee = query?.includes("assignee");
+    if (hasAssignee) {
+      return HttpResponse.json(db.issue.getAll());
+    } else {
+      return HttpResponse.json(db.pull.getAll());
+    }
   }),
   // get issue by number
   http.get("https://api.github.com/repos/:owner/:repo/issues/:issue_number", ({ params: { owner, repo, issue_number: issueNumber } }) =>

tests/__mocks__/users-get.json

@@ -1,14 +1,27 @@
 [
   {
     "id": 1,
-    "login": "ubiquity"
+    "login": "ubiquity",
+    "role": "admin"
   },
   {
     "id": 2,
-    "login": "user2"
+    "login": "user2",
+    "role": "contributor"
   },
   {
     "id": 3,
-    "login": "user3"
+    "login": "user3",
+    "role": "collaborator"
+  },
+  {
+    "id": 4,
+    "login": "user4",
+    "role": "new-start"
+  },
+  {
+    "id": 5,
+    "login": "user5",
+    "role": "member"
   }
 ]

tests/main.test.ts

@@ -172,16 +172,34 @@ describe("User start/stop", () => {
     await expect(userStartStop(context)).rejects.toThrow("Skipping '/start' since the issue is a parent issue");
   });
 
-  test("User can't start another issue if they have reached the max limit", async () => {
+  test("should set maxLimits to 6 if the user is a member", async () => {
     const issue = db.issue.findFirst({ where: { id: { equals: 1 } } }) as unknown as Issue;
-    const sender = db.users.findFirst({ where: { id: { equals: 2 } } }) as unknown as PayloadSender;
+    const sender = db.users.findFirst({ where: { id: { equals: 5 } } }) as unknown as Sender;
 
-    const context = createContext(issue, sender) as Context<"issue_comment.created">;
-    context.config.maxConcurrentTasks = 1;
+    const memberLimit = maxConcurrentDefaults.member;
 
-    context.adapters = createAdapters(getSupabase(), context);
+    createIssuesForMaxAssignment(memberLimit + 4, sender.id);
+    const context = createContext(issue, sender) as unknown as Context;
 
+    context.adapters = createAdapters(getSupabase(), context as unknown as Context);
     await expect(userStartStop(context)).rejects.toThrow("You have reached your max task limit. Please close out some tasks before assigning new ones.");
+
+    expect(memberLimit).toEqual(6);
+  });
+
+  test("should set maxLimits to 8 if the user is an admin", async () => {
+    const issue = db.issue.findFirst({ where: { id: { equals: 1 } } }) as unknown as Issue;
+    const sender = db.users.findFirst({ where: { id: { equals: 1 } } }) as unknown as Sender;
+
+    const adminLimit = maxConcurrentDefaults.admin;
+
+    createIssuesForMaxAssignment(adminLimit + 4, sender.id);
+    const context = createContext(issue, sender) as unknown as Context;
+
+    context.adapters = createAdapters(getSupabase(), context as unknown as Context);
+    await expect(userStartStop(context)).rejects.toThrow("You have reached your max task limit. Please close out some tasks before assigning new ones.");
+
+    expect(adminLimit).toEqual(8);
   });
 
   test("User can't start an issue if they have previously been unassigned by an admin", async () => {
@@ -208,7 +226,7 @@ describe("User start/stop", () => {
         errorDetails.push(`${error.path}: ${error.message}`);
       }
 
-      expect(errorDetails).toContain("/APP_ID: Required property");
+      expect(errorDetails).toContain("/APP_ID: Expected union value");
     }
   });
 
@@ -542,6 +560,23 @@ async function setupTests() {
   });
 }
 
+function createIssuesForMaxAssignment(n: number, userId: number) {
+  const user = db.users.findFirst({ where: { id: { equals: userId } } });
+  for (let i = 0; i < n; i++) {
+    db.issue.create({
+      ...issueTemplate,
+      id: i + 7,
+      assignee: user,
+    });
+  }
+}
+
+const maxConcurrentDefaults = {
+  admin: 8,
+  member: 6,
+  contributor: 4,
+};
+
 function createContext(
   issue: Record<string, unknown>,
   sender: Record<string, unknown>,
@@ -564,7 +599,7 @@ function createContext(
     config: {
       reviewDelayTolerance: "3 Days",
       taskStaleTimeoutDuration: "30 Days",
-      maxConcurrentTasks: 3,
+      maxConcurrentTasks: maxConcurrentDefaults,
       startRequiresWallet,
       emptyWalletText: "Please set your wallet address with the /wallet command first and try again.",
     },