opensphere-build-resolver/core.js

Resolves projects, their dependencies, plugins, and config to the correct arguments for compilation via the Google Closure Compiler, sass/node-sass, and other tools.

'use strict';

const Promise = require('bluebird');
const fs = Promise.promisifyAll(require('fs'));
const path = require('path');
const utils = require('./utils');
const semver = require('semver');
const slash = require('slash');
var plugins = null;

/**
 * Resolves the dependencies of a package
 * @param {string} rootProjectPath The root project path
 * @param {Object<string, string>} alreadyResolved Map of package names to versions
 * @param {Object} pack The package.json
 * @param {string} projectDir The directory in which the current package was resolved
 * @param {number} depth The tree depth
 * @param {Array<string>} depStack The ancestry stack
 * @return {Promise} resolving all of the dependencies
 */
const resolveDependencies = function(rootProjectPath, alreadyResolved, pack, projectDir, depth, depStack) {
  if (pack.dependencies) {
    var deps = Object.keys(pack.dependencies);
    if (deps && pack.build) {
      deps.forEach(function(dep) {
        if (dep in alreadyResolved) {
          var resolvedVersion = alreadyResolved[dep].version;
          var requestedVersion = pack.dependencies[dep];

          if (semver.valid(requestedVersion) ||
              semver.validRange(requestedVersion)) {
            var value = semver.satisfies(resolvedVersion, requestedVersion);

            if (!value) {
              throw new Error('The package "' + pack.name + '" has a ' +
                'dependency on "' + dep + '" version ' +
                pack.dependencies[dep] + ' which has already been ' +
                'resolved as version ' + alreadyResolved[dep].version);
            }
          } else {
            console.log('WARNING: "' + dep + '" version "' +
                requestedVersion + '" was required by "' + pack.name + '" but ' +
                'is not a valid semver or semver range. "' + dep + '" was ' +
                'already resolved as version "' + resolvedVersion + '" and ' +
                'will be kept.');
          }
        }
      });

      return Promise.all(deps.map(function(dep) {
        return resolvePackage(rootProjectPath, alreadyResolved, dep, depth + 1, depStack, projectDir);
      }));
    }
  }

  return Promise.resolve();
};

/**
 * Resolves the plugins for a package
 * @param {string} rootProjectPath The root project path
 * @param {Object<string, string>} alreadyResolved Map of package names to versions
 * @param {Object} pack The current package.json
 * @param {string} projectDir The current package path
 * @param {string} prefix The prefix before the plugin package name
 * @param {number} depth The current tree depth
 * @param {Array<string>} depStack The ancestry stack
 * @return {Promise} resolving all of the plugins
 */
const resolvePlugins = function(rootProjectPath, alreadyResolved, pack, projectDir, prefix, depth, depStack) {
  alreadyResolved = alreadyResolved || {};

  var pathsToTry = [
    path.resolve(projectDir, '../'),
    path.resolve(projectDir, 'node_modules'),
    path.resolve(rootProjectPath, 'node_modules')
  ];

  var thisPackage = require(path.join(rootProjectPath, 'package'));

  if (!pack.build || !pack.build.pluggable ||
      (utils.isAppPackage(thisPackage) && utils.isAppPackage(pack) &&
      depth > 0)) {
    // current package is not an OpenSphere Closure Project so stop
    return Promise.resolve();
  }

  console.log('\n\nResolving ' + pack.name + prefix + '*');

  return Promise.map(pathsToTry, function(p) {
    var priorityMap = {};
    return fs.readdirAsync(p)
      .filter(function(file) {
        if (!file.startsWith(pack.name + prefix)) {
          return false;
        }

        // check the peerDependencies semver
        var pluginPackPath;
        var pluginPack;

        try {
          pluginPackPath = path.resolve(p, file, 'package.json');
          pluginPack = require(pluginPackPath);
        } catch (e) {
          console.error(pluginPackPath + ' does not exist');
          return false;
        }

        if (pluginPack.build && pluginPack.build.type === 'config') {
          // don't enforce dependency checking for config packages
          return true;
        }

        // ensure it's a plugin
        if (!pluginPack.build || !pluginPack.build.type === 'plugin') {
          return false;
        }

        priorityMap[file] = pluginPack.build.priority || 0;

        // must have a dependency on the current package
        if (!pluginPack.dependencies ||
            !pluginPack.dependencies[pack.name]) {
          console.log('WARNING: The ' + pack.name + ' plugin ' + file +
            ' should have a dependency definition for ' + pack.name);
          return false;
        }

        // check that the required semver matches
        var required = pluginPack.dependencies[pack.name];
        if (!/^[=~^]?[\d.]+/.test(required)) {
          // the version was some other sort of dependency (e.g. git) and
          // we'll just take their word that it is going to work
          return true;
        }

        var value = semver.satisfies(pack.version, required);

        if (!value) {
          console.error('WARNING: ' + pluginPack.name + ' requires ' +
            pack.name + ' version ' + required +
            ' but the version is ' + pack.version);
        }

        return value;
      }).then(function(files) {
        files.sort(utils.getPrioritySort(priorityMap));
        return files;
      })
      .map(function(file) {
        return resolvePackage(rootProjectPath, alreadyResolved, path.resolve(p, file), depth + 1, depStack);
      })
      .catch({code: 'ENOENT'}, function() {});
  });
};

