feat(coderd): support ephemeral parameters (#8367)

coderd/database/db2sdk/db2sdk.go

@@ -75,6 +75,7 @@ func TemplateVersionParameter(param database.TemplateVersionParameter) (codersdk
 		ValidationError:      param.ValidationError,
 		ValidationMonotonic:  codersdk.ValidationMonotonicOrder(param.ValidationMonotonic),
 		Required:             param.Required,
+		Ephemeral:            param.Ephemeral,
 	}, nil
 }
 

coderd/database/dbfake/dbfake.go

@@ -3966,6 +3966,7 @@ func (q *fakeQuerier) InsertTemplateVersionParameter(_ context.Context, arg data
 		ValidationMonotonic: arg.ValidationMonotonic,
 		Required:            arg.Required,
 		DisplayOrder:        arg.DisplayOrder,
+		Ephemeral:           arg.Ephemeral,
 	}
 	q.templateVersionParameters = append(q.templateVersionParameters, param)
 	return param, nil

coderd/database/dump.sql

@@ -465,6 +465,7 @@ CREATE TABLE template_version_parameters (
     required boolean DEFAULT true NOT NULL,
     display_name text DEFAULT ''::text NOT NULL,
     display_order integer DEFAULT 0 NOT NULL,
+    ephemeral boolean DEFAULT false NOT NULL,
     CONSTRAINT validation_monotonic_order CHECK ((validation_monotonic = ANY (ARRAY['increasing'::text, 'decreasing'::text, ''::text])))
 );
 
@@ -498,6 +499,8 @@ COMMENT ON COLUMN template_version_parameters.display_name IS 'Display name of t
 
 COMMENT ON COLUMN template_version_parameters.display_order IS 'Specifies the order in which to display parameters in user interfaces.';
 
+COMMENT ON COLUMN template_version_parameters.ephemeral IS 'The value of an ephemeral parameter will not be preserved between consecutive workspace builds.';
+
 CREATE TABLE template_version_variables (
     template_version_id uuid NOT NULL,
     name text NOT NULL,

coderd/database/migrations/000136_ephemeral_parameters.down.sql

@@ -0,0 +1 @@
+ALTER TABLE template_version_parameters DROP COLUMN ephemeral;

coderd/database/migrations/000136_ephemeral_parameters.up.sql

@@ -0,0 +1,4 @@
+ALTER TABLE template_version_parameters ADD COLUMN ephemeral boolean NOT NULL DEFAULT false;
+
+COMMENT ON COLUMN template_version_parameters.ephemeral
+IS 'The value of an ephemeral parameter will not be preserved between consecutive workspace builds.';

coderd/database/models.go

@@ -1643,6 +1643,8 @@ type TemplateVersionParameter struct {
 	DisplayName string `db:"display_name" json:"display_name"`
 	// Specifies the order in which to display parameters in user interfaces.
 	DisplayOrder int32 `db:"display_order" json:"display_order"`
+	// The value of an ephemeral parameter will not be preserved between consecutive workspace builds.
+	Ephemeral bool `db:"ephemeral" json:"ephemeral"`
 }
 
 type TemplateVersionVariable struct {

coderd/database/queries.sql.go

@@ -4174,7 +4174,7 @@ func (q *sqlQuerier) UpdateTemplateScheduleByID(ctx context.Context, arg UpdateT
 }
 
 const getTemplateVersionParameters = `-- name: GetTemplateVersionParameters :many
-SELECT template_version_id, name, description, type, mutable, default_value, icon, options, validation_regex, validation_min, validation_max, validation_error, validation_monotonic, required, display_name, display_order FROM template_version_parameters WHERE template_version_id = $1 ORDER BY display_order ASC, LOWER(name) ASC
+SELECT template_version_id, name, description, type, mutable, default_value, icon, options, validation_regex, validation_min, validation_max, validation_error, validation_monotonic, required, display_name, display_order, ephemeral FROM template_version_parameters WHERE template_version_id = $1 ORDER BY display_order ASC, LOWER(name) ASC
 `
 
 func (q *sqlQuerier) GetTemplateVersionParameters(ctx context.Context, templateVersionID uuid.UUID) ([]TemplateVersionParameter, error) {
@@ -4203,6 +4203,7 @@ func (q *sqlQuerier) GetTemplateVersionParameters(ctx context.Context, templateV
 			&i.Required,
 			&i.DisplayName,
 			&i.DisplayOrder,
+			&i.Ephemeral,
 		); err != nil {
 			return nil, err
 		}
@@ -4235,7 +4236,8 @@ INSERT INTO
         validation_monotonic,
         required,
         display_name,
-        display_order
+        display_order,
+        ephemeral
     )
 VALUES
     (
@@ -4254,8 +4256,9 @@ VALUES
         $13,
         $14,
         $15,
-        $16
-    ) RETURNING template_version_id, name, description, type, mutable, default_value, icon, options, validation_regex, validation_min, validation_max, validation_error, validation_monotonic, required, display_name, display_order
+        $16,
+        $17
+    ) RETURNING template_version_id, name, description, type, mutable, default_value, icon, options, validation_regex, validation_min, validation_max, validation_error, validation_monotonic, required, display_name, display_order, ephemeral
 `
 
 type InsertTemplateVersionParameterParams struct {
@@ -4275,6 +4278,7 @@ type InsertTemplateVersionParameterParams struct {
 	Required            bool            `db:"required" json:"required"`
 	DisplayName         string          `db:"display_name" json:"display_name"`
 	DisplayOrder        int32           `db:"display_order" json:"display_order"`
+	Ephemeral           bool            `db:"ephemeral" json:"ephemeral"`
 }
 
 func (q *sqlQuerier) InsertTemplateVersionParameter(ctx context.Context, arg InsertTemplateVersionParameterParams) (TemplateVersionParameter, error) {
@@ -4295,6 +4299,7 @@ func (q *sqlQuerier) InsertTemplateVersionParameter(ctx context.Context, arg Ins
 		arg.Required,
 		arg.DisplayName,
 		arg.DisplayOrder,
+		arg.Ephemeral,
 	)
 	var i TemplateVersionParameter
 	err := row.Scan(
@@ -4314,6 +4319,7 @@ func (q *sqlQuerier) InsertTemplateVersionParameter(ctx context.Context, arg Ins
 		&i.Required,
 		&i.DisplayName,
 		&i.DisplayOrder,
+		&i.Ephemeral,
 	)
 	return i, err
 }

coderd/database/queries/templateversionparameters.sql

@@ -16,7 +16,8 @@ INSERT INTO
         validation_monotonic,
         required,
         display_name,
-        display_order
+        display_order,
+        ephemeral
     )
 VALUES
     (
@@ -35,7 +36,8 @@ VALUES
         $13,
         $14,
         $15,
-        $16
+        $16,
+        $17
     ) RETURNING *;
 
 -- name: GetTemplateVersionParameters :many