coder · mtojek · Mar 14, 2023 · Mar 10, 2023 · Mar 10, 2023 · Mar 10, 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/dbfake/databasefake.go b/coderd/database/dbfake/databasefake.go
@@ -2826,6 +2826,7 @@ func (q *fakeQuerier) InsertTemplateVersionParameter(_ context.Context, arg data
 		ValidationMax:       arg.ValidationMax,
 		ValidationMonotonic: arg.ValidationMonotonic,
 		Required:            arg.Required,
+		LegacyVariableName:  arg.LegacyVariableName,
 	}
 	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/000109_rich_parameter_legacy_variable.down.sql b/coderd/database/migrations/000109_rich_parameter_legacy_variable.down.sql
@@ -0,0 +1 @@
+ALTER TABLE template_version_parameters DROP COLUMN legacy_variable_name;
diff --git a/coderd/database/migrations/000109_rich_parameter_legacy_variable.up.sql b/coderd/database/migrations/000109_rich_parameter_legacy_variable.up.sql
@@ -0,0 +1,3 @@
+ALTER TABLE template_version_parameters ADD COLUMN legacy_variable_name text NOT NULL DEFAULT '';
+
+COMMENT ON COLUMN template_version_parameters.legacy_variable_name IS 'Name of the legacy variable for migration purposes';
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
@@ -14,7 +14,8 @@ INSERT INTO
         validation_max,
         validation_error,
         validation_monotonic,
-        required
+        required,
+        legacy_variable_name
     )
 VALUES
     (
@@ -31,7 +32,8 @@ VALUES
         $11,
         $12,
         $13,
-        $14
+        $14,
+        $15
     ) RETURNING *;
 
 -- name: GetTemplateVersionParameters :many

diff --git a/coderd/provisionerdserver/provisionerdserver.go b/coderd/provisionerdserver/provisionerdserver.go
@@ -835,6 +835,7 @@ func (server *Server) CompleteJob(ctx context.Context, completed *proto.Complete
 				ValidationMax:       richParameter.ValidationMax,
 				ValidationMonotonic: richParameter.ValidationMonotonic,
 				Required:            richParameter.Required,
+				LegacyVariableName:  richParameter.LegacyVariableName,
 			})
 			if err != nil {
 				return nil, xerrors.Errorf("insert parameter: %w", err)

diff --git a/coderd/templateversions.go b/coderd/templateversions.go
@@ -1622,6 +1622,7 @@ func convertTemplateVersionParameter(param database.TemplateVersionParameter) (c
 		ValidationError:      param.ValidationError,
 		ValidationMonotonic:  codersdk.ValidationMonotonicOrder(param.ValidationMonotonic),
 		Required:             param.Required,
+		LegacyVariableName:   param.LegacyVariableName,
 	}, nil
 }
 

diff --git a/coderd/workspacebuilds.go b/coderd/workspacebuilds.go
@@ -496,6 +496,39 @@ func (api *API) postWorkspaceBuilds(rw http.ResponseWriter, r *http.Request) {
 	}
 	apiLastBuildParameters := convertWorkspaceBuildParameters(lastBuildParameters)
 
