-
Notifications
You must be signed in to change notification settings - Fork 3
fix: disambiguate signal-killed errors from context cancellation #896
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
Merged
Merged
Changes from all commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
d05e20a
fix: disambiguate signal-killed errors from context cancellation
skevetter 2b14022
fix: disambiguate signal-killed errors from context cancellation
skevetter c042e81
style: update comments
skevetter ebbd65f
fix: typo
skevetter 64ed7cb
fix: extend signal-killed disambiguation to all docker CLI invocations
skevetter 27b7f12
fix: address CodeRabbit review feedback on signal-killed fix
skevetter a875f7f
style: remove explanatory comments in docker helper and tests
skevetter File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,75 @@ | ||
| package tunnelserver | ||
|
|
||
| import ( | ||
| "context" | ||
| "encoding/json" | ||
| "fmt" | ||
| "time" | ||
|
|
||
| "github.com/devsy-org/devsy/pkg/agent/tunnel" | ||
| "github.com/devsy-org/devsy/pkg/devcontainer/config" | ||
| "github.com/devsy-org/devsy/pkg/log" | ||
| ) | ||
|
|
||
| const sendResultTimeout = 5 * time.Second | ||
|
|
||
| // ReportResult runs fn and guarantees its outcome is sent over the tunnel | ||
| // via SendResult exactly once before returning, whether fn succeeds or | ||
| // fails. | ||
| func ReportResult( | ||
| ctx context.Context, | ||
| tunnelClient tunnel.TunnelClient, | ||
| fn func(ctx context.Context) (*config.Result, error), | ||
| ) (*config.Result, error) { | ||
| result, err := runJob(ctx, fn) | ||
|
|
||
| toSend := &config.Result{} | ||
| if result != nil { | ||
| copied := *result | ||
| toSend = &copied | ||
| } | ||
| if err != nil && toSend.Error == "" { | ||
| toSend.Error = err.Error() | ||
| } | ||
|
|
||
| if sendErr := sendResult(tunnelClient, toSend); sendErr != nil { | ||
| if err != nil { | ||
| log.Errorf("failed to forward result to host: %v", sendErr) | ||
| return result, err | ||
| } | ||
| return result, sendErr | ||
| } | ||
|
|
||
| return result, err | ||
| } | ||
|
|
||
| // runJob recovers a panic in fn so ReportResult's completion guarantee holds | ||
| // even when the job crashes outright, instead of the host waiting forever | ||
| // for a result that will never arrive. | ||
| func runJob( | ||
| ctx context.Context, | ||
| fn func(ctx context.Context) (*config.Result, error), | ||
| ) (result *config.Result, err error) { | ||
| defer func() { | ||
| if r := recover(); r != nil { | ||
| err = fmt.Errorf("panic: %v", r) | ||
| } | ||
| }() | ||
| return fn(ctx) | ||
| } | ||
|
|
||
| func sendResult(tunnelClient tunnel.TunnelClient, result *config.Result) error { | ||
| out, err := json.Marshal(result) | ||
| if err != nil { | ||
| return err | ||
| } | ||
|
|
||
| sendCtx, cancel := context.WithTimeout(context.Background(), sendResultTimeout) | ||
| defer cancel() | ||
|
|
||
| message := &tunnel.Message{Message: string(out)} | ||
| if _, err := tunnelClient.SendResult(sendCtx, message); err != nil { | ||
| return fmt.Errorf("send result: %w", err) | ||
| } | ||
| return nil | ||
| } |
Oops, something went wrong.
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.