Add timeout to JWKs refresh #28
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
We were explicitly not passing a context to the JWKs URI refresh call; this is problematic as calls may hang indefinitely. To better deal with these scenario, a new configuration option was added: * The `oidc-jwks-remote-timeout` flag. or * `oidc.jwksremotetimeout` configuration entry. this is passed to a `context.WithTimeout` so we now get a timeout as expected. Signed-off-by: Juan Antonio Osorio <juan.osoriorobles@eu.equinix.com>
sfunkhouser
approved these changes
Jun 7, 2022
fishnix
reviewed
Jun 7, 2022
| defer cancel() | ||
| } else { | ||
| ctx = context.Background() | ||
| } |
There was a problem hiding this comment.
This works and makes sense to me if we were passing this context up and down the stack, but did you give thought to creating a non-default http client and setting a timeout there?
client := http.Client{
Timeout: 5 * time.Second,
}There was a problem hiding this comment.
I did think about it, but I tend to prefer using contexts as opposed to the direct client timeout; It's more idiomatic. That was basically the extent of my reasoning.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
We were explicitly not passing a context to the JWKs URI refresh call;
this is problematic as calls may hang indefinitely.
To better deal with these scenario, a new configuration option was
added:
oidc-jwks-remote-timeoutflag.or
oidc.jwksremotetimeoutconfiguration entry.this is passed to a
context.WithTimeoutso we now get a timeout asexpected.
If a timeout is not given
context.Background()is used (as was the case before).Closes #21
Signed-off-by: Juan Antonio Osorio juan.osoriorobles@eu.equinix.com