feat: use graphql to workaround problems with private/internal repo…

…sitories (#105)
gr2m · Sep 6, 2022 · 0c53ab1 · 0c53ab1
1 parent 28f33b6
commit 0c53ab1
Show file tree

Hide file tree

Showing 18 changed files with 303 additions and 424 deletions.
diff --git a/src/compose-create-pull-request.ts b/src/compose-create-pull-request.ts
@@ -120,35 +120,52 @@ export async function composeCreatePullRequest(
     return null;
   }
 
-  // https://docs.github.com/en/rest/git/refs#get-a-reference
-  const branchExists = await octokit
-    .request("GET /repos/{owner}/{repo}/git/ref/{ref}", {
-      owner: state.fork,
-      repo,
-      ref: `heads/${head}`,
-    })
-    .then(
-      () => true,
-      (error) => {
-        /* istanbul ignore else */
-        if (error.status === 404) return false;
-
-        /* istanbul ignore next */
-        throw error;
+  const branchInfo: {
+    repository: {
+      ref: {
+        associatedPullRequests: {
+          edges: [
+            {
+              node: {
+                url: string;
+                number: number;
+              };
+            }
+          ];
+        };
+      };
+    };
+  } = await octokit.graphql(
+    `
+    query ($owner: String!, $repo: String!, $head: String!) {
+      repository(name: $repo, owner: $owner) {
+        ref(qualifiedName: $head) {
+          associatedPullRequests(first: 1, states: OPEN) {
+            edges {
+              node {
+                id
+                number
+                url
+              }
+            }
+          }
+        }
       }
-    );
+    }`,
+    {
+      owner,
+      repo,
+      head,
+    }
+  );
 
-  const existingPullRequest = branchExists
-    ? await octokit
-        .request("GET /search/issues", {
-          q: `head:${head} type:pr is:open repo:${owner}/${repo}`,
-        })
-        .then((response) => response.data.items[0])
-    : undefined;
+  const branchExists = !!branchInfo.repository.ref;
+  const existingPullRequest =
+    branchInfo.repository.ref?.associatedPullRequests?.edges?.[0]?.node;
 
   if (existingPullRequest && !update) {
     throw new Error(
-      `[octokit-plugin-create-pull-request] Pull request already exists: ${existingPullRequest.html_url}. Set update=true to enable updating`
+      `[octokit-plugin-create-pull-request] Pull request already exists: ${existingPullRequest.url}. Set update=true to enable updating`
     );
   }
 

diff --git a/test/fixtures/create-binary-file.json b/test/fixtures/create-binary-file.json
@@ -563,7 +563,7 @@
   },
   {
     "request": {
-      "method": "GET",
+      "method": "POST",
       "baseUrl": "https://api.github.com",
       "headers": {
         "accept": "application/vnd.github.v3+json",
@@ -574,13 +574,16 @@
         "previews": []
       },
       "request": {},
-      "url": "/repos/{owner}/{repo}/git/ref/{ref}",
-      "owner": "gr2m",
-      "repo": "pull-request-test",
-      "ref": "heads/patch"
+      "url": "/graphql",
+      "query": "\n    query ($owner: String!, $repo: String!, $head: String!) {\n      repository(name: $repo, owner: $owner) {\n        ref(qualifiedName: $head) {\n          associatedPullRequests(first: 1, states: OPEN) {\n            edges {\n              node {\n                id\n                number\n                url\n              }\n            }\n          }\n        }\n      }\n    }",
+      "variables": {
+        "owner": "gr2m",
+        "repo": "pull-request-test",
+        "head": "patch"
+      }
     },
     "response": {
-      "status": 404,
+      "status": 200,
       "headers": {
         "access-control-allow-origin": "*",
         "access-control-expose-headers": "ETag, Link, Location, Retry-After, X-GitHub-OTP, X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Used, X-RateLimit-Resource, X-RateLimit-Reset, X-OAuth-Scopes, X-Accepted-OAuth-Scopes, X-Poll-Interval, X-GitHub-Media-Type, X-GitHub-SSO, X-GitHub-Request-Id, Deprecation, Sunset",
@@ -612,8 +615,11 @@
         "x-xss-protection": "0"
       },
       "data": {
-        "error": "Not Found",
-        "documentation_url": "https://docs.github.com/rest/reference/git#get-a-reference"
+        "data": {
+          "repository": {
+            "ref": null
+          }
+        }
       }
     }
   },

diff --git a/test/fixtures/create-fork.json b/test/fixtures/create-fork.json
@@ -1087,7 +1087,7 @@
   },
   {
     "request": {
-      "method": "GET",
+      "method": "POST",
       "baseUrl": "https://api.github.com",
       "headers": {
         "accept": "application/vnd.github.v3+json",
@@ -1098,13 +1098,16 @@
         "previews": []
       },
       "request": {},
-      "url": "/repos/{owner}/{repo}/git/ref/{ref}",
-      "owner": "gr2m-test",
-      "repo": "pull-request-test",
-      "ref": "heads/test-branch-u7es0"
+      "url": "/graphql",
+      "query": "\n    query ($owner: String!, $repo: String!, $head: String!) {\n      repository(name: $repo, owner: $owner) {\n        ref(qualifiedName: $head) {\n          associatedPullRequests(first: 1, states: OPEN) {\n            edges {\n              node {\n                id\n                number\n                url\n              }\n            }\n          }\n        }\n      }\n    }",
+      "variables": {
+        "owner": "gr2m",
+        "repo": "pull-request-test",
+        "head": "test-branch-u7es0"
+      }
     },
     "response": {
-      "status": 404,
+      "status": 200,
       "headers": {
         "access-control-allow-origin": "*",
         "access-control-expose-headers": "ETag, Link, Location, Retry-After, X-GitHub-OTP, X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Used, X-RateLimit-Resource, X-RateLimit-Reset, X-OAuth-Scopes, X-Accepted-OAuth-Scopes, X-Poll-Interval, X-GitHub-Media-Type, X-GitHub-SSO, X-GitHub-Request-Id, Deprecation, Sunset",
@@ -1134,8 +1137,11 @@
         "x-xss-protection": "0"
       },
       "data": {
-        "error": "Not Found",
-        "documentation_url": "https://docs.github.com/rest/reference/git#get-a-reference"
+        "data": {
+          "repository": {
+            "ref": null
+          }
+        }
       }
     }
   },

diff --git a/test/fixtures/custom-base.json b/test/fixtures/custom-base.json
@@ -509,7 +509,7 @@
   },
   {
     "request": {
-      "method": "GET",
+      "method": "POST",
       "baseUrl": "https://api.github.com",
       "headers": {
         "accept": "application/vnd.github.v3+json",
@@ -520,13 +520,16 @@
         "previews": []
       },
       "request": {},
-      "url": "/repos/{owner}/{repo}/git/ref/{ref}",
-      "owner": "gr2m",
-      "repo": "pull-request-test",
-      "ref": "heads/test-branch-1rtg5"
+      "url": "/graphql",
+      "query": "\n    query ($owner: String!, $repo: String!, $head: String!) {\n      repository(name: $repo, owner: $owner) {\n        ref(qualifiedName: $head) {\n          associatedPullRequests(first: 1, states: OPEN) {\n            edges {\n              node {\n                id\n                number\n                url\n              }\n            }\n          }\n        }\n      }\n    }",
+      "variables": {
+        "owner": "gr2m",
+        "repo": "pull-request-test",
+        "head": "test-branch-1rtg5"
+      }
     },
     "response": {
-      "status": 404,
+      "status": 200,
       "headers": {
         "access-control-allow-origin": "*",
         "access-control-expose-headers": "ETag, Link, Location, Retry-After, X-GitHub-OTP, X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Used, X-RateLimit-Resource, X-RateLimit-Reset, X-OAuth-Scopes, X-Accepted-OAuth-Scopes, X-Poll-Interval, X-GitHub-Media-Type, X-GitHub-SSO, X-GitHub-Request-Id, Deprecation, Sunset",
@@ -558,8 +561,11 @@
         "x-xss-protection": "0"
       },
       "data": {
-        "error": "Not Found",
-        "documentation_url": "https://docs.github.com/rest/reference/git#get-a-reference"
+        "data": {
+          "repository": {
+            "ref": null
+          }
+        }
       }
     }
   },

