atom/src/package-transpilation-registry.js

'use strict'
// This file is required by compile-cache, which is required directly from
// apm, so it can only use the subset of newer JavaScript features that apm's
// version of Node supports. Strict mode is required for block scoped declarations.

const crypto = require('crypto')
const fs = require('fs')
const path = require('path')

const minimatch = require('minimatch')

let Resolve = null

class PackageTranspilationRegistry {
  constructor () {
    this.configByPackagePath = {}
    this.specByFilePath = {}
    this.transpilerPaths = {}
  }

  addTranspilerConfigForPath (packagePath, packageName, packageMeta, config) {
    this.configByPackagePath[packagePath] = {
      name: packageName,
      meta: packageMeta,
      path: packagePath,
      specs: config.map(spec => Object.assign({}, spec))
    }
  }

  removeTranspilerConfigForPath (packagePath) {
    delete this.configByPackagePath[packagePath]
  }

  // Wraps the transpiler in an object with the same interface
  // that falls back to the original transpiler implementation if and
  // only if a package hasn't registered its desire to transpile its own source.
  wrapTranspiler (transpiler) {
    return {
      getCachePath: (sourceCode, filePath) => {
        const spec = this.getPackageTranspilerSpecForFilePath(filePath)
        if (spec) {
          return this.getCachePath(sourceCode, filePath, spec)
        }

        return transpiler.getCachePath(sourceCode, filePath)
      },

      compile: (sourceCode, filePath) => {
        const spec = this.getPackageTranspilerSpecForFilePath(filePath)
        if (spec) {
          return this.transpileWithPackageTranspiler(sourceCode, filePath, spec)
        }

        return transpiler.compile(sourceCode, filePath)
      },

      shouldCompile: (sourceCode, filePath) => {
        if (this.transpilerPaths[filePath]) {
          return false
        }
        const spec = this.getPackageTranspilerSpecForFilePath(filePath)
        if (spec) {
          return true
        }

        return transpiler.shouldCompile(sourceCode, filePath)
      }
    }
  }

  getPackageTranspilerSpecForFilePath (filePath) {
    if (this.specByFilePath[filePath] !== undefined) return this.specByFilePath[filePath]

    // ignore node_modules
    if (filePath.indexOf(path.sep + 'node_modules' + path.sep) > -1) {
      return false
    }

    let thisPath = filePath
    let lastPath = null
    // Iterate parents from the file path to the root, checking at each level
    // to see if a package manages transpilation for that directory.
    // This means searching for a config for `/path/to/file/here.js` only
    // only iterates four times, even if there are hundreds of configs registered.
    while (thisPath !== lastPath) { // until we reach the root
      let config = this.configByPackagePath[thisPath]
      if (config) {
        for (let i = 0; i < config.specs.length; i++) {
          const spec = config.specs[i]
          if (minimatch(filePath, path.join(config.path, spec.glob))) {
            spec._config = config
            this.specByFilePath[filePath] = spec
            return spec
          }
        }
      }

      lastPath = thisPath
      thisPath = path.join(thisPath, '..')
    }

    this.specByFilePath[filePath] = null
    return null
  }

  getCachePath (sourceCode, filePath, spec) {
    const transpilerPath = this.getTranspilerPath(spec)
    const transpilerSource = spec._transpilerSource || fs.readFileSync(transpilerPath, 'utf8')
    spec._transpilerSource = transpilerSource
    const transpiler = this.getTranspiler(spec)

    let hash = crypto
      .createHash('sha1')
      .update(JSON.stringify(spec.options || {}))
      .update(transpilerSource, 'utf8')
      .update(sourceCode, 'utf8')

    if (transpiler && transpiler.getCacheKeyData) {
      const meta = this.getMetadata(spec)
      const additionalCacheData = transpiler.getCacheKeyData(sourceCode, filePath, spec.options || {}, meta)
      hash.update(additionalCacheData, 'utf8')
    }

    return path.join('package-transpile', spec._config.name, hash.digest('hex'))
  }

  transpileWithPackageTranspiler (sourceCode, filePath, spec) {
    const transpiler = this.getTranspiler(spec)

    if (transpiler) {
      const meta = this.getMetadata(spec)
      const result = transpiler.transpile(sourceCode, filePath, spec.options || {}, meta)
      if (result === undefined || (result && result.code === undefined)) {
        return sourceCode
      } else if (result.code) {
        return result.code.toString()
      } else {
        throw new Error('Could not find a property `.code` on the transpilation results of ' + filePath)
      }
    } else {
      const err = new Error("Could not resolve transpiler '" + spec.transpiler + "' from '" + spec._config.path + "'")
      throw err
    }
  }

  getMetadata (spec) {
    return {
      name: spec._config.name,
      path: spec._config.path,
      meta: spec._config.meta
    }
  }

  getTranspilerPath (spec) {
    Resolve = Resolve || require('resolve')
    return Resolve.sync(spec.transpiler, {
      basedir: spec._config.path,
      extensions: Object.keys(require.extensions)
    })
  }

  getTranspiler (spec) {
    const transpilerPath = this.getTranspilerPath(spec)
    if (transpilerPath) {
      const transpiler = require(transpilerPath)
      this.transpilerPaths[transpilerPath] = true
      return transpiler
    }
  }
}

module.exports = PackageTranspilationRegistry