feat: add update and rollback commands, and cli new version update core plugin #132

shazron · 2020-03-30T05:54:48Z

Description

The update command will update all installed plugins by checking for any updated versions in the npm registry (with --interactive mode available). Note that this will not check for any updates for any non @adobe namespaced core plugins, for compatibility reasons.

The rollback command will uninstall all user-installed plugins (with --interactive mode available).

Through a hook via the @oclif/plugin-warn-if-update-available plugin, npm is checked whether there is a newer version of the CLI available, and it will warn the user. This is shown at every command (can't turn it off) but it has a timeout of 7 days (so after 7 days of warnings, it won't prompt the user anymore).

Motivation and Context

Update of installed plugins (including core plugins) without a CLI reinstall
Reminder to user that a newer cli version is available

How Has This Been Tested?

npm test
manual tests

Types of changes

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

I have signed the Adobe Open Source CLA.
My code follows the code style of this project.
My change requires a change to the documentation.
I have updated the documentation accordingly.
I have read the CONTRIBUTING document.
I have added tests to cover my changes.
All new and existing tests passed.

codecov · 2020-03-31T06:10:22Z

Codecov Report

Merging #132 into master will not change coverage by %.
The diff coverage is 100.00%.

@@            Coverage Diff             @@
##            master      #132    +/-   ##
==========================================
  Coverage   100.00%   100.00%            
==========================================
  Files            3         5     +2     
  Lines           69       180   +111     
  Branches        10        25    +15     
==========================================
+ Hits            69       180   +111

Impacted Files	Coverage Δ
src/commands/rollback.js	`100.00% <100.00%> (ø)`
src/commands/update.js	`100.00% <100.00%> (ø)`
src/helpers.js	`100.00% <100.00%> (ø)`

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 07ce9cc...d538097. Read the comment docs.

The update command will update all installed plugins by checking for any updated versions in the npm registry (with --interactive mode available). The clear command will uninstall all user-installed plugins (with --interactive mode available). This command is also aliased to `plugins:clear` 100% coverage on tests

…adobe namespaced core plugins

purplecabbage

This looks good, I have noted a few possible issues.
I am not crazy about us adding more commands without a topic, the aio clear command to me is a bit unclear what it does without digging deeper. ( no pun intended )

purplecabbage · 2020-04-01T19:04:13Z

src/commands/update.js

+   */
+  async run () {
+    const { flags } = this.parse(UpdateCommand)
+    const spinner = ora()


Why not use cli-ux.action.start/stop and not add a dependency on ora?

actually cli-ux is not even a dependency of the base cli (check package.json). It just so happens to be a dependency of a dependency (I'm thinking runtime plugin). Also, I needed a spinner that "goes away" after use, cli-ux's spinner does not do that, nor can I specify an empty string.

Looks like the discover command uses cli-ux as well, which is not a dependency as I mentioned. In any case, we need to add cli-ux as a dependency here because of cli.table.

how did it ever work?

i mentioned above "dependency of a dependency had cli-ux". so it was in node_modules

there is a eslint plugin that would have detected this https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/no-extraneous-dependencies.md

forgot to mention (See the Slack thread), aio clear is now aio rollback. I reflected it in the issue description and title when I finalized the PR yesterday.

purplecabbage · 2020-04-01T19:11:07Z

src/commands/update.js

+   * @param {Array<InstalledPlugin>} installedPlugins
+   * @returns {Array<ToUpdatePlugin}
+   */
+  async __processPlugins () {


nit: At some point some of us started putting double __methodPrefix to signify that something is private or not exported. Personally, I don't really like this practice.
https://github.com/airbnb/javascript#naming--leading-underscore

Initially I wanted the functions into a the helper module. But since these functions heavily use base command functionality (this.config, etc), I kept it here. Until we have private functions in EcmaScript classes, this visual convention would have to do. The only public contract we have with devs is the run() function, nothing else.

purplecabbage · 2020-04-01T19:24:40Z

src/commands/update.js

+      const { type, name, version: currentVersion } = plugin
+      const latestVersion = await getNpmLatestVersion(name)
+      let coreVersion = (type === 'core') ? currentVersion : null
+      const needsUpdate = (latestVersion > currentVersion)


I think we probably need to go full semver here and not just text compare, there are numerous edge cases which I don't see covered by tests. ie. v1.0.0 or 2.8.3-lts
https://www.npmjs.com/package/semver

good catch, i'll fix

@purplecabbage PR updated

…qual to core plugin versions

shazron marked this pull request as ready for review March 31, 2020 06:21

shazron changed the title ~~WIP feat: add update and clear commands~~ feat: add update and clear commands Mar 31, 2020

feat: add @oclif/plugin-warn-if-update-available as a core plugin

d577519

shazron changed the title ~~feat: add update and clear commands~~ feat: add update and clear commands, and cli new version update core plugin Mar 31, 2020

fix: change aio clear to aio rollback. aio update only updates @…

e918b7f

…adobe namespaced core plugins

shazron requested a review from purplecabbage April 1, 2020 12:01

shazron changed the title ~~feat: add update and clear commands, and cli new version update core plugin~~ feat: add update and rollback commands, and cli new version update core plugin Apr 1, 2020

purplecabbage reviewed Apr 1, 2020

View reviewed changes

shazron added 2 commits April 2, 2020 16:12

fix: use semver module to compare versions

f7156f6

fix: print out warning for user-installed plugins that are older or e…

d538097

…qual to core plugin versions

purplecabbage approved these changes Apr 2, 2020

View reviewed changes

shazron merged commit 20bba9f into adobe:master Apr 2, 2020

shazron deleted the autoupdate branch April 2, 2020 09:26

sarahxxu mentioned this pull request Jun 24, 2020

aio update only updates the plugins but not the CLI itself #193

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: add update and rollback commands, and cli new version update core plugin #132

feat: add update and rollback commands, and cli new version update core plugin #132

shazron commented Mar 30, 2020 •

edited

Loading

codecov bot commented Mar 31, 2020 •

edited

Loading

purplecabbage left a comment

purplecabbage Apr 1, 2020

shazron Apr 2, 2020 •

edited

Loading

shazron Apr 2, 2020

purplecabbage Apr 2, 2020

shazron Apr 2, 2020

shazron Apr 2, 2020

shazron Apr 2, 2020

purplecabbage Apr 1, 2020

shazron Apr 2, 2020

purplecabbage Apr 1, 2020

shazron Apr 2, 2020

shazron Apr 2, 2020

feat: add update and rollback commands, and cli new version update core plugin #132

feat: add update and rollback commands, and cli new version update core plugin #132

Conversation

shazron commented Mar 30, 2020 • edited Loading

Description

Motivation and Context

How Has This Been Tested?

Types of changes

Checklist:

codecov bot commented Mar 31, 2020 • edited Loading

Codecov Report

purplecabbage left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

shazron Apr 2, 2020 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

shazron commented Mar 30, 2020 •

edited

Loading

codecov bot commented Mar 31, 2020 •

edited

Loading

shazron Apr 2, 2020 •

edited

Loading