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

screenshot showing the progress bar at the bottom of the page

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

Support from Acquia helps fund testing for Drupal Acquia logo

Comments

mikeryan created an issue. See original summary.

mikeryan’s picture

Issue tags: +Barcelona2015, +Novice

Tagging for Barcelona sprinting.

quietone’s picture

Had 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?

mikeryan’s picture

Status: Active » Postponed (maintainer needs more info)

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.

So, 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?

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?

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... ;-).

mikeryan’s picture

Project: Migrate Upgrade » Drupal core
Version: 8.x-1.x-dev » 8.1.x-dev
Component: User interface » migration system
Status: Postponed (maintainer needs more info) » Active
Issue tags: -Barcelona2015, -Novice

Any further UX refinement should go under #2678638: [META] Usability refinements for Migrate UI.

Version: 8.1.x-dev » 8.2.x-dev

Drupal 8.1.9 was released on September 7 and is the final bugfix release for the Drupal 8.1.x series. Drupal 8.1.x will not receive any further development aside from security fixes. Drupal 8.2.0-rc1 is now available and sites should prepare to upgrade to 8.2.0.

Bug reports should be targeted against the 8.2.x-dev branch from now on, and new development or disruptive changes should be targeted against the 8.3.x-dev branch. For more information see the Drupal 8 minor version schedule and the Allowed changes during the Drupal 8 release cycle.

heddn’s picture

From #2687851-22: Refactor run() method on Migrate UI batch and remove the $operation parameter:

+++ b/core/modules/migrate_drupal_ui/src/MigrateUpgradeBatchBase.php
@@ -0,0 +1,116 @@
+  const MESSAGE_LENGTH = 20;

Look at a better constant name.

Version: 8.2.x-dev » 8.3.x-dev

Drupal 8.2.6 was released on February 1, 2017 and is the final full bugfix release for the Drupal 8.2.x series. Drupal 8.2.x will not receive any further development aside from critical and security fixes. Sites should prepare to update to 8.3.0 on April 5, 2017. (Drupal 8.3.0-alpha1 is available for testing.)

Bug reports should be targeted against the 8.3.x-dev branch from now on, and new development or disruptive changes should be targeted against the 8.4.x-dev branch. For more information see the Drupal 8 minor version schedule and the Allowed changes during the Drupal 8 release cycle.

Version: 8.3.x-dev » 8.4.x-dev

Drupal 8.3.6 was released on August 2, 2017 and is the final full bugfix release for the Drupal 8.3.x series. Drupal 8.3.x will not receive any further development aside from critical and security fixes. Sites should prepare to update to 8.4.0 on October 4, 2017. (Drupal 8.4.0-alpha1 is available for testing.)

Bug reports should be targeted against the 8.4.x-dev branch from now on, and new development or disruptive changes should be targeted against the 8.5.x-dev branch. For more information see the Drupal 8 minor version schedule and the Allowed changes during the Drupal 8 release cycle.

Version: 8.4.x-dev » 8.5.x-dev

Drupal 8.4.4 was released on January 3, 2018 and is the final full bugfix release for the Drupal 8.4.x series. Drupal 8.4.x will not receive any further development aside from critical and security fixes. Sites should prepare to update to 8.5.0 on March 7, 2018. (Drupal 8.5.0-alpha1 is available for testing.)

Bug reports should be targeted against the 8.5.x-dev branch from now on, and new development or disruptive changes should be targeted against the 8.6.x-dev branch. For more information see the Drupal 8 minor version schedule and the Allowed changes during the Drupal 8 release cycle.

Version: 8.5.x-dev » 8.6.x-dev

Drupal 8.5.6 was released on August 1, 2018 and is the final bugfix release for the Drupal 8.5.x series. Drupal 8.5.x will not receive any further development aside from security fixes. Sites should prepare to update to 8.6.0 on September 5, 2018. (Drupal 8.6.0-rc1 is available for testing.)

Bug reports should be targeted against the 8.6.x-dev branch from now on, and new development or disruptive changes should be targeted against the 8.7.x-dev branch. For more information see the Drupal 8 minor version schedule and the Allowed changes during the Drupal 8 release cycle.

heddn’s picture

Is this still an issue?

quietone’s picture

Issue tags: +Needs screenshots

Yes, 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.

heddn’s picture

Issue tags: +Novice

Anyone 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.

vinmassaro’s picture

Here 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.

quietone’s picture

vinmassaro, 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.

Version: 8.6.x-dev » 8.8.x-dev

Drupal 8.6.x will not receive any further development aside from security fixes. Bug reports should be targeted against the 8.8.x-dev branch from now on, and new development or disruptive changes should be targeted against the 8.9.x-dev branch. For more information see the Drupal 8 and 9 minor version schedule and the Allowed changes during the Drupal 8 and 9 release cycles.

Version: 8.8.x-dev » 8.9.x-dev

Drupal 8.8.7 was released on June 3, 2020 and is the final full bugfix release for the Drupal 8.8.x series. Drupal 8.8.x will not receive any further development aside from security fixes. Sites should prepare to update to Drupal 8.9.0 or Drupal 9.0.0 for ongoing support.

Bug reports should be targeted against the 8.9.x-dev branch from now on, and new development or disruptive changes should be targeted against the 9.1.x-dev branch. For more information see the Drupal 8 and 9 minor version schedule and the Allowed changes during the Drupal 8 and 9 release cycles.

Version: 8.9.x-dev » 9.2.x-dev

Drupal 8 is end-of-life as of November 17, 2021. There will not be further changes made to Drupal 8. Bugfixes are now made to the 9.3.x and higher branches only. For more information see the Drupal core minor version schedule and the Allowed changes during the Drupal core release cycle.

Version: 9.2.x-dev » 9.3.x-dev

Version: 9.3.x-dev » 9.4.x-dev

Drupal 9.3.15 was released on June 1st, 2022 and is the final full bugfix release for the Drupal 9.3.x series. Drupal 9.3.x will not receive any further development aside from security fixes. Drupal 9 bug reports should be targeted for the 9.4.x-dev branch from now on, and new development or disruptive changes should be targeted for the 9.5.x-dev branch. For more information see the Drupal core minor version schedule and the Allowed changes during the Drupal core release cycle.

AaronMcHale’s picture

Queued for review at #3315240: Drupal Usability Meeting 2022-10-21 or a future meeting. Thanks.

Version: 9.4.x-dev » 9.5.x-dev

Drupal 9.4.9 was released on December 7, 2022 and is the final full bugfix release for the Drupal 9.4.x series. Drupal 9.4.x will not receive any further development aside from security fixes. Drupal 9 bug reports should be targeted for the 9.5.x-dev branch from now on, and new development or disruptive changes should be targeted for the 10.1.x-dev branch. For more information see the Drupal core minor version schedule and the Allowed changes during the Drupal core release cycle.

benjifisher’s picture

Issue summary: View changes
Issue tags: -Needs usability review

Usability 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.

Version: 9.5.x-dev » 11.x-dev

Drupal core is moving towards using a “main” branch. As an interim step, a new 11.x branch has been opened, as Drupal.org infrastructure cannot currently fully support a branch named main. New developments and disruptive changes should now be targeted for the 11.x branch. For more information, see the Drupal core minor version schedule and the Allowed changes during the Drupal core release cycle.