versionmanager.js 23.1 KB
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520
'use strict';
const semver = require('semver');
const _ = require('lodash');
const cint = require('cint');
const chalk = require('chalk');
const minimatch = require('minimatch');
const semverutils = require('semver-utils');
const ProgressBar = require('progress');
const prompts = require('prompts');
const pMap = require('p-map');
const { and } = require('fp-and-or');
const versionUtil = require('./version-util');
const packageManagers = require('./package-managers');
const { supportedVersionTargets } = require('./constants');
/**
 * Upgrade a dependencies collection based on latest available versions. Supports npm aliases.
 *
 * @param currentDependencies current dependencies collection object
 * @param latestVersions latest available versions collection object
 * @param [options={}]
 * @returns upgraded dependency collection object
 */
function upgradeDependencies(currentDependencies, latestVersions, options = {}) {
    // filter out dependencies with empty values
    currentDependencies = cint.filterObject(currentDependencies, (key, value) => value);
    // get the preferred wildcard and bind it to upgradeDependencyDeclaration
    const wildcard = getPreferredWildcard(currentDependencies) || versionUtil.DEFAULT_WILDCARD;
    /** Upgrades a single dependency. */
    const upgradeDep = (current, latest) => versionUtil.upgradeDependencyDeclaration(current, latest, {
        wildcard,
        removeRange: options.removeRange
    });
    return _(currentDependencies)
        // only include packages for which a latest version was fetched
        .pickBy((current, packageName) => packageName in latestVersions)
        // unpack npm alias and git urls
        .mapValues((current, packageName) => {
        const latest = latestVersions[packageName];
        let currentParsed = null;
        let latestParsed = null;
        // parse npm alias
        if (versionUtil.isNpmAlias(current)) {
            currentParsed = versionUtil.parseNpmAlias(current)[1];
            latestParsed = versionUtil.parseNpmAlias(latest)[1];
        }
        // "branch" is also used for tags (refers to everything after the hash character)
        if (versionUtil.isGithubUrl(current)) {
            const currentTag = versionUtil.getGithubUrlTag(current);
            const [currentSemver] = semverutils.parseRange(currentTag);
            currentParsed = versionUtil.stringify(currentSemver, 'patch');
            const latestTag = versionUtil.getGithubUrlTag(latest);
            const [latestSemver] = semverutils.parseRange(latestTag);
            latestParsed = versionUtil.stringify(latestSemver, 'patch');
        }
        return { current, currentParsed, latest, latestParsed };
    })
        // pick the packages that are upgradeable
        .pickBy(({ current, currentParsed, latest, latestParsed }) => isUpgradeable(currentParsed || current, latestParsed || latest))
        // pack embedded versions: npm aliases and git urls
        .mapValues(({ current, currentParsed, latest, latestParsed }) => {
        const upgraded = upgradeDep(currentParsed || current, latestParsed || latest);
        return versionUtil.isNpmAlias(current) ? versionUtil.upgradeNpmAlias(current, upgraded)
            : versionUtil.isGithubUrl(current) ? versionUtil.upgradeGithubUrl(current, upgraded)
                : upgraded;
    })
        .value();
}
// Determines if the given version (range) should be upgraded to the latest (i.e. it is valid, it does not currently
/**
 * Return true if the version satisfies the range.
 *
 * @type {Function}
 * @param {string} version
 * @param {string} range
 * @returns {boolean}
 */
const isSatisfied = semver.satisfies;
/**
 * Check if a version satisfies the latest, and is not beyond the latest). Ignores `v` prefix.
 *
 * @param current
 * @param latest
 * @returns
 */
function isUpgradeable(current, latest) {
    // do not upgrade non-npm version declarations (such as git tags)
    // do not upgrade versionUtil.wildcards
    if (!semver.validRange(current) || versionUtil.isWildCard(current)) {
        return false;
    }
    // remove the constraint (e.g. ^1.0.1 -> 1.0.1) to allow upgrades that satisfy the range, but are out of date
    const [range] = semverutils.parseRange(current);
    if (!range) {
        throw new Error(`"${current}" could not be parsed by semver-utils. This is probably a bug. Please file an issue at https://github.com/raineorshine/npm-check-updates.`);
    }
    const version = versionUtil.stringify(range);
    // allow upgrading of pseudo versions such as "v1" or "1.0"
    const latestNormalized = versionUtil.fixPseudoVersion(latest);
    const isValidCurrent = Boolean(semver.validRange(version));
    const isValidLatest = Boolean(semver.valid(latestNormalized));
    // make sure it is a valid range
    // not upgradeable if the latest version satisfies the current range
    // not upgradeable if the specified version is newer than the latest (indicating a prerelease version)
    // NOTE: When "<" is specified with a single digit version, e.g. "<7", and has the same major version as the latest, e.g. "7", isSatisfied(latest, version) will return true since it ignores the "<". In this case, test the original range (current) rather than the versionUtil output (version).
    return isValidCurrent &&
        isValidLatest &&
        !isSatisfied(latestNormalized, range.operator === '<' ? current : version) &&
        !semver.ltr(latestNormalized, version);
}
/**
 * @typedef {string|string[]|RegExp} FilterObject
 */
