QA 2

.github/.ubiquity-os.config.dev.yml

@@ -0,0 +1,8 @@
+plugins:
+  - uses:
+      - plugin: https://damaged-alysa-moniswap-b2f3cc8b.koyeb.app
+        with:
+          disabledCommands: []
+          miscellaneous:
+            maxConcurrentTasks: 3
+        runsOn: ["issue_comment", "issue_comment.created", "issue_comment.edited"]

.github/workflows/compute.yml

@@ -1,4 +1,4 @@
-name: "the name of the plugin"
+name: "ubiquity-contribs-scanner"
 
 on:
   workflow_dispatch:

.gitignore

@@ -16,3 +16,6 @@ cypress/screenshots
 script.ts
 .wrangler
 test-dashboard.md
+.platform*
+*Dockerfile*
+.dockerignore

eslint.config.mjs

@@ -9,7 +9,7 @@ export default tsEslint.config({
     "@typescript-eslint": tsEslint.plugin,
     "check-file": checkFile,
   },
-  ignores: [".github/knip.ts"],
+  ignores: [".github/knip.ts", "coverage/**/*.js"],
   extends: [eslint.configs.recommended, ...tsEslint.configs.recommended, sonarjs.configs.recommended],
   languageOptions: {
     parser: tsEslint.parser,

manifest.json

@@ -1,16 +1,20 @@
 {
-  "name": "ts-template",
-  "description": "ts-template for UbiquityOS plugins.",
-  "ubiquity:listeners": ["issue_comment.created", "issue_comment.deleted", "issue_comment.edited"],
+  "name": "scan-contributions",
+  "description": "UbiquityOS plugin for scanning contributions based on issues/pulls.",
+  "ubiquity:listeners": [
+    "issue_comment.created",
+    "issue_comment.edited",
+    "issue_comment"
+  ],
   "commands": {
-    "command1": {
-      "ubiquity:example": "/command1 argument",
-      "description": "Command 1 with an argument."
+    "scanContributions": {
+      "ubiquity:example": "/scanContributions",
+      "description": "Slash command that maps the names of contributors to events executed within a repo's context."
     }
   },
   "configuration": {
     "default": {
-      "configurableResponse": "Hello, world!"
+      "configurableResponse": "This is the UbiquityOS contributions scanner."
     },
     "type": "object",
     "properties": {
@@ -21,6 +25,8 @@
         "type": "string"
       }
     },
-    "required": ["configurableResponse"]
+    "required": [
+      "configurableResponse"
+    ]
   }
-}
+}

src/handlers/scan-contributions.ts

@@ -0,0 +1,165 @@
+import { Context } from "../types";
+
+export async function scanContributions(context: Context) {
+  const { logger, payload, octokit } = context;
+
+  const store: Record<string, Record<string, number>> = {};
+
+  const repo = payload.repository.name;
+  const issueNumber = payload.issue.number;
+  const owner = payload.repository.owner.login;
+  const body = payload.comment.body;
+
+  if (!body.match(/scanContributions/i)) {
+    return;
+  }
+
+  logger.info("Scanning Events!");
+
+  try {
+    const contributors = await octokit.repos.listContributors({
+      repo,
+      owner,
+    });
+
+    contributors.data.forEach((contributor) => {
+      if (contributor.login) {
+        store[contributor.login] = {};
+      }
+    });
+
+    const issueTimelineEvents = await octokit.paginate(octokit.issues.listEventsForTimeline, { owner, repo, issue_number: issueNumber });
+    const issueEvents = await octokit.paginate(octokit.issues.listEvents, { owner, repo, issue_number: issueNumber });
+    const issueReactionEvents = await octokit.paginate(octokit.reactions.listForIssue, { owner, repo, issue_number: issueNumber });
+    const issueCommentEvents = await octokit.paginate(octokit.issues.listComments, { owner, repo, issue_number: issueNumber });
+
+    issueTimelineEvents.forEach((ev) => {
+      if ("actor" in ev && ev.actor && !store[ev.actor.login]) {
+        store[ev.actor.login] = {};
+      }
+
+      if ("actor" in ev && ev.actor) {
+        const key = (payload.issue.pull_request ? "pull_request." : "issues.").concat(ev.event);
+        if (!store[ev.actor.login][key]) store[ev.actor.login][key] = 1;
+        else store[ev.actor.login][key] += 1;
+      }
+    });
+
+    issueEvents.forEach((ev) => {
+      if (ev.actor && !store[ev.actor.login]) {
+        store[ev.actor.login] = {};
+      }
+
+      if (ev.actor && !issueTimelineEvents.map((te) => te.event).includes(ev.event)) {
+        const key = (payload.issue.pull_request ? "pull_request." : "issues.").concat(ev.event);
+        if (!store[ev.actor.login][key]) store[ev.actor.login][key] = 1;
+        else store[ev.actor.login][key] += 1;
+      }
+    });
+
+    issueReactionEvents.forEach((ev) => {
+      if (ev.user && !store[ev.user.login]) {
+        store[ev.user.login] = {};
+      }
+      if (ev.user) {
+        if (!store[ev.user.login][ev.content]) store[ev.user.login][ev.content] = 1;
+        else store[ev.user.login][ev.content] += 1;
+      }
+    });
+
+    for (const issueCommentEvent of issueCommentEvents) {
+      const reactions = await octokit.paginate(octokit.reactions.listForIssueComment, { owner, repo, comment_id: issueCommentEvent.id });
+
+      reactions.forEach((reaction) => {
+        if (reaction.user && !store[reaction.user.login]) {
+          store[reaction.user.login] = {};
+        }
+
+        if (reaction.user) {
+          if (!store[reaction.user.login][reaction.content]) store[reaction.user.login][reaction.content] = 1;
+          else store[reaction.user.login][reaction.content] += 1;
+        }
+      });
+    }
+
+    if (payload.issue.pull_request) {
+      const pullReviews = await octokit.paginate(octokit.pulls.listReviews, { owner, repo, pull_number: issueNumber });
+      const pullReviewComments = await octokit.paginate(octokit.pulls.listReviewComments, { owner, repo, pull_number: issueNumber });
+
+      for (const pullReview of pullReviews) {
+        if (pullReview.user && !store[pullReview.user.login]) {
+          store[pullReview.user.login] = {};
+        }
+
+        if (pullReview.user) {
+          const key = "pull_request_review.".concat(pullReview.state.toLowerCase());
+          if (!store[pullReview.user.login][key]) store[pullReview.user.login][key] = 1;
+          else store[pullReview.user.login][key] += 1;
+        }
+      }
+
+      for (const pullReviewComment of pullReviewComments) {
+        if (pullReviewComment.user && !store[pullReviewComment.user.login]) {
+          store[pullReviewComment.user.login] = {};
+        }
+
+        const key = "pull_request_review_comment.created";
+
+        if (pullReviewComment.user) {
+          if (!store[pullReviewComment.user.login][key]) store[pullReviewComment.user.login][key] = 1;
+          else store[pullReviewComment.user.login][key] += 1;
+        }
+
+        const reactions = await octokit.paginate(octokit.reactions.listForPullRequestReviewComment, { owner, repo, comment_id: pullReviewComment.id });
+
+        reactions.forEach((reaction) => {
+          if (reaction.user && !store[reaction.user.login]) {
+            store[reaction.user.login] = {};
+          }
+
+          if (reaction.user) {
+            if (!store[reaction.user.login][reaction.content]) store[reaction.user.login][reaction.content] = 1;
+            else store[reaction.user.login][reaction.content] += 1;
+          }
+        });
+      }
+    }
+
+    logger.info("Contributions stats: ", store);
+    const octokitCommentBody = "```json\n" + JSON.stringify(store, undefined, 2) + "\n```";
+
+    await octokit.issues.createComment({
+      owner,
+      repo,
+      issue_number: issueNumber,
+      body: octokitCommentBody,
+    });
+  } catch (error) {
+    if (error instanceof Error) {
+      const octokitCommentBody =
+        "An error occurred while scanning this repository\n ```json\n" + JSON.stringify({ error: error, stack: error.stack }, undefined, 2) + "\n```";
+      await octokit.issues.createComment({
+        owner,
+        repo,
+        issue_number: issueNumber,
+        body: octokitCommentBody,
+      });
+      logger.error(`Error creating comment:`, { error: error, stack: error.stack });
+      throw error;
+    } else {
+      const octokitCommentBody =
+        "An error occurred while scanning this repository\n ```json\n" + JSON.stringify({ err: error, error: new Error() }, undefined, 2) + "\n```";
+      await octokit.issues.createComment({
+        owner,
+        repo,
+        issue_number: issueNumber,
+        body: octokitCommentBody,
+      });
+      logger.error(`Error creating comment:`, { err: error, error: new Error() });
+      throw error;
+    }
+  }
+
+  logger.ok(`Successfully scanned contributions!`, { repo, issueNumber });
+  logger.verbose(`Exiting scanContributions`);
+}

src/helpers/validator.ts

@@ -1,13 +1,18 @@
-import * as github from "@actions/github";
 import { Octokit } from "@octokit/rest";
 import { TransformDecodeCheckError, TransformDecodeError, Value, ValueError } from "@sinclair/typebox/value";
-import { Env, envSchema, envValidator, PluginSettings, pluginSettingsSchema, pluginSettingsValidator } from "../types";
+import { Context, Env, envSchema, envValidator, PluginSettings, pluginSettingsSchema, pluginSettingsValidator } from "../types";
 
-export async function returnDataToKernel(repoToken: string, stateId: string, output: object, eventType = "return-data-to-ubiquity-os-kernel") {
+export async function returnDataToKernel(
+  repoToken: string,
+  stateId: string,
+  output: object,
+  context: Context,
+  eventType = "return-data-to-ubiquity-os-kernel"
+) {
   const octokit = new Octokit({ auth: repoToken });
   return octokit.repos.createDispatchEvent({
-    owner: github.context.repo.owner,
-    repo: github.context.repo.repo,
+    owner: context.payload.repository.owner.login,
+    repo: context.payload.repository.name,
     event_type: eventType,
     client_payload: {
       state_id: stateId,

src/plugin.ts

@@ -3,8 +3,11 @@ import { returnDataToKernel } from "./helpers/validator";
 import { Env, PluginInputs } from "./types";
 import { Context } from "./types";
 import { isIssueCommentEvent } from "./types/typeguards";
-import { helloWorld } from "./handlers/hello-world";
+import { scanContributions } from "./handlers/scan-contributions";
 import { LogLevel, Logs } from "@ubiquity-dao/ubiquibot-logger";
+import dotenv from "dotenv";
+
+dotenv.config();
 
 /**
  * The main plugin function. Split for easier testing.
@@ -13,7 +16,7 @@ export async function runPlugin(context: Context) {
   const { logger, eventName } = context;
 
   if (isIssueCommentEvent(context)) {
-    return await helloWorld(context);
+    return await scanContributions(context);
   }
 
   logger.error(`Unsupported event: ${eventName}`);
@@ -46,5 +49,5 @@ export async function plugin(inputs: PluginInputs, env: Env) {
    */
 
   await runPlugin(context);
-  return returnDataToKernel(process.env.GITHUB_TOKEN, inputs.stateId, {});
+  return returnDataToKernel(process.env.GITHUB_TOKEN, inputs.stateId, {}, context);
 }

src/types/context.ts

@@ -9,7 +9,7 @@ import { Logs } from "@ubiquity-dao/ubiquibot-logger";
  *
  * ubiquity:listeners: ["issue_comment.created", ...]
  */
-export type SupportedEventsU = "issue_comment.created" | "issue_comment.deleted" | "issue_comment.edited";
+export type SupportedEventsU = "issue_comment.created" | "issue_comment.edited";
 
 export type SupportedEvents = {
   [K in SupportedEventsU]: K extends WebhookEventName ? WebhookEvent<K> : never;

src/types/plugin-inputs.ts

@@ -23,7 +23,7 @@ export const pluginSettingsSchema = T.Object(
     configurableResponse: T.String(),
     customStringsUrl: T.Optional(T.String()),
   },
-  { default: { configurableResponse: "Hello, world!" } }
+  { default: { configurableResponse: "This is the UbiquityOS contributions scanner." } }
 );
 
 export const pluginSettingsValidator = new StandardValidator(pluginSettingsSchema);

src/types/typeguards.ts

@@ -9,6 +9,6 @@ import { Context } from "./context";
 /**
  * Restricts the scope of `context` to the `issue_comment.created` payload.
  */
-export function isIssueCommentEvent(context: Context): context is Context<"issue_comment.created"> {
-  return context.eventName === "issue_comment.created";
+export function isIssueCommentEvent(context: Context): context is Context<"issue_comment.created" | "issue_comment.edited"> {
+  return context.eventName === "issue_comment.created" || context.eventName === "issue_comment.edited";
 }