src/github-apps/tests/rendering.ts

import { readFile } from 'fs/promises'

import { describe, expect, test, vi } from 'vitest'

import { allVersions } from '@/versions/lib/all-versions'
import { get, getDOM } from '@/tests/helpers/e2etest'
import { categoriesWithoutSubcategories } from '@/rest/lib/index'
import { getAppsData } from '@/github-apps/lib/index'
import type { Version } from '@/types'

interface PageConfig {
  frontmatterDefaults: {
    versions: string | Record<string, string>
    autogenerated: string
  }
  targetFilename: string
}

interface AppsConfig {
  targetDirectory: string
  pages: Record<string, PageConfig>
  'api-versions': Record<string, string[]>
  sha: string
}

interface PermissionItem {
  category: string
  subcategory: string
  slug: string
}

interface PermissionData {
  permissions: PermissionItem[]
}

interface EnabledItem {
  subcategory: string
  slug: string
}

const configContent: AppsConfig = JSON.parse(
  await readFile('src/github-apps/lib/config.json', 'utf8'),
)
const pageTypes: string[] = Object.keys(configContent.pages)
const permissionPages: string[] = pageTypes.filter((pageType) => pageType.includes('permissions'))
const enabledPages: string[] = pageTypes.filter((pageType) => !pageType.includes('permissions'))
const defaultVersion: Version | undefined = Object.values(allVersions)
  .filter((version) => version.nonEnterpriseDefault)
  .shift()

if (!defaultVersion) {
  throw new Error('No default version found')
}

const version: string = defaultVersion.version
const apiVersion: string = defaultVersion.latestApiVersion

describe('REST references docs', () => {
  vi.setConfig({ testTimeout: 3 * 60 * 1000 })
  // This test ensures that the page component and the Markdown file are
  // in sync. It also checks that all expected items are present.
  // For every version of /rest/overview/endpoints-available-for-github-apps
  test('loads enabled list pages', async () => {
    for (const page of enabledPages) {
      const schemaSlugs: string[] = []

      const enabledForApps: Record<string, EnabledItem[]> = await getAppsData(
        page,
        version,
        apiVersion,
      )

      // using the static file, generate the expected slug for each operation
      for (const [key, value] of Object.entries(enabledForApps)) {
        schemaSlugs.push(
          ...value.map(
            (item: EnabledItem) =>
              `/en/rest/${key}${
                categoriesWithoutSubcategories.includes(key) ? '' : `/${item.subcategory}`
              }#${item.slug}`,
          ),
        )
      }
      // get all of the href attributes in the anchor tags
      const contentPath = configContent.pages[page].targetFilename
        .replace('content/', '')
        .replace('.md', '')
      const $ = await getDOM(`/en/${contentPath}${apiVersion ? `?apiVersion=${apiVersion}` : ''}`)
      const domH3Ids = $('#article-contents a')
        .map((i, a) => $(a).attr('href'))
        .get()
      expect(schemaSlugs.every((slug) => domH3Ids.includes(slug))).toBe(true)
    }
  })

  test('loads permission list pages', async () => {
    // permissions pages
    for (const page of permissionPages) {
      const schemaSlugs: string[] = []

      const permissionsData: Record<string, PermissionData> = await getAppsData(
        page,
        version,
        apiVersion,
      )

      // using the static file, generate the expected slug for each operation
      for (const value of Object.values(permissionsData)) {
        schemaSlugs.push(
          ...value.permissions.map(
            (item: PermissionItem) =>
              `/en/rest/${item.category}${
                categoriesWithoutSubcategories.includes(item.category) ? '' : `/${item.subcategory}`
              }#${item.slug}`,
          ),
        )
      }

      // get all of the href attributes in the anchor tags
      const contentPath = configContent.pages[page].targetFilename
        .replace('content/', '')
        .replace('.md', '')
      const $ = await getDOM(`/en/${contentPath}${apiVersion ? `?apiVersion=${apiVersion}` : ''}`)
      const domH3Ids = $('#article-contents table tbody tr td a')
        .map((i, a) => $(a).attr('href'))
        .get()
      expect(schemaSlugs.every((slug) => domH3Ids.includes(slug))).toBe(true)
    }
  })

  for (const page of pageTypes) {
    const contentPath = configContent.pages[page].targetFilename
      .replace('content/', '')
      .replace('.md', '')
    const url = `/${contentPath}?${new URLSearchParams({ apiVersion: 'junk' })}`

    test(`falls back when unsupported calendar version provided for ${contentPath}`, async () => {
      const res = await get(url, { followRedirects: true })
      expect(res.statusCode).toBe(200)
    })
  }
})