Dynamic feature infos for users #1388

krauselukas · 2017-07-07T16:34:45Z

Related to:
https://progress.opensuse.org/issues/16376

foursixnine · 2017-07-07T16:48:26Z

lib/OpenQA/Schema/Result/Users.pm

+        data_type   => 'text',
+        is_nullable => 1,
+    },
+    feature_informed => {


What would be feature informed? (as it is a boolean... )

@foursixnine It is for checking if the user is already informed about the latest/current features or not. If he saw the newest features the boolean is true.

so with every new feature you would have to write a migration to reset? that's not going to work - you will need to store exactly what feature she was informed about

@coolo i want to do this in this area:
last_login_version => { data_type => 'text', is_nullable => 1, },
the boolean part is just for checking if the user is informed about the newest feature.
So lets say there is feature01, feature02, ...feature05 in the last_login_version (maybe i should change the description). The jquery code will check for the version number, and if the user saw the latest feature (lets say feature05), the boolean part will set to true. Is this the right direction?

coolo · 2017-07-07T17:52:01Z

lib/OpenQA/Schema/Result/Users.pm

+        data_type   => 'text',
+        is_nullable => 1,
+    },
+    feature_informed => {


so with every new feature you would have to write a migration to reset? that's not going to work - you will need to store exactly what feature she was informed about

coolo · 2017-07-10T10:13:34Z

lib/OpenQA/WebAPI.pm

@@ -466,6 +466,10 @@ sub startup {
    ## JSON API ends here
    #

+    # api/v1/feature
+    $api_public_r->post('/feature')->name('apiv1_post_informed_about')->to('feature#informed');


public does not make sense - you want the user

coolo · 2017-07-10T10:14:10Z

lib/OpenQA/WebAPI/Controller/API/V1/Feature.pm

+sub check {
+    my ($self) = @_;
+    my $user = $self->current_user;
+    $self->respond_to(json => {json => {version => $user->last_login_version, seen => $user->feature_informed}},);


why the duplicated json? Returning a hash is fine

this check route implies you want to query the server for every page load. This sounds problematic. You better check while rendering the page - if you need the feature feature at all.

@coolo thanks, will rework all these parts :)

coolo · 2017-07-10T10:17:58Z

lib/OpenQA/WebAPI/Controller/API/V1/Feature.pm

+    my $user    = $self->current_user;
+    my $version = $self->param('version');
+    $user->update({last_login_version => $version});
+    my $seen = $self->param('seen');


what else would seen be? You want to the user to confirm he didn't see it? :)

IMO these 2 fields are duplicating each other. Assume I visited openqa last on version 3 and now it's 5. So I need 2 features to be presented. Once these are presented, they are gone - and should never appear again. So the last_login_version is enough to know the features to be presented.

coolo · 2017-07-10T10:19:30Z

lib/OpenQA/Schema/Result/Users.pm

@@ -51,6 +51,14 @@ __PACKAGE__->add_columns(
        false_id      => ['0', '-1'],
        default_value => '0',
    },
+    last_login_version => {
+        data_type   => 'text',


I wouldn't make this a text version - make a list of features to be presented and store the number seen. And then have the user either ignore them all or go through them.

codecov · 2017-07-10T15:32:43Z

Codecov Report

Merging #1388 into master will increase coverage by 0.02%.
The diff coverage is 100%.

@@            Coverage Diff             @@
##           master    #1388      +/-   ##
==========================================
+ Coverage    87.7%   87.73%   +0.02%     
==========================================
  Files         104      105       +1     
  Lines        7580     7588       +8     
==========================================
+ Hits         6648     6657       +9     
+ Misses        932      931       -1

Impacted Files	Coverage Δ
lib/OpenQA/WebAPI/Plugin/Helpers.pm	`97.14% <ø> (ø)`	⬆️
lib/OpenQA/Schema.pm	`100% <ø> (ø)`	⬆️
lib/OpenQA/Schema/Result/Users.pm	`100% <ø> (ø)`	⬆️
lib/OpenQA/WebAPI/Controller/API/V1/Feature.pm	`100% <100%> (ø)`
lib/OpenQA/WebAPI.pm	`91.88% <100%> (+0.02%)`	⬆️
lib/OpenQA/WebAPI/Plugin/REST.pm	`100% <0%> (+3.84%)`	⬆️

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 0636c12...9ce22a3. Read the comment docs.

krauselukas

Still working on it, its is not ready yet.

krauselukas · 2017-07-13T10:56:57Z

templates/layouts/bootstrap.html.ep

@@ -30,6 +30,7 @@
          $(function() {
          setupForAll();
          %= content_for 'ready_function'
+          newFeature();


Not sure if this is the appropriate way to accomplish this, but i have to somehow load the bootstrap-tour instructions when traversing through multiple pages. Example will follow soon.

krauselukas · 2017-07-14T14:07:16Z

The dynamic notifications about new features are working now. There are still a few points which i have to improve, like the "I'm not interested" checkbox, which is doing nothing so far and making the feature javascript a bit more comfortable to maintain. I was thinking about getting those things done and the tests green. After that i would like to add a "real" tour. Feedback is welcomed :)

foursixnine · 2017-07-14T14:18:09Z

I'm very much looking forward to the tour part for newcomers, and also it will for sure help us with poo#16374 at least on the webUI part.

okurz · 2017-07-14T21:45:40Z

awesome video. Very nice.

krauselukas · 2017-07-18T13:15:31Z

This part fails when i start the tests on my local machine with perl-5-24.1 and tests gets aborted with an error: make: *** [Makefile:75: checkstyle] Error 2

Looks it appears since 2ad797f
It fails also on master:

lib/OpenQA/WebAPI/Plugin/Helpers.pm: Hash key with quotes at line 331, column 37. Avoid useless quotes. (Severity: 5)
lib/OpenQA/WebAPI/Plugin/Helpers.pm: Hash key with quotes at line 331, column 59. Avoid useless quotes. (Severity: 5)

okurz · 2017-07-18T14:23:24Z

So fix these first, your room colleagues should be able to help you with that :-)

krauselukas · 2017-07-26T11:15:05Z

lib/OpenQA/Schema/Result/Users.pm

@@ -51,6 +51,10 @@ __PACKAGE__->add_columns(
        false_id      => ['0', '-1'],
        default_value => '0',
    },
+    feature_version => {
+        data_type     => 'integer',
+        default_value => 0,


I disabled the feature tour temporarly, since i dont have a real tour yet. Will do a real tour in the next step, but i thought it would be a good idea to make a merge of the branch possible.

krauselukas · 2017-07-26T11:15:14Z

lib/OpenQA/Schema.pm

@@ -30,7 +30,7 @@ use OpenQA::Utils ();

 # after bumping the version please look at the instructions in the docs/Contributing.asciidoc file
 # on what scripts should be run and how
-our $VERSION   = 56;
+our $VERSION   = 57;


I reduced database number, since i pushed it more then once in the process, so currently it would be 57

krauselukas · 2017-07-26T11:17:00Z

t/fixtures/03-users.pl

+    },
+    Users => {
+        username        => 'nobody',
+        feature_version => 1,


I enabled the tour for the user nobody for the feature-tour ui test

krauselukas · 2017-07-27T12:18:15Z

So I'm ready with the base of this feature. Feature notifications are disabled, since i havent prepared proper ones yet. This will be the next step.

coolo · 2017-07-30T16:35:22Z

assets/javascripts/feature.js

+    initTour(featureVersion);
+
+    //Parse html code as string to change the default layout of bootstrap tour
+    function changeTemplate() {


you better put that HTML in a hidden block with proper indenting.

But I'll merge (and squash) in this stage.

commit 4c72a17 Author: Lukas Krause <lkrause@suse.de> AuthorDate: Sun Jul 30 18:35:50 2017 +0200 Commit: Stephan Kulow <coolo@kde.org> CommitDate: Sun Jul 30 18:35:50 2017 +0200 Dynamic feature infos for users (#1388) * Add bootstrap-tour to assetpack * Add javascript and controller files for features * Create API routes for feature notifications * Add subroutines to feature module * Change feature api route from public to user * Change json parsing in feature subroutine * Add prototyp of the feature jquery code * Add feature function to bootstrap template for multipage traversal * Improve feature javascript and add example tour * Add query for is user logged in * Add checkbox to suppress new feature notifications * Add a few comments * Fix avoid useless quotes test error in helpers module * Fix ui tests and add test for feature tour * Move a few things in feature javascript * Disable feature tour by seeting database entry to zero * Enable tour for user nobody in feature test * Get rid of unnecessary ajax call in feature javascript * Remove redundant api route * Adjust database and increase version number to 58

foursixnine reviewed Jul 7, 2017

View reviewed changes

coolo requested changes Jul 7, 2017

View reviewed changes

coolo requested changes Jul 10, 2017

View reviewed changes

krauselukas commented Jul 12, 2017

View reviewed changes

krauselukas commented Jul 13, 2017

View reviewed changes

krauselukas force-pushed the feature/dynamic_feature_info branch from 335cf7d to 1c5cf85 Compare July 14, 2017 12:13

krauselukas force-pushed the feature/dynamic_feature_info branch 5 times, most recently from a707035 to b121fb5 Compare July 25, 2017 11:21

krauselukas commented Jul 26, 2017

View reviewed changes

krauselukas force-pushed the feature/dynamic_feature_info branch 2 times, most recently from 874e88b to e7d4638 Compare July 26, 2017 16:17

krauselukas added 8 commits July 27, 2017 12:53

Add bootstrap-tour to assetpack

3d420d3

Add javascript and controller files for features

e4e33f9

Create API routes for feature notifications

c1d6522

Add subroutines to feature module

6ff10ec

Change feature api route from public to user

4456073

Change json parsing in feature subroutine

12fe4d8

Add prototyp of the feature jquery code

afa0d77

Add feature function to bootstrap template for multipage traversal

9e0ce86

krauselukas added 4 commits July 27, 2017 12:57

Improve feature javascript and add example tour

f560b92

Add query for is user logged in

ce7ca24

Add checkbox to suppress new feature notifications

672d9e0

Add a few comments

e47664d

krauselukas force-pushed the feature/dynamic_feature_info branch from e7d4638 to 1de38eb Compare July 27, 2017 11:38

krauselukas added 8 commits July 27, 2017 14:02

Fix avoid useless quotes test error in helpers module

723e696

Fix ui tests and add test for feature tour

48dc13c

Move a few things in feature javascript

e3111dc

Disable feature tour by seeting database entry to zero

2c793cc

Enable tour for user nobody in feature test

31e8d41

Get rid of unnecessary ajax call in feature javascript

d239e76

Remove redundant api route

49ab61d

Adjust database and increase version number to 58

9ce22a3

krauselukas force-pushed the feature/dynamic_feature_info branch from 1de38eb to 9ce22a3 Compare July 27, 2017 12:07

krauselukas changed the title ~~[WIP] Dynamic feature infos for users~~ Dynamic feature infos for users Jul 27, 2017

krauselukas changed the title ~~Dynamic feature infos for users~~ [WIP] Dynamic feature infos for users Jul 27, 2017

krauselukas changed the title ~~[WIP] Dynamic feature infos for users~~ Dynamic feature infos for users Jul 27, 2017

coolo reviewed Jul 30, 2017

View reviewed changes

coolo approved these changes Jul 30, 2017

View reviewed changes

coolo merged commit 4c72a17 into os-autoinst:master Jul 30, 2017

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Dynamic feature infos for users #1388

Dynamic feature infos for users #1388

krauselukas commented Jul 7, 2017

foursixnine Jul 7, 2017

krauselukas Jul 7, 2017 •

edited

Loading

coolo Jul 7, 2017

krauselukas Jul 10, 2017 •

edited

Loading

coolo Jul 7, 2017

coolo Jul 10, 2017

coolo Jul 10, 2017

coolo Jul 10, 2017

krauselukas Jul 10, 2017

coolo Jul 10, 2017

coolo Jul 10, 2017

codecov bot commented Jul 10, 2017 •

edited

Loading

krauselukas left a comment

krauselukas Jul 13, 2017

krauselukas commented Jul 14, 2017

foursixnine commented Jul 14, 2017

okurz commented Jul 14, 2017

krauselukas commented Jul 18, 2017 •

edited

Loading

okurz commented Jul 18, 2017

krauselukas Jul 26, 2017

krauselukas Jul 26, 2017

krauselukas Jul 26, 2017

krauselukas commented Jul 27, 2017

coolo Jul 30, 2017

Dynamic feature infos for users #1388

Dynamic feature infos for users #1388

Conversation

krauselukas commented Jul 7, 2017

Choose a reason for hiding this comment

krauselukas Jul 7, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

krauselukas Jul 10, 2017 • 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

codecov bot commented Jul 10, 2017 • edited Loading

Codecov Report

krauselukas left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

krauselukas commented Jul 14, 2017

foursixnine commented Jul 14, 2017

okurz commented Jul 14, 2017

krauselukas commented Jul 18, 2017 • edited Loading

okurz commented Jul 18, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

krauselukas commented Jul 27, 2017

Choose a reason for hiding this comment

krauselukas Jul 7, 2017 •

edited

Loading

krauselukas Jul 10, 2017 •

edited

Loading

codecov bot commented Jul 10, 2017 •

edited

Loading

krauselukas commented Jul 18, 2017 •

edited

Loading