Problem/Motivation
When running an upgrade via the UI (/upgrade), progress messages are displayed above the progress bar rather than below it. 20 messages are displayed before scrolling off the screen. I had thought this was an intentional D8 change, but apparently not - they should be below. We're not doing anything to try to achieve this, so we need to figure out why it's happening.
mikeryan sates in #4 the positive side of having 20 messages on screen,
I think the context is helpful, otherwise most migration results will disappear before it's possible to see them. I did include this to get feedback, so there's a -- so far... ;-).
The first step is decide if the upgrade screen stay as is or be changed? And if changed, then decided what needs to be done?
Screenshots
Upgrade display with migrations running
Shows the behviour, the text is being output to the progress__label div that is above the progress bar, instead of the progress__description div below the progress bar
Proposed resolution
Show the following elements on the batch progress page:
- Progress bar
- Currently executing migration
- Up to 20 completed migrations, most recent first
Remaining tasks
User interface changes
API changes
None
Data model changes
None
Release notes snippet
N/A
Comment | File | Size | Author |
---|---|---|---|
#15 | Screenshot 2019-04-08 16.39.17.png | 173.1 KB | vinmassaro |
#15 | Screenshot 2019-04-08 16.25.26.png | 284.64 KB | vinmassaro |
Comments
Comment #2
mikeryanTagging for Barcelona sprinting.
Comment #3
quietone CreditAttribution: quietone commentedHad a bit of explore of this and batch, focusing on progress_message. During a D8 install the progress message appears below the progress bar as 'Completed N of N'. But this default behavior is disabled in migrate_upgrade, possibly because it would other wise display 'Completed 0 of 1' even though many migrations or rollbacks run. That's because the first operation given to batch is 'run' and that one run tasks does all the migrations, so batch doesn't know that, in fact, there are many migrations to run. That seems like the wrong approach to me but it is late and this is the first time I've looked at batch. I also don't see a way to change progress_message from MigrateUpgradeRunBatch.
So, going back to basics. How important it is keep 20 message on screen? Personally, I find it distracting but then I've only done wee test sites, maybe it is useful when doing large sites?
Comment #4
mikeryanSo, you're thinking instead of the single run() taking in all migrations, the batch operations array should have one entry per migration? How would this affect the display of messages relative to the progress bar?
I think the context is helpful, otherwise most migration results will disappear before it's possible to see them. I did include this to get feedback, so there's a -- so far... ;-).
Comment #5
mikeryanAny further UX refinement should go under #2678638: [META] Usability refinements for Migrate UI.
Comment #7
heddnFrom #2687851-22: Refactor run() method on Migrate UI batch and remove the $operation parameter:
Look at a better constant name.
Comment #12
heddnIs this still an issue?
Comment #13
quietone CreditAttribution: quietone as a volunteer commentedYes, I think so.
The other pages in the UI have received attention not this one. It would be good to have a UX review of some kind to answer the question, what should be displayed on that page. The output is rather different that the install screen, so should they match as closely as possible? Do people want to see 20 messages so they can see the results is some context?
To start, this will need a screenshot.
Comment #14
heddnAnyone can run a D7 or D6 migration via migrate drupal ui and grab some screenshots. It might take a little time to get an environment setup, but it isn't complicated. Tagging novice.
Comment #15
vinmassaro CreditAttribution: vinmassaro commentedHere is a screenshot of the behavior:
The text is being output to the progress__label div that is above the progress bar, instead of the progress__description div below the progress bar.
Comment #16
quietone CreditAttribution: quietone as a volunteer commentedvinmassaro, thank you for the screenshots, really helpful.
OK there are screenshots and the IS is updated. So, tagging for Needs usability review to get direction on what should be done here. If that isn't the right tag please change it.
The current task is to answer the questions in the IS Problem/Motivation section.
Comment #22
AaronMcHaleQueued for review at #3315240: Drupal Usability Meeting 2022-10-21 or a future meeting. Thanks.
Comment #24
benjifisherUsability review
We discussed this issue at #3376176: Drupal Usability Meeting 2023-07-28. That issue has a link to a recording of the meeting. For the record, the attendees at the usability meeting were @AaronMcHale, @Emma Horrell, @benjifisher, @lukas.fischer, and @rkoller.
We agreed with the proposed change: move the progress bar to the top. We also discussed additional changes, and I just added #3379473: Do not show all completed migrations in batch message describing those suggestions. I created a new issue to avoid delaying this one, but if it is easier to implement all the changes at once, then we can do it here and close that issue.
I am updating the Proposed resolution in the issue summary.
Once the progress bar is at the top of the page, it is less important to limit the list of completed migrations to 20. Whoever works on this issue can choose keep the current behavior (limit to 20) or show them all without asking for another usability review, but please keep the issue summary up to date.