Implement snooze functionality for administrative monitors with… #26244

LakshyaBagani · 2026-02-02T11:46:46Z

Fixes #16641

Testing done

Automated Testing:

Created core/src/test/java/hudson/model/AdministrativeMonitorTest.java with 8 new unit tests covering:
Snooze expiry logic (testSnoozeExpiry).
Cleanup of expired monitors (testCleanupRemovesOnlyThisMonitor).
Persistence of snoozed state across restarts (testSnoozePersistence).
Isolation between multiple monitors (testMultipleMonitorsIndependent).
Validation of duration input (negative, zero, excessive duration checks).

Ran mvn test -Dtest=AdministrativeMonitorTest (Passed: 8/8 tests).
Ran mvn clean verify to ensure no regressions in established tests.

Manual Verification:

Verified Internationalization:
Checked core/src/main/resources/hudson/model/Messages.properties for presence of Snooze, Snooze.duration.label, etc.

Verified Accessibility:
Inspected Jelly files (BuiltInNodeMigration, ControllerExecutorsAgents, ControllerExecutorsNoAgents) to ensure <label>, id, aria-label, and title attributes were correctly added to input fields.

Verified Javadoc:
Confirmed AdministrativeMonitor.java Javadoc formatting matches master branch (no diff noise).

Screenshots (UI changes only)

Before

After

Proposed changelog entries

Allow administrative monitors to be snoozed for a specific duration (up to 1 year).

Proposed changelog category

/label rfe

Proposed upgrade guidelines

N/A

Submitter checklist

The issue, if it exists, is well-described.
The changelog entries and upgrade guidelines are appropriate for the audience affected by the change (users or developers, depending on the change) and are in the imperative mood.
There is automated testing or an explanation as to why this change has no tests.
New public classes, fields, and methods are annotated with @Restricted or have @since TODO Javadocs, as appropriate.
New deprecations are annotated with @Deprecated(since = "TODO") or @Deprecated(forRemoval = true, since = "TODO"), if applicable.
UI changes do not introduce regressions when enforcing the current default rules of Content Security Policy Plugin. In particular, new or substantially changed JavaScript is not defined inline and does not call eval to ease future introduction of Content Security Policy (CSP) directives.
For dependency updates, there are links to external changelogs and, if possible, full differentials.
For new APIs and extension points, there is a link to at least one consumer.

Desired reviewers

@timja @mawinter69 @MarkEWaite

… cleanup and validation

mawinter69

Do we really need minute precision for this? It will be hard to know how many minutes you have to enter when you want to snooze for a couple of days or even weeks. Hours or even days might be sufficient. Maybe instead use an input with a datetime picker.

Having the input field next to the button doesn't look that good. Already in your screenshot the placeholder is cut off. Might be worth to check if using a dialog where you choose the snooze time is better. There you could easily provide a drop down with some predefined values and a custom value.

You could just do some javascript that does a post to the doSnooze method and on success just hides the message. That would avoid a page reload.

mawinter69 · 2026-02-02T14:20:47Z

core/src/main/resources/hudson/model/Messages.properties


 UserPreferencesProperty.DisplayName=Preferences
+
+snooze=Snooze


That is not accessible from jelly files. You can see in your screenshot that the values are not used.

You are right the previous package mismatch caused the translation lookup to fail. I have now moved the form into a dedicated t:snooze taglib at lib/hudson/snooze.jelly with its own snooze.properties file in the same folder

mawinter69 · 2026-02-02T14:21:13Z

core/src/main/resources/jenkins/diagnostics/ControllerExecutorsAgents/message.jelly

+        <f:submit name="yes" value="${%Manage}"/>
+        <f:submit name="no" value="${%Dismiss}"/>
+      </form>
+      <form method="post" action="${rootURL}/${it.url}/snooze" style="display: inline-flex; gap: 0.5rem; align-items: center;">


Looks identical in all 3 places. So that might be better placed in a taglib for easy reuse.

Refactored the duplicate code into a reusable t:snooze tag in lib/hudson.

mawinter69 · 2026-02-02T14:22:37Z

core/src/main/resources/jenkins/diagnostics/ControllerExecutorsAgents/message.jelly

+        <f:submit name="yes" value="${%Manage}"/>
+        <f:submit name="no" value="${%Dismiss}"/>
+      </form>
+      <form method="post" action="${rootURL}/${it.url}/snooze" style="display: inline-flex; gap: 0.5rem; align-items: center;">


Would prefer that this is defined in a css file

I have replaced the inline styles with core utility classes.

mawinter69 · 2026-02-02T14:33:01Z

core/src/main/java/hudson/model/AdministrativeMonitor.java

