feat: skip PR when one already exists

Author: dominykas

lib/github.js

@@ -132,6 +132,12 @@ module.exports.getBranch = async function getBranch (owner, repo, branch) {
   }
 }
 
+module.exports.getPullsForBranch = async function getBranch (owner, repo, branch) {
+  const { data } = await octokit.pulls.list({ owner, repo, head: `${owner}:${branch}` })
+
+  return data
+}
+
 module.exports.getChecks = async function getChecks (owner, repo, branch) {
   return octokit.checks.listForRef({
     owner,

lib/test.js

@@ -81,7 +81,14 @@ async function createPR (dependentOwner, dependentRepo, parentBranchName, parent
   const body = `Wiby has raised this PR to kick off automated jobs.
   You are dependent upon ${parentDependencyLink}
   `
-  const head = context.getTestingBranchName(parentBranchName)
+  const testingBranchName = context.getTestingBranchName(parentBranchName)
+
+  const pullsForTestingBranch = await github.getPullsForBranch(dependentOwner, dependentRepo, testingBranchName)
+  if (pullsForTestingBranch.length) {
+    debug(`Existing PRs updated: ${pullsForTestingBranch.map((data) => data.html_url).join(', ')}`)
+    return
+  }
+
   const draft = true
   /*
         from the conversation on wiby PR 93 https://github.com/pkgjs/wiby/pull/93#discussion_r615362448
@@ -92,11 +99,11 @@ async function createPR (dependentOwner, dependentRepo, parentBranchName, parent
   const preExistingOnDependent = await github.getBranch(dependentOwner, dependentRepo, parentBranchName)
   let result
   if (preExistingOnDependent) {
-    result = await github.createPR(dependentOwner, dependentRepo, title, head, parentBranchName, draft, body)
+    result = await github.createPR(dependentOwner, dependentRepo, title, testingBranchName, parentBranchName, draft, body)
     debug(`PR raised upon ${result.data.html_url} (base branch: ${parentBranchName})`)
   } else {
     const defaultBranch = await github.getDefaultBranch(dependentOwner, dependentRepo)
-    result = await github.createPR(dependentOwner, dependentRepo, title, head, defaultBranch, draft, body)
+    result = await github.createPR(dependentOwner, dependentRepo, title, testingBranchName, defaultBranch, draft, body)
     debug(`PR raised upon ${result.data.html_url} (base branch: ${defaultBranch})`)
   }
   return result

test/cli/test.js

@@ -63,7 +63,7 @@ tap.test('test command', async (tap) => {
     tap.match(result, 'Pushed a new commit to https://github.com/wiby-test/pass#wiby-existing-branch')
     tap.match(result, 'Pushed a new commit to https://github.com/wiby-test/fail#wiby-existing-branch')
     tap.match(result, 'Pushed a new commit to https://github.com/wiby-test/partial#wiby-existing-branch')
-    tap.match(result, 'PR raised upon https://github.com/pkgjs/wiby/pull/1 (base branch: main)')
+    tap.match(result, 'Existing PRs updated: https://github.com/pkgjs/wiby/pull/1')
   })
 
   tap.test('test command should not add `wiby-` prefix when branch already has it', async (tap) => {

test/fixtures/http/test-command-positive.js

@@ -119,6 +119,14 @@ function nockRepo (nockInstance, repo) {
     })
     .patch(`/repos/wiby-test/${repo}/git/refs/heads%2Fwiby-existing-branch`, { sha: 'fake_sha' })
     .reply(204)
+    .get(`/repos/wiby-test/${repo}/pulls?head=wiby-test%3Awiby-running-unit-tests`)
+    .reply(200, [])
+    .get(`/repos/wiby-test/${repo}/pulls?head=wiby-test%3Awiby-existing-branch`)
+    .reply(200, [
+      {
+        html_url: 'https://github.com/pkgjs/wiby/pull/1'
+      }
+    ])
 }
 
 function buildNock () {