Skip to content

Commit 7f2a99f

Browse files
kylecarbskylecarbs
committed
chore: Rename ProjectHistory to ProjectVersion
Version more accurately represents version storage. This forks from the WorkspaceHistory name, but I think it's easier to understand Workspace history.
1 parent 2b41ac6 commit 7f2a99f

27 files changed

+551
-551
lines changed

‎coderd/coderd.go

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -66,13 +66,13 @@ func New(options *Options) http.Handler {
6666
r.Get("/", api.parametersByProject)
6767
r.Post("/", api.postParametersByProject)
6868
})
69-
r.Route("/history", func(r chi.Router) {
70-
r.Get("/", api.projectHistoryByOrganization)
71-
r.Post("/", api.postProjectHistoryByOrganization)
72-
r.Route("/{projecthistory}", func(r chi.Router) {
73-
r.Use(httpmw.ExtractProjectHistoryParam(api.Database))
74-
r.Get("/", api.projectHistoryByOrganizationAndName)
75-
r.Get("/parameters", api.projectHistoryParametersByOrganizationAndName)
69+
r.Route("/versions", func(r chi.Router) {
70+
r.Get("/", api.projectVersionsByOrganization)
71+
r.Post("/", api.postProjectVersionByOrganization)
72+
r.Route("/{projectversion}", func(r chi.Router) {
73+
r.Use(httpmw.ExtractProjectVersionParam(api.Database))
74+
r.Get("/", api.projectVersionByOrganizationAndName)
75+
r.Get("/parameters", api.projectVersionParametersByOrganizationAndName)
7676
})
7777
})
7878
})
@@ -91,7 +91,7 @@ func New(options *Options) http.Handler {
9191
r.Route("/{workspace}", func(r chi.Router) {
9292
r.Use(httpmw.ExtractWorkspaceParam(options.Database))
9393
r.Get("/", api.workspaceByUser)
94-
r.Route("/history", func(r chi.Router) {
94+
r.Route("/version", func(r chi.Router) {
9595
r.Post("/", api.postWorkspaceHistoryByUser)
9696
r.Get("/", api.workspaceHistoryByUser)
9797
r.Route("/{workspacehistory}", func(r chi.Router) {

‎coderd/projecthistory.go

Lines changed: 43 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,8 @@ import (
2020
"github.com/coder/coder/httpmw"
2121
)
2222

23-
// ProjectHistory is the JSON representation of Coder project version history.
24-
type ProjectHistory struct {
23+
// ProjectVersion represents a single version of a project.
24+
type ProjectVersion struct {
2525
ID uuid.UUID `json:"id"`
2626
ProjectID uuid.UUID `json:"project_id"`
2727
CreatedAt time.Time `json:"created_at"`
@@ -31,11 +31,11 @@ type ProjectHistory struct {
3131
Import ProvisionerJob `json:"import"`
3232
}
3333

34-
// ProjectParameter represents a parameter parsed from project history source on creation.
34+
// ProjectParameter represents a parameter parsed from project version source on creation.
3535
type ProjectParameter struct {
3636
ID uuid.UUID `json:"id"`
3737
CreatedAt time.Time `json:"created_at"`
38-
ProjectHistoryID uuid.UUID `json:"project_history_id"`
38+
ProjectVersionID uuid.UUID `json:"project_version_id"`
3939
Name string `json:"name"`
4040
Description string `json:"description,omitempty"`
4141
DefaultSourceScheme database.ParameterSourceScheme `json:"default_source_scheme,omitempty"`
@@ -52,60 +52,60 @@ type ProjectParameter struct {
5252
ValidationValueType string `json:"validation_value_type,omitempty"`
5353
}
5454

55-
// CreateProjectHistoryRequest enables callers to create a new Project Version.
56-
type CreateProjectHistoryRequest struct {
55+
// CreateProjectVersionRequest enables callers to create a new Project Version.
56+
type CreateProjectVersionRequest struct {
5757
StorageMethod database.ProjectStorageMethod `json:"storage_method" validate:"oneof=inline-archive,required"`
5858
StorageSource []byte `json:"storage_source" validate:"max=1048576,required"`
5959
}
6060

61-
// Lists history for a single project.
62-
func (api *api) projectHistoryByOrganization(rw http.ResponseWriter, r *http.Request) {
61+
// Lists versions for a single project.
62+
func (api *api) projectVersionsByOrganization(rw http.ResponseWriter, r *http.Request) {
6363
project := httpmw.ProjectParam(r)
6464

65-
history, err := api.Database.GetProjectHistoryByProjectID(r.Context(), project.ID)
65+
version, err := api.Database.GetProjectVersionByProjectID(r.Context(), project.ID)
6666
if errors.Is(err, sql.ErrNoRows) {
6767
err = nil
6868
}
6969
if err != nil {
7070
httpapi.Write(rw, http.StatusInternalServerError, httpapi.Response{
71-
Message: fmt.Sprintf("get project history: %s", err),
71+
Message: fmt.Sprintf("get project version: %s", err),
7272
})
7373
return
7474
}
75-
apiHistory := make([]ProjectHistory, 0)
76-
for _, version := range history {
75+
apiVersion := make([]ProjectVersion, 0)
76+
for _, version := range version {
7777
job, err := api.Database.GetProvisionerJobByID(r.Context(), version.ImportJobID)
7878
if err != nil {
7979
httpapi.Write(rw, http.StatusInternalServerError, httpapi.Response{
8080
Message: fmt.Sprintf("get provisioner job: %s", err),
8181
})
8282
return
8383
}
84-
apiHistory = append(apiHistory, convertProjectHistory(version, job))
84+
apiVersion = append(apiVersion, convertProjectVersion(version, job))
8585
}
8686
render.Status(r, http.StatusOK)
87-
render.JSON(rw, r, apiHistory)
87+
render.JSON(rw, r, apiVersion)
8888
}
8989

90-
// Return a single project history by organization and name.
91-
func (api *api) projectHistoryByOrganizationAndName(rw http.ResponseWriter, r *http.Request) {
92-
projectHistory := httpmw.ProjectHistoryParam(r)
93-
job, err := api.Database.GetProvisionerJobByID(r.Context(), projectHistory.ImportJobID)
90+
// Return a single project version by organization and name.
91+
func (api *api) projectVersionByOrganizationAndName(rw http.ResponseWriter, r *http.Request) {
92+
projectVersion := httpmw.ProjectVersionParam(r)
93+
job, err := api.Database.GetProvisionerJobByID(r.Context(), projectVersion.ImportJobID)
9494
if err != nil {
9595
httpapi.Write(rw, http.StatusInternalServerError, httpapi.Response{
9696
Message: fmt.Sprintf("get provisioner job: %s", err),
9797
})
9898
return
9999
}
100100
render.Status(r, http.StatusOK)
101-
render.JSON(rw, r, convertProjectHistory(projectHistory, job))
101+
render.JSON(rw, r, convertProjectVersion(projectVersion, job))
102102
}
103103

104104
// Creates a new version of the project. An import job is queued to parse
105105
// the storage method provided. Once completed, the import job will specify
106106
// the version as latest.
107-
func (api *api) postProjectHistoryByOrganization(rw http.ResponseWriter, r *http.Request) {
108-
var createProjectVersion CreateProjectHistoryRequest
107+
func (api *api) postProjectVersionByOrganization(rw http.ResponseWriter, r *http.Request) {
108+
var createProjectVersion CreateProjectVersionRequest
109109
if !httpapi.Read(rw, r, &createProjectVersion) {
110110
return
111111
}
@@ -131,11 +131,11 @@ func (api *api) postProjectHistoryByOrganization(rw http.ResponseWriter, r *http
131131
project := httpmw.ProjectParam(r)
132132

133133
var provisionerJob database.ProvisionerJob
134-
var projectHistory database.ProjectHistory
134+
var projectVersion database.ProjectVersion
135135
err := api.Database.InTx(func(db database.Store) error {
136-
projectHistoryID := uuid.New()
136+
projectVersionID := uuid.New()
137137
input, err := json.Marshal(projectImportJob{
138-
ProjectHistoryID: projectHistoryID,
138+
ProjectVersionID: projectVersionID,
139139
})
140140
if err != nil {
141141
return xerrors.Errorf("marshal import job: %w", err)
@@ -155,8 +155,8 @@ func (api *api) postProjectHistoryByOrganization(rw http.ResponseWriter, r *http
155155
return xerrors.Errorf("insert provisioner job: %w", err)
156156
}
157157

158-
projectHistory, err = api.Database.InsertProjectHistory(r.Context(), database.InsertProjectHistoryParams{
159-
ID: projectHistoryID,
158+
projectVersion, err = api.Database.InsertProjectVersion(r.Context(), database.InsertProjectVersionParams{
159+
ID: projectVersionID,
160160
ProjectID: project.ID,
161161
CreatedAt: database.Now(),
162162
UpdatedAt: database.Now(),
@@ -166,7 +166,7 @@ func (api *api) postProjectHistoryByOrganization(rw http.ResponseWriter, r *http
166166
ImportJobID: provisionerJob.ID,
167167
})
168168
if err != nil {
169-
return xerrors.Errorf("insert project history: %s", err)
169+
return xerrors.Errorf("insert project version: %s", err)
170170
}
171171
return nil
172172
})
@@ -178,12 +178,12 @@ func (api *api) postProjectHistoryByOrganization(rw http.ResponseWriter, r *http
178178
}
179179

180180
render.Status(r, http.StatusCreated)
181-
render.JSON(rw, r, convertProjectHistory(projectHistory, provisionerJob))
181+
render.JSON(rw, r, convertProjectVersion(projectVersion, provisionerJob))
182182
}
183183

184-
func (api *api) projectHistoryParametersByOrganizationAndName(rw http.ResponseWriter, r *http.Request) {
185-
projectHistory := httpmw.ProjectHistoryParam(r)
186-
job, err := api.Database.GetProvisionerJobByID(r.Context(), projectHistory.ImportJobID)
184+
func (api *api) projectVersionParametersByOrganizationAndName(rw http.ResponseWriter, r *http.Request) {
185+
projectVersion := httpmw.ProjectVersionParam(r)
186+
job, err := api.Database.GetProvisionerJobByID(r.Context(), projectVersion.ImportJobID)
187187
if err != nil {
188188
httpapi.Write(rw, http.StatusInternalServerError, httpapi.Response{
189189
Message: fmt.Sprintf("get provisioner job: %s", err),
@@ -204,7 +204,7 @@ func (api *api) projectHistoryParametersByOrganizationAndName(rw http.ResponseWr
204204
return
205205
}
206206

207-
parameters, err := api.Database.GetProjectParametersByHistoryID(r.Context(), projectHistory.ID)
207+
parameters, err := api.Database.GetProjectParametersByVersionID(r.Context(), projectVersion.ID)
208208
if errors.Is(err, sql.ErrNoRows) {
209209
err = nil
210210
parameters = []database.ProjectParameter{}
@@ -225,14 +225,14 @@ func (api *api) projectHistoryParametersByOrganizationAndName(rw http.ResponseWr
225225
render.JSON(rw, r, apiParameters)
226226
}
227227

228-
func convertProjectHistory(history database.ProjectHistory, job database.ProvisionerJob) ProjectHistory {
229-
return ProjectHistory{
230-
ID: history.ID,
231-
ProjectID: history.ProjectID,
232-
CreatedAt: history.CreatedAt,
233-
UpdatedAt: history.UpdatedAt,
234-
Name: history.Name,
235-
StorageMethod: history.StorageMethod,
228+
func convertProjectVersion(version database.ProjectVersion, job database.ProvisionerJob) ProjectVersion {
229+
return ProjectVersion{
230+
ID: version.ID,
231+
ProjectID: version.ProjectID,
232+
CreatedAt: version.CreatedAt,
233+
UpdatedAt: version.UpdatedAt,
234+
Name: version.Name,
235+
StorageMethod: version.StorageMethod,
236236
Import: convertProvisionerJob(job),
237237
}
238238
}
@@ -241,7 +241,7 @@ func convertProjectParameter(parameter database.ProjectParameter) ProjectParamet
241241
return ProjectParameter{
242242
ID: parameter.ID,
243243
CreatedAt: parameter.CreatedAt,
244-
ProjectHistoryID: parameter.ProjectHistoryID,
244+
ProjectVersionID: parameter.ProjectVersionID,
245245
Name: parameter.Name,
246246
Description: parameter.Description,
247247
DefaultSourceScheme: parameter.DefaultSourceScheme,
@@ -259,6 +259,6 @@ func convertProjectParameter(parameter database.ProjectParameter) ProjectParamet
259259
}
260260
}
261261

262-
func projectHistoryLogsChannel(projectHistoryID uuid.UUID) string {
263-
return fmt.Sprintf("project-history-logs:%s", projectHistoryID)
262+
func projectVersionLogsChannel(projectVersionID uuid.UUID) string {
263+
return fmt.Sprintf("project-version-logs:%s", projectVersionID)
264264
}

‎coderd/projecthistory_test.go

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ import (
1515
"github.com/coder/coder/provisionersdk/proto"
1616
)
1717

18-
func TestProjectHistory(t *testing.T) {
18+
func TestProjectVersion(t *testing.T) {
1919
t.Parallel()
2020

2121
t.Run("NoHistory", func(t *testing.T) {
@@ -27,12 +27,12 @@ func TestProjectHistory(t *testing.T) {
2727
Provisioner: database.ProvisionerTypeEcho,
2828
})
2929
require.NoError(t, err)
30-
versions, err := server.Client.ListProjectHistory(context.Background(), user.Organization, project.Name)
30+
versions, err := server.Client.ProjectVersions(context.Background(), user.Organization, project.Name)
3131
require.NoError(t, err)
3232
require.Len(t, versions, 0)
3333
})
3434

35-
t.Run("CreateHistory", func(t *testing.T) {
35+
t.Run("CreateVersion", func(t *testing.T) {
3636
t.Parallel()
3737
server := coderdtest.New(t)
3838
user := server.RandomInitialUser(t)
@@ -47,16 +47,16 @@ func TestProjectHistory(t *testing.T) {
4747
},
4848
}}, nil)
4949
require.NoError(t, err)
50-
history, err := server.Client.CreateProjectHistory(context.Background(), user.Organization, project.Name, coderd.CreateProjectHistoryRequest{
50+
version, err := server.Client.CreateProjectVersion(context.Background(), user.Organization, project.Name, coderd.CreateProjectVersionRequest{
5151
StorageMethod: database.ProjectStorageMethodInlineArchive,
5252
StorageSource: data,
5353
})
5454
require.NoError(t, err)
55-
versions, err := server.Client.ListProjectHistory(context.Background(), user.Organization, project.Name)
55+
versions, err := server.Client.ProjectVersions(context.Background(), user.Organization, project.Name)
5656
require.NoError(t, err)
5757
require.Len(t, versions, 1)
5858

59-
_, err = server.Client.ProjectHistory(context.Background(), user.Organization, project.Name, history.Name)
59+
_, err = server.Client.ProjectVersion(context.Background(), user.Organization, project.Name, version.Name)
6060
require.NoError(t, err)
6161
})
6262

@@ -78,7 +78,7 @@ func TestProjectHistory(t *testing.T) {
7878
require.NoError(t, err)
7979
_, err = writer.Write(make([]byte, 1<<21))
8080
require.NoError(t, err)
81-
_, err = server.Client.CreateProjectHistory(context.Background(), user.Organization, project.Name, coderd.CreateProjectHistoryRequest{
81+
_, err = server.Client.CreateProjectVersion(context.Background(), user.Organization, project.Name, coderd.CreateProjectVersionRequest{
8282
StorageMethod: database.ProjectStorageMethodInlineArchive,
8383
StorageSource: buffer.Bytes(),
8484
})
@@ -94,7 +94,7 @@ func TestProjectHistory(t *testing.T) {
9494
Provisioner: database.ProvisionerTypeEcho,
9595
})
9696
require.NoError(t, err)
97-
_, err = server.Client.CreateProjectHistory(context.Background(), user.Organization, project.Name, coderd.CreateProjectHistoryRequest{
97+
_, err = server.Client.CreateProjectVersion(context.Background(), user.Organization, project.Name, coderd.CreateProjectVersionRequest{
9898
StorageMethod: database.ProjectStorageMethodInlineArchive,
9999
StorageSource: []byte{},
100100
})

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy