Skip to content

feat: add auto-locking/deleting workspace based on template config #8240

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

Merged
merged 10 commits into from
Jul 3, 2023
Merged

feat: add auto-locking/deleting workspace based on template config #8240

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
8a39344
feat: add auto-locking/deleting to autobuild
sreya Jun 20, 2023
0ce8aa3
add some tests/fix some minor bugs
sreya Jun 28, 2023
62357a7
fix an issue in updating templates
sreya Jun 29, 2023
416d39e
add a test for locking
sreya Jun 29, 2023
4b29a80
fix some grammar
sreya Jun 29, 2023
52214bc
indentation
sreya Jun 29, 2023
b69f8e1
Merge branch 'main' into jon/autolock
sreya Jul 2, 2023
8439ef7
migrations
sreya Jul 2, 2023
e8b7605
pr comments
sreya Jul 2, 2023
0162216
lint
sreya Jul 3, 2023
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
Prev Previous commit
Next Next commit
fix some grammar
  • Loading branch information
@sreya
sreya committed Jun 29, 2023
commit 4b29a8010c2297ef9d51129b46527b006ff2aff6
10 changes: 5 additions & 5 deletions coderd/database/queries/workspaces.sql
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -415,7 +415,7 @@ LEFT JOIN
INNER JOIN
provisioner_jobs ON workspace_builds.job_id = provisioner_jobs.id
INNER JOIN
templates ON workspaces.template_id = templates.id
templates ON workspaces.template_id = templates.id
WHERE
workspace_builds.build_number = (
SELECT
Expand Down Expand Up @@ -458,15 +458,15 @@ WHERE
-- If the workspace's template has an inactivity_ttl set
-- it may be eligible for locking.
(
templates.inactivity_ttl > 0 AND
workspaces.locked_at IS NULL
templates.inactivity_ttl > 0 AND
workspaces.locked_at IS NULL
) OR

-- If the workspace's template has a locked_ttl set
-- and the workspace is already locked
(
templates.locked_ttl > 0 AND
workspaces.locked_at IS NOT NULL
templates.locked_ttl > 0 AND
workspaces.locked_at IS NOT NULL
)
) AND workspaces.deleted = 'false';

Expand Down
70 changes: 41 additions & 29 deletions enterprise/coderd/workspaces_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -210,25 +210,25 @@ func TestWorkspaceAutobuild(t *testing.T) {
})
)
user := coderdtest.CreateFirstUser(t, client)
_ = coderdenttest.AddLicense(t, client, coderdenttest.LicenseOptions{
Features: license.Features{
codersdk.FeatureAdvancedTemplateScheduling: 1,
},
})
_ = coderdenttest.AddFullLicense(t, client)
version := coderdtest.CreateTemplateVersion(t, client, user.OrganizationID, &echo.Responses{
Parse: echo.ParseComplete,
ProvisionPlan: echo.ProvisionComplete,
ProvisionApply: echo.ProvisionComplete,
})
// Create a template without setting a failure_ttl.
template := coderdtest.CreateTemplate(t, client, user.OrganizationID, version.ID)
require.Zero(t, template.InactivityTTLMillis)
require.Zero(t, template.FailureTTLMillis)
require.Zero(t, template.LockedTTLMillis)

coderdtest.AwaitTemplateVersionJob(t, client, version.ID)
ws := coderdtest.CreateWorkspace(t, client, user.OrganizationID, template.ID)
build := coderdtest.AwaitWorkspaceBuildJob(t, client, ws.LatestBuild.ID)
require.Equal(t, codersdk.WorkspaceStatusRunning, build.Status)
ticker <- time.Now()
stats := <-statCh
// Expect no transitions since the field is unset on the template.
// Expect no transitions since the fields are unset on the template.
require.Len(t, stats.Transitions, 0)
})

Expand Down Expand Up @@ -258,26 +258,33 @@ func TestWorkspaceAutobuild(t *testing.T) {
ProvisionPlan: echo.ProvisionComplete,
ProvisionApply: echo.ProvisionComplete,
})
// Create a template with a short inactivity ttl so we don't have to wait
// too long.
template := coderdtest.CreateTemplate(t, client, user.OrganizationID, version.ID, func(ctr *codersdk.CreateTemplateRequest) {
ctr.InactivityTTLMillis = ptr.Ref[int64](inactiveTTL.Milliseconds())
})
coderdtest.AwaitTemplateVersionJob(t, client, version.ID)

ws := coderdtest.CreateWorkspace(t, client, user.OrganizationID, template.ID)
build := coderdtest.AwaitWorkspaceBuildJob(t, client, ws.LatestBuild.ID)
require.Equal(t, codersdk.WorkspaceStatusRunning, build.Status)

