chore: insert audit log entries for organization CRUD

Emyrk · Emyrk · commit 6d19f4e39fbe · 2024-06-25T07:53:54.000-05:00
diff --git a/coderd/audit/diff.go b/coderd/audit/diff.go
@@ -23,7 +23,8 @@ type Auditable interface {
 		database.OAuth2ProviderApp |
 		database.OAuth2ProviderAppSecret |
 		database.CustomRole |
-		database.AuditableOrganizationMember
+		database.AuditableOrganizationMember |
+		database.Organization
 }
 
 // Map is a map of changed fields in an audited resource. It maps field names to
diff --git a/coderd/audit/request.go b/coderd/audit/request.go
@@ -107,6 +107,8 @@ func ResourceTarget[T Auditable](tgt T) string {
 		return typed.Name
 	case database.AuditableOrganizationMember:
 		return typed.Username
+	case database.Organization:
+		return typed.Name
 	default:
 		panic(fmt.Sprintf("unknown resource %T for ResourceTarget", tgt))
 	}
@@ -148,6 +150,8 @@ func ResourceID[T Auditable](tgt T) uuid.UUID {
 		return typed.ID
 	case database.AuditableOrganizationMember:
 		return typed.UserID
+	case database.Organization:
+		return typed.ID
 	default:
 		panic(fmt.Sprintf("unknown resource %T for ResourceID", tgt))
 	}
@@ -187,6 +191,8 @@ func ResourceType[T Auditable](tgt T) database.ResourceType {
 		return database.ResourceTypeCustomRole
 	case database.AuditableOrganizationMember:
 		return database.ResourceTypeOrganizationMember
+	case database.Organization:
+		return database.ResourceTypeOrganization
 	default:
 		panic(fmt.Sprintf("unknown resource %T for ResourceType", typed))
 	}
@@ -227,6 +233,8 @@ func ResourceRequiresOrgID[T Auditable]() bool {
 		return true
 	case database.AuditableOrganizationMember:
 		return true
+	case database.Organization:
+		return true
 	default:
 		panic(fmt.Sprintf("unknown resource %T for ResourceRequiresOrgID", tgt))
 	}
diff --git a/coderd/organizations.go b/coderd/organizations.go
@@ -9,6 +9,7 @@ import (
 	"github.com/google/uuid"
 	"golang.org/x/xerrors"
 
+	"github.com/coder/coder/v2/coderd/audit"
 	"github.com/coder/coder/v2/coderd/database"
 	"github.com/coder/coder/v2/coderd/database/dbtime"
 	"github.com/coder/coder/v2/coderd/httpapi"
@@ -41,8 +42,22 @@ func (*API) organization(rw http.ResponseWriter, r *http.Request) {
 // @Success 201 {object} codersdk.Organization
 // @Router /organizations [post]
 func (api *API) postOrganizations(rw http.ResponseWriter, r *http.Request) {
-	ctx := r.Context()
-	apiKey := httpmw.APIKey(r)
+	var (
+		// organizationID is required before the audit log entry is created.
+		organizationID    = uuid.New()
+		ctx               = r.Context()
+		apiKey            = httpmw.APIKey(r)
+		auditor           = api.Auditor.Load()
+		aReq, commitAudit = audit.InitRequest[database.Organization](rw, &audit.RequestParams{
+			Audit:          *auditor,
+			Log:            api.Logger,
+			Request:        r,
+			Action:         database.AuditActionCreate,
+			OrganizationID: organizationID,
+		})
+	)
+	aReq.Old = database.Organization{}
+	defer commitAudit()
 
 	var req codersdk.CreateOrganizationRequest
 	if !httpapi.Read(ctx, rw, r, &req) {
@@ -78,7 +93,7 @@ func (api *API) postOrganizations(rw http.ResponseWriter, r *http.Request) {
 		}
 
 		organization, err = tx.InsertOrganization(ctx, database.InsertOrganizationParams{
-			ID:          uuid.New(),
+			ID:          organizationID,
 			Name:        req.Name,
 			DisplayName: req.DisplayName,
 			Description: req.Description,
@@ -119,6 +134,7 @@ func (api *API) postOrganizations(rw http.ResponseWriter, r *http.Request) {
 		return
 	}
 
+	aReq.New = organization
 	httpapi.Write(ctx, rw, http.StatusCreated, convertOrganization(organization))
 }
 
diff --git a/enterprise/audit/table.go b/enterprise/audit/table.go
@@ -254,6 +254,16 @@ var auditableResourcesTypes = map[any]map[string]Action{
 		"app_id":         ActionIgnore,
 		"secret_prefix":  ActionIgnore,
 	},
+	&database.Organization{}: {
+		"id":           ActionIgnore,
+		"name":         ActionTrack,
+		"description":  ActionTrack,
+		"created_at":   ActionIgnore,
+		"updated_at":   ActionTrack,
+		"is_default":   ActionTrack,
+		"display_name": ActionTrack,
+		"icon":         ActionTrack,
+	},
 }
 
 // auditMap converts a map of struct pointers to a map of struct names as

Original file line number	Diff line number	Diff line change
`@@ -23,7 +23,8 @@ type Auditable interface {`
`23`	`23`	`database.OAuth2ProviderApp \|`
`24`	`24`	`database.OAuth2ProviderAppSecret \|`
`25`	`25`	`database.CustomRole \|`
`26`		`- database.AuditableOrganizationMember`
	`26`	`+ database.AuditableOrganizationMember \|`
	`27`	`+ database.Organization`
`27`	`28`	`}`
`28`	`29`
`29`	`30`	`// Map is a map of changed fields in an audited resource. It maps field names to`