Article API: extract common base fields in audit log events (#60074)

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Author: heiskr

src/article-api/templates/audit-logs-page.template.md

@@ -6,6 +6,14 @@
 
 ## Audit log events
 
+{% if baseFields.size > 0 %}
+### Common fields
+
+The following fields are included in most audit log events: {% for field in baseFields %}`{{ field }}`{% unless forloop.last %}, {% endunless %}{% endfor %}
+
+Each event below lists only its additional fields beyond these common fields.
+
+{% endif %}
 {% for categoryEntry in categorizedEvents %}
 {% assign categoryName = categoryEntry[0] %}
 {% assign events = categoryEntry[1] %}
@@ -20,7 +28,7 @@
 
 {{ event.description }}
 
-**Fields:** {% if event.fields %}{% for field in event.fields %}`{{ field }}`{% unless forloop.last %}, {% endunless %}{% endfor %}{% else %}No fields available{% endif %}
+{% if event.fields.size > 0 %}**Additional fields:** {% for field in event.fields %}`{{ field }}`{% unless forloop.last %}, {% endunless %}{% endfor %}{% endif %}
 
 {% if event.docs_reference_links and event.docs_reference_links != 'N/A' %}
 **Reference:** {{ event.docs_reference_links }}

src/article-api/tests/audit-logs-transformer.ts

@@ -76,8 +76,30 @@ describe('Audit Logs transformer', () => {
     // #### `action.name`
     expect(res.body).toMatch(/#### `[\w.]+`/)
 
-    // Check for fields section
-    expect(res.body).toContain('**Fields:**')
+    // Check for fields section - either common fields summary or additional fields per event
+    const body = res.body
+    const hasCommonFields = body.includes('### Common fields')
+    const hasAdditionalFields = body.includes('**Additional fields:**')
+    expect(hasCommonFields || hasAdditionalFields).toBe(true)
+
+    // Validate that a known common field is in the common section and not duplicated
+    if (hasCommonFields) {
+      const commonFieldsIndex = body.indexOf('### Common fields')
+      const commonFieldsSection = body.slice(
+        commonFieldsIndex,
+        body.indexOf('\n###', commonFieldsIndex + 1),
+      )
+      expect(commonFieldsSection).toContain('`action`')
+    }
+
+    // Ensure common fields do not appear in any "Additional fields" section
+    if (hasAdditionalFields) {
+      const additionalSections = body.split('**Additional fields:**').slice(1)
+      for (const section of additionalSections) {
+        const fieldsLine = section.split('\n')[0]
+        expect(fieldsLine).not.toContain('`action`')
+      }
+    }
 
     // Check for reference section
     expect(res.body).toContain('**Reference:**')

src/article-api/transformers/audit-logs-transformer.ts

@@ -99,7 +99,8 @@ export class AuditLogsTransformer implements PageTransformer {
     // Prepare page intro
     const intro = page.intro ? await page.renderProp('intro', context, { textOnly: true }) : ''
 
-    // Sort categories and events
+    // Sort categories and events, and compute fields shared by most (≥80%) events
+    const allFieldSets: string[][] = []
     const sortedCategorizedEvents: CategorizedEvents = {}
     const sortedCategories = Object.keys(categorizedEvents).sort((a, b) => a.localeCompare(b))
 
@@ -117,11 +118,37 @@ export class AuditLogsTransformer implements PageTransformer {
               context,
             )
           }
+          if (newEvent.fields) {
+            allFieldSets.push(newEvent.fields)
+          }
           return newEvent
         }),
       )
     }
 
+    // Compute base fields that appear in ≥80% of events
+    const fieldCounts = new Map<string, number>()
+    for (const fields of allFieldSets) {
+      for (const f of fields) {
+        fieldCounts.set(f, (fieldCounts.get(f) || 0) + 1)
+      }
+    }
+    const threshold = allFieldSets.length * 0.8
+    const baseFields = [...fieldCounts.entries()]
+      .filter(([, count]) => count >= threshold)
+      .map(([field]) => field)
+      .sort()
+
+    // Remove base fields from each event's field list
+    const baseFieldSet = new Set(baseFields)
+    for (const category of Object.keys(sortedCategorizedEvents)) {
+      for (const event of sortedCategorizedEvents[category]) {
+        if (event.fields) {
+          event.fields = event.fields.filter((f: string) => !baseFieldSet.has(f))
+        }
+      }
+    }
+
     return {
       page: {
         title: page.title,
@@ -130,6 +157,7 @@ export class AuditLogsTransformer implements PageTransformer {
       manualContent,
       categorizedEvents: sortedCategorizedEvents,
       categoryNotes,
+      baseFields,
     }
   }
 }