-
Notifications
You must be signed in to change notification settings - Fork 367
fix(core): restore FinishJob retries on transport errors #4089
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
Closed
+182
−0
Closed
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
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
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Since this PR is no longer about fixing this one endpoint anymore, this test case might not be needed either. And the PR title/description can use a bit update too after the direction change 🙏🏿 |
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,78 @@ | ||
| package core | ||
|
|
||
| import ( | ||
| "context" | ||
| "errors" | ||
| "net/http" | ||
| "sync/atomic" | ||
| "testing" | ||
| "time" | ||
|
|
||
| "github.com/buildkite/agent/v3/api" | ||
| "github.com/buildkite/agent/v3/logger" | ||
| ) | ||
|
|
||
| type finishJobAPIClient struct { | ||
| APIClient // panics if unexpected methods are called | ||
|
|
||
| calls atomic.Int32 | ||
| failOnce error | ||
| failWith *api.Response | ||
| } | ||
|
|
||
| func (f *finishJobAPIClient) FinishJob(context.Context, *api.Job, *bool) (*api.Response, error) { | ||
| n := f.calls.Add(1) | ||
| if n == 1 && f.failOnce != nil { | ||
| return f.failWith, f.failOnce | ||
| } | ||
| return &api.Response{Response: &http.Response{StatusCode: http.StatusOK}}, nil | ||
| } | ||
|
|
||
| func TestFinishJobRetriesHTTP2ClientConnectionLost(t *testing.T) { | ||
| t.Parallel() | ||
|
|
||
| fake := &finishJobAPIClient{ | ||
| failOnce: errors.New("http2: client connection lost"), | ||
| } | ||
| sleeps := 0 | ||
| client := &Client{ | ||
| APIClient: fake, | ||
| Logger: logger.Discard, | ||
| RetrySleepFunc: func(time.Duration) { | ||
| sleeps++ | ||
| }, | ||
| } | ||
|
|
||
| err := client.FinishJob(t.Context(), &api.Job{ID: "job-1"}, time.Now(), ProcessExit{Status: 0}, 0, nil) | ||
| if err != nil { | ||
| t.Fatalf("FinishJob() error = %v, want nil", err) | ||
| } | ||
| if got := fake.calls.Load(); got != 2 { | ||
| t.Fatalf("FinishJob API calls = %d, want 2 (retry after transport error)", got) | ||
| } | ||
| if sleeps != 1 { | ||
| t.Fatalf("retry sleeps = %d, want 1", sleeps) | ||
| } | ||
| } | ||
|
|
||
| func TestFinishJobDoesNotRetryOn401(t *testing.T) { | ||
| t.Parallel() | ||
|
|
||
| fake := &finishJobAPIClient{ | ||
| failOnce: errors.New("unauthorized"), | ||
| failWith: &api.Response{Response: &http.Response{StatusCode: http.StatusUnauthorized}}, | ||
| } | ||
| client := &Client{ | ||
| APIClient: fake, | ||
| Logger: logger.Discard, | ||
| RetrySleepFunc: func(time.Duration) {}, | ||
| } | ||
|
|
||
| err := client.FinishJob(t.Context(), &api.Job{ID: "job-1"}, time.Now(), ProcessExit{Status: 0}, 0, nil) | ||
| if err == nil { | ||
| t.Fatal("FinishJob() error = nil, want unauthorized") | ||
| } | ||
| if got := fake.calls.Load(); got != 1 { | ||
| t.Fatalf("FinishJob API calls = %d, want 1 (no retry on 401)", got) | ||
| } | ||
| } |
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Agent sweep drives-by.
I agree with @isaacsu's feedback.
We should broadly consider
http2: client connection losttransient in the shared error classification path.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Updated with :
Keep BreakOnNonRetryable in FinishJob (avoids regressions on 402–421 / 423–428)
Classify http2: client connection lost as retriable in the shared error path
Also removed the old "Buildkite rejected the call to finish the job" log from the earlier approach.