Book navigation block causes theme region to always render [#2842839]

Steps to reproduce:

Enable the book module.
Place the book navigation block in a region by itself.
Choose to have it show only when on book pages.
Go to a page that is not a book page, like /user/login.
Inspect the page HTML and find that the region that the block was placed in renders, although it has no content in it, just the empty container.

It's pretty much invisible in Bartik, but in a theme where things were center justified instead of left justified, it would suddenly be apparent that something was wrong.

Comment	File	Size	Author
#23	interdiff_2842839_18-23.txt	2.09 KB	ankithashetty
#23	2842839-23.patch	1.03 KB	ankithashetty
#23	9.4.x: PHP 8.1 & MySQL 5.7 29,739 pass
#19	applying-patch.png	68.69 KB	Madhu kumar
#18	2842839-18.patch	2.71 KB	Abhijith S
#18	9.2.x: PHP 7.3 & MySQL 5.7 Custom Commands Failed 9.4.x: PHP 8.1 & MySQL 5.7 Custom Commands Failed
#14	Screen Shot 2020-07-27 at 5.34.39 AM.png	391.14 KB	tanubansal
#11	Screen Shot 2020-07-24 at 2.03.39 PM.png	353.4 KB	tanubansal
#11	Screen Shot 2020-07-24 at 2.03.53 PM.png	304.25 KB	tanubansal
#8	book-navigation_block_causes_theme_region_to_always_render-2842839-8-D8.patch	2.72 KB	boromino
#8	8.8.x: PHP 7.1 & MySQL 5.7 27,212 pass 9.1.x: PHP 7.4 & MySQL 5.7 27,437 pass 9.2.x: PHP 7.4 & MySQL 5.7 27,787 pass 9.4.x: PHP 8.1 & MySQL 5.7 Patch Failed to Apply
#7	book-navigation_block_causes_theme_region_to_always_render-2842839-7-D8.patch	2.68 KB	boromino
#7	8.6.x: PHP 7.1 & MySQL 5.7 Patch Failed to Apply 8.8.x: PHP 7.3.x-dev & MySQL 5.7 27,195 pass, 4 fail

Support from Acquia helps fund testing for Drupal Acquia logo

Comments

Comment #1

11 January 2017 at 22:55

kevin.dutra created an issue. See original summary.

Comment #2

11 January 2017 at 22:55

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.

Comment #3

11 January 2017 at 22:55

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.

Comment #4

11 January 2017 at 22:55

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.

Comment #5

11 January 2017 at 22:55

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.

Comment #6

lhguerra CreditAttribution: lhguerra at Taller commented 6 February 2019 at 22:50

I reproduced this and it is really annoying, because it makes the check for the region in page template useless (the region will always have something inside, even with no navigation available). I think I'll have to make some context tweak for the block.

Comment #7

boromino CreditAttribution: boromino at LakeDrops commented 27 September 2019 at 11:43

Version:	8.6.x-dev	» 8.7.x-dev
Status:	Active	» Needs review

File	Size
book-navigation_block_causes_theme_region_to_always_render-2842839-7-D8.patch	2.68 KB
8.6.x: PHP 7.1 & MySQL 5.7 Patch Failed to Apply 8.8.x: PHP 7.3.x-dev & MySQL 5.7 27,195 pass, 4 fail

File

Size

book-navigation_block_causes_theme_region_to_always_render-2842839-7-D8.patch

2.68 KB

8.6.x:
PHP 7.1 & MySQL 5.7 Patch Failed to Apply

8.8.x:
PHP 7.3.x-dev & MySQL 5.7 27,195 pass, 4 fail

Comment #8

boromino CreditAttribution: boromino at LakeDrops commented 29 September 2019 at 20:05

Version:

8.7.x-dev

» 8.8.x-dev

File	Size
book-navigation_block_causes_theme_region_to_always_render-2842839-8-D8.patch	2.72 KB
8.8.x: PHP 7.1 & MySQL 5.7 27,212 pass 9.1.x: PHP 7.4 & MySQL 5.7 27,437 pass 9.2.x: PHP 7.4 & MySQL 5.7 27,787 pass 9.4.x: PHP 8.1 & MySQL 5.7 Patch Failed to Apply

File

Size

book-navigation_block_causes_theme_region_to_always_render-2842839-8-D8.patch

2.72 KB

8.8.x:
PHP 7.1 & MySQL 5.7 27,212 pass

9.1.x:
PHP 7.4 & MySQL 5.7 27,437 pass

9.2.x:
PHP 7.4 & MySQL 5.7 27,787 pass

9.4.x:
PHP 8.1 & MySQL 5.7 Patch Failed to Apply

Comment #9

29 September 2019 at 20:05

Version:

8.8.x-dev

» 8.9.x-dev

Drupal 8.8.0-alpha1 will be released the week of October 14th, 2019, which means new developments and disruptive changes should now be targeted against the 8.9.x-dev branch. (Any changes to 8.9.x will also be committed to 9.0.x in preparation for Drupal 9’s release, but some changes like significant feature additions will be deferred to 9.1.x.). For more information see the Drupal 8 and 9 minor version schedule and the Allowed changes during the Drupal 8 and 9 release cycles.

Comment #10

29 September 2019 at 20:05

Version:

8.9.x-dev

» 9.1.x-dev

Drupal 8.9.0-beta1 was released on March 20, 2020. 8.9.x is the final, long-term support (LTS) minor release of Drupal 8, which means new developments and disruptive changes should now 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.

Comment #11

tanubansal CreditAttribution: tanubansal at Salsa Digital commented 24 July 2020 at 08:36

File	Size
Screen Shot 2020-07-24 at 2.03.53 PM.png	304.25 KB
Screen Shot 2020-07-24 at 2.03.39 PM.png	353.4 KB

Tested on drupal 9.1

1. I have assigned 'Book navigation' block to Featured bottom first region
2. When checking on /user/login, it shows an empty container for that particular region

Can we get a patch for 9.1 as well?

Comment #12

tanubansal CreditAttribution: tanubansal at Salsa Digital commented 24 July 2020 at 08:36

Comment #13

boromino CreditAttribution: boromino at LakeDrops commented 26 July 2020 at 15:48

#8 works with 9.1.

Comment #14

tanubansal CreditAttribution: tanubansal at Salsa Digital commented 27 July 2020 at 00:06

File	Size
Screen Shot 2020-07-27 at 5.34.39 AM.png	391.14 KB

After adding latest patch mentioned in #8, issue is resolved in 9.1
Now, its not showing any books empty container
RTBC + 1

Comment #15

27 July 2020 at 00:06

Version:

9.1.x-dev

» 9.2.x-dev

Drupal 9.1.0-alpha1 will be released the week of October 19, 2020, which means new developments and disruptive changes should now be targeted for the 9.2.x-dev branch. For more information see the Drupal 9 minor version schedule and the Allowed changes during the Drupal 9 release cycle.

Comment #16

franz

any

Montréal

CreditAttribution: franz commented 28 January 2021 at 19:49

The dependency injection of current_user service is irrelevant to the patch.

Comment #17

Abhijith S CreditAttribution: Abhijith S as a volunteer and at Zyxware Technologies commented 19 March 2021 at 08:29

Patch #11 cant be applied on 9.2.x .Needs reroll

Checking patch core/modules/book/src/Plugin/Block/BookNavigationBlock.php...
error: while searching for:
use Symfony\Component\DependencyInjection\ContainerInterface;
use Symfony\Component\HttpFoundation\RequestStack;
use Drupal\Core\Entity\EntityStorageInterface;

/**
 * Provides a 'Book navigation' block.

error: patch failed: core/modules/book/src/Plugin/Block/BookNavigationBlock.php:11
error: core/modules/book/src/Plugin/Block/BookNavigationBlock.php: patch does not apply

Comment #18

Abhijith S CreditAttribution: Abhijith S as a volunteer and at Zyxware Technologies commented 19 March 2021 at 08:33

File	Size
2842839-18.patch	2.71 KB
9.2.x: PHP 7.3 & MySQL 5.7 Custom Commands Failed 9.4.x: PHP 8.1 & MySQL 5.7 Custom Commands Failed

File

Size

2842839-18.patch

2.71 KB

9.2.x:
PHP 7.3 & MySQL 5.7 Custom Commands Failed

9.4.x:
PHP 8.1 & MySQL 5.7 Custom Commands Failed

Rerolled patch #11 for 9.2.x.Please check.

Comment #19

Madhu kumar CreditAttribution: Madhu kumar as a volunteer and at Zyxware Technologies commented 19 March 2021 at 13:47

File	Size
applying-patch.png	68.69 KB

Patch #8 cant be applied , sharing screenshot for reference , Needs reroll for 9.2.x .

Comment #20

19 March 2021 at 13:47

Version:

9.2.x-dev

» 9.3.x-dev

Drupal 9.2.0-alpha1 will be released the week of May 3, 2021, which means new developments and disruptive changes should now be targeted for the 9.3.x-dev branch. For more information see the Drupal core minor version schedule and the Allowed changes during the Drupal core release cycle.

Comment #21

19 March 2021 at 13:47

Version:

9.3.x-dev

» 9.4.x-dev

Drupal 9.3.0-rc1 was released on November 26, 2021, which means new developments and disruptive changes should now be targeted for the 9.4.x-dev branch. For more information see the Drupal core minor version schedule and the Allowed changes during the Drupal core release cycle.

Comment #22

larowlan

🇦🇺🏝.au GMT+10

CreditAttribution: larowlan at PreviousNext commented 21 April 2022 at 09:31

Issue tags:

+Needs reroll, +Novice, +Needs tests, +Bug Smash Initiative

This needs a reroll and #16 needs to be implemented

Also needs a test

Comment #23

ankithashetty

Karnataka, India

CreditAttribution: ankithashetty as a volunteer and at Specbee for Drupal India Association commented 26 April 2022 at 11:07

Issue tags:

-Needs reroll

File	Size
2842839-23.patch	1.03 KB
9.4.x: PHP 8.1 & MySQL 5.7 29,739 pass
interdiff_2842839_18-23.txt	2.09 KB

Rerolled the patch in #18 and also addressed #16, thanks!

Comment #24

Scott Weston CreditAttribution: Scott Weston at Bounteous commented 27 April 2022 at 20:22

Status:

Needs review

» Reviewed & tested by the community

Reviewed and tested #23. Working as expected.

Testing Steps I took:
* Clean install of latest Drupal core standard installation profile.
* Enabled Book module.
* Place book navigation block in "Featured Top" region (with no other blocks).
* Verified featured top region is not output.

* Added book and pages.
* Confirmed Book Navigation block output in the Featured Top region.
* Navigated to a non-book page, confirmed that the Featured Top region is not output.

RTBC +1

Comment #25

larowlan

🇦🇺🏝.au GMT+10

CreditAttribution: larowlan at PreviousNext commented 29 April 2022 at 08:35

Status:	Reviewed & tested by the community	» Needs work
Issue tags:	-Novice

Thanks folks, we still need a test here to demonstrate the bug.

The best place for this would be \Drupal\Tests\book\Functional\BookTest

The test should basically repeat the steps outlined by @Scott Weston, thanks 💪

Comment #26

29 April 2022 at 08:35

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.

Comment #27

29 April 2022 at 08:35

Version:

9.5.x-dev

» 10.1.x-dev

Drupal 9.5.0-beta2 and Drupal 10.0.0-beta2 were released on September 29, 2022, which means new developments and disruptive changes should now 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.

Comment #28

29 April 2022 at 08:35

Version:

10.1.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, which currently accepts only minor-version allowed changes. For more information, see the Drupal core minor version schedule and the Allowed changes during the Drupal core release cycle.