Skip to content

Commit e6fe5c9

Browse files
holly-cumminsbitwiseman
holly-cummins
and
bitwiseman
committed
Accept 429 as an indication of the rate limit
Co-Authored-By: Liam Newman <[email protected]>
1 parent cab9bbb commit e6fe5c9

File tree

9 files changed

+409
-2
lines changed

9 files changed

+409
-2
lines changed

‎src/main/java/org/kohsuke/github/AbuseLimitHandler.java‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,8 @@ public void onError(IOException e, HttpURLConnection uc) throws IOException {
8989
private long parseWaitTime(HttpURLConnection uc) {
9090
String v = uc.getHeaderField("Retry-After");
9191
if (v == null)
92-
return 60 * 1000; // can't tell, return 1 min
92+
// can't tell, wait for unambiguously over one minute per GitHub guidance
93+
return 61 * 1000;
9394

9495
return Math.max(1000, Long.parseLong(v) * 1000);
9596
}

‎src/main/java/org/kohsuke/github/GitHubAbuseLimitHandler.java‎

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,19 @@ public abstract class GitHubAbuseLimitHandler extends GitHubConnectorResponseErr
2929
*/
3030
@Override
3131
boolean isError(@Nonnull GitHubConnectorResponse connectorResponse) {
32-
return isForbidden(connectorResponse) && hasRetryOrLimitHeader(connectorResponse);
32+
return isTooManyRequests(connectorResponse)
33+
|| (isForbidden(connectorResponse) && hasRetryOrLimitHeader(connectorResponse));
34+
}
35+
36+
/**
37+
* Checks if the response status code is TOO_MANY_REQUESTS (429).
38+
*
39+
* @param connectorResponse
40+
* the response from the GitHub connector
41+
* @return true if the status code is TOO_MANY_REQUESTS
42+
*/
43+
private boolean isTooManyRequests(GitHubConnectorResponse connectorResponse) {
44+
return connectorResponse.statusCode() == TOO_MANY_REQUESTS;
3345
}
3446

3547
/**

‎src/main/java/org/kohsuke/github/GitHubConnectorResponseErrorHandler.java‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,17 @@
2323
*/
2424
abstract class GitHubConnectorResponseErrorHandler {
2525

26+
/**
27+
* The HTTP 429 Too Many Requests response status code indicates the user has sent too many requests in a given
28+
* amount of time ("rate limiting").
29+
*
30+
* A Retry-After header might be included to this response indicating how long to wait before making a new request.
31+
*
32+
* Why is this hardcoded here? The HttpURLConnection class is missing the status codes above 415, so the constant
33+
* needs to be sourced from elsewhere.
34+
*/
35+
public static final int TOO_MANY_REQUESTS = 429;
36+
2637
/**
2738
* Called to detect an error handled by this handler.
2839
*

‎src/test/java/org/kohsuke/github/AbuseLimitHandlerTest.java‎

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -375,4 +375,67 @@ public void onError(IOException e, HttpURLConnection uc) throws IOException {
375375
}
376376
assertThat(mockGitHub.getRequestCount(), equalTo(2));
377377
}
378+
379+
/**
380+
* Tests the behavior of the GitHub API client when the abuse limit handler is set to WAIT then the handler waits
381+
* appropriately when secondary rate limits are encountered.
382+
*
383+
* @throws Exception
384+
* if any error occurs during the test execution.
385+
*/
386+
@Test
387+
public void testHandler_Wait_Secondary_Limits_Too_Many_Requests() throws Exception {
388+
// Customized response that templates the date to keep things working
389+
snapshotNotAllowed();
390+
final HttpURLConnection[] savedConnection = new HttpURLConnection[1];
391+
gitHub = getGitHubBuilder().withEndpoint(mockGitHub.apiServer().baseUrl())
392+
.withAbuseLimitHandler(new AbuseLimitHandler() {
393+
/**
394+
* Overriding method because the actual method will wait for one minute causing slowness in unit
395+
* tests
396+
*/
397+
@Override
398+
public void onError(IOException e, HttpURLConnection uc) throws IOException {
399+
savedConnection[0] = uc;
400+
// Verify
401+
assertThat(uc.getDate(), Matchers.greaterThanOrEqualTo(new Date().getTime() - 10000));
402+
assertThat(uc.getExpiration(), equalTo(0L));
403+
assertThat(uc.getIfModifiedSince(), equalTo(0L));
404+
assertThat(uc.getLastModified(), equalTo(1581014017000L));
405+
assertThat(uc.getRequestMethod(), equalTo("GET"));
406+
assertThat(uc.getResponseCode(), equalTo(429));
407+
assertThat(uc.getResponseMessage(), containsString("Many"));
408+
assertThat(uc.getURL().toString(),
409+
endsWith(
410+
"/repos/hub4j-test-org/temp-testHandler_Wait_Secondary_Limits_Too_Many_Requests"));
411+
assertThat(uc.getContentEncoding(), nullValue());
412+
assertThat(uc.getContentType(), equalTo("application/json; charset=utf-8"));
413+
assertThat(uc.getContentLength(), equalTo(-1));
414+
assertThat(uc.getHeaderFields(), instanceOf(Map.class));
415+
assertThat(uc.getHeaderFields().size(), Matchers.greaterThan(25));
416+
assertThat(uc.getHeaderField("Status"), equalTo("429 Too Many Requests"));
417+
418+
try (InputStream errorStream = uc.getErrorStream()) {
419+
assertThat(errorStream, notNullValue());
420+
String errorString = IOUtils.toString(errorStream, StandardCharsets.UTF_8);
421+
assertThat(errorString,
422+
containsString(
423+
"You have exceeded a secondary rate limit. Please wait a few minutes before you try again"));
424+
}
425+
AbuseLimitHandler.FAIL.onError(e, uc);
426+
}
427+
})
428+
.build();
429+
430+
gitHub.getMyself();
431+
assertThat(mockGitHub.getRequestCount(), equalTo(1));
432+
try {
433+
getTempRepository();
434+
fail();
435+
} catch (Exception e) {
436+
assertThat(e, instanceOf(HttpException.class));
437+
assertThat(e.getMessage(), equalTo("Abuse limit reached"));
438+
}
439+
assertThat(mockGitHub.getRequestCount(), equalTo(2));
440+
}
378441
}

‎src/test/resources/org/kohsuke/github/AbuseLimitHandlerTest/wiremock/testHandler_Wait_Secondary_Limits_Too_Many_Requests/__files/1-user.json‎

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
{
2+
"login": "bitwiseman",
3+
"id": 1958953,
4+
"node_id": "MDQ6VXNlcjE5NTg5NTM=",
5+
"avatar_url": "https://avatars3.githubusercontent.com/u/1958953?v=4",
6+
"gravatar_id": "",
7+
"url": "https://api.github.com/users/bitwiseman",
8+
"html_url": "https://github.com/bitwiseman",
9+
"followers_url": "https://api.github.com/users/bitwiseman/followers",
10+
"following_url": "https://api.github.com/users/bitwiseman/following{/other_user}",
11+
"gists_url": "https://api.github.com/users/bitwiseman/gists{/gist_id}",
12+
"starred_url": "https://api.github.com/users/bitwiseman/starred{/owner}{/repo}",
13+
"subscriptions_url": "https://api.github.com/users/bitwiseman/subscriptions",
14+
"organizations_url": "https://api.github.com/users/bitwiseman/orgs",
15+
"repos_url": "https://api.github.com/users/bitwiseman/repos",
16+
"events_url": "https://api.github.com/users/bitwiseman/events{/privacy}",
17+
"received_events_url": "https://api.github.com/users/bitwiseman/received_events",
18+
"type": "User",
19+
"site_admin": false,
20+
"name": "Liam Newman",
21+
"company": "Cloudbees, Inc.",
22+
"blog": "",
23+
"location": "Seattle, WA, USA",
24+
"email": "[email protected]",
25+
"hireable": null,
26+
"bio": "https://twitter.com/bitwiseman",
27+
"public_repos": 181,
28+
"public_gists": 7,
29+
"followers": 146,
30+
"following": 9,
31+
"created_at": "2012-07-11T20:38:33Z",
32+
"updated_at": "2020-02-06T17:29:39Z",
33+
"private_gists": 8,
34+
"total_private_repos": 10,
35+
"owned_private_repos": 0,
36+
"disk_usage": 33697,
37+
"collaborators": 0,
38+
"two_factor_authentication": true,
39+
"plan": {
40+
"name": "free",
41+
"space": 976562499,
42+
"collaborators": 0,
43+
"private_repos": 10000
44+
}
45+
}

‎src/test/resources/org/kohsuke/github/AbuseLimitHandlerTest/wiremock/testHandler_Wait_Secondary_Limits_Too_Many_Requests/__files/3-r_h_t_fail.json‎

Lines changed: 126 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,126 @@
1+
{
2+
"id": 238757196,
3+
"node_id": "MDEwOlJlcG9zaXRvcnkyMzg3NTcxOTY=",
4+
"name": "temp-testHandler_Wait_Secondary_Limits_Too_Many_Requests",
5+
"full_name": "hub4j-test-org/temp-testHandler_Wait_Secondary_Limits_Too_Many_Requests",
6+
"private": false,
7+
"owner": {
8+
"login": "hub4j-test-org",
9+
"id": 7544739,
10+
"node_id": "MDEyOk9yZ2FuaXphdGlvbjc1NDQ3Mzk=",
11+
"avatar_url": "https://avatars3.githubusercontent.com/u/7544739?v=4",
12+
"gravatar_id": "",
13+
"url": "https://api.github.com/users/hub4j-test-org",
14+
"html_url": "https://github.com/hub4j-test-org",
15+
"followers_url": "https://api.github.com/users/hub4j-test-org/followers",
16+
"following_url": "https://api.github.com/users/hub4j-test-org/following{/other_user}",
17+
"gists_url": "https://api.github.com/users/hub4j-test-org/gists{/gist_id}",
18+
"starred_url": "https://api.github.com/users/hub4j-test-org/starred{/owner}{/repo}",
19+
"subscriptions_url": "https://api.github.com/users/hub4j-test-org/subscriptions",
20+
"organizations_url": "https://api.github.com/users/hub4j-test-org/orgs",
21+
"repos_url": "https://api.github.com/users/hub4j-test-org/repos",
22+
"events_url": "https://api.github.com/users/hub4j-test-org/events{/privacy}",
23+
"received_events_url": "https://api.github.com/users/hub4j-test-org/received_events",
24+
"type": "Organization",
25+
"site_admin": false
26+
},
27+
"html_url": "https://github.com/hub4j-test-org/temp-testHandler_Wait_Secondary_Limits_Too_Many_Requests",
28+
"description": "A test repository for testing the github-api project: temp-testHandler_Wait_Secondary_Limits_Too_Many_Requests",
29+
"fork": false,
30+
"url": "https://api.github.com/repos/hub4j-test-org/temp-testHandler_Wait_Secondary_Limits_Too_Many_Requests",
31+
"forks_url": "https://api.github.com/repos/hub4j-test-org/temp-testHandler_Wait_Secondary_Limits_Too_Many_Requests/forks",
32+
"keys_url": "https://api.github.com/repos/hub4j-test-org/temp-testHandler_Wait_Secondary_Limits_Too_Many_Requests/keys{/key_id}",
33+
"collaborators_url": "https://api.github.com/repos/hub4j-test-org/temp-testHandler_Wait_Secondary_Limits_Too_Many_Requests/collaborators{/collaborator}",
34+
"teams_url": "https://api.github.com/repos/hub4j-test-org/temp-testHandler_Wait_Secondary_Limits_Too_Many_Requests/teams",
35+
"hooks_url": "https://api.github.com/repos/hub4j-test-org/temp-testHandler_Wait_Secondary_Limits_Too_Many_Requests/hooks",
36+
"issue_events_url": "https://api.github.com/repos/hub4j-test-org/temp-testHandler_Wait_Secondary_Limits_Too_Many_Requests/issues/events{/number}",
37+
"events_url": "https://api.github.com/repos/hub4j-test-org/temp-testHandler_Wait_Secondary_Limits_Too_Many_Requests/events",
38+
"assignees_url": "https://api.github.com/repos/hub4j-test-org/temp-testHandler_Wait_Secondary_Limits_Too_Many_Requests/assignees{/user}",
39+
"branches_url": "https://api.github.com/repos/hub4j-test-org/temp-testHandler_Wait_Secondary_Limits_Too_Many_Requests/branches{/branch}",
40+
"tags_url": "https://api.github.com/repos/hub4j-test-org/temp-testHandler_Wait_Secondary_Limits_Too_Many_Requests/tags",
41+
"blobs_url": "https://api.github.com/repos/hub4j-test-org/temp-testHandler_Wait_Secondary_Limits_Too_Many_Requests/git/blobs{/sha}",
42+
"git_tags_url": "https://api.github.com/repos/hub4j-test-org/temp-testHandler_Wait_Secondary_Limits_Too_Many_Requests/git/tags{/sha}",
43+
"git_refs_url": "https://api.github.com/repos/hub4j-test-org/temp-testHandler_Wait_Secondary_Limits_Too_Many_Requests/git/refs{/sha}",
44+
"trees_url": "https://api.github.com/repos/hub4j-test-org/temp-testHandler_Wait_Secondary_Limits_Too_Many_Requests/git/trees{/sha}",
45+
"statuses_url": "https://api.github.com/repos/hub4j-test-org/temp-testHandler_Wait_Secondary_Limits_Too_Many_Requests/statuses/{sha}",
46+
"languages_url": "https://api.github.com/repos/hub4j-test-org/temp-testHandler_Wait_Secondary_Limits_Too_Many_Requests/languages",
47+
"stargazers_url": "https://api.github.com/repos/hub4j-test-org/temp-testHandler_Wait_Secondary_Limits_Too_Many_Requests/stargazers",
48+
"contributors_url": "https://api.github.com/repos/hub4j-test-org/temp-testHandler_Wait_Secondary_Limits_Too_Many_Requests/contributors",
49+
"subscribers_url": "https://api.github.com/repos/hub4j-test-org/temp-testHandler_Wait_Secondary_Limits_Too_Many_Requests/subscribers",
50+
"subscription_url": "https://api.github.com/repos/hub4j-test-org/temp-testHandler_Wait_Secondary_Limits_Too_Many_Requests/subscription",
51+
"commits_url": "https://api.github.com/repos/hub4j-test-org/temp-testHandler_Wait_Secondary_Limits_Too_Many_Requests/commits{/sha}",
52+
"git_commits_url": "https://api.github.com/repos/hub4j-test-org/temp-testHandler_Wait_Secondary_Limits_Too_Many_Requests/git/commits{/sha}",
53+
"comments_url": "https://api.github.com/repos/hub4j-test-org/temp-testHandler_Wait_Secondary_Limits_Too_Many_Requests/comments{/number}",
54+
"issue_comment_url": "https://api.github.com/repos/hub4j-test-org/temp-testHandler_Wait_Secondary_Limits_Too_Many_Requests/issues/comments{/number}",
55+
"contents_url": "https://api.github.com/repos/hub4j-test-org/temp-testHandler_Wait_Secondary_Limits_Too_Many_Requests/contents/{+path}",
56+
"compare_url": "https://api.github.com/repos/hub4j-test-org/temp-testHandler_Wait_Secondary_Limits_Too_Many_Requests/compare/{base}...{head}",
57+
"merges_url": "https://api.github.com/repos/hub4j-test-org/temp-testHandler_Wait_Secondary_Limits_Too_Many_Requests/merges",
58+
"archive_url": "https://api.github.com/repos/hub4j-test-org/temp-testHandler_Wait_Secondary_Limits_Too_Many_Requests/{archive_format}{/ref}",
59+
"downloads_url": "https://api.github.com/repos/hub4j-test-org/temp-testHandler_Wait_Secondary_Limits_Too_Many_Requests/downloads",
60+
"issues_url": "https://api.github.com/repos/hub4j-test-org/temp-testHandler_Wait_Secondary_Limits_Too_Many_Requests/issues{/number}",
61+
"pulls_url": "https://api.github.com/repos/hub4j-test-org/temp-testHandler_Wait_Secondary_Limits_Too_Many_Requests/pulls{/number}",
62+
"milestones_url": "https://api.github.com/repos/hub4j-test-org/temp-testHandler_Wait_Secondary_Limits_Too_Many_Requests/milestones{/number}",
63+
"notifications_url": "https://api.github.com/repos/hub4j-test-org/temp-testHandler_Wait_Secondary_Limits_Too_Many_Requests/notifications{?since,all,participating}",
64+
"labels_url": "https://api.github.com/repos/hub4j-test-org/temp-testHandler_Wait_Secondary_Limits_Too_Many_Requests/labels{/name}",
65+
"releases_url": "https://api.github.com/repos/hub4j-test-org/temp-testHandler_Wait_Secondary_Limits_Too_Many_Requests/releases{/id}",
66+
"deployments_url": "https://api.github.com/repos/hub4j-test-org/temp-testHandler_Wait_Secondary_Limits_Too_Many_Requests/deployments",
67+
"created_at": "2020-02-06T18:33:39Z",
68+
"updated_at": "2020-02-06T18:33:43Z",
69+
"pushed_at": "2020-02-06T18:33:41Z",
70+
"git_url": "git://github.com/hub4j-test-org/temp-testHandler_Wait_Secondary_Limits_Too_Many_Requests.git",
71+
"ssh_url": "[email protected]:hub4j-test-org/temp-testHandler_Wait_Secondary_Limits_Too_Many_Requests.git",
72+
"clone_url": "https://github.com/hub4j-test-org/temp-testHandler_Wait_Secondary_Limits_Too_Many_Requests.git",
73+
"svn_url": "https://github.com/hub4j-test-org/temp-testHandler_Wait_Secondary_Limits_Too_Many_Requests",
74+
"homepage": "http://github-api.kohsuke.org/",
75+
"size": 0,
76+
"stargazers_count": 0,
77+
"watchers_count": 0,
78+
"language": null,
79+
"has_issues": true,
80+
"has_projects": true,
81+
"has_downloads": true,
82+
"has_wiki": true,
83+
"has_pages": false,
84+
"forks_count": 0,
85+
"mirror_url": null,
86+
"archived": false,
87+
"disabled": false,
88+
"open_issues_count": 0,
89+
"license": null,
90+
"forks": 0,
91+
"open_issues": 0,
92+
"watchers": 0,
93+
"default_branch": "main",
94+
"permissions": {
95+
"admin": true,
96+
"push": true,
97+
"pull": true
98+
},
99+
"temp_clone_token": "",
100+
"allow_squash_merge": true,
101+
"allow_merge_commit": true,
102+
"allow_rebase_merge": true,
103+
"delete_branch_on_merge": false,
104+
"organization": {
105+
"login": "hub4j-test-org",
106+
"id": 7544739,
107+
"node_id": "MDEyOk9yZ2FuaXphdGlvbjc1NDQ3Mzk=",
108+
"avatar_url": "https://avatars3.githubusercontent.com/u/7544739?v=4",
109+
"gravatar_id": "",
110+
"url": "https://api.github.com/users/hub4j-test-org",
111+
"html_url": "https://github.com/hub4j-test-org",
112+
"followers_url": "https://api.github.com/users/hub4j-test-org/followers",
113+
"following_url": "https://api.github.com/users/hub4j-test-org/following{/other_user}",
114+
"gists_url": "https://api.github.com/users/hub4j-test-org/gists{/gist_id}",
115+
"starred_url": "https://api.github.com/users/hub4j-test-org/starred{/owner}{/repo}",
116+
"subscriptions_url": "https://api.github.com/users/hub4j-test-org/subscriptions",
117+
"organizations_url": "https://api.github.com/users/hub4j-test-org/orgs",
118+
"repos_url": "https://api.github.com/users/hub4j-test-org/repos",
119+
"events_url": "https://api.github.com/users/hub4j-test-org/events{/privacy}",
120+
"received_events_url": "https://api.github.com/users/hub4j-test-org/received_events",
121+
"type": "Organization",
122+
"site_admin": false
123+
},
124+
"network_count": 0,
125+
"subscribers_count": 6
126+
}

‎src/test/resources/org/kohsuke/github/AbuseLimitHandlerTest/wiremock/testHandler_Wait_Secondary_Limits_Too_Many_Requests/mappings/1-user.json‎

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
{
2+
"id": "a60baf84-5b5c-4f86-af3d-cab0d609c7b2",
3+
"name": "user",
4+
"request": {
5+
"url": "/user",
6+
"method": "GET",
7+
"headers": {
8+
"Accept": {
9+
"equalTo": "application/vnd.github+json"
10+
}
11+
}
12+
},
13+
"response": {
14+
"status": 200,
15+
"bodyFileName": "1-user.json",
16+
"headers": {
17+
"Date": "{{now timezone='GMT' format='EEE, dd MMM yyyy HH:mm:ss z'}}",
18+
"Content-Type": "application/json; charset=utf-8",
19+
"Server": "GitHub.com",
20+
"Status": "200 OK",
21+
"X-RateLimit-Limit": "5000",
22+
"X-RateLimit-Remaining": "4930",
23+
"X-RateLimit-Reset": "{{now offset='3 seconds' format='unix'}}",
24+
"Cache-Control": "private, max-age=60, s-maxage=60",
25+
"Vary": [
26+
"Accept, Authorization, Cookie, X-GitHub-OTP",
27+
"Accept-Encoding"
28+
],
29+
"ETag": "W/\"1cb30f031c67c499473b3aad01c7f7a5\"",
30+
"Last-Modified": "Thu, 06 Feb 2020 17:29:39 GMT",
31+
"X-OAuth-Scopes": "admin:org, admin:org_hook, admin:public_key, admin:repo_hook, delete_repo, gist, notifications, repo, user, write:discussion",
32+
"X-Accepted-OAuth-Scopes": "",
33+
"X-GitHub-Media-Type": "unknown, github.v3",
34+
"Access-Control-Expose-Headers": "ETag, Link, Location, Retry-After, X-GitHub-OTP, X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset, X-OAuth-Scopes, X-Accepted-OAuth-Scopes, X-Poll-Interval, X-GitHub-Media-Type",
35+
"Access-Control-Allow-Origin": "*",
36+
"Strict-Transport-Security": "max-age=31536000; includeSubdomains; preload",
37+
"X-Frame-Options": "deny",
38+
"X-Content-Type-Options": "nosniff",
39+
"X-XSS-Protection": "1; mode=block",
40+
"Referrer-Policy": "origin-when-cross-origin, strict-origin-when-cross-origin",
41+
"Content-Security-Policy": "default-src 'none'",
42+
"X-GitHub-Request-Id": "CC37:2605:3F884:4E941:5E3C5BFC"
43+
}
44+
},
45+
"uuid": "a60baf84-5b5c-4f86-af3d-cab0d609c7b2",
46+
"persistent": true,
47+
"insertionIndex": 1
48+
}

0 commit comments

Comments
 (0)