+	legacyParameters, err := api.Database.ParameterValues(ctx, database.ParameterValuesParams{
+		Scopes:   []database.ParameterScope{database.ParameterScopeWorkspace},
+		ScopeIds: []uuid.UUID{workspace.ID},
+	})
+	if err != nil && !xerrors.Is(err, sql.ErrNoRows) {
+		httpapi.Write(ctx, rw, http.StatusInternalServerError, codersdk.Response{
+			Message: "Error fetching previous legacy parameters.",
+			Detail:  err.Error(),
+		})
+		return
+	}
+
+	// Rich parameters migration: include legacy variables to the last build parameters
+	for _, templateVersionParameter := range templateVersionParameters {
+		// Check if parameter is defined in previous build
+		if _, found := findWorkspaceBuildParameter(apiLastBuildParameters, templateVersionParameter.Name); found {
+			continue
+		}
+
+		// Check if legacy variable is defined
+		for _, legacyParameter := range legacyParameters {
+			if legacyParameter.Name != templateVersionParameter.LegacyVariableName {
+				continue
+			}
+
+			apiLastBuildParameters = append(apiLastBuildParameters, codersdk.WorkspaceBuildParameter{
+				Name:  templateVersionParameter.Name,
+				Value: legacyParameter.SourceValue,
+			})
+			break
+		}
+	}
+
 	err = codersdk.ValidateWorkspaceBuildParameters(templateVersionParameters, createBuild.RichParameterValues, apiLastBuildParameters)
 	if err != nil {
 		httpapi.Write(ctx, rw, http.StatusBadRequest, codersdk.Response{
@@ -525,26 +558,6 @@ func (api *API) postWorkspaceBuilds(rw http.ResponseWriter, r *http.Request) {
 		}
 	}
 
-	legacyParameters, err := api.Database.ParameterValues(ctx, database.ParameterValuesParams{
-		Scopes:   []database.ParameterScope{database.ParameterScopeWorkspace},
-		ScopeIds: []uuid.UUID{workspace.ID},
-	})
-	if err != nil && !xerrors.Is(err, sql.ErrNoRows) {
-		httpapi.Write(ctx, rw, http.StatusInternalServerError, codersdk.Response{
-			Message: "Error fetching previous legacy parameters.",
-			Detail:  err.Error(),
-		})
-		return
-	}
-
-	if createBuild.Transition == codersdk.WorkspaceTransitionStart &&
-		len(legacyParameters) > 0 && len(parameters) > 0 {
-		httpapi.Write(ctx, rw, http.StatusBadRequest, codersdk.Response{
-			Message: "Rich parameters can't be used together with legacy parameters.",
-		})
-		return
-	}
-
 	var workspaceBuild database.WorkspaceBuild
 	var provisionerJob database.ProvisionerJob
 	// This must happen in a transaction to ensure history can be inserted, and

diff --git a/coderd/workspacebuilds_test.go b/coderd/workspacebuilds_test.go
@@ -971,3 +971,170 @@ func TestWorkspaceBuildValidateRichParameters(t *testing.T) {
 		}
 	})
 }
