- Notifications
You must be signed in to change notification settings - Fork927
fix!: use devcontainer ID when rebuilding a devcontainer#18604
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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Merged
+149 −161
Merged
Changes fromall commits
Commits
Show all changes
2 commits Select commitHold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Jump to
Jump to file
Failed to load files.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Diff view
Diff view
There are no files selected for viewing
70 changes: 21 additions & 49 deletionsagent/agentcontainers/api.go
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 |
|---|---|---|
| @@ -494,8 +494,8 @@ func (api *API) Routes() http.Handler { | ||
| r.Get("/", api.handleList) | ||
| // TODO(mafredri): Simplify this route as the previous /devcontainers | ||
| // /-route was dropped. We can drop the /devcontainers prefix here too. | ||
| r.Route("/devcontainers/{devcontainer}", func(r chi.Router) { | ||
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. This dawned on me just now, but we could take 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. Oooh that could be good to add in the future. | ||
| r.Post("/recreate", api.handleDevcontainerRecreate) | ||
| }) | ||
| return r | ||
| @@ -859,68 +859,40 @@ func (api *API) getContainers() (codersdk.WorkspaceAgentListContainersResponse, | ||
| // devcontainer by referencing the container. | ||
| func (api *API) handleDevcontainerRecreate(w http.ResponseWriter, r *http.Request) { | ||
| ctx := r.Context() | ||
| devcontainerID := chi.URLParam(r, "devcontainer") | ||
| ifdevcontainerID == "" { | ||
| httpapi.Write(ctx, w, http.StatusBadRequest, codersdk.Response{ | ||
| Message: "Missing devcontainer ID", | ||
| Detail: "Devcontainer ID is required to recreate a devcontainer.", | ||
| }) | ||
| return | ||
| } | ||
| api.mu.Lock() | ||
| var dc codersdk.WorkspaceAgentDevcontainer | ||
| for _, knownDC := range api.knownDevcontainers { | ||
| if knownDC.ID.String() == devcontainerID { | ||
| dc = knownDC | ||
| break | ||
| } | ||
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. Suggestion: This could be simplified by storing | ||
| } | ||
| if dc.ID == uuid.Nil { | ||
| api.mu.Unlock() | ||
| httpapi.Write(ctx, w, http.StatusNotFound, codersdk.Response{ | ||
| Message: "Devcontainer not found.", | ||
| Detail: fmt.Sprintf("Could not find devcontainerwith ID: %q",devcontainerID), | ||
| }) | ||
| return | ||
| } | ||
| if dc.Status == codersdk.WorkspaceAgentDevcontainerStatusStarting { | ||
| api.mu.Unlock() | ||
| httpapi.Write(ctx, w, http.StatusConflict, codersdk.Response{ | ||
| Message: "Devcontainer recreation already in progress", | ||
| Detail: fmt.Sprintf("Recreation fordevcontainer%q is already underway.", dc.Name), | ||
| }) | ||
| return | ||
| } | ||
| @@ -931,14 +903,14 @@ func (api *API) handleDevcontainerRecreate(w http.ResponseWriter, r *http.Reques | ||
| dc.Container = nil | ||
| api.knownDevcontainers[dc.WorkspaceFolder] = dc | ||
| go func() { | ||
| _ = api.CreateDevcontainer(dc.WorkspaceFolder,dc.ConfigPath, WithRemoveExistingContainer()) | ||
| }() | ||
| api.mu.Unlock() | ||
| httpapi.Write(ctx, w, http.StatusAccepted, codersdk.Response{ | ||
| Message: "Devcontainer recreation initiated", | ||
| Detail: fmt.Sprintf("Recreation process fordevcontainer%q has started.", dc.Name), | ||
| }) | ||
| } | ||
114 changes: 63 additions & 51 deletionsagent/agentcontainers/api_test.go
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 |
|---|---|---|
| @@ -493,78 +493,77 @@ func TestAPI(t *testing.T) { | ||
| t.Run("Recreate", func(t *testing.T) { | ||
| t.Parallel() | ||
| devcontainerID1 := uuid.New() | ||
| devcontainerID2 := uuid.New() | ||
| workspaceFolder1 := "/workspace/test1" | ||
| workspaceFolder2 := "/workspace/test2" | ||
| configPath1 := "/workspace/test1/.devcontainer/devcontainer.json" | ||
| configPath2 := "/workspace/test2/.devcontainer/devcontainer.json" | ||
| // Create a container that represents an existing devcontainer | ||
| devContainer1 := codersdk.WorkspaceAgentContainer{ | ||
| ID: "container-1", | ||
| FriendlyName: "test-container-1", | ||
| Running: true, | ||
| Labels: map[string]string{ | ||
| agentcontainers.DevcontainerLocalFolderLabel:workspaceFolder1, | ||
| agentcontainers.DevcontainerConfigFileLabel:configPath1, | ||
| }, | ||
| } | ||
| devContainer2 := codersdk.WorkspaceAgentContainer{ | ||
| ID: "container-2", | ||
| FriendlyName: "test-container-2", | ||
| Running: true, | ||
| Labels: map[string]string{ | ||
| agentcontainers.DevcontainerLocalFolderLabel: workspaceFolder2, | ||
| agentcontainers.DevcontainerConfigFileLabel: configPath2, | ||
| }, | ||
| } | ||
| tests := []struct { | ||
| name string | ||
| devcontainerID string | ||
| setupDevcontainers []codersdk.WorkspaceAgentDevcontainer | ||
| lister *fakeContainerCLI | ||
| devcontainerCLI *fakeDevcontainerCLI | ||
| wantStatus []int | ||
| wantBody []string | ||
| }{ | ||
| { | ||
| name: "Missingdevcontainer ID", | ||
| devcontainerID: "", | ||
| lister: &fakeContainerCLI{}, | ||
| devcontainerCLI: &fakeDevcontainerCLI{}, | ||
| wantStatus: []int{http.StatusBadRequest}, | ||
| wantBody: []string{"Missingdevcontainer ID"}, | ||
| }, | ||
| { | ||
| name: "Devcontainer not found", | ||
| devcontainerID: uuid.NewString(), | ||
| lister: &fakeContainerCLI{ | ||
| arch: "<none>", // Unsupported architecture, don't inject subagent. | ||
| }, | ||
| devcontainerCLI: &fakeDevcontainerCLI{}, | ||
| wantStatus: []int{http.StatusNotFound}, | ||
| wantBody: []string{"Devcontainer not found"}, | ||
| }, | ||
| { | ||
| name: "Devcontainer CLI error", | ||
| devcontainerID: devcontainerID1.String(), | ||
| setupDevcontainers: []codersdk.WorkspaceAgentDevcontainer{ | ||
| { | ||
| ID: devcontainerID1, | ||
| Name: "test-devcontainer-1", | ||
| WorkspaceFolder: workspaceFolder1, | ||
| ConfigPath: configPath1, | ||
| Status: codersdk.WorkspaceAgentDevcontainerStatusRunning, | ||
| Container: &devContainer1, | ||
| }, | ||
| }, | ||
| lister: &fakeContainerCLI{ | ||
| containers: codersdk.WorkspaceAgentListContainersResponse{ | ||
| Containers: []codersdk.WorkspaceAgentContainer{devContainer1}, | ||
| }, | ||
| arch: "<none>", // Unsupported architecture, don't inject subagent. | ||
| }, | ||
| @@ -575,11 +574,21 @@ func TestAPI(t *testing.T) { | ||
| wantBody: []string{"Devcontainer recreation initiated", "Devcontainer recreation already in progress"}, | ||
| }, | ||
| { | ||
| name: "OK", | ||
| devcontainerID: devcontainerID2.String(), | ||
| setupDevcontainers: []codersdk.WorkspaceAgentDevcontainer{ | ||
| { | ||
| ID: devcontainerID2, | ||
| Name: "test-devcontainer-2", | ||
| WorkspaceFolder: workspaceFolder2, | ||
| ConfigPath: configPath2, | ||
| Status: codersdk.WorkspaceAgentDevcontainerStatusRunning, | ||
| Container: &devContainer2, | ||
| }, | ||
| }, | ||
| lister: &fakeContainerCLI{ | ||
| containers: codersdk.WorkspaceAgentListContainersResponse{ | ||
| Containers: []codersdk.WorkspaceAgentContainer{devContainer2}, | ||
| }, | ||
| arch: "<none>", // Unsupported architecture, don't inject subagent. | ||
| }, | ||
| @@ -608,13 +617,16 @@ func TestAPI(t *testing.T) { | ||
| // Setup router with the handler under test. | ||
| r := chi.NewRouter() | ||
| api := agentcontainers.NewAPI( | ||
| logger, | ||
| agentcontainers.WithClock(mClock), | ||
| agentcontainers.WithContainerCLI(tt.lister), | ||
| agentcontainers.WithDevcontainerCLI(tt.devcontainerCLI), | ||
| agentcontainers.WithWatcher(watcher.NewNoop()), | ||
| agentcontainers.WithDevcontainers(tt.setupDevcontainers, nil), | ||
| ) | ||
| api.Init() | ||
| defer api.Close() | ||
| r.Mount("/", api.Routes()) | ||
| @@ -626,7 +638,7 @@ func TestAPI(t *testing.T) { | ||
| for i := range tt.wantStatus { | ||
| // Simulate HTTP request to the recreate endpoint. | ||
| req := httptest.NewRequest(http.MethodPost, "/devcontainers/"+tt.devcontainerID+"/recreate", nil). | ||
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. This is a much more sensible URL 😍 | ||
| WithContext(ctx) | ||
| rec := httptest.NewRecorder() | ||
| r.ServeHTTP(rec, req) | ||
6 changes: 3 additions & 3 deletionscoderd/apidoc/docs.go
Some generated files are not rendered by default. Learn more abouthow customized files appear on GitHub.
Oops, something went wrong.
Uh oh!
There was an error while loading.Please reload this page.
6 changes: 3 additions & 3 deletionscoderd/apidoc/swagger.json
Some generated files are not rendered by default. Learn more abouthow customized files appear on GitHub.
Oops, something went wrong.
Uh oh!
There was an error while loading.Please reload this page.
2 changes: 1 addition & 1 deletioncoderd/coderd.go
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
14 changes: 7 additions & 7 deletionscoderd/workspaceagents.go
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
Oops, something went wrong.
Uh oh!
There was an error while loading.Please reload this page.
Oops, something went wrong.
Uh oh!
There was an error while loading.Please reload this page.
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.