Skip to content

Commit

Permalink
refactor: Rename ProjectParameter to ProjectVersionParameter (#170)
Browse files Browse the repository at this point in the history 
This was confusing with ParameterValue before. It still is a bit,
but this should help distinguish scope.
  • Loading branch information
@kylecarbs
kylecarbs committed Feb 7, 2022
1 parent ed705f6 commit d55231c
Show file tree
Hide file tree
Showing 13 changed files with 240 additions and 225 deletions.
6 changes: 3 additions & 3 deletions coderd/projectparameter/projectparameter.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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!
Expand Down Expand Up @@ -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".
Expand Down
6 changes: 3 additions & 3 deletions coderd/projectparameter/projectparameter_test.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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
}
Expand All @@ -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,
Expand All @@ -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",
Expand Down
16 changes: 8 additions & 8 deletions coderd/projectversion.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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"`
Expand Down Expand Up @@ -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
}
Expand Down Expand Up @@ -194,10 +194,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{
Expand All @@ -206,7 +206,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))
}
Expand All @@ -227,8 +227,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,
Expand Down
10 changes: 5 additions & 5 deletions coderd/provisionerdaemons.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -378,14 +378,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,
Expand Down Expand Up @@ -430,7 +430,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.
Expand All @@ -448,8 +448,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)
}
Expand Down
2 changes: 1 addition & 1 deletion coderd/provisionerdaemons_test.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,5 +24,5 @@ func TestProvisionerDaemons(t *testing.T) {
daemons, err := client.ProvisionerDaemons(context.Background())
require.NoError(t, err)
return len(daemons) > 0
}, time.Second, 25*time.Millisecond)
}, 3*time.Second, 50*time.Millisecond)
}
4 changes: 2 additions & 2 deletions codersdk/projects.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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)
}

Expand Down
62 changes: 31 additions & 31 deletions database/databasefake/databasefake.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,18 +19,18 @@ func New() database.Store {
organizationMembers: make([]database.OrganizationMember, 0),
users: make([]database.User, 0),

files: make([]database.File, 0),
parameterValue: make([]database.ParameterValue, 0),
project: make([]database.Project, 0),
projectVersion: make([]database.ProjectVersion, 0),
projectParameter: make([]database.ProjectParameter, 0),
provisionerDaemons: make([]database.ProvisionerDaemon, 0),
provisionerJobs: make([]database.ProvisionerJob, 0),
provisionerJobLog: make([]database.ProvisionerJobLog, 0),
workspace: make([]database.Workspace, 0),
workspaceResource: make([]database.WorkspaceResource, 0),
workspaceHistory: make([]database.WorkspaceHistory, 0),
workspaceAgent: make([]database.WorkspaceAgent, 0),
files: make([]database.File, 0),
parameterValue: make([]database.ParameterValue, 0),
project: make([]database.Project, 0),
projectVersion: make([]database.ProjectVersion, 0),
projectVersionParameter: make([]database.ProjectVersionParameter, 0),
provisionerDaemons: make([]database.ProvisionerDaemon, 0),
provisionerJobs: make([]database.ProvisionerJob, 0),
provisionerJobLog: make([]database.ProvisionerJobLog, 0),
workspace: make([]database.Workspace, 0),
workspaceResource: make([]database.WorkspaceResource, 0),
workspaceHistory: make([]database.WorkspaceHistory, 0),
workspaceAgent: make([]database.WorkspaceAgent, 0),
}
}

Expand All @@ -40,23 +40,23 @@ type fakeQuerier struct {

// Legacy tables
apiKeys []database.APIKey
files []database.File
organizations []database.Organization
organizationMembers []database.OrganizationMember
users []database.User

// New tables
parameterValue []database.ParameterValue
project []database.Project
projectVersion []database.ProjectVersion
projectParameter []database.ProjectParameter
provisionerDaemons []database.ProvisionerDaemon
provisionerJobs []database.ProvisionerJob
provisionerJobLog []database.ProvisionerJobLog
workspace []database.Workspace
workspaceAgent []database.WorkspaceAgent
workspaceHistory []database.WorkspaceHistory
workspaceResource []database.WorkspaceResource
files []database.File
parameterValue []database.ParameterValue
project []database.Project
projectVersion []database.ProjectVersion
projectVersionParameter []database.ProjectVersionParameter
provisionerDaemons []database.ProvisionerDaemon
provisionerJobs []database.ProvisionerJob
provisionerJobLog []database.ProvisionerJobLog
workspace []database.Workspace
workspaceAgent []database.WorkspaceAgent
workspaceHistory []database.WorkspaceHistory
workspaceResource []database.WorkspaceResource
}

// InTx doesn't rollback data properly for in-memory yet.
Expand Down Expand Up @@ -399,7 +399,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()

Expand Down Expand Up @@ -445,12 +445,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
}
Expand Down Expand Up @@ -703,12 +703,12 @@ func (q *fakeQuerier) InsertProvisionerJobLogs(_ 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,
Expand All @@ -727,7 +727,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
}

Expand Down
48 changes: 27 additions & 21 deletions database/dump.sql
View file

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion database/migrations/000002_projects.up.sql
View file
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,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,
Expand Down

0 comments on commit d55231c

Please sign in to comment.