adding workspace name to string

coder · Kira-Pilot · Oct 25, 2022 · Oct 18, 2022 · Oct 19, 2022 · Oct 19, 2022
commit ec3e6bf9f2f8f95a6e3075e14661043ad0b0a46c
diff --git a/coderd/audit.go b/coderd/audit.go
@@ -219,6 +219,10 @@ func convertAuditLog(dblog database.GetAuditLogsOffsetRow) codersdk.AuditLog {
 	}
 }
 
+type WorkspaceResourceInfo struct {
+	WorkspaceName string
+}
+
 func auditLogDescription(alog database.GetAuditLogsOffsetRow) string {
 	str := fmt.Sprintf("{user} %s %s",
 		codersdk.AuditAction(alog.Action).FriendlyString(),
@@ -229,7 +233,10 @@ func auditLogDescription(alog database.GetAuditLogsOffsetRow) string {
 	// "{user} started workspace build for workspace {target}"
 	// where target is a workspace instead of the workspace build
 	if alog.ResourceType == database.ResourceTypeWorkspaceBuild {
-		str += " for workspace"
+		workspace_bytes := []byte(alog.AdditionalFields)
+		var workspaceResourceInfo WorkspaceResourceInfo
+		json.Unmarshal(workspace_bytes, &workspaceResourceInfo)
+		str += " for workspace " + workspaceResourceInfo.WorkspaceName
 	}
 
 	// We don't display the name for git ssh keys. It's fairly long and doesn't

diff --git a/coderd/audit/request.go b/coderd/audit/request.go
@@ -20,8 +20,9 @@ type RequestParams struct {
 	Audit Auditor
 	Log   slog.Logger
 
-	Request *http.Request
-	Action  database.AuditAction
+	Request          *http.Request
+	Action           database.AuditAction
+	AdditionalFields json.RawMessage
 }
 
 type Request[T Auditable] struct {
@@ -44,7 +45,8 @@ func ResourceTarget[T Auditable](tgt T) string {
 	case database.Workspace:
 		return typed.Name
 	case database.WorkspaceBuild:
-		return string(typed.Transition)
+		// this isn't used
+		return string(typed.BuildNumber)
 	case database.GitSSHKey:
 		return typed.PublicKey
 	case database.Group:
@@ -149,7 +151,7 @@ func InitRequest[T Auditable](w http.ResponseWriter, p *RequestParams) (*Request
 			Diff:             diffRaw,
 			StatusCode:       int32(sw.Status),
 			RequestID:        httpmw.RequestID(p.Request),
-			AdditionalFields: json.RawMessage("{}"),
+			AdditionalFields: p.AdditionalFields,
 		})
 		if err != nil {
 			p.Log.Error(logCtx, "export audit log", slog.Error(err))

diff --git a/coderd/workspacebuilds.go b/coderd/workspacebuilds.go
@@ -300,12 +300,30 @@ func (api *API) postWorkspaceBuilds(rw http.ResponseWriter, r *http.Request) {
 	// if a user starts/stops a workspace, audit the workspace build
 	if action == rbac.ActionUpdate {
 
+		var auditAction database.AuditAction
+		if createBuild.Transition == codersdk.WorkspaceTransitionStart {
+			auditAction = database.AuditActionStart
+		} else if createBuild.Transition == codersdk.WorkspaceTransitionStop {
+			auditAction = database.AuditActionStop
+		} else {
+			auditAction = database.AuditActionWrite
+		}
+
+		// We pass the workspace name to the Auditor so that it
+		// can form a friendly string for the user.
+		workspaceResourceInfo := map[string]string{
+			"workspaceName": workspace.Name,
+		}
+
+		wri_bytes, _ := json.Marshal(workspaceResourceInfo)
+
 		var (
 			aReq, commitAudit = audit.InitRequest[database.WorkspaceBuild](rw, &audit.RequestParams{
-				Audit:   *auditor,
-				Log:     api.Logger,
-				Request: r,
-				Action:  database.AuditActionWrite,
+				Audit:            *auditor,
+				Log:              api.Logger,
+				Request:          r,
+				Action:           auditAction,
+				AdditionalFields: wri_bytes,
 			})
 		)