Problem/Motivation

When maintenance mode is active, the site maintenance message is renderen in a particular theme. That theme can be set explicitly in setings.php otherwise the default theme is used. If something goes wrong, however, when determining the default theme, for example because the database goes away during an update, we need some fallback theme to display the maintenance message.

This (last-resort) fallback theme is currently Bartik. As part of the effort to make Claro the default admin theme and eventually deprecate Batrik we should also change this fallback theme to Claro instead.

Steps to reproduce

  1. Change the default theme to something other than Bartik.
  2. Activate maintenance mode and somehow trigger an exception during the fetching of the default theme. You can do this by editing core/includes/theme.maintenance.inc and adding throw new \Exception('my exception'); at line 44 (inside the try block).
  3. You will see the maintenance message rendered in Bartik.

Proposed resolution

Change the fallback to Claro.

Remaining tasks

User interface changes

The fallback site maintenance message is rendered in Claro.

API changes

-

Data model changes

-

Release notes snippet

CommentFileSizeAuthor
#17 interdiff.txt1.06 KBlauriii
#17 3262674-17.patch1.98 KBlauriii
#16 Site_under_maintenance___Drupal-2.png41.86 KBmherchel
#15 Site_under_maintenance___Drupal.png14.56 KBmherchel
#13 interdiff_12-13.txt1.99 KBcindytwilliams
#13 3262674-13.patch3.04 KBcindytwilliams
#12 reroll_diff_5-12.txt2.02 KBravi.shankar
#12 3262674-12.patch3.05 KBravi.shankar
#9 Screen Shot 2022-07-13 at 10.54.51.png41.46 KBlauriii
#9 Screen Shot 2022-07-13 at 10.54.07.png17.94 KBlauriii
#9 Screen Shot 2022-07-13 at 10.54.41.png141.08 KBlauriii
#5 3262674-5.patch3.65 KBtstoeckler
#5 3262674-2-5-interdiff.txt422 byteststoeckler
#2 3262674-2.patch3.24 KBtstoeckler

Comments

tstoeckler created an issue. See original summary.

tstoeckler’s picture

tstoeckler
he/him
Primary language German
Location Essen, Germany
commented
Status: Active » Postponed
StatusFileSize
new 3262674-2.patch3.24 KB

Marked this postponed as I assume we want to do this after #3219959: Update standard profile so Olivero is the default theme but this could in principle be done at any time. We just have to remove the @todo-hunk added here for now to make the test pass.

One note: The test would have passed even without changing the markup assertion, because both Bartik and Olivero put the maintenance message in an element that matches "main h1". But to make the test a bit more meaningful I thought it makes sense to assert for some markup that is Olivero-specific.

tstoeckler’s picture

tstoeckler
he/him
Primary language German
Location Essen, Germany
commented
Status: Postponed » Needs review
tstoeckler’s picture

tstoeckler
he/him
Primary language German
Location Essen, Germany
commented
Status: Needs review » Postponed
tstoeckler’s picture

tstoeckler
he/him
Primary language German
Location Essen, Germany
commented
Status: Postponed » Needs review
StatusFileSize
new 3262674-2-5-interdiff.txt422 bytes
new 3262674-5.patch3.65 KB

Weird, had that locally at some point but must have gotten lost. Neat that our test suite catches this, though 👍

tstoeckler’s picture

tstoeckler
he/him
Primary language German
Location Essen, Germany
commented
Status: Needs review » Postponed
quietone’s picture

quietone commented
Status: Postponed » Needs review
Parent issue: » #3278213: [Meta] Tasks to deprecate Bartik

Adding a parent.
And no longer postponed.

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

Drupal 9.4.0-alpha1 was released on May 6, 2022, which means new developments and disruptive changes should now 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.

lauriii’s picture

lauriii
he/him
Primary language Finnish
Location Finland
commented
Issue summary: View changes
StatusFileSize
new Screen Shot 2022-07-13 at 10.54.41.png141.08 KB
new Screen Shot 2022-07-13 at 10.54.07.png17.94 KB
new Screen Shot 2022-07-13 at 10.54.51.png41.46 KB