diff --git a/test/fixtures/delete-files.json b/test/fixtures/delete-files.json
@@ -618,7 +618,7 @@
   },
   {
     "request": {
-      "method": "GET",
+      "method": "POST",
       "baseUrl": "https://api.github.com",
       "headers": {
         "accept": "application/vnd.github.v3+json",
@@ -629,13 +629,16 @@
         "previews": []
       },
       "request": {},
-      "url": "/repos/{owner}/{repo}/git/ref/{ref}",
-      "owner": "gr2m",
-      "repo": "pull-request-test",
-      "ref": "heads/patch"
+      "url": "/graphql",
+      "query": "\n    query ($owner: String!, $repo: String!, $head: String!) {\n      repository(name: $repo, owner: $owner) {\n        ref(qualifiedName: $head) {\n          associatedPullRequests(first: 1, states: OPEN) {\n            edges {\n              node {\n                id\n                number\n                url\n              }\n            }\n          }\n        }\n      }\n    }",
+      "variables": {
+        "owner": "gr2m",
+        "repo": "pull-request-test",
+        "head": "patch"
+      }
     },
     "response": {
-      "status": 404,
+      "status": 200,
       "headers": {
         "access-control-allow-origin": "*",
         "access-control-expose-headers": "ETag, Link, Location, Retry-After, X-GitHub-OTP, X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Used, X-RateLimit-Resource, X-RateLimit-Reset, X-OAuth-Scopes, X-Accepted-OAuth-Scopes, X-Poll-Interval, X-GitHub-Media-Type, X-GitHub-SSO, X-GitHub-Request-Id, Deprecation, Sunset",
@@ -667,8 +670,11 @@
         "x-xss-protection": "0"
       },
       "data": {
-        "error": "Not Found",
-        "documentation_url": "https://docs.github.com/rest/reference/git#get-a-reference"
+        "data": {
+          "repository": {
+            "ref": null
+          }
+        }
       }
     }
   },

