feat: add template version creator (#2991)

AbhineetJain · web-flow · commit aea3b3b83e1f · 2022-07-14T20:44:33.000Z
diff --git a/coderd/audit/diff_test.go b/coderd/audit/diff_test.go
@@ -114,12 +114,14 @@ func TestDiff(t *testing.T) {
 				UpdatedAt:      time.Now(),
 				OrganizationID: uuid.UUID{3},
 				Name:           "rust",
+				CreatedBy:      uuid.UUID{4},
 			},
 			exp: audit.Map{
 				"id":              uuid.UUID{1}.String(),
 				"template_id":     uuid.UUID{2}.String(),
 				"organization_id": uuid.UUID{3}.String(),
 				"name":            "rust",
+				"created_by":      uuid.UUID{4}.String(),
 			},
 		},
 		{
@@ -132,11 +134,13 @@ func TestDiff(t *testing.T) {
 				UpdatedAt:      time.Now(),
 				OrganizationID: uuid.UUID{3},
 				Name:           "rust",
+				CreatedBy:      uuid.UUID{4},
 			},
 			exp: audit.Map{
 				"id":              uuid.UUID{1}.String(),
 				"organization_id": uuid.UUID{3}.String(),
 				"name":            "rust",
+				"created_by":      uuid.UUID{4}.String(),
 			},
 		},
 	})
diff --git a/coderd/audit/table.go b/coderd/audit/table.go
@@ -83,6 +83,7 @@ var AuditableResources = auditMap(map[any]map[string]Action{
 		"name":            ActionTrack,
 		"readme":          ActionTrack,
 		"job_id":          ActionIgnore, // Not helpful in a diff because jobs aren't tracked in audit logs.
+		"created_by":      ActionTrack,
 	},
 	&database.User{}: {
 		"id":              ActionTrack,
diff --git a/coderd/database/databasefake/databasefake.go b/coderd/database/databasefake/databasefake.go
@@ -1511,6 +1511,7 @@ func (q *fakeQuerier) InsertTemplateVersion(_ context.Context, arg database.Inse
 		Name:           arg.Name,
 		Readme:         arg.Readme,
 		JobID:          arg.JobID,
+		CreatedBy:      arg.CreatedBy,
 	}
 	q.templateVersions = append(q.templateVersions, version)
 	return version, nil
diff --git a/coderd/database/dump.sql b/coderd/database/dump.sql
diff --git a/coderd/database/migrations/000030_template_version_created_by.down.sql b/coderd/database/migrations/000030_template_version_created_by.down.sql
@@ -0,0 +1 @@
+ALTER TABLE ONLY template_versions DROP COLUMN IF EXISTS created_by;
diff --git a/coderd/database/migrations/000030_template_version_created_by.up.sql b/coderd/database/migrations/000030_template_version_created_by.up.sql
@@ -0,0 +1,14 @@
+ALTER TABLE ONLY template_versions ADD COLUMN IF NOT EXISTS created_by uuid REFERENCES users (id) ON DELETE RESTRICT;
+
+UPDATE
+    template_versions
+SET
+    created_by = (
+        SELECT created_by FROM templates
+        WHERE template_versions.template_id = templates.id
+        LIMIT 1
+    )
+WHERE
+    created_by IS NULL;
+
+ALTER TABLE ONLY template_versions ALTER COLUMN created_by SET NOT NULL;
diff --git a/coderd/database/models.go b/coderd/database/models.go
diff --git a/coderd/database/queries.sql.go b/coderd/database/queries.sql.go
diff --git a/coderd/database/queries/templateversions.sql b/coderd/database/queries/templateversions.sql
@@ -70,10 +70,11 @@ INSERT INTO
 		updated_at,
 		"name",
 		readme,
-		job_id
+		job_id,
+		created_by
 	)
 VALUES
-	($1, $2, $3, $4, $5, $6, $7, $8) RETURNING *;
+	($1, $2, $3, $4, $5, $6, $7, $8, $9) RETURNING *;
 
 -- name: UpdateTemplateVersionByID :exec
 UPDATE
diff --git a/coderd/templates.go b/coderd/templates.go
@@ -209,6 +209,7 @@ func (api *API) postTemplateByOrganization(rw http.ResponseWriter, r *http.Reque
 				UUID:  dbTemplate.ID,
 				Valid: true,
 			},
+			UpdatedAt: database.Now(),
 		})
 		if err != nil {
 			return xerrors.Errorf("insert template version: %s", err)
diff --git a/coderd/templateversions.go b/coderd/templateversions.go
@@ -1,6 +1,7 @@
 package coderd
 
 import (
+	"context"
 	"database/sql"
 	"encoding/json"
 	"errors"
@@ -36,7 +37,16 @@ func (api *API) templateVersion(rw http.ResponseWriter, r *http.Request) {
 		return
 	}
 
-	httpapi.Write(rw, http.StatusOK, convertTemplateVersion(templateVersion, convertProvisionerJob(job)))
+	createdByName, err := getUsernameByUserID(r.Context(), api.Database, templateVersion.CreatedBy)
+	if err != nil {
+		httpapi.Write(rw, http.StatusInternalServerError, codersdk.Response{
+			Message: "Internal error fetching creator name.",
+			Detail:  err.Error(),
+		})
+		return
+	}
+
+	httpapi.Write(rw, http.StatusOK, convertTemplateVersion(templateVersion, convertProvisionerJob(job), createdByName))
 }
 
 func (api *API) patchCancelTemplateVersion(rw http.ResponseWriter, r *http.Request) {
@@ -476,7 +486,15 @@ func (api *API) templateVersionsByTemplate(rw http.ResponseWriter, r *http.Reque
 				})
 				return err
 			}
-			apiVersions = append(apiVersions, convertTemplateVersion(version, convertProvisionerJob(job)))
+			createdByName, err := getUsernameByUserID(r.Context(), store, version.CreatedBy)
+			if err != nil {
+				httpapi.Write(rw, http.StatusInternalServerError, codersdk.Response{
+					Message: "Internal error fetching creator name.",
+					Detail:  err.Error(),
+				})
+				return err
+			}
+			apiVersions = append(apiVersions, convertTemplateVersion(version, convertProvisionerJob(job), createdByName))
 		}
 
 		return nil
@@ -525,7 +543,16 @@ func (api *API) templateVersionByName(rw http.ResponseWriter, r *http.Request) {
 		return
 	}
 
-	httpapi.Write(rw, http.StatusOK, convertTemplateVersion(templateVersion, convertProvisionerJob(job)))
+	createdByName, err := getUsernameByUserID(r.Context(), api.Database, templateVersion.CreatedBy)
+	if err != nil {
+		httpapi.Write(rw, http.StatusInternalServerError, codersdk.Response{
+			Message: "Internal error fetching creator name.",
+			Detail:  err.Error(),
+		})
+		return
+	}
+
+	httpapi.Write(rw, http.StatusOK, convertTemplateVersion(templateVersion, convertProvisionerJob(job), createdByName))
 }
 
 func (api *API) patchActiveTemplateVersion(rw http.ResponseWriter, r *http.Request) {
@@ -735,6 +762,7 @@ func (api *API) postTemplateVersionsByOrganization(rw http.ResponseWriter, r *ht
 			Name:           namesgenerator.GetRandomName(1),
 			Readme:         "",
 			JobID:          provisionerJob.ID,
+			CreatedBy:      apiKey.UserID,
 		})
 		if err != nil {
 			return xerrors.Errorf("insert template version: %w", err)
@@ -748,7 +776,16 @@ func (api *API) postTemplateVersionsByOrganization(rw http.ResponseWriter, r *ht
 		return
 	}
 
-	httpapi.Write(rw, http.StatusCreated, convertTemplateVersion(templateVersion, convertProvisionerJob(provisionerJob)))
+	createdByName, err := getUsernameByUserID(r.Context(), api.Database, templateVersion.CreatedBy)
+	if err != nil {
+		httpapi.Write(rw, http.StatusInternalServerError, codersdk.Response{
+			Message: "Internal error fetching creator name.",
+			Detail:  err.Error(),
+		})
+		return
+	}
+
+	httpapi.Write(rw, http.StatusCreated, convertTemplateVersion(templateVersion, convertProvisionerJob(provisionerJob), createdByName))
 }
 
 // templateVersionResources returns the workspace agent resources associated
@@ -796,7 +833,15 @@ func (api *API) templateVersionLogs(rw http.ResponseWriter, r *http.Request) {
 	api.provisionerJobLogs(rw, r, job)
 }
 
-func convertTemplateVersion(version database.TemplateVersion, job codersdk.ProvisionerJob) codersdk.TemplateVersion {
+func getUsernameByUserID(ctx context.Context, db database.Store, userID uuid.UUID) (string, error) {
+	user, err := db.GetUserByID(ctx, userID)
+	if err != nil {
+		return "", err
+	}
+	return user.Username, nil
+}
+
+func convertTemplateVersion(version database.TemplateVersion, job codersdk.ProvisionerJob, createdByName string) codersdk.TemplateVersion {
 	return codersdk.TemplateVersion{
 		ID:             version.ID,
 		TemplateID:     &version.TemplateID.UUID,
@@ -806,5 +851,7 @@ func convertTemplateVersion(version database.TemplateVersion, job codersdk.Provi
 		Name:           version.Name,
 		Job:            job,
 		Readme:         version.Readme,
+		CreatedByID:    version.CreatedBy,
+		CreatedByName:  createdByName,
 	}
 }
diff --git a/codersdk/templateversions.go b/codersdk/templateversions.go
@@ -20,6 +20,8 @@ type TemplateVersion struct {
 	Name           string         `json:"name"`
 	Job            ProvisionerJob `json:"job"`
 	Readme         string         `json:"readme"`
+	CreatedByID    uuid.UUID      `json:"created_by_id"`
+	CreatedByName  string         `json:"created_by_name"`
 }
 
 // TemplateVersion returns a template version by ID.
diff --git a/site/src/api/typesGenerated.ts b/site/src/api/typesGenerated.ts
@@ -87,7 +87,7 @@ export interface CreateTemplateRequest {
   readonly min_autostart_interval_ms?: number
 }
 
-// From codersdk/templateversions.go:106:6
+// From codersdk/templateversions.go:108:6
 export interface CreateTemplateVersionDryRunRequest {
   readonly WorkspaceName: string
   readonly ParameterValues: CreateParameterRequest[]
@@ -290,6 +290,8 @@ export interface TemplateVersion {
   readonly name: string
   readonly job: ProvisionerJob
   readonly readme: string
+  readonly created_by_id: string
+  readonly created_by_name: string
 }
 
 // From codersdk/templates.go:100:6
diff --git a/site/src/testHelpers/entities.ts b/site/src/testHelpers/entities.ts
@@ -112,6 +112,8 @@ name:Template test
 You can add instructions here
 
 [Some link info](https://coder.com)`,
+  created_by_id: "test-creator-id",
+  created_by_name: "test_creator",
 }
 
 export const MockTemplate: TypesGen.Template = {

Original file line number	Diff line number	Diff line change
`@@ -1511,6 +1511,7 @@ func (q *fakeQuerier) InsertTemplateVersion(_ context.Context, arg database.Inse`
`1511`	`1511`	`Name: arg.Name,`
`1512`	`1512`	`Readme: arg.Readme,`
`1513`	`1513`	`JobID: arg.JobID,`
	`1514`	`+ CreatedBy: arg.CreatedBy,`
`1514`	`1515`	`}`
`1515`	`1516`	`q.templateVersions = append(q.templateVersions, version)`
`1516`	`1517`	`return version, nil`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+ALTER TABLE ONLY template_versions DROP COLUMN IF EXISTS created_by;`