feat: github comment generation and posting

.cspell.json

@@ -4,7 +4,7 @@
   "ignorePaths": ["**/*.json", "**/*.css", "node_modules", "**/*.log"],
   "useGitignore": true,
   "language": "en",
-  "words": ["dataurl", "devpool", "outdir", "servedir", "ubiquibot", "tiktoken", "typebox"],
+  "words": ["dataurl", "devpool", "outdir", "servedir", "ubiquibot", "tiktoken", "typebox", "supabase", "wxdai", "noopener"],
   "dictionaries": ["typescript", "node", "software-terms"],
   "import": ["@cspell/dict-typescript/cspell-ext.json", "@cspell/dict-node/cspell-ext.json", "@cspell/dict-software-terms"],
   "ignoreRegExpList": ["[0-9a-fA-F]{6}"]

.github/workflows/cspell.yml

@@ -2,6 +2,7 @@ name: Spell Check
 
 on:
   push:
+  pull_request:
 
 jobs:
   spellcheck:

.gitignore

@@ -9,3 +9,4 @@ node_modules
 static/dist
 .env
 junit.xml
+coverage

package.json

@@ -30,7 +30,7 @@
     "@octokit/rest": "20.1.0",
     "@sinclair/typebox": "0.32.20",
     "@supabase/supabase-js": "2.42.0",
-    "@ubiquibot/permit-generation": "1.0.3",
+    "@ubiquibot/permit-generation": "1.2.1",
     "commander": "12.0.0",
     "decimal.js": "10.4.3",
     "dotenv": "16.4.5",
@@ -56,7 +56,7 @@
     "@types/node": "20.11.28",
     "@typescript-eslint/eslint-plugin": "6.21.0",
     "@typescript-eslint/parser": "6.21.0",
-    "babel-jest": "^29.7.0",
+    "babel-jest": "29.7.0",
     "cspell": "8.3.2",
     "eslint": "8.56.0",
     "eslint-plugin-sonarjs": "0.23.0",

rewards-configuration.default.yml

@@ -27,29 +27,39 @@ formattingEvaluator:
     td: 1
     hr: 0
   multipliers:
-    - type: [ISSUE, ISSUER]:
+    - type: [ISSUE, ISSUER, TASK]:
+      formattingMultiplier: 1
+      wordValue: 0.1
+    - type: [ISSUE, ISSUER, COMMENT]:
       formattingMultiplier: 1
       wordValue: 0.2
-    - type: [ISSUE, ASSIGNEE]:
+    - type: [ISSUE, ASSIGNEE, COMMENT]:
       formattingMultiplier: 0
       wordValue: 0
-    - type: [ISSUE, COLLABORATOR]:
+    - type: [ISSUE, COLLABORATOR, COMMENT]:
       formattingMultiplier: 1
       wordValue: 0.1
-    - type: [ISSUE, CONTRIBUTOR]:
+    - type: [ISSUE, CONTRIBUTOR, COMMENT]:
       formattingMultiplier: 0.25
       wordValue: 0.1
-    - type: [REVIEW, ISSUER]:
+    - type: [REVIEW, ISSUER, SPECIFICATION]:
+      formattingMultiplier: 0
+      wordValue: 0
+    - type: [REVIEW, ISSUER, COMMENT]:
       formattingMultiplier: 2
       wordValue: 0.2
-    - type: [REVIEW, ASSIGNEE]:
+    - type: [REVIEW, ASSIGNEE, COMMENT]:
       formattingMultiplier: 1
       wordValue: 0.1
-    - type: [REVIEW, COLLABORATOR]:
+    - type: [REVIEW, COLLABORATOR, COMMENT]:
       formattingMultiplier: 1
       wordValue: 0.1
-    - type: [REVIEW, CONTRIBUTOR]:
+    - type: [REVIEW, CONTRIBUTOR, COMMENT]:
       formattingMultiplier: 0.25
       wordValue: 0.1
 permitGeneration:
   enabled: true
+githubComment:
+  enabled: true
+  post: true
+  debug: true

src/configuration/github-comment-config.ts

@@ -0,0 +1,11 @@
+import { Static, Type } from "@sinclair/typebox";
+
+const githubCommentConfigurationType = Type.Object({
+  enabled: Type.Boolean({ default: true }),
+  post: Type.Boolean({ default: true }),
+  debug: Type.Boolean({ default: false }),
+});
+
+export type GithubCommentConfiguration = Static<typeof githubCommentConfigurationType>;
+
+export default githubCommentConfigurationType;

src/issue-activity.ts

