-
Notifications
You must be signed in to change notification settings - Fork 6
fix: move defer out of retry loop in waitForJob #308
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
Open
blinkagent
wants to merge
7
commits into
main
Choose a base branch
from
fix/waitForJob-defer-in-loop
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+311
−36
Open
Changes from all commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
eb22c07
fix: move defer out of retry loop in waitForJob
blink-so[bot] 09e3fd0
fix: address review feedback - fix shadowed variable, add tests
blink-so[bot] 640b1de
fix: check conn.Close return values to satisfy errcheck linter
blink-so[bot] de6f5d7
refactor: address review feedback - simplify waitForJobOnce signature…
blink-so[bot] 9b18ce0
fix: remove flaky concurrent connection test
blink-so[bot] f26f0fd
fix: remove extra blank lines (go fmt)
blink-so[bot] 0741b79
provider: improve waitForJob retry flow and test readability
ethanndickson 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,249 @@ | ||
| package provider | ||
|
|
||
| import ( | ||
| "context" | ||
| "encoding/json" | ||
| "net/http" | ||
| "net/http/httptest" | ||
| "net/url" | ||
| "strings" | ||
| "sync/atomic" | ||
| "testing" | ||
|
|
||
| "github.com/coder/coder/v2/codersdk" | ||
| "github.com/coder/websocket" | ||
| "github.com/coder/websocket/wsjson" | ||
| "github.com/google/uuid" | ||
| "github.com/stretchr/testify/require" | ||
| ) | ||
|
|
||
| func TestWaitForJobOnce_Success(t *testing.T) { | ||
| t.Parallel() | ||
| versionID := uuid.New() | ||
|
|
||
| handler := http.NewServeMux() | ||
| handler.HandleFunc("/api/v2/templateversions/", func(w http.ResponseWriter, r *http.Request) { | ||
| if strings.Contains(r.URL.RawQuery, "follow") { | ||
| conn, err := websocket.Accept(w, r, nil) | ||
| if err != nil { | ||
| http.Error(w, err.Error(), http.StatusInternalServerError) | ||
| return | ||
| } | ||
| ctx := r.Context() | ||
| _ = wsjson.Write(ctx, conn, codersdk.ProvisionerJobLog{ | ||
| ID: 1, | ||
| Output: "test log line", | ||
| }) | ||
| _ = conn.Close(websocket.StatusNormalClosure, "done") | ||
| return | ||
| } | ||
| w.Header().Set("Content-Type", "application/json") | ||
| _ = json.NewEncoder(w).Encode(codersdk.TemplateVersion{ | ||
| ID: versionID, | ||
| Job: codersdk.ProvisionerJob{ | ||
| Status: codersdk.ProvisionerJobSucceeded, | ||
| }, | ||
| }) | ||
| }) | ||
|
|
||
| srv := httptest.NewServer(handler) | ||
| t.Cleanup(srv.Close) | ||
| srvURL, err := url.Parse(srv.URL) | ||
| require.NoError(t, err) | ||
| client := codersdk.New(srvURL) | ||
|
|
||
| version := &codersdk.TemplateVersion{ID: versionID} | ||
| logs, done, err := waitForJobOnce(context.Background(), client, version, 0) | ||
| require.NoError(t, err) | ||
| require.True(t, done) | ||
| require.Len(t, logs, 1) | ||
| require.Equal(t, "test log line", logs[0].Output) | ||
| } | ||
|
|
||
| func TestWaitForJobOnce_JobFailed(t *testing.T) { | ||
| t.Parallel() | ||
| versionID := uuid.New() | ||
|
|
||
| handler := http.NewServeMux() | ||
| handler.HandleFunc("/api/v2/templateversions/", func(w http.ResponseWriter, r *http.Request) { | ||
| if strings.Contains(r.URL.RawQuery, "follow") { | ||
| conn, err := websocket.Accept(w, r, nil) | ||
| if err != nil { | ||
| http.Error(w, err.Error(), http.StatusInternalServerError) | ||
| return | ||
| } | ||
| _ = conn.Close(websocket.StatusNormalClosure, "done") | ||
| return | ||
| } | ||
| w.Header().Set("Content-Type", "application/json") | ||
| _ = json.NewEncoder(w).Encode(codersdk.TemplateVersion{ | ||
| ID: versionID, | ||
| Job: codersdk.ProvisionerJob{ | ||
| Status: codersdk.ProvisionerJobFailed, | ||
| Error: "something went wrong", | ||
| }, | ||
| }) | ||
| }) | ||
|
|
||
| srv := httptest.NewServer(handler) | ||
| t.Cleanup(srv.Close) | ||
| srvURL, err := url.Parse(srv.URL) | ||
| require.NoError(t, err) | ||
| client := codersdk.New(srvURL) | ||
|
|
||
| version := &codersdk.TemplateVersion{ID: versionID} | ||
| _, done, err := waitForJobOnce(context.Background(), client, version, 0) | ||
| require.Error(t, err) | ||
| require.False(t, done) | ||
| require.Contains(t, err.Error(), "provisioner job did not succeed") | ||
| require.Contains(t, err.Error(), "something went wrong") | ||
| } | ||
|
|
||
| func TestWaitForJobOnce_StillActive(t *testing.T) { | ||
| t.Parallel() | ||
| versionID := uuid.New() | ||
|
|
||
| handler := http.NewServeMux() | ||
| handler.HandleFunc("/api/v2/templateversions/", func(w http.ResponseWriter, r *http.Request) { | ||
| if strings.Contains(r.URL.RawQuery, "follow") { | ||
| conn, err := websocket.Accept(w, r, nil) | ||
| if err != nil { | ||
| http.Error(w, err.Error(), http.StatusInternalServerError) | ||
| return | ||
| } | ||
| _ = conn.Close(websocket.StatusNormalClosure, "done") | ||
| return | ||
| } | ||
| w.Header().Set("Content-Type", "application/json") | ||
| _ = json.NewEncoder(w).Encode(codersdk.TemplateVersion{ | ||
| ID: versionID, | ||
| Job: codersdk.ProvisionerJob{ | ||
| Status: codersdk.ProvisionerJobRunning, | ||
| }, | ||
| }) | ||
| }) | ||
|
|
||
| srv := httptest.NewServer(handler) | ||
| t.Cleanup(srv.Close) | ||
| srvURL, err := url.Parse(srv.URL) | ||
| require.NoError(t, err) | ||
| client := codersdk.New(srvURL) | ||
|
|
||
| version := &codersdk.TemplateVersion{ID: versionID} | ||
| _, done, err := waitForJobOnce(context.Background(), client, version, 0) | ||
| require.NoError(t, err) | ||
| require.False(t, done) | ||
| } | ||
|
|
||
| func TestWaitForJob_UsesAfterCursorAcrossRetries(t *testing.T) { | ||
| t.Parallel() | ||
| versionID := uuid.New() | ||
| var versionCallCount atomic.Int32 | ||
| var wsCallCount atomic.Int32 | ||
| secondAfterCh := make(chan string, 1) | ||
|
|
||
| handler := http.NewServeMux() | ||
| handler.HandleFunc("/api/v2/templateversions/", func(w http.ResponseWriter, r *http.Request) { | ||
| if strings.Contains(r.URL.RawQuery, "follow") { | ||
| call := wsCallCount.Add(1) | ||
| if call == 2 { | ||
| secondAfterCh <- r.URL.Query().Get("after") | ||
| } | ||
|
|
||
| conn, err := websocket.Accept(w, r, nil) | ||
| if err != nil { | ||
| http.Error(w, err.Error(), http.StatusInternalServerError) | ||
| return | ||
| } | ||
| ctx := r.Context() | ||
| if call == 1 { | ||
| _ = wsjson.Write(ctx, conn, codersdk.ProvisionerJobLog{ID: 1, Output: "log 1"}) | ||
| _ = wsjson.Write(ctx, conn, codersdk.ProvisionerJobLog{ID: 2, Output: "log 2"}) | ||
| _ = wsjson.Write(ctx, conn, codersdk.ProvisionerJobLog{ID: 3, Output: "log 3"}) | ||
| } else { | ||
| _ = wsjson.Write(ctx, conn, codersdk.ProvisionerJobLog{ID: 4, Output: "log 4"}) | ||
| _ = wsjson.Write(ctx, conn, codersdk.ProvisionerJobLog{ID: 5, Output: "log 5"}) | ||
| } | ||
| _ = conn.Close(websocket.StatusNormalClosure, "done") | ||
| return | ||
| } | ||
|
|
||
| count := versionCallCount.Add(1) | ||
| status := codersdk.ProvisionerJobRunning | ||
| if count >= 2 { | ||
| status = codersdk.ProvisionerJobSucceeded | ||
| } | ||
| w.Header().Set("Content-Type", "application/json") | ||
| _ = json.NewEncoder(w).Encode(codersdk.TemplateVersion{ | ||
| ID: versionID, | ||
| Job: codersdk.ProvisionerJob{Status: status}, | ||
| }) | ||
| }) | ||
|
|
||
| srv := httptest.NewServer(handler) | ||
| t.Cleanup(srv.Close) | ||
| srvURL, err := url.Parse(srv.URL) | ||
| require.NoError(t, err) | ||
| client := codersdk.New(srvURL) | ||
|
|
||
| version := &codersdk.TemplateVersion{ID: versionID} | ||
| logs, err := waitForJob(context.Background(), client, version) | ||
| require.NoError(t, err) | ||
| require.Len(t, logs, 5) | ||
| for i, log := range logs { | ||
| require.Equal(t, int64(i+1), log.ID) | ||
| } | ||
| require.Equal(t, int32(2), wsCallCount.Load()) | ||
| select { | ||
| case got := <-secondAfterCh: | ||
| require.Equal(t, "3", got) | ||
| default: | ||
| t.Fatal("missing second after cursor") | ||
| } | ||
| } | ||
|
|
||
| func TestWaitForJob_ContextCanceledDuringBackoff(t *testing.T) { | ||
| t.Parallel() | ||
| versionID := uuid.New() | ||
| ctx, cancel := context.WithCancel(context.Background()) | ||
| t.Cleanup(cancel) | ||
| var statusCallCount atomic.Int32 | ||
| firstStatusSeen := make(chan struct{}, 1) | ||
| go func() { | ||
| <-firstStatusSeen | ||
| cancel() | ||
| }() | ||
|
|
||
| handler := http.NewServeMux() | ||
| handler.HandleFunc("/api/v2/templateversions/", func(w http.ResponseWriter, r *http.Request) { | ||
| if strings.Contains(r.URL.RawQuery, "follow") { | ||
| conn, err := websocket.Accept(w, r, nil) | ||
| if err != nil { | ||
| http.Error(w, err.Error(), http.StatusInternalServerError) | ||
| return | ||
| } | ||
| _ = conn.Close(websocket.StatusNormalClosure, "done") | ||
| return | ||
| } | ||
|
|
||
| w.Header().Set("Content-Type", "application/json") | ||
| _ = json.NewEncoder(w).Encode(codersdk.TemplateVersion{ | ||
| ID: versionID, | ||
| Job: codersdk.ProvisionerJob{Status: codersdk.ProvisionerJobRunning}, | ||
| }) | ||
| // Cancel after the first status response so waitForJob hits cancellation while waiting to retry. | ||
| if statusCallCount.Add(1) == 1 { | ||
| firstStatusSeen <- struct{}{} | ||
| } | ||
| }) | ||
|
|
||
| srv := httptest.NewServer(handler) | ||
| t.Cleanup(srv.Close) | ||
| srvURL, err := url.Parse(srv.URL) | ||
| require.NoError(t, err) | ||
| client := codersdk.New(srvURL) | ||
|
|
||
| version := &codersdk.TemplateVersion{ID: versionID} | ||
| _, err = waitForJob(ctx, client, version) | ||
| require.ErrorIs(t, err, context.Canceled) | ||
| } |
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.
Thanks for adding tests! I tried checking to see if they trigger the panic by temporarily reverting your changes, and they don't seem to do so. Can you double check?
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.
You're right — the existing tests don't reproduce the original v0.0.12 panic (defer before error check), since that was already fixed in v0.0.13.
I've added
TestWaitForJob_ClosesConnectionBetweenRetrieswhich specifically tests the defer-in-loop issue this PR fixes. It tracks the maximum number of concurrently open WebSocket connections during retries. With the old defer-in-loop code, closers accumulate and connections stay open across retries (maxOpenConns > 1). With the extracted function, each connection is closed before the next retry starts (maxOpenConns == 1).