feat: add pull review parsing and reward parsing

.cspell.json

@@ -16,6 +16,7 @@
   "language": "en",
   "words": [
     "dataurl",
+    "Incentivizer",
     "devpool",
     "outdir",
     "servedir",

README.md

@@ -104,6 +104,9 @@ with:
       redeemTask: true
     dataPurge:
       skipCommentsWhileAssigned: all
+    reviewIncentivizer:
+      baseRate: 100
+      conclusiveReviewCredit: 25
     formattingEvaluator:
       wordCountExponent: 0.85
       multipliers:

manifest.json

@@ -324,6 +324,30 @@
               }
             ]
           },
+          "reviewIncentivizer": {
+            "default": null,
+            "anyOf": [
+              {
+                "default": {},
+                "type": "object",
+                "properties": {
+                  "baseRate": {
+                    "default": 100,
+                    "description": "Number of lines of code that equals $1 in review credit",
+                    "type": "number"
+                  },
+                  "conclusiveReviewCredit": {
+                    "default": 25,
+                    "description": "Flat rate bonus in dollars for completing a conclusive review i.e (Approved or Changes Requested)",
+                    "type": "number"
+                  }
+                }
+              },
+              {
+                "type": "null"
+              }
+            ]
+          },
           "formattingEvaluator": {
             "default": null,
             "anyOf": [

package.json

@@ -41,6 +41,7 @@
     "js-tiktoken": "1.0.15",
     "jsdom": "24.0.0",
     "markdown-it": "14.1.0",
+    "minimatch": "^10.0.1",
     "openai": "4.56.0",
     "yaml": "^2.6.1"
   },

src/configuration/review-incentivizer-config.ts

@@ -0,0 +1,23 @@
+import { Static, Type } from "@sinclair/typebox";
+
+export const reviewIncentivizerConfigurationType = Type.Object(
+  {
+    /**
+     * Number of lines of code that equals $1 in review credit
+     */
+    baseRate: Type.Number({
+      default: 100,
+      description: "Number of lines of code that equals $1 in review credit",
+    }),
+    /**
+     * Flat rate bonus in dollars for completing a conclusive review i.e (Approved or Changes Requested)
+     */
+    conclusiveReviewCredit: Type.Number({
+      default: 25,
+      description: "Flat rate bonus in dollars for completing a conclusive review i.e (Approved or Changes Requested)",
+    }),
+  },
+  { default: {} }
+);
+
+export type ReviewIncentivizerConfiguration = Static<typeof reviewIncentivizerConfigurationType>;

src/data-collection/collect-linked-pulls.ts

@@ -30,5 +30,7 @@ export async function collectLinkedMergedPulls(context: ContextPlugin, issue: Is
     issue_number,
   });
 
-  return result.repository.issue.closedByPullRequestsReferences.edges.map((edge) => edge.node);
+  return result.repository.issue.closedByPullRequestsReferences.edges
+    .map((edge) => edge.node)
+    .filter((pull) => pull.state === "MERGED");
 }

src/helpers/excluded-files.ts

@@ -0,0 +1,75 @@
+import { ContextPlugin } from "../types/plugin-input";
+
+interface GitAttributes {
+  pattern: string;
+  attributes: { [key: string]: string | boolean };
+}
+
+async function parseGitAttributes(content: string): Promise<GitAttributes[]> {
+  const lines = content.split("\n");
+  return lines
+    .map((line) => {
+      line = line.trim();
+      if (!line || line.startsWith("#")) return null;
+
+      const parts = line.split(/\s+/);
+      if (parts.length < 2) return null;
+
+      const pattern = parts[0];
+      const attributes: { [key: string]: string | boolean } = {};
+
+      for (let i = 1; i < parts.length; i++) {
+        const attr = parts[i];
+        if (attr.includes("=")) {
+          const [key, value] = attr.split("=");
+          attributes[key.trim()] = value.trim();
+        } else {
+          attributes[attr.trim()] = true;
+        }
+      }
+
+      return { pattern, attributes };
+    })
+    .filter((item): item is GitAttributes => item !== null);
+}
+
+export async function getExcludedFiles(context: ContextPlugin, owner: string, repo: string) {
+  const gitAttributesContent = await getFileContent(context, ".gitattributes", owner, repo);
+  if (!gitAttributesContent) {
+    return null;
+  }
+  const gitAttributesLinguistGenerated = (await parseGitAttributes(gitAttributesContent))
+    .filter((v) => v.attributes["linguist-generated"])
+    .map((v) => v.pattern);
+
+  return gitAttributesLinguistGenerated;
+}
+
+async function getFileContent(
+  context: ContextPlugin,
+  path: string,
+  owner: string,
+  repo: string
+): Promise<string | null> {
+  try {
+    const response = await context.octokit.rest.repos.getContent({
+      owner,
+      repo,
+      path,
+    });
+
+    // GitHub API returns content as base64
+    if ("content" in response.data && !Array.isArray(response.data)) {
+      return Buffer.from(response.data.content, "base64").toString("utf-8");
+    }
+    return null;
+  } catch (err) {
+    if (err instanceof Error && "status" in err && err.status === 404) {
+      context.logger.error(
+        `.gitattributes was not found for ${context.payload.repository.owner.login}/${context.payload.repository.name}`
+      );
+      return null;
+    }
+    throw context.logger.error(`Error fetching files to be excluded ${err}`);
+  }
+}