diff --git a/test/fixtures/empty-commit-message.json b/test/fixtures/empty-commit-message.json
@@ -677,7 +677,7 @@
   },
   {
     "request": {
-      "method": "GET",
+      "method": "POST",
       "baseUrl": "https://api.github.com",
       "headers": {
         "accept": "application/vnd.github.v3+json",
@@ -688,13 +688,16 @@
         "previews": []
       },
       "request": {},
-      "url": "/repos/{owner}/{repo}/git/ref/{ref}",
-      "owner": "gr2m",
-      "repo": "pull-request-test",
-      "ref": "heads/empty-commit-message"
+      "url": "/graphql",
+      "query": "\n    query ($owner: String!, $repo: String!, $head: String!) {\n      repository(name: $repo, owner: $owner) {\n        ref(qualifiedName: $head) {\n          associatedPullRequests(first: 1, states: OPEN) {\n            edges {\n              node {\n                id\n                number\n                url\n              }\n            }\n          }\n        }\n      }\n    }",
+      "variables": {
+        "owner": "gr2m",
+        "repo": "pull-request-test",
+        "head": "empty-commit-message"
+      }
     },
     "response": {
-      "status": 404,
+      "status": 200,
       "headers": {
         "access-control-allow-origin": "*",
         "access-control-expose-headers": "ETag, Link, Location, Retry-After, X-GitHub-OTP, X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Used, X-RateLimit-Resource, X-RateLimit-Reset, X-OAuth-Scopes, X-Accepted-OAuth-Scopes, X-Poll-Interval, X-GitHub-Media-Type, X-GitHub-SSO, X-GitHub-Request-Id, Deprecation, Sunset",
@@ -726,8 +729,11 @@
         "x-xss-protection": "0"
       },
       "data": {
-        "error": "Not Found",
-        "documentation_url": "https://docs.github.com/rest/reference/git#get-a-reference"
+        "data": {
+          "repository": {
+            "ref": null
+          }
+        }
       }
     }
   },

