🧹 Filter audit-log sync to only supported GHES versions (#61110)

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

Author: heiskr

src/audit-logs/lib/index.ts

@@ -2,6 +2,7 @@ import path from 'path'
 
 import { readCompressedJsonFileFallback } from '@/frame/lib/read-json-file'
 import { getOpenApiVersion } from '@/versions/lib/all-versions'
+import { supported as supportedGhesReleases } from '@/versions/lib/enterprise-server-releases'
 import findPage from '@/frame/lib/find-page'
 import type { Context, Page } from '@/types'
 import type {
@@ -300,6 +301,7 @@ export async function filterAndUpdateGhesDataByAllowlistValues({
   auditLogPage,
   titleContext,
   globalFields = [],
+  supportedGhesVersions = supportedGhesReleases,
 }: {
   eventsToCheck: RawAuditLogEventT[]
   allowListValue: string
@@ -308,9 +310,17 @@ export async function filterAndUpdateGhesDataByAllowlistValues({
   auditLogPage: string
   titleContext?: TitleResolutionContext
   globalFields?: string[]
+  supportedGhesVersions?: string[]
 }) {
   if (!currentGhesEvents) currentGhesEvents = {}
 
+  // Upstream `audit-log-allowlists/data/schema.json` lags docs's deprecation
+  // schedule, so events still list `ghes` keys for versions we've already
+  // dropped from `supported` in `enterprise-server-releases.ts`. Without this
+  // filter, the nightly sync would re-add `src/audit-logs/data/ghes-X.Y/`
+  // dirs for those deprecated versions. See docs-engineering#6562.
+  const supportedGhesVersionSet = new Set(supportedGhesVersions)
+
   const seenByGhesVersion = new Map()
   for (const [ghesVersion, events] of Object.entries(currentGhesEvents)) {
     if (!events[auditLogPage]) continue
@@ -320,6 +330,7 @@ export async function filterAndUpdateGhesDataByAllowlistValues({
 
   for (const event of eventsToCheck) {
     for (const ghesVersion of Object.keys(event.ghes)) {
+      if (!supportedGhesVersionSet.has(ghesVersion)) continue
       const ghesVersionAllowlists = event.ghes[ghesVersion]._allowlists
       const fullGhesVersion = `ghes-${ghesVersion}`
 

src/audit-logs/tests/unit/filter-events.ts

@@ -223,11 +223,50 @@ describe('audit log event filtering', () => {
         appendedDescriptions: {},
       },
       auditLogPage,
+      supportedGhesVersions: ['3.10', '3.11', '3.12'],
     })
     const getActions = (version: string) =>
       currentEvents[version][auditLogPage].map((event) => event.action)
     expect(getActions('ghes-3.10').includes('repo.create')).toBe(true)
     expect(getActions('ghes-3.11').includes('repo.create')).toBe(true)
     expect(auditLogPage in currentEvents['ghes-3.12']).toBeFalsy()
   })
+
+  test('ghes skips versions not in the supported list', async () => {
+    const eventsToProcess: RawAuditLogEventT[] = [
+      {
+        action: 'repo.create',
+        description: 'repo was created',
+        docs_reference_links: '',
+        _allowlists: [],
+        ghes: {
+          '3.14': {
+            _allowlists: ['user'],
+          },
+          '3.15': {
+            _allowlists: ['user'],
+          },
+        },
+      },
+    ]
+
+    const currentEvents: VersionedAuditLogData = {}
+    const auditLogPage = 'user'
+
+    await filterAndUpdateGhesDataByAllowlistValues({
+      eventsToCheck: eventsToProcess,
+      allowListValue: 'user',
+      currentGhesEvents: currentEvents,
+      pipelineConfig: {
+        sha: '',
+        appendedDescriptions: {},
+      },
+      auditLogPage,
+      supportedGhesVersions: ['3.15'],
+    })
+    expect(currentEvents['ghes-3.14']).toBeUndefined()
+    expect(currentEvents['ghes-3.15'][auditLogPage].map((event) => event.action)).toContain(
+      'repo.create',
+    )
+  })
 })