Summary

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

Review Request #14560 — Created Aug. 7, 2025 and updated Sept. 15, 2025, 2:34 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.	f3745e0d3b0458a81cc3089d9103272bb661bb3c

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.

f3745e0d3b0458a81cc3089d9103272bb661bb3c

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	Sept. 15, 2025, 1:40 a.m.
Nit: we only use this variable in one place (after getting rid of the debug print), we could instead inline …	maubin	Sept. 15, 2025, 1:40 a.m.
Leftover debug code.	maubin	Sept. 15, 2025, 1:40 a.m.
Nit: we only use this variable in one place, we could instead inline this in the dict definition.	maubin	Sept. 15, 2025, 1:40 a.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.

Fix it!

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

An issue was opened. 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)

An issue was opened. 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)
An issue was opened. Show all issues
```
Leftover debug code.
```

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

An issue was opened. Show all issues

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