src/helpers/github.ts

@@ -1,5 +1,22 @@
 import * as github from "@actions/github";
+import { GitHubIssue } from "../github-types";
 
 export function getGithubWorkflowRunUrl() {
   return `${github.context.payload.repository?.html_url}/actions/runs/${github.context.runId}`;
 }
+
+export function parsePriorityLabel(labels: GitHubIssue["labels"] | undefined) {
+  if (!labels) return 1;
+
+  for (const label of labels) {
+    const priorityLabel = typeof label === "string" ? label : (label.name ?? "");
+    const matched = priorityLabel.match(/^Priority:\s*(\d+)/i);
+
+    if (matched) {
+      const urgency = Number(matched[1]);
+      if (urgency) return urgency;
+    }
+  }
+
+  return 1;
+}

src/issue-activity.ts

@@ -53,8 +53,9 @@ export class IssueActivity {
 
   private async _getLinkedReviews(): Promise<Review[]> {
     this._context.logger.debug("Trying to fetch linked pull-requests for", this._issueParams);
-    const pulls = (await collectLinkedMergedPulls(this._context, this._issueParams)).slice(-1);
-    this._context.logger.debug("Collected linked pull-requests", { pulls });
+    const pulls = await collectLinkedMergedPulls(this._context, this._issueParams);
+    this._context.logger.debug(`Collected linked pull-requests ${pulls.map((v) => v.number)}`);
+
     const promises = pulls
       .map(async (pull) => {
         const repository = pull.repository;

src/parser/formatting-evaluator-module.ts

@@ -14,7 +14,7 @@ import { BaseModule } from "../types/module";
 import { GithubCommentScore, Result, WordResult } from "../types/results";
 import { typeReplacer } from "../helpers/result-replacer";
 import { ContextPlugin } from "../types/plugin-input";
-import { GitHubIssue } from "../github-types";
+import { parsePriorityLabel } from "../helpers/github";
 
 interface Multiplier {
   multiplier: number;
@@ -69,7 +69,7 @@ export class FormattingEvaluatorModule extends BaseModule {
         const { formatting, words } = this._getFormattingScore(comment);
         const multiplierFactor = this._multipliers?.[comment.type] ?? { multiplier: 0 };
         const formattingTotal = this._calculateFormattingTotal(formatting, words, multiplierFactor).toDecimalPlaces(2);
-        const priority = this._parsePriorityLabel(data.self?.labels);
+        const priority = parsePriorityLabel(data.self?.labels);
         const reward = (comment.score?.reward ? formattingTotal.add(comment.score.reward) : formattingTotal).toNumber();
         comment.score = {
           ...comment.score,
@@ -192,20 +192,4 @@ export class FormattingEvaluatorModule extends BaseModule {
 
     return { formatting, words };
   }
-
-  _parsePriorityLabel(labels: GitHubIssue["labels"] | undefined) {
-    if (!labels) return 1;
-
-    for (const label of labels) {
-      const priorityLabel = typeof label === "string" ? label : (label.name ?? "");
-      const matched = priorityLabel.match(/^Priority:\s*(\d+)/i);
-
-      if (matched) {
-        const urgency = Number(matched[1]);
-        if (urgency) return urgency;
-      }
-    }
-
-    return 1;
-  }
 }

src/parser/github-comment-module.ts

@@ -15,7 +15,7 @@ import { removeKeyFromObject, typeReplacer } from "../helpers/result-replacer";
 import { getErc20TokenSymbol } from "../helpers/web3";
 import { IssueActivity } from "../issue-activity";
 import { BaseModule } from "../types/module";
-import { GithubCommentScore, Result } from "../types/results";
+import { GithubCommentScore, Result, ReviewScore } from "../types/results";
 
 interface SortedTasks {
   issues: { specification: GithubCommentScore | null; comments: GithubCommentScore[] };
@@ -134,15 +134,6 @@ export class GithubCommentModule extends BaseModule {
 
   _createContributionRows(result: Result[0], sortedTasks: SortedTasks | undefined) {
     const content: string[] = [];
-
-    if (result.task?.reward) {
-      content.push(buildContributionRow("Issue", "Task", result.task.multiplier, result.task.reward));
-    }
-
-    if (!sortedTasks) {
-      return content.join("");
-    }
-
     function buildContributionRow(
       view: string,
       contribution: string,
@@ -158,6 +149,48 @@ export class GithubCommentModule extends BaseModule {
           </tr>`;
     }
 
+    if (result.task?.reward) {
+      content.push(buildContributionRow("Issue", "Task", result.task.multiplier, result.task.reward));
+    }
+
+    if (result.reviewRewards) {
+      result.reviewRewards.forEach((reviewReward) => {
+        const reviewRewardPullNumber = reviewReward.url.split("/").slice(-1)[0];
+        if (reviewReward.reviewBaseReward?.reward) {
+          content.push(
+            buildContributionRow(
+              "Review",
+              `Base Review for&nbsp;<a href="${reviewReward.url}" target="_blank" rel="noopener">#${reviewRewardPullNumber}</a>`,
+              1,
+              reviewReward.reviewBaseReward?.reward
+            )
+          );
+        }
+      });
+
+      const reviewCount = result.reviewRewards.reduce(
+        (total, reviewReward) => total + (reviewReward.reviews?.length ?? 0),
+        0
+      );
+
+      const totalReviewReward = result.reviewRewards.reduce(
+        (sum, reviewReward) =>
+          sum.add(
+            reviewReward.reviews?.reduce((subSum, review) => subSum.add(review.reward), new Decimal(0)) ??
+              new Decimal(0)
+          ),
+        new Decimal(0)
+      );
+
+      if (reviewCount > 0) {
+        content.push(buildContributionRow("Review", "Code Review", reviewCount, totalReviewReward.toNumber()));
+      }
+    }
+
+    if (!sortedTasks) {
+      return content.join("");
+    }
+
     if (sortedTasks.issues.specification) {
       content.push(buildContributionRow("Issue", "Specification", 1, sortedTasks.issues.specification.score?.reward));
     }
@@ -236,6 +269,43 @@ export class GithubCommentModule extends BaseModule {
     return content.join("");
   }
 
+  _createReviewRows(result: Result[0]) {
+    if (result.reviewRewards?.every((reviewReward) => reviewReward.reviews?.length === 0) || !result.reviewRewards) {
+      return "";
+    }
+
+    function buildReviewRow(review: ReviewScore) {
+      return `
+        <tr>
+          <td>+${review.effect.addition} -${review.effect.deletion}</td>
+          <td>${review.priority ?? "-"}</td>
+          <td>${review.reward}</td>
+        </tr>`;
+    }
+
+    const reviewTables = result.reviewRewards
+      .filter((reviewReward) => reviewReward.reviews && reviewReward.reviews.length > 0)
+      .map((reviewReward) => {
+        const rows = reviewReward.reviews?.map(buildReviewRow).join("") ?? "";
+        return `
+          <h6>Review Details for&nbsp;<a href="${reviewReward.url}" target="_blank" rel="noopener">#${reviewReward.url.split("/").slice(-1)[0]}</a></h6>
+          <table>
+            <thead>
+              <tr>
+                <th>Changes</th>
+                <th>Priority</th>
+                <th>Reward</th>
+              </tr>
+            </thead>
+            <tbody>
+              ${rows}
+            </tbody>
+          </table>`;
+      })
+      .join("");
+
+    return reviewTables;
+  }
   async _generateHtml(username: string, result: Result[0], taskReward: number, stripComments = false) {
     const sortedTasks = result.comments?.reduce<SortedTasks>(
       (acc, curr) => {
@@ -261,7 +331,6 @@ export class GithubCommentModule extends BaseModule {
     const rewardsSum =
       result.comments?.reduce<Decimal>((acc, curr) => acc.add(curr.score?.reward ?? 0), new Decimal(0)) ??
       new Decimal(0);
-    // The task reward can be 0 if either there is no pricing tag or if there is no assignee
     const isCapped = taskReward > 0 && rewardsSum.gt(taskReward);
 
     return `
@@ -296,6 +365,7 @@ export class GithubCommentModule extends BaseModule {
           ${this._createContributionRows(result, sortedTasks)}
         </tbody>
       </table>
+      ${!stripComments ? this._createReviewRows(result) : ""}
       ${
         !stripComments
           ? `<h6>Conversation Incentives</h6>