sourcegraph/client/shared/dev/buildCodeIntelExtensions.js

/* eslint-disable no-sync, @typescript-eslint/restrict-template-expressions */
const fs = require('fs')
const path = require('path')

const shelljs = require('shelljs')
const signale = require('signale')

const bundlesRepoName = 'sourcegraph-extensions-bundles'

/**
 * Clones https://github.com/sourcegraph/sourcegraph-extensions-bundles repo and copies programming languages
 * extensions bundles to the specified path. These bundles may be included into IDE/browser extensions bundles
 * in order not to require access to the extensions registry for the code intel features to work.
 */
function fetchAndBuildCodeIntelExtensions({ pathToExtensionBundles, revision }) {
  const pathToDistributionRevisionFile = path.join(pathToExtensionBundles, 'revision.txt')

  const currentRevision =
    fs.existsSync(pathToDistributionRevisionFile) && fs.readFileSync(pathToDistributionRevisionFile).toString()

  if (currentRevision === revision) {
    signale.success(`Code-intel-extensions for revision "${revision}" are already bundled.`)
    return
  }

  signale.info(`Did not find an existing code-intel-extensions bundles matching revision ${revision}.`)

  signale.pending('Fetching code intel extensions bundles...')

  const result = shelljs.exec(`curl -OLs https://github.com/sourcegraph/${bundlesRepoName}/archive/${revision}.zip`)

  if (result.code !== 0) {
    console.error('Curl command failed with exit code:', result.code)
    console.error('Error message:', result.stderr)
    return
  }

  // when repo archive is unpacked the leading 'v' from tag is trimmed: v1.0.0.zip => sourcegraph-extensions-bundles-1.0.0
  const bundlesRepoDirectoryName = `${bundlesRepoName}-${revision.replaceAll(/^v/g, '')}`

  // Remove existing repo and bundles directory in case of an interrupted process.
  shelljs.rm('-rf', bundlesRepoDirectoryName)
  shelljs.rm('-rf', pathToExtensionBundles)

  // Unzip bundles repo archive, which creates a new directory: sourcegraph-extensions-bundles-{revision}
  shelljs.exec(`unzip -q ${revision}.zip`)
  // Remove bundles repo archive
  shelljs.exec(`rm ${revision}.zip`)

  buildCodeIntelExtensions({
    extensionBundlesSrc: bundlesRepoDirectoryName,
    extensionBundlesDest: pathToExtensionBundles,
    revision,
  })

  // Remove bundles repo directory and archive
  shelljs.exec(`rm -rf ${bundlesRepoDirectoryName}`)

  // Save sourcegraph-extensions-bundles revision not to refetch it on the next calls if the revision doesn't change
  fs.writeFileSync(pathToDistributionRevisionFile, revision)
}

function buildCodeIntelExtensions({ extensionBundlesSrc, extensionBundlesDest }) {
  const codeIntelExtensionIds = [] // list of cloned code intel extension ids, e.g. [..., 'sourcegraph/typescript', ...]
  const content = fs.readdirSync(path.join(extensionBundlesSrc, 'bundles'), { withFileTypes: true })

  for (const item of content) {
    if (!item.isDirectory()) {
      continue
    }

    const extensionName = item.name // kebab-case extension name, e.g. 'sourcegraph-typescript'

    const bundlePath = path.join(extensionBundlesSrc, 'bundles', extensionName)
    const files = fs.readdirSync(bundlePath)

    if (['package.json', `${extensionName}.js`].some(file => !files.includes(file))) {
      // does not look like a valid bundle directory
      continue
    }

    let isProgrammingLanguageExtension = false
    try {
      const packageJsonContent = JSON.parse(fs.readFileSync(path.join(bundlePath, 'package.json')).toString())
      isProgrammingLanguageExtension = packageJsonContent.categories?.includes('Programming languages')
    } catch {
      // couldn't parse package.json
      continue
    }

    if (!isProgrammingLanguageExtension) {
      continue
    }

    shelljs.mkdir('-p', path.join(extensionBundlesDest, extensionName))
    shelljs.exec(
      `cp ${path.join(bundlePath, 'package.json')} ${path.join(extensionBundlesDest, extensionName, 'package.json')}`
    )
    shelljs.exec(
      `cp ${path.join(bundlePath, `${extensionName}.js`)} ${path.join(
        extensionBundlesDest,
        extensionName,
        'extension.js'
      )}`
    )

    codeIntelExtensionIds.push(extensionName.replace(/^sourcegraph-/, 'sourcegraph/'))
  }

  // Save extension IDs of the copied bundles
  fs.writeFileSync(path.join(process.cwd(), 'code-intel-extensions.json'), JSON.stringify(codeIntelExtensionIds))

  signale.success('Code intel extensions bundles successfully copied.')
}

module.exports = { buildCodeIntelExtensions, fetchAndBuildCodeIntelExtensions }

// Use this script in Bazel. Remove `module.exports` once the Bazel migration is completed.
function main(args) {
  if (args.length !== 2) {
    throw new Error('Usage: <inputPath> <outputPath>')
  }

  const [inputPath, outputPath] = args
  const output = path.join(process.cwd(), outputPath)
  const input = path.join(process.env['JS_BINARY__EXECROOT'], inputPath)

  buildCodeIntelExtensions({ extensionBundlesSrc: input, extensionBundlesDest: output })
}

if (require.main === module) {
  main(process.argv.slice(2))
}