Implement handling RFCs

.env.example

@@ -4,3 +4,7 @@ TWITTER_API_KEY=
 TWITTER_API_KEY_SECRET=
 TWITTER_ACCESS_TOKEN=
 TWITTER_ACCESS_TOKEN_SECRET=
+
+DEVPOOL_OWNER_NAME=ubiquity
+DEVPOOL_REPO_NAME=devpool-directory
+RFC=0

.github/workflows/jest-testing.yml

@@ -14,6 +14,9 @@ env:
   TWITTER_API_KEY_SECRET: "<twitter_api_secret>"
   TWITTER_ACCESS_TOKEN: "<twitter_access_token>"
   TWITTER_ACCESS_TOKEN_SECRET: "<twitter_access_token_secret>"
+  DEVPOOL_OWNER_NAME: ubiquity
+  DEVPOOL_REPO_NAME: devpool-directory
+  RFC: 0
 
 jobs:
   testing:

.github/workflows/sync-issues.yml

@@ -46,6 +46,9 @@ jobs:
           TWITTER_API_KEY_SECRET: ${{ secrets.TWITTER_API_KEY_SECRET }}
           TWITTER_ACCESS_TOKEN: ${{ secrets.TWITTER_ACCESS_TOKEN }}
           TWITTER_ACCESS_TOKEN_SECRET: ${{ secrets.TWITTER_ACCESS_TOKEN_SECRET }}
+          DEVPOOL_OWNER_NAME: ubiquity
+          DEVPOOL_REPO_NAME: devpool-directory
+          RFC: 0
         run: npx tsx index.ts
 
       - uses: actions/upload-artifact@v4

helpers/github.ts

@@ -7,6 +7,16 @@ import { writeFile } from "fs/promises";
 import twitter from "./twitter";
 import { TwitterMap } from "..";
 
+// Usually
+export const DEVPOOL_OWNER_NAME = process.env.DEVPOOL_OWNER_NAME;
+export const DEVPOOL_REPO_NAME = process.env.DEVPOOL_REPO_NAME;
+export const IS_RFC = process.env.RFC == "1";
+
+// For rfc-issue-handler.test.ts
+// export const DEVPOOL_OWNER_NAME = "ubiquity";
+// export const DEVPOOL_REPO_NAME = "devpool-rfc";
+// export const IS_RFC = true;
+
 export type GitHubIssue = RestEndpointMethodTypes["issues"]["get"]["response"]["data"];
 export type GitHubLabel = RestEndpointMethodTypes["issues"]["listLabelsOnIssue"]["response"]["data"][0];
 
@@ -23,8 +33,6 @@ export const projects = _projects as {
   category?: Record<string, string>;
 };
 