/**
 * Resolve a package by name
 * @param {string} rootProjectPath The root project path
 * @param {Object<string, string>} alreadyResolved Map of package names to versions
 * @param {string} name The package name to resolve
 * @param {number} depth The tree depth
 * @param {Array<string>} depStack The ancestry stack
 * @param {string} optDependent The dependent path from which to resolve
 * @param {Object<string, Array<Function>>=} optPlugins optional set of plugin functions
 * @return {Promise} resolving all the things
 */
const resolvePackage = function(rootProjectPath, alreadyResolved, name, depth, depStack, optDependent, optPlugins) {
  optDependent = optDependent || '';
  alreadyResolved = alreadyResolved || {};
  depStack = depStack ? depStack.slice() : [];

  if (optPlugins) {
    plugins = optPlugins;
  }

  var filesToTry = ['package.json', 'bower.json'];
  var pathsToTry = path.isAbsolute(name) ? [name] : [
    path.resolve(optDependent, '../', name),
    path.resolve(optDependent, 'node_modules', name),
    path.resolve(optDependent, 'bower_components', name),
    path.resolve(rootProjectPath, 'node_modules', name),
    path.resolve(rootProjectPath, 'bower_components', name),
    path.resolve(rootProjectPath, '../../node_modules', name)
  ];

  var pack = null;
  var reduceFiles = function(p, c) {
    if (p) {
      if (c && c.dependencies) {
        // merge any bower dependencies so that we look for those properly
        p.dependencies = Object.assign(p.dependencies || {}, c.dependencies);
      }
      return p;
    } else if (c) {
      return c;
    }
  };

  var tryPath = function(p) {
    return filesToTry.map(function(file) {
      try {
        return require(path.resolve(p, file));
      } catch (e) {
      }

      return null;
    });
  };

  var i = 0;
  for (var n = pathsToTry.length; i < n; i++) {
    pack = tryPath(pathsToTry[i]).reduce(reduceFiles);

    if (pack) {
      pack.dependencies = Object.assign(
        pack.dependencies || {},
        pack.peerDependencies || {}
      );
      break;
    }
  }

  if (!pack) {
    throw new Error('Could not resolve module "' + name + '"');
  }

  var projectDir = pathsToTry[i];
  var lastDir = projectDir;
  while (!slash(projectDir).endsWith(slash(name))) {
    projectDir = path.resolve(projectDir, '../');
    if (lastDir === projectDir) {
      throw new Error('Could not resolve module path for "' + name + '"');
    }
    lastDir = projectDir;
  }

  if (!rootProjectPath) {
    rootProjectPath = projectDir;
  }

  depStack.push(pack.name);

  if (pack.name in alreadyResolved) {
    console.log('Resolved ' + depStack.join(' > ') + '@' + pack.version + ' as already resolved. Updating...');
    return Promise.map(plugins.updaters, function(updater) {
      return Promise.all([
        updater(pack, depth, depStack),
        utils.updateDependencies(pack.dependencies, alreadyResolved, depth, depStack, updater, [pack.name])
      ]);
    });
  }

  alreadyResolved[pack.name] = pack;
  console.log('Resolved ' + depStack.join(' > ') + '@' + pack.version + ' to ' + projectDir);

  return Promise.map(plugins.resolvers, function(resolver) {
    return resolver(pack, projectDir, depth, depStack);
  })
    .then(resolveDependencies.bind(null, rootProjectPath, alreadyResolved, pack, projectDir, depth, depStack))
    .then(resolvePlugins.bind(null, rootProjectPath, alreadyResolved, pack, projectDir, '-plugin-', depth, depStack))
    .then(resolvePlugins.bind(null, rootProjectPath, alreadyResolved, pack, projectDir, '-config-', depth, depStack));
};

module.exports = {
  resolvePackage: resolvePackage,
  resolveDependencies: resolveDependencies,
  resolvePlugins: resolvePlugins
};