fixes based on pr comments

- replaced audit event for reading channel history with document metadata read
- updated description of the event
- added channels and sequence into the audit event for document channel history compaction

Author: RIT3shSapata

base/audit_events.go

@@ -120,8 +120,7 @@ const (
 	AuditIDDocumentImport                AuditID = 55005
 	AuditIDDocumentResync                AuditID = 55006
 	AuditIDDocumentRevoke                AuditID = 55007
-	AuditIDDocumentChannelHistory        AuditID = 55008
-	AuditIDDocumentChannelHistoryCompact AuditID = 55009
+	AuditIDDocumentChannelHistoryCompact AuditID = 55008
 
 	// Document attachments events
 	AuditIDAttachmentCreate AuditID = 55010
@@ -1161,28 +1160,13 @@ var AuditEvents = events{
 		FilteringPermitted: true,
 		EventType:          eventTypeData,
 	},
-	AuditIDDocumentChannelHistory: {
-		Name:        "Document Channel history",
-		Description: "A document channel history was sent to a client",
-		MandatoryFields: AuditFields{
-			AuditFieldDocID: "document id",
-		},
-		mandatoryFieldGroups: []fieldGroup{
-			fieldGroupAuthenticated,
-			fieldGroupKeyspace,
-		},
-		optionalFieldGroups: []fieldGroup{
-			fieldGroupRequest,
-		},
-		EnabledByDefault:   false,
-		FilteringPermitted: true,
-		EventType:          eventTypeData,
-	},
 	AuditIDDocumentChannelHistoryCompact: {
 		Name:        "Document Channel history compact",
-		Description: "A document channel history was compacted by a client",
+		Description: "A document channel history was compacted by the Administrator",
 		MandatoryFields: AuditFields{
-			AuditFieldDocID: "document id",
+			AuditFieldDocID:    "document id",
+			AuditFieldChannels: "channels",
+			AuditFieldSequence: "sequence",
 		},
 		mandatoryFieldGroups: []fieldGroup{
 			fieldGroupAuthenticated,

base/audit_events_fields.go

@@ -86,4 +86,5 @@ const (
 	AuditFieldDocIDs      = "doc_ids"
 	AuditFieldFeedType    = "feed_type"
 	AuditFieldIncludeDocs = "include_docs"
+	AuditFieldSequence    = "seq"
 )

rest/audit_test.go

@@ -2011,64 +2011,12 @@ func TestDocumentChannelHistoryCompactionAudit(t *testing.T) {
 			})
 
 			for _, docID := range tc.docIDs {
-				requireChannelHistoryCompactAuditEvent(t, output, docID)
+				requireDocChannelAuditEvent(t, output, base.AuditIDDocumentChannelHistoryCompact, docID)
 			}
 		})
 	}
 }
 
-func TestDocumentChannelHistoryAudit(t *testing.T) {
-	rt := createAuditLoggingRestTester(t)
-	defer rt.Close()
-
-	dbConfig := rt.NewDbConfig()
-	dbConfig.Logging = &DbLoggingConfig{
-		Audit: &DbAuditLoggingConfig{
-			Enabled: base.Ptr(true),
-			EnabledEvents: base.Ptr([]uint{
-				uint(base.AuditIDDocumentChannelHistory),
-			}),
-		},
-	}
-	RequireStatus(t, rt.CreateDatabase("db", dbConfig), http.StatusCreated)
-
-	testCases := []struct {
-		name  string
-		docID string
-	}{
-		{
-			name:  "existing doc",
-			docID: "existing_doc",
-		},
-	}
-
-	for _, tc := range testCases {
-		rt.Run(tc.name, func(t *testing.T) {
-			rt.CreateTestDoc(tc.docID)
-
-			output := base.AuditLogContents(t, func(t testing.TB) {
-				RequireStatus(t, rt.SendAdminRequest(http.MethodGet, "/{{.keyspace}}/_channel_history/"+tc.docID, ""), http.StatusOK)
-			})
-
-			requireChannelHistoryAuditEvent(t, output, tc.docID)
-		})
-	}
-}
-
-// requireChannelHistoryCompactAuditEvent asserts that exactly one AuditIDDocumentChannelHistoryCompact event
-// was logged for the given docID.
-func requireChannelHistoryCompactAuditEvent(t testing.TB, output []byte, docID string) {
-	t.Helper()
-	requireDocChannelAuditEvent(t, output, base.AuditIDDocumentChannelHistoryCompact, docID)
-}
-
-// requireChannelHistoryAuditEvent asserts that exactly one AuditIDDocumentChannelHistory event
-// was logged for the given docID.
-func requireChannelHistoryAuditEvent(t testing.TB, output []byte, docID string) {
-	t.Helper()
-	requireDocChannelAuditEvent(t, output, base.AuditIDDocumentChannelHistory, docID)
-}
-
 func requireDocChannelAuditEvent(t testing.TB, output []byte, eventID base.AuditID, docID string) {
 	t.Helper()
 	events := jsonLines(t, output)

rest/doc_api.go

@@ -945,7 +945,7 @@ func (h *handler) handleGetDocChannelHistory() error {
 		return err
 	}
 
-	base.Audit(h.ctx(), base.AuditIDDocumentChannelHistory, base.AuditFields{
+	base.Audit(h.ctx(), base.AuditIDDocumentMetadataRead, base.AuditFields{
 		base.AuditFieldDocID: docid,
 	})
 
@@ -988,8 +988,11 @@ func (h *handler) handleCompactDocChannelHistory() error {
 	res := map[string][]string{
 		"compacted_channels": channels,
 	}
+
 	base.Audit(h.ctx(), base.AuditIDDocumentChannelHistoryCompact, base.AuditFields{
-		base.AuditFieldDocID: docid,
+		base.AuditFieldDocID:    docid,
+		base.AuditFieldChannels: channels,
+		base.AuditFieldSequence: req.Seq,
 	})
 
 	h.writeJSON(res)