Thanks to visit codestin.com
Credit goes to github.com

Skip to content

fix(coderd): reject redundant SSH autostarts of running workspaces #29246

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.

Sign up for GitHub

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

Draft
ezhang-figma wants to merge 1 commit into
base: main
Choose a base branch
from
+79 −0
Draft

fix(coderd): reject redundant SSH autostarts of running workspaces #29246

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
66 changes: 66 additions & 0 deletions coderd/workspacebuilds_ssh_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
package coderd_test

import (
"net/http"
"testing"

"github.com/stretchr/testify/require"

"github.com/coder/coder/v2/coderd/coderdtest"
"github.com/coder/coder/v2/codersdk"
"github.com/coder/coder/v2/testutil"
)

func TestWorkspaceBuildSSHAutostart(t *testing.T) {
t.Parallel()

for _, tc := range []struct {
name string
stopped bool
reason codersdk.CreateWorkspaceBuildReason
conflict bool
}{
{name: "Running", reason: codersdk.CreateWorkspaceBuildReasonSSHConnection, conflict: true},
{name: "Stopped", stopped: true, reason: codersdk.CreateWorkspaceBuildReasonSSHConnection},
{name: "ExplicitStart", reason: codersdk.CreateWorkspaceBuildReasonDashboard},
} {
t.Run(tc.name, func(t *testing.T) {
t.Parallel()
ctx := testutil.Context(t, testutil.WaitLong)
client := coderdtest.New(t, &coderdtest.Options{IncludeProvisionerDaemon: true})
user := coderdtest.CreateFirstUser(t, client)
version := coderdtest.CreateTemplateVersion(t, client, user.OrganizationID, nil)
coderdtest.AwaitTemplateVersionJobCompleted(t, client, version.ID)
template := coderdtest.CreateTemplate(t, client, user.OrganizationID, version.ID)
workspace := coderdtest.CreateWorkspace(t, client, template.ID)
latest := coderdtest.AwaitWorkspaceBuildJobCompleted(t, client, workspace.LatestBuild.ID)

if tc.stopped {
stop, err := client.CreateWorkspaceBuild(ctx, workspace.ID, codersdk.CreateWorkspaceBuildRequest{
Transition: codersdk.WorkspaceTransitionStop,
})
require.NoError(t, err)
latest = coderdtest.AwaitWorkspaceBuildJobCompleted(t, client, stop.ID)
}

// An SSH client may submit a delayed autostart after another
// client has already finished starting the workspace.
build, err := client.CreateWorkspaceBuild(ctx, workspace.ID, codersdk.CreateWorkspaceBuildRequest{
Transition: codersdk.WorkspaceTransitionStart,
Reason: tc.reason,
})
if tc.conflict {
var apiError *codersdk.Error
require.ErrorAs(t, err, &apiError)
require.Equal(t, http.StatusConflict, apiError.StatusCode())
current, err := client.Workspace(ctx, workspace.ID)
require.NoError(t, err)
require.Equal(t, latest.ID, current.LatestBuild.ID)
return
}
require.NoError(t, err)
require.Equal(t, latest.BuildNumber+1, build.BuildNumber)
coderdtest.AwaitWorkspaceBuildJobCompleted(t, client, build.ID)
})
}
}
13 changes: 13 additions & 0 deletions coderd/wsbuilder/wsbuilder.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1386,6 +1386,19 @@ func (b *Builder) checkRunningBuild() error {
xerrors.New(msg),
}
}
if b.trans == database.WorkspaceTransitionStart && b.reason == database.BuildReasonSshConnection && job.JobStatus == database.ProvisionerJobStatusSucceeded {
build, err := b.getLastBuild()
if err != nil {
return BuildError{http.StatusInternalServerError, "failed to fetch prior build", err}
}
if build.Transition == database.WorkspaceTransitionStart {
// An SSH client can read a stopped workspace before another client
// starts it, then submit its request after that build completes.
// Preserve the running build and let the client reconnect on 409.
msg := "The workspace is already running."
return BuildError{http.StatusConflict, msg, xerrors.New(msg)}
}
}
return nil
}

Expand Down
Loading