coder · Kira-Pilot · Oct 27, 2022 · Oct 24, 2022 · Oct 26, 2022 · Oct 26, 2022
diff --git a/coderd/audit.go b/coderd/audit.go
@@ -1,6 +1,7 @@
 package coderd
 
 import (
+	"context"
 	"encoding/json"
 	"fmt"
 	"net"
@@ -13,6 +14,7 @@ import (
 	"github.com/google/uuid"
 	"github.com/tabbed/pqtype"
 
+	"cdr.dev/slog"
 	"github.com/coder/coder/coderd/database"
 	"github.com/coder/coder/coderd/httpapi"
 	"github.com/coder/coder/coderd/httpmw"
@@ -57,7 +59,7 @@ func (api *API) auditLogs(rw http.ResponseWriter, r *http.Request) {
 	}
 
 	httpapi.Write(ctx, rw, http.StatusOK, codersdk.AuditLogResponse{
-		AuditLogs: convertAuditLogs(dblogs),
+		AuditLogs: api.convertAuditLogs(ctx, dblogs),
 	})
 }
 
@@ -165,17 +167,17 @@ func (api *API) generateFakeAuditLog(rw http.ResponseWriter, r *http.Request) {
 	rw.WriteHeader(http.StatusNoContent)
 }
 
-func convertAuditLogs(dblogs []database.GetAuditLogsOffsetRow) []codersdk.AuditLog {
+func (api *API) convertAuditLogs(ctx context.Context, dblogs []database.GetAuditLogsOffsetRow) []codersdk.AuditLog {
 	alogs := make([]codersdk.AuditLog, 0, len(dblogs))
 
 	for _, dblog := range dblogs {
-		alogs = append(alogs, convertAuditLog(dblog))
+		alogs = append(alogs, api.convertAuditLog(ctx, dblog))
 	}
 
 	return alogs
 }
 
-func convertAuditLog(dblog database.GetAuditLogsOffsetRow) codersdk.AuditLog {
+func (api *API) convertAuditLog(ctx context.Context, dblog database.GetAuditLogsOffsetRow) codersdk.AuditLog {
 	ip, _ := netip.AddrFromSlice(dblog.Ip.IPNet.IP)
 
 	diff := codersdk.AuditDiff{}
@@ -214,7 +216,7 @@ func convertAuditLog(dblog database.GetAuditLogsOffsetRow) codersdk.AuditLog {
 		Diff:             diff,
 		StatusCode:       dblog.StatusCode,
 		AdditionalFields: dblog.AdditionalFields,
-		Description:      auditLogDescription(dblog),
+		Description:      api.auditLogDescription(ctx, dblog),
 		User:             user,
 	}
 }
@@ -223,25 +225,30 @@ type WorkspaceResourceInfo struct {
 	WorkspaceName string
 }
 
-func auditLogDescription(alog database.GetAuditLogsOffsetRow) string {
+func (api *API) auditLogDescription(ctx context.Context, alog database.GetAuditLogsOffsetRow) string {
 	str := fmt.Sprintf("{user} %s %s",
 		codersdk.AuditAction(alog.Action).FriendlyString(),
 		codersdk.ResourceType(alog.ResourceType).FriendlyString(),
 	)
 
 	// Strings for build updates follow the below format:
-	// "{user} started workspace build for workspace {target}"
+	// "{user} started workspace build for {target}"
 	// where target is a workspace instead of the workspace build
 	if alog.ResourceType == database.ResourceTypeWorkspaceBuild {
 		workspaceBytes := []byte(alog.AdditionalFields)
 		var workspaceResourceInfo WorkspaceResourceInfo
-		_ = json.Unmarshal(workspaceBytes, &workspaceResourceInfo)
-		str += " for workspace " + workspaceResourceInfo.WorkspaceName
+		err := json.Unmarshal(workspaceBytes, &workspaceResourceInfo)
+		if err != nil {
+			api.Logger.Error(ctx, "could not unmarshal workspace name for friendly string", slog.Error(err))
+		}
+		str += " for " + workspaceResourceInfo.WorkspaceName
-		workspaceBytes := []byte(alog.AdditionalFields)
-		var workspaceResourceInfo WorkspaceResourceInfo
-		_ = json.Unmarshal(workspaceBytes, &workspaceResourceInfo)
-		str += " for workspace " + workspaceResourceInfo.WorkspaceName
-		err := json.Unmarshal(workspaceBytes, &workspaceResourceInfo)
-		if err != nil {
-			api.Logger.Error(ctx, "could not unmarshal workspace name for friendly string", slog.Error(err))
-		}
-		str += " for " + workspaceResourceInfo.WorkspaceName
+		str += " for {target}"
-		workspaceBytes := []byte(alog.AdditionalFields)
-		var workspaceResourceInfo WorkspaceResourceInfo
-		_ = json.Unmarshal(workspaceBytes, &workspaceResourceInfo)
-		str += " for workspace " + workspaceResourceInfo.WorkspaceName
-		err := json.Unmarshal(workspaceBytes, &workspaceResourceInfo)
-		if err != nil {
-			api.Logger.Error(ctx, "could not unmarshal workspace name for friendly string", slog.Error(err))
-		}
-		str += " for " + workspaceResourceInfo.WorkspaceName
+		str += " for {target}"
 	}
 
 	// We don't display the name for git ssh keys. It's fairly long and doesn't
 	// make too much sense to display.
-	if alog.ResourceType != database.ResourceTypeGitSshKey {
+
+	// The UI-visible target for workspace builds is workspace (see above block) so we don't add it to the friendly string
+	if alog.ResourceType != database.ResourceTypeGitSshKey && alog.ResourceType != database.ResourceTypeWorkspaceBuild {
 		str += " {target}"
 	}
 

diff --git a/coderd/audit/request.go b/coderd/audit/request.go
@@ -46,7 +46,7 @@ func ResourceTarget[T Auditable](tgt T) string {
 		return typed.Name
 	case database.WorkspaceBuild:
 		// this isn't used
-		return string(typed.BuildNumber)
+		return ""
 	case database.GitSSHKey:
 		return typed.PublicKey
 	case database.Group:

diff --git a/coderd/workspacebuilds_test.go b/coderd/workspacebuilds_test.go
@@ -536,13 +536,20 @@ func TestWorkspaceBuildStatus(t *testing.T) {
 	ctx, cancel := context.WithTimeout(context.Background(), testutil.WaitLong)
 	defer cancel()
 	auditor := audit.NewMock()
+	numLogs := len(auditor.AuditLogs)
 	client, closeDaemon, api := coderdtest.NewWithAPI(t, &coderdtest.Options{IncludeProvisionerDaemon: true, Auditor: auditor})
 	user := coderdtest.CreateFirstUser(t, client)
+	numLogs++ // add an audit log for user
 	version := coderdtest.CreateTemplateVersion(t, client, user.OrganizationID, nil)
+	numLogs++ // add an audit log for template version
+
 	coderdtest.AwaitTemplateVersionJob(t, client, version.ID)
 	closeDaemon.Close()
 	template := coderdtest.CreateTemplate(t, client, user.OrganizationID, version.ID)
+	numLogs++ // add an audit log for template creation
+
 	workspace := coderdtest.CreateWorkspace(t, client, user.OrganizationID, template.ID)
+	numLogs++ // add an audit log for workspace creation
 
 	// initial returned state is "pending"
 	require.EqualValues(t, codersdk.WorkspaceStatusPending, workspace.LatestBuild.Status)
@@ -561,11 +568,22 @@ func TestWorkspaceBuildStatus(t *testing.T) {
 	require.NoError(t, err)
 	require.EqualValues(t, codersdk.WorkspaceStatusStopped, workspace.LatestBuild.Status)
 
+	// assert an audit log has been created for workspace stopping
+	numLogs++ // add an audit log for workspace_build stop
+	require.Len(t, auditor.AuditLogs, numLogs)
+	require.Equal(t, database.AuditActionStop, auditor.AuditLogs[numLogs-1].Action)
+
 	_ = closeDaemon.Close()
 	// after successful cancel is "canceled"
 	build = coderdtest.CreateWorkspaceBuild(t, client, workspace, database.WorkspaceTransitionStart)
 	err = client.CancelWorkspaceBuild(ctx, build.ID)
 	require.NoError(t, err)
+
+	numLogs++ // add an audit log for workspace build start
+	// assert an audit log has been created workspace starting
+	require.Len(t, auditor.AuditLogs, numLogs)
+	require.Equal(t, database.AuditActionStart, auditor.AuditLogs[numLogs-1].Action)
+
 	workspace, err = client.Workspace(ctx, workspace.ID)
 	require.NoError(t, err)
 	require.EqualValues(t, codersdk.WorkspaceStatusCanceled, workspace.LatestBuild.Status)
@@ -577,8 +595,9 @@ func TestWorkspaceBuildStatus(t *testing.T) {
 	workspace, err = client.DeletedWorkspace(ctx, workspace.ID)
 	require.NoError(t, err)
 	require.EqualValues(t, codersdk.WorkspaceStatusDeleted, workspace.LatestBuild.Status)
+	numLogs++ // add an audit log for workspace build deletion
 
 	// assert an audit log has been created for deletion
-	require.Len(t, auditor.AuditLogs, 7)
-	assert.Equal(t, database.AuditActionDelete, auditor.AuditLogs[6].Action)
+	require.Len(t, auditor.AuditLogs, numLogs)
+	require.Equal(t, database.AuditActionDelete, auditor.AuditLogs[numLogs-1].Action)
 }
diff --git a/docs/admin/audit-logs.md b/docs/admin/audit-logs.md
@@ -11,6 +11,7 @@ We track **create, update and delete** events for the following resources:
 - Template
 - TemplateVersion
 - Workspace
+- Workspace start/stop
 - User
 - Group
 

diff --git a/site/src/components/AuditLogRow/AuditLogRow.stories.tsx b/site/src/components/AuditLogRow/AuditLogRow.stories.tsx
@@ -5,7 +5,11 @@ import TableContainer from "@material-ui/core/TableContainer"
 import TableHead from "@material-ui/core/TableHead"
 import TableRow from "@material-ui/core/TableRow"
 import { ComponentMeta, Story } from "@storybook/react"
-import { MockAuditLog, MockAuditLog2 } from "testHelpers/entities"
+import {
+  MockAuditLog,
+  MockAuditLog2,
+  MockAuditLogWithWorkspaceBuild,
+} from "testHelpers/entities"
 import { AuditLogRow, AuditLogRowProps } from "./AuditLogRow"
 
 export default {
@@ -38,3 +42,8 @@ WithDiff.args = {
   auditLog: MockAuditLog2,
   defaultIsDiffOpen: true,
 }
+
+export const WithWorkspaceBuild = Template.bind({})
+WithWorkspaceBuild.args = {
+  auditLog: MockAuditLogWithWorkspaceBuild,
+}
diff --git a/site/src/components/AuditLogRow/AuditLogRow.tsx b/site/src/components/AuditLogRow/AuditLogRow.tsx
@@ -31,6 +31,14 @@ const pillTypeByHttpStatus = (
 }
 
 const readableActionMessage = (auditLog: AuditLog) => {
+  // workspace builds audit logs don't have targets; therefore format them differently
+  if (auditLog.resource_type === "workspace_build") {
+    const substr = auditLog.description.trim().split(" ").pop() ?? ""
+    return auditLog.description
+      .replace("{user}", `<strong>${auditLog.user?.username}</strong>`)
+      .replace(substr, `<strong>${substr}</strong>`)
+  }
+
   return auditLog.description
     .replace("{user}", `<strong>${auditLog.user?.username}</strong>`)
     .replace("{target}", `<strong>${auditLog.resource_target}</strong>`)

diff --git a/site/src/testHelpers/entities.ts b/site/src/testHelpers/entities.ts
@@ -949,6 +949,15 @@ export const MockAuditLog2: TypesGen.AuditLog = {
   },
 }
 
+export const MockAuditLogWithWorkspaceBuild: TypesGen.AuditLog = {
+  ...MockAuditLog,
+  id: "f90995bf-4a2b-4089-b597-e66e025e523e",
+  request_id: "61555889-2875-475c-8494-f7693dd5d75b",
+  action: "stop",
+  resource_type: "workspace_build",
+  description: "{user} stopped workspace build for workspace test2",
+}
+
 export const MockWorkspaceQuota: TypesGen.WorkspaceQuota = {
   user_workspace_count: 0,
   user_workspace_limit: 100,