docs/script/check-s3-images.js

#!/usr/bin/env node

const path = require('path')
const { chain, difference } = require('lodash')
const loadPages = require('../lib/pages')
const loadSiteData = require('../lib/site-data')
const renderContent = require('../lib/render-content')
const allVersions = require('../lib/all-versions')
const nonEnterpriseDefaultVersion = require('../lib/non-enterprise-default-version')
const { getS3BucketPathFromVersion, getVersionFromS3BucketPath } = require('../lib/s3-bucket-path-utils')
const patterns = require('../lib/patterns')
const authenticateToAWS = require('../lib/authenticate-to-aws.js')
const readlineSync = require('readline-sync')
const { execSync } = require('child_process')
const uploadScript = path.join(process.cwd(), 'script/upload-images-to-s3.js')

// ignore the non-enterprise default version
const versionsToCheck = Object.keys(allVersions)
  .filter(version => version !== nonEnterpriseDefaultVersion)

// [start-readme]
//
// Run this script in your branch to check whether any images referenced in content are
// not in an expected S3 bucket. You will need to authenticate to S3 via `awssume` to use this script.
// Instructions for the one-time setup are [here](https://github.com/github/product-documentation/blob/master/doc-team-workflows/workflow-information-for-all-writers/setting-up-awssume-and-s3cmd.md).
//
// [end-readme]

main()

async function main () {
  const s3 = await authenticateToAWS()

  console.log('Working...\n')
  const pages = await getEnglishPages()
  const siteData = await getEnglishSiteData()

  const s3References = []

  for (const version of versionsToCheck) {
    for (const page of pages) {
      // skip page if it doesn't have a permalink for the current version
      if (!page.permalinks.some(permalink => permalink.pageVersion === version)) continue

      // skip index pages because they do not contain images
      if (page.relativePath.endsWith('index.md')) continue

      // build fake context object for rendering the page
      page.version = version
      const context = {
        page,
        site: siteData,
        currentVersion: version,
        currentLanguage: 'en'
      }

      const rendered = await renderContent(page.markdown, context)
      const imageReferences = rendered.match(patterns.imagePath)

      if (!imageReferences) continue

      const bucketPath = getS3BucketPathFromVersion(version)

      imageReferences.forEach(ref => {
        s3References.push(`${bucketPath}${ref}`)
      })
    }
  }

  // store all images referenced in Enterprise content
  const s3ReferencesToCheck = chain(s3References).uniq().sort().value()

  console.log(`Found ${s3ReferencesToCheck.length} images referenced in S3-eligible content in the current checkout.\n`)

  console.log('Checking the github-images S3 bucket...\n')

  const imagesOnS3 = []
  // now look for the images on S3
  for (const version of versionsToCheck) {
    const bucketPath = getS3BucketPathFromVersion(version)
    imagesOnS3.push(await listObjects(s3, bucketPath, imagesOnS3))
  }

  // store all found images on s3
  const allImagesOnS3 = chain(imagesOnS3).flatten().uniq().sort().value()

  const imagesMissingFromS3 = difference(s3ReferencesToCheck, allImagesOnS3)

  // return early if there are no missing images
  if (!imagesMissingFromS3.length) {
    console.log('All images are in S3 that should be!')
    return
  }

  console.log(`${imagesMissingFromS3.length} images are missing from S3:\n\n${imagesMissingFromS3.join('\n')}`)

  const prompt = `\nDo you want to try to upload these images to S3 from your local checkout?
\nPress Y to continue, or press enter any other key to cancel: `

  const answer = readlineSync.question(prompt)

  if (!answer.match(/^Y$/mi)) {
    console.log('Exiting!')
    process.exit()
  }

  console.log('Trying to upload...\n')
  imagesMissingFromS3.forEach(missingImage => {
    // given an s3 path like `enterprise/2.19/assets/images/foo.png`,
    // find the version `enterprise-server@2.19` and the local path `assets/images/foo.png`,
    // then attempt to upload the file using the upload script
    const version = getVersionFromS3BucketPath(missingImage)
    const assetPath = missingImage.replace(/.+?assets/, 'assets')
    const result = execSync(`${uploadScript} --single ${assetPath} --version ${version}`)
    console.log(result.toString())
  })

  console.log('Done uploading! Checking S3 again.')
  main()
}

async function getEnglishPages () {
  const pages = await loadPages()
  return pages.filter(page => page.languageCode === 'en')
}

async function getEnglishSiteData () {
  const siteData = await loadSiteData()
  return siteData.en.site
}

async function listObjects (s3, bucketPath, imagesOnS3, token) {
  const params = {
    Bucket: 'github-images',
    StartAfter: bucketPath
  }

  if (token) params.ContinuationToken = token

  const data = await s3.listObjectsV2(params).promise()

  const matchingKeys = data.Contents
    .map(obj => obj.Key)
    .filter(imageFile => imageFile.startsWith(bucketPath))

  if (!matchingKeys.length) return []

  imagesOnS3.push(matchingKeys)

  if (data.IsTruncated) {
    await listObjects(s3, bucketPath, imagesOnS3, data.NextContinuationToken)
  }

  return imagesOnS3
}