mirror of
https://github.com/git/git.git
synced 2026-03-11 17:39:46 +01:00
Merge branch 'vp/http-rate-limit-retries' into seen
The HTTP transport learned to react to "429 Too Many Requests". * vp/http-rate-limit-retries: http: add support for HTTP 429 rate limit retries remote-curl: introduce show_http_message_fatal() helper strbuf_attach: fix call sites to pass correct alloc strbuf: pass correct alloc to strbuf_attach() in strbuf_reencode()
This commit is contained in:
Junio C Hamano
@@ -167,6 +167,7 @@ prepare_httpd() {
|
||||
install_script error.sh
|
||||
install_script apply-one-time-script.sh
|
||||
install_script nph-custom-auth.sh
|
||||
install_script http-429.sh
|
||||
|
||||
ln -s "$LIB_HTTPD_MODULE_PATH" "$HTTPD_ROOT_PATH/modules"
|
||||
|
||||
|
||||
@@ -139,6 +139,10 @@ SetEnv PERL_PATH ${PERL_PATH}
|
||||
SetEnv GIT_EXEC_PATH ${GIT_EXEC_PATH}
|
||||
SetEnv GIT_HTTP_EXPORT_ALL
|
||||
</LocationMatch>
|
||||
<LocationMatch /http_429/>
|
||||
SetEnv GIT_EXEC_PATH ${GIT_EXEC_PATH}
|
||||
SetEnv GIT_HTTP_EXPORT_ALL
|
||||
</LocationMatch>
|
||||
<LocationMatch /smart_v0/>
|
||||
SetEnv GIT_EXEC_PATH ${GIT_EXEC_PATH}
|
||||
SetEnv GIT_HTTP_EXPORT_ALL
|
||||
@@ -160,6 +164,7 @@ ScriptAlias /broken_smart/ broken-smart-http.sh/
|
||||
ScriptAlias /error_smart/ error-smart-http.sh/
|
||||
ScriptAlias /error/ error.sh/
|
||||
ScriptAliasMatch /one_time_script/(.*) apply-one-time-script.sh/$1
|
||||
ScriptAliasMatch /http_429/(.*) http-429.sh/$1
|
||||
ScriptAliasMatch /custom_auth/(.*) nph-custom-auth.sh/$1
|
||||
<Directory ${GIT_EXEC_PATH}>
|
||||
Options FollowSymlinks
|
||||
@@ -185,6 +190,9 @@ ScriptAliasMatch /custom_auth/(.*) nph-custom-auth.sh/$1
|
||||
<Files apply-one-time-script.sh>
|
||||
Options ExecCGI
|
||||
</Files>
|
||||
<Files http-429.sh>
|
||||
Options ExecCGI
|
||||
</Files>
|
||||
<Files ${GIT_EXEC_PATH}/git-http-backend>
|
||||
Options ExecCGI
|
||||
</Files>
|
||||
|
||||
98
t/lib-httpd/http-429.sh
Normal file
98
t/lib-httpd/http-429.sh
Normal file
@@ -0,0 +1,98 @@
|
||||
#!/bin/sh
|
||||
|
||||
# Script to return HTTP 429 Too Many Requests responses for testing retry logic.
|
||||
# Usage: /http_429/<test-context>/<retry-after-value>/<repo-path>
|
||||
#
|
||||
# The test-context is a unique identifier for each test to isolate state files.
|
||||
# The retry-after-value can be:
|
||||
# - A number (e.g., "1", "2", "100") - sets Retry-After header to that many seconds
|
||||
# - "none" - no Retry-After header
|
||||
# - "invalid" - invalid Retry-After format
|
||||
# - "permanent" - always return 429 (never succeed)
|
||||
# - An HTTP-date string (RFC 2822 format) - sets Retry-After to that date
|
||||
#
|
||||
# On first call, returns 429. On subsequent calls (after retry), forwards to git-http-backend
|
||||
# unless retry-after-value is "permanent".
|
||||
|
||||
# Extract test context, retry-after value and repo path from PATH_INFO
|
||||
# PATH_INFO format: /<test-context>/<retry-after-value>/<repo-path>
|
||||
path_info="${PATH_INFO#/}" # Remove leading slash
|
||||
test_context="${path_info%%/*}" # Get first component (test context)
|
||||
remaining="${path_info#*/}" # Get rest
|
||||
retry_after="${remaining%%/*}" # Get second component (retry-after value)
|
||||
repo_path="${remaining#*/}" # Get rest (repo path)
|
||||
|
||||
# Extract repository name from repo_path (e.g., "repo.git" from "repo.git/info/refs")
|
||||
# The repo name is the first component before any "/"
|
||||
repo_name="${repo_path%%/*}"
|
||||
|
||||
# Use current directory (HTTPD_ROOT_PATH) for state file
|
||||
# Create a safe filename from test_context, retry_after and repo_name
|
||||
# This ensures all requests for the same test context share the same state file
|
||||
safe_name=$(echo "${test_context}-${retry_after}-${repo_name}" | tr '/' '_' | tr -cd 'a-zA-Z0-9_-')
|
||||
state_file="http-429-state-${safe_name}"
|
||||
|
||||
# Check if this is the first call (no state file exists)
|
||||
if test -f "$state_file"
|
||||
then
|
||||
# Already returned 429 once, forward to git-http-backend
|
||||
# Set PATH_INFO to just the repo path (without retry-after value)
|
||||
# Set GIT_PROJECT_ROOT so git-http-backend can find the repository
|
||||
# Use exec to replace this process so git-http-backend gets the updated environment
|
||||
PATH_INFO="/$repo_path"
|
||||
export PATH_INFO
|
||||
# GIT_PROJECT_ROOT points to the document root where repositories are stored
|
||||
# The script runs from HTTPD_ROOT_PATH, and www/ is the document root
|
||||
if test -z "$GIT_PROJECT_ROOT"
|
||||
then
|
||||
# Construct path: current directory (HTTPD_ROOT_PATH) + /www
|
||||
GIT_PROJECT_ROOT="$(pwd)/www"
|
||||
export GIT_PROJECT_ROOT
|
||||
fi
|
||||
exec "$GIT_EXEC_PATH/git-http-backend"
|
||||
fi
|
||||
|
||||
# Mark that we've returned 429
|
||||
touch "$state_file"
|
||||
|
||||
# Output HTTP 429 response
|
||||
printf "Status: 429 Too Many Requests\r\n"
|
||||
|
||||
# Set Retry-After header based on retry_after value
|
||||
case "$retry_after" in
|
||||
none)
|
||||
# No Retry-After header
|
||||
;;
|
||||
invalid)
|
||||
printf "Retry-After: invalid-format-123abc\r\n"
|
||||
;;
|
||||
permanent)
|
||||
# Always return 429, don't set state file for success
|
||||
rm -f "$state_file"
|
||||
printf "Retry-After: 1\r\n"
|
||||
printf "Content-Type: text/plain\r\n"
|
||||
printf "\r\n"
|
||||
printf "Permanently rate limited\n"
|
||||
exit 0
|
||||
;;
|
||||
*)
|
||||
# Check if it's a number
|
||||
case "$retry_after" in
|
||||
[0-9]*)
|
||||
# Numeric value
|
||||
printf "Retry-After: %s\r\n" "$retry_after"
|
||||
;;
|
||||
*)
|
||||
# Assume it's an HTTP-date format (passed as-is, URL decoded)
|
||||
# Apache may URL-encode the path, so decode common URL-encoded characters
|
||||
# %20 = space, %2C = comma, %3A = colon
|
||||
retry_value=$(echo "$retry_after" | sed -e 's/%20/ /g' -e 's/%2C/,/g' -e 's/%3A/:/g')
|
||||
printf "Retry-After: %s\r\n" "$retry_value"
|
||||
;;
|
||||
esac
|
||||
;;
|
||||
esac
|
||||
|
||||
printf "Content-Type: text/plain\r\n"
|
||||
printf "\r\n"
|
||||
printf "Rate limited\n"
|
||||
@@ -712,6 +712,7 @@ integration_tests = [
|
||||
't5581-http-curl-verbose.sh',
|
||||
't5582-fetch-negative-refspec.sh',
|
||||
't5583-push-branches.sh',
|
||||
't5584-http-429-retry.sh',
|
||||
't5600-clone-fail-cleanup.sh',
|
||||
't5601-clone.sh',
|
||||
't5602-clone-remote-exec.sh',
|
||||
|
||||
266
t/t5584-http-429-retry.sh
Executable file
266
t/t5584-http-429-retry.sh
Executable file
@@ -0,0 +1,266 @@
|
||||
#!/bin/sh
|
||||
|
||||
test_description='test HTTP 429 Too Many Requests retry logic'
|
||||
|
||||
. ./test-lib.sh
|
||||
|
||||
. "$TEST_DIRECTORY"/lib-httpd.sh
|
||||
|
||||
start_httpd
|
||||
|
||||
test_expect_success 'setup test repository' '
|
||||
test_commit initial &&
|
||||
git clone --bare . "$HTTPD_DOCUMENT_ROOT_PATH/repo.git" &&
|
||||
git --git-dir="$HTTPD_DOCUMENT_ROOT_PATH/repo.git" config http.receivepack true
|
||||
'
|
||||
|
||||
# This test suite uses a special HTTP 429 endpoint at /http_429/ that simulates
|
||||
# rate limiting. The endpoint format is:
|
||||
# /http_429/<test-context>/<retry-after-value>/<repo-path>
|
||||
# The http-429.sh script (in t/lib-httpd) returns a 429 response with the
|
||||
# specified Retry-After header on the first request for each test context,
|
||||
# then forwards subsequent requests to git-http-backend. Each test context
|
||||
# is isolated, allowing multiple tests to run independently.
|
||||
|
||||
test_expect_success 'HTTP 429 with retries disabled (maxRetries=0) fails immediately' '
|
||||
# Set maxRetries to 0 (disabled)
|
||||
test_config http.maxRetries 0 &&
|
||||
test_config http.retryAfter 1 &&
|
||||
|
||||
# Should fail immediately without any retry attempt
|
||||
test_must_fail git ls-remote "$HTTPD_URL/http_429/retries-disabled/1/repo.git" 2>err &&
|
||||
|
||||
# Verify no retry happened (no "waiting" message in stderr)
|
||||
test_grep ! -i "waiting.*retry" err
|
||||
'
|
||||
|
||||
test_expect_success 'HTTP 429 permanent should fail after max retries' '
|
||||
# Enable retries with a limit
|
||||
test_config http.maxRetries 2 &&
|
||||
|
||||
# Git should retry but eventually fail when 429 persists
|
||||
test_must_fail git ls-remote "$HTTPD_URL/http_429/permanent-fail/permanent/repo.git" 2>err
|
||||
'
|
||||
|
||||
test_expect_success 'HTTP 429 with Retry-After is retried and succeeds' '
|
||||
# Enable retries
|
||||
test_config http.maxRetries 3 &&
|
||||
|
||||
# Git should retry after receiving 429 and eventually succeed
|
||||
git ls-remote "$HTTPD_URL/http_429/retry-succeeds/1/repo.git" >output 2>err &&
|
||||
test_grep "refs/heads/" output
|
||||
'
|
||||
|
||||
test_expect_success 'HTTP 429 without Retry-After uses configured default' '
|
||||
# Enable retries and configure default delay
|
||||
test_config http.maxRetries 3 &&
|
||||
test_config http.retryAfter 1 &&
|
||||
|
||||
# Git should retry using configured default and succeed
|
||||
git ls-remote "$HTTPD_URL/http_429/no-retry-after-header/none/repo.git" >output 2>err &&
|
||||
test_grep "refs/heads/" output
|
||||
'
|
||||
|
||||
test_expect_success 'HTTP 429 retry delays are respected' '
|
||||
# Enable retries
|
||||
test_config http.maxRetries 3 &&
|
||||
|
||||
# Time the operation - it should take at least 2 seconds due to retry delay
|
||||
start=$(test-tool date getnanos) &&
|
||||
git ls-remote "$HTTPD_URL/http_429/retry-delays-respected/2/repo.git" >output 2>err &&
|
||||
duration=$(test-tool date getnanos $start) &&
|
||||
|
||||
# Verify it took at least 2 seconds (allowing some tolerance)
|
||||
duration_int=${duration%.*} &&
|
||||
test "$duration_int" -ge 1 &&
|
||||
test_grep "refs/heads/" output
|
||||
'
|
||||
|
||||
test_expect_success 'HTTP 429 fails immediately if Retry-After exceeds http.maxRetryTime' '
|
||||
# Configure max retry time to 3 seconds (much less than requested 100)
|
||||
test_config http.maxRetries 3 &&
|
||||
test_config http.maxRetryTime 3 &&
|
||||
|
||||
# Should fail immediately without waiting
|
||||
start=$(test-tool date getnanos) &&
|
||||
test_must_fail git ls-remote "$HTTPD_URL/http_429/retry-after-exceeds-max-time/100/repo.git" 2>err &&
|
||||
duration=$(test-tool date getnanos $start) &&
|
||||
|
||||
# Should fail quickly (less than 2 seconds, no 100 second wait)
|
||||
duration_int=${duration%.*} &&
|
||||
test "$duration_int" -lt 2 &&
|
||||
test_grep "greater than http.maxRetryTime" err
|
||||
'
|
||||
|
||||
test_expect_success 'HTTP 429 fails if configured http.retryAfter exceeds http.maxRetryTime' '
|
||||
# Test misconfiguration: retryAfter > maxRetryTime
|
||||
# Configure retryAfter larger than maxRetryTime
|
||||
test_config http.maxRetries 3 &&
|
||||
test_config http.retryAfter 100 &&
|
||||
test_config http.maxRetryTime 5 &&
|
||||
|
||||
# Should fail immediately with configuration error
|
||||
start=$(test-tool date getnanos) &&
|
||||
test_must_fail git ls-remote "$HTTPD_URL/http_429/config-retry-after-exceeds-max-time/none/repo.git" 2>err &&
|
||||
duration=$(test-tool date getnanos $start) &&
|
||||
|
||||
# Should fail quickly
|
||||
duration_int=${duration%.*} &&
|
||||
test "$duration_int" -lt 2 &&
|
||||
test_grep "configured http.retryAfter.*exceeds.*http.maxRetryTime" err
|
||||
'
|
||||
|
||||
test_expect_success 'HTTP 429 with Retry-After HTTP-date format' '
|
||||
# Test HTTP-date format (RFC 2822) in Retry-After header
|
||||
raw=$(test-tool date timestamp now) &&
|
||||
now="${raw#* -> }" &&
|
||||
future_time=$((now + 2)) &&
|
||||
raw=$(test-tool date show:rfc2822 $future_time) &&
|
||||
future_date="${raw#* -> }" &&
|
||||
future_date_encoded=$(echo "$future_date" | sed "s/ /%20/g") &&
|
||||
|
||||
# Enable retries
|
||||
test_config http.maxRetries 3 &&
|
||||
|
||||
# Git should parse the HTTP-date and retry after the delay
|
||||
start=$(test-tool date getnanos) &&
|
||||
git ls-remote "$HTTPD_URL/http_429/http-date-format/$future_date_encoded/repo.git" >output 2>err &&
|
||||
duration=$(test-tool date getnanos $start) &&
|
||||
|
||||
# Should take at least 1 second (allowing tolerance for processing time)
|
||||
duration_int=${duration%.*} &&
|
||||
test "$duration_int" -ge 1 &&
|
||||
test_grep "refs/heads/" output
|
||||
'
|
||||
|
||||
test_expect_success 'HTTP 429 with HTTP-date exceeding maxRetryTime fails immediately' '
|
||||
raw=$(test-tool date timestamp now) &&
|
||||
now="${raw#* -> }" &&
|
||||
future_time=$((now + 200)) &&
|
||||
raw=$(test-tool date show:rfc2822 $future_time) &&
|
||||
future_date="${raw#* -> }" &&
|
||||
future_date_encoded=$(echo "$future_date" | sed "s/ /%20/g") &&
|
||||
|
||||
# Configure max retry time much less than the 200 second delay
|
||||
test_config http.maxRetries 3 &&
|
||||
test_config http.maxRetryTime 10 &&
|
||||
|
||||
# Should fail immediately without waiting 200 seconds
|
||||
start=$(test-tool date getnanos) &&
|
||||
test_must_fail git ls-remote "$HTTPD_URL/http_429/http-date-exceeds-max-time/$future_date_encoded/repo.git" 2>err &&
|
||||
duration=$(test-tool date getnanos $start) &&
|
||||
|
||||
# Should fail quickly (not wait 200 seconds)
|
||||
duration_int=${duration%.*} &&
|
||||
test "$duration_int" -lt 2 &&
|
||||
test_grep "http.maxRetryTime" err
|
||||
'
|
||||
|
||||
test_expect_success 'HTTP 429 with past HTTP-date should not wait' '
|
||||
raw=$(test-tool date timestamp now) &&
|
||||
now="${raw#* -> }" &&
|
||||
past_time=$((now - 10)) &&
|
||||
raw=$(test-tool date show:rfc2822 $past_time) &&
|
||||
past_date="${raw#* -> }" &&
|
||||
past_date_encoded=$(echo "$past_date" | sed "s/ /%20/g") &&
|
||||
|
||||
# Enable retries
|
||||
test_config http.maxRetries 3 &&
|
||||
|
||||
# Git should retry immediately without waiting
|
||||
start=$(test-tool date getnanos) &&
|
||||
git ls-remote "$HTTPD_URL/http_429/past-http-date/$past_date_encoded/repo.git" >output 2>err &&
|
||||
duration=$(test-tool date getnanos $start) &&
|
||||
|
||||
# Should complete quickly (less than 2 seconds)
|
||||
duration_int=${duration%.*} &&
|
||||
test "$duration_int" -lt 2 &&
|
||||
test_grep "refs/heads/" output
|
||||
'
|
||||
|
||||
test_expect_success 'HTTP 429 with invalid Retry-After format uses configured default' '
|
||||
# Configure default retry-after
|
||||
test_config http.maxRetries 3 &&
|
||||
test_config http.retryAfter 1 &&
|
||||
|
||||
# Should use configured default (1 second) since header is invalid
|
||||
start=$(test-tool date getnanos) &&
|
||||
git ls-remote "$HTTPD_URL/http_429/invalid-retry-after-format/invalid/repo.git" >output 2>err &&
|
||||
duration=$(test-tool date getnanos $start) &&
|
||||
|
||||
# Should take at least 1 second (the configured default)
|
||||
duration_int=${duration%.*} &&
|
||||
test "$duration_int" -ge 1 &&
|
||||
test_grep "refs/heads/" output &&
|
||||
test_grep "waiting.*retry" err
|
||||
'
|
||||
|
||||
test_expect_success 'HTTP 429 will not be retried without config' '
|
||||
# Default config means http.maxRetries=0 (retries disabled)
|
||||
# When 429 is received, it should fail immediately without retry
|
||||
# Do NOT configure anything - use defaults (http.maxRetries defaults to 0)
|
||||
|
||||
# Should fail immediately without retry
|
||||
test_must_fail git ls-remote "$HTTPD_URL/http_429/no-retry-without-config/1/repo.git" 2>err &&
|
||||
|
||||
# Verify no retry happened (no "waiting" message)
|
||||
test_grep ! -i "waiting.*retry" err &&
|
||||
|
||||
# Should get 429 error
|
||||
test_grep "429" err
|
||||
'
|
||||
|
||||
test_expect_success 'GIT_HTTP_RETRY_AFTER overrides http.retryAfter config' '
|
||||
# Configure retryAfter to 10 seconds
|
||||
test_config http.maxRetries 3 &&
|
||||
test_config http.retryAfter 10 &&
|
||||
|
||||
# Override with environment variable to 1 second
|
||||
start=$(test-tool date getnanos) &&
|
||||
GIT_HTTP_RETRY_AFTER=1 git ls-remote "$HTTPD_URL/http_429/env-retry-after-override/none/repo.git" >output 2>err &&
|
||||
duration=$(test-tool date getnanos $start) &&
|
||||
|
||||
# Should use env var (1 second), not config (10 seconds)
|
||||
duration_int=${duration%.*} &&
|
||||
test "$duration_int" -ge 1 &&
|
||||
test "$duration_int" -lt 5 &&
|
||||
test_grep "refs/heads/" output &&
|
||||
test_grep "waiting.*retry" err
|
||||
'
|
||||
|
||||
test_expect_success 'GIT_HTTP_MAX_RETRIES overrides http.maxRetries config' '
|
||||
# Configure maxRetries to 0 (disabled)
|
||||
test_config http.maxRetries 0 &&
|
||||
test_config http.retryAfter 1 &&
|
||||
|
||||
# Override with environment variable to enable retries
|
||||
GIT_HTTP_MAX_RETRIES=3 git ls-remote "$HTTPD_URL/http_429/env-max-retries-override/1/repo.git" >output 2>err &&
|
||||
|
||||
# Should retry (env var enables it despite config saying disabled)
|
||||
test_grep "refs/heads/" output &&
|
||||
test_grep "waiting.*retry" err
|
||||
'
|
||||
|
||||
test_expect_success 'GIT_HTTP_MAX_RETRY_TIME overrides http.maxRetryTime config' '
|
||||
# Configure maxRetryTime to 100 seconds (would accept 50 second delay)
|
||||
test_config http.maxRetries 3 &&
|
||||
test_config http.maxRetryTime 100 &&
|
||||
|
||||
# Override with environment variable to 10 seconds (should reject 50 second delay)
|
||||
start=$(test-tool date getnanos) &&
|
||||
test_must_fail env GIT_HTTP_MAX_RETRY_TIME=10 \
|
||||
git ls-remote "$HTTPD_URL/http_429/env-max-retry-time-override/50/repo.git" 2>err &&
|
||||
duration=$(test-tool date getnanos $start) &&
|
||||
|
||||
# Should fail quickly (not wait 50 seconds) because env var limits to 10
|
||||
duration_int=${duration%.*} &&
|
||||
test "$duration_int" -lt 5 &&
|
||||
test_grep "greater than http.maxRetryTime" err
|
||||
'
|
||||
|
||||
test_expect_success 'verify normal repository access still works' '
|
||||
git ls-remote "$HTTPD_URL/smart/repo.git" >output &&
|
||||
test_grep "refs/heads/" output
|
||||
'
|
||||
|
||||
test_done
|
||||
Reference in New Issue
Block a user