// Wait to trigger the inactivity threshold.
require.Eventually(t,
func() bool {
return database.Now().Sub(ws.LastUsedAt) > inactiveTTL
},
testutil.IntervalMedium, testutil.IntervalFast)
ticker <- time.Now()
stats := <-statCh

// Expect workspace to transition to stopped state for breaching
// failure TTL.
require.Len(t, stats.Transitions, 1)
require.Equal(t, stats.Transitions[ws.ID], database.WorkspaceTransitionStop)
ws = coderdtest.MustWorkspace(t, client, ws.ID)

// The workspace should be locked.
ws = coderdtest.MustWorkspace(t, client, ws.ID)
require.NotNil(t, ws.LockedAt)
lastUsedAt := ws.LastUsedAt

Expand Down Expand Up @@ -308,11 +315,7 @@ func TestWorkspaceAutobuild(t *testing.T) {
})
)
user := coderdtest.CreateFirstUser(t, client)
_ = coderdenttest.AddLicense(t, client, coderdenttest.LicenseOptions{
Features: license.Features{
codersdk.FeatureAdvancedTemplateScheduling: 1,
},
})
_ = coderdenttest.AddFullLicense(t, client)
version := coderdtest.CreateTemplateVersion(t, client, user.OrganizationID, &echo.Responses{
Parse: echo.ParseComplete,
ProvisionPlan: echo.ProvisionComplete,
Expand All @@ -331,6 +334,9 @@ func TestWorkspaceAutobuild(t *testing.T) {
require.Len(t, stats.Transitions, 0)
})

// This is kind of a dumb test but it exists to offer some marginal
// confidence that bug in the auto-deletion logic doesn't delete running
// workspaces.
t.Run("UnlockedWorkspacesNotDeleted", func(t *testing.T) {
t.Parallel()

Expand All @@ -349,11 +355,7 @@ func TestWorkspaceAutobuild(t *testing.T) {
})
)
user := coderdtest.CreateFirstUser(t, client)
_ = coderdenttest.AddLicense(t, client, coderdenttest.LicenseOptions{
Features: license.Features{
codersdk.FeatureAdvancedTemplateScheduling: 1,
},
})
_ = coderdenttest.AddFullLicense(t, client)
version := coderdtest.CreateTemplateVersion(t, client, user.OrganizationID, &echo.Responses{
Parse: echo.ParseComplete,
ProvisionPlan: echo.ProvisionComplete,
Expand All @@ -365,6 +367,7 @@ func TestWorkspaceAutobuild(t *testing.T) {
coderdtest.AwaitTemplateVersionJob(t, client, version.ID)
ws := coderdtest.CreateWorkspace(t, client, user.OrganizationID, template.ID)
build := coderdtest.AwaitWorkspaceBuildJob(t, client, ws.LatestBuild.ID)
require.Nil(t, ws.LockedAt)
require.Equal(t, codersdk.WorkspaceStatusRunning, build.Status)
require.Eventually(t,
func() bool {
Expand All @@ -378,6 +381,9 @@ func TestWorkspaceAutobuild(t *testing.T) {
require.Len(t, stats.Transitions, 0)
})

// Assert that a stopped workspace that breaches the inactivity threshold
// does not trigger a build transition but is still placed in the
// lock state.
t.Run("InactiveStoppedWorkspaceNoTransition", func(t *testing.T) {
t.Parallel()

Expand All @@ -396,11 +402,7 @@ func TestWorkspaceAutobuild(t *testing.T) {
})
)
user := coderdtest.CreateFirstUser(t, client)
_ = coderdenttest.AddLicense(t, client, coderdenttest.LicenseOptions{
Features: license.Features{
codersdk.FeatureAdvancedTemplateScheduling: 1,
},
})
_ = coderdenttest.AddFullLicense(t, client)
version := coderdtest.CreateTemplateVersion(t, client, user.OrganizationID, &echo.Responses{
Parse: echo.ParseComplete,
ProvisionPlan: echo.ProvisionComplete,
Expand All @@ -410,6 +412,7 @@ func TestWorkspaceAutobuild(t *testing.T) {
ctr.InactivityTTLMillis = ptr.Ref[int64](inactiveTTL.Milliseconds())
})
coderdtest.AwaitTemplateVersionJob(t, client, version.ID)

ws := coderdtest.CreateWorkspace(t, client, user.OrganizationID, template.ID)
build := coderdtest.AwaitWorkspaceBuildJob(t, client, ws.LatestBuild.ID)
require.Equal(t, codersdk.WorkspaceStatusRunning, build.Status)
Expand Down Expand Up @@ -466,41 +469,50 @@ func TestWorkspaceAutobuild(t *testing.T) {
ctr.InactivityTTLMillis = ptr.Ref[int64](transitionTTL.Milliseconds())
ctr.LockedTTLMillis = ptr.Ref[int64](transitionTTL.Milliseconds())
})

coderdtest.AwaitTemplateVersionJob(t, client, version.ID)

ws := coderdtest.CreateWorkspace(t, client, user.OrganizationID, template.ID)
build := coderdtest.AwaitWorkspaceBuildJob(t, client, ws.LatestBuild.ID)
require.Equal(t, codersdk.WorkspaceStatusRunning, build.Status)

require.Eventually(t,
func() bool {
return database.Now().Sub(ws.LastUsedAt) > transitionTTL
},
testutil.IntervalMedium, testutil.IntervalFast)

ticker <- time.Now()
stats := <-statCh
// Expect workspace to transition to stopped state for breaching
// inactive TTL.
require.Len(t, stats.Transitions, 1)
require.Equal(t, stats.Transitions[ws.ID], database.WorkspaceTransitionStop)

ws = coderdtest.MustWorkspace(t, client, ws.ID)
// The workspace should be locked.
require.NotNil(t, ws.LockedAt)

// Wait for the autobuilder to stop the workspace.
_ = coderdtest.AwaitWorkspaceBuildJob(t, client, ws.LatestBuild.ID)
// Wait for the workspace to breach the locked threshold.

// Wait to trigger our locked threshold.
require.Eventually(t,
func() bool {
return database.Now().Sub(*ws.LockedAt) > transitionTTL
},
testutil.IntervalMedium, testutil.IntervalFast)

ticker <- time.Now()
stats = <-statCh
require.Len(t, stats.Transitions, 1)
// The workspace should be scheduled for deletion.
require.Equal(t, stats.Transitions[ws.ID], database.WorkspaceTransitionDelete)

// Wait for the workspace to be deleted.
ws = coderdtest.MustWorkspace(t, client, ws.ID)
_ = coderdtest.AwaitWorkspaceBuildJob(t, client, ws.LatestBuild.ID)

// Assert that the workspace is actually deleted.
_, err := client.Workspace(testutil.Context(t, testutil.WaitShort), ws.ID)
require.Error(t, err)
cerr, ok := codersdk.AsError(err)
Expand Down Expand Up @@ -575,11 +587,11 @@ func TestWorkspaceAutobuild(t *testing.T) {

ticker <- time.Now()
stats = <-statCh
// Expect no transitions since not enough time has elapsed.
require.Len(t, stats.Transitions, 1)
require.Equal(t, database.WorkspaceTransitionDelete, stats.Transitions[ws.ID])
})

// Assert that a locked workspace does not autostart.
t.Run("LockedNoAutostart", func(t *testing.T) {
t.Parallel()

Expand Down Expand Up @@ -621,12 +633,12 @@ func TestWorkspaceAutobuild(t *testing.T) {

// Assert that autostart works when the workspace isn't locked..
tickCh <- sched.Next(ws.LatestBuild.CreatedAt)
// Then: the workspace should eventually be started
stats := <-statsCh
require.NoError(t, stats.Error)
require.Len(t, stats.Transitions, 1)
require.Contains(t, stats.Transitions, ws.ID)
require.Equal(t, database.WorkspaceTransitionStart, stats.Transitions[ws.ID])

ws = coderdtest.MustWorkspace(t, client, ws.ID)
coderdtest.AwaitWorkspaceBuildJob(t, client, ws.LatestBuild.ID)

Expand All @@ -643,21 +655,21 @@ func TestWorkspaceAutobuild(t *testing.T) {
},
testutil.IntervalMedium, testutil.IntervalFast)

// We should see the workspace get stopped now.
tickCh <- time.Now()
// Then: the workspace should eventually be started
stats = <-statsCh
require.NoError(t, stats.Error)
require.Len(t, stats.Transitions, 1)
require.Contains(t, stats.Transitions, ws.ID)
require.Equal(t, database.WorkspaceTransitionStop, stats.Transitions[ws.ID])

// The workspace should be locked now.
ws = coderdtest.MustWorkspace(t, client, ws.ID)
coderdtest.AwaitWorkspaceBuildJob(t, client, ws.LatestBuild.ID)
// The workspace should be locked now.
require.NotNil(t, ws.LockedAt)

// Assert that autostart is no longer triggered since workspace is locked.
tickCh <- sched.Next(ws.LatestBuild.CreatedAt)
// Then: the workspace should eventually be started
stats = <-statsCh
require.Len(t, stats.Transitions, 0)
})
Expand Down