Skip to content

Commit 86f32e8

Browse files
author
mrzhao
committed
fix: detect secondary rate limit via response body marker
GitHub does not always return Retry-After or gh-limited-by headers when a secondary rate limit is hit. In those cases the response is a plain 403 whose body contains "You have exceeded a secondary rate limit", which currently slips through GitHubAbuseLimitHandler#isError and surfaces as a generic HttpException. Fall back to matching the "secondary rate" marker in the response body when neither header is present. The body for non-200 responses is already buffered into memory by GitHubConnectorResponse, so this adds no extra I/O for downstream handlers. Fixes #2009
1 parent 3622553 commit 86f32e8

7 files changed

Lines changed: 407 additions & 3 deletions

File tree

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

Lines changed: 43 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,17 @@
11
package org.kohsuke.github;
22

3+
import org.apache.commons.io.IOUtils;
34
import org.kohsuke.github.connector.GitHubConnectorResponse;
45

56
import java.io.IOException;
7+
import java.io.InputStream;
68
import java.io.InterruptedIOException;
9+
import java.nio.charset.StandardCharsets;
710
import java.time.Duration;
811
import java.time.ZonedDateTime;
912
import java.time.format.DateTimeFormatter;
1013
import java.time.temporal.ChronoUnit;
14+
import java.util.regex.Pattern;
1115

1216
import javax.annotation.Nonnull;
1317

@@ -57,6 +61,18 @@ public void onError(GitHubConnectorResponse connectorResponse) throws IOExceptio
5761
*/
5862
private static final int MINIMUM_ABUSE_RETRY_MILLIS = 1000;
5963

64+
/**
65+
* Pattern matching the marker GitHub returns in the response body when the request is rejected by a secondary rate
66+
* limit, regardless of whether {@code Retry-After} or {@code gh-limited-by} headers are present. Used as a fallback
67+
* detection path so that responses without those headers are still recognized.
68+
*
69+
* @see <a href=
70+
* "https://docs.github.com/en/rest/using-the-rest-api/rate-limits-for-the-rest-api?apiVersion=2022-11-28#about-secondary-rate-limits">About
71+
* secondary rate limits</a>
72+
*/
73+
private static final Pattern SECONDARY_RATE_LIMIT_BODY_PATTERN = Pattern.compile("\\bsecondary rate\\b",
74+
Pattern.CASE_INSENSITIVE);
75+
6076
// If "Retry-After" missing, wait for unambiguously over one minute per GitHub guidance
6177
static long DEFAULT_WAIT_MILLIS = Duration.ofSeconds(61).toMillis();
6278

@@ -146,6 +162,25 @@ private boolean hasRetryOrLimitHeader(GitHubConnectorResponse connectorResponse)
146162
return hasHeader(connectorResponse, "Retry-After") || hasHeader(connectorResponse, "gh-limited-by");
147163
}
148164

165+
/**
166+
* Checks if the response body contains the secondary rate limit marker. GitHub does not always return
167+
* {@code Retry-After} or {@code gh-limited-by} headers when a secondary rate limit is hit; in those cases the body
168+
* still contains a "secondary rate" marker that can be matched as a fallback detection path.
169+
*
170+
* @param connectorResponse
171+
* the response from the GitHub connector
172+
* @return true if the response body contains the secondary rate limit marker
173+
* @throws IOException
174+
* if reading the response body fails
175+
* @see <a href="https://github.com/hub4j/github-api/issues/2009">hub4j/github-api#2009</a>
176+
*/
177+
private boolean hasSecondaryRateLimitBodyMarker(GitHubConnectorResponse connectorResponse) throws IOException {
178+
try (InputStream bodyStream = connectorResponse.bodyStream()) {
179+
String body = IOUtils.toString(bodyStream, StandardCharsets.UTF_8);
180+
return SECONDARY_RATE_LIMIT_BODY_PATTERN.matcher(body).find();
181+
}
182+
}
183+
149184
/**
150185
* Checks if the response status code is HTTP_FORBIDDEN (403).
151186
*
@@ -178,9 +213,14 @@ private boolean isTooManyRequests(GitHubConnectorResponse connectorResponse) {
178213
* Signals that an I/O exception has occurred.
179214
*/
180215
@Override
181-
boolean isError(@Nonnull GitHubConnectorResponse connectorResponse) {
182-
return isTooManyRequests(connectorResponse)
183-
|| (isForbidden(connectorResponse) && hasRetryOrLimitHeader(connectorResponse));
216+
boolean isError(@Nonnull GitHubConnectorResponse connectorResponse) throws IOException {
217+
if (isTooManyRequests(connectorResponse)) {
218+
return true;
219+
}
220+
if (!isForbidden(connectorResponse)) {
221+
return false;
222+
}
223+
return hasRetryOrLimitHeader(connectorResponse) || hasSecondaryRateLimitBodyMarker(connectorResponse);
184224
}
185225

186226
}

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

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -389,6 +389,50 @@ public void onError(@NotNull GitHubConnectorResponse connectorResponse) throws I
389389
assertThat(mockGitHub.getRequestCount(), equalTo(3));
390390
}
391391

