Fix panic on remote connection errors #530
Open
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
There was a panic in remote.dialWithRetry() on context cancellation,
e.g. when timeout that was specified by pulumi.Timeouts() passed to
remote.NewCommand() exceeded.
retry.Until() when the context is cancelled returns: ok = false, data = nil, err = nil;
so if we try to cast data to T, we get panic:
> interface conversion: interface {} is nil, not T
We can cast data to T in remote.dialWithRetry(), not only when err returned
from retry.Until() is nil, but also when ok is true.
|
PR is now waiting for a maintainer to run the acceptance tests. |
mjeffryes
reviewed
Sep 12, 2024
| @@ -145,11 +145,14 @@ func dialWithRetry[T any](ctx context.Context, msg string, maxAttempts int, f fu | |||
| return false, nil, nil | |||
| }, | |||
| }) | |||
| if err == nil { | |||
| if ok && err == nil { | |||
There was a problem hiding this comment.
Suggested change
| if ok && err == nil { | |
| // It's important to check both `ok` and `err` as sometimes `err` will be nil when `ok` is false, such as when the context is cancelled | |
| if ok && err == nil { |
| return data.(T), nil | ||
| } | ||
|
|
||
| var t T | ||
| if err == nil { | ||
| err = ctx.Err() |
There was a problem hiding this comment.
Suggested change
| err = ctx.Err() | |
| // `err` is nil but ok was false, use the err reported from the context. | |
| err = ctx.Err() |
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.
There was a panic in
remote.dialWithRetry()on the context cancellation, e.g. when the timeout specified bypulumi.Timeouts()passed toremote.NewCommand()exceeded.retry.Until()when the context is cancelled returns:ok = false, data = nil, err = nil; so if we try to castdatatoT, we get panic:We can cast
datatoTinremote.dialWithRetry(), not only whenerrreturned fromretry.Until()isnil, but also whenokistrue.