chore: new workspace view to join in owner, template, and org

Previously this data was fetched via seperate queries. This caused an issue in orgs, as users are site wide scoped. So user read access was required to read another user's username. Now it is all joined into the workspace, implcitly giving read perms to some fields in related objects.
coder · Emyrk · Oct 22, 2024 · Oct 16, 2024 · Oct 16, 2024 · Oct 16, 2024
commit 4967b6bb648a9a72f883b0e9f102162ba58ab012
diff --git a/coderd/activitybump_test.go b/coderd/activitybump_test.go
@@ -199,7 +199,7 @@ func TestWorkspaceActivityBump(t *testing.T) {
 		t.Parallel()
 
 		client, workspace, assertBumped := setupActivityTest(t)
-
+		Access - Control - Allow - Origin
 		resources := coderdtest.AwaitWorkspaceAgents(t, client, workspace.ID)
 		conn, err := workspacesdk.New(client).
 			DialAgent(ctx, resources[0].Agents[0].ID, &workspacesdk.DialAgentOptions{

diff --git a/coderd/agentapi/api.go b/coderd/agentapi/api.go
@@ -106,7 +106,7 @@ func New(opts Options) *API {
 			if err != nil {
 				return uuid.Nil, err
 			}
-			return ws.Workspace.ID, nil
+			return ws.ID, nil
 		},
 	}
 
@@ -231,9 +231,9 @@ func (a *API) workspaceID(ctx context.Context, agent *database.WorkspaceAgent) (
 	}
 
 	a.mu.Lock()
-	a.cachedWorkspaceID = getWorkspaceAgentByIDRow.Workspace.ID
+	a.cachedWorkspaceID = getWorkspaceAgentByIDRow.ID
 	a.mu.Unlock()
-	return getWorkspaceAgentByIDRow.Workspace.ID, nil
+	return getWorkspaceAgentByIDRow.ID, nil
 }
 
 func (a *API) publishWorkspaceUpdate(ctx context.Context, agent *database.WorkspaceAgent) error {

diff --git a/coderd/agentapi/stats.go b/coderd/agentapi/stats.go
@@ -50,7 +50,7 @@ func (a *StatsAPI) UpdateStats(ctx context.Context, req *agentproto.UpdateStatsR
 	if err != nil {
 		return nil, xerrors.Errorf("get workspace by agent ID %q: %w", workspaceAgent.ID, err)
 	}
-	workspace := getWorkspaceAgentByIDRow.Workspace
+	workspace := getWorkspaceAgentByIDRow
 	a.Log.Debug(ctx, "read stats report",
 		slog.F("interval", a.AgentStatsRefreshInterval),
 		slog.F("workspace_id", workspace.ID),

diff --git a/coderd/audit/diff.go b/coderd/audit/diff.go
@@ -12,7 +12,7 @@ type Auditable interface {
 		database.Template |
 		database.TemplateVersion |
 		database.User |
-		database.Workspace |
+		database.WorkspaceTable |
 		database.GitSSHKey |
 		database.WorkspaceBuild |
 		database.AuditableGroup |

diff --git a/coderd/autobuild/lifecycle_executor.go b/coderd/autobuild/lifecycle_executor.go
@@ -234,22 +234,25 @@ func (e *Executor) runOnce(t time.Time) Stats {
 					// threshold for inactivity.
 					if reason == database.BuildReasonDormancy {
 						wsOld := ws
-						ws, err = tx.UpdateWorkspaceDormantDeletingAt(e.ctx, database.UpdateWorkspaceDormantDeletingAtParams{
+						wsNew, err := tx.UpdateWorkspaceDormantDeletingAt(e.ctx, database.UpdateWorkspaceDormantDeletingAtParams{
 							ID: ws.ID,
 							DormantAt: sql.NullTime{
 								Time:  dbtime.Now(),
 								Valid: true,
 							},
 						})
 
-						auditLog = &auditParams{
-							Old: wsOld,
-							New: ws,
-						}
 						if err != nil {
 							return xerrors.Errorf("update workspace dormant deleting at: %w", err)
 						}
 
+						auditLog = &auditParams{
+							Old: wsOld.WorkspaceTable(),
+							New: wsNew,
+						}
+						// To keep the `ws` accurate without doing a sql fetch
+						ws.DormantAt = wsNew.DormantAt
+
 						shouldNotifyDormancy = true
 
 						log.Info(e.ctx, "dormant workspace",
@@ -510,8 +513,8 @@ func isEligibleForFailedStop(build database.WorkspaceBuild, job database.Provisi
 }
 
 type auditParams struct {
-	Old     database.Workspace
-	New     database.Workspace
+	Old     database.WorkspaceTable
+	New     database.WorkspaceTable
 	Success bool
 }
 
@@ -521,7 +524,7 @@ func auditBuild(ctx context.Context, log slog.Logger, auditor audit.Auditor, par
 		status = http.StatusOK
 	}
 
-	audit.BackgroundAudit(ctx, &audit.BackgroundAuditParams[database.Workspace]{
+	audit.BackgroundAudit(ctx, &audit.BackgroundAuditParams[database.WorkspaceTable]{
 		Audit:          auditor,
 		Log:            log,
 		UserID:         params.New.OwnerID,

diff --git a/coderd/database/dbauthz/dbauthz.go b/coderd/database/dbauthz/dbauthz.go
@@ -2574,7 +2574,7 @@ func (q *querier) GetWorkspaceBuildsCreatedAfter(ctx context.Context, createdAt
 	return q.db.GetWorkspaceBuildsCreatedAfter(ctx, createdAt)
 }
 
-func (q *querier) GetWorkspaceByAgentID(ctx context.Context, agentID uuid.UUID) (database.GetWorkspaceByAgentIDRow, error) {
+func (q *querier) GetWorkspaceByAgentID(ctx context.Context, agentID uuid.UUID) (database.Workspace, error) {
 	return fetch(q.log, q.auth, q.db.GetWorkspaceByAgentID)(ctx, agentID)
 }
 
@@ -2719,7 +2719,7 @@ func (q *querier) GetWorkspaces(ctx context.Context, arg database.GetWorkspacesP
 	return q.db.GetAuthorizedWorkspaces(ctx, arg, prep)
 }
 
-func (q *querier) GetWorkspacesEligibleForTransition(ctx context.Context, now time.Time) ([]database.Workspace, error) {
+func (q *querier) GetWorkspacesEligibleForTransition(ctx context.Context, now time.Time) ([]database.WorkspaceTable, error) {
 	return q.db.GetWorkspacesEligibleForTransition(ctx, now)
 }
 
@@ -3009,7 +3009,7 @@ func (q *querier) InsertUserLink(ctx context.Context, arg database.InsertUserLin
 	return q.db.InsertUserLink(ctx, arg)
 }
 
-func (q *querier) InsertWorkspace(ctx context.Context, arg database.InsertWorkspaceParams) (database.Workspace, error) {
+func (q *querier) InsertWorkspace(ctx context.Context, arg database.InsertWorkspaceParams) (database.WorkspaceTable, error) {
 	obj := rbac.ResourceWorkspace.WithOwner(arg.OwnerID.String()).InOrg(arg.OrganizationID)
 	return insert(q.log, q.auth, obj, q.db.InsertWorkspace)(ctx, arg)
 }
@@ -3751,9 +3751,13 @@ func (q *querier) UpdateUserStatus(ctx context.Context, arg database.UpdateUserS
 	return updateWithReturn(q.log, q.auth, fetch, q.db.UpdateUserStatus)(ctx, arg)
 }
 
-func (q *querier) UpdateWorkspace(ctx context.Context, arg database.UpdateWorkspaceParams) (database.Workspace, error) {
-	fetch := func(ctx context.Context, arg database.UpdateWorkspaceParams) (database.Workspace, error) {
-		return q.db.GetWorkspaceByID(ctx, arg.ID)
+func (q *querier) UpdateWorkspace(ctx context.Context, arg database.UpdateWorkspaceParams) (database.WorkspaceTable, error) {
+	fetch := func(ctx context.Context, arg database.UpdateWorkspaceParams) (database.WorkspaceTable, error) {
+		w, err := q.db.GetWorkspaceByID(ctx, arg.ID)
+		if err != nil {
+			return database.WorkspaceTable{}, err
+		}
+		return w.WorkspaceTable(), nil
 	}
 	return updateWithReturn(q.log, q.auth, fetch, q.db.UpdateWorkspace)(ctx, arg)
 }
@@ -3905,9 +3909,13 @@ func (q *querier) UpdateWorkspaceDeletedByID(ctx context.Context, arg database.U
 	return deleteQ(q.log, q.auth, fetch, q.db.UpdateWorkspaceDeletedByID)(ctx, arg)
 }
 
-func (q *querier) UpdateWorkspaceDormantDeletingAt(ctx context.Context, arg database.UpdateWorkspaceDormantDeletingAtParams) (database.Workspace, error) {
-	fetch := func(ctx context.Context, arg database.UpdateWorkspaceDormantDeletingAtParams) (database.Workspace, error) {
-		return q.db.GetWorkspaceByID(ctx, arg.ID)
+func (q *querier) UpdateWorkspaceDormantDeletingAt(ctx context.Context, arg database.UpdateWorkspaceDormantDeletingAtParams) (database.WorkspaceTable, error) {
+	fetch := func(ctx context.Context, arg database.UpdateWorkspaceDormantDeletingAtParams) (database.WorkspaceTable, error) {
+		w, err := q.db.GetWorkspaceByID(ctx, arg.ID)
+		if err != nil {
+			return database.WorkspaceTable{}, err
+		}
+		return w.WorkspaceTable(), nil
 	}
 	return updateWithReturn(q.log, q.auth, fetch, q.db.UpdateWorkspaceDormantDeletingAt)(ctx, arg)
 }
@@ -3940,7 +3948,7 @@ func (q *querier) UpdateWorkspaceTTL(ctx context.Context, arg database.UpdateWor
 	return update(q.log, q.auth, fetch, q.db.UpdateWorkspaceTTL)(ctx, arg)
 }
 
-func (q *querier) UpdateWorkspacesDormantDeletingAtByTemplateID(ctx context.Context, arg database.UpdateWorkspacesDormantDeletingAtByTemplateIDParams) ([]database.Workspace, error) {
+func (q *querier) UpdateWorkspacesDormantDeletingAtByTemplateID(ctx context.Context, arg database.UpdateWorkspacesDormantDeletingAtByTemplateIDParams) ([]database.WorkspaceTable, error) {
 	template, err := q.db.GetTemplateByID(ctx, arg.TemplateID)
 	if err != nil {
 		return nil, xerrors.Errorf("get template by id: %w", err)