Merge pull request ubiquity-os-marketplace#37 from ubq-testing/fix/ap…

…proved-roles

fix: add rolesWithReviewAuth to config

README.md

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

manifest.json

@@ -12,4 +12,4 @@
       "description": "Unassign yourself from the issue."
     }
   }
-}
+}

src/types/plugin-input.ts

@@ -11,14 +11,26 @@ export interface PluginInputs<T extends SupportedEventsU = SupportedEventsU, TU
   ref: string;
 }
 
+const rolesWithReviewAuthority = T.Array(T.String(), { default: ["COLLABORATOR", "OWNER", "MEMBER", "ADMIN"] });
+
 function maxConcurrentTasks() {
   return T.Transform(T.Record(T.String(), T.Integer(), { default: { member: 10, contributor: 2 } }))
-    .Decode((value) => {
+    .Decode((obj) => {
+      // normalize the role keys to lowercase
+      obj = Object.keys(obj).reduce(
+        (acc, key) => {
+          acc[key.toLowerCase()] = obj[key];
+          return acc;
+        },
+        {} as Record<string, number>
+      );
+
       // If admin is omitted, defaults to infinity
-      if (!Object.keys(value).includes("admin")) {
-        value["admin"] = Infinity;
+      if (!obj["admin"]) {
+        obj["admin"] = Infinity;
       }
-      return value;
+
+      return obj;
     })
     .Encode((value) => value);
 }
@@ -30,6 +42,9 @@ export const startStopSchema = T.Object(
     startRequiresWallet: T.Boolean({ default: true }),
     maxConcurrentTasks: maxConcurrentTasks(),
     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()))
+      .Encode((value) => value.map((role) => role.toUpperCase())),
   },
   {
     default: {},

src/utils/issue.ts

@@ -187,13 +187,18 @@ export async function getAllPullRequests(context: Context, state: "open" | "clos
 }
 
 export async function getAllPullRequestReviews(context: Context, pullNumber: number, owner: string, repo: string) {
+  const {
+    config: { rolesWithReviewAuthority },
+  } = context;
   try {
-    return (await context.octokit.paginate(context.octokit.pulls.listReviews, {
-      owner,
-      repo,
-      pull_number: pullNumber,
-      per_page: 100,
-    })) as Review[];
+    return (
+      await context.octokit.paginate(context.octokit.pulls.listReviews, {
+        owner,
+        repo,
+        pull_number: pullNumber,
+        per_page: 100,
+      })
+    ).filter((review) => rolesWithReviewAuthority.includes(review.author_association)) as Review[];
   } catch (err: unknown) {
     throw new Error(context.logger.error("Fetching all pull request reviews failed!", { error: err as Error }).logMessage.raw);
   }

tests/__mocks__/valid-configuration.json

@@ -2,6 +2,11 @@
   "reviewDelayTolerance": "1 Day",
   "taskStaleTimeoutDuration": "30 Days",
   "startRequiresWallet": true,
-  "maxConcurrentTasks": { "admin": 20, "member": 10, "contributor": 2 },
-  "emptyWalletText": "Please set your wallet address with the /wallet command first and try again."
+  "maxConcurrentTasks": {
+    "admin": 20,
+    "member": 10,
+    "contributor": 2
+  },
+  "emptyWalletText": "Please set your wallet address with the /wallet command first and try again.",
+  "rolesWithReviewAuthority": ["OWNER", "ADMIN", "MEMBER"]
 }

tests/configuration.test.ts

@@ -4,12 +4,27 @@ import cfg from "./__mocks__/valid-configuration.json";
 
 describe("Configuration tests", () => {
   it("Should decode the configuration", () => {
-    const settings = Value.Default(startStopSchema, { maxConcurrentTasks: { admin: 20, member: 10, contributor: 2 } }) as StartStopSettings;
+    const settings = Value.Default(startStopSchema, {
+      reviewDelayTolerance: "1 Day",
+      taskStaleTimeoutDuration: "30 Days",
+      startRequiresWallet: true,
+      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"],
+    }) as StartStopSettings;
     expect(settings).toEqual(cfg);
   });
   it("Should default the admin to infinity if missing from config when decoded", () => {
     const settings = Value.Default(startStopSchema, {}) as StartStopSettings;
     const decodedSettings = Value.Decode(startStopSchema, settings);
     expect(decodedSettings.maxConcurrentTasks["admin"]).toEqual(Infinity);
   });
+
+  it("Should normalize maxConcurrentTasks role keys to lowercase when decoded", () => {
+    const settings = Value.Default(startStopSchema, {
+      maxConcurrentTasks: { ADMIN: 20, memBER: 10, CONTRIBUTOR: 2 },
+    }) as StartStopSettings;
+    const decodedSettings = Value.Decode(startStopSchema, settings);
+    expect(decodedSettings.maxConcurrentTasks).toEqual({ admin: 20, member: 10, contributor: 2 });
+  });
 });

tests/main.test.ts

@@ -622,6 +622,7 @@ function createContext(
       maxConcurrentTasks: maxConcurrentDefaults,
       startRequiresWallet,
       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,