feat: add pull review parsing and reward parsing

.cspell.json

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

manifest.json

@@ -317,6 +317,27 @@
               }
             ]
           },
+          "reviewIncentivizer": {
+            "default": null,
+            "anyOf": [
+              {
+                "default": {},
+                "type": "object",
+                "properties": {
+                  "baseRate": {
+                    "type": "number"
+                  },
+                  "conclusiveReviewCredit": {
+                    "type": "number"
+                  }
+                },
+                "required": ["baseRate", "conclusiveReviewCredit"]
+              },
+              {
+                "type": "null"
+              }
+            ]
+          },
           "formattingEvaluator": {
             "default": null,
             "anyOf": [

src/configuration/review-incentivizer-config.ts

@@ -0,0 +1,11 @@
+import { Static, Type } from "@sinclair/typebox";
+
+export const reviewIncentivizerConfigurationType = Type.Object(
+  {
+    baseRate: Type.Number(),
+    conclusiveReviewCredit: Type.Number(),
+  },
+  { default: {} }
+);
+
+export type ReviewIncentivizerConfiguration = Static<typeof reviewIncentivizerConfigurationType>;

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/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[] };
@@ -164,15 +164,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,
@@ -188,6 +179,29 @@ export class GithubCommentModule extends BaseModule {
           </tr>`;
     }
 
+    if (result.task?.reward) {
+      content.push(buildContributionRow("Issue", "Task", result.task.multiplier, result.task.reward));
+    }
+
+    if (result.reviewReward) {
+      if (result.reviewReward.reviewBaseReward?.reward) {
+        content.push(buildContributionRow("Review", "Base Review", 1, result.reviewReward.reviewBaseReward.reward));
+      }
+
+      const reviewCount = result.reviewReward.reviews?.length ?? 0;
+
+      const totalReviewReward =
+        result.reviewReward.reviews?.reduce((sum, review) => sum.add(review.reward), 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));
     }
@@ -266,6 +280,36 @@ export class GithubCommentModule extends BaseModule {
     return content.join("");
   }
 
+  _createReviewRows(result: Result[0]) {
+    if (!result.reviewReward?.reviews?.length) {
+      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 rows = result.reviewReward.reviews.map(buildReviewRow).join("");
+
+    return `
+      <h6>Review Details</h6>
+      <table>
+        <thead>
+          <tr>
+            <th>Changes</th>
+            <th>Priority</th>            
+            <th>Reward</th>
+          </tr>
+        </thead>
+        <tbody>
+          ${rows}
+        </tbody>
+      </table>`;
+  }
   async _generateHtml(username: string, result: Result[0], taskReward: number, stripComments = false) {
     const sortedTasks = result.comments?.reduce<SortedTasks>(
       (acc, curr) => {
@@ -291,7 +335,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 `
@@ -326,6 +369,7 @@ export class GithubCommentModule extends BaseModule {
           ${this._createContributionRows(result, sortedTasks)}
         </tbody>
       </table>
+      ${!stripComments ? this._createReviewRows(result) : ""}
       ${
         !stripComments
           ? `<h6>Conversation Incentives</h6>

src/parser/processor.ts

@@ -13,6 +13,7 @@ import { PermitGenerationModule } from "./permit-generation-module";
 import { UserExtractorModule } from "./user-extractor-module";
 import { getTaskReward } from "../helpers/label-price-extractor";
 import { GitHubIssue } from "../github-types";
+import { ReviewIncentivizerModule } from "./review-incentivizer-module";
 
 export class Processor {
   private _transformers: Module[] = [];
@@ -25,6 +26,7 @@ export class Processor {
       .add(new DataPurgeModule(context))
       .add(new FormattingEvaluatorModule(context))
       .add(new ContentEvaluatorModule(context))
+      .add(new ReviewIncentivizerModule(context))
       .add(new PermitGenerationModule(context))
       .add(new GithubCommentModule(context));
     this._context = context;
@@ -51,7 +53,9 @@ export class Processor {
       }
       // Aggregate total result
       for (const item of Object.keys(this._result)) {
-        this._result[item].total = this._sumRewards(this._result[item], this._getRewardsLimit(data.self));
+        if (item === data.self?.assignee?.login) {
+          this._result[item].total = this._sumRewards(this._result[item], this._getRewardsLimit(data.self) * 3);
+        } else this._result[item].total = this._sumRewards(this._result[item], this._getRewardsLimit(data.self));
       }
     }
     return this._result;
@@ -70,17 +74,16 @@ export class Processor {
 
   _sumRewards(obj: Record<string, unknown>, taskRewardLimit = Infinity) {
     let totalReward = new Decimal(0);
-
     for (const [key, value] of Object.entries(obj)) {
       if (key === "reward" && typeof value === "number") {
-        totalReward = totalReward.add(Math.min(value, taskRewardLimit));
+        totalReward = totalReward.add(value);
       } else if (typeof value === "object") {
         totalReward = totalReward.add(
           Math.min(this._sumRewards(value as Record<string, unknown>, taskRewardLimit), taskRewardLimit)
         );
       }
     }
 
-    return totalReward.toNumber();
+    return Math.min(totalReward.toNumber(), taskRewardLimit);
   }
 }