feat: add API for setting template max_ttl

coder · deansheather · Mar 7, 2023 · Feb 8, 2023 · Feb 15, 2023 · Feb 20, 2023
commit 9e37cc73cf7238e73002b17f7c142af075e61937
diff --git a/coderd/apidoc/docs.go b/coderd/apidoc/docs.go
diff --git a/coderd/apidoc/swagger.json b/coderd/apidoc/swagger.json
diff --git a/coderd/database/dbauthz/querier.go b/coderd/database/dbauthz/querier.go
@@ -852,6 +852,13 @@ func (q *querier) UpdateTemplateMetaByID(ctx context.Context, arg database.Updat
 	return updateWithReturn(q.log, q.auth, fetch, q.db.UpdateTemplateMetaByID)(ctx, arg)
 }
 
+func (q *querier) UpdateTemplateScheduleByID(ctx context.Context, arg database.UpdateTemplateScheduleByIDParams) (database.Template, error) {
+	fetch := func(ctx context.Context, arg database.UpdateTemplateScheduleByIDParams) (database.Template, error) {
+		return q.db.GetTemplateByID(ctx, arg.ID)
+	}
+	return updateWithReturn(q.log, q.auth, fetch, q.db.UpdateTemplateScheduleByID)(ctx, arg)
+}
+
 func (q *querier) UpdateTemplateVersionByID(ctx context.Context, arg database.UpdateTemplateVersionByIDParams) error {
 	template, err := q.db.GetTemplateByID(ctx, arg.TemplateID.UUID)
 	if err != nil {

diff --git a/coderd/database/dbfake/databasefake.go b/coderd/database/dbfake/databasefake.go
@@ -1644,8 +1644,8 @@ func (q *fakeQuerier) UpdateTemplateMetaByID(_ context.Context, arg database.Upd
 		return database.Template{}, err
 	}
 
-	q.mutex.RLock()
-	defer q.mutex.RUnlock()
+	q.mutex.Lock()
+	defer q.mutex.Unlock()
 
 	for idx, tpl := range q.templates {
 		if tpl.ID != arg.ID {
@@ -1656,7 +1656,28 @@ func (q *fakeQuerier) UpdateTemplateMetaByID(_ context.Context, arg database.Upd
 		tpl.DisplayName = arg.DisplayName
 		tpl.Description = arg.Description
 		tpl.Icon = arg.Icon
+		q.templates[idx] = tpl
+		return tpl, nil
+	}
+
+	return database.Template{}, sql.ErrNoRows
+}
+
+func (q *fakeQuerier) UpdateTemplateScheduleByID(_ context.Context, arg database.UpdateTemplateScheduleByIDParams) (database.Template, error) {
+	if err := validateDatabaseType(arg); err != nil {
+		return database.Template{}, err
+	}
+
+	q.mutex.Lock()
+	defer q.mutex.Unlock()
+
+	for idx, tpl := range q.templates {
+		if tpl.ID != arg.ID {
+			continue
+		}
+		tpl.UpdatedAt = database.Now()
 		tpl.DefaultTTL = arg.DefaultTTL
+		tpl.MaxTTL = arg.MaxTTL
 		q.templates[idx] = tpl
 		return tpl, nil
 	}

diff --git a/coderd/database/querier.go b/coderd/database/querier.go
diff --git a/coderd/database/queries.sql.go b/coderd/database/queries.sql.go
diff --git a/coderd/database/queries/provisionerjobs.sql b/coderd/database/queries/provisionerjobs.sql
@@ -22,7 +22,7 @@ WHERE
 			-- Ensure the caller has the correct provisioner.
 			AND nested.provisioner = ANY(@types :: provisioner_type [ ])
 			-- Ensure the caller satisfies all job tags.
-			AND nested.tags <@ @tags :: jsonb 
+			AND nested.tags <@ @tags :: jsonb
 		ORDER BY
 			nested.created_at
 		FOR UPDATE

diff --git a/coderd/database/queries/templates.sql b/coderd/database/queries/templates.sql
@@ -102,11 +102,22 @@ UPDATE
 SET
 	updated_at = $2,
 	description = $3,
-	default_ttl = $4,
-	name = $5,
-	icon = $6,
-	display_name = $7,
-	allow_user_cancel_workspace_jobs = $8
+	name = $4,
+	icon = $5,
+	display_name = $6,
+	allow_user_cancel_workspace_jobs = $7
+WHERE
+	id = $1
+RETURNING
+	*;
+
+-- name: UpdateTemplateScheduleByID :one
+UPDATE
+	templates
+SET
+	updated_at = $2,
+	default_ttl = $3,
+	max_ttl = $4
 WHERE
 	id = $1
 RETURNING

diff --git a/coderd/provisionerdserver/templatescheduleoptions.go b/coderd/provisionerdserver/templatescheduleoptions.go
@@ -23,6 +23,7 @@ type TemplateScheduleOptions struct {
 // scheduling options set by the template/site admin.
 type TemplateScheduleStore interface {
 	GetTemplateScheduleOptions(ctx context.Context, db database.Store, templateID uuid.UUID) (TemplateScheduleOptions, error)
+	SetTemplateScheduleOptions(ctx context.Context, db database.Store, template database.Template, opts TemplateScheduleOptions) (database.Template, error)
 }
 
 type agplTemplateScheduleStore struct{}
@@ -33,7 +34,7 @@ func NewAGPLTemplateScheduleStore() TemplateScheduleStore {
 	return &agplTemplateScheduleStore{}
 }
 
-func (s *agplTemplateScheduleStore) GetTemplateScheduleOptions(ctx context.Context, db database.Store, templateID uuid.UUID) (TemplateScheduleOptions, error) {
+func (*agplTemplateScheduleStore) GetTemplateScheduleOptions(ctx context.Context, db database.Store, templateID uuid.UUID) (TemplateScheduleOptions, error) {
 	tpl, err := db.GetTemplateByID(ctx, templateID)
 	if err != nil {
 		return TemplateScheduleOptions{}, err
@@ -42,6 +43,19 @@ func (s *agplTemplateScheduleStore) GetTemplateScheduleOptions(ctx context.Conte
 	return TemplateScheduleOptions{
 		UserSchedulingEnabled: true,
 		DefaultTTL:            time.Duration(tpl.DefaultTTL),
-		MaxTTL:                0,
+		// Disregard the value in the database, since MaxTTL is an enterprise
+		// feature.
+		MaxTTL: 0,
 	}, nil
 }
+
+func (*agplTemplateScheduleStore) SetTemplateScheduleOptions(ctx context.Context, db database.Store, tpl database.Template, opts TemplateScheduleOptions) (database.Template, error) {
+	return db.UpdateTemplateScheduleByID(ctx, database.UpdateTemplateScheduleByIDParams{
+		ID:         tpl.ID,
+		UpdatedAt:  database.Now(),
+		DefaultTTL: int64(opts.DefaultTTL),
+		// Don't allow changing it, but keep the value in the DB (to avoid
+		// clearing settings if the license has an issue).
+		MaxTTL: tpl.MaxTTL,
+	})
+}
diff --git a/coderd/templates.go b/coderd/templates.go
@@ -17,6 +17,7 @@ import (
 	"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/telemetry"
 	"github.com/coder/coder/codersdk"
@@ -479,7 +480,6 @@ func (api *API) patchTemplateMeta(rw http.ResponseWriter, r *http.Request) {
 		displayName := req.DisplayName
 		desc := req.Description
 		icon := req.Icon
-		defaultTTL := time.Duration(req.DefaultTTLMillis) * time.Millisecond
 		allowUserCancelWorkspaceJobs := req.AllowUserCancelWorkspaceJobs
 
 		if name == "" {
@@ -497,11 +497,23 @@ func (api *API) patchTemplateMeta(rw http.ResponseWriter, r *http.Request) {
 			DisplayName:                  displayName,
 			Description:                  desc,
 			Icon:                         icon,
-			DefaultTTL:                   int64(defaultTTL),
 			AllowUserCancelWorkspaceJobs: allowUserCancelWorkspaceJobs,
 		})
 		if err != nil {
-			return err
+			return xerrors.Errorf("update template metadata: %w", err)
+		}
+
+		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{
+				UserSchedulingEnabled: true,
+				DefaultTTL:            defaultTTL,
+				MaxTTL:                maxTTL,
+			})
+			if err != nil {
+				return xerrors.Errorf("set template schedule options: %w", err)
+			}
 		}
 
 		return nil

diff --git a/coderd/templates_test.go b/coderd/templates_test.go
@@ -430,6 +430,30 @@ func TestPatchTemplateMeta(t *testing.T) {
 		require.NoError(t, err)
 		assert.Equal(t, updated.Icon, "")
 	})
+
+	t.Run("MaxTTLEnterpriseOnly", func(t *testing.T) {
+		t.Parallel()
+
+		client := coderdtest.New(t, nil)
+		user := coderdtest.CreateFirstUser(t, client)
+		version := coderdtest.CreateTemplateVersion(t, client, user.OrganizationID, nil)
+		template := coderdtest.CreateTemplate(t, client, user.OrganizationID, version.ID)
+		require.EqualValues(t, 0, template.MaxTTLMillis)
+		req := codersdk.UpdateTemplateMeta{
+			MaxTTLMillis: time.Hour.Milliseconds(),
+		}
+
+		ctx, cancel := context.WithTimeout(context.Background(), testutil.WaitLong)
+		defer cancel()
+
+		updated, err := client.UpdateTemplateMeta(ctx, template.ID, req)
+		require.NoError(t, err)
+		require.EqualValues(t, 0, updated.MaxTTLMillis)
+
+		template, err = client.Template(ctx, template.ID)
+		require.NoError(t, err)
+		require.EqualValues(t, 0, template.MaxTTLMillis)
+	})
 }
 
 func TestDeleteTemplate(t *testing.T) {

diff --git a/codersdk/templates.go b/codersdk/templates.go
@@ -28,8 +28,11 @@ type Template struct {
 	Description      string                 `json:"description"`
 	Icon             string                 `json:"icon"`
 	DefaultTTLMillis int64                  `json:"default_ttl_ms"`
-	CreatedByID      uuid.UUID              `json:"created_by_id" format:"uuid"`
-	CreatedByName    string                 `json:"created_by_name"`
+	// MaxTTLMillis is an enterprise feature. It's value is only used if your
+	// license is entitled to use the advanced template scheduling feature.
+	MaxTTLMillis  int64     `json:"max_ttl_ms"`
+	CreatedByID   uuid.UUID `json:"created_by_id" format:"uuid"`
+	CreatedByName string    `json:"created_by_name"`
 
 	AllowUserCancelWorkspaceJobs bool `json:"allow_user_cancel_workspace_jobs"`
 }
@@ -75,12 +78,16 @@ type UpdateTemplateACL struct {
 }
 
 type UpdateTemplateMeta struct {
-	Name                         string `json:"name,omitempty" validate:"omitempty,template_name"`
-	DisplayName                  string `json:"display_name,omitempty" validate:"omitempty,template_display_name"`
-	Description                  string `json:"description,omitempty"`
-	Icon                         string `json:"icon,omitempty"`
-	DefaultTTLMillis             int64  `json:"default_ttl_ms,omitempty"`
-	AllowUserCancelWorkspaceJobs bool   `json:"allow_user_cancel_workspace_jobs,omitempty"`
+	Name             string `json:"name,omitempty" validate:"omitempty,template_name"`
+	DisplayName      string `json:"display_name,omitempty" validate:"omitempty,template_display_name"`
+	Description      string `json:"description,omitempty"`
+	Icon             string `json:"icon,omitempty"`
+	DefaultTTLMillis int64  `json:"default_ttl_ms,omitempty"`
+	// MaxTTLMillis can only be set if your license includes the advanced
+	// template scheduling feature. If you attempt to set this value while
+	// unlicensed, it will be ignored.
+	MaxTTLMillis                 int64 `json:"max_ttl_ms,omitempty"`
+	AllowUserCancelWorkspaceJobs bool  `json:"allow_user_cancel_workspace_jobs,omitempty"`
 }
 
 type TemplateExample struct {