Allow configuring Announcement banner by admin #10951

sudo87 · 2025-06-04T09:33:33Z

Description

This PR enables Admin to configure UI Announcement banner containing message through config.json. HTML based message is supported apart from regular text

It can be configured by defining following section in config.json:

"announcementBanner": {
    "enabled": true,
    "showIcon": true,
    "closable": true,
    "persistDismissal": true,
    "type": "warning",
    "message": "<strong>Performance Notice:</strong> We're experiencing high load. Some operations may be slower than usual.",
    "startDate": "2025-06-01T00:00:00Z",
    "endDate": "2025-07-16T00:00:00Z"
}

Following types are supported:

info
warning
error

To ensure banner is shown only once, enable the following config:

persistDismissal: true

Doc PR: apache/cloudstack-documentation#517

Types of changes

Breaking change (fix or feature that would cause existing functionality to change)
New feature (non-breaking change which adds functionality)
Bug fix (non-breaking change which fixes an issue)
Enhancement (improves an existing feature and functionality)
Cleanup (Code refactoring and cleanup, that may add test cases)
build/CI
test (unit or integration test code)

Feature/Enhancement Scale or Bug Severity

Feature/Enhancement Scale

Major
Minor

Bug Severity

Screenshots (if appropriate):

How Has This Been Tested?

How did you try to break this feature and the system with this change?

New npm dep (dompurify) is included to sanitize the html.

codecov · 2025-06-04T09:40:56Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 16.60%. Comparing base (2d669db) to head (0d58cb0).
Report is 12 commits behind head on main.

Additional details and impacted files

@@             Coverage Diff              @@
##               main   #10951      +/-   ##
============================================
- Coverage     16.60%   16.60%   -0.01%     
- Complexity    13924    13925       +1     
============================================
  Files          5730     5731       +1     
  Lines        508082   508123      +41     
  Branches      61770    61783      +13     
============================================
+ Hits          84388    84392       +4     
- Misses       414259   414296      +37     
  Partials       9435     9435

Flag	Coverage Δ
uitests	`3.94% <ø> (+<0.01%)`	⬆️
unittests	`17.50% <ø> (+<0.01%)`	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

ui/package-lock.json

sudo87 · 2025-06-05T06:48:26Z

@blueorangutan ui

blueorangutan · 2025-06-05T06:49:04Z

@sudo87 a Jenkins job has been kicked to build UI QA env. I'll keep you posted as I make progress.

blueorangutan · 2025-06-05T07:06:47Z

UI build: ✔️
Live QA URL: https://qa.cloudstack.cloud/simulator/pr/10951 (QA-JID-637)

sudo87 · 2025-06-05T11:49:39Z

@blueorangutan package

blueorangutan · 2025-06-05T11:50:04Z

@sudo87 a [SL] Jenkins job has been kicked to build packages. It will be bundled with KVM, XenServer and VMware SystemVM templates. I'll keep you posted as I make progress.

blueorangutan · 2025-06-05T13:30:32Z

Packaging result [SF]: ✔️ el8 ✔️ el9 ✔️ debian ✔️ suse15. SL-JID 13635

shwstppr

code lgtm

@sudo87 can you please add some documentation regarding this, probably somewhere https://github.com/apache/cloudstack-documentation/blob/main/source/adminguide/ui.rst

rohityadavcloud

The floating banner hides the content behind it. I think it should instead be part of the page view/frame (or top global header component) & push the entire UI content down. See the banner on https://apisix.apache.org/ or https://docusaurus.io/ for example, where the announcement banner is pushing the entire content down, not floating on the UI.

The a-alert Ant Design Vue — An enterprise-class UI components based on Ant Design and Vue.js could be used, or a new component could be created.

sudo87 · 2025-06-09T13:08:35Z

@blueorangutan package

blueorangutan · 2025-06-09T13:10:04Z

@sudo87 a [SL] Jenkins job has been kicked to build packages. It will be bundled with KVM, XenServer and VMware SystemVM templates. I'll keep you posted as I make progress.

blueorangutan · 2025-06-09T14:22:40Z

Packaging result [SF]: ✔️ el8 ✔️ el9 ✔️ debian ✔️ suse15. SL-JID 13670

shwstppr · 2025-06-11T06:17:29Z

@blueorangutan ui

blueorangutan · 2025-06-11T06:18:04Z

@shwstppr a Jenkins job has been kicked to build UI QA env. I'll keep you posted as I make progress.

blueorangutan · 2025-06-11T06:35:35Z

UI build: ✔️
Live QA URL: https://qa.cloudstack.cloud/simulator/pr/10951 (QA-JID-643)

shwstppr

LGTM

vishesh92

@sudo87 CLGTM. Some minor changes would be good to have:

Add a dummy entry in config.json for the banner which is disabled by default. It helps the end user update the configuration directly on the server.
Allow configuring the banner such that it only shows on login screen or after login or both.

vishesh92 · 2025-06-11T10:19:40Z

@sudo87 Found an issue.
When the banner is not closed,

Open a list view (e.g. projects) or details page (e.g. Public IP Address)
On scrolling down, there is a gray area on top.

github-actions · 2025-06-12T07:47:06Z

This pull request has merge conflicts. Dear author, please fix the conflicts and sync your branch with the base branch.

vishesh92 · 2025-06-12T08:04:50Z

@blueorangutan package

blueorangutan · 2025-06-12T08:06:04Z

