feat: task limit improvement

README.md

@@ -42,6 +42,7 @@ To configure your Ubiquibot to run this plugin, add the following to the `.ubiqu
       member: 5
       contributor: 3
     startRequiresWallet: true # default is true
+    checkAssignedIssues: "org" # or "org" or "network". Default is org
     emptyWalletText: "Please set your wallet address with the /wallet command first and try again."
     rolesWithReviewAuthority: ["MEMBER", "OWNER"]
 ```

manifest.json

@@ -46,6 +46,10 @@
           }
         }
       },
+      "checkAssignedIssues": {
+        "default": "org",
+        "type": "string"
+      },
       "emptyWalletText": {
         "default": "Please set your wallet address with the /wallet command first and try again.",
         "type": "string"
@@ -68,6 +72,7 @@
       "taskStaleTimeoutDuration",
       "startRequiresWallet",
       "maxConcurrentTasks",
+      "checkAssignedIssues",
       "emptyWalletText",
       "rolesWithReviewAuthority"
     ]

src/handlers/shared/start.ts

@@ -1,4 +1,4 @@
-import { Context, ISSUE_TYPE, Label } from "../../types";
+import { Context, GitHubIssueSearch, ISSUE_TYPE, Label } from "../../types";
 import { isUserCollaborator } from "../../utils/get-user-association";
 import { addAssignees, addCommentToIssue, getAssignedIssues, getAvailableOpenedPullRequests, getTimeValue, isParentIssue } from "../../utils/issue";
 import { HttpStatusCode, Result } from "../result-types";
@@ -64,23 +64,46 @@ export async function start(
   teammates.push(sender.login);
 
   const toAssign = [];
+  let assignedIssues: GitHubIssueSearch["items"] = [];
   // check max assigned issues
   for (const user of teammates) {
-    if (await handleTaskLimitChecks(user, context, logger, sender.login)) {
+    const { isWithinLimit, issues } = await handleTaskLimitChecks(user, context, logger, sender.login);
+    if (isWithinLimit) {
       toAssign.push(user);
+    } else {
+      assignedIssues = assignedIssues.concat(issues);
     }
   }
 
   let error: string | null = null;
-
   if (toAssign.length === 0 && teammates.length > 1) {
     error = "All teammates have reached their max task limit. Please close out some tasks before assigning new ones.";
+    throw logger.error(error, { issueNumber: issue.number });
   } else if (toAssign.length === 0) {
     error = "You have reached your max task limit. Please close out some tasks before assigning new ones.";
-  }
+    let issues = "";
+    const urlPattern = /https:\/\/(github.com\/(\S+)\/(\S+)\/issues\/(\d+))/;
+    assignedIssues.forEach((el) => {
+      const match = el.html_url.match(urlPattern);
+      if (match) {
+        issues = issues.concat(`- ###### [${match[2]}/${match[3]} - ${el.title} #${match[4]}](https://www.${match[1]})\n`);
+      } else {
+        issues = issues.concat(`- ###### [${el.title}](${el.html_url})\n`);
+      }
+    });
 
-  if (error) {
-    throw logger.error(error, { issueNumber: issue.number });
+    await addCommentToIssue(
+      context,
+      `
+
+> [!WARNING]
+> ${error}
+
+${issues}
+
+`
+    );
+    throw new Error(logger.error(error, { issueNumber: issue.number }).logMessage.raw);
   }
 
   const labels = issue.labels ?? [];
@@ -168,12 +191,18 @@ async function handleTaskLimitChecks(username: string, context: Context, logger:
       limit,
     });
 
-    return false;
+    return {
+      isWithinLimit: false,
+      issues: assignedIssues,
+    };
   }
 
   if (await hasUserBeenUnassigned(context, username)) {
     throw logger.error(`${username} you were previously unassigned from this task. You cannot be reassigned.`, { username });
   }
 
-  return true;
+  return {
+    isWithinLimit: true,
+    issues: [],
+  };
 }

src/plugin.ts

@@ -4,9 +4,46 @@ import { createClient } from "@supabase/supabase-js";
 import { LogReturn, Logs } from "@ubiquity-os/ubiquity-os-logger";
 import { createAdapters } from "./adapters";
 import { userPullRequest, userSelfAssign, userStartStop, userUnassigned } from "./handlers/user-start-stop";
