Guided mode #1867

odeimaiz · 2020-10-07T14:08:04Z

What do these changes do?

This feature is only available in master and devel:

Frontend

GUI for creating/editing the slideshow workflow
Serialize the slideshow
Move node's position to the new "ui" field. Be backwards compatible
Provide a way to start/stop the slideshow
Provide a way to start a study in slideshow mode
A lot of refactoring
FilePicker is not shown in a separate window anymore. It is rendered in the node view, same as the rest of nodes.

Backend

Update project model. Add a new "ui" field
Add migration script for new "ui" column

Related issue number

ITISFoundation/osparc-issues#327

How to test

Checklist

Did you change any service's API? Then make sure to bundle document and upgrade version (make openapi-specs, git commit ... and then make version-*)
Unit tests for the changes exist
Runs in the swarm
Documentation reflects the changes
New module? Add your github username to .github/CODEOWNERS

codecov · 2020-10-07T14:10:09Z

Codecov Report

Merging #1867 into master will increase coverage by 1.9%.
The diff coverage is 100.0%.

@@           Coverage Diff            @@
##           master   #1867     +/-   ##
========================================
+ Coverage    70.7%   72.7%   +1.9%     
========================================
  Files         337     337             
  Lines       12818   12830     +12     
  Branches     1362    1362             
========================================
+ Hits         9071    9329    +258     
+ Misses       3391    3124    -267     
- Partials      356     377     +21

Flag	Coverage Δ
#integrationtests	`58.9% <ø> (+0.7%)`	⬆️
#unittests	`66.6% <100.0%> (+<0.1%)`	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files	Coverage Δ
...e/src/simcore_postgres_database/models/projects.py	`100.0% <ø> (ø)`
...ages/models-library/src/models_library/projects.py	`100.0% <100.0%> (ø)`
.../director/src/simcore_service_director/producer.py	`60.5% <0.0%> (+0.2%)`	⬆️
...ce_webserver/resource_manager/garbage_collector.py	`72.3% <0.0%> (+1.0%)`	⬆️
...es/sidecar/src/simcore_service_sidecar/rabbitmq.py	`90.7% <0.0%> (+4.6%)`	⬆️
.../sidecar/src/simcore_service_sidecar/log_parser.py	`81.8% <0.0%> (+16.8%)`	⬆️
...ervices/sidecar/src/simcore_service_sidecar/cli.py	`81.4% <0.0%> (+22.2%)`	⬆️
...vices/sidecar/src/simcore_service_sidecar/utils.py	`81.9% <0.0%> (+27.7%)`	⬆️
services/sidecar/src/simcore_service_sidecar/db.py	`92.0% <0.0%> (+40.0%)`	⬆️
...rvices/sidecar/src/simcore_service_sidecar/core.py	`76.8% <0.0%> (+49.4%)`	⬆️
... and 1 more

ignapas

Just some suggestions:

Sweeper and Slides use the same completely unrelated icon :P I suggest random for the sweeper and caret-square-right for the slides.
I think slides is a bit confusing because I think of Google Slides and this is not the same thing. I think "guided mode" is a very good name, I propose using that instead of slides.
Inside the Slides window:
- Tree should have the same background of the containing window (maybe transparent does it).
- Buttons and order numbers need some more space in between.
I like the compact style of the previous file picker in a window but if everyone agrees to have the other back , it's ok.
- Although there is no progress when a file is uploaded, and the progress remains there even if the file was uploaded. And if the folder is open, the file doesn't show after upload unless reload is hit.
Maybe this doesn't fulfil the requirements...? I would say that is not enough to guide a user through the configuration of the study... at least some kind of guiding text would be missing? @KZzizzle what do you think?

GitHK

A few ideas worth investigating:

I do agree with @ignapas about having some "text slides" where the user can present some information as guidance between each service. I think that the primary user of the guided mode is a non developer. He or she might need more information in order to correctly work out how to use this "application".
While in the "presentation mode" (after start slides is pressed) it might be advisable to not allow the user to change information about the service (like name and other things which must not be changeable by the user).
a slide like icon would be better for the button (not having any text, it is hard to find and understand what it is used for)

GitHK

The following require improvement:

I think there is something odd about selecting and deselecting images. The order does not feel right.
the below study has a lot of services, when opened it will open a slide. I was expecting to see the workbench. Also note the disappearance of the next and prev buttons.
services with long names will destroy the layout, rendering them unusable. Please consider using ellipsis. Also please note the missing prev and next buttons
long service names are also an inconvenience as shown below

odeimaiz · 2020-10-20T09:16:39Z

From @ignapas:

Sweeper and Slides use the same completely unrelated icon :P I suggest random for the sweeper and caret-square-right for the slides.
I think slides is a bit confusing because I think of Google Slides and this is not the same thing. I think "guided mode" is a very good name, I propose using that instead of slides.
Inside the Slides window:
- Widgets in new osparc.Window look raro #1636 Tree should have the same background of the containing window (maybe transparent does it).
- Buttons and order numbers need some more space in between.

odeimaiz · 2020-10-20T10:24:14Z

From @GitHK:

