docs/src/audit-logs/scripts/sync.js

#!/usr/bin/env node

/**
 * Required env variables:
 *
 * GITHUB_TOKEN
 *
 * Gets latest audit log event data, extracts the data we need for rendering on
 * the 3 different audit log pages, and writes out the data to files versioned
 * per page.
 */
import { existsSync } from 'fs'
import { writeFile } from 'fs/promises'
import { mkdirp } from 'mkdirp'
import path from 'path'

import { getContents } from '../../../script/helpers/git-utils.js'

if (!process.env.GITHUB_TOKEN) {
  throw new Error('GITHUB_TOKEN environment variable must be set to run this script')
}

const AUDIT_LOG_DATA_DIR = 'src/audit-logs/data'

// the 3 different audit log types which correspond to audit log event pages
const auditLogTypes = ['user', 'organization', 'enterprise']
const versions = ['fpt', 'ghec', 'ghes']

// store an array of audit log event data keyed by version and audit log type,
// array will look like:
//
// [
//  {
//    "action": "repo.create",
//    "description": "description",
//    "docs_reference_link": "reference link",
//  },
//  ...
// ]
const auditLogData = {}
versions.forEach((version) => {
  auditLogData[version] = {}

  auditLogTypes.forEach((type) => {
    auditLogData[version][type] = []
  })
})

async function main() {
  // get latest audit log data
  //
  // an array of event objects that look like this (omitting fields we won't
  // use):
  //
  // {
  //   "account.billing_date_change": {
  //     "description": "Event description",
  //     "docs_reference_links": "Event reference link (can be space or comma-space separated list of links)",
  //   }
  // }
  const owner = 'github'
  const repo = 'audit-log-allowlists'
  const ref = 'main'
  const schemaFilePath = 'data/schema.json'
  const schemaEvents = JSON.parse(await getContents(owner, repo, ref, schemaFilePath))

  // translate allowLists values into the versions and audit log page the event
  // belongs to -- for versions:
  //
  // * user => fpt
  // * business => ghec
  // * business_server => ghes
  // * organization => fpt
  //
  // for audit log pages:
  //
  // * user => user page
  // * business_server => enterprise page
  // * organization => organization page
  schemaEvents
    .filter((event) => event._allowlists !== null)
    .forEach((event) => {
      const minimalEvent = {
        action: event.action,
        description: event.description,
        docs_reference_links: event.docs_reference_links,
      }

      // FPT events
      if (event._allowlists.includes('user')) {
        auditLogData.fpt.user.push(minimalEvent)
      }
      if (event._allowlists.includes('organization')) {
        auditLogData.fpt.organization.push(minimalEvent)
      }

      // GHES events
      if (event._allowlists.includes('business_server')) {
        auditLogData.ghes.enterprise.push(minimalEvent)

        if (event._allowlists.includes('user')) {
          auditLogData.ghes.user.push(minimalEvent)
        }

        if (event._allowlists.includes('organization')) {
          auditLogData.ghes.organization.push(minimalEvent)
        }
      }

      // GHEC events
      if (event._allowlists.includes('business')) {
        // If an event is on the business and business_server allowlist,
        // it is an enterprise type event
        if (event._allowlists.includes('business_server')) {
          auditLogData.ghec.enterprise.push(minimalEvent)
        }

        if (event._allowlists.includes('organization')) {
          auditLogData.ghec.organization.push(minimalEvent)
        }

        if (event._allowlists.includes('user')) {
          auditLogData.ghec.user.push(minimalEvent)
        }
      }
    })

  // write out audit log event data to page event files per version e.g.:
  //
  // fpt/
  // |- enterprise.json
  // |- organization.json
  // |- user.json
  for (const version of Object.keys(auditLogData)) {
    const auditLogVersionDirPath = path.join(AUDIT_LOG_DATA_DIR, version)

    if (!existsSync(auditLogVersionDirPath)) {
      await mkdirp(auditLogVersionDirPath)
    }

    auditLogTypes.forEach(async (type) => {
      const auditLogSchemaFilePath = path.join(auditLogVersionDirPath, `${type}.json`)

      if (auditLogData[version][type]) {
        await writeFile(
          auditLogSchemaFilePath,
          JSON.stringify(auditLogData[version][type], null, 2),
        )
      }
    })
  }
}

main()