Summary

Port to the new Page Banner support, and add can-close settings.

Review Request #14560 — Created Aug. 7, 2025 and updated March 26, 2026, 3:43 p.m.

Information

Owner

chipx86

Repository

rb-extension-pack

Branch

master

Bugs

Depends On

~~14557~~

Reviewers

Groups

rb-extension-pack

People

Description

When run on older versions, the banner will continue to handle all
presentation and placement as before.

This is implemented as two entirely separate TemplateHooks. They
calculate similar state, but behave a bit differently under the hood,
particularly with the visibility state.

There's also a new feature allowing administrators to control whether
users can close this banner. This can be turned off if the banner is
something that needs to always be seen (such as important user
instructions, legal notices, outages, etc.).

This will all be for the upcoming 4.0 release.

Testing Done

Tested on Review Board 7.0 and 7.1, with and without the option
for letting users close banners.

Tested the closing and should-render functionality on both.

Inspected the generated HTML and scripts for all verson/setting
combinations.

Commits

Summary	ID
Port to the new Page Banner support, and add can-close settings. When run on Review Board 7.1+, the Message of the Day banner will now make use of the new standard Page Banner UI component, which takes care of all the presentation of banners. This creates a more consistent look and helps make this extension more future-proof. When run on older versions, the banner will continue to handle all presentation and placement as before. This is implemented as two entirely separate `TemplateHooks`. They calculate similar state, but behave a bit differently under the hood, particularly with the visibility state. There's also a new feature allowing administrators to control whether users can close this banner. This can be turned off if the banner is something that needs to always be seen (such as important user instructions, legal notices, outages, etc.). This will all be for the upcoming 4.0 release.	67b7af662f512e6bd3471a876c183e497692c63b

Summary

Port to the new Page Banner support, and add can-close settings.

When run on Review Board 7.1+, the Message of the Day banner will now make use of the new standard Page Banner UI component, which takes care of all the presentation of banners. This creates a more consistent look and helps make this extension more future-proof. When run on older versions, the banner will continue to handle all presentation and placement as before. This is implemented as two entirely separate `TemplateHooks`. They calculate similar state, but behave a bit differently under the hood, particularly with the visibility state. There's also a new feature allowing administrators to control whether users can close this banner. This can be turned off if the banner is something that needs to always be seen (such as important user instructions, legal notices, outages, etc.). This will all be for the upcoming 4.0 release.

67b7af662f512e6bd3471a876c183e497692c63b

Issues

Description	From	Last Updated
Did you forget to add the scripts.html file?	david	Sept. 14, 2025, 6:46 p.m.
This needs a Version Changed for the rename, and shouldn't we keep the old name around and use housekeeping's "class …	maubin	March 9, 2026, 11:50 p.m.
Nit: we only use this variable in one place (after getting rid of the debug print), we could instead inline …	maubin	March 9, 2026, 11:50 p.m.
Leftover debug code.	maubin	March 9, 2026, 11:50 p.m.
Nit: we only use this variable in one place, we could instead inline this in the dict definition.	maubin	March 9, 2026, 11:50 p.m.
While we're doing this can we explicitly type as tuple[int, int, int, int, str, int, bool]? Otherwise version comparisons get …	david	March 25, 2026, 12:12 p.m.
Typo: single backtick at the end instead of double.	david	March 25, 2026, 12:12 p.m.
Typo: utilizies -> utilizes	david	March 25, 2026, 12:12 p.m.
Can we switch to an f-string?	david	March 26, 2026, 3:43 p.m.
Just for extra sanity, should we check that the message isn't empty?	david	March 26, 2026, 3:43 p.m.
Can we switch to an f-string?	david	March 26, 2026, 3:43 p.m.

flake8 passed.

JSHint passed.

rbmotd/rbmotd/templates/rbmotd/motd.html (Diff revision 1)
The issue has been resolved. Show all issues
```
Did you forget to add the scripts.html file?
```

