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/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

@@ -23,8 +23,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",
@@ -285,8 +283,8 @@ export async function calculateStatistics(issues: GitHubIssue[]) {
 
   issues.forEach((issue) => {
     if (!issue.repository_url || !issue.html_url) return;
-    if (!issue.repository_url.includes(DEVPOOL_REPO_NAME) || !issue.html_url.includes(DEVPOOL_REPO_NAME)) return;
-    if ("repo" in issue && issue.repo != DEVPOOL_REPO_NAME) return;
+    if (!issue.repository_url.includes(process.env.DEVPOOL_REPO_NAME) || !issue.html_url.includes(process.env.DEVPOOL_REPO_NAME)) return;
+    if ("repo" in issue && issue.repo != process.env.DEVPOOL_REPO_NAME) return;
 
     const labels = issue.labels as GitHubLabel[];
     // devpool issue has unavailable label because it's assigned and so it's closed
@@ -337,8 +335,8 @@ export async function calculateStatistics(issues: GitHubIssue[]) {
 
 export async function writeTotalRewardsToGithub(statistics: Statistics) {
   try {
-    const owner = DEVPOOL_OWNER_NAME;
-    const repo = DEVPOOL_REPO_NAME;
+    const owner = process.env.DEVPOOL_OWNER_NAME;
+    const repo = process.env.DEVPOOL_REPO_NAME;
     const filePath = "total-rewards.json";
     const content = JSON.stringify(statistics, null, 2);
 
@@ -389,14 +387,16 @@ 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 = (process.env.RFC && !hasPriceLabel) || (!process.env.RFC && hasPriceLabel)
+  if (!hasCorrectPriceLabel) return;
 
   // create a new issue
   try {
     const createdIssue = await octokit.rest.issues.create({
-      owner: DEVPOOL_OWNER_NAME,
-      repo: DEVPOOL_REPO_NAME,
+      owner: process.env.DEVPOOL_OWNER_NAME,
+      repo: process.env.DEVPOOL_REPO_NAME,
       title: projectIssue.title,
       body,
       labels: getDevpoolIssueLabels(projectIssue, projectUrl),
@@ -408,15 +408,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 (!process.env.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);
@@ -435,7 +437,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
@@ -448,7 +450,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,
@@ -473,8 +475,8 @@ async function applyMetaChanges(
   if (shouldUpdate) {
     try {
       await octokit.rest.issues.update({
-        owner: DEVPOOL_OWNER_NAME,
-        repo: DEVPOOL_REPO_NAME,
+        owner: process.env.DEVPOOL_OWNER_NAME,
+        repo: process.env.DEVPOOL_REPO_NAME,
         issue_number: devpoolIssue.number,
         title: metaChanges.title ? projectIssue.title : devpoolIssue.title,
         body: metaChanges.body && !isFork ? projectIssue.html_url : projectIssue.html_url.replace("https://", "https://www."),
@@ -490,7 +492,9 @@ 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 = (process.env.RFC && !hasPriceLabel) || (!process.env.RFC && hasPriceLabel)
+
   const stateChanges: StateChanges = {
     // missing in the partners
     forceMissing_Close: {
@@ -500,10 +504,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: (!process.env.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: process.env.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,
@@ -528,20 +538,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)",
     },
@@ -559,8 +569,8 @@ async function applyStateChanges(projectIssues: GitHubIssue[], projectIssue: Git
 
       try {
         await octokit.rest.issues.update({
-          owner: DEVPOOL_OWNER_NAME,
-          repo: DEVPOOL_REPO_NAME,
+          owner: process.env.DEVPOOL_OWNER_NAME,
+          repo: process.env.DEVPOOL_REPO_NAME,
           issue_number: devpoolIssue.number,
           state: value.effect,
         });
@@ -596,8 +606,8 @@ async function applyUnavailableLabelToDevpoolIssue(
   ) {
     try {
       await octokit.rest.issues.addLabels({
-        owner: DEVPOOL_OWNER_NAME,
-        repo: DEVPOOL_REPO_NAME,
+        owner: process.env.DEVPOOL_OWNER_NAME,
+        repo: process.env.DEVPOOL_REPO_NAME,
         issue_number: devpoolIssue.number,
         labels: metaChanges.labels ? labelRemoved.concat(LABELS.UNAVAILABLE) : originals.concat(LABELS.UNAVAILABLE),
       });
@@ -607,8 +617,8 @@ async function applyUnavailableLabelToDevpoolIssue(
   } else if (projectIssue.state === "closed" && devpoolIssue.labels.some((label) => (label as GitHubLabel).name === LABELS.UNAVAILABLE)) {
     try {
       await octokit.rest.issues.removeLabel({
-        owner: DEVPOOL_OWNER_NAME,
-        repo: DEVPOOL_REPO_NAME,
+        owner: process.env.DEVPOOL_OWNER_NAME,
+        repo: process.env.DEVPOOL_REPO_NAME,
         issue_number: devpoolIssue.number,
         name: LABELS.UNAVAILABLE,
       });

index.ts

@@ -1,7 +1,5 @@
 import dotenv from "dotenv";
 import {
-  DEVPOOL_OWNER_NAME,
-  DEVPOOL_REPO_NAME,
   getAllIssues,
   getIssueByLabel,
   getProjectUrls,
@@ -35,21 +33,23 @@ async function main() {
   }
 
   // get devpool issues
-  const devpoolIssues: GitHubIssue[] = await getAllIssues(DEVPOOL_OWNER_NAME, DEVPOOL_REPO_NAME);
+  const devpoolIssues: GitHubIssue[] = (await getAllIssues(process.env.DEVPOOL_OWNER_NAME, process.env.DEVPOOL_REPO_NAME))
 
   // Calculate total rewards from open issues
-  const { rewards, tasks } = await calculateStatistics(devpoolIssues);
-  const statistics: Statistics = { rewards, tasks };
+  if (!process.env.RFC) {
+    const { rewards, tasks } = await calculateStatistics(devpoolIssues);
+    const statistics: Statistics = { rewards, tasks };
 
-  await writeTotalRewardsToGithub(statistics);
+    await writeTotalRewardsToGithub(statistics);
+  }
 
   // aggregate projects.urls and opt settings
   const projectUrls = await getProjectUrls();
 
   // aggregate all project issues
   const allProjectIssues: GitHubIssue[] = [];
 
-  const isFork = await checkIfForked(DEVPOOL_OWNER_NAME);
+  const isFork = await checkIfForked(process.env.DEVPOOL_OWNER_NAME);
 
   // for each project URL
   for (const projectUrl of projectUrls) {