Jul 10, 2023 · Jul 7, 2023 · Jul 7, 2023 · Jul 7, 2023 · Jul 7, 2023 · Jul 7, 2023
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/db2sdk/db2sdk.go b/coderd/database/db2sdk/db2sdk.go
 ValidationError:      param.ValidationError,
 ValidationMonotonic:  codersdk.ValidationMonotonicOrder(param.ValidationMonotonic),
 Required:             param.Required,
 Ephemeral:            param.Ephemeral,
 }, nil
 }

diff --git a/coderd/database/dbfake/dbfake.go b/coderd/database/dbfake/dbfake.go
 ValidationMonotonic: arg.ValidationMonotonic,
 Required:            arg.Required,
 DisplayOrder:        arg.DisplayOrder,
 Ephemeral:           arg.Ephemeral,
 }
 q.templateVersionParameters = append(q.templateVersionParameters, param)
 return param, nil
diff --git a/coderd/database/dump.sql b/coderd/database/dump.sql
diff --git a/coderd/database/migrations/000136_ephemeral_parameters.down.sql b/coderd/database/migrations/000136_ephemeral_parameters.down.sql
 ALTER TABLE template_version_parameters DROP COLUMN ephemeral;
diff --git a/coderd/database/migrations/000136_ephemeral_parameters.up.sql b/coderd/database/migrations/000136_ephemeral_parameters.up.sql
 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.';
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/templateversionparameters.sql b/coderd/database/queries/templateversionparameters.sql
        validation_monotonic,
        required,
        display_name,
        display_order
        display_order,
        ephemeral
    )
 VALUES
    (
        $13,
        $14,
        $15,
        $16
        $16,
        $17
    ) RETURNING *;

 -- name: GetTemplateVersionParameters :many
diff --git a/coderd/provisionerdserver/provisionerdserver.go b/coderd/provisionerdserver/provisionerdserver.go
 server.Logger.Info(ctx, "inserting template import job parameter",
 slog.F("job_id", job.ID.String()),
 slog.F("parameter_name", richParameter.Name),
 slog.F("type", richParameter.Type),
 slog.F("ephemeral", richParameter.Ephemeral),
 )
 options, err := json.Marshal(richParameter.Options)
 if err != nil {
 ValidationMonotonic: richParameter.ValidationMonotonic,
 Required:            richParameter.Required,
 DisplayOrder:        richParameter.Order,
 Ephemeral:           richParameter.Ephemeral,
 })
 if err != nil {
 return nil, xerrors.Errorf("insert parameter: %w", err)
diff --git a/coderd/templateversions.go b/coderd/templateversions.go
 ValidationError:      param.ValidationError,
 ValidationMonotonic:  codersdk.ValidationMonotonicOrder(param.ValidationMonotonic),
 Required:             param.Required,
 Ephemeral:            param.Ephemeral,
 }, nil
 }