/**
 * Creates a filter function from a given filter string. Supports
 * strings, wildcards, comma-or-space-delimited lists, and regexes.
 *
 * @param [filter]
 * @returns
 */
function composeFilter(filterPattern) {
    let predicate;
    // no filter
    if (!filterPattern) {
        predicate = _.identity;
    }
    // string
    else if (typeof filterPattern === 'string') {
        // RegExp string
        if (filterPattern[0] === '/' && filterPattern[filterPattern.length - 1] === '/') {
            const regexp = new RegExp(filterPattern.slice(1, -1));
            predicate = s => regexp.test(s);
        }
        // glob string
        else {
            const patterns = filterPattern.split(/[\s,]+/);
            predicate = s => patterns.some(pattern => minimatch(s, pattern));
        }
    }
    // array
    else if (Array.isArray(filterPattern)) {
        predicate = s => filterPattern.some(subpattern => composeFilter(subpattern)(s));
    }
    // raw RegExp
    else if (filterPattern instanceof RegExp) {
        predicate = s => filterPattern.test(s);
    }
    else {
        throw new TypeError('Invalid filter. Must be a RegExp, array, or comma-or-space-delimited list.');
    }
    // limit the arity to 1 to avoid passing the value
    return predicate;
}
/**
 * Composes a filter function from filter, reject, filterVersion, and rejectVersion patterns.
 *
 * @param filter
 * @param reject
 * @param filterVersion
 * @param rejectVersion
 */
function filterAndReject(filter, reject, filterVersion, rejectVersion) {
    return and(
    // filter dep
    (dep, version) => and(filter ? composeFilter(filter) : _.identity, reject ? _.negate(composeFilter(reject)) : _.identity)(dep), 
    // filter version
    (dep, version) => and(filterVersion ? composeFilter(filterVersion) : _.identity, rejectVersion ? _.negate(composeFilter(rejectVersion)) : _.identity)(version));
}
/**
 * Return a promise which resolves to object storing package owner changed status for each dependency.
 *
 * @param fromVersion current packages version.
 * @param toVersion target packages version.
 * @param options
 * @returns
 */
async function getOwnerPerDependency(fromVersion, toVersion, options) {
    const packageManager = getPackageManager(options.packageManager);
    return await Object.keys(toVersion).reduce(async (accum, dep) => {
        const from = fromVersion[dep] || null;
        const to = toVersion[dep] || null;
        const ownerChanged = await packageManager.packageAuthorChanged(dep, from, to, options);
        return {
            ...accum,
            [dep]: ownerChanged,
        };
    }, {});
}
/**
 * Returns an 3-tuple of upgradedDependencies, their latest versions and the resulting peer dependencies.
 *
 * @param currentDependencies
 * @param options
 * @returns
 */
async function upgradePackageDefinitions(currentDependencies, options) {
    const latestVersions = await queryVersions(currentDependencies, options);
    const upgradedDependencies = upgradeDependencies(currentDependencies, latestVersions, {
        removeRange: options.removeRange
    });
    const filteredUpgradedDependencies = _.pickBy(upgradedDependencies, (v, dep) => {
        return !options.jsonUpgraded || !options.minimal || !isSatisfied(latestVersions[dep], currentDependencies[dep]);
    });
    if (options.peer && !_.isEmpty(filteredUpgradedDependencies)) {
        const upgradedPeerDependencies = await getPeerDependenciesFromRegistry(filteredUpgradedDependencies, options);
        const peerDependencies = { ...options.peerDependencies, ...upgradedPeerDependencies };
        if (!_.isEqual(options.peerDependencies, peerDependencies)) {
            const [newUpgradedDependencies, newLatestVersions, newPeerDependencies] = await upgradePackageDefinitions({ ...currentDependencies, ...filteredUpgradedDependencies }, { ...options, peerDependencies, loglevel: 'silent' });
            return [
                { ...filteredUpgradedDependencies, ...newUpgradedDependencies },
                { ...latestVersions, ...newLatestVersions },
                newPeerDependencies
            ];
        }
    }
    return [filteredUpgradedDependencies, latestVersions, options.peerDependencies];
}
/**
 * Upgrade the dependency declarations in the package data.
 *
 * @param pkgData The package.json data, as utf8 text
 * @param oldDependencies Old dependencies {package: range}
 * @param newDependencies New dependencies {package: range}
 * @param newVersions New versions {package: version}
 * @param [options={}]
 * @returns The updated package data, as utf8 text
 * @description Side Effect: prompts
 */
