refactor: Rename ProjectParameter to ProjectVersionParameter

This was confusing with ParameterValue before. It still is a bit, but this should help distinguish scope.
coder · kylecarbs · Feb 8, 2022 · Feb 6, 2022 · Feb 7, 2022 · Feb 7, 2022
commit 4345922d31a8a09276554c6c8d8e2321991e3a36
diff --git a/coderd/projectparameter/projectparameter.go b/coderd/projectparameter/projectparameter.go
@@ -40,11 +40,11 @@ func Compute(ctx context.Context, db database.Store, scope Scope) ([]Value, erro
 	compute := &compute{
 		db:                             db,
 		computedParameterByName:        map[string]Value{},
-		projectVersionParametersByName: map[string]database.ProjectParameter{},
+		projectVersionParametersByName: map[string]database.ProjectVersionParameter{},
 	}
 
 	// All parameters for the project version!
-	projectVersionParameters, err := db.GetProjectParametersByVersionID(ctx, scope.ProjectVersionID)
+	projectVersionParameters, err := db.GetProjectVersionParametersByVersionID(ctx, scope.ProjectVersionID)
 	if errors.Is(err, sql.ErrNoRows) {
 		// This occurs when the project version has defined
 		// no parameters, so we have nothing to compute!
@@ -144,7 +144,7 @@ func Compute(ctx context.Context, db database.Store, scope Scope) ([]Value, erro
 type compute struct {
 	db                             database.Store
 	computedParameterByName        map[string]Value
-	projectVersionParametersByName map[string]database.ProjectParameter
+	projectVersionParametersByName map[string]database.ProjectVersionParameter
 }
 
 // Validates and computes the value for parameters; setting the value on "parameterByName".

diff --git a/coderd/projectparameter/projectparameter_test.go b/coderd/projectparameter/projectparameter_test.go
@@ -31,7 +31,7 @@ func TestCompute(t *testing.T) {
 		DefaultDestinationScheme database.ParameterDestinationScheme
 		ProjectVersionID         uuid.UUID
 	}
-	generateProjectParameter := func(t *testing.T, db database.Store, opts projectParameterOptions) database.ProjectParameter {
+	generateProjectParameter := func(t *testing.T, db database.Store, opts projectParameterOptions) database.ProjectVersionParameter {
 		if opts.DefaultDestinationScheme == "" {
 			opts.DefaultDestinationScheme = database.ParameterDestinationSchemeEnvironmentVariable
 		}
@@ -41,7 +41,7 @@ func TestCompute(t *testing.T) {
 		require.NoError(t, err)
 		destinationValue, err := cryptorand.String(8)
 		require.NoError(t, err)
-		param, err := db.InsertProjectParameter(context.Background(), database.InsertProjectParameterParams{
+		param, err := db.InsertProjectVersionParameter(context.Background(), database.InsertProjectVersionParameterParams{
 			ID:                  uuid.New(),
 			Name:                name,
 			ProjectVersionID:    opts.ProjectVersionID,
@@ -66,7 +66,7 @@ func TestCompute(t *testing.T) {
 		t.Parallel()
 		db := databasefake.New()
 		scope := generateScope()
-		parameter, err := db.InsertProjectParameter(context.Background(), database.InsertProjectParameterParams{
+		parameter, err := db.InsertProjectVersionParameter(context.Background(), database.InsertProjectVersionParameterParams{
 			ID:               uuid.New(),
 			ProjectVersionID: scope.ProjectVersionID,
 			Name:             "hey",

diff --git a/coderd/projectversion.go b/coderd/projectversion.go
@@ -31,8 +31,8 @@ type ProjectVersion struct {
 	Import        ProvisionerJob                `json:"import"`
 }
 
-// ProjectParameter represents a parameter parsed from project version source on creation.
-type ProjectParameter struct {
+// ProjectVersionParameter represents a parameter parsed from project version source on creation.
+type ProjectVersionParameter struct {
 	ID                       uuid.UUID                           `json:"id"`
 	CreatedAt                time.Time                           `json:"created_at"`
 	ProjectVersionID         uuid.UUID                           `json:"project_version_id"`
@@ -62,7 +62,7 @@ type CreateProjectVersionRequest struct {
 func (api *api) projectVersionsByOrganization(rw http.ResponseWriter, r *http.Request) {
 	project := httpmw.ProjectParam(r)
 
-	version, err := api.Database.GetProjectVersionByProjectID(r.Context(), project.ID)
+	version, err := api.Database.GetProjectVersionsByProjectID(r.Context(), project.ID)
 	if errors.Is(err, sql.ErrNoRows) {
 		err = nil
 	}
@@ -196,10 +196,10 @@ func (api *api) projectVersionParametersByOrganizationAndName(rw http.ResponseWr
 		return
 	}
 
-	parameters, err := api.Database.GetProjectParametersByVersionID(r.Context(), projectVersion.ID)
+	parameters, err := api.Database.GetProjectVersionParametersByVersionID(r.Context(), projectVersion.ID)
 	if errors.Is(err, sql.ErrNoRows) {
 		err = nil
-		parameters = []database.ProjectParameter{}
+		parameters = []database.ProjectVersionParameter{}
 	}
 	if err != nil {
 		httpapi.Write(rw, http.StatusInternalServerError, httpapi.Response{
@@ -208,7 +208,7 @@ func (api *api) projectVersionParametersByOrganizationAndName(rw http.ResponseWr
 		return
 	}
 
-	apiParameters := make([]ProjectParameter, 0, len(parameters))
+	apiParameters := make([]ProjectVersionParameter, 0, len(parameters))
 	for _, parameter := range parameters {
 		apiParameters = append(apiParameters, convertProjectParameter(parameter))
 	}
@@ -229,8 +229,8 @@ func convertProjectVersion(version database.ProjectVersion, job database.Provisi
 	}
 }
 
-func convertProjectParameter(parameter database.ProjectParameter) ProjectParameter {
-	return ProjectParameter{
+func convertProjectParameter(parameter database.ProjectVersionParameter) ProjectVersionParameter {
+	return ProjectVersionParameter{
 		ID:                       parameter.ID,
 		CreatedAt:                parameter.CreatedAt,
 		ProjectVersionID:         parameter.ProjectVersionID,

diff --git a/coderd/provisionerdaemons.go b/coderd/provisionerdaemons.go
@@ -422,14 +422,14 @@ func (server *provisionerdServer) CompleteJob(ctx context.Context, completed *pr
 
 		// Validate that all parameters send from the provisioner daemon
 		// follow the protocol.
-		projectParameters := make([]database.InsertProjectParameterParams, 0, len(jobType.ProjectImport.ParameterSchemas))
+		projectVersionParameters := make([]database.InsertProjectVersionParameterParams, 0, len(jobType.ProjectImport.ParameterSchemas))
 		for _, protoParameter := range jobType.ProjectImport.ParameterSchemas {
 			validationTypeSystem, err := convertValidationTypeSystem(protoParameter.ValidationTypeSystem)
 			if err != nil {
 				return nil, xerrors.Errorf("convert validation type system for %q: %w", protoParameter.Name, err)
 			}
 
-			projectParameter := database.InsertProjectParameterParams{
+			projectParameter := database.InsertProjectVersionParameterParams{
 				ID:                   uuid.New(),
 				CreatedAt:            database.Now(),
 				ProjectVersionID:     input.ProjectVersionID,
@@ -474,7 +474,7 @@ func (server *provisionerdServer) CompleteJob(ctx context.Context, completed *pr
 				}
 			}
 
-			projectParameters = append(projectParameters, projectParameter)
+			projectVersionParameters = append(projectVersionParameters, projectParameter)
 		}
 
 		// This must occur in a transaction in case of failure.
@@ -492,8 +492,8 @@ func (server *provisionerdServer) CompleteJob(ctx context.Context, completed *pr
 			}
 			// This could be a bulk-insert operation to improve performance.
 			// See the "InsertWorkspaceHistoryLogs" query.
-			for _, projectParameter := range projectParameters {
-				_, err = db.InsertProjectParameter(ctx, projectParameter)
+			for _, projectParameter := range projectVersionParameters {
+				_, err = db.InsertProjectVersionParameter(ctx, projectParameter)
 				if err != nil {
 					return xerrors.Errorf("insert project parameter %q: %w", projectParameter.Name, err)
 				}

diff --git a/codersdk/projects.go b/codersdk/projects.go
@@ -100,7 +100,7 @@ func (c *Client) CreateProjectVersion(ctx context.Context, organization, project
 }
 
 // ProjectVersionParameters returns project parameters for a version by name.
-func (c *Client) ProjectVersionParameters(ctx context.Context, organization, project, version string) ([]coderd.ProjectParameter, error) {
+func (c *Client) ProjectVersionParameters(ctx context.Context, organization, project, version string) ([]coderd.ProjectVersionParameter, error) {
 	res, err := c.request(ctx, http.MethodGet, fmt.Sprintf("/api/v2/projects/%s/%s/versions/%s/parameters", organization, project, version), nil)
 	if err != nil {
 		return nil, err
@@ -109,7 +109,7 @@ func (c *Client) ProjectVersionParameters(ctx context.Context, organization, pro
 	if res.StatusCode != http.StatusOK {
 		return nil, readBodyAsError(res)
 	}
-	var params []coderd.ProjectParameter
+	var params []coderd.ProjectVersionParameter
 	return params, json.NewDecoder(res.Body).Decode(&params)
 }
 

diff --git a/database/databasefake/databasefake.go b/database/databasefake/databasefake.go
@@ -19,18 +19,18 @@ func New() database.Store {
 		organizationMembers: make([]database.OrganizationMember, 0),
 		users:               make([]database.User, 0),
 
-		parameterValue:      make([]database.ParameterValue, 0),
-		project:             make([]database.Project, 0),
-		projectVersion:      make([]database.ProjectVersion, 0),
-		projectVersionLog:   make([]database.ProjectVersionLog, 0),
-		projectParameter:    make([]database.ProjectParameter, 0),
-		provisionerDaemons:  make([]database.ProvisionerDaemon, 0),
-		provisionerJobs:     make([]database.ProvisionerJob, 0),
-		workspace:           make([]database.Workspace, 0),
-		workspaceResource:   make([]database.WorkspaceResource, 0),
-		workspaceHistory:    make([]database.WorkspaceHistory, 0),
-		workspaceHistoryLog: make([]database.WorkspaceHistoryLog, 0),
-		workspaceAgent:      make([]database.WorkspaceAgent, 0),
+		parameterValue:          make([]database.ParameterValue, 0),
+		project:                 make([]database.Project, 0),
+		projectVersion:          make([]database.ProjectVersion, 0),
+		projectVersionLog:       make([]database.ProjectVersionLog, 0),
+		projectVersionParameter: make([]database.ProjectVersionParameter, 0),
+		provisionerDaemons:      make([]database.ProvisionerDaemon, 0),
+		provisionerJobs:         make([]database.ProvisionerJob, 0),
+		workspace:               make([]database.Workspace, 0),
+		workspaceResource:       make([]database.WorkspaceResource, 0),
+		workspaceHistory:        make([]database.WorkspaceHistory, 0),
+		workspaceHistoryLog:     make([]database.WorkspaceHistoryLog, 0),
+		workspaceAgent:          make([]database.WorkspaceAgent, 0),
 	}
 }
 
@@ -45,18 +45,18 @@ type fakeQuerier struct {
 	users               []database.User
 
 	// New tables
-	parameterValue      []database.ParameterValue
-	project             []database.Project
-	projectVersion      []database.ProjectVersion
-	projectVersionLog   []database.ProjectVersionLog
-	projectParameter    []database.ProjectParameter
-	provisionerDaemons  []database.ProvisionerDaemon
-	provisionerJobs     []database.ProvisionerJob
-	workspace           []database.Workspace
-	workspaceAgent      []database.WorkspaceAgent
-	workspaceHistory    []database.WorkspaceHistory
-	workspaceHistoryLog []database.WorkspaceHistoryLog
-	workspaceResource   []database.WorkspaceResource
+	parameterValue          []database.ParameterValue
+	project                 []database.Project
+	projectVersion          []database.ProjectVersion
+	projectVersionLog       []database.ProjectVersionLog
+	projectVersionParameter []database.ProjectVersionParameter
+	provisionerDaemons      []database.ProvisionerDaemon
+	provisionerJobs         []database.ProvisionerJob
+	workspace               []database.Workspace
+	workspaceAgent          []database.WorkspaceAgent
+	workspaceHistory        []database.WorkspaceHistory
+	workspaceHistoryLog     []database.WorkspaceHistoryLog
+	workspaceResource       []database.WorkspaceResource
 }
 
 // InTx doesn't rollback data properly for in-memory yet.
@@ -410,7 +410,7 @@ func (q *fakeQuerier) GetProjectByOrganizationAndName(_ context.Context, arg dat
 	return database.Project{}, sql.ErrNoRows
 }
 
-func (q *fakeQuerier) GetProjectVersionByProjectID(_ context.Context, projectID uuid.UUID) ([]database.ProjectVersion, error) {
+func (q *fakeQuerier) GetProjectVersionsByProjectID(_ context.Context, projectID uuid.UUID) ([]database.ProjectVersion, error) {
 	q.mutex.Lock()
 	defer q.mutex.Unlock()
 
@@ -479,12 +479,12 @@ func (q *fakeQuerier) GetProjectVersionByID(_ context.Context, projectVersionID
 	return database.ProjectVersion{}, sql.ErrNoRows
 }
 
-func (q *fakeQuerier) GetProjectParametersByVersionID(_ context.Context, projectVersionID uuid.UUID) ([]database.ProjectParameter, error) {
+func (q *fakeQuerier) GetProjectVersionParametersByVersionID(_ context.Context, projectVersionID uuid.UUID) ([]database.ProjectVersionParameter, error) {
 	q.mutex.Lock()
 	defer q.mutex.Unlock()
 
-	parameters := make([]database.ProjectParameter, 0)
-	for _, projectParameter := range q.projectParameter {
+	parameters := make([]database.ProjectVersionParameter, 0)
+	for _, projectParameter := range q.projectVersionParameter {
 		if projectParameter.ProjectVersionID.String() != projectVersionID.String() {
 			continue
 		}
@@ -699,12 +699,12 @@ func (q *fakeQuerier) InsertProjectVersionLogs(_ context.Context, arg database.I
 	return logs, nil
 }
 
-func (q *fakeQuerier) InsertProjectParameter(_ context.Context, arg database.InsertProjectParameterParams) (database.ProjectParameter, error) {
+func (q *fakeQuerier) InsertProjectVersionParameter(_ context.Context, arg database.InsertProjectVersionParameterParams) (database.ProjectVersionParameter, error) {
 	q.mutex.Lock()
 	defer q.mutex.Unlock()
 
 	//nolint:gosimple
-	param := database.ProjectParameter{
+	param := database.ProjectVersionParameter{
 		ID:                       arg.ID,
 		CreatedAt:                arg.CreatedAt,
 		ProjectVersionID:         arg.ProjectVersionID,
@@ -723,7 +723,7 @@ func (q *fakeQuerier) InsertProjectParameter(_ context.Context, arg database.Ins
 		ValidationTypeSystem:     arg.ValidationTypeSystem,
 		ValidationValueType:      arg.ValidationValueType,
 	}
-	q.projectParameter = append(q.projectParameter, param)
+	q.projectVersionParameter = append(q.projectVersionParameter, param)
 	return param, nil
 }
 

diff --git a/database/dump.sql b/database/dump.sql
diff --git a/database/migrations/000002_projects.up.sql b/database/migrations/000002_projects.up.sql
@@ -63,7 +63,7 @@ CREATE TYPE parameter_destination_scheme AS ENUM('none', 'environment_variable',
 -- Parameter types, description, and validation will produce
 -- a UI for users to enter values.
 -- Needs to be made consistent with the examples below.
-CREATE TABLE project_parameter (
+CREATE TABLE project_version_parameter (
     id uuid NOT NULL UNIQUE,
     created_at timestamptz NOT NULL,
     project_version_id uuid NOT NULL REFERENCES project_version(id) ON DELETE CASCADE,