Change Summary:

Added the missing scripts.html.

Commits:

	Summary	ID
	Port to the new Page Banner support, and add can-close settings. When run on Review Board 7.1+, the Message of the Day banner will now make use of the new standard Page Banner UI component, which takes care of all the presentation of banners. This creates a more consistent look and helps make this extension more future-proof. When run on older versions, the banner will continue to handle all presentation and placement as before. This is implemented as two entirely separate `TemplateHooks`. They calculate similar state, but behave a bit differently under the hood, particularly with the visibility state. There's also a new feature allowing administrators to control whether users can close this banner. This can be turned off if the banner is something that needs to always be seen (such as important user instructions, legal notices, outages, etc.). This will all be for the upcoming 4.0 release.	effb44dedb9692e433eec6c3d6edb3e09b936890
	Port to the new Page Banner support, and add can-close settings. When run on Review Board 7.1+, the Message of the Day banner will now make use of the new standard Page Banner UI component, which takes care of all the presentation of banners. This creates a more consistent look and helps make this extension more future-proof. When run on older versions, the banner will continue to handle all presentation and placement as before. This is implemented as two entirely separate `TemplateHooks`. They calculate similar state, but behave a bit differently under the hood, particularly with the visibility state. There's also a new feature allowing administrators to control whether users can close this banner. This can be turned off if the banner is something that needs to always be seen (such as important user instructions, legal notices, outages, etc.). This will all be for the upcoming 4.0 release.	f3745e0d3b0458a81cc3089d9103272bb661bb3c

Diff:

Revision 2 (+360 -76)

Show changes

	rbmotd/rbmotd/__init__.py
	rbmotd/rbmotd/extension.py
	rbmotd/rbmotd/forms.py
	rbmotd/rbmotd/templates/rbmotd/motd.html
	rbmotd/rbmotd/templates/rbmotd/scripts.html

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

rbmotd/rbmotd/extension.py (Diff revision 2)

The issue has been resolved. Show all issues

This needs a Version Changed for the rename, and shouldn't we keep the old name around and use housekeeping's "class moved" decorator? I know these are internal to the MOTD extension but aren't they technically still public.

david Sept. 15, 2025, 2:34 p.m.

Nobody is using this code as an API. For extensions like this we want to maintain compatibility and potentially do deprecation cycles for functionality, but we don't need to maintain API stability the way we do in our other code.

rbmotd/rbmotd/extension.py (Diff revision 2)

The issue has been resolved. Show all issues

Nit: we only use this variable in one place (after getting rid of the debug print), we could instead inline this in the dict definition.

rbmotd/rbmotd/extension.py (Diff revision 2)
The issue has been resolved. Show all issues
```
Leftover debug code.
```

rbmotd/rbmotd/extension.py (Diff revision 2)

The issue has been resolved. Show all issues

Nit: we only use this variable in one place, we could instead inline this in the dict definition.

Change Summary:


Removed leftover debug output.
Added a Version Added to the legacy banner, with a note that it replaces the old banner.
Moved some can_close calculations inline into the resulting context dictionaries.

Commits:

	Summary	ID
	Port to the new Page Banner support, and add can-close settings. When run on Review Board 7.1+, the Message of the Day banner will now make use of the new standard Page Banner UI component, which takes care of all the presentation of banners. This creates a more consistent look and helps make this extension more future-proof. When run on older versions, the banner will continue to handle all presentation and placement as before. This is implemented as two entirely separate `TemplateHooks`. They calculate similar state, but behave a bit differently under the hood, particularly with the visibility state. There's also a new feature allowing administrators to control whether users can close this banner. This can be turned off if the banner is something that needs to always be seen (such as important user instructions, legal notices, outages, etc.). This will all be for the upcoming 4.0 release.	f3745e0d3b0458a81cc3089d9103272bb661bb3c
	Port to the new Page Banner support, and add can-close settings. When run on Review Board 7.1+, the Message of the Day banner will now make use of the new standard Page Banner UI component, which takes care of all the presentation of banners. This creates a more consistent look and helps make this extension more future-proof. When run on older versions, the banner will continue to handle all presentation and placement as before. This is implemented as two entirely separate `TemplateHooks`. They calculate similar state, but behave a bit differently under the hood, particularly with the visibility state. There's also a new feature allowing administrators to control whether users can close this banner. This can be turned off if the banner is something that needs to always be seen (such as important user instructions, legal notices, outages, etc.). This will all be for the upcoming 4.0 release.	5e489e65cbdfff4e30785a6dae9031828f7e821b