async function upgradePackageData(pkgData, oldDependencies, newDependencies, newVersions, options = {}) {
    // copy newDependencies for mutation via interactive mode
    const selectedNewDependencies = { ...newDependencies };
    let newPkgData = pkgData;
    // eslint-disable-next-line fp/no-loops
    for (const dependency in newDependencies) {
        if (!options.minimal || !isSatisfied(newVersions[dependency], oldDependencies[dependency])) {
            if (options.interactive) {
                const to = versionUtil.colorizeDiff(oldDependencies[dependency], newDependencies[dependency] || '');
                const response = await prompts({
                    type: 'confirm',
                    name: 'value',
                    message: `Do you want to upgrade: ${dependency} ${oldDependencies[dependency]}${to}?`,
                    initial: true,
                    onState: state => {
                        if (state.aborted) {
                            process.nextTick(() => process.exit(1));
                        }
                    }
                });
                if (!response.value) {
                    // continue loop to next dependency and skip updating newPkgData
                    delete selectedNewDependencies[dependency]; // eslint-disable-line fp/no-delete
                    continue;
                }
            }
            const expression = `"${dependency}"\\s*:\\s*"${escapeRegexp(`${oldDependencies[dependency]}"`)}`;
            const regExp = new RegExp(expression, 'g');
            newPkgData = newPkgData.replace(regExp, `"${dependency}": "${newDependencies[dependency]}"`);
        }
    }
    return { newPkgData, selectedNewDependencies };
}
/** Returns true if spec1 is greater than spec2, ignoring invalid version ranges. */
const isGreaterThanSafe = (spec1, spec2) => 
// not a valid range to compare (e.g. github url)
semver.validRange(spec1) &&
    semver.validRange(spec2) &&
    // otherwise return true if spec2 is smaller than spec1
    semver.gt(semver.minVersion(spec1), semver.minVersion(spec2));
/**
 * Get the current dependencies from the package file.
 *
 * @param [pkgData={}] Object with dependencies, devDependencies, peerDependencies, optionalDependencies, and/or bundleDependencies properties
 * @param [options={}]
 * @param options.dep
 * @param options.filter
 * @param options.reject
 * @returns Promised {packageName: version} collection
 */
function getCurrentDependencies(pkgData = {}, options = {}) {
    const depOptions = options.dep
        ? (options.dep || '').split(',')
        // exclude peerDependencies
        // https://github.com/raineorshine/npm-check-updates/issues/951
        : ['dev', 'optional', 'prod', 'bundle'];
    // map the dependency section option to a full dependency section name
    const depSections = depOptions.map(short => short === 'prod' ? 'dependencies' : short + 'Dependencies');
    // get all dependencies from the selected sections
    // if a dependency appears in more than one section, take the lowest version number
    const allDependencies = depSections.reduce((accum, depSection) => {
        return {
            ...accum,
            ...cint.filterObject(pkgData[depSection], (dep, spec) => !isGreaterThanSafe(spec, accum[dep]))
        };
    }, {});
    // filter & reject dependencies and versions
    const filteredDependencies = cint.filterObject(allDependencies, filterAndReject(options.filter, options.reject, options.filterVersion, options.rejectVersion));
    return filteredDependencies;
}
/** Get all upgrades that are ignored due to incompatible peer dependencies. */
async function getIgnoredUpgrades(current, upgraded, upgradedPeerDependencies, options = {}) {
    const [upgradedLatestVersions, latestVersions] = await upgradePackageDefinitions(current, { ...options, peer: false, peerDependencies: undefined, loglevel: 'silent' });
    return Object.entries(upgradedLatestVersions)
        .filter(([pkgName, newVersion]) => upgraded[pkgName] !== newVersion)
        .reduce((accum, [pkgName, newVersion]) => ({
        ...accum,
        [pkgName]: {
            from: current[pkgName],
            to: newVersion,
            reason: Object.entries(upgradedPeerDependencies)
                .filter(([, peers]) => peers[pkgName] !== undefined && !semver.satisfies(latestVersions[pkgName], peers[pkgName]))
                .reduce((accumReason, [peerPkg, peers]) => ({ ...accumReason, [peerPkg]: peers[pkgName] }), {})
        }
    }), {});
}
/**
 * @param [options]
 * @param options.cwd
 * @param options.filter
 * @param options.global
 * @param options.packageManager
 * @param options.prefix
 * @param options.reject
 */