+        String duration = req.getParameter("duration");
+        long durationMs;
+        try {
+            if ("custom".equals(duration)) {


Isn't that always true as the 'duration' field has a default of custom and there is no code that will ever change this?

I included that for future flexibility, but you are right it is redundant since the current UI only sends custom. I will simplify the logic to handle the custom path directly and remove the unnecessary check.

mawinter69 · 2026-02-02T14:37:41Z

core/src/main/resources/jenkins/diagnostics/ControllerExecutorsAgents/message.jelly

+        <f:submit name="no" value="${%Dismiss}"/>
+      </form>
+      <form method="post" action="${rootURL}/${it.url}/snooze" style="display: inline-flex; gap: 0.5rem; align-items: center;">
+        <j:if test="${h.isCrumbEncoded()}">


Why is this needed?

I manually added the CSRF crumb logic to ensure the snooze action was secure, but I have since realized this is redundant as Jenkins global JavaScript automatically injects crumbs into all POST forms. I will remove these lines along with the manual flex styling to keep the implementation clean and consistent with the existing patterns in the codebase.

mawinter69

You might want to take a look at #23859 where I implemented token expiration. This also has a dialog with a select for preset expirations and a custom input field for a date select.

mawinter69 · 2026-02-03T18:22:11Z

core/src/main/java/hudson/model/AdministrativeMonitor.java

    }

+    /**
+     * @since 2.549


Please don't set a version yet but write TODO. You don't know how fast your change will be merged. The version will be filled in later automatically.

mawinter69 · 2026-02-03T18:24:56Z

core/src/main/resources/lib/hudson/snoozeForm.js

Please use the built-in support for dialogs. See https://weekly.ci.jenkins.io/design-library/dialogs/ how to use it

mawinter69 · 2026-02-03T18:33:17Z

core/src/main/resources/lib/hudson/snoozeForm.jelly

+          <label for="snooze-duration-${it.id}" class="jenkins-form-label" style="display:block; margin-bottom: 5px;">
+            ${%snooze.duration.label}
+          </label>
+          <select id="snooze-duration-${it.id}" name="durationPreset" 


The select will not be styled like other selects in Jenkins

mawinter69 · 2026-02-03T18:39:25Z

core/src/main/resources/lib/hudson/snoozeForm.jelly

+  </button>
+
+  <dialog id="snooze-dialog-${it.id}" class="snooze-dialog">
+    <form id="snooze-form-${it.id}" method="post" 


Use <f:form

mawinter69 · 2026-02-03T18:42:34Z

core/src/main/resources/lib/hudson/snoozeForm.jelly

+          </select>
+        </div>
+
+        <div class="jenkins-form-item">


That could be just <f:number ...

mawinter69 · 2026-02-03T18:44:27Z

core/src/main/java/hudson/model/AbstractCIBase.java

+    private final Map<String, Long> snoozedAdministrativeMonitors = new HashMap<>();
+
+    /**
+     * @since 2.549


mawinter69 · 2026-02-03T18:44:31Z

core/src/main/java/hudson/model/AbstractCIBase.java

+    }
+
+    /**
+     * @since 2.549


mawinter69 · 2026-02-03T18:44:36Z

core/src/main/java/hudson/model/AdministrativeMonitor.java

+    }
+
+    /**
+     * @since 2.549


mawinter69 · 2026-02-03T18:44:40Z

core/src/main/java/hudson/model/AdministrativeMonitor.java

    }

    /**
+     * @since 2.549


mawinter69 · 2026-02-03T18:46:52Z

core/src/main/resources/lib/hudson/snoozeForm.jelly

+            <input type="number" id="snooze-minutes-${it.id}" name="customMinutes"
+                   placeholder="${%snooze.duration.placeholder}" min="1" max="525600"
+                   class="jenkins-input snooze-custom-input"
+                   style="display: none; width: 100%;"


In general when you want to hide something, set the class jenkins-hidden, to later show it just remove it from the element. That avoids that you need to know which exact value is set for display when it is shown.

mawinter69

Seems you've never really tested this.

mawinter69 · 2026-02-03T19:17:27Z

core/src/main/resources/lib/hudson/snoozeForm.jelly

+    Uses AJAX to avoid page reload.
+  </st:documentation>
+
+  <st:adjunct includes="lib.hudson.snoozeForm"/>


You need to rename the .js and the .css files. What happens now is that the adjunct will also include the snoozeForm.jelly, leading to a duplication of things

mawinter69 · 2026-02-03T19:20:01Z

core/src/main/resources/lib/hudson/snoozeForm.css

By using the built-in dialog support you will most likely not need any css. It will work out of the box also with dark theme or other themes

feat: implement snooze functionality for administrative monitors with…

ac35495

… cleanup and validation

comment-ops-bot bot added the rfe For changelog: Minor enhancement. use `major-rfe` for changes to be highlighted label Feb 2, 2026

mawinter69 suggested changes Feb 2, 2026

View reviewed changes

LakshyaBagani added 5 commits February 3, 2026 22:07

Refactor Snooze to use Dialog, external JS/CSS, and fix CSP/CSRF issues

7709367

Fix formatting and comments in AdministrativeMonitor

8b761a0

Refactor comments for clarity in AdministrativeMonitor

96f6ed8

Update AdministrativeMonitor.java

689cf94

Fix deprecated method documentation in AdministrativeMonitor

da9f705

LakshyaBagani requested a review from mawinter69 February 3, 2026 17:11

mawinter69 reviewed Feb 3, 2026

View reviewed changes

mawinter69 suggested changes Feb 3, 2026

View reviewed changes


		UserPreferencesProperty.DisplayName=Preferences

		snooze=Snooze

Uh oh!

Implement snooze functionality for administrative monitors with… #26244

Are you sure you want to change the base?

Implement snooze functionality for administrative monitors with… #26244

Uh oh!

Conversation

LakshyaBagani commented Feb 2, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Fixes #16641

Testing done

Automated Testing:

Manual Verification:

Screenshots (UI changes only)

Before

After

Proposed changelog entries

Proposed changelog category

Proposed upgrade guidelines

Submitter checklist

Desired reviewers

Uh oh!

mawinter69 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mawinter69 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mawinter69 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

LakshyaBagani commented Feb 2, 2026 •

edited

Loading