Merge branch 'feat/contributor-incentives-total-scoring' of https://g…

…ithub.com/pavlovcik/ubiquibot into feat/contributor-incentives-total-scoring
ubiquity-whilefoo · Nov 17, 2023 · 1d6da4b · 1d6da4b
2 parents 82450db + d00946c
commit 1d6da4b
Show file tree

Hide file tree

Showing 6 changed files with 83 additions and 61 deletions.
diff --git a/src/handlers/comment/handlers/issue/allCommentScoring.ts b/src/handlers/comment/handlers/issue/allCommentScoring.ts
@@ -17,11 +17,11 @@ export async function allCommentScoring({
   const usersByClass = await sortUsersByClass(context, issue, comments);
   const commentsByClass = sortCommentsByClass(usersByClass, comments, view);
   const contributionClasses = Object.keys(usersByClass).map((key) => key as ContributorClassesKeys);
-
   return contributionClasses
     .filter((className: string) => className.endsWith("Comment"))
     .flatMap((contributionStyle) => {
-      const scoring = commentScoringByContributionClass[contributionStyle];
+      const commentsOfRole = commentsByClass[contributionStyle as keyof typeof commentsByClass];
+      const scoring = commentScoringByContributionClass[contributionStyle]();
 
       const selection = usersByClass[contributionStyle as keyof typeof usersByClass];
 
@@ -33,12 +33,16 @@ export async function allCommentScoring({
       // Ensure selection is always an array
       const users = Array.isArray(selection) ? selection : [selection];
 
-      return users.flatMap((user) => {
-        const commentsOfRole = commentsByClass[contributionStyle as keyof typeof commentsByClass];
+      users.forEach((user) => {
         if (!commentsOfRole) {
           return [];
         }
-        return perUserCommentScoring(user, commentsOfRole, scoring);
+        perUserCommentScoring(
+          user,
+          commentsOfRole.filter((comment) => comment.user.id === user.id),
+          scoring
+        );
       });
+      return scoring;
     });
 }
diff --git a/src/handlers/comment/handlers/issue/comment-scoring-by-contribution-style.ts b/src/handlers/comment/handlers/issue/comment-scoring-by-contribution-style.ts
@@ -4,53 +4,62 @@ import { ContributorClasses } from "./contribution-style-types";
 export const commentScoringByContributionClass = {
   // TODO: make this configurable
 
-  "Issue Assignee Task": new CommentScoring({
-    contributionClass: "Issue Assignee Task",
-    formattingMultiplier: 0,
-    wordValue: 0,
-  }),
+  "Issue Assignee Task": () =>
+    new CommentScoring({
+      contributionClass: "Issue Assignee Task",
+      formattingMultiplier: 0,
+      wordValue: 0,
+    }),
 
-  "Issue Issuer Comment": new CommentScoring({
-    contributionClass: "Issue Issuer Comment",
-    formattingMultiplier: 1,
-    wordValue: 0.2,
-  }),
-  "Issue Assignee Comment": new CommentScoring({
-    contributionClass: "Issue Assignee Comment",
-    formattingMultiplier: 0,
-    wordValue: 0,
-  }),
+  "Issue Issuer Comment": () =>
+    new CommentScoring({
+      contributionClass: "Issue Issuer Comment",
+      formattingMultiplier: 1,
+      wordValue: 0.2,
+    }),
+  "Issue Assignee Comment": () =>
+    new CommentScoring({
+      contributionClass: "Issue Assignee Comment",
+      formattingMultiplier: 0,
+      wordValue: 0,
+    }),
 
-  "Issue Collaborator Comment": new CommentScoring({
-    contributionClass: "Issue Collaborator Comment",
-    formattingMultiplier: 1,
-    wordValue: 0.1,
-  }),
-  "Issue Contributor Comment": new CommentScoring({
-    contributionClass: "Issue Contributor Comment",
-    formattingMultiplier: 0.25,
-    wordValue: 0.1,
-  }),
-  "Review Issuer Comment": new CommentScoring({
-    contributionClass: "Review Issuer Comment",
-    formattingMultiplier: 2,
-    wordValue: 0.2,
-  }),
-  "Review Assignee Comment": new CommentScoring({
-    contributionClass: "Review Assignee Comment",
-    formattingMultiplier: 1,
-    wordValue: 0.1,
-  }),
-  "Review Collaborator Comment": new CommentScoring({
-    contributionClass: "Review Collaborator Comment",
-    formattingMultiplier: 1,
-    wordValue: 0.1,
-  }),
-  "Review Contributor Comment": new CommentScoring({
-    contributionClass: "Review Contributor Comment",
-    formattingMultiplier: 0.25,
-    wordValue: 0.1,
-  }),
+  "Issue Collaborator Comment": () =>
+    new CommentScoring({
+      contributionClass: "Issue Collaborator Comment",
+      formattingMultiplier: 1,
+      wordValue: 0.1,
+    }),
+  "Issue Contributor Comment": () =>
+    new CommentScoring({
+      contributionClass: "Issue Contributor Comment",
+      formattingMultiplier: 0.25,
+      wordValue: 0.1,
+    }),
+  "Review Issuer Comment": () =>
+    new CommentScoring({
+      contributionClass: "Review Issuer Comment",
+      formattingMultiplier: 2,
+      wordValue: 0.2,
+    }),
+  "Review Assignee Comment": () =>
+    new CommentScoring({
+      contributionClass: "Review Assignee Comment",
+      formattingMultiplier: 1,
+      wordValue: 0.1,
+    }),
+  "Review Collaborator Comment": () =>
+    new CommentScoring({
+      contributionClass: "Review Collaborator Comment",
+      formattingMultiplier: 1,
+      wordValue: 0.1,
+    }),
+  "Review Contributor Comment": () =>
+    new CommentScoring({
+      contributionClass: "Review Contributor Comment",
+      formattingMultiplier: 0.25,
+      wordValue: 0.1,
+    }),
   // end comments
   // "Issue Issuer Specification": new CommentScoring({
   //   contributionClass: "Issue Issuer Specification",
@@ -97,5 +106,5 @@ export const commentScoringByContributionClass = {
   //   wordValue: 1,
   // }),
 } as {
-  [key in keyof ContributorClasses]: CommentScoring;
+  [key in keyof ContributorClasses]: () => CommentScoring;
 };
diff --git a/src/handlers/comment/handlers/issue/evaluate-comments.ts b/src/handlers/comment/handlers/issue/evaluate-comments.ts
@@ -29,7 +29,6 @@ export async function commentsScoring({
   const userScoreDetails = formattingWithRelevance.reduce((acc, commentScoring) => {
     for (const userId in commentScoring.commentScores) {
       const userScore = commentScoring.commentScores[userId];
-      if (!userScore.details[userId]) continue;
 
       const userScoreDetail: UserScoreDetails = {
         score: userScore.totalScoreTotal,
@@ -44,7 +43,7 @@ export async function commentsScoring({
         },
         source: {
           issue,
-          user: userScore.details[userId].comment.user,
+          user: Object.values(userScore.details)[0].comment.user,
         },
       };
 

diff --git a/src/handlers/comment/handlers/issue/generate-permits.ts b/src/handlers/comment/handlers/issue/generate-permits.ts
@@ -4,7 +4,7 @@ import { stringify } from "yaml";
 import Runtime from "../../../../bindings/bot-runtime";
 import { getPayoutConfigByNetworkId } from "../../../../helpers";
 import { getTokenSymbol } from "../../../../helpers/contracts";
-import { Context } from "../../../../types";
+import { Context, Issue, Payload } from "../../../../types";
 import structuredMetadata from "../../../shared/structured-metadata";
 import { generatePermit2Signature } from "./generate-permit-2-signature";
 import { UserScoreTotals } from "./issue-shared-types";
@@ -22,18 +22,19 @@ async function generateComment(context: Context, totals: TotalsById) {
   const {
     keys: { evmPrivateEncrypted },
   } = context.config;
+  const payload = context.event.payload as Payload;
+  const issue = payload.issue as Issue;
   const { rpc, paymentToken } = getPayoutConfigByNetworkId(context.config.payments.evmNetworkId);
 
-  const contributionsOverviewTable = generateContributionsOverview(totals);
-  const conversationIncentivesTable = generateDetailsTable(totals);
-
   const tokenSymbol = await getTokenSymbol(paymentToken, rpc);
   const HTMLs = [] as string[];
 
   const permits = [];
 
   for (const userId in totals) {
     const userTotals = totals[userId];
+    const contributionsOverviewTable = generateContributionsOverview({ [userId]: userTotals }, issue);
+    const conversationIncentivesTable = generateDetailsTable({ [userId]: userTotals });
 
     const tokenAmount = userTotals.total;
 
@@ -92,7 +93,7 @@ function generateHtml({
   `;
 }
 
-function generateContributionsOverview(userScoreDetails: TotalsById) {
+function generateContributionsOverview(userScoreDetails: TotalsById, issue: Issue) {
   const buffer = [
     "<h6>Contributions Overview</h6>",
     "<table><thead>",
@@ -140,7 +141,14 @@ function generateContributionsOverview(userScoreDetails: TotalsById) {
         );
       }
       if (task) {
-        buffer.push(newRow("Issue", "Task", task?.toString() || "-", task?.toString() || "-"));
+        buffer.push(
+          newRow(
+            "Issue",
+            "Task",
+            issue.assignees.length === 0 ? "-" : `${(1 / issue.assignees.length).toFixed(2)}`,
+            task?.toString() || "-"
+          )
+        );
       }
     }
   }
@@ -216,6 +224,7 @@ function generateDetailsTable(totals: TotalsById) {
       }
     }
   }
+  if (tableRows === "") return "";
   return `<table><tbody><tr><td>Comment</td><td>Formatting</td><td>Relevance</td><td>Reward</td></tr>${tableRows}</tbody></table>`;
 }
 

diff --git a/src/handlers/comment/handlers/issue/identify-user-ids.ts b/src/handlers/comment/handlers/issue/identify-user-ids.ts
@@ -30,7 +30,8 @@ async function filterUsers(context: Context, issue: Issue, contributorComments:
   const contributors = humanUsersWhoCommented.filter(
     (user: User) => !allRoleUsers.some((_user) => _user?.id === user.id)
   );
-  return { issuer, assignees, collaborators, contributors };
+  const uniqueContributors = Array.from(new Map(contributors.map((user) => [user.id, user])).values());
+  return { issuer, assignees, collaborators, contributors: uniqueContributors };
 }
 
 function returnValues(

diff --git a/src/handlers/comment/handlers/issue/specification-scoring.ts b/src/handlers/comment/handlers/issue/specification-scoring.ts
@@ -28,8 +28,8 @@ export async function specificationScoring({
   const scoreDetails = addRelevanceAndFormatScoring(RELEVANT, formatting);
   for (const user in scoreDetails) {
     const userScore = scoreDetails[user];
+    if (userScore.contributionClass !== "Issue Issuer Comment") continue;
 
-    if (!userScore.commentScores[issue.user.id]) continue;
     const userScoreDetail: UserScoreDetails = {
       score: userScore.commentScores[issue.user.id].totalScoreTotal,
       view: view,