I think we should consider whether it makes sense to use Olivero as the fallback maintenance theme. Olivero provides a much more opinionated experience compared to Bartik, which might not fit in for all sites. It makes sense to provide this opinionated experience when using Olivero, but this simply doesn't fit in as well to use with other themes.

Olivero:

Bartik:

I think we could get an experience closer matching the old behavior if we enabled Claro as the fallback maintenance theme. The Claro designs are also more neutral which has a better chance of fitting into the sites brand.

Claro:

lauriii’s picture

lauriii
he/him
Primary language Finnish
Location Finland
commented
Title: [PP-1] Use Olivero instead of Bartik as fallback maintenance theme » Use Olivero instead of Bartik as fallback maintenance theme
Issue tags: +Needs product manager review

Tagging for product manager feedback on #9.

gábor hojtsy’s picture

gábor hojtsy
he/him
Primary language Hungarian
Location Hungary
commented
Title: Use Olivero instead of Bartik as fallback maintenance theme » Use Claro instead of Bartik as fallback maintenance theme
Status: Needs review » Needs work
Issue tags: -Needs product manager review

I think being in maintenance mode is a backend situation either way, so showing the backend a bit is not bad, especially as a super last resotrt like here. If the database went away, etc. we don't know if Olivero is even enabled or used, so we can't programatically decide if showing that would make sense. However Claro's maintenance experience is more restraied and generally applicable indeed.

ravi.shankar’s picture

ravi.shankar commented
StatusFileSize
new 3262674-12.patch3.05 KB
new reroll_diff_5-12.txt2.02 KB

Added a patch for Drupal 9.5.x, as patch #5 is not applied to 9.5.x., still needs work for #11.

cindytwilliams’s picture

cindytwilliams commented
Status: Needs work » Needs review
StatusFileSize
new 3262674-13.patch3.04 KB
new interdiff_12-13.txt1.99 KB

Here is a patch that addresses #11 and updates the patch to use Claro as the fallback maintenance theme instead of Olivero.

mherchel’s picture

mherchel
he/him
Primary language English
Location Gainesville, FL, US
commented
Issue summary: View changes

Editing issue summary

mherchel’s picture

mherchel
he/him
Primary language English
Location Gainesville, FL, US
commented
Status: Needs review » Reviewed & tested by the community
StatusFileSize
new Site_under_maintenance___Drupal.png14.56 KB

This patch in #13 looks perfect to me. Thanks @cindytwilliams!

Before screenshot

mherchel’s picture

mherchel
he/him
Primary language English
Location Gainesville, FL, US
commented
StatusFileSize
new Site_under_maintenance___Drupal-2.png41.86 KB

After picture:

lauriii’s picture

lauriii
he/him
Primary language Finnish
Location Finland
commented
StatusFileSize
new 3262674-17.patch1.98 KB
new interdiff.txt1.06 KB

Reverted the changes to \Drupal\Tests\system\Functional\System\SiteMaintenanceTest because I don't think the changes there were doing what they were originally intended to do.

  • lauriii committed 047faa3 on 10.1.x 
    Issue #3262674 by tstoeckler, lauriii, cindytwilliams, mherchel, Gábor...

  • lauriii committed 6e09571 on 10.0.x 
    Issue #3262674 by tstoeckler, lauriii, cindytwilliams, mherchel, Gábor...

  • lauriii committed 18b725e on 9.5.x 
    Issue #3262674 by tstoeckler, lauriii, cindytwilliams, mherchel, Gábor...
lauriii’s picture

lauriii
he/him
Primary language Finnish
Location Finland
commented
Status: Reviewed & tested by the community » Fixed

Committing my own patch since the changes were very minor, and essentially just reverted changes from a test.

Committed 047faa3 and pushed to 10.1.x. Cherry-picked to 10.0.x and 9.5.x. Thanks!

Status: Fixed » Closed (fixed)

Automatically closed - issue fixed for 2 weeks with no activity.