require_promoted_version -> require_active_version

sreya · sreya · commit 6586b6fdb7fc · 2023-10-15T23:06:06.000Z
diff --git a/coderd/autobuild/lifecycle_executor.go b/coderd/autobuild/lifecycle_executor.go
@@ -460,5 +460,5 @@ func auditBuild(ctx context.Context, log slog.Logger, auditor audit.Auditor, par
 }
 
 func useActiveVersion(opts schedule.TemplateScheduleOptions, ws database.Workspace) bool {
-	return opts.RequirePromotedVersion || ws.AutomaticUpdates == database.AutomaticUpdatesAlways
+	return opts.RequireActiveVersion || ws.AutomaticUpdates == database.AutomaticUpdatesAlways
 }
diff --git a/coderd/database/dbauthz/dbauthz.go b/coderd/database/dbauthz/dbauthz.go
@@ -2224,7 +2224,7 @@ func (q *querier) InsertWorkspaceBuild(ctx context.Context, arg database.InsertW
 		// If the template requires the promoted version we need to check if
 		// the user is a template admin. If they aren't and are attempting
 		// to use a non-promoted version then we must fail the request.
-		if t.RequirePromotedVersion {
+		if t.RequireActiveVersion {
 			if arg.TemplateVersionID != t.ActiveVersionID {
 				if err = q.authorizeContext(ctx, rbac.ActionUpdate, t); err != nil {
 					return xerrors.Errorf("cannot use non-active version: %w", err)
diff --git a/coderd/database/dbfake/dbfake.go b/coderd/database/dbfake/dbfake.go
@@ -5703,7 +5703,7 @@ func (q *FakeQuerier) UpdateTemplateScheduleByID(_ context.Context, arg database
 		tpl.FailureTTL = arg.FailureTTL
 		tpl.TimeTilDormant = arg.TimeTilDormant
 		tpl.TimeTilDormantAutoDelete = arg.TimeTilDormantAutoDelete
-		tpl.RequirePromotedVersion = arg.RequirePromotedVersion
+		tpl.RequireActiveVersion = arg.RequireActiveVersion
 		q.templates[idx] = tpl
 		return nil
 	}
diff --git a/coderd/database/dump.sql b/coderd/database/dump.sql
diff --git a/coderd/database/migrations/000165_template_promotion.down.sql b/coderd/database/migrations/000165_template_promotion.down.sql
@@ -1,6 +1,6 @@
 BEGIN;
 
-ALTER TABLE templates DROP COLUMN require_promoted_version;
+ALTER TABLE templates DROP COLUMN require_active_version;
 
 -- Update the template_with_users view;
 DROP VIEW template_with_users;
diff --git a/coderd/database/migrations/000165_template_promotion.up.sql b/coderd/database/migrations/000165_template_promotion.up.sql
@@ -2,7 +2,7 @@ BEGIN;
 
 DROP VIEW template_with_users;
 
-ALTER TABLE templates ADD COLUMN require_promoted_version boolean NOT NULL DEFAULT 'f';
+ALTER TABLE templates ADD COLUMN require_active_version boolean NOT NULL DEFAULT 'f';
 
 CREATE VIEW
     template_with_users
diff --git a/coderd/database/models.go b/coderd/database/models.go
diff --git a/coderd/database/queries.sql.go b/coderd/database/queries.sql.go
diff --git a/coderd/database/queries/templates.sql b/coderd/database/queries/templates.sql
@@ -123,7 +123,7 @@ SET
 	failure_ttl = $9,
 	time_til_dormant = $10,
 	time_til_dormant_autodelete = $11,
-    require_promoted_version = $12
+	require_active_version = $12
 WHERE
 	id = $1
 ;
diff --git a/coderd/schedule/template.go b/coderd/schedule/template.go
@@ -118,7 +118,9 @@ type TemplateScheduleOptions struct {
 	// workspaces whose dormant_at field violates the new template time_til_dormant_autodelete
 	// threshold.
 	UpdateWorkspaceDormantAt bool `json:"update_workspace_dormant_at"`
-	RequirePromotedVersion   bool `json:"require_promoted_version"`
+	// RequireActiveVersion requires that a starting a workspace uses the active
+	// version for a template.
+	RequireActiveVersion bool `json:"require_promoted_version"`
 }
 
 // TemplateScheduleStore provides an interface for retrieving template
@@ -164,7 +166,7 @@ func (*agplTemplateScheduleStore) Get(ctx context.Context, db database.Store, te
 		FailureTTL:               0,
 		TimeTilDormant:           0,
 		TimeTilDormantAutoDelete: 0,
-		RequirePromotedVersion:   false,
+		RequireActiveVersion:     false,
 	}, nil
 }
 
@@ -196,7 +198,7 @@ func (*agplTemplateScheduleStore) Set(ctx context.Context, db database.Store, tp
 			FailureTTL:                    tpl.FailureTTL,
 			TimeTilDormant:                tpl.TimeTilDormant,
 			TimeTilDormantAutoDelete:      tpl.TimeTilDormantAutoDelete,
-			RequirePromotedVersion:        tpl.RequirePromotedVersion,
+			RequireActiveVersion:          tpl.RequireActiveVersion,
 		})
 		if err != nil {
 			return xerrors.Errorf("update template schedule: %w", err)
diff --git a/coderd/templates.go b/coderd/templates.go
@@ -585,7 +585,7 @@ func (api *API) patchTemplateMeta(rw http.ResponseWriter, r *http.Request) {
 			req.FailureTTLMillis == time.Duration(template.FailureTTL).Milliseconds() &&
 			req.TimeTilDormantMillis == time.Duration(template.TimeTilDormant).Milliseconds() &&
 			req.TimeTilDormantAutoDeleteMillis == time.Duration(template.TimeTilDormantAutoDelete).Milliseconds() &&
-			req.RequirePromotedVersion == template.RequirePromotedVersion {
+			req.RequireActiveVersion == template.RequireActiveVersion {
 			return nil
 		}
 
@@ -629,7 +629,7 @@ func (api *API) patchTemplateMeta(rw http.ResponseWriter, r *http.Request) {
 			timeTilDormantAutoDelete != time.Duration(template.TimeTilDormantAutoDelete) ||
 			req.AllowUserAutostart != template.AllowUserAutostart ||
 			req.AllowUserAutostop != template.AllowUserAutostop ||
-			req.RequirePromotedVersion != template.RequirePromotedVersion {
+			req.RequireActiveVersion != template.RequireActiveVersion {
 			updated, err = (*api.TemplateScheduleStore.Load()).Set(ctx, tx, updated, schedule.TemplateScheduleOptions{
 				// Some of these values are enterprise-only, but the
 				// TemplateScheduleStore will handle avoiding setting them if
@@ -647,7 +647,7 @@ func (api *API) patchTemplateMeta(rw http.ResponseWriter, r *http.Request) {
 				TimeTilDormantAutoDelete:  timeTilDormantAutoDelete,
 				UpdateWorkspaceLastUsedAt: req.UpdateWorkspaceLastUsedAt,
 				UpdateWorkspaceDormantAt:  req.UpdateWorkspaceDormantAt,
-				RequirePromotedVersion:    req.RequirePromotedVersion,
+				RequireActiveVersion:      req.RequireActiveVersion,
 			})
 			if err != nil {
 				return xerrors.Errorf("set template schedule options: %w", err)
@@ -790,6 +790,6 @@ func (api *API) convertTemplate(
 			DaysOfWeek: codersdk.BitmapToWeekdays(uint8(template.AutostopRequirementDaysOfWeek)),
 			Weeks:      autostopRequirementWeeks,
 		},
-		RequirePromotedVersion: template.RequirePromotedVersion,
+		RequireActiveVersion: template.RequireActiveVersion,
 	}
 }
diff --git a/codersdk/templates.go b/codersdk/templates.go
@@ -51,7 +51,9 @@ type Template struct {
 	TimeTilDormantMillis           int64 `json:"time_til_dormant_ms"`
 	TimeTilDormantAutoDeleteMillis int64 `json:"time_til_dormant_autodelete_ms"`
 
-	RequirePromotedVersion bool `json:"require_promoted_version"`
+	// RequireActiveVersion mandates that workspaces are built with the active
+	// template version.
+	RequireActiveVersion bool `json:"require_promoted_version"`
 }
 
 // WeekdaysToBitmap converts a list of weekdays to a bitmap in accordance with
@@ -214,10 +216,10 @@ type UpdateTemplateMeta struct {
 	// from the template. This is useful for preventing dormant workspaces being immediately
 	// deleted when updating the dormant_ttl field to a new, shorter value.
 	UpdateWorkspaceDormantAt bool `json:"update_workspace_dormant_at"`
-	// RequirePromotedVersion mandates workspaces built using this template
+	// RequireActiveVersion mandates workspaces built using this template
 	// use the latest promoted version of the template. This option has no
 	// effect on template admins.
-	RequirePromotedVersion bool `json:"require_promoted_version"`
+	RequireActiveVersion bool `json:"require_promoted_version"`
 }
 
 type TemplateExample struct {
diff --git a/enterprise/audit/table.go b/enterprise/audit/table.go
@@ -84,7 +84,7 @@ var auditableResourcesTypes = map[any]map[string]Action{
 		"failure_ttl":                       ActionTrack,
 		"time_til_dormant":                  ActionTrack,
 		"time_til_dormant_autodelete":       ActionTrack,
-		"require_promoted_version":          ActionTrack,
+		"require_active_version":            ActionTrack,
 	},
 	&database.TemplateVersion{}: {
 		"id":                      ActionTrack,
diff --git a/enterprise/coderd/schedule/template.go b/enterprise/coderd/schedule/template.go
@@ -89,7 +89,7 @@ func (s *EnterpriseTemplateScheduleStore) Get(ctx context.Context, db database.S
 		FailureTTL:               time.Duration(tpl.FailureTTL),
 		TimeTilDormant:           time.Duration(tpl.TimeTilDormant),
 		TimeTilDormantAutoDelete: time.Duration(tpl.TimeTilDormantAutoDelete),
-		RequirePromotedVersion:   tpl.RequirePromotedVersion,
+		RequireActiveVersion:     tpl.RequireActiveVersion,
 	}, nil
 }
 
@@ -140,7 +140,7 @@ func (s *EnterpriseTemplateScheduleStore) Set(ctx context.Context, db database.S
 			FailureTTL:                    int64(opts.FailureTTL),
 			TimeTilDormant:                int64(opts.TimeTilDormant),
 			TimeTilDormantAutoDelete:      int64(opts.TimeTilDormantAutoDelete),
-			RequirePromotedVersion:        opts.RequirePromotedVersion,
+			RequireActiveVersion:          opts.RequireActiveVersion,
 		})
 		if err != nil {
 			return xerrors.Errorf("update template schedule: %w", err)
diff --git a/enterprise/coderd/templates_test.go b/enterprise/coderd/templates_test.go
@@ -507,16 +507,16 @@ func TestTemplates(t *testing.T) {
 		version := coderdtest.CreateTemplateVersion(t, client, user.OrganizationID, nil)
 		template := coderdtest.CreateTemplate(t, client, user.OrganizationID, version.ID)
 		coderdtest.AwaitTemplateVersionJobCompleted(t, client, version.ID)
-		require.False(t, template.RequirePromotedVersion)
+		require.False(t, template.RequireActiveVersion)
 
 		ctx, cancel := context.WithTimeout(context.Background(), testutil.WaitLong)
 		defer cancel()
 
 		updatedTemplate, err := client.UpdateTemplateMeta(ctx, template.ID, codersdk.UpdateTemplateMeta{
-			RequirePromotedVersion: true,
+			RequireActiveVersion: true,
 		})
 		require.NoError(t, err)
-		require.True(t, updatedTemplate.RequirePromotedVersion)
+		require.True(t, updatedTemplate.RequireActiveVersion)
 
 		// Assert that fetching a template is no different from the response
 		// when updating.
diff --git a/enterprise/coderd/workspacebuilds_test.go b/enterprise/coderd/workspacebuilds_test.go
@@ -18,7 +18,7 @@ import (
 
 func TestWorkspaceBuild(t *testing.T) {
 	t.Parallel()
-	t.Run("TemplateAdminNoActiveVersion", func(t *testing.T) {
+	t.Run("TemplateRequiresActiveVersion", func(t *testing.T) {
 		t.Parallel()
 
 		ctx := testutil.Context(t, testutil.WaitMedium)
@@ -43,7 +43,7 @@ func TestWorkspaceBuild(t *testing.T) {
 		coderdtest.AwaitTemplateVersionJobCompleted(t, ownerClient, oldVersion.ID)
 		require.Equal(t, oldVersion.ID, template.ActiveVersionID)
 		template, err := ownerClient.UpdateTemplateMeta(ctx, template.ID, codersdk.UpdateTemplateMeta{
-			RequirePromotedVersion: true,
+			RequireActiveVersion: true,
 		})
 		require.NoError(t, err)
 
diff --git a/enterprise/coderd/workspaces_test.go b/enterprise/coderd/workspaces_test.go
@@ -803,8 +803,8 @@ func TestWorkspaceAutobuild(t *testing.T) {
 
 		// Update the template to require the promoted version.
 		_, err = client.UpdateTemplateMeta(ctx, template.ID, codersdk.UpdateTemplateMeta{
-			RequirePromotedVersion: true,
-			AllowUserAutostart:     true,
+			RequireActiveVersion: true,
+			AllowUserAutostart:   true,
 		})
 		require.NoError(t, err)
 

Original file line number	Diff line number	Diff line change
`@@ -460,5 +460,5 @@ func auditBuild(ctx context.Context, log slog.Logger, auditor audit.Auditor, par`
`460`	`460`	`}`
`461`	`461`
`462`	`462`	`func useActiveVersion(opts schedule.TemplateScheduleOptions, ws database.Workspace) bool {`
`463`		`- return opts.RequirePromotedVersion \|\| ws.AutomaticUpdates == database.AutomaticUpdatesAlways`
	`463`	`+ return opts.RequireActiveVersion \|\| ws.AutomaticUpdates == database.AutomaticUpdatesAlways`
`464`	`464`	`}`
Original file line number	Diff line number	Diff line change
`@@ -5703,7 +5703,7 @@ func (q *FakeQuerier) UpdateTemplateScheduleByID(_ context.Context, arg database`
`5703`	`5703`	`tpl.FailureTTL = arg.FailureTTL`
`5704`	`5704`	`tpl.TimeTilDormant = arg.TimeTilDormant`
`5705`	`5705`	`tpl.TimeTilDormantAutoDelete = arg.TimeTilDormantAutoDelete`
`5706`		`- tpl.RequirePromotedVersion = arg.RequirePromotedVersion`
	`5706`	`+ tpl.RequireActiveVersion = arg.RequireActiveVersion`
`5707`	`5707`	`q.templates[idx] = tpl`
`5708`	`5708`	`return nil`
`5709`	`5709`	`}`
Original file line number	Diff line number	Diff line change
`@@ -123,7 +123,7 @@ SET`
`123`	`123`	`failure_ttl = $9,`
`124`	`124`	`time_til_dormant = $10,`
`125`	`125`	`time_til_dormant_autodelete = $11,`
`126`		`- require_promoted_version = $12`
	`126`	`+ require_active_version = $12`
`127`	`127`	`WHERE`
`128`	`128`	`id = $1`
`129`	`129`	`;`