feat: add description to audit log responses

coder · coadler · Sep 8, 2022 · Sep 7, 2022 · Sep 7, 2022 · Sep 7, 2022
commit af63c44c183c32a8843eb5faeb1dfb519b014c87
diff --git a/coderd/audit.go b/coderd/audit.go
@@ -2,6 +2,7 @@ package coderd
 
 import (
 	"encoding/json"
+	"fmt"
 	"net"
 	"net/http"
 	"net/netip"
@@ -167,7 +168,14 @@ func convertAuditLog(dblog database.GetAuditLogsOffsetRow) codersdk.AuditLog {
 		Diff:             diff,
 		StatusCode:       dblog.StatusCode,
 		AdditionalFields: dblog.AdditionalFields,
-		Description:      "",
+		Description:      auditLogDescription(dblog),
 		User:             user,
 	}
 }
+
+func auditLogDescription(alog database.GetAuditLogsOffsetRow) string {
+	return fmt.Sprintf("{user} %s %s {target}",
+		codersdk.AuditAction(alog.Action).FriendlyString(),
+		codersdk.ResourceType(alog.ResourceType).FriendlyString(),
+	)
+}
diff --git a/coderd/audit_test.go b/coderd/audit_test.go
@@ -4,6 +4,7 @@ import (
 	"context"
 	"testing"
 
+	"github.com/davecgh/go-spew/spew"
 	"github.com/stretchr/testify/require"
 
 	"github.com/coder/coder/coderd/coderdtest"
@@ -29,6 +30,7 @@ func TestAuditLogs(t *testing.T) {
 		alogs, err := client.AuditLogs(ctx, codersdk.Pagination{Limit: 1})
 		require.NoError(t, err)
 
+		spew.Dump(alogs.AuditLogs)
 		require.Equal(t, int64(1), count.Count)
 		require.Len(t, alogs.AuditLogs, 1)
 	})

diff --git a/coderd/database/databasefake/databasefake.go b/coderd/database/databasefake/databasefake.go
@@ -2325,7 +2325,7 @@ func (q *fakeQuerier) GetAuditLogsOffset(ctx context.Context, arg database.GetAu
 			OrganizationID:   alog.OrganizationID,
 			Ip:               alog.Ip,
 			UserAgent:        alog.UserAgent,
-			ResourceType:     database.ResourceType(alog.UserAgent),
+			ResourceType:     alog.ResourceType,
 			ResourceID:       alog.ResourceID,
 			ResourceTarget:   alog.ResourceTarget,
 			ResourceIcon:     alog.ResourceIcon,

diff --git a/coderd/database/dump.sql b/coderd/database/dump.sql
diff --git a/coderd/database/migrations/000018_provisioner_job_type_dry_run.down.sql b/coderd/database/migrations/000018_provisioner_job_type_dry_run.down.sql
@@ -1,9 +1,9 @@
 -- It's not possible to drop enum values from enum types, so the UP has "IF NOT
 -- EXISTS".
 
--- Delete all jobs that use the new enum value.
+-- Delete all audit logs that use the new enum values.
 DELETE FROM
-    provisioner_jobs
+    audit_logs
 WHERE
-    type = 'template_version_dry_run'
-;
+    resource_type = 'git_ssh_key' OR
+    resource_type = 'api_key';
diff --git a/coderd/database/migrations/000045_more_resource_types.down.sql b/coderd/database/migrations/000045_more_resource_types.down.sql
@@ -0,0 +1,8 @@
+-- It's not possible to drop enum values from enum types, so the UP has "IF NOT
+-- EXISTS".
+
+-- Delete all jobs that use the new enum value.
+DELETE FROM
+    provisioner_jobs
+WHERE
+    type = 'template_version_dry_run';
diff --git a/coderd/database/migrations/000045_more_resource_types.up.sql b/coderd/database/migrations/000045_more_resource_types.up.sql
@@ -0,0 +1,2 @@
+ALTER TYPE resource_type ADD VALUE IF NOT EXISTS 'git_ssh_key';
+ALTER TYPE resource_type ADD VALUE IF NOT EXISTS 'api_key';
diff --git a/coderd/database/models.go b/coderd/database/models.go
diff --git a/codersdk/audit.go b/codersdk/audit.go
@@ -18,8 +18,31 @@ const (
 	ResourceTypeTemplateVersion ResourceType = "template_version"
 	ResourceTypeUser            ResourceType = "user"
 	ResourceTypeWorkspace       ResourceType = "workspace"
+	ResourceTypeGitSSHKey       ResourceType = "git_ssh_key"
+	ResourceTypeAPIKey          ResourceType = "api_key"
 )
 
+func (r ResourceType) FriendlyString() string {
+	switch r {
+	case ResourceTypeOrganization:
+		return "organization"
+	case ResourceTypeTemplate:
+		return "template"
+	case ResourceTypeTemplateVersion:
+		return "template version"
+	case ResourceTypeUser:
+		return "user"
+	case ResourceTypeWorkspace:
+		return "workspace"
+	case ResourceTypeGitSSHKey:
+		return "git ssh key"
+	case ResourceTypeAPIKey:
+		return "api key"
+	default:
+		return "unknown"
+	}
+}
+
 type AuditAction string
 
 const (
@@ -28,6 +51,19 @@ const (
 	AuditActionDelete AuditAction = "delete"
 )
 
+func (a AuditAction) FriendlyString() string {
+	switch a {
+	case AuditActionCreate:
+		return "created"
+	case AuditActionWrite:
+		return "updated"
+	case AuditActionDelete:
+		return "deleted"
+	default:
+		return "unknown"
+	}
+}
+
 type AuditDiff map[string]AuditDiffField
 
 type AuditDiffField struct {

diff --git a/site/src/api/typesGenerated.ts b/site/src/api/typesGenerated.ts
@@ -693,7 +693,14 @@ export type ProvisionerStorageMethod = "file"
 export type ProvisionerType = "echo" | "terraform"
 
 // From codersdk/audit.go
-export type ResourceType = "organization" | "template" | "template_version" | "user" | "workspace"
+export type ResourceType =
+  | "api_key"
+  | "git_ssh_key"
+  | "organization"
+  | "template"
+  | "template_version"
+  | "user"
+  | "workspace"
 
 // From codersdk/users.go
 export type UserStatus = "active" | "suspended"
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		ALTER TYPE resource_type ADD VALUE IF NOT EXISTS 'git_ssh_key';
		ALTER TYPE resource_type ADD VALUE IF NOT EXISTS 'api_key';