feat(plugins): rewards plugin

.github/.ubiquibot-config.yml

@@ -0,0 +1,8 @@
+plugins:
+  "issue_comment.created":
+    - name: "reward plugin name"
+      command: "/rewards"
+      skipBotEvents: true
+      uses:
+        - plugin: amit0617/contributor-rewards:compute.yml@development
+          type: github

.github/workflows/compute.yml

@@ -1,4 +1,4 @@
-name: "the name of the plugin"
+name: "github contributor rewards"
 
 on:
   workflow_dispatch:
@@ -18,7 +18,7 @@ on:
 
 jobs:
   compute:
-    name: "plugin name"
+    name: "github contributor rewards"
     runs-on: ubuntu-latest
     permissions: write-all
     env:
@@ -38,7 +38,7 @@ jobs:
 
       - name: execute directive
         run: npx tsx ./src/main.ts
-        id: plugin-name
+        id: github-contrib-reward
         env:
           SUPABASE_URL: ${{ secrets.SUPABASE_URL }}
           SUPABASE_KEY: ${{ secrets.SUPABASE_KEY }}

manifest.json

@@ -2,17 +2,54 @@
   "name": "ts-template",
   "description": "ts-template for UbiquityOS plugins.",
   "ubiquity:listeners": [
-    "issue_comment.created"
+    "issue_comment.created",
+    "issue_comment.deleted",
+    "issue_comment.edited",
+    "pull_request.assigned",
+    "pull_request.auto_merge_disabled",
+    "pull_request.auto_merge_enabled",
+    "pull_request.closed",
+    "pull_request.converted_to_draft",
+    "pull_request.demilestoned",
+    "pull_request.dequeued",
+    "pull_request.edited",
+    "pull_request.enqueued",
+    "pull_request.labeled",
+    "pull_request.locked",
+    "pull_request.milestoned",
+    "pull_request.opened",
+    "pull_request.ready_for_review",
+    "pull_request.reopened",
+    "pull_request.review_request_removed",
+    "pull_request.review_requested",
+    "pull_request.synchronize",
+    "pull_request.unassigned",
+    "pull_request.unlabeled",
+    "pull_request.unlocked",
+    "pull_request_review",
+    "pull_request_review.dismissed",
+    "pull_request_review.edited",
+    "pull_request_review.submitted",
+    "pull_request_review_comment",
+    "pull_request_review_comment.created",
+    "pull_request_review_comment.deleted",
+    "pull_request_review_comment.edited",
+    "pull_request_review_thread",
+    "pull_request_review_thread.resolved",
+    "pull_request_review_thread.unresolved"
   ],
   "commands": {
     "command1": {
       "ubiquity:example": "/command1 argument",
       "description": "Command 1 with an argument."
+    },
+    "rewards": {
+      "description": "Rewards to get calculate for contributors."
     }
   },
   "configuration": {
     "default": {
-      "configurableResponse": "Hello, world!"
+      "configurableResponse": "Hello, world! Amit passed from here, testing"
     },
     "type": "object",
     "properties": {

src/handlers/contrib-reward.ts

@@ -0,0 +1,61 @@
+import { Context } from "../types";
+
+export async function contribReward(context: Context) {
+  const {
+    logger,
+    payload,
+    octokit,
+    // config: { configurableResponse, },
+  } = context;
+  const contributors: Record<string, number> = {};
+
+  const sender = payload.comment.user?.login;
+  const repo = payload.repository.name;
+  const issueNumber = payload.issue.number;
+  const owner = payload.repository.owner.login;
+  const body = payload.comment.body;
+
+  if (!body.match(/rewards/i)) {
+    logger.error(`Invalid use of slash command, use "/rewards".`, { body });
+    return;
+  }
+
+  logger.info("Calculating rewards for contributor.");
+  logger.debug(`Executing contribReward:`, { sender, repo, issueNumber, owner });
+
+  try {
+    const events = await octokit.issues.listEventsForTimeline({
+      owner,
+      repo,
+      issue_number: issueNumber,
+    });
+
+    events.data.forEach((event) => {
+      const contributor = event.actor?.login;
+      if (!contributors[contributor]) {
+        contributors[contributor] = 0;
+      }
+      contributors[contributor]++;
+    });
+
+    await octokit.issues.createComment({
+      owner: payload.repository.owner.login,
+      repo: payload.repository.name,
+      issue_number: payload.issue.number,
+      body: JSON.stringify(contributors),
+    });
+
+    logger.info(`Contributors: ${JSON.stringify(contributors)}`);
+  } catch (error) {
+    if (error instanceof Error) {
+      logger.error(`Error calculating rewards:`, { error });
+      throw error;
+    } else {
+      logger.error(`Error calculating rewards:`, { error: new Error(String(error)) });
+      throw error;
+    }
+  }
+
+  logger.ok(`Successfully created comment!`);
+  logger.verbose(`Exiting contribReward`);
+}

src/plugin.ts

@@ -4,18 +4,24 @@ import { Env, PluginInputs } from "./types";
 import { Context } from "./types";
 import { isIssueCommentEvent } from "./types/typeguards";
 import { helloWorld } from "./handlers/hello-world";
+import { contribReward } from "./handlers/contrib-reward";
 import { LogLevel, Logs } from "@ubiquity-dao/ubiquibot-logger";
 
 /**
  * The main plugin function. Split for easier testing.
  */
 export async function runPlugin(context: Context) {
-  const { logger, eventName } = context;
+  const { logger, eventName, payload } = context;
 
+  // let's keep it for testing purposes
   if (isIssueCommentEvent(context)) {
     return await helloWorld(context);
   }
 
+  if (eventName === "issue_comment.created" && payload.comment.body.match(/rewards/i)) {
+    return await contribReward(context);
+  }
+
   logger.error(`Unsupported event: ${eventName}`);
 }
 

src/types/context.ts

@@ -9,7 +9,42 @@ import { Logs } from "@ubiquity-dao/ubiquibot-logger";
  *
  * ubiquity:listeners: ["issue_comment.created", ...]
  */
-export type SupportedEventsU = "issue_comment.created";
+export type SupportedEventsU =
+  | "issue_comment.created"
+  | "issue_comment.deleted"
+  | "issue_comment.edited"
+  | "pull_request.assigned"
+  | "pull_request.auto_merge_disabled"
+  | "pull_request.auto_merge_enabled"
+  | "pull_request.closed"
+  | "pull_request.converted_to_draft"
+  | "pull_request.demilestoned"
+  | "pull_request.dequeued"
+  | "pull_request.edited"
+  | "pull_request.enqueued"
+  | "pull_request.labeled"
+  | "pull_request.locked"
+  | "pull_request.milestoned"
+  | "pull_request.opened"
+  | "pull_request.ready_for_review"
+  | "pull_request.reopened"
+  | "pull_request.review_request_removed"
+  | "pull_request.review_requested"
+  | "pull_request.synchronize"
+  | "pull_request.unassigned"
+  | "pull_request.unlabeled"
+  | "pull_request.unlocked"
+  | "pull_request_review"
+  | "pull_request_review.dismissed"
+  | "pull_request_review.edited"
+  | "pull_request_review.submitted"
+  | "pull_request_review_comment"
+  | "pull_request_review_comment.created"
+  | "pull_request_review_comment.deleted"
+  | "pull_request_review_comment.edited"
+  | "pull_request_review_thread"
+  | "pull_request_review_thread.resolved"
+  | "pull_request_review_thread.unresolved";
 
 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: "Hello, world! Amit passed from here, testing" } }
 );
 
 export const pluginSettingsValidator = new StandardValidator(pluginSettingsSchema);