status-im
/
sourcecred
mirror of https://github.com/status-im/sourcecred.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity

Improve GitHub rate limit error message (#755) 

Fixes #732; see that issue for context.

Test plan:
The success case still works (verified that loading
sourcecred/sourcecred works).

I haven't tested the error case, as getting a real RATE_LIMIT_EXCEEDED
form GitHub is time-consuming, and has only happened once in practice.
I'm pretty confident the code works because it's a simple adaptation of
the code that catches other cases.
This commit is contained in:
Dandelion Mané 2018-09-03 14:33:17 -07:00 committed by GitHub
parent f3fbb3940b
commit b92d6138d3
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 48 additions and 27 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

75
src/plugins/github/fetchGithubRepo.js
View File

@ -53,6 +53,7 @@ const GITHUB_GRAPHQL_SERVER = "https://api.github.com/graphql";
type GithubResponseError =
| {|+type: "FETCH_ERROR", retry: false, error: Error|}
| {|+type: "GRAPHQL_ERROR", retry: false, error: mixed|}
| {|+type: "RATE_LIMIT_EXCEEDED", retry: false, error: mixed|}
| {|+type: "GITHUB_INTERNAL_EXECUTION_ERROR", retry: true, error: mixed|}
| {|+type: "NO_DATA", retry: true, error: mixed|};
@ -75,6 +76,17 @@ function tryGithubFetch(fetch, fetchOptions): Promise<any> {
error: x,
}: GithubResponseError)
);
} else if (
x.errors.length === 1 &&
x.errors[0].type === "RATE_LIMITED"
) {
return Promise.reject(
({
type: "RATE_LIMIT_EXCEEDED",
retry: false,
error: x,
}: GithubResponseError)
);
} else {
return Promise.reject(
({
@ -131,34 +143,43 @@ async function postQuery({body, variables}, token): Promise<any> {
Authorization: `bearer ${token}`,
},
};
return retryGithubFetch(fetch, fetchOptions).catch((error) => {
switch (error.type) {
case "GITHUB_INTERNAL_EXECUTION_ERROR":
case "NO_DATA":
console.error(
"GitHub query failed! We're tracking these issues at " +
"https://github.com/sourcecred/sourcecred/issues/350.\n" +
"If the error is a timeout or abuse rate limit, you can " +
"try loading a smaller repo, or trying again in a few minutes.\n" +
"The actual failed response can be found below:\n" +
"================================================="
);
console.error(error.error);
break;
case "GRAPHQL_ERROR":
console.error(
"Unexpected GraphQL error; this may be a bug in SourceCred: ",
JSON.stringify({postBody: postBody, error: error.error})
);
break;
case "FETCH_ERROR":
// Network error; no need for additional commentary.
break;
default:
throw new Error((error.type: empty));
return retryGithubFetch(fetch, fetchOptions).catch(
(error: GithubResponseError) => {
const type = error.type;
switch (type) {
case "GITHUB_INTERNAL_EXECUTION_ERROR":
case "NO_DATA":
console.error(
"GitHub query failed! We're tracking these issues at " +
"https://github.com/sourcecred/sourcecred/issues/350.\n" +
"If the error is a timeout or abuse rate limit, you can " +
"try loading a smaller repo, or trying again in a few minutes.\n" +
"The actual failed response can be found below:\n" +
"================================================="
);
console.error(error.error);
break;
case "GRAPHQL_ERROR":
console.error(
"Unexpected GraphQL error; this may be a bug in SourceCred: ",
JSON.stringify({postBody: postBody, error: error.error})
);
break;
case "RATE_LIMIT_EXCEEDED":
console.error(
"You've exceeded your hourly GitHub rate limit.\n" +
"You'll need to wait until it resets."
);
break;
case "FETCH_ERROR":
// Network error; no need for additional commentary.
break;
default:
throw new Error((type: empty));
}
return Promise.reject(error);
}
return Promise.reject(error);
});
);
}
function ensureNoMorePages(result: any, path = []) {