async function getInstalledPackages(options = {}) {
    const pkgInfoObj = await getPackageManager(options.packageManager)
        .list({ cwd: options.cwd, prefix: options.prefix, global: options.global });
    if (!pkgInfoObj) {
        throw new Error('Unable to retrieve NPM package list');
    }
    // filter out undefined packages or those with a wildcard
    const filterFunction = filterAndReject(options.filter, options.reject, options.filterVersion, options.rejectVersion);
    return cint.filterObject(pkgInfoObj, (dep, version) => version && !versionUtil.isWildPart(version) && filterFunction(dep, version));
}
/**
 * Get the latest or greatest versions from the NPM repository based on the version target.
 *
 * @param packageMap   An object whose keys are package name and values are current versions. May include npm aliases, i.e. { "package": "npm:other-package@1.0.0" }
 * @param [options={}] Options. Default: { target: 'latest' }.
 * @returns Promised {packageName: version} collection
 */
async function queryVersions(packageMap, options = {}) {
    const target = options.target || 'latest';
    const packageList = Object.keys(packageMap);
    const packageManager = getPackageManager(options.packageManager);
    let bar;
    if (!options.json && options.loglevel !== 'silent' && options.loglevel !== 'verbose' && packageList.length > 0) {
        bar = new ProgressBar('[:bar] :current/:total :percent', { total: packageList.length, width: 20 });
        bar.render();
    }
    // set the getPackageVersion function from options.target
    const getPackageVersion = packageManager[target];
    if (!getPackageVersion) {
        const packageManagerSupportedVersionTargets = supportedVersionTargets.filter(t => t in packageManager);
        return Promise.reject(new Error(`Unsupported target "${target}" for ${options.packageManager || 'npm'}. Supported version targets are: ${packageManagerSupportedVersionTargets.join(', ')}`));
    }
    /**
     * Ignore 404 errors from getPackageVersion by having them return `null`
     * instead of rejecting.
     *
     * @param dep
     * @returns
     */
    async function getPackageVersionProtected(dep) {
        const npmAlias = versionUtil.parseNpmAlias(packageMap[dep]);
        const [name, version] = npmAlias || [dep, packageMap[dep]];
        let versionNew = null;
        // use gitTags package manager for git urls
        if (versionUtil.isGithubUrl(packageMap[dep])) {
            // override packageManager and getPackageVersion just for this dependency
            const packageManager = packageManagers.gitTags;
            const getPackageVersion = packageManager[target];
            if (!getPackageVersion) {
                const packageManagerSupportedVersionTargets = supportedVersionTargets.filter(t => t in packageManager);
                return Promise.reject(new Error(`Unsupported target "${target}" for github urls. Supported version targets are: ${packageManagerSupportedVersionTargets.join(', ')}`));
            }
            versionNew = await getPackageVersion(name, version, {
                ...options,
                // upgrade prereleases to newer prereleases by default
                pre: options.pre != null ? options.pre : versionUtil.isPre(version),
            });
        }
        else {
            try {
                versionNew = await getPackageVersion(name, version, {
                    ...options,
                    // upgrade prereleases to newer prereleases by default
                    pre: options.pre != null ? options.pre : versionUtil.isPre(version),
                });
                versionNew = npmAlias ? versionUtil.createNpmAlias(name, versionNew) : versionNew;
            }
            catch (err) {
                const errorMessage = err ? (err.message || err).toString() : '';
                if (!errorMessage.match(/E404|ENOTFOUND|404 Not Found/i)) {
                    // print a hint about the --timeout option for network timeout errors
                    if (!process.env.NCU_TESTS && /(Response|network) timeout/i.test(errorMessage)) {
                        console.error('\n\n' + chalk.red('FetchError: Request Timeout. npm-registry-fetch defaults to 30000 (30 seconds). Try setting the --timeout option (in milliseconds) to override this.') + '\n');
                    }
                    throw err;
                }
            }
        }
        if (bar) {
            bar.tick();
        }
        return versionNew;
    }
    /**
     * Zip up the array of versions into to a nicer object keyed by package name.
     *
     * @param versionList
     * @returns
     */
    const zipVersions = versionList => cint.toObject(versionList, (version, i) => ({
        [packageList[i]]: version
    }));
    const versions = await pMap(packageList, getPackageVersionProtected, { concurrency: options.concurrency });
    return _.pickBy(zipVersions(versions), _.identity);
}
/**
 * Get the latest or greatest versions from the NPM repository based on the version target.
 *
 * @param packageMap   An object whose keys are package name and values are version
 * @param [options={}] Options.
 * @returns Promised {packageName: peer dependencies} collection
 */