-export const DEVPOOL_OWNER_NAME = "ubiquity";
-export const DEVPOOL_REPO_NAME = "devpool-directory";
 export enum LABELS {
   PRICE = "Price",
   UNAVAILABLE = "Unavailable",
@@ -129,12 +137,24 @@ export function getDevpoolIssueLabels(issue: GitHubIssue, projectUrl: string) {
   // get owner and repo name from issue's URL because the repo name could be updated
   const [ownerName, repoName] = getRepoCredentials(issue.html_url);
 
+  const pricing = getIssuePriceLabel(issue)
+
+  let devpoolIssueLabels: string[];
+
   // default labels
-  const devpoolIssueLabels = [
-    getIssuePriceLabel(issue), // price
-    `Partner: ${ownerName}/${repoName}`, // partner
-    `id: ${issue.node_id}`, // id
-  ];
+  if (pricing != "Pricing: not set") {
+    devpoolIssueLabels = [
+      pricing,
+      `Partner: ${ownerName}/${repoName}`, // partner
+      `id: ${issue.node_id}`, // id
+    ];
+  }
+  else {
+    devpoolIssueLabels = [
+      `Partner: ${ownerName}/${repoName}`, // partner
+      `id: ${issue.node_id}`, // id
+    ];
+  }
 
   // if project is already assigned then add the "Unavailable" label
   if (issue.assignee?.login) devpoolIssueLabels.push(LABELS.UNAVAILABLE);
@@ -380,8 +400,10 @@ export async function createDevPoolIssue(projectIssue: GitHubIssue, projectUrl:
   // if the project issue is assigned to someone, then skip it
   if (projectIssue.assignee) return;
 
-  // if issue doesn't have the "Price" label then skip it, no need to pollute repo with draft issues
-  if (!(projectIssue.labels as GitHubLabel[]).some((label) => label.name.includes(LABELS.PRICE))) return;
+  // check if the issue is the same type as it should be
+  const hasPriceLabel = (projectIssue.labels as GitHubLabel[]).some((label) => label.name.includes(LABELS.PRICE));
+  const hasCorrectPriceLabel = (IS_RFC && !hasPriceLabel) || (!IS_RFC && hasPriceLabel)
+  if (!hasCorrectPriceLabel) return;
 
   // create a new issue
   try {
@@ -399,15 +421,17 @@ export async function createDevPoolIssue(projectIssue: GitHubIssue, projectUrl:
       return;
     }
 
-    // post to social media
-    try {
-      const socialMediaText = getSocialMediaText(createdIssue.data);
-      const tweetId = await twitter.postTweet(socialMediaText);
-
-      twitterMap[createdIssue.data.node_id] = tweetId?.id ?? "";
-      await writeFile("./twitterMap.json", JSON.stringify(twitterMap));
-    } catch (err) {
-      console.error("Failed to post tweet: ", err);
+    // post to social media (only if it's not an RFC)
+    if (!IS_RFC) {
+      try {
+        const socialMediaText = getSocialMediaText(createdIssue.data);
+        const tweetId = await twitter.postTweet(socialMediaText);
+
+        twitterMap[createdIssue.data.node_id] = tweetId?.id ?? "";
+        await writeFile("./twitterMap.json", JSON.stringify(twitterMap));
+      } catch (err) {
+        console.error("Failed to post tweet: ", err);
+      }
     }
   } catch (err) {
     console.error("Failed to create new issue: ", err);
@@ -426,7 +450,7 @@ export async function handleDevPoolIssue(
   const labelRemoved = getDevpoolIssueLabels(projectIssue, projectUrl).filter((label) => label != LABELS.UNAVAILABLE);
   const originals = devpoolIssue.labels.map((label) => (label as GitHubLabel).name);
   const hasChanges = !areEqual(originals, labelRemoved);
-  const hasNoPriceLabels = !(projectIssue.labels as GitHubLabel[]).some((label) => label.name.includes(LABELS.PRICE));
+  const hasPriceLabel = (projectIssue.labels as GitHubLabel[]).some((label) => label.name.includes(LABELS.PRICE));
 
   const metaChanges = {
     // the title of the issue has changed
@@ -439,7 +463,7 @@ export async function handleDevPoolIssue(
 
   await applyMetaChanges(metaChanges, devpoolIssue, projectIssue, isFork, labelRemoved, originals);
 
-  const newState = await applyStateChanges(projectIssues, projectIssue, devpoolIssue, hasNoPriceLabels);
+  const newState = await applyStateChanges(projectIssues, projectIssue, devpoolIssue, hasPriceLabel);
 
   await applyUnavailableLabelToDevpoolIssue(
     projectIssue,
@@ -481,7 +505,11 @@ async function applyMetaChanges(
   }
 }
 
-async function applyStateChanges(projectIssues: GitHubIssue[], projectIssue: GitHubIssue, devpoolIssue: GitHubIssue, hasNoPriceLabels: boolean) {
+async function applyStateChanges(projectIssues: GitHubIssue[], projectIssue: GitHubIssue, devpoolIssue: GitHubIssue, hasPriceLabel: boolean) {
+  const hasCorrectPriceLabel = (IS_RFC && !hasPriceLabel) || (!IS_RFC && hasPriceLabel)
+
+  // console.log(hasCorrectPriceLabel)
+
   const stateChanges: StateChanges = {
     // missing in the partners
     forceMissing_Close: {
@@ -491,10 +519,16 @@ async function applyStateChanges(projectIssues: GitHubIssue[], projectIssue: Git
     },
     // no price labels set and open in the devpool
     noPriceLabels_Close: {
-      cause: hasNoPriceLabels && devpoolIssue.state === "open",
+      cause: (!IS_RFC) && (!hasCorrectPriceLabel) && devpoolIssue.state === "open",
       effect: "closed",
       comment: "Closed (no price labels)",
     },
+    // HAS price labels set and open in the RFC devpool
+    rfcPriceLabels_Close: {
+      cause: IS_RFC && (!hasCorrectPriceLabel) && devpoolIssue.state === "open",
+      effect: "closed",
+      comment: "Closed (has price labels)",
+    },
     // it's closed, been merged and still open in the devpool
     issueComplete_Close: {
       cause: projectIssue.state === "closed" && devpoolIssue.state === "open" && !!projectIssue.pull_request?.merged_at,
@@ -519,20 +553,20 @@ async function applyStateChanges(projectIssues: GitHubIssue[], projectIssue: Git
       effect: "closed",
       comment: "Closed (assigned-open)",
     },
-    // it's open, merged, unassigned, has price labels and is closed in the devpool
+    // it's open, merged, unassigned, has CORRECT price labels and is closed in the devpool
     issueReopenedMerged_Open: {
       cause:
         projectIssue.state === "open" &&
         devpoolIssue.state === "closed" &&
         !!projectIssue.pull_request?.merged_at &&
-        !hasNoPriceLabels &&
+        hasCorrectPriceLabel &&
         !projectIssue.assignee?.login,
       effect: "open",
       comment: "Reopened (merged)",
     },
-    // it's open, unassigned, has price labels and is closed in the devpool
+    // it's open, unassigned, has CORRECT price labels and is closed in the devpool
     issueUnassigned_Open: {
-      cause: projectIssue.state === "open" && devpoolIssue.state === "closed" && !projectIssue.assignee?.login && !hasNoPriceLabels,
+      cause: projectIssue.state === "open" && devpoolIssue.state === "closed" && !projectIssue.assignee?.login && hasCorrectPriceLabel,
       effect: "open",
       comment: "Reopened (unassigned)",
     },

index.ts

@@ -2,6 +2,7 @@ import dotenv from "dotenv";
 import {
   DEVPOOL_OWNER_NAME,
   DEVPOOL_REPO_NAME,
+  IS_RFC,
   getAllIssues,
   getIssueByLabel,
   getProjectUrls,
@@ -35,7 +36,7 @@ async function main() {
   }
 
   // get devpool issues
-  const devpoolIssues: GitHubIssue[] = await getAllIssues(DEVPOOL_OWNER_NAME, DEVPOOL_REPO_NAME);
+  const devpoolIssues: GitHubIssue[] = (await getAllIssues(DEVPOOL_OWNER_NAME, DEVPOOL_REPO_NAME))
 
   // aggregate projects.urls and opt settings
   const projectUrls = await getProjectUrls();
@@ -74,10 +75,12 @@ async function main() {
   }
 
   // Calculate total rewards from devpool issues
-  const { rewards, tasks } = await calculateStatistics(await getAllIssues(DEVPOOL_OWNER_NAME, DEVPOOL_REPO_NAME));
-  const statistics: Statistics = { rewards, tasks };
+  if (IS_RFC) {
+    const { rewards, tasks } = await calculateStatistics(await getAllIssues(DEVPOOL_OWNER_NAME, DEVPOOL_REPO_NAME));
+    const statistics: Statistics = { rewards, tasks };
 
-  await writeTotalRewardsToGithub(statistics);
+    await writeTotalRewardsToGithub(statistics);
+  }
 }
 
 void (async () => {

mocks/issue-devpool-template-rfc.json

@@ -0,0 +1,55 @@
+{
+  "assignee": {
+    "login": "",
+    "avatar_url": "",
+    "email": "undefined",
+    "events_url": "",
+    "followers_url": "",
+    "following_url": "",
+    "gists_url": "",
+    "gravatar_id": null,
+    "html_url": "",
+    "id": 1,
+    "name": "undefined",
+    "node_id": "",
+    "organizations_url": "",
+    "received_events_url": "",
+    "repos_url": "",
+    "site_admin": false,
+    "starred_at": "",
+    "starred_url": "",
+    "subscriptions_url": "",
+    "type": "",
+    "url": ""
+  },
+  "author_association": "NONE",
+  "closed_at": null,
+  "comments": 0,
+  "comments_url": "",
+  "created_at": "",
+  "events_url": "",
+  "html_url": "https://github.com/ubiquity/devpool-rfc/issues/1",
+  "id": 1,
+  "labels_url": "",
+  "locked": false,
+  "milestone": null,
+  "node_id": "1",
+  "number": 1,
+  "repository_url": "https://github.com/ubiquity/devpool-rfc",
+  "state": "open",
+  "title": "issue",
+  "updated_at": "",
+  "url": "",
+  "user": null,
+  "owner": "ubiquity",
+  "repo": "devpool-rfc",
+  "labels": [
+    {
+      "name": "Time: 1h"
+    },
+    {
+      "name": "id: 2"
+    }
+  ],
+  "body": "https://github.com/ubiquity/test-repo/issues/1"
+}

mocks/issue-template-rfc.json

@@ -0,0 +1,52 @@
+{
+  "assignee": {
+    "login": "",
+    "avatar_url": "",
+    "email": "undefined",
+    "events_url": "",
+    "followers_url": "",
+    "following_url": "",
+    "gists_url": "",
+    "gravatar_id": null,
+    "html_url": "",
+    "id": 1,
+    "name": "undefined",
+    "node_id": "",
+    "organizations_url": "",
+    "received_events_url": "",
+    "repos_url": "",
+    "site_admin": false,
+    "starred_at": "",
+    "starred_url": "",
+    "subscriptions_url": "",
+    "type": "",
+    "url": ""
+  },
+  "author_association": "NONE",
+  "closed_at": null,
+  "comments": 0,
+  "comments_url": "",
+  "created_at": "",
+  "events_url": "",
+  "html_url": "https://github.com/ubiquity/test-repo/issues/1",
+  "id": 2,
+  "labels_url": "",
+  "locked": false,
+  "milestone": null,
+  "node_id": "2",
+  "number": 2,
+  "repository_url": "https://github.com/ubiquity/test-repo",
+  "state": "open",
+  "title": "issue",
+  "updated_at": "",
+  "url": "",
+  "user": null,
+  "owner": "ubiquity",
+  "repo": "test-repo",
+  "labels": [
+    {
+      "name": "Time: 1h"
+    }
+  ],
+  "body": "body"
+}