diff --git a/coderd/workspaces_test.go b/coderd/workspaces_test.go
 require.ElementsMatch(t, expectedBuildParameters, workspaceBuildParameters)
 }

 func TestWorkspaceWithEphemeralRichParameters(t *testing.T) {
 t.Parallel()

 const (
 firstParameterName         = "first_parameter"
 firstParameterType         = "string"
 firstParameterDescription  = "This is first parameter"
 firstParameterMutable      = true
 firstParameterDefaultValue = "1"
 firstParameterValue        = "i_am_first_parameter"

 ephemeralParameterName         = "second_parameter"
 ephemeralParameterType         = "string"
 ephemeralParameterDescription  = "This is second parameter"
 ephemeralParameterDefaultValue = ""
 ephemeralParameterMutable      = true
 ephemeralParameterValue        = "i_am_ephemeral"
 )

 // Create template version with ephemeral parameter
 client := coderdtest.New(t, &coderdtest.Options{IncludeProvisionerDaemon: true})
 user := coderdtest.CreateFirstUser(t, client)
 version := coderdtest.CreateTemplateVersion(t, client, user.OrganizationID, &echo.Responses{
 Parse: echo.ParseComplete,
 ProvisionPlan: []*proto.Provision_Response{
 {
 Type: &proto.Provision_Response_Complete{
 Complete: &proto.Provision_Complete{
 Parameters: []*proto.RichParameter{
 {
 Name:         firstParameterName,
 Type:         firstParameterType,
 Description:  firstParameterDescription,
 DefaultValue: firstParameterDefaultValue,
 Mutable:      firstParameterMutable,
 },
 {
 Name:         ephemeralParameterName,
 Type:         ephemeralParameterType,
 Description:  ephemeralParameterDescription,
 DefaultValue: ephemeralParameterDefaultValue,
 Mutable:      ephemeralParameterMutable,
 Ephemeral:    true,
 },
 },
 },
 },
 },
 },
 ProvisionApply: []*proto.Provision_Response{{
 Type: &proto.Provision_Response_Complete{
 Complete: &proto.Provision_Complete{},
 },
 }},
 })
 coderdtest.AwaitTemplateVersionJob(t, client, version.ID)
 template := coderdtest.CreateTemplate(t, client, user.OrganizationID, version.ID)

 // Create workspace with default values
 workspace := coderdtest.CreateWorkspace(t, client, user.OrganizationID, template.ID)
 workspaceBuild := coderdtest.AwaitWorkspaceBuildJob(t, client, workspace.LatestBuild.ID)
 require.Equal(t, codersdk.WorkspaceStatusRunning, workspaceBuild.Status)

 // Verify workspace build parameters (default values)
 ctx, cancel := context.WithTimeout(context.Background(), testutil.WaitLong)
 defer cancel()

 workspaceBuildParameters, err := client.WorkspaceBuildParameters(ctx, workspaceBuild.ID)
 require.NoError(t, err)

 expectedBuildParameters := []codersdk.WorkspaceBuildParameter{
 {Name: firstParameterName, Value: firstParameterDefaultValue},
 {Name: ephemeralParameterName, Value: ephemeralParameterDefaultValue},
 }
 require.ElementsMatch(t, expectedBuildParameters, workspaceBuildParameters)

 // Trigger workspace build job with ephemeral parameter
 workspaceBuild, err = client.CreateWorkspaceBuild(ctx, workspaceBuild.WorkspaceID, codersdk.CreateWorkspaceBuildRequest{
 Transition: codersdk.WorkspaceTransitionStart,
 RichParameterValues: []codersdk.WorkspaceBuildParameter{
 {
 Name:  ephemeralParameterName,
 Value: ephemeralParameterValue,
 },
 },
 })
 require.NoError(t, err)
 workspaceBuild = coderdtest.AwaitWorkspaceBuildJob(t, client, workspaceBuild.ID)
 require.Equal(t, codersdk.WorkspaceStatusRunning, workspaceBuild.Status)

 // Verify workspace build parameters (including ephemeral)
 workspaceBuildParameters, err = client.WorkspaceBuildParameters(ctx, workspaceBuild.ID)
 require.NoError(t, err)

 expectedBuildParameters = []codersdk.WorkspaceBuildParameter{
 {Name: firstParameterName, Value: firstParameterDefaultValue},
 {Name: ephemeralParameterName, Value: ephemeralParameterValue},
 }
 require.ElementsMatch(t, expectedBuildParameters, workspaceBuildParameters)

 // Trigger workspace build one more time without the ephemeral parameter
 workspaceBuild, err = client.CreateWorkspaceBuild(ctx, workspaceBuild.WorkspaceID, codersdk.CreateWorkspaceBuildRequest{
 Transition: codersdk.WorkspaceTransitionStart,
 RichParameterValues: []codersdk.WorkspaceBuildParameter{
 {
 Name:  firstParameterName,
 Value: firstParameterValue,
 },
 },
 })
 require.NoError(t, err)
 workspaceBuild = coderdtest.AwaitWorkspaceBuildJob(t, client, workspaceBuild.ID)
 require.Equal(t, codersdk.WorkspaceStatusRunning, workspaceBuild.Status)

 // Verify workspace build parameters (ephemeral should be back to default)
 workspaceBuildParameters, err = client.WorkspaceBuildParameters(ctx, workspaceBuild.ID)
 require.NoError(t, err)

 expectedBuildParameters = []codersdk.WorkspaceBuildParameter{
 {Name: firstParameterName, Value: firstParameterValue},
 {Name: ephemeralParameterName, Value: ephemeralParameterDefaultValue},
 }
 require.ElementsMatch(t, expectedBuildParameters, workspaceBuildParameters)
 }

 func TestWorkspaceLock(t *testing.T) {
 t.Parallel()

diff --git a/codersdk/richparameters.go b/codersdk/richparameters.go
 }
 // First, the provided value
 resolvedValue := v
 // Second, previous value
 if resolvedValue == nil {
 // Second, previous value if not ephemeral
 if resolvedValue == nil&& !p.Ephemeral{
 resolvedValue = prevV
 }
 // Last, default value
Original file line number	Diff line number	Diff line change
Expand Up		@@ -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
		}

Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -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
Expand Down
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		ALTER TABLE template_version_parameters DROP COLUMN ephemeral;
Original file line number	Diff line number	Diff line change
		@@ -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.';
