Skip to content

[FEATURE] Recent update warning #81

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 12 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion .npm-upgrade.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,10 @@
"versions": ">=6.0.0",
"reason": "^5 is required for 'eslint-config-th0r'"
}
},
"recentUpdates": {
"info": "3d",
"warning": "2d",
"caution": "1d"
}
}
}
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,9 @@ Update "@angular/common" in package.json from 2.4.8 to 2.4.10? (Use arrow keys)
* `Ignore` will add this module to the ignored list (see details in [`Ignoring module`](#ignoring-module) section below).
* `Finish update process` will ...hm... finish update process and save all the changes to `package.json`.

> [!NOTE]
> By default, `npm-upgrade` will show warnings for modules that have recent updates (by default, within the last 3 days). You can change this behavior by modifying `config.recentUpdates` in your `~/.npm-upgrade/config.json` file. For example, you can set it to `{"info": "1d", "warning": "2d", "caution": "3d"}` to show warnings for modules updated within the last 1 day, 2 days, and 3 days respectively.

A note on saving changes to `package.json`: when you choose `Yes` to update some module's version, `package.json` won't be immediately updated. It will be updated only after you will process all the outdated modules and confirm update **or** when you choose `Finish update process`. So if in the middle of the update process you've changed your mind just press `Ctrl+C` and `package.json` will remain untouched.

If you want to check only some deps, you can use `filter` argument:
Expand Down
6 changes: 6 additions & 0 deletions src/Config.js
Original file line number Diff line number Diff line change
Expand Up @@ -80,3 +80,9 @@ function cleanDeep(obj) {

return obj;
}

export const RECENT_UPDATES_DEFAULT = {
info: '3d',
warning: '2d',
caution: '1d'
};
6 changes: 5 additions & 1 deletion src/cliStyles.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
import {white, green, yellow} from 'chalk';
import {white, green, yellow, black} from 'chalk';

export const strong = white.bold;
export const success = green.bold;
export const attention = yellow.bold;

export const upgradeCaution = black.bgRed;
export const upgradeWarning = black.bgYellow;
export const upgradeInfo = black.bgWhite;
50 changes: 46 additions & 4 deletions src/commands/check.js
Original file line number Diff line number Diff line change
Expand Up @@ -12,14 +12,15 @@ import {colorizeDiff} from 'npm-check-updates/lib/version-util';
import catchAsyncError from '../catchAsyncError';
import {makeFilterFunction} from '../filterUtils';
import {DEPS_GROUPS, loadGlobalPackages, loadPackageJson, setModuleVersion,
getModuleInfo, getModuleHomepage} from '../packageUtils';
getModuleInfo, getModuleHomepage, getVersionPublicationDate,
getModuleVersions} from '../packageUtils';
import {fetchRemoteDb, findModuleChangelogUrl} from '../changelogUtils';
import {createSimpleTable} from '../cliTable';
import {strong, success, attention} from '../cliStyles';
import {strong, success, attention, upgradeCaution, upgradeWarning, upgradeInfo} from '../cliStyles';
import askUser from '../askUser';
import {toSentence} from '../stringUtils';
import {toSentence, toTimespan} from '../stringUtils';
import {askIgnoreFields} from './ignore';
import Config from '../Config';
import Config, {RECENT_UPDATES_DEFAULT} from '../Config';

const pkg = require('../../package.json');

Expand Down Expand Up @@ -140,6 +141,24 @@ export const handler = catchAsyncError(async opts => {
console.log(`\n${strong('Ignored updates:')}\n\n${createSimpleTable(rows)}`);
}

let infoTime = toTimespan(config.recentUpdates?.info ?? RECENT_UPDATES_DEFAULT.info);
let warningTime = toTimespan(config.recentUpdates?.warning ?? RECENT_UPDATES_DEFAULT.warning);
let cautionTime = toTimespan(config.recentUpdates?.caution ?? RECENT_UPDATES_DEFAULT.caution);

// If timespan are not valid, print an error and set to default values
if (infoTime < warningTime || infoTime < cautionTime || warningTime < cautionTime) {
console.error('Invalid timespan values in config.recentUpdates. Using default values.');
infoTime = toTimespan(RECENT_UPDATES_DEFAULT.info);
warningTime = toTimespan(RECENT_UPDATES_DEFAULT.warning);
cautionTime = toTimespan(RECENT_UPDATES_DEFAULT.caution);
}

// Preload published dates in the background before the loop
const publishedDatesCache = {};
modulesToUpdate.forEach(({name, to}) => {
publishedDatesCache[`${name}@${to}`] = getVersionPublicationDate(name, to);
});

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

what're you actually trying to do because this just doesn't look right?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am adding every promises to the object so that they can resolve in the background and be awaited once needed in the loop.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

that's not really how promises work. nothing will resolve until they're awaited.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

that's not really how promises work. nothing will resolve until they're awaited.

What would be the best way to approach this issue then?

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

what're you actually trying to do?


const updatedModules = [];
let isUpdateFinished = false;
while (modulesToUpdate.length && !isUpdateFinished) {
Expand All @@ -150,6 +169,29 @@ export const handler = catchAsyncError(async opts => {
// Adds new line
console.log('');

// This checks if the package was released less than N days ago, throws a warning if true
const publishedDate = new Date(await publishedDatesCache[`${name}@${to}`]);
// This is N days prior to execution time.
const recommendedDatePrior = new Date(Date.now() - infoTime);
const isRecent = publishedDate.getTime() > recommendedDatePrior.getTime();
if (isRecent) {
const timeSincePublication = new Date(Date.now()).getTime() - publishedDate.getTime();
const warningLevel = (isRecent
&& timeSincePublication < cautionTime) ? 'caution'
: (timeSincePublication < warningTime) ? 'warning'
: 'info';
let message = (warningLevel === 'caution')
? upgradeCaution('CAUTION') : (warningLevel === 'warning')
? upgradeWarning('WARN') : upgradeInfo('INFO');

const versions = await getModuleVersions(name);
const resolvedVersion = semver.maxSatisfying(Object.keys(versions), to);
message += ` ${name}@${resolvedVersion} was released less than ${Math.ceil(
timeSincePublication / toTimespan('1d')
)} days ago, be careful when upgrading.`;
console.log(message);
}

const answer = await askUser({
type: 'list',
message: `${changelogUrl === undefined ? 'U' : 'So, u'}pdate "${name}" ${opts.global ? 'globally' :
Expand Down
14 changes: 14 additions & 0 deletions src/packageUtils.js
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ import pacote from 'pacote';
import shell from 'shelljs';

import _ from 'lodash';
import got from 'got';
import {maxSatisfying, validRange} from 'semver';

export const DEPS_GROUPS = [
{name: 'global', field: 'dependencies', flag: 'g', ncuValue: 'prod'},
Expand Down Expand Up @@ -108,3 +110,15 @@ export const getModuleInfo = _.memoize(async moduleName =>
fullMetadata: true
})
);

export const getModuleVersions = _.memoize(async moduleName => {
const moduleData = await got(`https://registry.npmjs.org/${moduleName}/`).json();
return moduleData.time;
});

// This function returns the publication date of a specific module version.
export const getVersionPublicationDate = _.memoize(async (moduleName, version) => {
const versions = await getModuleVersions(moduleName);
const resolvedVersion = maxSatisfying(Object.keys(versions), validRange(version));
return versions[resolvedVersion] || null;
}, (moduleName, version) => `${moduleName}@${version}`);
23 changes: 23 additions & 0 deletions src/stringUtils.js
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,26 @@ export function toSentence(items) {

return items.slice(0, -1).join(', ') + ' and ' + items[items.length - 1];
}

export function toTimespan(string) {
const match = string.match(/^(\d+)([smhd])$/);
if (!match) {
return null;
}

const value = parseInt(match[1], 10);
const unit = match[2];

switch (unit) {
case 's':
return value * 1000;
case 'm':
return value * 60 * 1000;
case 'h':
return value * 60 * 60 * 1000;
case 'd':
return value * 24 * 60 * 60 * 1000;
default:
return null;
}
}