-import { Context, Env, PluginInputs } from "./types";
+import { Context, Env, GitHubIssueSearch, PluginInputs } from "./types";
 import { addCommentToIssue } from "./utils/issue";
 
+async function listOrganizations(context: Context): Promise<string[]> {
+  const {
+    config: { checkAssignedIssues },
+    logger,
+    payload,
+  } = context;
+
+  if (checkAssignedIssues === "repo" || checkAssignedIssues === "org") {
+    return [payload.repository.owner.login];
+  } else if (checkAssignedIssues === "network") {
+    const orgsSet: Set<string> = new Set();
+    const urlPattern = /https:\/\/github\.com\/(\S+)\/\S+\/issues\/\d+/;
+
+    const url = "https://raw.githubusercontent.com/ubiquity/devpool-directory/refs/heads/__STORAGE__/devpool-issues.json";
+    const response = await fetch(url);
+    if (!response.ok) {
+      if (response.status === 404) {
+        throw logger.error(`Error 404: unable to fetch file devpool-issues.json ${url}`);
+      } else {
+        throw logger.error("Error fetching file devpool-issues.json.", { status: response.status });
+      }
+    }
+
+    const devpoolIssues: GitHubIssueSearch["items"] = await response.json();
+    devpoolIssues.forEach((issue) => {
+      const match = issue.html_url.match(urlPattern);
+      if (match) {
+        orgsSet.add(match[1]);
+      }
+    });
+
+    return [...orgsSet];
+  }
+
+  throw new Error("Unknown checkAssignedIssues value. Supported values: ['org', 'repo', 'network']");
+}
+
 export async function startStopTask(inputs: PluginInputs, env: Env) {
   const customOctokit = Octokit.plugin(paginateGraphQL);
   const octokit = new customOctokit({ auth: inputs.authToken });
@@ -16,6 +53,7 @@ export async function startStopTask(inputs: PluginInputs, env: Env) {
     eventName: inputs.eventName,
     payload: inputs.eventPayload,
     config: inputs.settings,
+    organizations: [],
     octokit,
     env,
     logger: new Logs("info"),
@@ -25,6 +63,9 @@ export async function startStopTask(inputs: PluginInputs, env: Env) {
   context.adapters = createAdapters(supabase, context);
 
   try {
+    const organizations = await listOrganizations(context);
+    context.organizations = organizations;
+
     switch (context.eventName) {
       case "issue_comment.created":
         return await userStartStop(context);

src/types/context.ts

@@ -22,6 +22,7 @@ export interface Context<T extends SupportedEventsU = SupportedEventsU, TU exten
   octokit: InstanceType<typeof Octokit> & paginateGraphQLInterface;
   adapters: ReturnType<typeof createAdapters>;
   config: PluginSettings;
+  organizations: string[];
   env: Env;
   logger: Logs;
 }

src/types/plugin-input.ts

@@ -41,6 +41,7 @@ export const pluginSettingsSchema = T.Object(
     taskStaleTimeoutDuration: T.String({ default: "30 Days" }),
     startRequiresWallet: T.Boolean({ default: true }),
     maxConcurrentTasks: maxConcurrentTasks(),
+    checkAssignedIssues: T.String({ default: "org" }),
     emptyWalletText: T.String({ default: "Please set your wallet address with the /wallet command first and try again." }),
     rolesWithReviewAuthority: T.Transform(rolesWithReviewAuthority)
       .Decode((value) => value.map((role) => role.toUpperCase()))

src/utils/issue.ts

@@ -11,13 +11,20 @@ export function isParentIssue(body: string) {
   return body.match(parentPattern);
 }
 
-export async function getAssignedIssues(context: Context, username: string) {
-  const payload = context.payload;
+export async function getAssignedIssues(context: Context, username: string): Promise<GitHubIssueSearch["items"]> {
+  let repoOrgQuery = "";
+  if (context.config.checkAssignedIssues === "repo") {
+    repoOrgQuery = `repo:${context.payload.repository.full_name}`;
+  } else {
+    context.organizations.forEach((org) => {
+      repoOrgQuery += `org:${org} `;
+    });
+  }
 
   try {
-    return await context.octokit
+    return context.octokit
       .paginate(context.octokit.rest.search.issuesAndPullRequests, {
-        q: `org:${payload.repository.owner.login} assignee:${username} is:open is:issue`,
+        q: `${repoOrgQuery} assignee:${username} is:open is:issue`,
         per_page: 100,
         order: "desc",
         sort: "created",
@@ -29,7 +36,7 @@ export async function getAssignedIssues(context: Context, username: string) {
       );
   } catch (err) {
     context.logger.info("Will try re-fetching assigned issues...", { error: err as Error });
-    return getAssignedIssuesFallback(context, username);
+    return getAssignedIssuesFallback(context, username) as Promise<GitHubIssueSearch["items"]>;
   }
 }
 
@@ -174,16 +181,25 @@ export async function addAssignees(context: Context, issueNo: number, assignees:
 }
 
 async function getAllPullRequests(context: Context, state: Endpoints["GET /repos/{owner}/{repo}/pulls"]["parameters"]["state"] = "open", username: string) {
-  const { payload } = context;
+  let repoOrgQuery = "";
+  if (context.config.checkAssignedIssues === "repo") {
+    repoOrgQuery = `repo:${context.payload.repository.full_name}`;
+  } else {
+    context.organizations.forEach((org) => {
+      repoOrgQuery += `org:${org} `;
+    });
+  }
+
   const query: RestEndpointMethodTypes["search"]["issuesAndPullRequests"]["parameters"] = {
-    q: `org:${payload.repository.owner.login} author:${username} state:${state}`,
+    q: `${repoOrgQuery} author:${username} state:${state}`,
     per_page: 100,
     order: "desc",
     sort: "created",
   };
 
   try {
-    return (await context.octokit.paginate(context.octokit.rest.search.issuesAndPullRequests, query)) as GitHubIssueSearch["items"];
+    const prs = (await context.octokit.paginate(context.octokit.rest.search.issuesAndPullRequests, query)) as GitHubIssueSearch["items"];
+    return prs.filter((pr) => pr.pull_request && pr.state === "open");
   } catch (err: unknown) {
     throw new Error(context.logger.error("Fetching all pull requests failed!", { error: err as Error, query }).logMessage.raw);
   }

tests/__mocks__/valid-configuration.json

@@ -7,6 +7,7 @@
     "member": 10,
     "contributor": 2
   },
+  "checkAssignedIssues": "org",
   "emptyWalletText": "Please set your wallet address with the /wallet command first and try again.",
   "rolesWithReviewAuthority": ["OWNER", "ADMIN", "MEMBER"]
 }

tests/configuration.test.ts

@@ -8,6 +8,7 @@ describe("Configuration tests", () => {
       reviewDelayTolerance: "1 Day",
       taskStaleTimeoutDuration: "30 Days",
       startRequiresWallet: true,
+      checkAssignedIssues: "org",
       emptyWalletText: "Please set your wallet address with the /wallet command first and try again.",
       maxConcurrentTasks: { admin: 20, member: 10, contributor: 2 },
       rolesWithReviewAuthority: ["OWNER", "ADMIN", "MEMBER"],

tests/main.test.ts

@@ -221,9 +221,7 @@ describe("User start/stop", () => {
     const context = createContext(issue, sender) as unknown as Context;
 
     context.adapters = createAdapters(getSupabase(), context as unknown as Context);
-    await expect(userStartStop(context)).rejects.toMatchObject({
-      logMessage: { raw: "You have reached your max task limit. Please close out some tasks before assigning new ones." },
-    });
+    await expect(userStartStop(context)).rejects.toThrowError("You have reached your max task limit. Please close out some tasks before assigning new ones.");
 
     expect(memberLimit).toEqual(6);
   });
@@ -629,11 +627,13 @@ export function createContext(
       taskStaleTimeoutDuration: "30 Days",
       maxConcurrentTasks: maxConcurrentDefaults,
       startRequiresWallet,
+      checkAssignedIssues: "org",
       emptyWalletText: "Please set your wallet address with the /wallet command first and try again.",
       rolesWithReviewAuthority: ["ADMIN", "OWNER", "MEMBER"],
     },
     octokit: new octokit.Octokit(),
     eventName: "issue_comment.created" as SupportedEventsU,
+    organizations: ["ubiquity"],
     env: {
       SUPABASE_KEY: "key",
       SUPABASE_URL: "url",