392+
/**
393+
* Tests the behavior of the GitHub API client when the abuse limit handler encounters a 403 response that contains
394+
* the secondary rate limit marker in the body, but neither the {@code Retry-After} nor the {@code gh-limited-by}
395+
* header. Without body-based detection, this case slips through {@code isError()} and surfaces as a generic
396+
* {@code HttpException} (see hub4j/github-api#2009).
397+
*
398+
* @throws Exception
399+
* if any error occurs during the test execution.
400+
*/
401+
@Test
402+
public void testHandler_Wait_Secondary_Limits_Body_Marker_Only() throws Exception {
403+
snapshotNotAllowed();
404+
gitHub = getGitHubBuilder().withEndpoint(mockGitHub.apiServer().baseUrl())
405+
.withAbuseLimitHandler(new GitHubAbuseLimitHandler() {
406+
/**
407+
* Overriding method because the actual method will wait for one minute causing slowness in unit
408+
* tests.
409+
*/
410+
@Override
411+
public void onError(@NotNull GitHubConnectorResponse connectorResponse) throws IOException {
412+
assertThat(connectorResponse.request().method(), equalTo("GET"));
413+
assertThat(connectorResponse.statusCode(), equalTo(403));
414+
assertThat(connectorResponse.request().url().toString(),
415+
endsWith(
416+
"/repos/hub4j-test-org/temp-testHandler_Wait_Secondary_Limits_Body_Marker_Only"));
417+
assertThat(connectorResponse.header("Retry-After"), nullValue());
418+
assertThat(connectorResponse.header("gh-limited-by"), nullValue());
419+
420+
checkErrorMessageMatches(connectorResponse,
421+
"You have exceeded a secondary rate limit. Please wait a few minutes before you try again");
422+
423+
long waitTime = parseWaitTime(connectorResponse);
424+
assertThat(waitTime, equalTo(GitHubAbuseLimitHandler.DEFAULT_WAIT_MILLIS));
425+
}
426+
})
427+
.build();
428+
429+
gitHub.getMyself();
430+
assertThat(mockGitHub.getRequestCount(), equalTo(1));
431+
432+
getTempRepository();
433+
assertThat(mockGitHub.getRequestCount(), equalTo(3));
434+
}
435+
392436
/**
393437
* Tests the behavior of the GitHub API client when the abuse limit handler is set to WAIT then the handler waits
394438
* appropriately when secondary rate limits are encountered.
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": "bitwiseman@gmail.com",
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+
}
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_Body_Marker_Only",
5+
"full_name": "hub4j-test-org/temp-testHandler_Wait_Secondary_Limits_Body_Marker_Only",
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_Body_Marker_Only",
28+
"description": "A test repository for testing the github-api project: temp-testHandler_Wait_Secondary_Limits_Body_Marker_Only",
29+
"fork": false,
30+
"url": "https://api.github.com/repos/hub4j-test-org/temp-testHandler_Wait_Secondary_Limits_Body_Marker_Only",
31+
"forks_url": "https://api.github.com/repos/hub4j-test-org/temp-testHandler_Wait_Secondary_Limits_Body_Marker_Only/forks",
32+
"keys_url": "https://api.github.com/repos/hub4j-test-org/temp-testHandler_Wait_Secondary_Limits_Body_Marker_Only/keys{/key_id}",
33+
"collaborators_url": "https://api.github.com/repos/hub4j-test-org/temp-testHandler_Wait_Secondary_Limits_Body_Marker_Only/collaborators{/collaborator}",
34+
"teams_url": "https://api.github.com/repos/hub4j-test-org/temp-testHandler_Wait_Secondary_Limits_Body_Marker_Only/teams",
35+
"hooks_url": "https://api.github.com/repos/hub4j-test-org/temp-testHandler_Wait_Secondary_Limits_Body_Marker_Only/hooks",
36+
"issue_events_url": "https://api.github.com/repos/hub4j-test-org/temp-testHandler_Wait_Secondary_Limits_Body_Marker_Only/issues/events{/number}",
37+
"events_url": "https://api.github.com/repos/hub4j-test-org/temp-testHandler_Wait_Secondary_Limits_Body_Marker_Only/events",
38+
"assignees_url": "https://api.github.com/repos/hub4j-test-org/temp-testHandler_Wait_Secondary_Limits_Body_Marker_Only/assignees{/user}",
39+
"branches_url": "https://api.github.com/repos/hub4j-test-org/temp-testHandler_Wait_Secondary_Limits_Body_Marker_Only/branches{/branch}",
40+
"tags_url": "https://api.github.com/repos/hub4j-test-org/temp-testHandler_Wait_Secondary_Limits_Body_Marker_Only/tags",
41+
"blobs_url": "https://api.github.com/repos/hub4j-test-org/temp-testHandler_Wait_Secondary_Limits_Body_Marker_Only/git/blobs{/sha}",
42+
"git_tags_url": "https://api.github.com/repos/hub4j-test-org/temp-testHandler_Wait_Secondary_Limits_Body_Marker_Only/git/tags{/sha}",
43+
"git_refs_url": "https://api.github.com/repos/hub4j-test-org/temp-testHandler_Wait_Secondary_Limits_Body_Marker_Only/git/refs{/sha}",
44+
"trees_url": "https://api.github.com/repos/hub4j-test-org/temp-testHandler_Wait_Secondary_Limits_Body_Marker_Only/git/trees{/sha}",
45+
"statuses_url": "https://api.github.com/repos/hub4j-test-org/temp-testHandler_Wait_Secondary_Limits_Body_Marker_Only/statuses/{sha}",
46+
"languages_url": "https://api.github.com/repos/hub4j-test-org/temp-testHandler_Wait_Secondary_Limits_Body_Marker_Only/languages",
47+
"stargazers_url": "https://api.github.com/repos/hub4j-test-org/temp-testHandler_Wait_Secondary_Limits_Body_Marker_Only/stargazers",
48+
"contributors_url": "https://api.github.com/repos/hub4j-test-org/temp-testHandler_Wait_Secondary_Limits_Body_Marker_Only/contributors",
49+
"subscribers_url": "https://api.github.com/repos/hub4j-test-org/temp-testHandler_Wait_Secondary_Limits_Body_Marker_Only/subscribers",
50+
"subscription_url": "https://api.github.com/repos/hub4j-test-org/temp-testHandler_Wait_Secondary_Limits_Body_Marker_Only/subscription",
51+
"commits_url": "https://api.github.com/repos/hub4j-test-org/temp-testHandler_Wait_Secondary_Limits_Body_Marker_Only/commits{/sha}",
52+
"git_commits_url": "https://api.github.com/repos/hub4j-test-org/temp-testHandler_Wait_Secondary_Limits_Body_Marker_Only/git/commits{/sha}",
53+
"comments_url": "https://api.github.com/repos/hub4j-test-org/temp-testHandler_Wait_Secondary_Limits_Body_Marker_Only/comments{/number}",
54+
"issue_comment_url": "https://api.github.com/repos/hub4j-test-org/temp-testHandler_Wait_Secondary_Limits_Body_Marker_Only/issues/comments{/number}",
55+
"contents_url": "https://api.github.com/repos/hub4j-test-org/temp-testHandler_Wait_Secondary_Limits_Body_Marker_Only/contents/{+path}",
56+
"compare_url": "https://api.github.com/repos/hub4j-test-org/temp-testHandler_Wait_Secondary_Limits_Body_Marker_Only/compare/{base}...{head}",
57+
"merges_url": "https://api.github.com/repos/hub4j-test-org/temp-testHandler_Wait_Secondary_Limits_Body_Marker_Only/merges",
58+
"archive_url": "https://api.github.com/repos/hub4j-test-org/temp-testHandler_Wait_Secondary_Limits_Body_Marker_Only/{archive_format}{/ref}",
59+
"downloads_url": "https://api.github.com/repos/hub4j-test-org/temp-testHandler_Wait_Secondary_Limits_Body_Marker_Only/downloads",
60+
"issues_url": "https://api.github.com/repos/hub4j-test-org/temp-testHandler_Wait_Secondary_Limits_Body_Marker_Only/issues{/number}",
61+
"pulls_url": "https://api.github.com/repos/hub4j-test-org/temp-testHandler_Wait_Secondary_Limits_Body_Marker_Only/pulls{/number}",
62+
"milestones_url": "https://api.github.com/repos/hub4j-test-org/temp-testHandler_Wait_Secondary_Limits_Body_Marker_Only/milestones{/number}",
63+
"notifications_url": "https://api.github.com/repos/hub4j-test-org/temp-testHandler_Wait_Secondary_Limits_Body_Marker_Only/notifications{?since,all,participating}",
64+
"labels_url": "https://api.github.com/repos/hub4j-test-org/temp-testHandler_Wait_Secondary_Limits_Body_Marker_Only/labels{/name}",
65+
"releases_url": "https://api.github.com/repos/hub4j-test-org/temp-testHandler_Wait_Secondary_Limits_Body_Marker_Only/releases{/id}",
66+
"deployments_url": "https://api.github.com/repos/hub4j-test-org/temp-testHandler_Wait_Secondary_Limits_Body_Marker_Only/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_Body_Marker_Only.git",
71+
"ssh_url": "git@github.com:hub4j-test-org/temp-testHandler_Wait_Secondary_Limits_Body_Marker_Only.git",
72+
"clone_url": "https://github.com/hub4j-test-org/temp-testHandler_Wait_Secondary_Limits_Body_Marker_Only.git",
73+
"svn_url": "https://github.com/hub4j-test-org/temp-testHandler_Wait_Secondary_Limits_Body_Marker_Only",
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+
}
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
{
2+
"id": "a60baf84-5b5c-4f86-af3d-cab0d609c7c3",
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-cab0d609c7c3",
46+
"persistent": true,
47+
"insertionIndex": 1
48+
}

0 commit comments

Comments
 (0)