Skip to content

Commit 4345922

Browse files
kylecarbskylecarbs
committed
refactor: Rename ProjectParameter to ProjectVersionParameter
This was confusing with ParameterValue before. It still is a bit, but this should help distinguish scope.
1 parent 1796dc6 commit 4345922

File tree

12 files changed

+308
-308
lines changed

12 files changed

+308
-308
lines changed

‎coderd/projectparameter/projectparameter.go

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -40,11 +40,11 @@ func Compute(ctx context.Context, db database.Store, scope Scope) ([]Value, erro
4040
compute := &compute{
4141
db: db,
4242
computedParameterByName: map[string]Value{},
43-
projectVersionParametersByName: map[string]database.ProjectParameter{},
43+
projectVersionParametersByName: map[string]database.ProjectVersionParameter{},
4444
}
4545

4646
// All parameters for the project version!
47-
projectVersionParameters, err := db.GetProjectParametersByVersionID(ctx, scope.ProjectVersionID)
47+
projectVersionParameters, err := db.GetProjectVersionParametersByVersionID(ctx, scope.ProjectVersionID)
4848
if errors.Is(err, sql.ErrNoRows) {
4949
// This occurs when the project version has defined
5050
// no parameters, so we have nothing to compute!
@@ -144,7 +144,7 @@ func Compute(ctx context.Context, db database.Store, scope Scope) ([]Value, erro
144144
type compute struct {
145145
db database.Store
146146
computedParameterByName map[string]Value
147-
projectVersionParametersByName map[string]database.ProjectParameter
147+
projectVersionParametersByName map[string]database.ProjectVersionParameter
148148
}
149149

150150
// Validates and computes the value for parameters; setting the value on "parameterByName".

‎coderd/projectparameter/projectparameter_test.go

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ func TestCompute(t *testing.T) {
3131
DefaultDestinationScheme database.ParameterDestinationScheme
3232
ProjectVersionID uuid.UUID
3333
}
34-
generateProjectParameter := func(t *testing.T, db database.Store, opts projectParameterOptions) database.ProjectParameter {
34+
generateProjectParameter := func(t *testing.T, db database.Store, opts projectParameterOptions) database.ProjectVersionParameter {
3535
if opts.DefaultDestinationScheme == "" {
3636
opts.DefaultDestinationScheme = database.ParameterDestinationSchemeEnvironmentVariable
3737
}
@@ -41,7 +41,7 @@ func TestCompute(t *testing.T) {
4141
require.NoError(t, err)
4242
destinationValue, err := cryptorand.String(8)
4343
require.NoError(t, err)
44-
param, err := db.InsertProjectParameter(context.Background(), database.InsertProjectParameterParams{
44+
param, err := db.InsertProjectVersionParameter(context.Background(), database.InsertProjectVersionParameterParams{
4545
ID: uuid.New(),
4646
Name: name,
4747
ProjectVersionID: opts.ProjectVersionID,
@@ -66,7 +66,7 @@ func TestCompute(t *testing.T) {
6666
t.Parallel()
6767
db := databasefake.New()
6868
scope := generateScope()
69-
parameter, err := db.InsertProjectParameter(context.Background(), database.InsertProjectParameterParams{
69+
parameter, err := db.InsertProjectVersionParameter(context.Background(), database.InsertProjectVersionParameterParams{
7070
ID: uuid.New(),
7171
ProjectVersionID: scope.ProjectVersionID,
7272
Name: "hey",

‎coderd/projectversion.go

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -31,8 +31,8 @@ type ProjectVersion struct {
3131
Import ProvisionerJob `json:"import"`
3232
}
3333

34-
// ProjectParameter represents a parameter parsed from project version source on creation.
35-
type ProjectParameter struct {
34+
// ProjectVersionParameter represents a parameter parsed from project version source on creation.
35+
type ProjectVersionParameter struct {
3636
ID uuid.UUID `json:"id"`
3737
CreatedAt time.Time `json:"created_at"`
3838
ProjectVersionID uuid.UUID `json:"project_version_id"`
@@ -62,7 +62,7 @@ type CreateProjectVersionRequest struct {
6262
func (api *api) projectVersionsByOrganization(rw http.ResponseWriter, r *http.Request) {
6363
project := httpmw.ProjectParam(r)
6464

65-
version, err := api.Database.GetProjectVersionByProjectID(r.Context(), project.ID)
65+
version, err := api.Database.GetProjectVersionsByProjectID(r.Context(), project.ID)
6666
if errors.Is(err, sql.ErrNoRows) {
6767
err = nil
6868
}
@@ -196,10 +196,10 @@ func (api *api) projectVersionParametersByOrganizationAndName(rw http.ResponseWr
196196
return
197197
}
198198

199-
parameters, err := api.Database.GetProjectParametersByVersionID(r.Context(), projectVersion.ID)
199+
parameters, err := api.Database.GetProjectVersionParametersByVersionID(r.Context(), projectVersion.ID)
200200
if errors.Is(err, sql.ErrNoRows) {
201201
err = nil
202-
parameters = []database.ProjectParameter{}
202+
parameters = []database.ProjectVersionParameter{}
203203
}
204204
if err != nil {
205205
httpapi.Write(rw, http.StatusInternalServerError, httpapi.Response{
@@ -208,7 +208,7 @@ func (api *api) projectVersionParametersByOrganizationAndName(rw http.ResponseWr
208208
return
209209
}
210210

211-
apiParameters := make([]ProjectParameter, 0, len(parameters))
211+
apiParameters := make([]ProjectVersionParameter, 0, len(parameters))
212212
for _, parameter := range parameters {
213213
apiParameters = append(apiParameters, convertProjectParameter(parameter))
214214
}
@@ -229,8 +229,8 @@ func convertProjectVersion(version database.ProjectVersion, job database.Provisi
229229
}
230230
}
231231

232-
func convertProjectParameter(parameter database.ProjectParameter) ProjectParameter {
233-
return ProjectParameter{
232+
func convertProjectParameter(parameter database.ProjectVersionParameter) ProjectVersionParameter {
233+
return ProjectVersionParameter{
234234
ID: parameter.ID,
235235
CreatedAt: parameter.CreatedAt,
236236
ProjectVersionID: parameter.ProjectVersionID,

‎coderd/provisionerdaemons.go

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -422,14 +422,14 @@ func (server *provisionerdServer) CompleteJob(ctx context.Context, completed *pr
422422

423423
// Validate that all parameters send from the provisioner daemon
424424
// follow the protocol.
425-
projectParameters := make([]database.InsertProjectParameterParams, 0, len(jobType.ProjectImport.ParameterSchemas))
425+
projectVersionParameters := make([]database.InsertProjectVersionParameterParams, 0, len(jobType.ProjectImport.ParameterSchemas))
426426
for _, protoParameter := range jobType.ProjectImport.ParameterSchemas {
427427
validationTypeSystem, err := convertValidationTypeSystem(protoParameter.ValidationTypeSystem)
428428
if err != nil {
429429
return nil, xerrors.Errorf("convert validation type system for %q: %w", protoParameter.Name, err)
430430
}
431431

432-
projectParameter := database.InsertProjectParameterParams{
432+
projectParameter := database.InsertProjectVersionParameterParams{
433433
ID: uuid.New(),
434434
CreatedAt: database.Now(),
435435
ProjectVersionID: input.ProjectVersionID,
@@ -474,7 +474,7 @@ func (server *provisionerdServer) CompleteJob(ctx context.Context, completed *pr
474474
}
475475
}
476476

477-
projectParameters = append(projectParameters, projectParameter)
477+
projectVersionParameters = append(projectVersionParameters, projectParameter)
478478
}
479479

480480
// This must occur in a transaction in case of failure.
@@ -492,8 +492,8 @@ func (server *provisionerdServer) CompleteJob(ctx context.Context, completed *pr
492492
}
493493
// This could be a bulk-insert operation to improve performance.
494494
// See the "InsertWorkspaceHistoryLogs" query.
495-
for _, projectParameter := range projectParameters {
496-
_, err = db.InsertProjectParameter(ctx, projectParameter)
495+
for _, projectParameter := range projectVersionParameters {
496+
_, err = db.InsertProjectVersionParameter(ctx, projectParameter)
497497
if err != nil {
498498
return xerrors.Errorf("insert project parameter %q: %w", projectParameter.Name, err)
499499
}

‎codersdk/projects.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,7 @@ func (c *Client) CreateProjectVersion(ctx context.Context, organization, project
100100
}
101101

102102
// ProjectVersionParameters returns project parameters for a version by name.
103-
func (c *Client) ProjectVersionParameters(ctx context.Context, organization, project, version string) ([]coderd.ProjectParameter, error) {
103+
func (c *Client) ProjectVersionParameters(ctx context.Context, organization, project, version string) ([]coderd.ProjectVersionParameter, error) {
104104
res, err := c.request(ctx, http.MethodGet, fmt.Sprintf("/api/v2/projects/%s/%s/versions/%s/parameters", organization, project, version), nil)
105105
if err != nil {
106106
return nil, err
@@ -109,7 +109,7 @@ func (c *Client) ProjectVersionParameters(ctx context.Context, organization, pro
109109
if res.StatusCode != http.StatusOK {
110110
return nil, readBodyAsError(res)
111111
}
112-
var params []coderd.ProjectParameter
112+
var params []coderd.ProjectVersionParameter
113113
return params, json.NewDecoder(res.Body).Decode(&params)
114114
}
115115

‎database/databasefake/databasefake.go

Lines changed: 31 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -19,18 +19,18 @@ func New() database.Store {
1919
organizationMembers: make([]database.OrganizationMember, 0),
2020
users: make([]database.User, 0),
2121

22-
parameterValue: make([]database.ParameterValue, 0),
23-
project: make([]database.Project, 0),
24-
projectVersion: make([]database.ProjectVersion, 0),
25-
projectVersionLog: make([]database.ProjectVersionLog, 0),
26-
projectParameter: make([]database.ProjectParameter, 0),
27-
provisionerDaemons: make([]database.ProvisionerDaemon, 0),
28-
provisionerJobs: make([]database.ProvisionerJob, 0),
29-
workspace: make([]database.Workspace, 0),
30-
workspaceResource: make([]database.WorkspaceResource, 0),
31-
workspaceHistory: make([]database.WorkspaceHistory, 0),
32-
workspaceHistoryLog: make([]database.WorkspaceHistoryLog, 0),
33-
workspaceAgent: make([]database.WorkspaceAgent, 0),
22+
parameterValue: make([]database.ParameterValue, 0),
23+
project: make([]database.Project, 0),
24+
projectVersion: make([]database.ProjectVersion, 0),
25+
projectVersionLog: make([]database.ProjectVersionLog, 0),
26+
projectVersionParameter: make([]database.ProjectVersionParameter, 0),
27+
provisionerDaemons: make([]database.ProvisionerDaemon, 0),
28+
provisionerJobs: make([]database.ProvisionerJob, 0),
29+
workspace: make([]database.Workspace, 0),
30+
workspaceResource: make([]database.WorkspaceResource, 0),
31+
workspaceHistory: make([]database.WorkspaceHistory, 0),
32+
workspaceHistoryLog: make([]database.WorkspaceHistoryLog, 0),
33+
workspaceAgent: make([]database.WorkspaceAgent, 0),
3434
}
3535
}
3636

@@ -45,18 +45,18 @@ type fakeQuerier struct {
4545
users []database.User
4646

4747
// New tables
48-
parameterValue []database.ParameterValue
49-
project []database.Project
50-
projectVersion []database.ProjectVersion
51-
projectVersionLog []database.ProjectVersionLog
52-
projectParameter []database.ProjectParameter
53-
provisionerDaemons []database.ProvisionerDaemon
54-
provisionerJobs []database.ProvisionerJob
55-
workspace []database.Workspace
56-
workspaceAgent []database.WorkspaceAgent
57-
workspaceHistory []database.WorkspaceHistory
58-
workspaceHistoryLog []database.WorkspaceHistoryLog
59-
workspaceResource []database.WorkspaceResource
48+
parameterValue []database.ParameterValue
49+
project []database.Project
50+
projectVersion []database.ProjectVersion
51+
projectVersionLog []database.ProjectVersionLog
52+
projectVersionParameter []database.ProjectVersionParameter
53+
provisionerDaemons []database.ProvisionerDaemon
54+
provisionerJobs []database.ProvisionerJob
55+
workspace []database.Workspace
56+
workspaceAgent []database.WorkspaceAgent
57+
workspaceHistory []database.WorkspaceHistory
58+
workspaceHistoryLog []database.WorkspaceHistoryLog
59+
workspaceResource []database.WorkspaceResource
6060
}
6161

6262
// InTx doesn't rollback data properly for in-memory yet.
@@ -410,7 +410,7 @@ func (q *fakeQuerier) GetProjectByOrganizationAndName(_ context.Context, arg dat
410410
return database.Project{}, sql.ErrNoRows
411411
}
412412

413-
func (q *fakeQuerier) GetProjectVersionByProjectID(_ context.Context, projectID uuid.UUID) ([]database.ProjectVersion, error) {
413+
func (q *fakeQuerier) GetProjectVersionsByProjectID(_ context.Context, projectID uuid.UUID) ([]database.ProjectVersion, error) {
414414
q.mutex.Lock()
415415
defer q.mutex.Unlock()
416416

@@ -479,12 +479,12 @@ func (q *fakeQuerier) GetProjectVersionByID(_ context.Context, projectVersionID
479479
return database.ProjectVersion{}, sql.ErrNoRows
480480
}
481481

482-
func (q *fakeQuerier) GetProjectParametersByVersionID(_ context.Context, projectVersionID uuid.UUID) ([]database.ProjectParameter, error) {
482+
func (q *fakeQuerier) GetProjectVersionParametersByVersionID(_ context.Context, projectVersionID uuid.UUID) ([]database.ProjectVersionParameter, error) {
483483
q.mutex.Lock()
484484
defer q.mutex.Unlock()
485485

486-
parameters := make([]database.ProjectParameter, 0)
487-
for _, projectParameter := range q.projectParameter {
486+
parameters := make([]database.ProjectVersionParameter, 0)
487+
for _, projectParameter := range q.projectVersionParameter {
488488
if projectParameter.ProjectVersionID.String() != projectVersionID.String() {
489489
continue
490490
}
@@ -699,12 +699,12 @@ func (q *fakeQuerier) InsertProjectVersionLogs(_ context.Context, arg database.I
699699
return logs, nil
700700
}
701701

702-
func (q *fakeQuerier) InsertProjectParameter(_ context.Context, arg database.InsertProjectParameterParams) (database.ProjectParameter, error) {
702+
func (q *fakeQuerier) InsertProjectVersionParameter(_ context.Context, arg database.InsertProjectVersionParameterParams) (database.ProjectVersionParameter, error) {
703703
q.mutex.Lock()
704704
defer q.mutex.Unlock()
705705

706706
//nolint:gosimple
707-
param := database.ProjectParameter{
707+
param := database.ProjectVersionParameter{
708708
ID: arg.ID,
709709
CreatedAt: arg.CreatedAt,
710710
ProjectVersionID: arg.ProjectVersionID,
@@ -723,7 +723,7 @@ func (q *fakeQuerier) InsertProjectParameter(_ context.Context, arg database.Ins
723723
ValidationTypeSystem: arg.ValidationTypeSystem,
724724
ValidationValueType: arg.ValidationValueType,
725725
}
726-
q.projectParameter = append(q.projectParameter, param)
726+
q.projectVersionParameter = append(q.projectVersionParameter, param)
727727
return param, nil
728728
}
729729

‎database/dump.sql

Lines changed: 29 additions & 29 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎database/migrations/000002_projects.up.sql

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ CREATE TYPE parameter_destination_scheme AS ENUM('none', 'environment_variable',
6363
-- Parameter types, description, and validation will produce
6464
-- a UI for users to enter values.
6565
-- Needs to be made consistent with the examples below.
66-
CREATE TABLE project_parameter (
66+
CREATE TABLE project_version_parameter (
6767
id uuid NOT NULL UNIQUE,
6868
created_at timestamptz NOT NULL,
6969
project_version_id uuid NOT NULL REFERENCES project_version(id) ON DELETE CASCADE,

0 commit comments

Comments
 (0)