chore: move autobuild/executor into autobuild

sreya · sreya · commit 7d0f53dc8534 · 2023-06-20T02:38:30.000Z
diff --git a/cli/server.go b/cli/server.go
@@ -62,7 +62,7 @@ import (
 	"github.com/coder/coder/cli/cliui"
 	"github.com/coder/coder/cli/config"
 	"github.com/coder/coder/coderd"
-	"github.com/coder/coder/coderd/autobuild/executor"
+	"github.com/coder/coder/coderd/autobuild"
 	"github.com/coder/coder/coderd/database"
 	"github.com/coder/coder/coderd/database/dbfake"
 	"github.com/coder/coder/coderd/database/dbmetrics"
@@ -899,7 +899,7 @@ func (r *RootCmd) Server(newAPI func(context.Context, *coderd.Options) (*coderd.
 
 			autobuildPoller := time.NewTicker(cfg.AutobuildPollInterval.Value())
 			defer autobuildPoller.Stop()
-			autobuildExecutor := executor.New(ctx, options.Database, coderAPI.TemplateScheduleStore, logger, autobuildPoller.C)
+			autobuildExecutor := autobuild.NewExecutor(ctx, options.Database, coderAPI.TemplateScheduleStore, logger, autobuildPoller.C)
 			autobuildExecutor.Run()
 
 			// Currently there is no way to ask the server to shut
diff --git a/coderd/autobuild/doc.go b/coderd/autobuild/doc.go
@@ -0,0 +1,3 @@
+// Package autobuild contains logic for scheduling workspace
+// builds in the background.
+package autobuild
diff --git a/coderd/autobuild/lifecycle_executor.go b/coderd/autobuild/lifecycle_executor.go
@@ -1,4 +1,4 @@
-package executor
+package autobuild
 
 import (
 	"context"
@@ -35,8 +35,8 @@ type Stats struct {
 	Error       error
 }
 
-// New returns a new autobuild executor.
-func New(ctx context.Context, db database.Store, tss *atomic.Pointer[schedule.TemplateScheduleStore], log slog.Logger, tick <-chan time.Time) *Executor {
+// New returns a new wsactions executor.
+func NewExecutor(ctx context.Context, db database.Store, tss *atomic.Pointer[schedule.TemplateScheduleStore], log slog.Logger, tick <-chan time.Time) *Executor {
 	le := &Executor{
 		//nolint:gocritic // Autostart has a limited set of permissions.
 		ctx:                   dbauthz.AsAutostart(ctx),
@@ -125,77 +125,57 @@ func (e *Executor) runOnce(t time.Time) Stats {
 		log := e.log.With(slog.F("workspace_id", wsID))
 
 		eg.Go(func() error {
-			err := e.db.InTx(func(db database.Store) error {
+			err := e.db.InTx(func(tx database.Store) error {
 				// Re-check eligibility since the first check was outside the
 				// transaction and the workspace settings may have changed.
-				ws, err := db.GetWorkspaceByID(e.ctx, wsID)
+				ws, err := tx.GetWorkspaceByID(e.ctx, wsID)
 				if err != nil {
 					log.Error(e.ctx, "get workspace autostart failed", slog.Error(err))
 					return nil
 				}
 
 				// Determine the workspace state based on its latest build.
-				priorHistory, err := db.GetLatestWorkspaceBuildByWorkspaceID(e.ctx, ws.ID)
+				latestBuild, err := tx.GetLatestWorkspaceBuildByWorkspaceID(e.ctx, ws.ID)
 				if err != nil {
 					log.Warn(e.ctx, "get latest workspace build", slog.Error(err))
 					return nil
 				}
 
-				templateSchedule, err := (*(e.templateScheduleStore.Load())).GetTemplateScheduleOptions(e.ctx, db, ws.TemplateID)
+				templateSchedule, err := (*(e.templateScheduleStore.Load())).GetTemplateScheduleOptions(e.ctx, tx, ws.TemplateID)
 				if err != nil {
 					log.Warn(e.ctx, "get template schedule options", slog.Error(err))
 					return nil
 				}
 
-				if !isEligibleForAutoStartStop(ws, priorHistory, templateSchedule) {
-					return nil
-				}
-
-				priorJob, err := db.GetProvisionerJobByID(e.ctx, priorHistory.JobID)
+				latestJob, err := tx.GetProvisionerJobByID(e.ctx, latestBuild.JobID)
 				if err != nil {
 					log.Warn(e.ctx, "get last provisioner job for workspace %q: %w", slog.Error(err))
 					return nil
 				}
 
-				validTransition, nextTransition, err := getNextTransition(ws, priorHistory, priorJob)
+				nextTransition, reason, err := getNextTransition(ws, latestBuild, latestJob, templateSchedule, currentTick)
 				if err != nil {
 					log.Debug(e.ctx, "skipping workspace", slog.Error(err))
 					return nil
 				}
 
-				if currentTick.Before(nextTransition) {
-					log.Debug(e.ctx, "skipping workspace: too early",
-						slog.F("next_transition_at", nextTransition),
-						slog.F("transition", validTransition),
-						slog.F("current_tick", currentTick),
-					)
-					return nil
-				}
-				builder := wsbuilder.New(ws, validTransition).
-					SetLastWorkspaceBuildInTx(&priorHistory).
-					SetLastWorkspaceBuildJobInTx(&priorJob)
-
-				switch validTransition {
-				case database.WorkspaceTransitionStart:
-					builder = builder.Reason(database.BuildReasonAutostart)
-				case database.WorkspaceTransitionStop:
-					builder = builder.Reason(database.BuildReasonAutostop)
-				default:
-					log.Error(e.ctx, "unsupported transition", slog.F("transition", validTransition))
-					return nil
-				}
-				if _, _, err := builder.Build(e.ctx, db, nil); err != nil {
+				builder := wsbuilder.New(ws, nextTransition).
+					SetLastWorkspaceBuildInTx(&latestBuild).
+					SetLastWorkspaceBuildJobInTx(&latestJob).
+					Reason(reason)
+
+				if _, _, err := builder.Build(e.ctx, tx, nil); err != nil {
 					log.Error(e.ctx, "unable to transition workspace",
-						slog.F("transition", validTransition),
+						slog.F("transition", nextTransition),
 						slog.Error(err),
 					)
 					return nil
 				}
 				statsMu.Lock()
-				stats.Transitions[ws.ID] = validTransition
+				stats.Transitions[ws.ID] = nextTransition
 				statsMu.Unlock()
 
-				log.Info(e.ctx, "scheduling workspace transition", slog.F("transition", validTransition))
+				log.Info(e.ctx, "scheduling workspace transition", slog.F("transition", nextTransition))
 
 				return nil
 
@@ -218,7 +198,9 @@ func (e *Executor) runOnce(t time.Time) Stats {
 	return stats
 }
 
-func isEligibleForAutoStartStop(ws database.Workspace, priorHistory database.WorkspaceBuild, templateSchedule schedule.TemplateScheduleOptions) bool {
+// isEligibleForTransition returns true if the workspace meets basic criteria
+// for transitioning to a new state.
+func isEligibleForTransition(ws database.Workspace, latestBuild database.WorkspaceBuild, templateSchedule schedule.TemplateScheduleOptions) bool {
 	if ws.Deleted {
 		return false
 	}
@@ -227,7 +209,7 @@ func isEligibleForAutoStartStop(ws database.Workspace, priorHistory database.Wor
 	}
 	// Don't check the template schedule to see whether it allows autostop, this
 	// is done during the build when determining the deadline.
-	if priorHistory.Transition == database.WorkspaceTransitionStart && !priorHistory.Deadline.IsZero() {
+	if latestBuild.Transition == database.WorkspaceTransitionStart && !latestBuild.Deadline.IsZero() {
 		return true
 	}
 
@@ -236,35 +218,57 @@ func isEligibleForAutoStartStop(ws database.Workspace, priorHistory database.Wor
 
 func getNextTransition(
 	ws database.Workspace,
-	priorHistory database.WorkspaceBuild,
-	priorJob database.ProvisionerJob,
+	latestBuild database.WorkspaceBuild,
+	latestJob database.ProvisionerJob,
+	templateSchedule schedule.TemplateScheduleOptions,
+	currentTick time.Time,
 ) (
-	validTransition database.WorkspaceTransition,
-	nextTransition time.Time,
-	err error,
+	database.WorkspaceTransition,
+	database.BuildReason,
+	error,
 ) {
-	if !priorJob.CompletedAt.Valid || priorJob.Error.String != "" {
-		return "", time.Time{}, xerrors.Errorf("last workspace build did not complete successfully")
+	if !isEligibleForTransition(ws, latestBuild, templateSchedule) {
+		return "", "", xerrors.Errorf("workspace ineligible for transition")
 	}
 
-	switch priorHistory.Transition {
-	case database.WorkspaceTransitionStart:
-		if priorHistory.Deadline.IsZero() {
-			return "", time.Time{}, xerrors.Errorf("latest workspace build has zero deadline")
-		}
-		// For stopping, do not truncate. This is inconsistent with autostart, but
-		// it ensures we will not stop too early.
-		return database.WorkspaceTransitionStop, priorHistory.Deadline, nil
-	case database.WorkspaceTransitionStop:
-		sched, err := schedule.Weekly(ws.AutostartSchedule.String)
-		if err != nil {
-			return "", time.Time{}, xerrors.Errorf("workspace has invalid autostart schedule: %w", err)
-		}
-		// Round down to the nearest minute, as this is the finest granularity cron supports.
-		// Truncate is probably not necessary here, but doing it anyway to be sure.
-		nextTransition = sched.Next(priorHistory.CreatedAt).Truncate(time.Minute)
-		return database.WorkspaceTransitionStart, nextTransition, nil
+	if !latestJob.CompletedAt.Valid || latestJob.Error.String != "" {
+		return "", "", xerrors.Errorf("last workspace build did not complete successfully")
+	}
+
+	switch {
+	case isEligibleForAutostop(latestBuild, currentTick):
+		return database.WorkspaceTransitionStop, database.BuildReasonAutostop, nil
+	case isEligibleForAutostart(ws, latestBuild, currentTick):
+		return database.WorkspaceTransitionStart, database.BuildReasonAutostart, nil
 	default:
-		return "", time.Time{}, xerrors.Errorf("last transition not valid for autostart or autostop")
+		return "", "", xerrors.Errorf("last transition not valid for autostart or autostop")
+	}
+}
+
+// isEligibleForAutostart returns true if the workspace should be autostarted.
+func isEligibleForAutostart(ws database.Workspace, build database.WorkspaceBuild, currentTick time.Time) bool {
+	// If the last transition for the workspace was not 'stop' then the workspace
+	// cannot be started.
+	if build.Transition != database.WorkspaceTransitionStop {
+		return false
+	}
+
+	sched, err := schedule.Weekly(ws.AutostartSchedule.String)
+	if err != nil {
+		return false
 	}
+	// Round down to the nearest minute, as this is the finest granularity cron supports.
+	// Truncate is probably not necessary here, but doing it anyway to be sure.
+	nextTransition := sched.Next(build.CreatedAt).Truncate(time.Minute)
+
+	return !currentTick.Before(nextTransition)
+}
+
+// isEligibleForAutostart returns true if the workspace should be autostopped.
+func isEligibleForAutostop(build database.WorkspaceBuild, currentTick time.Time) bool {
+	// A workspace must be started in order for it to be auto-stopped.
+	return build.Transition == database.WorkspaceTransitionStart &&
+		!build.Deadline.IsZero() &&
+		// We do not want to stop a workspace prior to it breaching its deadline.
+		!currentTick.Before(build.Deadline)
 }
diff --git a/coderd/autobuild/lifecycle_executor_test.go b/coderd/autobuild/lifecycle_executor_test.go
@@ -1,4 +1,4 @@
-package executor_test
+package autobuild_test
 
 import (
 	"context"
@@ -11,7 +11,7 @@ import (
 	"github.com/stretchr/testify/require"
 	"go.uber.org/goleak"
 
-	"github.com/coder/coder/coderd/autobuild/executor"
+	"github.com/coder/coder/coderd/autobuild"
 	"github.com/coder/coder/coderd/coderdtest"
 	"github.com/coder/coder/coderd/database"
 	"github.com/coder/coder/coderd/schedule"
@@ -27,7 +27,7 @@ func TestExecutorAutostartOK(t *testing.T) {
 	var (
 		sched   = mustSchedule(t, "CRON_TZ=UTC 0 * * * *")
 		tickCh  = make(chan time.Time)
-		statsCh = make(chan executor.Stats)
+		statsCh = make(chan autobuild.Stats)
 		client  = coderdtest.New(t, &coderdtest.Options{
 			AutobuildTicker:          tickCh,
 			IncludeProvisionerDaemon: true,
@@ -66,7 +66,7 @@ func TestExecutorAutostartTemplateUpdated(t *testing.T) {
 		ctx     = context.Background()
 		err     error
 		tickCh  = make(chan time.Time)
-		statsCh = make(chan executor.Stats)
+		statsCh = make(chan autobuild.Stats)
 		client  = coderdtest.New(t, &coderdtest.Options{
 			AutobuildTicker:          tickCh,
 			IncludeProvisionerDaemon: true,
@@ -113,7 +113,7 @@ func TestExecutorAutostartAlreadyRunning(t *testing.T) {
 	var (
 		sched   = mustSchedule(t, "CRON_TZ=UTC 0 * * * *")
 		tickCh  = make(chan time.Time)
-		statsCh = make(chan executor.Stats)
+		statsCh = make(chan autobuild.Stats)
 		client  = coderdtest.New(t, &coderdtest.Options{
 			AutobuildTicker:          tickCh,
 			IncludeProvisionerDaemon: true,
@@ -145,7 +145,7 @@ func TestExecutorAutostartNotEnabled(t *testing.T) {
 
 	var (
 		tickCh  = make(chan time.Time)
-		statsCh = make(chan executor.Stats)
+		statsCh = make(chan autobuild.Stats)
 		client  = coderdtest.New(t, &coderdtest.Options{
 			AutobuildTicker:          tickCh,
 			IncludeProvisionerDaemon: true,
@@ -180,7 +180,7 @@ func TestExecutorAutostopOK(t *testing.T) {
 
 	var (
 		tickCh  = make(chan time.Time)
-		statsCh = make(chan executor.Stats)
+		statsCh = make(chan autobuild.Stats)
 		client  = coderdtest.New(t, &coderdtest.Options{
 			AutobuildTicker:          tickCh,
 			IncludeProvisionerDaemon: true,
@@ -216,7 +216,7 @@ func TestExecutorAutostopExtend(t *testing.T) {
 	var (
 		ctx     = context.Background()
 		tickCh  = make(chan time.Time)
-		statsCh = make(chan executor.Stats)
+		statsCh = make(chan autobuild.Stats)
 		client  = coderdtest.New(t, &coderdtest.Options{
 			AutobuildTicker:          tickCh,
 			IncludeProvisionerDaemon: true,
@@ -266,7 +266,7 @@ func TestExecutorAutostopAlreadyStopped(t *testing.T) {
 
 	var (
 		tickCh  = make(chan time.Time)
-		statsCh = make(chan executor.Stats)
+		statsCh = make(chan autobuild.Stats)
 		client  = coderdtest.New(t, &coderdtest.Options{
 			AutobuildTicker:          tickCh,
 			IncludeProvisionerDaemon: true,
@@ -299,7 +299,7 @@ func TestExecutorAutostopNotEnabled(t *testing.T) {
 	var (
 		ctx     = context.Background()
 		tickCh  = make(chan time.Time)
-		statsCh = make(chan executor.Stats)
+		statsCh = make(chan autobuild.Stats)
 		client  = coderdtest.New(t, &coderdtest.Options{
 			AutobuildTicker:          tickCh,
 			IncludeProvisionerDaemon: true,
@@ -341,7 +341,7 @@ func TestExecutorWorkspaceDeleted(t *testing.T) {
 	var (
 		sched   = mustSchedule(t, "CRON_TZ=UTC 0 * * * *")
 		tickCh  = make(chan time.Time)
-		statsCh = make(chan executor.Stats)
+		statsCh = make(chan autobuild.Stats)
 		client  = coderdtest.New(t, &coderdtest.Options{
 			AutobuildTicker:          tickCh,
 			IncludeProvisionerDaemon: true,
@@ -374,7 +374,7 @@ func TestExecutorWorkspaceAutostartTooEarly(t *testing.T) {
 	var (
 		sched   = mustSchedule(t, "CRON_TZ=UTC 0 * * * *")
 		tickCh  = make(chan time.Time)
-		statsCh = make(chan executor.Stats)
+		statsCh = make(chan autobuild.Stats)
 		client  = coderdtest.New(t, &coderdtest.Options{
 			AutobuildTicker:          tickCh,
 			IncludeProvisionerDaemon: true,
@@ -405,7 +405,7 @@ func TestExecutorWorkspaceAutostopBeforeDeadline(t *testing.T) {
 
 	var (
 		tickCh  = make(chan time.Time)
-		statsCh = make(chan executor.Stats)
+		statsCh = make(chan autobuild.Stats)
 		client  = coderdtest.New(t, &coderdtest.Options{
 			AutobuildTicker:          tickCh,
 			IncludeProvisionerDaemon: true,
@@ -433,7 +433,7 @@ func TestExecutorWorkspaceAutostopNoWaitChangedMyMind(t *testing.T) {
 	var (
 		ctx     = context.Background()
 		tickCh  = make(chan time.Time)
-		statsCh = make(chan executor.Stats)
+		statsCh = make(chan autobuild.Stats)
 		client  = coderdtest.New(t, &coderdtest.Options{
 			AutobuildTicker:          tickCh,
 			IncludeProvisionerDaemon: true,
@@ -501,8 +501,8 @@ func TestExecutorAutostartMultipleOK(t *testing.T) {
 		sched    = mustSchedule(t, "CRON_TZ=UTC 0 * * * *")
 		tickCh   = make(chan time.Time)
 		tickCh2  = make(chan time.Time)
-		statsCh1 = make(chan executor.Stats)
-		statsCh2 = make(chan executor.Stats)
+		statsCh1 = make(chan autobuild.Stats)
+		statsCh2 = make(chan autobuild.Stats)
 		client   = coderdtest.New(t, &coderdtest.Options{
 			AutobuildTicker:          tickCh,
 			IncludeProvisionerDaemon: true,
@@ -556,7 +556,7 @@ func TestExecutorAutostartWithParameters(t *testing.T) {
 	var (
 		sched   = mustSchedule(t, "CRON_TZ=UTC 0 * * * *")
 		tickCh  = make(chan time.Time)
-		statsCh = make(chan executor.Stats)
+		statsCh = make(chan autobuild.Stats)
 		client  = coderdtest.New(t, &coderdtest.Options{
 			AutobuildTicker:          tickCh,
 			IncludeProvisionerDaemon: true,
@@ -609,7 +609,7 @@ func TestExecutorAutostartTemplateDisabled(t *testing.T) {
 	var (
 		sched   = mustSchedule(t, "CRON_TZ=UTC 0 * * * *")
 		tickCh  = make(chan time.Time)
-		statsCh = make(chan executor.Stats)
+		statsCh = make(chan autobuild.Stats)
 
 		client = coderdtest.New(t, &coderdtest.Options{
 			AutobuildTicker:          tickCh,
diff --git a/coderd/autobuild/notify/notifier_test.go b/coderd/autobuild/notify/notifier_test.go
@@ -9,7 +9,7 @@ import (
 	"go.uber.org/atomic"
 	"go.uber.org/goleak"
 
-	"github.com/coder/coder/coderd/autobuild/notify"
+	"github.com/coder/coder/coderd/wsactions/notify"
 )
 
 func TestNotifier(t *testing.T) {
diff --git a/coderd/coderdtest/coderdtest.go b/coderd/coderdtest/coderdtest.go

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+// Package autobuild contains logic for scheduling workspace`
	`2`	`+// builds in the background.`
	`3`	`+package autobuild`
Original file line number	Diff line number	Diff line change
`@@ -9,7 +9,7 @@ import (`
`9`	`9`	`"go.uber.org/atomic"`
`10`	`10`	`"go.uber.org/goleak"`
`11`	`11`
`12`		`- "github.com/coder/coder/coderd/autobuild/notify"`
	`12`	`+ "github.com/coder/coder/coderd/wsactions/notify"`
`13`	`13`	`)`
`14`	`14`
`15`	`15`	`func TestNotifier(t *testing.T) {`