Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(core): parse legacy rate limit if new rate limit not exist #7614

Closed
wants to merge 4 commits into from
Closed
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
44 changes: 34 additions & 10 deletions core/internal/api/ratelimitheaders.go
Original file line number Diff line number Diff line change
Expand Up @@ -21,18 +21,42 @@

// Parses RateLimitHeaders out of the HTTP header.
func ParseRateLimitHeaders(header http.Header) (RateLimitHeaders, bool) {
rlRemaining, err := strconv.ParseFloat(header.Get("RateLimit-Remaining"), 64)
if err != nil || rlRemaining < 0 {
return RateLimitHeaders{}, false
headers := RateLimitHeaders{}

remainingStr := header.Get("RateLimit-Remaining")
resetStr := header.Get("RateLimit-Reset")

if remainingStr != "" && resetStr != "" {
remaining, err := strconv.ParseFloat(remainingStr, 64)
if err != nil || remaining < 0 {
return RateLimitHeaders{}, false
}

reset, err := strconv.ParseFloat(resetStr, 64)
if err != nil || reset < 0 {
return RateLimitHeaders{}, false
}

headers.Remaining = remaining
headers.Reset = reset
return headers, true
}

rlReset, err := strconv.ParseFloat(header.Get("RateLimit-Reset"), 64)
if err != nil || rlReset < 0 {
return RateLimitHeaders{}, false
// legacy entity level rate limit headers
legacyRemainingStr := header.Get("X-RateLimit-Remaining")
if legacyRemainingStr != "" {
remaining, err := strconv.ParseFloat(legacyRemainingStr, 64)
if err != nil || remaining < 0 {
return RateLimitHeaders{}, false

Check warning on line 50 in core/internal/api/ratelimitheaders.go

View check run for this annotation

Codecov / codecov/patch

core/internal/api/ratelimitheaders.go#L50

Added line #L50 was not covered by tests
}

headers.Remaining = remaining
// legacy rate limit doesn't send back a reset time
headers.Reset = 0
return headers, true
}

return RateLimitHeaders{
Remaining: rlRemaining,
Reset: rlReset,
}, true
return RateLimitHeaders{}, false
}


34 changes: 34 additions & 0 deletions core/internal/api/ratelimitheaders_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -59,3 +59,37 @@ func Test_ResetNegative(t *testing.T) {

assert.False(t, ok)
}

func Test_NoValue(t *testing.T) {
header := http.Header{}

_, ok := api.ParseRateLimitHeaders(header)

assert.False(t, ok)
}


func Test_UseLegacyRateLimit(t *testing.T) {
header := http.Header{}
header.Set("X-RateLimit-Remaining", "123.5")

result, ok := api.ParseRateLimitHeaders(header)

assert.True(t, ok)
assert.EqualValues(t, 123.5, result.Remaining)
assert.EqualValues(t, 0, result.Reset)
}

func Test_UseNewRateLimitOverLegacy(t *testing.T) {
header := http.Header{}
header.Set("X-RateLimit-Remaining", "100")
header.Set("RateLimit-Remaining", "200")
header.Set("RateLimit-Reset", "50")

result, ok := api.ParseRateLimitHeaders(header)

assert.True(t, ok)
assert.EqualValues(t, 200, result.Remaining)
assert.EqualValues(t, 50, result.Reset)
}