Skip to content

Fix #5331: update system-wide alert preview countdown dynamically#5383

Open
guillermo-escire wants to merge 3 commits intoDSpace:mainfrom
guillermo-escire:feature/5331
Open

Fix #5331: update system-wide alert preview countdown dynamically#5383
guillermo-escire wants to merge 3 commits intoDSpace:mainfrom
guillermo-escire:feature/5331

Conversation

@guillermo-escire
Copy link
Copy Markdown
Contributor

References

Fixes #5331

Description

Fixes the system-wide alert countdown timer in the preview. The countdown now updates dynamically every second and disappears when it reaches zero.

Instructions for Reviewers

Changes included in this PR:

  • Added checks for date and time before updating the preview to prevent errors.
  • Modified the allocateTimeUnits function so that when the countdown reaches zero, days, hours, and minutes are set to 0 and the visible countdown stops.
  • Adjusted the previewSubscription using interval(1000) to refresh the countdown every second.
  • Added a comment to the previewSubscription variable for consistency with other variables (counterEnabled$, previewMinutes, previewHours, previewDays).

How to test:

  1. Go to System Alerts → System-Wide Alert.
  2. Activate an alert and enable the countdown timer.
  3. Set the timer to one minute in the future.
  4. Observe the alert preview: the countdown should update dynamically every second showing the correct remaining time.
  5. When it reaches zero, the counter disappears from the banner.

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: preview timer does not auto-update after scheduled time elapses

1 participant