refactor: convert workspacesdk.AgentConn to an interface #19392
+667
−143
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
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
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,186 @@ | ||
| package coderd | ||
|
|
||
| import ( | ||
| "bytes" | ||
| "context" | ||
| "database/sql" | ||
| "fmt" | ||
| "io" | ||
| "net/http" | ||
| "net/http/httptest" | ||
| "net/http/httputil" | ||
| "net/url" | ||
| "strings" | ||
| "testing" | ||
|
|
||
| "github.com/go-chi/chi/v5" | ||
| "github.com/google/uuid" | ||
| "github.com/stretchr/testify/require" | ||
| "go.uber.org/mock/gomock" | ||
|
|
||
| "cdr.dev/slog" | ||
| "cdr.dev/slog/sloggers/slogtest" | ||
| "github.com/coder/coder/v2/coderd/database" | ||
| "github.com/coder/coder/v2/coderd/database/dbmock" | ||
| "github.com/coder/coder/v2/coderd/database/dbtime" | ||
| "github.com/coder/coder/v2/coderd/httpmw" | ||
| "github.com/coder/coder/v2/coderd/workspaceapps/appurl" | ||
| "github.com/coder/coder/v2/codersdk" | ||
| "github.com/coder/coder/v2/codersdk/workspacesdk" | ||
| "github.com/coder/coder/v2/codersdk/workspacesdk/agentconnmock" | ||
| "github.com/coder/coder/v2/codersdk/wsjson" | ||
| "github.com/coder/coder/v2/tailnet" | ||
| "github.com/coder/coder/v2/tailnet/tailnettest" | ||
| "github.com/coder/coder/v2/testutil" | ||
| "github.com/coder/websocket" | ||
| ) | ||
|
|
||
| type fakeAgentProvider struct { | ||
| agentConn func(ctx context.Context, agentID uuid.UUID) (_ workspacesdk.AgentConn, release func(), _ error) | ||
| } | ||
|
|
||
| func (fakeAgentProvider) ReverseProxy(targetURL, dashboardURL *url.URL, agentID uuid.UUID, app appurl.ApplicationURL, wildcardHost string) *httputil.ReverseProxy { | ||
| panic("unimplemented") | ||
| } | ||
|
|
||
| func (f fakeAgentProvider) AgentConn(ctx context.Context, agentID uuid.UUID) (_ workspacesdk.AgentConn, release func(), _ error) { | ||
| if f.agentConn != nil { | ||
| return f.agentConn(ctx, agentID) | ||
| } | ||
|
|
||
| panic("unimplemented") | ||
| } | ||
|
|
||
| func (fakeAgentProvider) ServeHTTPDebug(w http.ResponseWriter, r *http.Request) { | ||
| panic("unimplemented") | ||
| } | ||
|
|
||
| func (fakeAgentProvider) Close() error { | ||
| return nil | ||
| } | ||
|
|
||
| func TestWatchAgentContainers(t *testing.T) { | ||
| t.Parallel() | ||
|
|
||
| t.Run("WebSocketClosesProperly", func(t *testing.T) { | ||
| t.Parallel() | ||
|
|
||
| // This test ensures that the agent containers `/watch` websocket can gracefully | ||
| // handle the underlying websocket unexpectedly closing. This test was created in | ||
| // response to this issue: https://github.com/coder/coder/issues/19372 | ||
|
|
||
| var ( | ||
| ctx = testutil.Context(t, testutil.WaitShort) | ||
| logger = slogtest.Make(t, &slogtest.Options{IgnoreErrors: true}).Leveled(slog.LevelDebug).Named("coderd") | ||
|
|
||
| mCtrl = gomock.NewController(t) | ||
| mDB = dbmock.NewMockStore(mCtrl) | ||
| mCoordinator = tailnettest.NewMockCoordinator(mCtrl) | ||
| mAgentConn = agentconnmock.NewMockAgentConn(mCtrl) | ||
|
|
||
| fAgentProvider = fakeAgentProvider{ | ||
| agentConn: func(ctx context.Context, agentID uuid.UUID) (_ workspacesdk.AgentConn, release func(), _ error) { | ||
| return mAgentConn, func() {}, nil | ||
| }, | ||
| } | ||
|
|
||
| workspaceID = uuid.New() | ||
| agentID = uuid.New() | ||
| resourceID = uuid.New() | ||
| jobID = uuid.New() | ||
| buildID = uuid.New() | ||
|
|
||
| containersCh = make(chan codersdk.WorkspaceAgentListContainersResponse) | ||
|
|
||
| r = chi.NewMux() | ||
|
|
||
| api = API{ | ||
| ctx: ctx, | ||
| Options: &Options{ | ||
| AgentInactiveDisconnectTimeout: testutil.WaitShort, | ||
| Database: mDB, | ||
| Logger: logger, | ||
| DeploymentValues: &codersdk.DeploymentValues{}, | ||
| TailnetCoordinator: tailnettest.NewFakeCoordinator(), | ||
| }, | ||
| } | ||
| ) | ||
|
|
||
| var tailnetCoordinator tailnet.Coordinator = mCoordinator | ||
| api.TailnetCoordinator.Store(&tailnetCoordinator) | ||
| api.agentProvider = fAgentProvider | ||
|
|
||
| // Setup: Allow `ExtractWorkspaceAgentParams` to complete. | ||
| mDB.EXPECT().GetWorkspaceAgentByID(gomock.Any(), agentID).Return(database.WorkspaceAgent{ | ||
| ID: agentID, | ||
| ResourceID: resourceID, | ||
| LifecycleState: database.WorkspaceAgentLifecycleStateReady, | ||
| FirstConnectedAt: sql.NullTime{Valid: true, Time: dbtime.Now()}, | ||
| LastConnectedAt: sql.NullTime{Valid: true, Time: dbtime.Now()}, | ||
| }, nil) | ||
| mDB.EXPECT().GetWorkspaceResourceByID(gomock.Any(), resourceID).Return(database.WorkspaceResource{ | ||
| ID: resourceID, | ||
| JobID: jobID, | ||
| }, nil) | ||
| mDB.EXPECT().GetProvisionerJobByID(gomock.Any(), jobID).Return(database.ProvisionerJob{ | ||
| ID: jobID, | ||
| Type: database.ProvisionerJobTypeWorkspaceBuild, | ||
| }, nil) | ||
| mDB.EXPECT().GetWorkspaceBuildByJobID(gomock.Any(), jobID).Return(database.WorkspaceBuild{ | ||
| WorkspaceID: workspaceID, | ||
| ID: buildID, | ||
| }, nil) | ||
|
|
||
| // And: Allow `db2dsk.WorkspaceAgent` to complete. | ||
| mCoordinator.EXPECT().Node(gomock.Any()).Return(nil) | ||
|
|
||
| // And: Allow `WatchContainers` to be called, returing our `containersCh` channel. | ||
| mAgentConn.EXPECT().WatchContainers(gomock.Any(), gomock.Any()). | ||
| Return(containersCh, io.NopCloser(&bytes.Buffer{}), nil) | ||
|
|
||
| // And: We mount the HTTP Handler | ||
| r.With(httpmw.ExtractWorkspaceAgentParam(mDB)). | ||
| Get("/workspaceagents/{workspaceagent}/containers/watch", api.watchWorkspaceAgentContainers) | ||
|
|
||
| // Given: We create the HTTP server | ||
| srv := httptest.NewServer(r) | ||
| defer srv.Close() | ||
|
|
||
| // And: Dial the WebSocket | ||
| wsURL := strings.Replace(srv.URL, "http://", "ws://", 1) | ||
| conn, resp, err := websocket.Dial(ctx, fmt.Sprintf("%s/workspaceagents/%s/containers/watch", wsURL, agentID), nil) | ||
| require.NoError(t, err) | ||
| if resp.Body != nil { | ||
| defer resp.Body.Close() | ||
| } | ||
|
|
||
| // And: Create a streaming decoder | ||
| decoder := wsjson.NewDecoder[codersdk.WorkspaceAgentListContainersResponse](conn, websocket.MessageText, logger) | ||
| defer decoder.Close() | ||
| decodeCh := decoder.Chan() | ||
|
|
||
| // And: We can successfully send through the channel. | ||
| testutil.RequireSend(ctx, t, containersCh, codersdk.WorkspaceAgentListContainersResponse{ | ||
| Containers: []codersdk.WorkspaceAgentContainer{{ | ||
| ID: "test-container-id", | ||
| }}, | ||
| }) | ||
|
|
||
| // And: Receive the data. | ||
| containerResp := testutil.RequireReceive(ctx, t, decodeCh) | ||
| require.Len(t, containerResp.Containers, 1) | ||
| require.Equal(t, "test-container-id", containerResp.Containers[0].ID) | ||
|
|
||
| // When: We close the `containersCh` | ||
| close(containersCh) | ||
|
There was a problem hiding this comment. Should we have at least one test message sent first to confirm the base case works and then the exit? There was a problem hiding this comment. Sounds good to me |
||
|
|
||
| // Then: We expect `decodeCh` to be closed. | ||
| select { | ||
| case <-ctx.Done(): | ||
| t.Fail() | ||
|
|
||
| case _, ok := <-decodeCh: | ||
| require.False(t, ok, "channel is expected to be closed") | ||
| } | ||
| }) | ||
| } | ||
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.
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.
This re-order fixes a nil pointer access when no
PrometheusRegistryandAuthorizerare passed through options.