docs/script/graphql/update-files.js

#!/usr/bin/env node
import fs from 'fs'
import path from 'path'
import xMkdirp from 'mkdirp'
import yaml from 'js-yaml'
import { execSync } from 'child_process'
import { getContents, listMatchingRefs } from '../helpers/git-utils.js'
import allVersions from '../../lib/all-versions.js'
import processPreviews from './utils/process-previews.js'
import processUpcomingChanges from './utils/process-upcoming-changes.js'
import processSchemas from './utils/process-schemas.js'
import prerenderObjects from './utils/prerender-objects.js'
import prerenderInputObjects from './utils/prerender-input-objects.js'
import { prependDatedEntry, createChangelogEntry } from './build-changelog.js'
import loadData from '../../lib/site-data.js'

const mkdirp = xMkdirp.sync
const graphqlDataDir = path.join(process.cwd(), 'data/graphql')
const graphqlStaticDir = path.join(process.cwd(), 'lib/graphql/static')
const dataFilenames = JSON.parse(fs.readFileSync(path.join(process.cwd(), './script/graphql/utils/data-filenames.json')))

// check for required PAT
if (!process.env.GITHUB_TOKEN) {
  console.error('Error! You must have a GITHUB_TOKEN set in an .env file to run this script.')
  process.exit(1)
}

const versionsToBuild = Object.keys(allVersions)

const currentLanguage = 'en'

main()

async function main () {
  try {
    const previewsJson = {}
    const upcomingChangesJson = {}
    const prerenderedObjects = {}
    const prerenderedInputObjects = {}

    const siteData = await loadData()

    // create a bare minimum context for rendering the graphql-object.html layout
    const context = {
      currentLanguage,
      site: siteData[currentLanguage].site
    }

    for (const version of versionsToBuild) {
      // Get the relevant GraphQL name  for the current version
      // For example, free-pro-team@latest corresponds to dotcom,
      // enterprise-server@2.22 corresponds to ghes-2.22,
      // and github-ae@latest corresponds to ghae
      const graphqlVersion = allVersions[version].miscVersionName

      // 1. UPDATE PREVIEWS
      const previewsPath = getDataFilepath('previews', graphqlVersion)
      const safeForPublicPreviews = yaml.load(await getRemoteRawContent(previewsPath, graphqlVersion))
      updateFile(previewsPath, yaml.dump(safeForPublicPreviews))
      previewsJson[graphqlVersion] = processPreviews(safeForPublicPreviews)

      // 2. UPDATE UPCOMING CHANGES
      const upcomingChangesPath = getDataFilepath('upcomingChanges', graphqlVersion)
      const previousUpcomingChanges = yaml.load(fs.readFileSync(upcomingChangesPath, 'utf8'))
      const safeForPublicChanges = await getRemoteRawContent(upcomingChangesPath, graphqlVersion)
      updateFile(upcomingChangesPath, safeForPublicChanges)
      upcomingChangesJson[graphqlVersion] = await processUpcomingChanges(safeForPublicChanges)

      // 3. UPDATE SCHEMAS
      // note: schemas live in separate files per version
      const schemaPath = getDataFilepath('schemas', graphqlVersion)
      const previousSchemaString = fs.readFileSync(schemaPath, 'utf8')
      const latestSchema = await getRemoteRawContent(schemaPath, graphqlVersion)
      updateFile(schemaPath, latestSchema)
      const schemaJsonPerVersion = await processSchemas(latestSchema, safeForPublicPreviews)
      updateStaticFile(schemaJsonPerVersion, path.join(graphqlStaticDir, `schema-${graphqlVersion}.json`))

      // Add some version specific data to the context
      context.graphql = { schemaForCurrentVersion: schemaJsonPerVersion }
      context.currentVersion = version

      // 4. PRERENDER OBJECTS HTML
      // because the objects page is too big to render on page load
      prerenderedObjects[graphqlVersion] = await prerenderObjects(context)

      // 5. PRERENDER INPUT OBJECTS HTML
      // because the objects page is too big to render on page load
      prerenderedInputObjects[graphqlVersion] = await prerenderInputObjects(context)

      // 6. UPDATE CHANGELOG
      if (allVersions[version].nonEnterpriseDefault) {
        // The Changelog is only build for free-pro-team@latest
        const changelogEntry = await createChangelogEntry(
          previousSchemaString,
          latestSchema,
          safeForPublicPreviews,
          previousUpcomingChanges.upcoming_changes,
          yaml.load(safeForPublicChanges).upcoming_changes
        )
        if (changelogEntry) {
          prependDatedEntry(changelogEntry, path.join(process.cwd(), 'lib/graphql/static/changelog.json'))
        }
      }
    }

    updateStaticFile(previewsJson, path.join(graphqlStaticDir, 'previews.json'))
    updateStaticFile(upcomingChangesJson, path.join(graphqlStaticDir, 'upcoming-changes.json'))
    updateStaticFile(prerenderedObjects, path.join(graphqlStaticDir, 'prerendered-objects.json'))
    updateStaticFile(prerenderedInputObjects, path.join(graphqlStaticDir, 'prerendered-input-objects.json'))

    // Ensure the YAML linter runs before checkinging in files
    execSync('npx prettier -w "**/*.{yml,yaml}"')
  } catch (e) {
    console.error(e)
    process.exit(1)
  }
}