@@ -25,6 +25,9 @@ export enum CommentType {
   ISSUER = 0b1000,
   COLLABORATOR = 0b10000,
   CONTRIBUTOR = 0b100000,
+  COMMENT = 0b1000000,
+  TASK = 0b10000000,
+  SPECIFICATION = 0b100000000,
 }
 
 export class IssueActivity {
@@ -73,7 +76,12 @@ export class IssueActivity {
     self: GitHubPullRequest | GitHubIssue | null
   ) {
     let ret = 0;
-    ret |= "pull_request_review_id" in comment ? CommentType.REVIEW : CommentType.ISSUE;
+    ret |= "pull_request_review_id" in comment || "draft" in comment ? CommentType.REVIEW : CommentType.ISSUE;
+    if (comment.id === self?.id) {
+      ret |= ret & CommentType.ISSUE ? CommentType.TASK : CommentType.SPECIFICATION;
+    } else {
+      ret |= CommentType.COMMENT;
+    }
     if (comment.user?.id === self?.user?.id) {
       ret |= CommentType.ISSUER;
     } else if (comment.user?.id === self?.assignee?.id) {

src/parser/github-comment-module.ts

@@ -0,0 +1,212 @@
+import { Value } from "@sinclair/typebox/value";
+import Decimal from "decimal.js";
+import * as fs from "fs";
+import { stringify } from "yaml";
+import configuration from "../configuration/config-reader";
+import githubCommentConfig, { GithubCommentConfiguration } from "../configuration/github-comment-config";
+import { getOctokitInstance } from "../get-authentication-token";
+import { CommentType, IssueActivity } from "../issue-activity";
+import { parseGitHubUrl } from "../start";
+import { getPayoutConfigByNetworkId } from "../types/payout";
+import program from "./command-line";
+import { GithubCommentScore, Module, Result } from "./processor";
+
+/**
+ * Posts a GitHub comment according to the given results.
+ */
+export class GithubCommentModule implements Module {
+  private readonly _configuration: GithubCommentConfiguration = configuration.githubComment;
+  private readonly _debugFilePath = "./output.html";
+
+  async transform(data: Readonly<IssueActivity>, result: Result): Promise<Result> {
+    let body = "";
+
+    for (const [key, value] of Object.entries(result)) {
+      result[key].evaluationCommentHtml = this._generateHtml(key, value);
+      body += result[key].evaluationCommentHtml;
+    }
+    if (this._configuration.debug) {
+      fs.writeFileSync(this._debugFilePath, body);
+    }
+    if (this._configuration.post) {
+      try {
+        const octokit = getOctokitInstance();
+        const { owner, repo, issue_number } = parseGitHubUrl(program.opts().issue);
+
+        await octokit.issues.createComment({
+          body,
+          repo,
+          owner,
+          issue_number,
+        });
+      } catch (e) {
+        console.error(`Could not post GitHub comment: ${e}`);
+      }
+    }
+    return Promise.resolve(result);
+  }
+
+  get enabled(): boolean {
+    if (!Value.Check(githubCommentConfig, this._configuration)) {
+      console.warn("Invalid configuration detected for GithubContentModule, disabling.");
+      return false;
+    }
+    return true;
+  }
+
+  _generateHtml(username: string, result: Result[0]) {
+    const sorted = result.comments?.reduce<{
+      issues: { task: GithubCommentScore | null; comments: GithubCommentScore[] };
+      reviews: GithubCommentScore[];
+    }>(
+      (acc, curr) => {
+        if (curr.type & CommentType.ISSUE) {
+          if (curr.type & CommentType.TASK) {
+            acc.issues.task = curr;
+          } else {
+            acc.issues.comments.push(curr);
+          }
+        } else if (curr.type & CommentType.REVIEW) {
+          acc.reviews.push(curr);
+        }
+        return acc;
+      },
+      { issues: { task: null, comments: [] }, reviews: [] }
+    );
+
+    function createContributionRows() {
+      let content = "";
+
+      if (!sorted) {
+        return "";
+      }
+
+      function generateContributionRow(
+        view: string,
+        contribution: string,
+        count: number,
+        reward: number | Decimal | undefined
+      ) {
+        return `
+          <tr>
+            <td>${view}</td>
+            <td>${contribution}</td>
+            <td>${count}</td>
+            <td>${reward || "-"}</td>
+          </tr>`;
+      }
+
+      if (result.task?.reward) {
+        content += generateContributionRow("Issue", "Task", 1, result.task.reward);
+      }
+      if (sorted.issues.task) {
+        content += generateContributionRow("Issue", "Specification", 1, sorted.issues.task.score?.reward);
+      }
+      if (sorted.issues.comments.length) {
+        content += generateContributionRow(
+          "Issue",
+          "Comment",
+          sorted.issues.comments.length,
+          sorted.issues.comments.reduce((acc, curr) => acc.add(curr.score?.reward ?? 0), new Decimal(0))
+        );
+      }
+      if (sorted.reviews.length) {
+        content += generateContributionRow(
+          "Review",
+          "Comment",
+          sorted.reviews.length,
+          sorted.reviews.reduce((acc, curr) => acc.add(curr.score?.reward ?? 0), new Decimal(0))
+        );
+      }
+      return content;
+    }
+
+    function createIncentiveRows() {
+      let content = "";
+
+      if (!sorted) {
+        return "";
+      }
+
+      function buildIncentiveRow(commentScore: GithubCommentScore) {
+        // Properly escape carriage returns for HTML rendering
+        const formatting = stringify(commentScore.score?.formatting?.content).replace(/[\n\r]/g, "&#13;");
+        return `
+          <tr>
+            <td>
+              <h6>
+                <a href="${commentScore.url}" target="_blank" rel="noopener">${commentScore.content.replace(/(.{64})..+/, "$1…")}</a>
+              </h6>
+            </td>
+            <td>
+            <details>
+              <summary>
+                ${Object.values(commentScore.score?.formatting?.content || {}).reduce((acc, curr) => {
+                  return acc.add(curr.score * curr.count);
+                }, new Decimal(0))}
+              </summary>
+              <pre>${formatting}</pre>
+             </details>
+            </td>
+            <td>${commentScore.score?.relevance || "-"}</td>
+            <td>${commentScore.score?.reward || "-"}</td>
+          </tr>`;
+      }
+
+      for (const issueComment of sorted.issues.comments) {
+        content += buildIncentiveRow(issueComment);
+      }
+      for (const reviewComment of sorted.reviews) {
+        content += buildIncentiveRow(reviewComment);
+      }
+      return content;
+    }
+
+    return `
+    <details>
+      <summary>
+        <b>
+          <h3>
+            <a href="${result.permitUrl}" target="_blank" rel="noopener">
+              [ ${result.total} ${getPayoutConfigByNetworkId(program.opts().evmNetworkId).symbol} ]
+            </a>
+          </h3>
+          <h6>
+            @${username}
+          </h6>
+        </b>
+      </summary>
+      <h6>Contributions Overview</h6>
+      <table>
+        <thead>
+          <tr>
+            <th>View</th>
+            <th>Contribution</th>
+            <th>Count</th>
+            <th>Reward</th>
+          </tr>
+        </thead>
+        <tbody>
+          ${createContributionRows()}
+        </tbody>
+      </table>
+      <h6>Conversation Incentives</h6>
+      <table>
+        <thead>
+          <tr>
+            <th>Comment</th>
+            <th>Formatting</th>
+            <th>Relevance</th>
+            <th>Reward</th>
+          </tr>
+        </thead>
+        <tbody>
+          ${createIncentiveRows()}
+        </tbody>
+      </table>
+    </details>
+    `
+      .replace(/\s+/g, " ")
+      .trim();
+  }
+}

src/parser/permit-generation-module.ts

@@ -9,13 +9,15 @@ import {
   generatePayoutPermit,
   SupportedEvents,
   TokenType,
-} from "@ubiquibot/permit-generation";
+} from "@ubiquibot/permit-generation/core";
 import configuration from "../configuration/config-reader";
 import permitGenerationConfigurationType, {
   PermitGenerationConfiguration,
 } from "../configuration/permit-generation-configuration";
 import { getOctokitInstance } from "../get-authentication-token";
 import { IssueActivity } from "../issue-activity";
+import envConfigSchema from "../types/env-type";
+import program from "./command-line";
 import { Module, Result } from "./processor";
 
 interface Payload {
@@ -30,12 +32,21 @@ export class PermitGenerationModule implements Module {
   readonly _supabase = createClient<Database>(process.env.SUPABASE_URL, process.env.SUPABASE_KEY);
 
   async transform(data: Readonly<IssueActivity>, result: Result): Promise<Result> {
-    const payload: Context["payload"] & Payload = context.payload.inputs;
+    const payload: Context["payload"] & Payload = {
+      ...context.payload.inputs,
+      issueUrl: program.opts().issue,
+      evmPrivateEncrypted: program.opts().evmPrivateEncrypted,
+      evmNetworkId: program.opts().evmNetworkId,
+    };
     const issueId = Number(payload.issueUrl.match(/[0-9]+$/)?.[1]);
     payload.issue = {
       id: issueId,
     };
     const env = process.env;
+    if (!Value.Check(envConfigSchema, env)) {
+      console.warn("[PermitGenerationModule] Invalid env detected, skipping.");
+      return Promise.resolve(result);
+    }
     const eventName = context.eventName as SupportedEvents;
     const octokit = getOctokitInstance();
     const logger = {