chore: add classic parameter flow to tempalte meta api

coder · Emyrk · May 15, 2025 · May 14, 2025 · May 14, 2025 · May 14, 2025
commit 459ec293c741d0a5b6edfadb27295cd77a192180
diff --git a/coderd/database/dbmem/dbmem.go b/coderd/database/dbmem/dbmem.go
@@ -11082,6 +11082,7 @@ func (q *FakeQuerier) UpdateTemplateMetaByID(_ context.Context, arg database.Upd
 		tpl.GroupACL = arg.GroupACL
 		tpl.AllowUserCancelWorkspaceJobs = arg.AllowUserCancelWorkspaceJobs
 		tpl.MaxPortSharingLevel = arg.MaxPortSharingLevel
+		tpl.ClassicParameterFlow = arg.ClassicParameterFlow
 		q.templates[idx] = tpl
 		return nil
 	}

diff --git a/coderd/database/dump.sql b/coderd/database/dump.sql
diff --git a/coderd/database/migrations/000325_version_dynamic_parameter_flow.down.sql b/coderd/database/migrations/000325_version_dynamic_parameter_flow.down.sql
@@ -1 +1 @@
-ALTER TABLE templates DROP COLUMN dynamic_parameter_flow;
+ALTER TABLE templates DROP COLUMN classic_parameter_flow;
diff --git a/coderd/database/migrations/000325_version_dynamic_parameter_flow.up.sql b/coderd/database/migrations/000325_version_dynamic_parameter_flow.up.sql
@@ -1,10 +1,36 @@
--- Default to `true`. Users will have to opt out of the new flow if they have issues.
-ALTER TABLE templates ADD COLUMN dynamic_parameter_flow BOOL NOT NULL DEFAULT true;
+-- Default to `false`. Users will have to manually opt back into the classic parameter flow.
+-- We want the new experience to be tried first.
+ALTER TABLE templates ADD COLUMN classic_parameter_flow BOOL NOT NULL DEFAULT false;
 
-COMMENT ON COLUMN templates.dynamic_parameter_flow IS
-	'Determines whether to default to the dynamic parameter creation flow for this template. '
-	'As a template wide setting, the template admin can opt out if there are any issues. '
+COMMENT ON COLUMN templates.classic_parameter_flow IS
+	'Determines whether to default to the dynamic parameter creation flow for this template '
+	'or continue using the legacy classic parameter creation flow.'
+	'This is a template wide setting, the template admin can revert to the classic flow if there are any issues. '
 	'An escape hatch is required, as workspace creation is a core workflow and cannot break. '
 	'This column will be removed when the dynamic parameter creation flow is stable.';
 
 
+-- Update the template_with_names view by recreating it.
+DROP VIEW template_with_names;
+CREATE VIEW
+	template_with_names
+AS
+SELECT
+	templates.*,
+	coalesce(visible_users.avatar_url, '') AS created_by_avatar_url,
+	coalesce(visible_users.username, '') AS created_by_username,
+	coalesce(organizations.name, '') AS organization_name,
+	coalesce(organizations.display_name, '') AS organization_display_name,
+	coalesce(organizations.icon, '') AS organization_icon
+FROM
+	templates
+		LEFT JOIN
+	visible_users
+	ON
+		templates.created_by = visible_users.id
+		LEFT JOIN
+	organizations
+	ON templates.organization_id = organizations.id
+;
+
+COMMENT ON VIEW template_with_names IS 'Joins in the display name information such as username, avatar, and organization name.';
diff --git a/coderd/database/modelqueries.go b/coderd/database/modelqueries.go
@@ -117,6 +117,7 @@ func (q *sqlQuerier) GetAuthorizedTemplates(ctx context.Context, arg GetTemplate
 			&i.Deprecated,
 			&i.ActivityBump,
 			&i.MaxPortSharingLevel,
+			&i.ClassicParameterFlow,
 			&i.CreatedByAvatarURL,
 			&i.CreatedByUsername,
 			&i.OrganizationName,

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
@@ -124,7 +124,8 @@ SET
 	display_name = $6,
 	allow_user_cancel_workspace_jobs = $7,
 	group_acl = $8,
-	max_port_sharing_level = $9
+	max_port_sharing_level = $9,
+	classic_parameter_flow = $10
 WHERE
 	id = $1
 ;

diff --git a/coderd/templates.go b/coderd/templates.go
@@ -728,6 +728,12 @@ func (api *API) patchTemplateMeta(rw http.ResponseWriter, r *http.Request) {
 		return
 	}
 
+	// Defaults to the existing.
+	classicTemplateFlow := template.ClassicParameterFlow
+	if req.ClassicParameterFlow != nil {
+		classicTemplateFlow = *req.ClassicParameterFlow
+	}
+
 	var updated database.Template
 	err = api.Database.InTx(func(tx database.Store) error {
 		if req.Name == template.Name &&
@@ -747,6 +753,7 @@ func (api *API) patchTemplateMeta(rw http.ResponseWriter, r *http.Request) {
 			req.TimeTilDormantAutoDeleteMillis == time.Duration(template.TimeTilDormantAutoDelete).Milliseconds() &&
 			req.RequireActiveVersion == template.RequireActiveVersion &&
 			(deprecationMessage == template.Deprecated) &&
+			(classicTemplateFlow == template.ClassicParameterFlow) &&
 			maxPortShareLevel == template.MaxPortSharingLevel {
 			return nil
 		}
@@ -788,6 +795,7 @@ func (api *API) patchTemplateMeta(rw http.ResponseWriter, r *http.Request) {
 			AllowUserCancelWorkspaceJobs: req.AllowUserCancelWorkspaceJobs,
 			GroupACL:                     groupACL,
 			MaxPortSharingLevel:          maxPortShareLevel,
+			ClassicParameterFlow:         classicTemplateFlow,
 		})
 		if err != nil {
 			return xerrors.Errorf("update template metadata: %w", err)

diff --git a/codersdk/templates.go b/codersdk/templates.go
@@ -250,6 +250,12 @@ type UpdateTemplateMeta struct {
 	// of the template.
 	DisableEveryoneGroupAccess bool                          `json:"disable_everyone_group_access"`
 	MaxPortShareLevel          *WorkspaceAgentPortShareLevel `json:"max_port_share_level,omitempty"`
+	// ClassicParameterFlow is a flag that switches the default behavior to use the classic
+	// parameter flow when creating a workspace. This only affects deployments with the experiment
+	// "dynamic-parameters" enabled. This setting will live for a period after the experiment is
+	// made the default.
+	// An "opt-out" is present in case the new feature breaks some existing templates.
+	ClassicParameterFlow *bool `json:"dynamic_parameter_flow,omitempty"`
 }
 
 type TemplateExample struct {

diff --git a/enterprise/audit/table.go b/enterprise/audit/table.go
@@ -115,6 +115,7 @@ var auditableResourcesTypes = map[any]map[string]Action{
 		"deprecated":                        ActionTrack,
 		"max_port_sharing_level":            ActionTrack,
 		"activity_bump":                     ActionTrack,
+		"classic_parameter_flow":            ActionTrack,
 	},
 	&database.TemplateVersion{}: {
 		"id":                      ActionTrack,
Original file line number	Diff line number	Diff line change
		@@ -1 +1 @@
		ALTER TABLE templates DROP COLUMN dynamic_parameter_flow;
		ALTER TABLE templates DROP COLUMN classic_parameter_flow;