diff --git a/test/fixtures/empty-commits.json b/test/fixtures/empty-commits.json
@@ -488,7 +488,7 @@
   },
   {
     "request": {
-      "method": "GET",
+      "method": "POST",
       "baseUrl": "https://api.github.com",
       "headers": {
         "accept": "application/vnd.github.v3+json",
@@ -499,13 +499,16 @@
         "previews": []
       },
       "request": {},
-      "url": "/repos/{owner}/{repo}/git/ref/{ref}",
-      "owner": "gr2m",
-      "repo": "pull-request-test",
-      "ref": "heads/empty-files"
+      "url": "/graphql",
+      "query": "\n    query ($owner: String!, $repo: String!, $head: String!) {\n      repository(name: $repo, owner: $owner) {\n        ref(qualifiedName: $head) {\n          associatedPullRequests(first: 1, states: OPEN) {\n            edges {\n              node {\n                id\n                number\n                url\n              }\n            }\n          }\n        }\n      }\n    }",
+      "variables": {
+        "owner": "gr2m",
+        "repo": "pull-request-test",
+        "head": "empty-files"
+      }
     },
     "response": {
-      "status": 404,
+      "status": 200,
       "headers": {
         "access-control-allow-origin": "*",
         "access-control-expose-headers": "ETag, Link, Location, Retry-After, X-GitHub-OTP, X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Used, X-RateLimit-Resource, X-RateLimit-Reset, X-OAuth-Scopes, X-Accepted-OAuth-Scopes, X-Poll-Interval, X-GitHub-Media-Type, X-GitHub-SSO, X-GitHub-Request-Id, Deprecation, Sunset",
@@ -537,8 +540,11 @@
         "x-xss-protection": "0"
       },
       "data": {
-        "error": "Not Found",
-        "documentation_url": "https://docs.github.com/rest/reference/git#get-a-reference"
+        "data": {
+          "repository": {
+            "ref": null
+          }
+        }
       }
     }
   },

diff --git a/test/fixtures/empty-update.json b/test/fixtures/empty-update.json
@@ -473,7 +473,7 @@
   },
   {
     "request": {
-      "method": "GET",
+      "method": "POST",
       "baseUrl": "https://api.github.com",
       "headers": {
         "accept": "application/vnd.github.v3+json",
@@ -484,13 +484,17 @@
         "previews": []
       },
       "request": {},
-      "url": "/repos/{owner}/{repo}/git/ref/{ref}",
-      "owner": "gr2m",
-      "repo": "pull-request-test",
-      "ref": "heads/empty-update"
+      "url": "/graphql",
+      "query": "\n    query ($owner: String!, $repo: String!, $head: String!) {\n      repository(name: $repo, owner: $owner) {\n        ref(qualifiedName: $head) {\n          associatedPullRequests(first: 1, states: OPEN) {\n            edges {\n              node {\n                id\n                number\n                url\n              }\n            }\n          }\n        }\n      }\n    }",
+      "variables": {
+        "owner": "gr2m",
+        "repo": "pull-request-test",
+        "head": "empty-update"
+      }
     },
     "response": {
-      "status": 404,
+      "status": 200,
+      "url": "https://api.github.com/graphql",
       "headers": {
         "access-control-allow-origin": "*",
         "access-control-expose-headers": "ETag, Link, Location, Retry-After, X-GitHub-OTP, X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Used, X-RateLimit-Resource, X-RateLimit-Reset, X-OAuth-Scopes, X-Accepted-OAuth-Scopes, X-Poll-Interval, X-GitHub-Media-Type, X-GitHub-SSO, X-GitHub-Request-Id, Deprecation, Sunset",
@@ -522,8 +526,11 @@
         "x-xss-protection": "0"
       },
       "data": {
-        "error": "Not Found",
-        "documentation_url": "https://docs.github.com/rest/reference/git#get-a-reference"
+        "data": {
+          "repository": {
+            "ref": null
+          }
+        }
       }
     }
   },