@vishesh92 a [SL] Jenkins job has been kicked to build packages. It will be bundled with KVM, XenServer and VMware SystemVM templates. I'll keep you posted as I make progress.

blueorangutan · 2025-06-12T10:15:55Z

Packaging result [SF]: ✖️ el8 ✖️ el9 ✔️ debian ✖️ suse15. SL-JID 13744

vishesh92 · 2025-06-12T10:43:07Z

@blueorangutan package
@blueorangutan ui

blueorangutan · 2025-06-12T10:44:04Z

@vishesh92 a [SL] Jenkins job has been kicked to build packages. It will be bundled with@blueorangutan ui SystemVM template(s). I'll keep you posted as I make progress.

blueorangutan · 2025-06-12T10:44:04Z

@vishesh92 a Jenkins job has been kicked to build UI QA env. I'll keep you posted as I make progress.

blueorangutan · 2025-06-12T11:02:25Z

UI build: ✔️
Live QA URL: https://qa.cloudstack.cloud/simulator/pr/10951 (QA-JID-646)

blueorangutan · 2025-06-12T11:39:30Z

Packaging result [SF]: ✔️ el8 ✔️ el9 ✔️ debian ✔️ suse15. SL-JID 13748

vishesh92

lgtm. tested locally. works as expected.

harikrishna-patnala

LGTM

Allow configuring Announcement banner by admin

e7f9cc7

boring-cyborg bot added the component:UI label Jun 4, 2025

sudo87 requested review from rohityadavcloud and shwstppr June 4, 2025 09:34

add license

c3e4b66

sudo87 marked this pull request as ready for review June 4, 2025 11:33

bernardodemarco reviewed Jun 4, 2025

View reviewed changes

ui/package-lock.json Show resolved Hide resolved

revert un-necessary changes from package-lock.json

e3b6f6f

sudo87 requested a review from vishesh92 June 5, 2025 06:00

sureshanaparti added this to the 4.21.0 milestone Jun 5, 2025

sureshanaparti added this to Apache CloudStack 4.21.0 Jun 5, 2025

shwstppr approved these changes Jun 6, 2025

View reviewed changes

sudo87 mentioned this pull request Jun 6, 2025

UI: Announcement banner documentation apache/cloudstack-documentation#517

Open

rohityadavcloud requested changes Jun 9, 2025

View reviewed changes

banner should use 100% width and push down content down

8dd5bda

sudo87 requested a review from rohityadavcloud June 10, 2025 09:29

shwstppr approved these changes Jun 11, 2025

View reviewed changes

vishesh92 reviewed Jun 11, 2025

View reviewed changes

fix grey area issue

72e1ad1

github-actions bot added the status:has-conflicts label Jun 12, 2025

merge main changes

0d58cb0

github-actions bot removed the status:has-conflicts label Jun 12, 2025

vishesh92 approved these changes Jun 17, 2025

View reviewed changes

harikrishna-patnala approved these changes Jun 19, 2025

View reviewed changes

sudo87 added the status:needs-testing label Jun 19, 2025

sudo87 requested a review from borisstoyanov June 19, 2025 04:51

Allow configuring Announcement banner by admin #10951

Are you sure you want to change the base?

Allow configuring Announcement banner by admin #10951

Uh oh!

Conversation

sudo87 commented Jun 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Types of changes

Feature/Enhancement Scale or Bug Severity

Feature/Enhancement Scale

Bug Severity

Screenshots (if appropriate):

How Has This Been Tested?

How did you try to break this feature and the system with this change?

Uh oh!

codecov bot commented Jun 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Uh oh!

sudo87 commented Jun 5, 2025

Uh oh!

blueorangutan commented Jun 5, 2025

Uh oh!

blueorangutan commented Jun 5, 2025

Uh oh!

sudo87 commented Jun 5, 2025

Uh oh!

blueorangutan commented Jun 5, 2025

Uh oh!

blueorangutan commented Jun 5, 2025

Uh oh!

shwstppr left a comment

Choose a reason for hiding this comment

Uh oh!

rohityadavcloud left a comment

Choose a reason for hiding this comment

Uh oh!

sudo87 commented Jun 9, 2025

Uh oh!

blueorangutan commented Jun 9, 2025

Uh oh!

blueorangutan commented Jun 9, 2025

Uh oh!

shwstppr commented Jun 11, 2025

Uh oh!

blueorangutan commented Jun 11, 2025

Uh oh!

blueorangutan commented Jun 11, 2025

Uh oh!

shwstppr left a comment

Choose a reason for hiding this comment

Uh oh!

vishesh92 left a comment

Choose a reason for hiding this comment

Uh oh!

vishesh92 commented Jun 11, 2025

Uh oh!

github-actions bot commented Jun 12, 2025

Uh oh!

vishesh92 commented Jun 12, 2025

Uh oh!

blueorangutan commented Jun 12, 2025

Uh oh!

blueorangutan commented Jun 12, 2025

Uh oh!

vishesh92 commented Jun 12, 2025

Uh oh!

blueorangutan commented Jun 12, 2025

Uh oh!

blueorangutan commented Jun 12, 2025

Uh oh!

blueorangutan commented Jun 12, 2025

Uh oh!

blueorangutan commented Jun 12, 2025

Uh oh!

vishesh92 left a comment

Choose a reason for hiding this comment

Uh oh!

sudo87 commented Jun 4, 2025 •

edited

Loading

codecov bot commented Jun 4, 2025 •

edited

Loading