Introduce CLI update banner #3422

nilbus · 2017-03-22T04:01:41Z

This branch introduces a banner asking people to update to [currently-unreleased] cli version 2.4.0.

I'm guessing 2.4.0 will be the version number according to semantic versioning, because master contains a new configuration option from exercism/cli#366 and debatably the -m short option in exercism/cli#359.

Feature name: advertise_cli_update

Todo:

Conditionally show a banner message
Create User migration to track when the message was dismissed, forward-compatible with Track each user's client version, and notify when there are updates #3416
Limit after hook from running on each request multiple times
Complete ClientVersion tests
Update client_version_notification_dismissed_at when then flash notice is dismissed
Test manually
- Does not appear when logged out (guest user)
- Disappears permanently for any user that dismisses it
- No visible change when the feature flipper is off

ClientVersion will eventually impement the functionality outlined in exercism#3416. This simply implements the ability to check for a dismissed flash notice on the User record for a hard-coded version number.

kytrinyx · 2017-03-23T01:08:08Z

lib/exercism/client_version.rb

+
+    def notice_when_client_outdated
+      unless dismissed?
+        "A new version of the exercism client is available (cli-2.4.0). Run <code>exercism upgrade</code> to get the latest hotness!"


I'm hesitant to hard-code this. I'd rather either:

get the most recent CLI release when the app boots up and store that in a constant that we can refer to, or

have a cli_versions table and populate it based on what we get from the HTTP header when people submit (only storing each version once, and with a "first seen at" timestamp).

I think that the next CLI release will be a patch release, since changing where the CLI gets the text it displays is more of an implementation detail than a new feature.

I agree this must stay a short-term thing. I'm just running out of time this week and want to keep it simple, so I can get to the real experiment code. #3416 exists to fix this while the experiment runs. Keep in mind that, in a pinch, we can even just turn the banner off with the feature flag, without having to synchronize a deploy of this repo.

See my edited description for why I guessed at 2.4.0, but I'd be happy to make this 2.3.1 at your discretion.

Oh, no you're right. The config option means we'll end up at 2.4.0. Yepp, for the experiment, let's keep it simple.

This is defined in ExercismWeb::Routes::Profile, because it's the most logical subclass of ExercismWeb::Routes::Core that runs on every normal web page request. Defining this before filter in Core itself causes the before filter to run once for each of its many subclasses that load for the page: generally each router that has a partial displayed. Sinatra! Since the user profile nav appears on every page, this is a candidate that works. Also, requests for /icon come through the normal rack stack, and each of those requests also runs before filters. I want this to run and set the flash notice once per page, so this also checks the HTTP_ACCEPT header to see whether or not a text/html page is being loaded.

nilbus · 2017-03-23T02:54:25Z

This has a green build, is manually tested, and should be ready to go. 🎉 We can ship this now, and turn on the advertise_cli_update feature after cli merges exercism/cli#377 and releases 2.4.0.

I recommend we release the updated cli now to get people a head start on updating, so we can have as many people on at the beginning of the week as possible with the right version. Next week on Monday morning, we can turn on the feature flag that updates its call to action.

nilbus · 2017-03-23T02:57:49Z

I just read #3416 (comment). Consider pausing until we get the naming of these fields worked out.

Rename to client_version_update_notification_dismissed_at as per discussion in exercism#3416.

kytrinyx · 2017-03-23T15:12:46Z

I recommend we release the updated cli now to get people a head start on updating, so we can have as many people on at the beginning of the week as possible with the right version.

Agreed. I'll get that done today.

BTW, @nilbus, if you fear that a PR has dropped off my radar for some reason, please don't hesitate to send me an email directly about it. I don't want to accidentally leave something languishing.

kytrinyx · 2017-03-23T15:15:48Z

Consider pausing until we get the naming of these fields worked out.

D'oh. Once I saw the names you suggested this felt resolved to me. I forgot that the change actually has to be made.

I have not deployed this. Would you mind making an additional PR to fix the names?

nilbus · 2017-03-23T16:40:00Z

I actually did rename it already in the branch you merged, in b0d521f. 👍

nilbus · 2017-03-24T01:24:41Z

I did rename them, but with dyslexic typos! Fix coming shortly.

kytrinyx · 2017-03-24T15:17:22Z

We're all good. It wasn't an active code path (yet).

…i-banner" This reverts commit 55c705c, reversing changes made to 57b2a2c. Conflicts: - app/routes/profile.rb [removed relevant lines] - db/migrate/201703212321_add_client_version_notification_dismissed_at_to_users.rb [kept] - lib/exercism/client_version.rb [removed] - test/exercism/client_version_test.rb [removed] The migration was kept and will be reversed in a subsequent commit. Closes exercism#3416

nilbus changed the title ~~This is a work in progress.~~ Introduce CLI update banner Mar 22, 2017

nilbus force-pushed the please-update-cli-banner branch 2 times, most recently from 1579832 to b13d99c Compare March 22, 2017 21:27

Implement a preliminary version of ClientVersion

914d4e1

ClientVersion will eventually impement the functionality outlined in exercism#3416. This simply implements the ability to check for a dismissed flash notice on the User record for a hard-coded version number.

nilbus force-pushed the please-update-cli-banner branch from b13d99c to b2d252a Compare March 23, 2017 01:04

kytrinyx reviewed Mar 23, 2017

View reviewed changes

nilbus force-pushed the please-update-cli-banner branch from b2d252a to f391e0c Compare March 23, 2017 01:39

nilbus added 2 commits March 22, 2017 21:43

Use flash.now to prevent messages from appearing twice

4c3e744

Persist client version notice dismissal

2795143

nilbus force-pushed the please-update-cli-banner branch from 860dbee to 2795143 Compare March 23, 2017 02:47

Rename tracking column

b0d521f

Rename to client_version_update_notification_dismissed_at as per discussion in exercism#3416.

nilbus force-pushed the please-update-cli-banner branch from 8657539 to b0d521f Compare March 23, 2017 03:15

kytrinyx merged commit 55c705c into exercism:master Mar 23, 2017

nilbus deleted the please-update-cli-banner branch March 24, 2017 00:58

Introduce CLI update banner #3422

Introduce CLI update banner #3422

nilbus commented Mar 22, 2017 •

edited

kytrinyx Mar 23, 2017

nilbus Mar 23, 2017

kytrinyx Mar 23, 2017

nilbus commented Mar 23, 2017

nilbus commented Mar 23, 2017

kytrinyx commented Mar 23, 2017

kytrinyx commented Mar 23, 2017

nilbus commented Mar 23, 2017

nilbus commented Mar 24, 2017

kytrinyx commented Mar 24, 2017

Introduce CLI update banner #3422

Introduce CLI update banner #3422

Conversation

nilbus commented Mar 22, 2017 • edited

kytrinyx Mar 23, 2017

Choose a reason for hiding this comment

nilbus Mar 23, 2017

Choose a reason for hiding this comment

kytrinyx Mar 23, 2017

Choose a reason for hiding this comment

nilbus commented Mar 23, 2017

nilbus commented Mar 23, 2017

kytrinyx commented Mar 23, 2017

kytrinyx commented Mar 23, 2017

nilbus commented Mar 23, 2017

nilbus commented Mar 24, 2017

kytrinyx commented Mar 24, 2017

nilbus commented Mar 22, 2017 •

edited