feat: Allow inheriting parameters from previous template_versions when updating a template (#2397)

* WIP: feat: Update templates also updates parameters * Insert params for template version update * Working implementation of inherited params * Add "--always-prompt" flag and logging info
2026-09-22 05:05:20 +08:00 · 2022-06-17 12:22:28 -05:00
parent 18973a65c1
commit 64b92eea67
16 changed files with 547 additions and 167 deletions
@@ -12,6 +12,7 @@ import (
 	"golang.org/x/exp/slices"

 	"github.com/coder/coder/coderd/database"
+	"github.com/coder/coder/coderd/util/slice"
 )

 // New returns an in-memory fake of the database.
@@ -103,6 +104,19 @@ func (q *fakeQuerier) AcquireProvisionerJob(_ context.Context, arg database.Acqu
 	return database.ProvisionerJob{}, sql.ErrNoRows
 }

+func (q *fakeQuerier) ParameterValue(_ context.Context, id uuid.UUID) (database.ParameterValue, error) {
+	q.mutex.Lock()
+	defer q.mutex.Unlock()
+
+	for _, parameterValue := range q.parameterValues {
+		if parameterValue.ID.String() != id.String() {
+			continue
+		}
+		return parameterValue, nil
+	}
+	return database.ParameterValue{}, sql.ErrNoRows
+}
+
 func (q *fakeQuerier) DeleteParameterValueByID(_ context.Context, id uuid.UUID) error {
 	q.mutex.Lock()
 	defer q.mutex.Unlock()
@@ -744,17 +758,27 @@ func (q *fakeQuerier) GetOrganizationsByUserID(_ context.Context, userID uuid.UU
 	return organizations, nil
 }

-func (q *fakeQuerier) GetParameterValuesByScope(_ context.Context, arg database.GetParameterValuesByScopeParams) ([]database.ParameterValue, error) {
+func (q *fakeQuerier) ParameterValues(_ context.Context, arg database.ParameterValuesParams) ([]database.ParameterValue, error) {
 	q.mutex.RLock()
 	defer q.mutex.RUnlock()

 	parameterValues := make([]database.ParameterValue, 0)
 	for _, parameterValue := range q.parameterValues {
-		if parameterValue.Scope != arg.Scope {
-			continue
+		if len(arg.Scopes) > 0 {
+			if !slice.Contains(arg.Scopes, parameterValue.Scope) {
+				continue
+			}
 		}
-		if parameterValue.ScopeID != arg.ScopeID {
-			continue
+		if len(arg.ScopeIds) > 0 {
+			if !slice.Contains(arg.ScopeIds, parameterValue.ScopeID) {
+				continue
+			}
+		}
+
+		if len(arg.Ids) > 0 {
+			if !slice.Contains(arg.Ids, parameterValue.ID) {
+				continue
+			}
 		}
 		parameterValues = append(parameterValues, parameterValue)
 	}
@@ -45,7 +45,6 @@ type querier interface {
 	GetParameterSchemasByJobID(ctx context.Context, jobID uuid.UUID) ([]ParameterSchema, error)
 	GetParameterSchemasCreatedAfter(ctx context.Context, createdAt time.Time) ([]ParameterSchema, error)
 	GetParameterValueByScopeAndName(ctx context.Context, arg GetParameterValueByScopeAndNameParams) (ParameterValue, error)
-	GetParameterValuesByScope(ctx context.Context, arg GetParameterValuesByScopeParams) ([]ParameterValue, error)
 	GetProvisionerDaemonByID(ctx context.Context, id uuid.UUID) (ProvisionerDaemon, error)
 	GetProvisionerDaemons(ctx context.Context) ([]ProvisionerDaemon, error)
 	GetProvisionerJobByID(ctx context.Context, id uuid.UUID) (ProvisionerJob, error)
@@ -109,6 +108,8 @@ type querier interface {
 	InsertWorkspaceApp(ctx context.Context, arg InsertWorkspaceAppParams) (WorkspaceApp, error)
 	InsertWorkspaceBuild(ctx context.Context, arg InsertWorkspaceBuildParams) (WorkspaceBuild, error)
 	InsertWorkspaceResource(ctx context.Context, arg InsertWorkspaceResourceParams) (WorkspaceResource, error)
+	ParameterValue(ctx context.Context, id uuid.UUID) (ParameterValue, error)
+	ParameterValues(ctx context.Context, arg ParameterValuesParams) ([]ParameterValue, error)
 	UpdateAPIKeyByID(ctx context.Context, arg UpdateAPIKeyByIDParams) error
 	UpdateGitSSHKey(ctx context.Context, arg UpdateGitSSHKeyParams) error
 	UpdateMemberRoles(ctx context.Context, arg UpdateMemberRolesParams) (OrganizationMember, error)
@@ -1079,54 +1079,6 @@ func (q *sqlQuerier) GetParameterValueByScopeAndName(ctx context.Context, arg Ge
 	return i, err
 }

-const getParameterValuesByScope = `-- name: GetParameterValuesByScope :many
-SELECT
-	id, created_at, updated_at, scope, scope_id, name, source_scheme, source_value, destination_scheme
-FROM
-	parameter_values
-WHERE
-	scope = $1
-	AND scope_id = $2
-`
-
-type GetParameterValuesByScopeParams struct {
-	Scope   ParameterScope `db:"scope" json:"scope"`
-	ScopeID uuid.UUID      `db:"scope_id" json:"scope_id"`
-}
-
-func (q *sqlQuerier) GetParameterValuesByScope(ctx context.Context, arg GetParameterValuesByScopeParams) ([]ParameterValue, error) {
-	rows, err := q.db.QueryContext(ctx, getParameterValuesByScope, arg.Scope, arg.ScopeID)
-	if err != nil {
-		return nil, err
-	}
-	defer rows.Close()
-	var items []ParameterValue
-	for rows.Next() {
-		var i ParameterValue
-		if err := rows.Scan(
-			&i.ID,
-			&i.CreatedAt,
-			&i.UpdatedAt,
-			&i.Scope,
-			&i.ScopeID,
-			&i.Name,
-			&i.SourceScheme,
-			&i.SourceValue,
-			&i.DestinationScheme,
-		); err != nil {
-			return nil, err
-		}
-		items = append(items, i)
-	}
-	if err := rows.Close(); err != nil {
-		return nil, err
-	}
-	if err := rows.Err(); err != nil {
-		return nil, err
-	}
-	return items, nil
-}
-
 const insertParameterValue = `-- name: InsertParameterValue :one
 INSERT INTO
 	parameter_values (
@@ -1183,6 +1135,103 @@ func (q *sqlQuerier) InsertParameterValue(ctx context.Context, arg InsertParamet
 	return i, err
 }

+const parameterValue = `-- name: ParameterValue :one
+SELECT id, created_at, updated_at, scope, scope_id, name, source_scheme, source_value, destination_scheme FROM
+	parameter_values
+WHERE
+	id = $1
+`
+
+func (q *sqlQuerier) ParameterValue(ctx context.Context, id uuid.UUID) (ParameterValue, error) {
+	row := q.db.QueryRowContext(ctx, parameterValue, id)
+	var i ParameterValue
+	err := row.Scan(
+		&i.ID,
+		&i.CreatedAt,
+		&i.UpdatedAt,
+		&i.Scope,
+		&i.ScopeID,
+		&i.Name,
+		&i.SourceScheme,
+		&i.SourceValue,
+		&i.DestinationScheme,
+	)
+	return i, err
+}
+
+const parameterValues = `-- name: ParameterValues :many
+SELECT
+	id, created_at, updated_at, scope, scope_id, name, source_scheme, source_value, destination_scheme
+FROM
+	parameter_values
+WHERE
+  	CASE
+		  WHEN cardinality($1 :: parameter_scope[]) > 0 THEN
+				  scope = ANY($1 :: parameter_scope[])
+		  ELSE true
+	END
+    AND CASE
+		WHEN cardinality($2 :: uuid[]) > 0 THEN
+			scope_id = ANY($2 :: uuid[])
+		ELSE true
+	END
+  	AND CASE
+		WHEN cardinality($3 :: uuid[]) > 0 THEN
+			id = ANY($3 :: uuid[])
+		ELSE true
+	END
+  	AND CASE
+		  WHEN cardinality($4 :: text[]) > 0 THEN
+				  "name" = ANY($4 :: text[])
+		  ELSE true
+	END
+`
+
+type ParameterValuesParams struct {
+	Scopes   []ParameterScope `db:"scopes" json:"scopes"`
+	ScopeIds []uuid.UUID      `db:"scope_ids" json:"scope_ids"`
+	Ids      []uuid.UUID      `db:"ids" json:"ids"`
+	Names    []string         `db:"names" json:"names"`
+}
+
+func (q *sqlQuerier) ParameterValues(ctx context.Context, arg ParameterValuesParams) ([]ParameterValue, error) {
+	rows, err := q.db.QueryContext(ctx, parameterValues,
+		pq.Array(arg.Scopes),
+		pq.Array(arg.ScopeIds),
+		pq.Array(arg.Ids),
+		pq.Array(arg.Names),
+	)
+	if err != nil {
+		return nil, err
+	}
+	defer rows.Close()
+	var items []ParameterValue
+	for rows.Next() {
+		var i ParameterValue
+		if err := rows.Scan(
+			&i.ID,
+			&i.CreatedAt,
+			&i.UpdatedAt,
+			&i.Scope,
+			&i.ScopeID,
+			&i.Name,
+			&i.SourceScheme,
+			&i.SourceValue,
+			&i.DestinationScheme,
+		); err != nil {
+			return nil, err
+		}
+		items = append(items, i)
+	}
+	if err := rows.Close(); err != nil {
+		return nil, err
+	}
+	if err := rows.Err(); err != nil {
+		return nil, err
+	}
+	return items, nil
+}
+
 const getProvisionerDaemonByID = `-- name: GetProvisionerDaemonByID :one
 SELECT
 	id, created_at, updated_at, name, provisioners
@@ -1,17 +1,43 @@
+-- name: ParameterValue :one
+SELECT * FROM
+	parameter_values
+WHERE
+	id = $1;
+
+
 -- name: DeleteParameterValueByID :exec
 DELETE FROM
 	parameter_values
 WHERE
 	id = $1;

-- name: GetParameterValuesByScope :many
+-- name: ParameterValues :many
 SELECT
 	*
 FROM
 	parameter_values
 WHERE
-	scope = $1
-	AND scope_id = $2;
+  	CASE
+		  WHEN cardinality(@scopes :: parameter_scope[]) > 0 THEN
+				  scope = ANY(@scopes :: parameter_scope[])
+		  ELSE true
+	END
+    AND CASE
+		WHEN cardinality(@scope_ids :: uuid[]) > 0 THEN
+			scope_id = ANY(@scope_ids :: uuid[])
+		ELSE true
+	END
+  	AND CASE
+		WHEN cardinality(@ids :: uuid[]) > 0 THEN
+			id = ANY(@ids :: uuid[])
+		ELSE true
+	END
+  	AND CASE
+		  WHEN cardinality(@names :: text[]) > 0 THEN
+				  "name" = ANY(@names :: text[])
+		  ELSE true
+	END
+;

 -- name: GetParameterValueByScopeAndName :one
 SELECT