chore: move schedule code to new package

coder · deansheather · Mar 7, 2023 · Feb 8, 2023 · Feb 15, 2023 · Feb 20, 2023
commit 847bc4c5078422fddb4f1895e2f46feec9c51a53
diff --git a/cli/list.go b/cli/list.go
@@ -8,7 +8,7 @@ import (
 	"github.com/spf13/cobra"
 
 	"github.com/coder/coder/cli/cliui"
-	"github.com/coder/coder/coderd/autobuild/schedule"
+	"github.com/coder/coder/coderd/schedule"
 	"github.com/coder/coder/coderd/util/ptr"
 	"github.com/coder/coder/codersdk"
 )

diff --git a/cli/schedule.go b/cli/schedule.go
@@ -10,7 +10,7 @@ import (
 	"golang.org/x/xerrors"
 
 	"github.com/coder/coder/cli/cliui"
-	"github.com/coder/coder/coderd/autobuild/schedule"
+	"github.com/coder/coder/coderd/schedule"
 	"github.com/coder/coder/coderd/util/ptr"
 	"github.com/coder/coder/coderd/util/tz"
 	"github.com/coder/coder/codersdk"

diff --git a/cli/util.go b/cli/util.go
@@ -8,7 +8,7 @@ import (
 
 	"golang.org/x/xerrors"
 
-	"github.com/coder/coder/coderd/autobuild/schedule"
+	"github.com/coder/coder/coderd/schedule"
 	"github.com/coder/coder/coderd/util/tz"
 )
 

diff --git a/coderd/activitybump_test.go b/coderd/activitybump_test.go
@@ -11,32 +11,32 @@ import (
 	"cdr.dev/slog/sloggers/slogtest"
 	"github.com/coder/coder/coderd/coderdtest"
 	"github.com/coder/coder/coderd/database"
-	"github.com/coder/coder/coderd/provisionerdserver"
+	"github.com/coder/coder/coderd/schedule"
 	"github.com/coder/coder/codersdk"
 	"github.com/coder/coder/testutil"
 )
 
 type mockTemplateScheduleStore struct {
-	getFn func(ctx context.Context, db database.Store, templateID uuid.UUID) (provisionerdserver.TemplateScheduleOptions, error)
-	setFn func(ctx context.Context, db database.Store, template database.Template, options provisionerdserver.TemplateScheduleOptions) (database.Template, error)
+	getFn func(ctx context.Context, db database.Store, templateID uuid.UUID) (schedule.TemplateScheduleOptions, error)
+	setFn func(ctx context.Context, db database.Store, template database.Template, options schedule.TemplateScheduleOptions) (database.Template, error)
 }
 
-var _ provisionerdserver.TemplateScheduleStore = mockTemplateScheduleStore{}
+var _ schedule.TemplateScheduleStore = mockTemplateScheduleStore{}
 
-func (m mockTemplateScheduleStore) GetTemplateScheduleOptions(ctx context.Context, db database.Store, templateID uuid.UUID) (provisionerdserver.TemplateScheduleOptions, error) {
+func (m mockTemplateScheduleStore) GetTemplateScheduleOptions(ctx context.Context, db database.Store, templateID uuid.UUID) (schedule.TemplateScheduleOptions, error) {
 	if m.getFn != nil {
 		return m.getFn(ctx, db, templateID)
 	}
 
-	return provisionerdserver.NewAGPLTemplateScheduleStore().GetTemplateScheduleOptions(ctx, db, templateID)
+	return schedule.NewAGPLTemplateScheduleStore().GetTemplateScheduleOptions(ctx, db, templateID)
 }
 
-func (m mockTemplateScheduleStore) SetTemplateScheduleOptions(ctx context.Context, db database.Store, template database.Template, options provisionerdserver.TemplateScheduleOptions) (database.Template, error) {
+func (m mockTemplateScheduleStore) SetTemplateScheduleOptions(ctx context.Context, db database.Store, template database.Template, options schedule.TemplateScheduleOptions) (database.Template, error) {
 	if m.setFn != nil {
 		return m.setFn(ctx, db, template, options)
 	}
 
-	return provisionerdserver.NewAGPLTemplateScheduleStore().SetTemplateScheduleOptions(ctx, db, template, options)
+	return schedule.NewAGPLTemplateScheduleStore().SetTemplateScheduleOptions(ctx, db, template, options)
 }
 
 func TestWorkspaceActivityBump(t *testing.T) {
@@ -58,8 +58,8 @@ func TestWorkspaceActivityBump(t *testing.T) {
 			// very frequently in tests.
 			AgentStatsRefreshInterval: time.Millisecond * 100,
 			TemplateScheduleStore: mockTemplateScheduleStore{
-				getFn: func(ctx context.Context, db database.Store, templateID uuid.UUID) (provisionerdserver.TemplateScheduleOptions, error) {
-					return provisionerdserver.TemplateScheduleOptions{
+				getFn: func(ctx context.Context, db database.Store, templateID uuid.UUID) (schedule.TemplateScheduleOptions, error) {
+					return schedule.TemplateScheduleOptions{
 						UserSchedulingEnabled: true,
 						DefaultTTL:            ttl,
 						MaxTTL:                maxTTL,

diff --git a/coderd/autobuild/executor/lifecycle_executor.go b/coderd/autobuild/executor/lifecycle_executor.go
@@ -10,10 +10,10 @@ import (
 	"golang.org/x/xerrors"
 
 	"cdr.dev/slog"
-	"github.com/coder/coder/coderd/autobuild/schedule"
 	"github.com/coder/coder/coderd/database"
 	"github.com/coder/coder/coderd/database/dbauthz"
 	"github.com/coder/coder/coderd/provisionerdserver"
+	"github.com/coder/coder/coderd/schedule"
 )
 
 // Executor automatically starts or stops workspaces.

diff --git a/coderd/autobuild/executor/lifecycle_executor_test.go b/coderd/autobuild/executor/lifecycle_executor_test.go
@@ -11,9 +11,9 @@ import (
 	"github.com/google/uuid"
 
 	"github.com/coder/coder/coderd/autobuild/executor"
-	"github.com/coder/coder/coderd/autobuild/schedule"
 	"github.com/coder/coder/coderd/coderdtest"
 	"github.com/coder/coder/coderd/database"
+	"github.com/coder/coder/coderd/schedule"
 	"github.com/coder/coder/coderd/util/ptr"
 	"github.com/coder/coder/codersdk"
 	"github.com/coder/coder/provisioner/echo"

diff --git a/coderd/coderd.go b/coderd/coderd.go
@@ -51,6 +51,7 @@ import (
 	"github.com/coder/coder/coderd/metricscache"
 	"github.com/coder/coder/coderd/provisionerdserver"
 	"github.com/coder/coder/coderd/rbac"
+	"github.com/coder/coder/coderd/schedule"
 	"github.com/coder/coder/coderd/telemetry"
 	"github.com/coder/coder/coderd/tracing"
 	"github.com/coder/coder/coderd/updatecheck"
@@ -118,7 +119,7 @@ type Options struct {
 	DERPMap               *tailcfg.DERPMap
 	SwaggerEndpoint       bool
 	SetUserGroups         func(ctx context.Context, tx database.Store, userID uuid.UUID, groupNames []string) error
-	TemplateScheduleStore provisionerdserver.TemplateScheduleStore
+	TemplateScheduleStore schedule.TemplateScheduleStore
 
 	// APIRateLimit is the minutely throughput rate limit per user or ip.
 	// Setting a rate limit <0 will disable the rate limiter across the entire
@@ -211,7 +212,7 @@ func New(options *Options) *API {
 		options.SetUserGroups = func(context.Context, database.Store, uuid.UUID, []string) error { return nil }
 	}
 	if options.TemplateScheduleStore == nil {
-		options.TemplateScheduleStore = provisionerdserver.NewAGPLTemplateScheduleStore()
+		options.TemplateScheduleStore = schedule.NewAGPLTemplateScheduleStore()
 	}
 
 	siteCacheDir := options.CacheDir
@@ -251,7 +252,7 @@ func New(options *Options) *API {
 		},
 		metricsCache:          metricsCache,
 		Auditor:               atomic.Pointer[audit.Auditor]{},
-		TemplateScheduleStore: atomic.Pointer[provisionerdserver.TemplateScheduleStore]{},
+		TemplateScheduleStore: atomic.Pointer[schedule.TemplateScheduleStore]{},
 		Experiments:           experiments,
 	}
 	if options.UpdateCheckOptions != nil {
@@ -726,7 +727,7 @@ type API struct {
 	WorkspaceClientCoordinateOverride atomic.Pointer[func(rw http.ResponseWriter) bool]
 	TailnetCoordinator                atomic.Pointer[tailnet.Coordinator]
 	QuotaCommitter                    atomic.Pointer[proto.QuotaCommitter]
-	TemplateScheduleStore             atomic.Pointer[provisionerdserver.TemplateScheduleStore]
+	TemplateScheduleStore             atomic.Pointer[schedule.TemplateScheduleStore]
 
 	HTTPAuth *HTTPAuthorizer
 

diff --git a/coderd/coderdtest/coderdtest.go b/coderd/coderdtest/coderdtest.go
@@ -65,8 +65,8 @@ import (
 	"github.com/coder/coder/coderd/gitsshkey"
 	"github.com/coder/coder/coderd/httpapi"
 	"github.com/coder/coder/coderd/httpmw"
-	"github.com/coder/coder/coderd/provisionerdserver"
 	"github.com/coder/coder/coderd/rbac"
+	"github.com/coder/coder/coderd/schedule"
 	"github.com/coder/coder/coderd/telemetry"
 	"github.com/coder/coder/coderd/updatecheck"
 	"github.com/coder/coder/coderd/util/ptr"
@@ -102,7 +102,7 @@ type Options struct {
 	TLSCertificates       []tls.Certificate
 	GitAuthConfigs        []*gitauth.Config
 	TrialGenerator        func(context.Context, string) error
-	TemplateScheduleStore provisionerdserver.TemplateScheduleStore
+	TemplateScheduleStore schedule.TemplateScheduleStore
 
 	// All rate limits default to -1 (unlimited) in tests if not set.
 	APIRateLimit   int

diff --git a/coderd/provisionerdserver/provisionerdserver.go b/coderd/provisionerdserver/provisionerdserver.go
@@ -28,6 +28,7 @@ import (
 	"github.com/coder/coder/coderd/database"
 	"github.com/coder/coder/coderd/database/dbauthz"
 	"github.com/coder/coder/coderd/parameter"
+	"github.com/coder/coder/coderd/schedule"
 	"github.com/coder/coder/coderd/telemetry"
 	"github.com/coder/coder/coderd/util/slice"
 	"github.com/coder/coder/codersdk"
@@ -54,7 +55,7 @@ type Server struct {
 	Telemetry             telemetry.Reporter
 	QuotaCommitter        *atomic.Pointer[proto.QuotaCommitter]
 	Auditor               *atomic.Pointer[audit.Auditor]
-	TemplateScheduleStore *atomic.Pointer[TemplateScheduleStore]
+	TemplateScheduleStore *atomic.Pointer[schedule.TemplateScheduleStore]
 
 	AcquireJobDebounce time.Duration
 }

diff --git a/coderd/provisionerdserver/provisionerdserver_test.go b/coderd/provisionerdserver/provisionerdserver_test.go
@@ -18,6 +18,7 @@ import (
 	"github.com/coder/coder/coderd/database/dbfake"
 	"github.com/coder/coder/coderd/database/dbgen"
 	"github.com/coder/coder/coderd/provisionerdserver"
+	"github.com/coder/coder/coderd/schedule"
 	"github.com/coder/coder/coderd/telemetry"
 	"github.com/coder/coder/codersdk"
 	"github.com/coder/coder/provisionerd/proto"
@@ -32,9 +33,9 @@ func mockAuditor() *atomic.Pointer[audit.Auditor] {
 	return ptr
 }
 
-func testTemplateScheduleStore() *atomic.Pointer[provisionerdserver.TemplateScheduleStore] {
-	ptr := &atomic.Pointer[provisionerdserver.TemplateScheduleStore]{}
-	store := provisionerdserver.NewAGPLTemplateScheduleStore()
+func testTemplateScheduleStore() *atomic.Pointer[schedule.TemplateScheduleStore] {
+	ptr := &atomic.Pointer[schedule.TemplateScheduleStore]{}
+	store := schedule.NewAGPLTemplateScheduleStore()
 	ptr.Store(&store)
 	return ptr
 }
@@ -890,9 +891,9 @@ func TestCompleteJob(t *testing.T) {
 
 				srv := setup(t, false)
 
-				var store provisionerdserver.TemplateScheduleStore = mockTemplateScheduleStore{
-					GetFn: func(_ context.Context, _ database.Store, _ uuid.UUID) (provisionerdserver.TemplateScheduleOptions, error) {
-						return provisionerdserver.TemplateScheduleOptions{
+				var store schedule.TemplateScheduleStore = mockTemplateScheduleStore{
+					GetFn: func(_ context.Context, _ database.Store, _ uuid.UUID) (schedule.TemplateScheduleOptions, error) {
+						return schedule.TemplateScheduleOptions{
 							UserSchedulingEnabled: true,
 							DefaultTTL:            c.templateDefaultTTL,
 							MaxTTL:                c.templateMaxTTL,
@@ -1167,15 +1168,15 @@ func must[T any](value T, err error) T {
 }
 
 type mockTemplateScheduleStore struct {
-	GetFn func(ctx context.Context, db database.Store, id uuid.UUID) (provisionerdserver.TemplateScheduleOptions, error)
+	GetFn func(ctx context.Context, db database.Store, id uuid.UUID) (schedule.TemplateScheduleOptions, error)
 }
 
-var _ provisionerdserver.TemplateScheduleStore = mockTemplateScheduleStore{}
+var _ schedule.TemplateScheduleStore = mockTemplateScheduleStore{}
 
-func (mockTemplateScheduleStore) SetTemplateScheduleOptions(ctx context.Context, db database.Store, template database.Template, opts provisionerdserver.TemplateScheduleOptions) (database.Template, error) {
-	return provisionerdserver.NewAGPLTemplateScheduleStore().SetTemplateScheduleOptions(ctx, db, template, opts)
+func (mockTemplateScheduleStore) SetTemplateScheduleOptions(ctx context.Context, db database.Store, template database.Template, opts schedule.TemplateScheduleOptions) (database.Template, error) {
+	return schedule.NewAGPLTemplateScheduleStore().SetTemplateScheduleOptions(ctx, db, template, opts)
 }
 
-func (m mockTemplateScheduleStore) GetTemplateScheduleOptions(ctx context.Context, db database.Store, id uuid.UUID) (provisionerdserver.TemplateScheduleOptions, error) {
+func (m mockTemplateScheduleStore) GetTemplateScheduleOptions(ctx context.Context, db database.Store, id uuid.UUID) (schedule.TemplateScheduleOptions, error) {
 	return m.GetFn(ctx, db, id)
 }
diff --git a/coderd/autobuild/schedule/schedule.go → coderd/schedule/cron.go b/coderd/autobuild/schedule/schedule.go → coderd/schedule/cron.go
@@ -1,5 +1,6 @@
-// package schedule provides utilities for parsing and deserializing
-// cron-style expressions.
+// package schedule provides utilities for managing template and workspace
+// auto-start and auto-stop schedules. This includes utilities for parsing and
+// deserializing cron-style expressions.
 package schedule
 
 import (

diff --git a/coderd/autobuild/schedule/schedule_test.go → coderd/schedule/cron_test.go b/coderd/autobuild/schedule/schedule_test.go → coderd/schedule/cron_test.go
@@ -6,7 +6,7 @@ import (
 
 	"github.com/stretchr/testify/require"
 
-	"github.com/coder/coder/coderd/autobuild/schedule"
+	"github.com/coder/coder/coderd/schedule"
 )
 
 func Test_Weekly(t *testing.T) {

diff --git a/...isionerdserver/templatescheduleoptions.go → coderd/schedule/template.go b/...isionerdserver/templatescheduleoptions.go → coderd/schedule/template.go
@@ -1,4 +1,4 @@
-package provisionerdserver
+package schedule
 
 import (
 	"context"

diff --git a/coderd/templates.go b/coderd/templates.go
@@ -18,8 +18,8 @@ import (
 	"github.com/coder/coder/coderd/database/dbauthz"
 	"github.com/coder/coder/coderd/httpapi"
 	"github.com/coder/coder/coderd/httpmw"
-	"github.com/coder/coder/coderd/provisionerdserver"
 	"github.com/coder/coder/coderd/rbac"
+	"github.com/coder/coder/coderd/schedule"
 	"github.com/coder/coder/coderd/telemetry"
 	"github.com/coder/coder/codersdk"
 	"github.com/coder/coder/examples"
@@ -273,7 +273,7 @@ func (api *API) postTemplateByOrganization(rw http.ResponseWriter, r *http.Reque
 			return xerrors.Errorf("insert template: %s", err)
 		}
 
-		dbTemplate, err = (*api.TemplateScheduleStore.Load()).SetTemplateScheduleOptions(ctx, tx, dbTemplate, provisionerdserver.TemplateScheduleOptions{
+		dbTemplate, err = (*api.TemplateScheduleStore.Load()).SetTemplateScheduleOptions(ctx, tx, dbTemplate, schedule.TemplateScheduleOptions{
 			UserSchedulingEnabled: true,
 			DefaultTTL:            defaultTTL,
 			MaxTTL:                maxTTL,
@@ -536,7 +536,7 @@ func (api *API) patchTemplateMeta(rw http.ResponseWriter, r *http.Request) {
 		defaultTTL := time.Duration(req.DefaultTTLMillis) * time.Millisecond
 		maxTTL := time.Duration(req.MaxTTLMillis) * time.Millisecond
 		if defaultTTL != time.Duration(template.DefaultTTL) || maxTTL != time.Duration(template.MaxTTL) {
-			updated, err = (*api.TemplateScheduleStore.Load()).SetTemplateScheduleOptions(ctx, tx, updated, provisionerdserver.TemplateScheduleOptions{
+			updated, err = (*api.TemplateScheduleStore.Load()).SetTemplateScheduleOptions(ctx, tx, updated, schedule.TemplateScheduleOptions{
 				UserSchedulingEnabled: true,
 				DefaultTTL:            defaultTTL,
 				MaxTTL:                maxTTL,

diff --git a/coderd/templates_test.go b/coderd/templates_test.go
@@ -16,7 +16,7 @@ import (
 	"github.com/coder/coder/coderd/audit"
 	"github.com/coder/coder/coderd/coderdtest"
 	"github.com/coder/coder/coderd/database"
-	"github.com/coder/coder/coderd/provisionerdserver"
+	"github.com/coder/coder/coderd/schedule"
 	"github.com/coder/coder/coderd/util/ptr"
 	"github.com/coder/coder/codersdk"
 	"github.com/coder/coder/codersdk/agentsdk"
@@ -159,7 +159,7 @@ func TestPostTemplateByOrganization(t *testing.T) {
 			var setCalled int64
 			client := coderdtest.New(t, &coderdtest.Options{
 				TemplateScheduleStore: mockTemplateScheduleStore{
-					setFn: func(ctx context.Context, db database.Store, template database.Template, options provisionerdserver.TemplateScheduleOptions) (database.Template, error) {
+					setFn: func(ctx context.Context, db database.Store, template database.Template, options schedule.TemplateScheduleOptions) (database.Template, error) {
 						atomic.AddInt64(&setCalled, 1)
 						require.Equal(t, maxTTL, options.MaxTTL)
 						template.DefaultTTL = int64(options.DefaultTTL)
@@ -450,7 +450,7 @@ func TestPatchTemplateMeta(t *testing.T) {
 			var setCalled int64
 			client := coderdtest.New(t, &coderdtest.Options{
 				TemplateScheduleStore: mockTemplateScheduleStore{
-					setFn: func(ctx context.Context, db database.Store, template database.Template, options provisionerdserver.TemplateScheduleOptions) (database.Template, error) {
+					setFn: func(ctx context.Context, db database.Store, template database.Template, options schedule.TemplateScheduleOptions) (database.Template, error) {
 						if atomic.AddInt64(&setCalled, 1) == 2 {
 							require.Equal(t, maxTTL, options.MaxTTL)
 						}

diff --git a/coderd/workspaces.go b/coderd/workspaces.go
@@ -18,12 +18,12 @@ import (
 
 	"cdr.dev/slog"
 	"github.com/coder/coder/coderd/audit"
-	"github.com/coder/coder/coderd/autobuild/schedule"
 	"github.com/coder/coder/coderd/database"
 	"github.com/coder/coder/coderd/httpapi"
 	"github.com/coder/coder/coderd/httpmw"
 	"github.com/coder/coder/coderd/provisionerdserver"
 	"github.com/coder/coder/coderd/rbac"
+	"github.com/coder/coder/coderd/schedule"
 	"github.com/coder/coder/coderd/searchquery"
 	"github.com/coder/coder/coderd/telemetry"
 	"github.com/coder/coder/coderd/tracing"

diff --git a/coderd/workspaces_test.go b/coderd/workspaces_test.go
@@ -17,11 +17,11 @@ import (
 
 	"github.com/coder/coder/agent"
 	"github.com/coder/coder/coderd/audit"
-	"github.com/coder/coder/coderd/autobuild/schedule"
 	"github.com/coder/coder/coderd/coderdtest"
 	"github.com/coder/coder/coderd/database"
 	"github.com/coder/coder/coderd/parameter"
 	"github.com/coder/coder/coderd/rbac"
+	"github.com/coder/coder/coderd/schedule"
 	"github.com/coder/coder/coderd/util/ptr"
 	"github.com/coder/coder/codersdk"
 	"github.com/coder/coder/codersdk/agentsdk"

diff --git a/enterprise/coderd/coderd.go b/enterprise/coderd/coderd.go
@@ -20,8 +20,8 @@ import (
 	agplaudit "github.com/coder/coder/coderd/audit"
 	"github.com/coder/coder/coderd/httpapi"
 	"github.com/coder/coder/coderd/httpmw"
-	"github.com/coder/coder/coderd/provisionerdserver"
 	"github.com/coder/coder/coderd/rbac"
+	"github.com/coder/coder/coderd/schedule"
 	"github.com/coder/coder/codersdk"
 	"github.com/coder/coder/enterprise/coderd/license"
 	"github.com/coder/coder/enterprise/derpmesh"
@@ -315,10 +315,10 @@ func (api *API) updateEntitlements(ctx context.Context) error {
 	if changed, enabled := featureChanged(codersdk.FeatureAdvancedTemplateScheduling); changed {
 		if enabled {
 			store := &enterpriseTemplateScheduleStore{}
-			ptr := provisionerdserver.TemplateScheduleStore(store)
+			ptr := schedule.TemplateScheduleStore(store)
 			api.AGPL.TemplateScheduleStore.Store(&ptr)
 		} else {
-			store := provisionerdserver.NewAGPLTemplateScheduleStore()
+			store := schedule.NewAGPLTemplateScheduleStore()
 			api.AGPL.TemplateScheduleStore.Store(&store)
 		}
 	}