Skip to content

Fix #5336: General system alert visible to users in real time without…#5451

Open
guillermo-escire wants to merge 1 commit intoDSpace:mainfrom
guillermo-escire:feature/5336
Open

Fix #5336: General system alert visible to users in real time without…#5451
guillermo-escire wants to merge 1 commit intoDSpace:mainfrom
guillermo-escire:feature/5336

Conversation

@guillermo-escire
Copy link
Copy Markdown
Contributor

References

Description

Fixes an issue where system-wide alerts were not updated in real time for users already browsing the site. The alert banner now refreshes on navigation and properly handles deactivation without requiring a manual page reload.

Instructions for Reviewers

This PR ensures that system-wide alerts are dynamically updated during normal navigation without requiring a full page reload.

Changes

List of changes in this PR:

  • Re-fetch system-wide alerts on every NavigationEnd router event
  • Added startWith(null) to trigger initial fetch on component load
  • Disabled cache usage in searchBy to ensure fresh data is retrieved
  • Updated logic to handle empty responses (no active alerts) by emitting null
  • Ensured banner is hidden when no active alert exists
  • Added Router mock in unit tests to support new reactive flow

How to test

  1. Open DSpace in two browser sessions (or one normal + one incognito)

  2. In Browser 1:

    • Navigate to any page (e.g. homepage)
  3. In Browser 2 (admin user):

    • Go to System-Wide Alert settings
    • Enable a new alert and save
  4. In Browser 1:

    • Navigate to another page (without refreshing)
    • ✅ The alert should now appear
  5. Still in Browser 2:

    • Disable the alert and save
  6. In Browser 1:

    • Navigate again
    • ✅ The alert should disappear

Checklist

This checklist provides a reminder of what we are going to look for when reviewing your PR. You do not need to complete this checklist prior creating your PR (draft PRs are always welcome).
However, reviewers may request that you complete any actions in this list if you have not done so. If you are unsure about an item in the checklist, don't hesitate to ask. We're here to help!

  • My PR is created against the main branch of code (unless it is a backport or is fixing an issue specific to an older branch).
  • My PR is small in size (e.g. less than 1,000 lines of code, not including comments & specs/tests), or I have provided reasons as to why that's not possible.
  • My PR passes ESLint validation using npm run lint
  • My PR doesn't introduce circular dependencies (verified via npm run check-circ-deps)
  • My PR includes TypeDoc comments for all new (or modified) public methods and classes. It also includes TypeDoc for large or complex private methods.
  • My PR passes all specs/tests and includes new/updated specs or tests based on the Code Testing Guide.
  • My PR aligns with Accessibility guidelines if it makes changes to the user interface.
  • My PR uses i18n (internationalization) keys instead of hardcoded English text, to allow for translations.
  • My PR includes details on how to test it. I've provided clear instructions to reviewers on how to successfully test this fix or feature.
  • If my PR includes new libraries/dependencies (in package.json), I've made sure their licenses align with the DSpace BSD License based on the Licensing of Contributions documentation.
  • If my PR includes new features or configurations, I've provided basic technical documentation in the PR itself.
  • If my PR fixes an issue ticket, I've linked them together.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

System-Wide Alert: Not visible to users in real time without page reload

1 participant