fix: survive short network outages when downloading (#2953)
* fix: use exponential backoff when a download fails The retry used a flat 3 second wait over 3 attempts, which covers only about 6 seconds of downtime. A CI runner lost DNS for approximately a minute and the PyPy download failed. Wait 3, 6, 12, 24, then 48 seconds over 6 attempts. Assisted-by: ClaudeCode:claude-opus-5 * ci: raise the uv HTTP retry count uv stops after 3 retries, which was too few when a runner lost DNS for approximately a minute during a test run. Assisted-by: ClaudeCode:claude-opus-5 * fix: do not retry a download after a client error A bad URL will not fix itself, and the longer backoff made the wait before the report about 93 seconds. Report 4xx responses at once, and keep retrying 5xx. Assisted-by: ClaudeCode:claude-opus-5
This commit is contained in:
@@ -1,6 +1,10 @@
|
||||
from __future__ import annotations
|
||||
|
||||
import io
|
||||
import ssl
|
||||
import time
|
||||
import urllib.error
|
||||
import urllib.request
|
||||
|
||||
import certifi
|
||||
import pytest
|
||||
@@ -9,9 +13,12 @@ from cibuildwheel.util.file import download
|
||||
|
||||
TYPE_CHECKING = False
|
||||
if TYPE_CHECKING:
|
||||
from collections.abc import Callable, Iterator
|
||||
from pathlib import Path
|
||||
from typing import Self
|
||||
|
||||
DOWNLOAD_URL = "https://cdn.jsdelivr.net/gh/pypa/cibuildwheel@v1.6.3/requirements-dev.txt"
|
||||
PAYLOAD = b"payload"
|
||||
|
||||
|
||||
def test_download(monkeypatch: pytest.MonkeyPatch, tmp_path: Path) -> None:
|
||||
@@ -35,3 +42,131 @@ def test_download_bad_ssl_cert_file(monkeypatch: pytest.MonkeyPatch, tmp_path: P
|
||||
dest = tmp_path / "file.txt"
|
||||
with pytest.raises(ssl.SSLError):
|
||||
download(DOWNLOAD_URL, dest)
|
||||
|
||||
|
||||
def _no_sleep(seconds: float) -> None:
|
||||
pass
|
||||
|
||||
|
||||
@pytest.fixture
|
||||
def http_error() -> Iterator[Callable[[str, int], urllib.error.HTTPError]]:
|
||||
"""Build HTTPErrors, and close them, as each one holds a temporary file."""
|
||||
errors = []
|
||||
|
||||
def make(url: str, code: int) -> urllib.error.HTTPError:
|
||||
error = urllib.error.HTTPError(url, code, "error", {}, io.BytesIO(b"")) # type: ignore[arg-type]
|
||||
errors.append(error)
|
||||
return error
|
||||
|
||||
yield make
|
||||
|
||||
for error in errors:
|
||||
error.close()
|
||||
|
||||
|
||||
class FakeResponse:
|
||||
def __enter__(self) -> Self:
|
||||
return self
|
||||
|
||||
def __exit__(self, *args: object) -> None:
|
||||
return None
|
||||
|
||||
def read(self) -> bytes:
|
||||
return PAYLOAD
|
||||
|
||||
|
||||
@pytest.fixture
|
||||
def fake_network(
|
||||
monkeypatch: pytest.MonkeyPatch,
|
||||
) -> Callable[[int], tuple[list[str], list[float]]]:
|
||||
"""Fail the first ``failures`` downloads, recording attempts and sleeps."""
|
||||
|
||||
def setup(failures: int) -> tuple[list[str], list[float]]:
|
||||
attempts: list[str] = []
|
||||
sleeps: list[float] = []
|
||||
|
||||
def fake_urlopen(url: str, context: object = None) -> FakeResponse: # noqa: ARG001
|
||||
attempts.append(url)
|
||||
if len(attempts) <= failures:
|
||||
msg = "temporary DNS failure"
|
||||
raise OSError(msg)
|
||||
return FakeResponse()
|
||||
|
||||
monkeypatch.setattr(urllib.request, "urlopen", fake_urlopen)
|
||||
monkeypatch.setattr(time, "sleep", sleeps.append)
|
||||
return attempts, sleeps
|
||||
|
||||
return setup
|
||||
|
||||
|
||||
def test_download_retries_transient_failures(
|
||||
fake_network: Callable[[int], tuple[list[str], list[float]]], tmp_path: Path
|
||||
) -> None:
|
||||
attempts, sleeps = fake_network(3)
|
||||
dest = tmp_path / "file.txt"
|
||||
|
||||
download(DOWNLOAD_URL, dest)
|
||||
|
||||
assert dest.read_bytes() == PAYLOAD
|
||||
assert len(attempts) == 4
|
||||
# the wait must grow, so that a long outage is survivable
|
||||
assert sleeps == sorted(sleeps)
|
||||
assert sleeps[-1] > sleeps[0]
|
||||
|
||||
|
||||
def test_download_backoff_covers_a_minute_outage(
|
||||
fake_network: Callable[[int], tuple[list[str], list[float]]], tmp_path: Path
|
||||
) -> None:
|
||||
_, sleeps = fake_network(99)
|
||||
dest = tmp_path / "file.txt"
|
||||
|
||||
with pytest.raises(OSError, match="temporary DNS failure"):
|
||||
download(DOWNLOAD_URL, dest)
|
||||
|
||||
assert sum(sleeps) >= 60
|
||||
|
||||
|
||||
@pytest.mark.parametrize("code", [400, 404, 410])
|
||||
def test_download_does_not_retry_client_errors(
|
||||
monkeypatch: pytest.MonkeyPatch,
|
||||
tmp_path: Path,
|
||||
code: int,
|
||||
http_error: Callable[[str, int], urllib.error.HTTPError],
|
||||
) -> None:
|
||||
"""A bad URL is not going to fix itself, so report it at once."""
|
||||
attempts: list[str] = []
|
||||
|
||||
def fake_urlopen(url: str, context: object = None) -> FakeResponse: # noqa: ARG001
|
||||
attempts.append(url)
|
||||
raise http_error(url, code)
|
||||
|
||||
monkeypatch.setattr(urllib.request, "urlopen", fake_urlopen)
|
||||
monkeypatch.setattr(time, "sleep", _no_sleep)
|
||||
|
||||
with pytest.raises(urllib.error.HTTPError):
|
||||
download(DOWNLOAD_URL, tmp_path / "file.txt")
|
||||
|
||||
assert len(attempts) == 1
|
||||
|
||||
|
||||
@pytest.mark.parametrize("code", [500, 503])
|
||||
def test_download_retries_server_errors(
|
||||
monkeypatch: pytest.MonkeyPatch,
|
||||
tmp_path: Path,
|
||||
code: int,
|
||||
http_error: Callable[[str, int], urllib.error.HTTPError],
|
||||
) -> None:
|
||||
attempts: list[str] = []
|
||||
|
||||
def fake_urlopen(url: str, context: object = None) -> FakeResponse: # noqa: ARG001
|
||||
attempts.append(url)
|
||||
if len(attempts) == 1:
|
||||
raise http_error(url, code)
|
||||
return FakeResponse()
|
||||
|
||||
monkeypatch.setattr(urllib.request, "urlopen", fake_urlopen)
|
||||
monkeypatch.setattr(time, "sleep", _no_sleep)
|
||||
|
||||
download(DOWNLOAD_URL, tmp_path / "file.txt")
|
||||
|
||||
assert len(attempts) == 2
|
||||
|
||||
Reference in New Issue
Block a user