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

Enable retries and connection timeouts when using curl #1335

Merged
merged 1 commit into from
Jun 13, 2022
Merged

Conversation

edmorley
Copy link
Member

@edmorley edmorley commented Jun 13, 2022

In the shimmed CNBs used in heroku/builder we have been seeing quite a few transient errors related to buildpacks downloading from S3.

Adding appropriate retries and connection timeouts to all of our buildpack's curl usages should help with these, as well as make builds more reliable in general for users on Heroku, plus also anyone using a shimmed CNB locally with Pack CLI (where the network connection may be even less reliable).

The --retry-connrefused option has been used since otherwise curl doesn't retry cases where the connection was refused. Ideally we would use --retry-all-errors which takes that one step further, however that option was only added in curl 7.71, so is only supported by Heroku-22+.

I've intentionally not added --max-time to usages within buildpack compile, since otherwise users running the buildpack locally on slow connections may permanently hit timeouts (and timeouts mid-download occur so rarely it's not worth the hassle of making this configurable).

For more on curl options, see:
https://curl.se/docs/manpage.html

GUS-W-11283397.

In the shimmed CNBs used in `heroku/builder` we have been seeing
quite a few transient errors related to buildpacks downloading from S3.

Adding appropriate retries and connection timeouts to all of our
buildpack's curl usages should help with these, as well as make builds
more reliable in general for users on Heroku, plus also anyone using a
shimmed CNB locally with Pack CLI (where the network connection may
be even less reliable).

The `--retry-connrefused` has been used since otherwise curl doesn't
retry cases where the connection was refused. Ideally we would use
`--retry-all-errors` which takes that one step further, however that
option was only added in curl 7.71, so is only supported by Heroku-22+.

I've intentionally not added `--max-time` to usages within buildpack
compile, since otherwise users running the buildpack locally on slow
connections may permanently hit timeouts (and timeouts mid-download
occur so rarely it's not worth the hassle of making this configurable).

For more on curl options, see:
https://curl.se/docs/manpage.html

GUS-W-11283397.
@edmorley edmorley self-assigned this Jun 13, 2022
@edmorley edmorley marked this pull request as ready for review June 13, 2022 18:12
@edmorley edmorley requested a review from a team as a code owner June 13, 2022 18:12
@edmorley edmorley merged commit c6ebbec into main Jun 13, 2022
@edmorley edmorley deleted the curl-retries branch June 13, 2022 19:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants