feat: initiator_username joined to workspace_build queries

Using views to make models for sqlc
coder · Emyrk · Jun 7, 2022 · Jun 7, 2022 · Jun 7, 2022 · Jun 7, 2022
commit 541f98544185ce82efc96e0c22a957c02fc45568
diff --git a/coderd/autobuild/executor/lifecycle_executor.go b/coderd/autobuild/executor/lifecycle_executor.go
@@ -190,7 +190,7 @@ func (e *Executor) runOnce(t time.Time) Stats {
 
 // TODO(cian): this function duplicates most of api.postWorkspaceBuilds. Refactor.
 // See: https://github.com/coder/coder/issues/1401
-func build(ctx context.Context, store database.Store, workspace database.Workspace, trans database.WorkspaceTransition, priorHistory database.WorkspaceBuild, priorJob database.ProvisionerJob) error {
+func build(ctx context.Context, store database.Store, workspace database.Workspace, trans database.WorkspaceTransition, priorHistory database.WorkspaceBuildsWithInitiator, priorJob database.ProvisionerJob) error {
 	template, err := store.GetTemplateByID(ctx, workspace.TemplateID)
 	if err != nil {
 		return xerrors.Errorf("get workspace template: %w", err)

diff --git a/coderd/database/databasefake/databasefake.go b/coderd/database/databasefake/databasefake.go
@@ -476,63 +476,63 @@ func (q *fakeQuerier) GetWorkspaceOwnerCountsByTemplateIDs(_ context.Context, te
 	return res, nil
 }
 
-func (q *fakeQuerier) GetWorkspaceBuildByID(_ context.Context, id uuid.UUID) (database.WorkspaceBuild, error) {
+func (q *fakeQuerier) GetWorkspaceBuildByID(_ context.Context, id uuid.UUID) (database.WorkspaceBuildsWithInitiator, error) {
 	q.mutex.RLock()
 	defer q.mutex.RUnlock()
 
 	for _, history := range q.workspaceBuilds {
 		if history.ID.String() == id.String() {
-			return history, nil
+			return q.workspaceBuildWithInitiator(history), nil
 		}
 	}
-	return database.WorkspaceBuild{}, sql.ErrNoRows
+	return database.WorkspaceBuildsWithInitiator{}, sql.ErrNoRows
 }
 
-func (q *fakeQuerier) GetWorkspaceBuildByJobID(_ context.Context, jobID uuid.UUID) (database.WorkspaceBuild, error) {
+func (q *fakeQuerier) GetWorkspaceBuildByJobID(_ context.Context, jobID uuid.UUID) (database.WorkspaceBuildsWithInitiator, error) {
 	q.mutex.RLock()
 	defer q.mutex.RUnlock()
 
 	for _, build := range q.workspaceBuilds {
 		if build.JobID.String() == jobID.String() {
-			return build, nil
+			return q.workspaceBuildWithInitiator(build), nil
 		}
 	}
-	return database.WorkspaceBuild{}, sql.ErrNoRows
+	return database.WorkspaceBuildsWithInitiator{}, sql.ErrNoRows
 }
 
-func (q *fakeQuerier) GetLatestWorkspaceBuildByWorkspaceID(_ context.Context, workspaceID uuid.UUID) (database.WorkspaceBuild, error) {
+func (q *fakeQuerier) GetLatestWorkspaceBuildByWorkspaceID(_ context.Context, workspaceID uuid.UUID) (database.WorkspaceBuildsWithInitiator, error) {
 	q.mutex.RLock()
 	defer q.mutex.RUnlock()
 
-	var row database.WorkspaceBuild
+	var row database.WorkspaceBuildsWithInitiator
 	var buildNum int32
 	for _, workspaceBuild := range q.workspaceBuilds {
 		if workspaceBuild.WorkspaceID.String() == workspaceID.String() && workspaceBuild.BuildNumber > buildNum {
-			row = workspaceBuild
+			row = q.workspaceBuildWithInitiator(workspaceBuild)
 			buildNum = workspaceBuild.BuildNumber
 		}
 	}
 	if buildNum == 0 {
-		return database.WorkspaceBuild{}, sql.ErrNoRows
+		return database.WorkspaceBuildsWithInitiator{}, sql.ErrNoRows
 	}
 	return row, nil
 }
 
-func (q *fakeQuerier) GetLatestWorkspaceBuildsByWorkspaceIDs(_ context.Context, ids []uuid.UUID) ([]database.WorkspaceBuild, error) {
+func (q *fakeQuerier) GetLatestWorkspaceBuildsByWorkspaceIDs(_ context.Context, ids []uuid.UUID) ([]database.WorkspaceBuildsWithInitiator, error) {
 	q.mutex.RLock()
 	defer q.mutex.RUnlock()
 
-	builds := make(map[uuid.UUID]database.WorkspaceBuild)
+	builds := make(map[uuid.UUID]database.WorkspaceBuildsWithInitiator)
 	buildNumbers := make(map[uuid.UUID]int32)
 	for _, workspaceBuild := range q.workspaceBuilds {
 		for _, id := range ids {
 			if id.String() == workspaceBuild.WorkspaceID.String() && workspaceBuild.BuildNumber > buildNumbers[id] {
-				builds[id] = workspaceBuild
+				builds[id] = q.workspaceBuildWithInitiator(workspaceBuild)
 				buildNumbers[id] = workspaceBuild.BuildNumber
 			}
 		}
 	}
-	var returnBuilds []database.WorkspaceBuild
+	var returnBuilds []database.WorkspaceBuildsWithInitiator
 	for i, n := range buildNumbers {
 		if n > 0 {
 			b := builds[i]
@@ -546,19 +546,19 @@ func (q *fakeQuerier) GetLatestWorkspaceBuildsByWorkspaceIDs(_ context.Context,
 }
 
 func (q *fakeQuerier) GetWorkspaceBuildByWorkspaceID(_ context.Context,
-	params database.GetWorkspaceBuildByWorkspaceIDParams) ([]database.WorkspaceBuild, error) {
+	params database.GetWorkspaceBuildByWorkspaceIDParams) ([]database.WorkspaceBuildsWithInitiator, error) {
 	q.mutex.RLock()
 	defer q.mutex.RUnlock()
 
-	history := make([]database.WorkspaceBuild, 0)
+	history := make([]database.WorkspaceBuildsWithInitiator, 0)
 	for _, workspaceBuild := range q.workspaceBuilds {
 		if workspaceBuild.WorkspaceID.String() == params.WorkspaceID.String() {
-			history = append(history, workspaceBuild)
+			history = append(history, q.workspaceBuildWithInitiator(workspaceBuild))
 		}
 	}
 
 	// Order by build_number
-	slices.SortFunc(history, func(a, b database.WorkspaceBuild) bool {
+	slices.SortFunc(history, func(a, b database.WorkspaceBuildsWithInitiator) bool {
 		// use greater than since we want descending order
 		return a.BuildNumber > b.BuildNumber
 	})
@@ -600,7 +600,7 @@ func (q *fakeQuerier) GetWorkspaceBuildByWorkspaceID(_ context.Context,
 	return history, nil
 }
 
-func (q *fakeQuerier) GetWorkspaceBuildByWorkspaceIDAndName(_ context.Context, arg database.GetWorkspaceBuildByWorkspaceIDAndNameParams) (database.WorkspaceBuild, error) {
+func (q *fakeQuerier) GetWorkspaceBuildByWorkspaceIDAndName(_ context.Context, arg database.GetWorkspaceBuildByWorkspaceIDAndNameParams) (database.WorkspaceBuildsWithInitiator, error) {
 	q.mutex.RLock()
 	defer q.mutex.RUnlock()
 
@@ -611,9 +611,33 @@ func (q *fakeQuerier) GetWorkspaceBuildByWorkspaceIDAndName(_ context.Context, a
 		if !strings.EqualFold(workspaceBuild.Name, arg.Name) {
 			continue
 		}
-		return workspaceBuild, nil
+
+		return q.workspaceBuildWithInitiator(workspaceBuild), nil
+	}
+	return database.WorkspaceBuildsWithInitiator{}, sql.ErrNoRows
+}
+
+func (q *fakeQuerier) workspaceBuildWithInitiator(build database.WorkspaceBuild) database.WorkspaceBuildsWithInitiator {
+	username := "unknown"
+	usr, err := q.GetUserByID(context.Background(), build.InitiatorID)
+	if err == nil {
+		username = usr.Username
+	}
+	return database.WorkspaceBuildsWithInitiator{
+		ID:                build.ID,
+		CreatedAt:         build.CreatedAt,
+		UpdatedAt:         build.UpdatedAt,
+		WorkspaceID:       build.WorkspaceID,
+		TemplateVersionID: build.TemplateVersionID,
+		Name:              build.Name,
+		BuildNumber:       build.BuildNumber,
+		Transition:        build.Transition,
+		InitiatorID:       build.InitiatorID,
+		ProvisionerState:  build.ProvisionerState,
+		JobID:             build.JobID,
+		Deadline:          build.Deadline,
+		InitiatorUsername: username,
 	}
-	return database.WorkspaceBuild{}, sql.ErrNoRows
 }
 
 func (q *fakeQuerier) GetWorkspacesByOrganizationIDs(_ context.Context, req database.GetWorkspacesByOrganizationIDsParams) ([]database.Workspace, error) {

diff --git a/coderd/database/dump.sql b/coderd/database/dump.sql
diff --git a/coderd/database/migrations/000022_workspace_builds_with_initiaitor_view.down.sql b/coderd/database/migrations/000022_workspace_builds_with_initiaitor_view.down.sql
@@ -0,0 +1 @@
+DROP VIEW IF EXISTS workspace_builds_with_initiator;
diff --git a/coderd/database/migrations/000022_workspace_builds_with_initiaitor_view.up.sql b/coderd/database/migrations/000022_workspace_builds_with_initiaitor_view.up.sql
@@ -0,0 +1,7 @@
+-- This view adds the initiator name to the query for UI purposes.
+-- Showing the initiator user ID is not very friendly.
+CREATE VIEW workspace_builds_with_initiator AS
+-- If the user is nil, just use 'unknown' for now.
+SELECT workspace_builds.*, coalesce(users.username, 'unknown') AS initiator_username
+FROM workspace_builds
+		 LEFT JOIN users ON workspace_builds.initiator_id = users.id;
diff --git a/coderd/database/models.go b/coderd/database/models.go
diff --git a/coderd/database/querier.go b/coderd/database/querier.go
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		DROP VIEW IF EXISTS workspace_builds_with_initiator;