feat: Refactor API routes to use UUIDs instead of friendly names (#401)

* Add client for agent * Cleanup code * Fix linting error * Rename routes to be simpler * Rename workspace history to workspace build * Refactor HTTP middlewares to use UUIDs * Cleanup routes * Compiles! * Fix files and organizations * Fix querying * Fix agent lock * Cleanup database abstraction * Add parameters * Fix linting errors * Fix log race * Lock on close wait * Fix log cleanup * Fix e2e tests * Fix upstream version of opencensus-go * Update coderdtest.go * Fix coverpkg * Fix codecov ignore
2025-07-08 11:39:50 +00:00 · 2022-03-07 11:40:54 -06:00
parent 330686f60a
commit bf0ae8f573
115 changed files with 5853 additions and 4657 deletions
--- a/coderd/projectversions.go
+++ b/coderd/projectversions.go
@ -0,0 +1,150 @@
+package coderd
+
+import (
+	"database/sql"
+	"errors"
+	"fmt"
+	"net/http"
+	"time"
+
+	"github.com/go-chi/render"
+	"github.com/google/uuid"
+
+	"github.com/coder/coder/coderd/parameter"
+	"github.com/coder/coder/database"
+	"github.com/coder/coder/httpapi"
+	"github.com/coder/coder/httpmw"
+)
+
+// ProjectVersion represents a single version of a project.
+type ProjectVersion struct {
+	ID        uuid.UUID      `json:"id"`
+	ProjectID *uuid.UUID     `json:"project_id,omitempty"`
+	CreatedAt time.Time      `json:"created_at"`
+	UpdatedAt time.Time      `json:"updated_at"`
+	Name      string         `json:"name"`
+	Job       ProvisionerJob `json:"job"`
+}
+
+// ProjectVersionParameterSchema represents a parameter parsed from project version source.
+type ProjectVersionParameterSchema database.ParameterSchema
+
+// ProjectVersionParameter represents a computed parameter value.
+type ProjectVersionParameter parameter.ComputedValue
+
+func (api *api) projectVersion(rw http.ResponseWriter, r *http.Request) {
+	projectVersion := httpmw.ProjectVersionParam(r)
+	job, err := api.Database.GetProvisionerJobByID(r.Context(), projectVersion.JobID)
+	if err != nil {
+		httpapi.Write(rw, http.StatusInternalServerError, httpapi.Response{
+			Message: fmt.Sprintf("get provisioner job: %s", err),
+		})
+		return
+	}
+	render.Status(r, http.StatusOK)
+	render.JSON(rw, r, convertProjectVersion(projectVersion, convertProvisionerJob(job)))
+}
+
+func (api *api) projectVersionSchema(rw http.ResponseWriter, r *http.Request) {
+	projectVersion := httpmw.ProjectVersionParam(r)
+	job, err := api.Database.GetProvisionerJobByID(r.Context(), projectVersion.JobID)
+	if err != nil {
+		httpapi.Write(rw, http.StatusInternalServerError, httpapi.Response{
+			Message: fmt.Sprintf("get provisioner job: %s", err),
+		})
+		return
+	}
+	if !job.CompletedAt.Valid {
+		httpapi.Write(rw, http.StatusPreconditionFailed, httpapi.Response{
+			Message: "Project version job hasn't completed!",
+		})
+		return
+	}
+	schemas, err := api.Database.GetParameterSchemasByJobID(r.Context(), job.ID)
+	if errors.Is(err, sql.ErrNoRows) {
+		err = nil
+	}
+	if err != nil {
+		httpapi.Write(rw, http.StatusInternalServerError, httpapi.Response{
+			Message: fmt.Sprintf("list parameter schemas: %s", err),
+		})
+		return
+	}
+	if schemas == nil {
+		schemas = []database.ParameterSchema{}
+	}
+	render.Status(r, http.StatusOK)
+	render.JSON(rw, r, schemas)
+}
+
+func (api *api) projectVersionParameters(rw http.ResponseWriter, r *http.Request) {
+	apiKey := httpmw.APIKey(r)
+	projectVersion := httpmw.ProjectVersionParam(r)
+	job, err := api.Database.GetProvisionerJobByID(r.Context(), projectVersion.JobID)
+	if err != nil {
+		httpapi.Write(rw, http.StatusInternalServerError, httpapi.Response{
+			Message: fmt.Sprintf("get provisioner job: %s", err),
+		})
+		return
+	}
+	if !job.CompletedAt.Valid {
+		httpapi.Write(rw, http.StatusPreconditionFailed, httpapi.Response{
+			Message: "Job hasn't completed!",
+		})
+		return
+	}
+	values, err := parameter.Compute(r.Context(), api.Database, parameter.ComputeScope{
+		ProjectImportJobID: job.ID,
+		OrganizationID:     job.OrganizationID,
+		UserID:             apiKey.UserID,
+	}, &parameter.ComputeOptions{
+		// We *never* want to send the client secret parameter values.
+		HideRedisplayValues: true,
+	})
+	if err != nil {
+		httpapi.Write(rw, http.StatusInternalServerError, httpapi.Response{
+			Message: fmt.Sprintf("compute values: %s", err),
+		})
+		return
+	}
+	if values == nil {
+		values = []parameter.ComputedValue{}
+	}
+	render.Status(r, http.StatusOK)
+	render.JSON(rw, r, values)
+}
+
+func (api *api) projectVersionResources(rw http.ResponseWriter, r *http.Request) {
+	projectVersion := httpmw.ProjectVersionParam(r)
+	job, err := api.Database.GetProvisionerJobByID(r.Context(), projectVersion.JobID)
+	if err != nil {
+		httpapi.Write(rw, http.StatusInternalServerError, httpapi.Response{
+			Message: fmt.Sprintf("get provisioner job: %s", err),
+		})
+		return
+	}
+	api.provisionerJobResources(rw, r, job)
+}
+
+func (api *api) projectVersionLogs(rw http.ResponseWriter, r *http.Request) {
+	projectVersion := httpmw.ProjectVersionParam(r)
+	job, err := api.Database.GetProvisionerJobByID(r.Context(), projectVersion.JobID)
+	if err != nil {
+		httpapi.Write(rw, http.StatusInternalServerError, httpapi.Response{
+			Message: fmt.Sprintf("get provisioner job: %s", err),
+		})
+		return
+	}
+	api.provisionerJobLogs(rw, r, job)
+}
+
+func convertProjectVersion(version database.ProjectVersion, job ProvisionerJob) ProjectVersion {
+	return ProjectVersion{
+		ID:        version.ID,
+		ProjectID: &version.ProjectID.UUID,
+		CreatedAt: version.CreatedAt,
+		UpdatedAt: version.UpdatedAt,
+		Name:      version.Name,
+		Job:       job,
+	}
+}