feat: gh projects v2 to GraphQL (#267)

* feat: Moved GitHub Projects API usage from REST to GraphQL

* Update src/utils/github/getProjectsApi.js

* Update src/utils/github/getProjectsApi.js

---------

Co-authored-by: Eddie Jaoude <[email protected]>

Author: SaptarshiSarkar12

README.md

@@ -1,6 +1,6 @@
 > [!NOTE]
 > This project is sponsored by the Open Source project Flagsmith https://github.com/Flagsmith/flagsmith
-> 
+>
 > Feature flags have so many benefits, remote config, testing in production and so much more!
 
 # HealthCheck

package-lock.json

@@ -25,6 +25,7 @@
     "@auth/prisma-adapter": "^2.4.2",
     "@headlessui/react": "^2.1.5",
     "@heroicons/react": "^2.1.5",
+    "@octokit/graphql": "^8.1.1",
     "@octokit/rest": "^21.0.0",
     "@prisma/client": "^5.19.0",
     "@tailwindcss/aspect-ratio": "^0.4.2",

package.json

@@ -46,7 +46,7 @@ export default function checks(data, ignoreChecks = []) {
     pullRequestTemplate(data.communityMetrics),
     codeOfConduct(data.communityMetrics),
     labels(data.labels),
-    // projects(data.repo, data.projects),
+    projects(data.repo, data.projects),
   ];
 
   const userChecks = filterIgnoredChecks(allChecks, ignoreChecks);

src/utils/checks/index.js

@@ -11,14 +11,18 @@ export default function projects(repo, projectsData) {
     response.extra = "No action required.";
   }
 
-  if (repo.has_projects && projectsData.length > 0) {
+  const filteredProjectsData = projectsData.filter(
+    (project) => !project.closed,
+  ); // filter out closed projects
+
+  if (repo.has_projects && filteredProjectsData.length > 0) {
     response.status = "success";
     response.description =
       "You have project boards enabled and it is being used.";
     response.extra = "No action required.";
   }
 
-  if (repo.has_projects && projectsData.length === 0) {
+  if (repo.has_projects && filteredProjectsData.length === 0) {
     response.status = "error";
     response.description =
       "You have project boards enabled but it is not being used.";

src/utils/checks/projects.js

@@ -1,21 +1,41 @@
-import { Octokit } from "@octokit/rest";
+import { graphql } from "@octokit/graphql";
 import extractOwnerRepo from "./extractOwnerRepo";
 
 export default async function getProjectsApi(url, token) {
   // get owner and repo name from url
   const { owner, repo } = extractOwnerRepo(url);
 
   // get data from github api using user's API
-  const octokit = new Octokit({
-    auth: token,
+  const octokit = graphql.defaults({
+    headers: {
+      authorization: `token ${token}`,
+    },
   });
   let response;
   try {
-    response = await octokit.rest.projects.listForRepo({
-      owner,
-      repo,
-      state: "open",
-    });
+    response = await octokit(
+      `
+      query($owner: String!, $repo: String!) {
+        repository(owner: $owner, name: $repo) {
+          projectsV2(first: 10) {
+            nodes {
+              id
+              title
+              closed
+            }
+          }
+        }
+      }
+      `,
+      {
+        owner,
+        repo,
+      },
+    );
+    response = {
+      status: 200,
+      data: response.repository.projectsV2.nodes,
+    };
   } catch (e) {
     console.error(e);
     response = {