+
+func TestMigrateLegacyToRichParameters(t *testing.T) {
+	t.Parallel()
+
+	client := coderdtest.New(t, &coderdtest.Options{IncludeProvisionerDaemon: true})
+	user := coderdtest.CreateFirstUser(t, client)
+
+	ctx, cancel := context.WithTimeout(context.Background(), testutil.WaitLong)
+	defer cancel()
+
+	// 1. Prepare a template with legacy parameters.
+	templateVersion := coderdtest.CreateTemplateVersion(t, client, user.OrganizationID, &echo.Responses{
+		Parse: []*proto.Parse_Response{{
+			Type: &proto.Parse_Response_Complete{
+				Complete: &proto.Parse_Complete{
+					ParameterSchemas: []*proto.ParameterSchema{
+						{
+							AllowOverrideSource: true,
+							Name:                "example",
+							Description:         "description 1",
+							DefaultSource: &proto.ParameterSource{
+								Scheme: proto.ParameterSource_DATA,
+								Value:  "tomato",
+							},
+							DefaultDestination: &proto.ParameterDestination{
+								Scheme: proto.ParameterDestination_PROVISIONER_VARIABLE,
+							},
+						},
+					},
+				},
+			},
+		}},
+		ProvisionApply: echo.ProvisionComplete,
+		ProvisionPlan:  echo.ProvisionComplete,
+	})
+	coderdtest.AwaitTemplateVersionJob(t, client, templateVersion.ID)
+	template := coderdtest.CreateTemplate(t, client, user.OrganizationID, templateVersion.ID)
+
+	// Create a workspace
+	workspace := coderdtest.CreateWorkspace(t, client, user.OrganizationID, template.ID, func(cwr *codersdk.CreateWorkspaceRequest) {
+		cwr.ParameterValues = []codersdk.CreateParameterRequest{
+			{
+				Name:              "example",
+				SourceValue:       "carrot",
+				SourceScheme:      codersdk.ParameterSourceSchemeData,
+				DestinationScheme: codersdk.ParameterDestinationSchemeEnvironmentVariable,
+			},
+		}
+	})
+	workspaceBuild := coderdtest.AwaitWorkspaceBuildJob(t, client, workspace.LatestBuild.ID)
+	require.Equal(t, codersdk.WorkspaceStatusRunning, workspaceBuild.Status)
+
+	// 2. Upload the template with legacy and rich parameters.
+	templateWithParameters := &echo.Responses{
+		Parse: []*proto.Parse_Response{{
+			Type: &proto.Parse_Response_Complete{
+				Complete: &proto.Parse_Complete{
+					ParameterSchemas: []*proto.ParameterSchema{
+						{
+							AllowOverrideSource: true,
+							Name:                "example",
+							Description:         "description 1",
+							DefaultSource: &proto.ParameterSource{
+								Scheme: proto.ParameterSource_DATA,
+								Value:  "tomato",
+							},
+							DefaultDestination: &proto.ParameterDestination{
+								Scheme: proto.ParameterDestination_PROVISIONER_VARIABLE,
+							},
+						},
+					},
+				},
+			},
+		}},
+		ProvisionPlan: []*proto.Provision_Response{
+			{
+				Type: &proto.Provision_Response_Complete{
+					Complete: &proto.Provision_Complete{
+						Parameters: []*proto.RichParameter{
+							{
+								Name:               "new_example",
+								Type:               "string",
+								Mutable:            true,
+								Required:           true,
+								LegacyVariableName: "example",
+							},
+						},
+					},
+				},
+			},
+		},
+		ProvisionApply: echo.ProvisionComplete,
+	}
+	templateVersion = coderdtest.UpdateTemplateVersion(t, client, user.OrganizationID, templateWithParameters, template.ID)
+	coderdtest.AwaitTemplateVersionJob(t, client, templateVersion.ID)
+
+	// Check if rich parameters are expected
+	richParameters, err := client.TemplateVersionRichParameters(ctx, templateVersion.ID)
+	require.NoError(t, err)
+	require.Len(t, richParameters, 1)
+	require.Equal(t, "new_example", richParameters[0].Name)
+
+	// Update workspace to use rich parameters and template variables
+	workspaceBuild, err = client.CreateWorkspaceBuild(ctx, workspace.ID, codersdk.CreateWorkspaceBuildRequest{
+		TemplateVersionID: templateVersion.ID,
+		Transition:        codersdk.WorkspaceTransitionStart,
+	})
+	require.NoError(t, err)
+	require.Eventually(t, func() bool {
+		workspaceBuild = coderdtest.AwaitWorkspaceBuildJob(t, client, workspaceBuild.ID)
+		return codersdk.WorkspaceStatusRunning == workspaceBuild.Status
+	}, testutil.WaitLong, testutil.IntervalFast)
+
+	// Check if variable value has been imported
+	buildParameters, err := client.WorkspaceBuildParameters(ctx, workspaceBuild.ID)
+	require.NoError(t, err)
+	require.Len(t, buildParameters, 1)
+	require.Equal(t, "carrot", buildParameters[0].Value)
+
+	// 3. Upload the template with rich parameters only
+	templateWithParameters = &echo.Responses{
+		Parse: echo.ParseComplete,
+		ProvisionPlan: []*proto.Provision_Response{
+			{
+				Type: &proto.Provision_Response_Complete{
+					Complete: &proto.Provision_Complete{
+						Parameters: []*proto.RichParameter{
+							{
+								Name:               "new_example",
+								Type:               "string",
+								Mutable:            true,
+								Required:           true,
+								LegacyVariableName: "example",
+							},
+						},
+					},
+				},
+			},
+		},
+		ProvisionApply: echo.ProvisionComplete,
+	}
+	templateVersion = coderdtest.UpdateTemplateVersion(t, client, user.OrganizationID, templateWithParameters, template.ID)
+	coderdtest.AwaitTemplateVersionJob(t, client, templateVersion.ID)
+
+	// Check if rich parameters are expected
+	richParameters, err = client.TemplateVersionRichParameters(ctx, templateVersion.ID)
+	require.NoError(t, err)
+	require.Len(t, richParameters, 1)
+	require.Equal(t, "new_example", richParameters[0].Name)
+
+	// Update workspace to use rich parameters and template variables
+	workspaceBuild, err = client.CreateWorkspaceBuild(ctx, workspace.ID, codersdk.CreateWorkspaceBuildRequest{
+		TemplateVersionID: templateVersion.ID,
+		Transition:        codersdk.WorkspaceTransitionStart,
+	})
+	require.NoError(t, err)
+	require.Eventually(t, func() bool {
+		workspaceBuild = coderdtest.AwaitWorkspaceBuildJob(t, client, workspaceBuild.ID)
+		return codersdk.WorkspaceStatusRunning == workspaceBuild.Status
+	}, testutil.WaitLong, testutil.IntervalFast)
+
+	// Check if build parameters have been pulled from last build
+	buildParameters, err = client.WorkspaceBuildParameters(ctx, workspaceBuild.ID)
+	require.NoError(t, err)
+	require.Len(t, buildParameters, 1)
+	require.Equal(t, "carrot", buildParameters[0].Value)
+}
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		ALTER TABLE template_version_parameters DROP COLUMN legacy_variable_name;
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		ALTER TABLE template_version_parameters ADD COLUMN legacy_variable_name text NOT NULL DEFAULT '';

		COMMENT ON COLUMN template_version_parameters.legacy_variable_name IS 'Name of the legacy variable for migration purposes';