// get latest from github/github
async function getRemoteRawContent (filepath, graphqlVersion) {
  const options = {
    owner: 'github',
    repo: 'github'
  }

  // find the relevant branch in github/github and set it as options.ref
  await setBranchAsRef(options, graphqlVersion)

  // add the filepath to the options so we can get the contents of the file
  options.path = `config/${path.basename(filepath)}`

  return getContents(...Object.values(options))
}

// find the relevant filepath in script/graphql/utils/data-filenames.json
function getDataFilepath (id, graphqlVersion) {
  const versionType = getVersionType(graphqlVersion)

  // for example, dataFilenames['schema']['ghes'] = schema.docs-enterprise.graphql
  const filename = dataFilenames[id][versionType]

  // dotcom files live at the root of data/graphql
  // non-dotcom files live in data/graphql/<version_subdir>
  const dataSubdir = graphqlVersion === 'dotcom' ? '' : graphqlVersion

  return path.join(graphqlDataDir, dataSubdir, filename)
}

async function setBranchAsRef (options, graphqlVersion, branch = false) {
  const versionType = getVersionType(graphqlVersion)
  const defaultBranch = 'master'

  const branches = {
    dotcom: defaultBranch,
    ghes: `enterprise-${graphqlVersion.replace('ghes-', '')}-release`,
    // TODO confirm the below is accurate after the release branch is created
    ghae: 'github-ae-release'
  }

  // the first time this runs, it uses the branch found for the version above
  if (!branch) branch = branches[versionType]

  // set the branch as the ref
  options.ref = `heads/${branch}`

  // check whether the branch can be found in github/github
  const foundRefs = await listMatchingRefs(...Object.values(options))

  // if foundRefs array is empty, the branch cannot be found, so try a fallback
  if (!foundRefs.length) {
    const fallbackBranch = defaultBranch
    await setBranchAsRef(options, graphqlVersion, fallbackBranch)
  }
}

// given a GraphQL version like `ghes-2.22`, return `ghes`;
// given a GraphQL version like `ghae` or `dotcom`, return as is
function getVersionType (graphqlVersion) {
  return graphqlVersion.split('-')[0]
}

function updateFile (filepath, content) {
  console.log(`fetching latest data to ${filepath}`)
  mkdirp(path.dirname(filepath))
  fs.writeFileSync(filepath, content, 'utf8')
}

function updateStaticFile (json, filepath) {
  const jsonString = JSON.stringify(json, null, 2)
  updateFile(filepath, jsonString)
}