add cancellable audit log v2

Emyrk · Emyrk · commit 806c28413bbc · 2024-07-19T15:31:17.000-05:00
diff --git a/coderd/audit/request.go b/coderd/audit/request.go
@@ -267,18 +267,21 @@ func requireOrgID[T Auditable](ctx context.Context, id uuid.UUID, log slog.Logge
 	return id
 }
 
-// InitRequestWithCancel returns 2 functions. The first commits the audit log,
-// the second cancels any future calls to commit.
-func InitRequestWithCancel[T Auditable](w http.ResponseWriter, p *RequestParams) (aReq *Request[T], commit func(), cancel func()) {
-	req, commit := InitRequest[T](w, p)
-	canceled := false
-	return req, func() {
-			if !canceled {
-				commit()
-			}
-		}, func() {
-			canceled = true
+// InitRequestWithCancel returns a commit function with a boolean arg.
+// If the arg is false, future calls to commit() will not create an audit log
+// entry.
+func InitRequestWithCancel[T Auditable](w http.ResponseWriter, p *RequestParams) (*Request[T], func(commit bool)) {
+	req, commitF := InitRequest[T](w, p)
+	cancelled := false
+	return req, func(commit bool) {
+		if !commit {
+			cancelled = true
+			return
 		}
+		if !cancelled {
+			commitF()
+		}
+	}
 }
 
 // InitRequest initializes an audit log for a request. It returns a function
diff --git a/enterprise/coderd/scim.go b/enterprise/coderd/scim.go
@@ -272,14 +272,14 @@ func (api *API) scimPatchUser(rw http.ResponseWriter, r *http.Request) {
 	}
 
 	auditor := *api.AGPL.Auditor.Load()
-	aReq, commitAudit, cancelAudit := audit.InitRequestWithCancel[database.User](rw, &audit.RequestParams{
+	aReq, commitAudit := audit.InitRequestWithCancel[database.User](rw, &audit.RequestParams{
 		Audit:   auditor,
 		Log:     api.Logger,
 		Request: r,
 		Action:  database.AuditActionWrite,
 	})
 
-	defer commitAudit()
+	defer commitAudit(true)
 
 	id := chi.URLParam(r, "id")
 
@@ -338,7 +338,7 @@ func (api *API) scimPatchUser(rw http.ResponseWriter, r *http.Request) {
 		dbUser = userNew
 	} else {
 		// Do not push an audit log if there is no change.
-		cancelAudit()
+		commitAudit(false)
 	}
 
 	aReq.New = dbUser