async function getPeerDependenciesFromRegistry(packageMap, options) {
    const packageManager = getPackageManager(options.packageManager);
    if (!packageManager.getPeerDependencies)
        return {};
    const numItems = Object.keys(packageMap).length;
    let bar;
    if (!options.json && options.loglevel !== 'silent' && options.loglevel !== 'verbose' && numItems > 0) {
        bar = new ProgressBar('[:bar] :current/:total :percent', { total: numItems, width: 20 });
        bar.render();
    }
    return Object.entries(packageMap).reduce(async (accumPromise, [pkg, version]) => {
        const dep = await packageManager.getPeerDependencies(pkg, version);
        if (bar) {
            bar.tick();
        }
        const accum = await accumPromise;
        return { ...accum, [pkg]: dep };
    }, {});
}
/**
 *
 * @param dependencies A dependencies collection
 * @returns Returns whether the user prefers ^, ~, .*, or .x
 * (simply counts the greatest number of occurrences) or `null` if
 * given no dependencies.
 */
function getPreferredWildcard(dependencies) {
    // if there are no dependencies, return null.
    if (Object.keys(dependencies).length === 0) {
        return null;
    }
    // group the dependencies by wildcard
    const groups = _.groupBy(Object.values(dependencies), dep => versionUtil.WILDCARDS.find(wildcard => dep && dep.includes(wildcard)));
    delete groups.undefined; // eslint-disable-line fp/no-delete
    // convert to an array of objects that can be sorted
    const arrOfGroups = cint.toArray(groups, (wildcard, instances) => ({
        wildcard,
        instances
    }));
    // reverse sort the groups so that the wildcard with the most appearances is at the head, then return it.
    const sorted = _.sortBy(arrOfGroups, wildcardObject => -wildcardObject.instances.length);
    return sorted.length > 0 ? sorted[0].wildcard : null;
}
/**
 * Initialize the version manager with the given package manager.
 *
 * @param packageManagerNameOrObject
 * @param packageManagerNameOrObject.global
 * @param packageManagerNameOrObject.packageManager
 * @returns
 */
function getPackageManager(packageManagerNameOrObject) {
    /** Get one of the preset package managers or throw an error if there is no match. */
    function getPresetPackageManager(packageManagerName) {
        if (!(packageManagerName in packageManagers)) {
            throw new Error(`Invalid package manager: ${packageManagerName}`);
        }
        return packageManagers[packageManagerName];
    }
    return !packageManagerNameOrObject ? packageManagers.npm : // default to npm
        // use present package manager if name is specified
        typeof packageManagerNameOrObject === 'string' ? getPresetPackageManager(packageManagerNameOrObject) :
            // use provided package manager object otherwise
            packageManagerNameOrObject;
}
//
// Helper functions
//
/**
 * @param s
 * @returns String safe for use in `new RegExp()`
 */
function escapeRegexp(s) {
    return s.replace(/[-/\\^$*+?.()|[\]{}]/g, '\\$&'); // Thanks Stack Overflow!
}
//
// API
//
module.exports = {
    // used directly by cli.js
    getCurrentDependencies,
    getInstalledPackages,
    isSatisfied,
    upgradePackageData,
    upgradePackageDefinitions,
    getOwnerPerDependency,
    // exposed for testing
    getPreferredWildcard,
    isUpgradeable,
    queryVersions,
    upgradeDependencies,
    getPackageManager,
    getPeerDependenciesFromRegistry,
    getIgnoredUpgrades,
};
//# sourceMappingURL=versionmanager.js.map