Diff:

Revision 3 (+364 -78)

Show changes

	rbmotd/rbmotd/__init__.py
	rbmotd/rbmotd/extension.py
	rbmotd/rbmotd/forms.py
	rbmotd/rbmotd/templates/rbmotd/motd.html
	rbmotd/rbmotd/templates/rbmotd/scripts.html

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Ship it!

```
Ship It!
```

rbmotd/rbmotd/__init__.py (Diff revision 3)

The issue has been resolved. Show all issues

While we're doing this can we explicitly type as tuple[int, int, int, int, str, int, bool]? Otherwise version comparisons get flagged because the implicit type for this uses Literal (would also need __future__.annotations import)

rbmotd/rbmotd/extension.py (Diff revision 3)
The issue has been resolved. Show all issues
```
Typo: single backtick at the end instead of double.
```
rbmotd/rbmotd/extension.py (Diff revision 3)
The issue has been resolved. Show all issues
```
Typo: utilizies -> utilizes
```

Change Summary:


Added typing for VERSION.
Fixed issues in docstrings.

Commits:

	Summary	ID
	Port to the new Page Banner support, and add can-close settings. When run on Review Board 7.1+, the Message of the Day banner will now make use of the new standard Page Banner UI component, which takes care of all the presentation of banners. This creates a more consistent look and helps make this extension more future-proof. When run on older versions, the banner will continue to handle all presentation and placement as before. This is implemented as two entirely separate `TemplateHooks`. They calculate similar state, but behave a bit differently under the hood, particularly with the visibility state. There's also a new feature allowing administrators to control whether users can close this banner. This can be turned off if the banner is something that needs to always be seen (such as important user instructions, legal notices, outages, etc.). This will all be for the upcoming 4.0 release.	5e489e65cbdfff4e30785a6dae9031828f7e821b
	Port to the new Page Banner support, and add can-close settings. When run on Review Board 7.1+, the Message of the Day banner will now make use of the new standard Page Banner UI component, which takes care of all the presentation of banners. This creates a more consistent look and helps make this extension more future-proof. When run on older versions, the banner will continue to handle all presentation and placement as before. This is implemented as two entirely separate `TemplateHooks`. They calculate similar state, but behave a bit differently under the hood, particularly with the visibility state. There's also a new feature allowing administrators to control whether users can close this banner. This can be turned off if the banner is something that needs to always be seen (such as important user instructions, legal notices, outages, etc.). This will all be for the upcoming 4.0 release.	67b7af662f512e6bd3471a876c183e497692c63b

Diff:

Revision 4 (+370 -78)

Show changes

	rbmotd/rbmotd/__init__.py
	rbmotd/rbmotd/extension.py
	rbmotd/rbmotd/forms.py
	rbmotd/rbmotd/templates/rbmotd/motd.html
	rbmotd/rbmotd/templates/rbmotd/scripts.html

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Fix it!

rbmotd/rbmotd/extension.py (Diff revision 4)
An issue was opened. Show all issues
```
Can we switch to an f-string?
```

rbmotd/rbmotd/extension.py (Diff revision 4)

An issue was opened. Show all issues

Just for extra sanity, should we check that the message isn't empty?

rbmotd/rbmotd/extension.py (Diff revision 4)
An issue was opened. Show all issues
```
Can we switch to an f-string?
```