src/cli/commands/check.js - master - githubmirror/yarn

src/cli/commands/check.js
408 строк14 KB
kaylie-alexa
fix(install): Inherit optional property for resolutions (#7273)
06 июн 2019, 19:38
06 июн 2019, 19:38b656953
/* @flow */

import type Config from '../../config.js';
import {MessageError} from '../../errors.js';
import InstallationIntegrityChecker from '../../integrity-checker.js';
import {integrityErrors} from '../../integrity-checker.js';
import Lockfile from '../../lockfile';
import type {Reporter} from '../../reporters/index.js';
import * as fs from '../../util/fs.js';
import {Install} from './install.js';
import {normalizePattern} from '../../util/normalize-pattern.js';

const semver = require('semver');
const path = require('path');

export const requireLockfile = false;
export const noArguments = true;

export function hasWrapper(commander: Object): boolean {
  return true;
}

export function setFlags(commander: Object) {
  commander.description('Verifies if versions in the current project’s package.json match that of yarn’s lock file.');
  commander.option('--integrity');
  commander.option('--verify-tree');
}

export async function verifyTreeCheck(
  config: Config,
  reporter: Reporter,
  flags: Object,
  args: Array<string>,
): Promise<void> {
  let errCount = 0;
  function reportError(msg, ...vars) {
    reporter.error(reporter.lang(msg, ...vars));
    errCount++;
  }
  // check all dependencies recursively without relying on internal resolver
  const registryName = 'yarn';
  const registryFolder = config.registryFolders[0];
  const cwd = config.workspaceRootFolder ? config.lockfileFolder : config.cwd;
  const rootManifest = await config.readManifest(cwd, registryName);

  type PackageToVerify = {
    name: string,
    originalKey: string,
    parentCwd: string,
    version: string,
  };
  const dependenciesToCheckVersion: PackageToVerify[] = [];
  if (rootManifest.dependencies) {
    for (const name in rootManifest.dependencies) {
      const version = rootManifest.dependencies[name];
      // skip linked dependencies
      const isLinkedDependency = /^link:/i.test(version) || (/^file:/i.test(version) && config.linkFileDependencies);
      if (isLinkedDependency) {
        continue;
      }
      dependenciesToCheckVersion.push({
        name,
        originalKey: name,
        parentCwd: cwd,
        version,
      });
    }
  }
  if (rootManifest.devDependencies && !config.production) {
    for (const name in rootManifest.devDependencies) {
      const version = rootManifest.devDependencies[name];
      // skip linked dependencies
      const isLinkedDependency = /^link:/i.test(version) || (/^file:/i.test(version) && config.linkFileDependencies);
      if (isLinkedDependency) {
        continue;
      }
      dependenciesToCheckVersion.push({
        name,
        originalKey: name,
        parentCwd: cwd,
        version,
      });
    }
  }

  const locationsVisited: Set<string> = new Set();
  while (dependenciesToCheckVersion.length) {
    const dep = dependenciesToCheckVersion.shift();
    const manifestLoc = path.resolve(dep.parentCwd, registryFolder, dep.name);
    if (locationsVisited.has(manifestLoc + `@${dep.version}`)) {
      continue;
    }
    locationsVisited.add(manifestLoc + `@${dep.version}`);
    // When plugnplay is enabled, packages aren't copied to the node_modules folder, so this check doesn't make sense
    // TODO: We ideally should check that the packages are located inside the cache instead
    if (config.plugnplayEnabled) {
      continue;
    }
    if (!await fs.exists(manifestLoc)) {
      reportError('packageNotInstalled', `${dep.originalKey}`);
      continue;
    }
    if (!await fs.exists(path.join(manifestLoc, 'package.json'))) {
      continue;
    }
    const pkg = await config.readManifest(manifestLoc, registryName);
    if (
      semver.validRange(dep.version, config.looseSemver) &&
      !semver.satisfies(pkg.version, dep.version, config.looseSemver)
    ) {
      reportError('packageWrongVersion', dep.originalKey, dep.version, pkg.version);
      continue;
    }
    const dependencies = pkg.dependencies;
    if (dependencies) {
      for (const subdep in dependencies) {
        const subDepPath = path.resolve(manifestLoc, registryFolder, subdep);
        let found = false;
        const relative = path.relative(cwd, subDepPath);
        const locations = path.normalize(relative).split(registryFolder + path.sep).filter(dir => !!dir);
        locations.pop();
        while (locations.length >= 0) {
          let possiblePath;
          if (locations.length > 0) {
            possiblePath = path.join(cwd, registryFolder, locations.join(path.sep + registryFolder + path.sep));
          } else {
            possiblePath = cwd;
          }
          if (await fs.exists(path.resolve(possiblePath, registryFolder, subdep))) {
            dependenciesToCheckVersion.push({
              name: subdep,
              originalKey: `${dep.originalKey}#${subdep}`,
              parentCwd: possiblePath,
              version: dependencies[subdep],
            });
            found = true;
            break;
          }
          if (!locations.length) {
            break;
          }
          locations.pop();
        }
        if (!found) {
          reportError('packageNotInstalled', `${dep.originalKey}#${subdep}`);
        }
      }
    }
  }

  if (errCount > 0) {
    throw new MessageError(reporter.lang('foundErrors', errCount));
  } else {
    reporter.success(reporter.lang('folderInSync'));
  }
}

async function integrityHashCheck(
  config: Config,
  reporter: Reporter,
  flags: Object,
  args: Array<string>,
): Promise<void> {
  let errCount = 0;
  function reportError(msg, ...vars) {
    reporter.error(reporter.lang(msg, ...vars));
    errCount++;
  }
  const integrityChecker = new InstallationIntegrityChecker(config);

  const lockfile = await Lockfile.fromDirectory(config.cwd);
  const install = new Install(flags, config, reporter, lockfile);

  // get patterns that are installed when running `yarn install`
  const {patterns, workspaceLayout} = await install.fetchRequestFromCwd();

  const match = await integrityChecker.check(patterns, lockfile.cache, flags, workspaceLayout);
  for (const pattern of match.missingPatterns) {
    reportError('lockfileNotContainPattern', pattern);
  }
  if (match.integrityFileMissing) {
    reportError('noIntegrityFile');
  }
  if (match.integrityMatches === false) {
    reporter.warn(reporter.lang(integrityErrors[match.integrityError]));
    reportError('integrityCheckFailed');
  }

  if (errCount > 0) {
    throw new MessageError(reporter.lang('foundErrors', errCount));
  } else {
    reporter.success(reporter.lang('folderInSync'));
  }
}

export async function run(config: Config, reporter: Reporter, flags: Object, args: Array<string>): Promise<void> {
  if (flags.verifyTree) {
    await verifyTreeCheck(config, reporter, flags, args);
    return;
  } else if (flags.integrity) {
    await integrityHashCheck(config, reporter, flags, args);
    return;
  }

  const lockfile = await Lockfile.fromDirectory(config.cwd);
  const install = new Install(flags, config, reporter, lockfile);

  function humaniseLocation(loc: string): Array<string> {
    const relative = path.relative(path.join(config.cwd, 'node_modules'), loc);
    const normalized = path.normalize(relative).split(path.sep);
    return normalized.filter(p => p !== 'node_modules').reduce((result, part) => {
      const length = result.length;
      if (length && result[length - 1].startsWith('@') && result[length - 1].indexOf(path.sep) === -1) {
        result[length - 1] += path.sep + part;
      } else {
        result.push(part);
      }
      return result;
    }, []);
  }

  let warningCount = 0;
  let errCount = 0;
  function reportError(msg, ...vars) {
    reporter.error(reporter.lang(msg, ...vars));
    errCount++;
  }

  // get patterns that are installed when running `yarn install`
  const {patterns: rawPatterns, workspaceLayout} = await install.hydrate();
  const patterns = await install.flatten(rawPatterns);

  // check if patterns exist in lockfile
  for (const pattern of patterns) {
    if (!lockfile.getLocked(pattern) && (!workspaceLayout || !workspaceLayout.getManifestByPattern(pattern))) {
      reportError('lockfileNotContainPattern', pattern);
    }
  }

  const bundledDeps = {};
  // check if any of the node_modules are out of sync
  const res = await install.linker.getFlatHoistedTree(patterns, workspaceLayout);
  for (const [loc, {originalKey, pkg, ignore}] of res) {
    if (ignore) {
      continue;
    }

    const parts = humaniseLocation(loc);

    // grey out hoisted portions of key
    let human = originalKey;
    const hoistedParts = parts.slice();
    const hoistedKey = parts.join('#');
    if (human !== hoistedKey) {
      const humanParts = human.split('#');

      for (let i = 0; i < humanParts.length; i++) {
        const humanPart = humanParts[i];

        if (hoistedParts[0] === humanPart) {
          hoistedParts.shift();

          if (i < humanParts.length - 1) {
            humanParts[i] += '#';
          }
        } else {
          humanParts[i] = reporter.format.dim(`${humanPart}#`);
        }
      }

      human = humanParts.join('');
    }

    // skip unnecessary checks for linked dependencies
    const remoteType = pkg._reference.remote.type;
    const isLinkedDependency =
      remoteType === 'link' || remoteType === 'workspace' || (remoteType === 'file' && config.linkFileDependencies);
    const isResolution = pkg._reference.hint === 'resolution';
    if (isLinkedDependency || isResolution) {
      continue;
    }

    if (!await fs.exists(loc)) {
      if (pkg._reference.optional) {
        reporter.warn(reporter.lang('optionalDepNotInstalled', human));
      } else {
        reportError('packageNotInstalled', human);
      }
      continue;
    }

    const pkgLoc = path.join(loc, 'package.json');

    if (await fs.exists(pkgLoc)) {
      const packageJson = await config.readJson(pkgLoc);
      packageJson.version = semver.clean(packageJson.version);

      if (pkg.version !== packageJson.version) {
        // node_modules contains wrong version
        reportError('packageWrongVersion', human, pkg.version, packageJson.version);
      }

      const deps = Object.assign({}, packageJson.dependencies, packageJson.peerDependencies);
      bundledDeps[packageJson.name] = packageJson.bundledDependencies || [];

      for (const name in deps) {
        const range = deps[name];
        if (!semver.validRange(range, config.looseSemver)) {
          continue; // exotic
        }

        const subHuman = `${human}#${name}@${range}`;

        // find the package that this will resolve to, factoring in hoisting
        const possibles = [];
        let depLoc;
        for (let i = parts.length; i >= 0; i--) {
          const myParts = parts.slice(0, i).concat(name);

          // build package.json location for this position
          const myDepPkgLoc = path.join(config.cwd, 'node_modules', myParts.join(`${path.sep}node_modules${path.sep}`));

          possibles.push(myDepPkgLoc);
        }
        while (possibles.length) {
          const myDepPkgLoc = possibles.shift();
          if (await fs.exists(myDepPkgLoc)) {
            depLoc = myDepPkgLoc;
            break;
          }
        }
        if (!depLoc) {
          // we'll hit the module not install error above when this module is hit
          continue;
        }

        const depPkgLoc = path.join(depLoc, 'package.json');

        if (await fs.exists(depPkgLoc)) {
          const depPkg = await config.readJson(depPkgLoc);
          const foundHuman = `${humaniseLocation(path.dirname(depPkgLoc)).join('#')}@${depPkg.version}`;
          if (!semver.satisfies(depPkg.version, range, config.looseSemver)) {
            // module isn't correct semver
            const resPattern = install.resolutionMap.find(name, originalKey.split('#'));
            if (resPattern) {
              const resHuman = `${human}#${resPattern}`;
              const {range: resRange} = normalizePattern(resPattern);

              if (semver.satisfies(depPkg.version, resRange, config.looseSemver)) {
                reporter.warn(reporter.lang('incompatibleResolutionVersion', foundHuman, subHuman));
                warningCount++;
              } else {
                reportError('packageDontSatisfy', resHuman, foundHuman);
              }
            } else {
              reportError('packageDontSatisfy', subHuman, foundHuman);
            }

            continue;
          }

          // check for modules above us that this could be deduped to
          for (const loc of possibles) {
            const locPkg = path.join(loc, 'package.json');

            if (!await fs.exists(locPkg)) {
              continue;
            }

            const packageJson = await config.readJson(locPkg);
            const packagePath = originalKey.split('#');
            const rootDep = packagePath[0];
            const packageName = packagePath[1] || packageJson.name;

            const bundledDep = bundledDeps[rootDep] && bundledDeps[rootDep].indexOf(packageName) !== -1;
            if (
              !bundledDep &&
              (packageJson.version === depPkg.version ||
                (semver.satisfies(packageJson.version, range, config.looseSemver) &&
                  semver.gt(packageJson.version, depPkg.version, config.looseSemver)))
            ) {
              reporter.warn(
                reporter.lang(
                  'couldBeDeduped',
                  subHuman,
                  packageJson.version,
                  `${humaniseLocation(path.dirname(locPkg)).join('#')}@${packageJson.version}`,
                ),
              );
              warningCount++;
            }
            break;
          }
        }
      }
    }
  }

  if (warningCount > 1) {
    reporter.info(reporter.lang('foundWarnings', warningCount));
  }

  if (errCount > 0) {
    throw new MessageError(reporter.lang('foundErrors', errCount));
  } else {
    reporter.success(reporter.lang('folderInSync'));
  }
}