"I think there is something odd about selecting and deselecting images. The order does not feel right." I don't see any weird thing there.
The below study has a lot of services, when opened it will open a slide. I was expecting to see the workbench. Also note the disappearance of the next and prev buttons.
services with long names will destroy the layout, rendering them unusable. Please consider using ellipsis. Also please note the missing prev and next buttons

ignapas

PRed with visual changes but the upload visual bugs of the file picker are still there. Probably not related to this PR

Some visuals for guided mode

GitHK

It is usable for demo purposes.

done

KZzizzle

cool stuff - looks good to me as a first version - will wait for UI revamp to get nitpicky =P

odeimaiz and others added 2 commits October 7, 2020 15:25

'dummy' state property added

959f684

Merge branch 'master' into feature/guided-mode

0ccca3d

odeimaiz added 3 commits October 7, 2020 18:06

refactoring

f5aa9fc

make populateTree reusable

a4256cf

open NodesSlidesTree

d6a3126

odeimaiz self-assigned this Oct 8, 2020

odeimaiz added the a:frontend issue affecting the front-end (area group) label Oct 8, 2020

odeimaiz added this to the Shu milestone Oct 8, 2020

odeimaiz and others added 21 commits October 8, 2020 11:15

minor

a0a9b49

refactoring

0c8766c

minor

dbb7810

back to private

70da840

reverting

3e02019

minor

2669ab7

Move up & down working

ff61978

showing all buttons

88296ee

cleanup

3f9a06a

minor

fa96d8a

refactoring

6cbbfcd

Save button added

13bb052

looking better

7801fca

postion calculated

5238cdd

migration script added

f213ab5

project model and schemas updated

197d8cc

project and schemas updated

f597dc1

project and schemas updated

b39e278

serialize/desirialize node position

4e61330

Update projects.py

3aa54a3

Merge branch 'master' into feature/guided-mode

12bff72

Update sleepers_project_template_sql.csv

ccbfd6c

ignapas previously requested changes Oct 19, 2020

View reviewed changes

Merge branch 'master' into feature/guided-mode

5d6661f

GitHK reviewed Oct 20, 2020

View reviewed changes

GitHK requested changes Oct 20, 2020

View reviewed changes

odeimaiz added 2 commits October 20, 2020 11:04

Visuals

4764871

start in workbench mode by default

7eded82

more uniform buttons

4ac7151

maxWidth + tooltip for Navigation buttons

3840575

odeimaiz requested review from ignapas and GitHK October 20, 2020 10:36

odeimaiz and others added 2 commits October 20, 2020 13:15

cropping node labels

ed6eab7

Added visuals

f7fa881

ignapas reviewed Oct 20, 2020

View reviewed changes

odeimaiz and others added 3 commits October 20, 2020 13:29

Merge pull request #75 from ignapas/odeimaiz-feature/guided-mode

1d56af2

Some visuals for guided mode

clean up

7adbede

eslint

aa3f568

pcrespov requested a review from ignapas October 20, 2020 11:55

GitHK approved these changes Oct 20, 2020

View reviewed changes

KZzizzle approved these changes Oct 20, 2020

View reviewed changes

odeimaiz and others added 3 commits October 20, 2020 14:45

crop label also in NodeTree

865e09d

Update NavigationBar.js

9bc8632

Merge branch 'master' into feature/guided-mode

967fc21

ignapas approved these changes Oct 20, 2020

View reviewed changes

Merge branch 'master' into feature/guided-mode

256fa21

odeimaiz merged commit 6d89c10 into ITISFoundation:master Oct 20, 2020

odeimaiz deleted the feature/guided-mode branch November 26, 2020 09:21

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Guided mode #1867

Guided mode #1867

odeimaiz commented Oct 7, 2020 •

edited

Loading

codecov bot commented Oct 7, 2020 •

edited

Loading

ignapas left a comment

GitHK left a comment

GitHK left a comment

odeimaiz commented Oct 20, 2020 •

edited

Loading

odeimaiz commented Oct 20, 2020 •

edited

Loading

ignapas left a comment

GitHK left a comment

KZzizzle left a comment

Guided mode #1867

Guided mode #1867

Conversation

odeimaiz commented Oct 7, 2020 • edited Loading

What do these changes do?

Related issue number

How to test

Checklist

codecov bot commented Oct 7, 2020 • edited Loading

Codecov Report

ignapas left a comment

Choose a reason for hiding this comment

GitHK left a comment

Choose a reason for hiding this comment

GitHK left a comment

Choose a reason for hiding this comment

odeimaiz commented Oct 20, 2020 • edited Loading

odeimaiz commented Oct 20, 2020 • edited Loading

ignapas left a comment

Choose a reason for hiding this comment

GitHK left a comment

Choose a reason for hiding this comment

KZzizzle left a comment

Choose a reason for hiding this comment

odeimaiz commented Oct 7, 2020 •

edited

Loading

codecov bot commented Oct 7, 2020 •

edited

Loading

odeimaiz commented Oct 20, 2020 •

edited

Loading

odeimaiz commented Oct 20, 2020 •

edited

Loading