Original file line number	Diff line number	Diff line change
Expand Up		@@ -16,7 +16,8 @@ INSERT INTO
		validation_monotonic,
		required,
		display_name,
		display_order
		display_order,
		ephemeral
		)
		VALUES
		(
Expand All		@@ -35,7 +36,8 @@ VALUES
		$13,
		$14,
		$15,
		$16
		$16,
		$17
		) RETURNING *;

		-- name: GetTemplateVersionParameters :many
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -789,6 +789,8 @@ func (server Server) CompleteJob(ctx context.Context, completed proto.Complete
		server.Logger.Info(ctx, "inserting template import job parameter",
		slog.F("job_id", job.ID.String()),
		slog.F("parameter_name", richParameter.Name),
		slog.F("type", richParameter.Type),
		slog.F("ephemeral", richParameter.Ephemeral),
		)
		options, err := json.Marshal(richParameter.Options)
		if err != nil {
Expand DownExpand Up		@@ -826,6 +828,7 @@ func (server Server) CompleteJob(ctx context.Context, completed proto.Complete
		ValidationMonotonic: richParameter.ValidationMonotonic,
		Required: richParameter.Required,
		DisplayOrder: richParameter.Order,
		Ephemeral: richParameter.Ephemeral,
		})
		if err != nil {
		return nil, xerrors.Errorf("insert parameter: %w", err)
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -1484,6 +1484,7 @@ func convertTemplateVersionParameter(param database.TemplateVersionParameter) (c
		ValidationError: param.ValidationError,
		ValidationMonotonic: codersdk.ValidationMonotonicOrder(param.ValidationMonotonic),
		Required: param.Required,
		Ephemeral: param.Ephemeral,
		}, nil
		}

Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -2518,6 +2518,131 @@ func TestWorkspaceWithOptionalRichParameters(t *testing.T) {
		require.ElementsMatch(t, expectedBuildParameters, workspaceBuildParameters)
		}

		func TestWorkspaceWithEphemeralRichParameters(t *testing.T) {
		t.Parallel()

		const (
		firstParameterName = "first_parameter"
		firstParameterType = "string"
		firstParameterDescription = "This is first parameter"
		firstParameterMutable = true
		firstParameterDefaultValue = "1"
		firstParameterValue = "i_am_first_parameter"

		ephemeralParameterName = "second_parameter"
		ephemeralParameterType = "string"
		ephemeralParameterDescription = "This is second parameter"
		ephemeralParameterDefaultValue = ""
		ephemeralParameterMutable = true
		ephemeralParameterValue = "i_am_ephemeral"
		)

		// Create template version with ephemeral parameter
		client := coderdtest.New(t, &coderdtest.Options{IncludeProvisionerDaemon: true})
		user := coderdtest.CreateFirstUser(t, client)
		version := coderdtest.CreateTemplateVersion(t, client, user.OrganizationID, &echo.Responses{
		Parse: echo.ParseComplete,
		ProvisionPlan: []*proto.Provision_Response{
		{
		Type: &proto.Provision_Response_Complete{
		Complete: &proto.Provision_Complete{
		Parameters: []*proto.RichParameter{
		{
		Name: firstParameterName,
		Type: firstParameterType,
		Description: firstParameterDescription,
		DefaultValue: firstParameterDefaultValue,
		Mutable: firstParameterMutable,
		},
		{
		Name: ephemeralParameterName,
		Type: ephemeralParameterType,
		Description: ephemeralParameterDescription,
		DefaultValue: ephemeralParameterDefaultValue,
		Mutable: ephemeralParameterMutable,
		Ephemeral: true,
		},
		},
		},
		},
		},
		},
		ProvisionApply: []*proto.Provision_Response{{
		Type: &proto.Provision_Response_Complete{
		Complete: &proto.Provision_Complete{},
		},
		}},
		})
		coderdtest.AwaitTemplateVersionJob(t, client, version.ID)
		template := coderdtest.CreateTemplate(t, client, user.OrganizationID, version.ID)

		// Create workspace with default values
		workspace := coderdtest.CreateWorkspace(t, client, user.OrganizationID, template.ID)
		workspaceBuild := coderdtest.AwaitWorkspaceBuildJob(t, client, workspace.LatestBuild.ID)
		require.Equal(t, codersdk.WorkspaceStatusRunning, workspaceBuild.Status)

		// Verify workspace build parameters (default values)
		ctx, cancel := context.WithTimeout(context.Background(), testutil.WaitLong)
		defer cancel()

		workspaceBuildParameters, err := client.WorkspaceBuildParameters(ctx, workspaceBuild.ID)
		require.NoError(t, err)

		expectedBuildParameters := []codersdk.WorkspaceBuildParameter{
		{Name: firstParameterName, Value: firstParameterDefaultValue},
		{Name: ephemeralParameterName, Value: ephemeralParameterDefaultValue},
		}
		require.ElementsMatch(t, expectedBuildParameters, workspaceBuildParameters)

		// Trigger workspace build job with ephemeral parameter
		workspaceBuild, err = client.CreateWorkspaceBuild(ctx, workspaceBuild.WorkspaceID, codersdk.CreateWorkspaceBuildRequest{
		Transition: codersdk.WorkspaceTransitionStart,
		RichParameterValues: []codersdk.WorkspaceBuildParameter{
		{
		Name: ephemeralParameterName,
		Value: ephemeralParameterValue,
		},
		},
		})
		require.NoError(t, err)
		workspaceBuild = coderdtest.AwaitWorkspaceBuildJob(t, client, workspaceBuild.ID)
		require.Equal(t, codersdk.WorkspaceStatusRunning, workspaceBuild.Status)

		// Verify workspace build parameters (including ephemeral)
		workspaceBuildParameters, err = client.WorkspaceBuildParameters(ctx, workspaceBuild.ID)
		require.NoError(t, err)

		expectedBuildParameters = []codersdk.WorkspaceBuildParameter{
		{Name: firstParameterName, Value: firstParameterDefaultValue},
		{Name: ephemeralParameterName, Value: ephemeralParameterValue},
		}
		require.ElementsMatch(t, expectedBuildParameters, workspaceBuildParameters)

		// Trigger workspace build one more time without the ephemeral parameter
		workspaceBuild, err = client.CreateWorkspaceBuild(ctx, workspaceBuild.WorkspaceID, codersdk.CreateWorkspaceBuildRequest{
		Transition: codersdk.WorkspaceTransitionStart,
		RichParameterValues: []codersdk.WorkspaceBuildParameter{
		{
		Name: firstParameterName,
		Value: firstParameterValue,
		},
		},
		})
		require.NoError(t, err)
		workspaceBuild = coderdtest.AwaitWorkspaceBuildJob(t, client, workspaceBuild.ID)
		require.Equal(t, codersdk.WorkspaceStatusRunning, workspaceBuild.Status)

		// Verify workspace build parameters (ephemeral should be back to default)
		workspaceBuildParameters, err = client.WorkspaceBuildParameters(ctx, workspaceBuild.ID)
		require.NoError(t, err)

		expectedBuildParameters = []codersdk.WorkspaceBuildParameter{
		{Name: firstParameterName, Value: firstParameterValue},
		{Name: ephemeralParameterName, Value: ephemeralParameterDefaultValue},
		}
		require.ElementsMatch(t, expectedBuildParameters, workspaceBuildParameters)
		}

		func TestWorkspaceLock(t *testing.T) {
		t.Parallel()

Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -148,8 +148,8 @@ func (r ParameterResolver) ValidateResolve(p TemplateVersionParameter, v Works
		}
		// First, the provided value
		resolvedValue := v
		// Second, previous value
		if resolvedValue == nil {
		// Second, previous value if not ephemeral
		if resolvedValue == nil&& !p.Ephemeral{
		resolvedValue = prevV
		}
		// Last, default value
Expand Down