yeoman / update-notifier

Update notifications for your CLI app
BSD 2-Clause "Simplified" License
1.76k stars 132 forks source link

Notification is only displayed at most once per interval #209

Open slorber opened 3 years ago

slorber commented 3 years ago

As of 5.1.0, notifications are displayed at most once per interval period, because the fetched update is deleted once "emitted" (ie set to this.update)

        this.update = this.config.get('update');

        if (this.update) {
            // Use the real latest version instead of the cached one
            this.update.current = this.packageVersion;

            // Clear cached information
            this.config.delete('update');
        }

This is a bit weird to me, wouldn't it be better if the update message was displayed consistently as long as there is an update? Some users might miss that there is an available update quite easily.

Some workarounds I'm using to ensure that once an update gets fetched, it remains visible, and trying to fetch it before the first interval:

// Hacky way to ensure we check for updates on first run
// Note: the notification will only happen in the 2nd run anyway
if (
  !notifier.disabled &&
  Date.now() - notifier.config.get('lastUpdateCheck') < 50
) {
  notifier.config.set('lastUpdateCheck', 0);
  notifier.check();
}

if (notifier.update && notifier.update.current !== notifier.update.latest) {
  // Because notifier clears cached data after reading it, leading to notifier not consistently displaying the update
  notifier.config.set('update', notifier.update);

  // Display notification
}

Having a more convenient way to achieve all this could be useful

sindresorhus commented 3 years ago

This behavior is intentional. When we made this package, we wanted it to be as unobtrusive as possible.

That being said, I'm open to having an option added that changes the behavior, but I still believe the current behavior is the best default.

sindresorhus commented 3 years ago

This is a bit weird to me, wouldn't it be better if the update message was displayed consistently as long as there is an update?

What if the user cannot upgrade for some reason? Then they will be bothered by an update notification they every time they run your CLI.

slorber commented 3 years ago

Considering there's a way to disable the update-notifier already, they can just temporarily disable it.

I can also expose my own way to allow disabling this through our own config, so that it's clearly documented for my users. The notification may even link to that config option doc so that user can disable it very easily