refactor: github_api/projects (#536)

* refactor github_api/projects

* ran lint

Author: shine2lay

__tests__/unit/github/api.test.js

@@ -385,3 +385,78 @@ describe('getMembershipForUserInOrg', () => {
     }
   })
 })
+
+describe('projectListColumns', () => {
+  test('return correct data if no error', async () => {
+    const projectColumns = [
+      { id: '1' },
+      { id: '2' }
+    ]
+
+    const res = await GithubAPI.projectListColumns(Helper.mockContext({ projectColumns }))
+    expect(res).toEqual(['1', '2'])
+  })
+
+  test('that error are re-thrown', async () => {
+    const context = Helper.mockContext()
+    context.octokit.projects.listColumns = jest.fn().mockRejectedValue({ status: 402 })
+
+    try {
+      await GithubAPI.projectListColumns(context)
+      // Fail test if above expression doesn't throw anything.
+      expect(true).toBe(false)
+    } catch (e) {
+      expect(e.status).toBe(402)
+    }
+  })
+})
+
+describe('projectListForRepo', () => {
+  test('return correct data if no error', async () => {
+    const repoProjects = [
+      { name: 'Project One', id: 1 },
+      { name: 'Project Two', id: 2 }
+    ]
+
+    const res = await GithubAPI.projectListForRepo(Helper.mockContext({ repoProjects }))
+    expect(res).toEqual(repoProjects)
+  })
+
+  test('that error are re-thrown', async () => {
+    const context = Helper.mockContext()
+    context.octokit.projects.listForRepo = jest.fn().mockRejectedValue({ status: 402 })
+
+    try {
+      await GithubAPI.projectListForRepo(context)
+      // Fail test if above expression doesn't throw anything.
+      expect(true).toBe(false)
+    } catch (e) {
+      expect(e.status).toBe(402)
+    }
+  })
+})
+
+describe('projectListCards', () => {
+  test('return correct data if no error', async () => {
+    const projectCards = [
+      { content_url: 'testRepo/issues/1' },
+      { content_url: 'testRepo/issues/2' }
+    ]
+
+    const res = await GithubAPI.projectListCards(Helper.mockContext({ projectCards }))
+    expect(res).toEqual({ data: projectCards })
+  })
+
+  test('that error are re-thrown', async () => {
+    const context = Helper.mockContext()
+    context.octokit.projects.listCards = jest.fn().mockRejectedValue({ status: 402 })
+
+    try {
+      await GithubAPI.projectListCards(context)
+      // Fail test if above expression doesn't throw anything.
+      expect(true).toBe(false)
+    } catch (e) {
+      expect(e.status).toBe(402)
+    }
+  })
+})

lib/github/api.js

@@ -272,6 +272,46 @@ class GithubAPI {
       }
     }
   }
+
+  static async projectListColumns (context, callParam) {
+    const callFn = 'projects.listColumns'
+
+    debugLog(context, callFn)
+
+    try {
+      const res = await context.octokit.projects.listColumns(callParam)
+
+      return res.data.map(project => project.id)
+    } catch (err) {
+      return checkCommonError(err, context, callFn)
+    }
+  }
+
+  static async projectListForRepo (context, callParam) {
+    const callFn = 'projects.listForRepo'
+
+    debugLog(context, callFn)
+
+    try {
+      const res = await context.octokit.projects.listForRepo(callParam)
+
+      return res.data.map(project => ({ id: project.id, name: project.name }))
+    } catch (err) {
+      return checkCommonError(err, context, callFn)
+    }
+  }
+
+  static async projectListCards (context, callParam) {
+    const callFn = 'projects.listCards'
+
+    debugLog(context, callFn)
+
+    try {
+      return await context.octokit.projects.listCards(callParam)
+    } catch (err) {
+      return checkCommonError(err, context, callFn)
+    }
+  }
 }
 
 module.exports = GithubAPI

lib/validators/project.js

@@ -31,7 +31,7 @@ class Project extends Validator {
     const description = validationSettings.message ||
       `Must be in the "${projectName}" project.`
 
-    const projects = await getProjects(context)
+    const projects = await this.githubAPI.projectListForRepo(context, context.repo())
     const validatorContext = { name: 'project' }
     if (!projectName) {
       return consolidateResult([constructError('project', projects, validationSettings, MATCH_NOT_FOUND_ERROR)], validatorContext)
@@ -40,7 +40,7 @@ class Project extends Validator {
     const regex = new RegExp(projectName, 'i')
 
     const projIds = projects.filter(project => regex.test(project.name)).map(project => project.id)
-    const projectCards = await getProjectCards(context, projIds)
+    const projectCards = await getProjectCards(context, projIds, this)
     const idsFromCards = extractIssueIdsFromCards(pr, projectCards)
     let isMergeable = idsFromCards.includes(String(pr.number))
 
@@ -72,23 +72,14 @@ const extractIssueIdsFromCards = (pr, cards) => {
   return ids
 }
 
-const getProjects = async (context) => {
-  const res = await context.octokit.projects.listForRepo(
-    context.repo()
-  )
-
-  return res.data.map(project => ({ id: project.id, name: project.name }))
-}
-
-const getProjectCards = async (context, projIds) => {
+const getProjectCards = async (context, projIds, validatorObj) => {
   let cards = []
 
   // get all the project columns
   for (let i = 0; i < projIds.length; i++) {
-    let res = await context.octokit.projects.listColumns({ project_id: projIds[i] })
-    const columnIds = res.data.map(project => project.id)
+    const columnIds = await validatorObj.githubAPI.projectListColumns(context, { project_id: projIds[i] })
 
-    res = await Promise.all(columnIds.map(id => context.octokit.projects.listCards({ column_id: id })))
+    const res = await Promise.all(columnIds.map(id => validatorObj.githubAPI.projectListCards(context, { column_id: id })))
     res.forEach(card => {
       cards = cards.concat(card.data)
     })