ember-cli/lib/tasks/install-blueprint.js

Command line tool for developing ambitious ember.js apps

'use strict';

const fs = require('fs-extra');
const Blueprint = require('../models/blueprint');
const Task = require('../models/task');
const util = require('util');
const temp = require('temp');
const path = require('path');
const merge = require('lodash/merge');
const execa = require('../utilities/execa');
const SilentError = require('silent-error');
const npa = require('npm-package-arg');
const lintFix = require('../utilities/lint-fix');

const logger = require('heimdalljs-logger')('ember-cli:tasks:install-blueprint');
const { isExperimentEnabled } = require('@ember-tooling/blueprint-model/utilities/experiments');

const NOT_FOUND_REGEXP = /npm ERR! 404 {2}'(\S+)' is not in the npm registry/;

// Automatically track and cleanup temp files at exit
temp.track();

let mkdirTemp = util.promisify(temp.mkdir);

class InstallBlueprintTask extends Task {
  async run(options) {
    let cwd = process.cwd();
    let name = options.rawName;
    let blueprintOption = options.blueprint;
    // If we're in a dry run, pretend we changed directories.
    // Pretending we cd'd avoids prompts in the actual current directory.
    let fakeCwd = path.join(cwd, name);
    let target = options.dryRun ? fakeCwd : cwd;

    let installOptions = {
      target,
      entity: { name },
      ui: this.ui,
      project: this.project,
      dryRun: options.dryRun,
      targetFiles: options.targetFiles,
      rawArgs: options.rawArgs,
      ciProvider: options.ciProvider,
    };

    installOptions = merge(installOptions, options || {});

    let blueprint = await this._resolveBlueprint(blueprintOption);
    logger.info(`Installing blueprint into "${target}" ...`);
    await blueprint.install(installOptions);

    if (options.lintFix) {
      try {
        await lintFix.run(this.project);
      } catch (error) {
        logger.error('Lint fix failed: %o', error);
      }
    }
  }

  async _resolveBlueprint(name) {
    name = name || 'app';
    logger.info(`Resolving blueprint "${name}" ...`);

    if (isExperimentEnabled('VITE') && name === 'app') {
      return Blueprint.load(path.dirname(require.resolve('@ember/app-blueprint')));
    }

    let blueprint;
    try {
      blueprint = await this._lookupLocalBlueprint(name);
    } catch (error) {
      blueprint = await this._handleLocalLookupFailure(name, error);
    }

    return blueprint;
  }

  async _lookupLocalBlueprint(name) {
    logger.info(`Looking up blueprint "${name}" locally...`);
    return Blueprint.lookup(name, {
      paths: this.project.blueprintLookupPaths(),
    });
  }

  _handleLocalLookupFailure(name, error) {
    logger.info(`Local blueprint lookup for "${name}" failed`);

    try {
      npa(name);
    } catch (err) {
      logger.info(`"${name} is not a valid npm package specifier -> rethrowing original error`);
      throw error;
    }

    logger.info(`"${name} is a valid npm package specifier -> trying npm`);
    return this._tryRemoteBlueprint(name);
  }

  async _tryRemoteBlueprint(name) {
    let tmpDir = await this._createTempFolder();
    await this._createEmptyPackageJSON(tmpDir, name);

    try {
      await this._npmInstall(tmpDir, name);
    } catch (error) {
      this._handleNpmInstallModuleError(error); // re-throws
    }

    let packageName = await this._readSingleDependencyFromPackageJSON(tmpDir);
    let blueprintPath = path.resolve(tmpDir, 'node_modules', packageName);
    this._validateNpmModule(blueprintPath, packageName);

    return this._loadBlueprintFromPath(blueprintPath);
  }

  _createTempFolder() {
    return mkdirTemp('ember-cli');
  }

  _resolvePackageJSON(directoryPath) {
    return path.resolve(directoryPath, 'package.json');
  }

  async _createEmptyPackageJSON(tempProjectPath, blueprintName) {
    return fs.writeFile(
      this._resolvePackageJSON(tempProjectPath),
      JSON.stringify({
        name: 'ember-cli-blueprint-install-wrapper',
        version: '0.0.0',
        description: `This is a transient package used to fetch this blueprint: ${blueprintName}`,
        license: 'UNLICENSED',
        private: true,
        dependencies: {},
      })
    );
  }

  async _readSingleDependencyFromPackageJSON(tempProjectPath) {
    let packageJSON = JSON.parse(await fs.readFile(this._resolvePackageJSON(tempProjectPath), 'utf8'));

    if (!packageJSON.dependencies || typeof packageJSON.dependencies !== 'object') {
      throw new SilentError(`The transient package.json at '${tempProjectPath}' is missing 'dependencies'.`);
    }

    let dependencyNames = Object.keys(packageJSON.dependencies);

    if (dependencyNames.length !== 1) {
      throw new SilentError(
        `The transient package.json at '${tempProjectPath}' has more than one or no entries in 'dependencies'.`
      );
    }

    return dependencyNames[0];
  }

  async _createPackageJSON(tempProjectPath, descriptor) {
    let packageName = descriptor.name || `ember-cli-blueprint-${Date.now()}`;
    let specifier = descriptor.saveSpec || descriptor.fetchSpec;

    await fs.writeFile(
      this._resolvePackageJSON(tempProjectPath),
      JSON.stringify({
        dependencies: {
          [packageName]: specifier,
        },
      })
    );

    return packageName;
  }

  _npmInstall(cwd, name) {
    logger.info(`Running "npm install" for "${name}" in "${cwd}" ...`);

    this._copyNpmrc(cwd);

    return execa('npm', ['install', '--no-package-lock', '--save', name], { cwd });
  }

  _handleNpmInstallModuleError(error) {
    let match = error.stderr && error.stderr.match(NOT_FOUND_REGEXP);
    if (match) {
      let packageName = match[1];
      throw new SilentError(`The package '${packageName}' was not found in the npm registry.`);
    }

    throw error;
  }

  _validateNpmModule(modulePath, packageName) {
    logger.info(`Checking for "ember-blueprint" keyword in "${packageName}" module ...`);
    let pkg = require(this._resolvePackageJSON(modulePath));
    if (!pkg || !pkg.keywords || pkg.keywords.indexOf('ember-blueprint') === -1) {
      throw new SilentError(`The package '${packageName}' is not a valid Ember CLI blueprint.`);
    }
  }

  async _loadBlueprintFromPath(path) {
    logger.info(`Loading blueprint from "${path}" ...`);
    return Blueprint.load(path);
  }

  /*
   * NPM has 4 places it uses for .npmrc. 3 of the 4 are supported as their locations
   * are external to the project root but if there is an .npmrc file located at the project root it will
   * not be respected. This is because we create a tmp directory (createTempFolder) where we run
   * the npm install. This function simply copies over the .npmrc file to the tmp directory so that it
   * will be used during the install of the blueprint. Useful for installing private blueprints
   * such as `ember init -b @company/company-specific-blueprint` where the module is in a different
   * registry.
   */
  _copyNpmrc(tmpDir) {
    let rcPath = path.join(this.project.root, '.npmrc');
    let tempLocation = path.join(tmpDir, '.npmrc');

    if (fs.existsSync(rcPath)) {
      fs.copySync(rcPath, tempLocation, {
        dereference: true,
      });
    }
  }
}

module.exports = InstallBlueprintTask;