Add deprecated key to codersdk parameter values

coder · kylecarbs · Sep 29, 2022 · Sep 29, 2022 · Sep 29, 2022 · Sep 29, 2022
commit 120a70a3a135d2817b4591f3b2a949f7d99a7bdc
diff --git a/cli/cliui/parameter.go b/cli/cliui/parameter.go
@@ -10,7 +10,7 @@ import (
 	"github.com/coder/coder/codersdk"
 )
 
-func ParameterSchema(cmd *cobra.Command, parameterSchema codersdk.ParameterSchema) (string, error) {
+func ParameterSchema(cmd *cobra.Command, parameterSchema codersdk.DeprecatedParameterSchema) (string, error) {
 	_, _ = fmt.Fprintln(cmd.OutOrStdout(), Styles.Bold.Render("var."+parameterSchema.Name))
 	if parameterSchema.Description != "" {
 		_, _ = fmt.Fprintln(cmd.OutOrStdout(), "  "+strings.TrimSpace(strings.Join(strings.Split(parameterSchema.Description, "\n"), "\n  "))+"\n")

diff --git a/cli/create.go b/cli/create.go
@@ -123,7 +123,7 @@ func create() *cobra.Command {
 
 			parameters, err := prepWorkspaceBuild(cmd, client, prepWorkspaceBuildArgs{
 				Template:         template,
-				ExistingParams:   []codersdk.Parameter{},
+				ExistingParams:   []codersdk.DeprecatedParameter{},
 				ParameterFile:    parameterFile,
 				NewWorkspaceName: workspaceName,
 			})
@@ -171,14 +171,14 @@ func create() *cobra.Command {
 
 type prepWorkspaceBuildArgs struct {
 	Template         codersdk.Template
-	ExistingParams   []codersdk.Parameter
+	ExistingParams   []codersdk.DeprecatedParameter
 	ParameterFile    string
 	NewWorkspaceName string
 }
 
 // prepWorkspaceBuild will ensure a workspace build will succeed on the latest template version.
 // Any missing params will be prompted to the user.
-func prepWorkspaceBuild(cmd *cobra.Command, client *codersdk.Client, args prepWorkspaceBuildArgs) ([]codersdk.CreateParameterRequest, error) {
+func prepWorkspaceBuild(cmd *cobra.Command, client *codersdk.Client, args prepWorkspaceBuildArgs) ([]codersdk.DeprecatedCreateParameterRequest, error) {
 	ctx := cmd.Context()
 	templateVersion, err := client.TemplateVersion(ctx, args.Template.ActiveVersionID)
 	if err != nil {
@@ -201,7 +201,7 @@ func prepWorkspaceBuild(cmd *cobra.Command, client *codersdk.Client, args prepWo
 		}
 	}
 	disclaimerPrinted := false
-	parameters := make([]codersdk.CreateParameterRequest, 0)
+	parameters := make([]codersdk.DeprecatedCreateParameterRequest, 0)
 PromptParamLoop:
 	for _, parameterSchema := range parameterSchemas {
 		if !parameterSchema.AllowOverrideSource {
@@ -228,10 +228,10 @@ PromptParamLoop:
 			return nil, err
 		}
 
-		parameters = append(parameters, codersdk.CreateParameterRequest{
+		parameters = append(parameters, codersdk.DeprecatedCreateParameterRequest{
 			Name:              parameterSchema.Name,
 			SourceValue:       parameterValue,
-			SourceScheme:      codersdk.ParameterSourceSchemeData,
+			SourceScheme:      codersdk.DeprecatedParameterSourceSchemeData,
 			DestinationScheme: parameterSchema.DefaultDestinationScheme,
 		})
 	}

diff --git a/cli/parameter.go b/cli/parameter.go
@@ -38,7 +38,7 @@ func createParameterMapFromFile(parameterFile string) (map[string]string, error)
 
 // Returns a parameter value from a given map, if the map exists, else takes input from the user.
 // Throws an error if the map exists but does not include a value for the parameter.
-func getParameterValueFromMapOrInput(cmd *cobra.Command, parameterMap map[string]string, parameterSchema codersdk.ParameterSchema) (string, error) {
+func getParameterValueFromMapOrInput(cmd *cobra.Command, parameterMap map[string]string, parameterSchema codersdk.DeprecatedParameterSchema) (string, error) {
 	var parameterValue string
 	if parameterMap != nil {
 		var ok bool

diff --git a/cli/parameterslist.go b/cli/parameterslist.go
@@ -33,21 +33,21 @@ func parameterList() *cobra.Command {
 			}
 
 			var scopeID uuid.UUID
-			switch codersdk.ParameterScope(scope) {
-			case codersdk.ParameterWorkspace:
+			switch codersdk.DeprecatedParameterScope(scope) {
+			case codersdk.DeprecatedParameterWorkspace:
 				workspace, err := namedWorkspace(cmd, client, name)
 				if err != nil {
 					return err
 				}
 				scopeID = workspace.ID
-			case codersdk.ParameterTemplate:
+			case codersdk.DeprecatedParameterTemplate:
 				template, err := client.TemplateByName(cmd.Context(), organization.ID, name)
 				if err != nil {
 					return xerrors.Errorf("get workspace template: %w", err)
 				}
 				scopeID = template.ID
-			case codersdk.ParameterImportJob, "template_version":
-				scope = string(codersdk.ParameterImportJob)
+			case codersdk.DeprecatedParameterImportJob, "template_version":
+				scope = string(codersdk.DeprecatedParameterImportJob)
 				scopeID, err = uuid.Parse(name)
 				if err != nil {
 					return xerrors.Errorf("%q must be a uuid for this scope type", name)
@@ -61,12 +61,12 @@ func parameterList() *cobra.Command {
 				}
 
 			default:
-				return xerrors.Errorf("%q is an unsupported scope, use %v", scope, []codersdk.ParameterScope{
-					codersdk.ParameterWorkspace, codersdk.ParameterTemplate, codersdk.ParameterImportJob,
+				return xerrors.Errorf("%q is an unsupported scope, use %v", scope, []codersdk.DeprecatedParameterScope{
+					codersdk.DeprecatedParameterWorkspace, codersdk.DeprecatedParameterTemplate, codersdk.DeprecatedParameterImportJob,
 				})
 			}
 
-			params, err := client.DeprecatedParameters(cmd.Context(), codersdk.ParameterScope(scope), scopeID)
+			params, err := client.DeprecatedParameters(cmd.Context(), codersdk.DeprecatedParameterScope(scope), scopeID)
 			if err != nil {
 				return xerrors.Errorf("fetch params: %w", err)
 			}

diff --git a/cli/templatecreate.go b/cli/templatecreate.go
@@ -158,7 +158,7 @@ type createValidTemplateVersionArgs struct {
 	ReuseParameters bool
 }
 
-func createValidTemplateVersion(cmd *cobra.Command, args createValidTemplateVersionArgs, parameters ...codersdk.CreateParameterRequest) (*codersdk.TemplateVersion, []codersdk.CreateParameterRequest, error) {
+func createValidTemplateVersion(cmd *cobra.Command, args createValidTemplateVersionArgs, parameters ...codersdk.DeprecatedCreateParameterRequest) (*codersdk.TemplateVersion, []codersdk.DeprecatedCreateParameterRequest, error) {
 	before := time.Now()
 	client := args.Client
 
@@ -210,15 +210,15 @@ func createValidTemplateVersion(cmd *cobra.Command, args createValidTemplateVers
 	// lastParameterValues are pulled from the current active template version if
 	// templateID is provided. This allows pulling params from the last
 	// version instead of prompting if we are updating template versions.
-	lastParameterValues := make(map[string]codersdk.Parameter)
+	lastParameterValues := make(map[string]codersdk.DeprecatedParameter)
 	if args.ReuseParameters && args.Template != nil {
 		activeVersion, err := client.TemplateVersion(cmd.Context(), args.Template.ActiveVersionID)
 		if err != nil {
 			return nil, nil, xerrors.Errorf("Fetch current active template version: %w", err)
 		}
 
 		// We don't want to compute the params, we only want to copy from this scope
-		values, err := client.DeprecatedParameters(cmd.Context(), codersdk.ParameterImportJob, activeVersion.Job.ID)
+		values, err := client.DeprecatedParameters(cmd.Context(), codersdk.DeprecatedParameterImportJob, activeVersion.Job.ID)
 		if err != nil {
 			return nil, nil, xerrors.Errorf("Fetch previous version parameters: %w", err)
 		}
@@ -228,7 +228,7 @@ func createValidTemplateVersion(cmd *cobra.Command, args createValidTemplateVers
 	}
 
 	if provisionerd.IsMissingParameterError(version.Job.Error) {
-		valuesBySchemaID := map[string]codersdk.ComputedParameter{}
+		valuesBySchemaID := map[string]codersdk.DeprecatedComputedParameter{}
 		for _, parameterValue := range parameterValues {
 			valuesBySchemaID[parameterValue.SchemaID.String()] = parameterValue
 		}
@@ -245,7 +245,7 @@ func createValidTemplateVersion(cmd *cobra.Command, args createValidTemplateVers
 
 		// pulled params come from the last template version
 		pulled := make([]string, 0)
-		missingSchemas := make([]codersdk.ParameterSchema, 0)
+		missingSchemas := make([]codersdk.DeprecatedParameterSchema, 0)
 		for _, parameterSchema := range parameterSchemas {
 			_, ok := valuesBySchemaID[parameterSchema.ID.String()]
 			if ok {
@@ -258,7 +258,7 @@ func createValidTemplateVersion(cmd *cobra.Command, args createValidTemplateVers
 			if inherit, ok := lastParameterValues[parameterSchema.Name]; ok && !fileOk {
 				// If the value is not in the param file, and can be pulled from the last template version,
 				// then don't mark it as missing.
-				parameters = append(parameters, codersdk.CreateParameterRequest{
+				parameters = append(parameters, codersdk.DeprecatedCreateParameterRequest{
 					CloneID: inherit.ID,
 				})
 				pulled = append(pulled, fmt.Sprintf("%q", parameterSchema.Name))
@@ -279,10 +279,10 @@ func createValidTemplateVersion(cmd *cobra.Command, args createValidTemplateVers
 			if err != nil {
 				return nil, nil, err
 			}
-			parameters = append(parameters, codersdk.CreateParameterRequest{
+			parameters = append(parameters, codersdk.DeprecatedCreateParameterRequest{
 				Name:              parameterSchema.Name,
 				SourceValue:       parameterValue,
-				SourceScheme:      codersdk.ParameterSourceSchemeData,
+				SourceScheme:      codersdk.DeprecatedParameterSourceSchemeData,
 				DestinationScheme: parameterSchema.DefaultDestinationScheme,
 			})
 			_, _ = fmt.Fprintln(cmd.OutOrStdout())

diff --git a/cli/templatepush_test.go b/cli/templatepush_test.go
@@ -210,15 +210,15 @@ func TestTemplatePush(t *testing.T) {
 	})
 }
 
-func latestTemplateVersion(t *testing.T, client *codersdk.Client, templateID uuid.UUID) (codersdk.TemplateVersion, []codersdk.Parameter) {
+func latestTemplateVersion(t *testing.T, client *codersdk.Client, templateID uuid.UUID) (codersdk.TemplateVersion, []codersdk.DeprecatedParameter) {
 	t.Helper()
 
 	ctx := context.Background()
 	newTemplate, err := client.Template(ctx, templateID)
 	require.NoError(t, err)
 	tv, err := client.TemplateVersion(ctx, newTemplate.ActiveVersionID)
 	require.NoError(t, err)
-	params, err := client.DeprecatedParameters(ctx, codersdk.ParameterImportJob, tv.Job.ID)
+	params, err := client.DeprecatedParameters(ctx, codersdk.DeprecatedParameterImportJob, tv.Job.ID)
 	require.NoError(t, err)
 
 	return tv, params

diff --git a/cli/update.go b/cli/update.go
@@ -39,9 +39,9 @@ func update() *cobra.Command {
 				return nil
 			}
 
-			var existingParams []codersdk.Parameter
+			var existingParams []codersdk.DeprecatedParameter
 			if !alwaysPrompt {
-				existingParams, err = client.DeprecatedParameters(cmd.Context(), codersdk.ParameterWorkspace, workspace.ID)
+				existingParams, err = client.DeprecatedParameters(cmd.Context(), codersdk.DeprecatedParameterWorkspace, workspace.ID)
 				if err != nil {
 					return nil
 				}

diff --git a/coderd/coderdtest/authorize.go b/coderd/coderdtest/authorize.go
@@ -298,7 +298,7 @@ type AuthTester struct {
 	WorkspaceResource     codersdk.WorkspaceResource
 	File                  codersdk.UploadResponse
 	TemplateVersionDryRun codersdk.ProvisionerJob
-	TemplateParam         codersdk.Parameter
+	TemplateParam         codersdk.DeprecatedParameter
 	URLParams             map[string]string
 }
 
@@ -354,15 +354,15 @@ func NewAuthTester(ctx context.Context, t *testing.T, client *codersdk.Client, a
 	workspaceResources, err := client.WorkspaceResourcesByBuild(ctx, workspace.LatestBuild.ID)
 	require.NoError(t, err, "workspace resources")
 	templateVersionDryRun, err := client.CreateTemplateVersionDryRun(ctx, version.ID, codersdk.CreateTemplateVersionDryRunRequest{
-		ParameterValues: []codersdk.CreateParameterRequest{},
+		ParameterValues: []codersdk.DeprecatedCreateParameterRequest{},
 	})
 	require.NoError(t, err, "template version dry-run")
 
-	templateParam, err := client.DeprecatedCreateParameter(ctx, codersdk.ParameterTemplate, template.ID, codersdk.CreateParameterRequest{
+	templateParam, err := client.DeprecatedCreateParameter(ctx, codersdk.DeprecatedParameterTemplate, template.ID, codersdk.DeprecatedCreateParameterRequest{
 		Name:              "test-param",
 		SourceValue:       "hello world",
-		SourceScheme:      codersdk.ParameterSourceSchemeData,
-		DestinationScheme: codersdk.ParameterDestinationSchemeProvisionerVariable,
+		SourceScheme:      codersdk.DeprecatedParameterSourceSchemeData,
+		DestinationScheme: codersdk.DeprecatedParameterDestinationSchemeProvisionerVariable,
 	})
 	require.NoError(t, err, "create template param")
 	urlParameters := map[string]string{

diff --git a/coderd/parameters.go b/coderd/parameters.go
@@ -33,7 +33,7 @@ func (api *API) deprecatedPostParameter(rw http.ResponseWriter, r *http.Request)
 		return
 	}
 
-	var createRequest codersdk.CreateParameterRequest
+	var createRequest codersdk.DeprecatedCreateParameterRequest
 	if !httpapi.Read(ctx, rw, r, &createRequest) {
 		return
 	}
@@ -108,7 +108,7 @@ func (api *API) deprecatedParameters(rw http.ResponseWriter, r *http.Request) {
 		})
 		return
 	}
-	apiParameterValues := make([]codersdk.Parameter, 0, len(parameterValues))
+	apiParameterValues := make([]codersdk.DeprecatedParameter, 0, len(parameterValues))
 	for _, parameterValue := range parameterValues {
 		apiParameterValues = append(apiParameterValues, convertParameterValue(parameterValue))
 	}
@@ -162,26 +162,26 @@ func (api *API) deprecatedDeleteParameter(rw http.ResponseWriter, r *http.Reques
 	})
 }
 
-func convertParameterSchema(parameterSchema database.ParameterSchema) (codersdk.ParameterSchema, error) {
+func convertParameterSchema(parameterSchema database.ParameterSchema) (codersdk.DeprecatedParameterSchema, error) {
 	contains := []string{}
 	if parameterSchema.ValidationCondition != "" {
 		var err error
 		contains, _, err = parameter.Contains(parameterSchema.ValidationCondition)
 		if err != nil {
-			return codersdk.ParameterSchema{}, xerrors.Errorf("parse validation condition for %q: %w", parameterSchema.Name, err)
+			return codersdk.DeprecatedParameterSchema{}, xerrors.Errorf("parse validation condition for %q: %w", parameterSchema.Name, err)
 		}
 	}
 
-	return codersdk.ParameterSchema{
+	return codersdk.DeprecatedParameterSchema{
 		ID:                       parameterSchema.ID,
 		CreatedAt:                parameterSchema.CreatedAt,
 		JobID:                    parameterSchema.JobID,
 		Name:                     parameterSchema.Name,
 		Description:              parameterSchema.Description,
-		DefaultSourceScheme:      codersdk.ParameterSourceScheme(parameterSchema.DefaultSourceScheme),
+		DefaultSourceScheme:      codersdk.DeprecatedParameterSourceScheme(parameterSchema.DefaultSourceScheme),
 		DefaultSourceValue:       parameterSchema.DefaultSourceValue,
 		AllowOverrideSource:      parameterSchema.AllowOverrideSource,
-		DefaultDestinationScheme: codersdk.ParameterDestinationScheme(parameterSchema.DefaultDestinationScheme),
+		DefaultDestinationScheme: codersdk.DeprecatedParameterDestinationScheme(parameterSchema.DefaultDestinationScheme),
 		AllowOverrideDestination: parameterSchema.AllowOverrideDestination,
 		DefaultRefresh:           parameterSchema.DefaultRefresh,
 		RedisplayValue:           parameterSchema.RedisplayValue,
@@ -193,16 +193,16 @@ func convertParameterSchema(parameterSchema database.ParameterSchema) (codersdk.
 	}, nil
 }
 
-func convertParameterValue(parameterValue database.ParameterValue) codersdk.Parameter {
-	return codersdk.Parameter{
+func convertParameterValue(parameterValue database.ParameterValue) codersdk.DeprecatedParameter {
+	return codersdk.DeprecatedParameter{
 		ID:                parameterValue.ID,
 		CreatedAt:         parameterValue.CreatedAt,
 		UpdatedAt:         parameterValue.UpdatedAt,
-		Scope:             codersdk.ParameterScope(parameterValue.Scope),
+		Scope:             codersdk.DeprecatedParameterScope(parameterValue.Scope),
 		ScopeID:           parameterValue.ScopeID,
 		Name:              parameterValue.Name,
-		SourceScheme:      codersdk.ParameterSourceScheme(parameterValue.SourceScheme),
-		DestinationScheme: codersdk.ParameterDestinationScheme(parameterValue.DestinationScheme),
+		SourceScheme:      codersdk.DeprecatedParameterSourceScheme(parameterValue.SourceScheme),
+		DestinationScheme: codersdk.DeprecatedParameterDestinationScheme(parameterValue.DestinationScheme),
 	}
 }