Automate Java version recommendation administrative monitor #8526

basil · 2023-09-26T01:28:48Z

This PR documents the steps for adding support for a new Java version in JavaVersionRecommendationAdminMonitor and adds one additional step: defining the date the Jenkins project will drop support for that Java version. An administrative monitor is automatically shown two years before that date. If the user dismisses that monitor and declines to upgrade, another (red) "danger" administrative monitor will be shown one year before that date. The ID of the administrative monitor is keyed off the Java version, EOL date, and severity of the warning so that changes to the dates automatically invalidate previous dismissals. Users are directed to https://jenkins.io/redirect/java-support/ for help, which is consistent with the URL used in executable.Main. It is the responsibility of the Documentation Officer to keep this URL fresh with reasonable content.

An alternative design would have been to define a recommended Java version in addition to the set of supported Java versions. The disadvantage of this approach is that more manual steps are required. The advantage is that the result is guaranteed to be accurate, as opposed to the approach in this PR (which could potentially be communicating incorrect information to users if the Jenkins project ever falls dramatically behind in its Java Platform support). We believe that the advantages of automation outweigh the disadvantages. In the unlikely event that the Jenkins project ever falls far behind again in Java Platform support, the approach in this PR could be scaled back in favor of a more manual communication schedule.

Since this change will be delivered after September 30, 2024, it will immediately result in a "danger" (red) warning for all users who are running on Java 11 and have not upgraded to Java 17.

Testing done

Ran on Java 17 and 19; verified that no warning was printed.
Ran on Java 11 and verified the warning was printed and went away after dismissed, being persisted in the correct ID format.
Artificially changed the EOL date to be less than a year away and verified the severity increased to "danger" and the color changed to red.

Proposed changelog entries

Automate the display of an administrative monitor when approaching Java end of life (EOL) dates.

Proposed upgrade guidelines

N/A

Submitter checklist

Give feedback

The Jira 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 (see examples). Fill in the Proposed upgrade guidelines section only if there are breaking changes or changes that may require extra steps from users during upgrade.
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.
New or substantially changed JavaScript is not defined inline and does not call eval to ease future introduction of Content Security Policy (CSP) directives (see documentation).
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.
Options

Desired reviewers

@mention

Before the changes are marked as ready-for-merge:

Maintainer checklist

Give feedback

There are at least two (2) approvals for the pull request and no outstanding requests for change.
Conversations in the pull request are over, or it is explicit that a reviewer is not blocking the change.
Changelog entries in the pull request title and/or Proposed changelog entries are accurate, human-readable, and in the imperative mood.
Proper changelog labels are set so that the changelog can be generated automatically.
If the change needs additional upgrade steps from users, the upgrade-guide-needed label is set and there is a Proposed upgrade guidelines section in the pull request title (see example).
If it would make sense to backport the change to LTS, a Jira issue must exist, be a Bug or Improvement, and be labeled as lts-candidate to be considered (see query).
Options

basil · 2023-09-26T01:32:44Z

core/src/main/java/jenkins/monitor/JavaVersionRecommendationAdminMonitor.java

+     */
+    @Restricted(DoNotUse.class)
+    public Date getEndOfLifeAsDate() {
+        return Date.from(getEndOfLife().atStartOfDay(ZoneId.systemDefault()).toInstant());


Jelly localization requires a Date object rather than the (more appropriate) LocalDate. Here we downconvert to support Jelly localization.

daniel-beck · 2023-09-26T06:30:26Z

core/src/main/java/jenkins/monitor/JavaVersionRecommendationAdminMonitor.java

+        SUCCESS,
+        INFO,


Correct. Was there a point you were trying to make?

Seems like it should be deleted if unused. A random admin monitor doesn't need to be the reference for what CSS classes exist on the UI. If there's a reason this is here while unused, it's nonobvious and should be documented in code.

Well this is a model object, so just like a Hibernate model object where every field has a getter and setter, some are going to be unused. But the model object should be complete so that if someone wants to use the model in a different way then they can do so in the future. Model objects are an exception to the general wisdom around deleting unused code, and (trust me) I love deleting code — the majority of my efforts as a programmer are around code cleanup rather than greenfielding. In any case, I've never added comments to unused getters in e.g. a Hibernate model object and I do not see a compelling reason to do so here.

core/src/main/java/jenkins/monitor/JavaVersionRecommendationAdminMonitor.java

timja

nice

/label ready-for-merge

This PR is now ready for merge, after ~24 hours, we will merge it if there's no negative feedback.

Thanks!

* master: Automate Java version recommendation administrative monitor (jenkinsci#8526) Avoid saving disabled status when deleting a project (jenkinsci#8528) Bump org.jenkins-ci.main:jenkins-test-harness from 2064.vcd3b_b_8f3f2b_a_ to 2085.va_c531db_287b_d (jenkinsci#8535) [JENKINS-72067] High memory usage from `XStream2.AssociatedConverterImpl` (jenkinsci#8529)

MarkEWaite · 2023-10-02T04:08:27Z

@basil the recommend Java version message has an incorrect string in the /manage/configure page segment that appears when I click the button under the "Administrative monitors configuration" heading. It looks like this:

I'm not sure if I'm understanding the code correctly, but I thought it would insert the feature release number of the current JVM in that string. I think that we want the next LTS version in that string rather than the Java version that is currently running.

I think that it might be better if the danger period were 9 months and the warning period were 18 months so that we have 6 months between the initial support of a Java version and the visibility of the end of life warning for the upcoming end of life Java version. Alternately, I think danger period of 12 months and warning period of 21 months would be fine as well.

basil · 2023-10-02T04:38:25Z

@MarkEWaite The first issue can be fixed by rewording the message to not use an argument parameter. The second issue can be fixed by modifying the code to use the desired periods.

MarkEWaite · 2023-10-02T12:54:50Z

@MarkEWaite The first issue can be fixed by rewording the message to not use an argument parameter. The second issue can be fixed by modifying the code to use the desired periods.

Thanks! I've proposed those changes in

Warn users of old Java version 18 months before end of life #8543

Apologies for my delay reviewing the pull request. I had to sketch the calendar dates several times in order to see when the admin monitor warning will appear, when the admin monitor danger will appear and how that matches with the Java LTS release dates and the transition from Java 11 to Java 17 to Java 21.

Automate Java version recommendation administrative monitor

6dd3a0a

basil added the rfe For changelog: Minor enhancement. use `major-rfe` for changes to be highlighted label Sep 26, 2023

basil commented Sep 26, 2023

View reviewed changes

daniel-beck approved these changes Sep 26, 2023

View reviewed changes

NotMyFault approved these changes Sep 26, 2023

View reviewed changes

basil added 2 commits September 26, 2023 09:58

Merge branch 'master' into java-eol

2c4734c

Improve dates

c0301a7

NotMyFault requested a review from a team September 28, 2023 10:25

timja approved these changes Sep 28, 2023

View reviewed changes

comment-ops-bot bot added the ready-for-merge The PR is ready to go, and it will be merged soon if there is no negative feedback label Sep 28, 2023

MarkEWaite merged commit 02502e2 into jenkinsci:master Sep 29, 2023
16 checks passed

MarkEWaite mentioned this pull request Oct 2, 2023

Warn users of old Java version 18 months before end of life #8543

Merged

14 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Automate Java version recommendation administrative monitor #8526

Automate Java version recommendation administrative monitor #8526

basil commented Sep 26, 2023 •

edited by MarkEWaite

Loading

Submitter checklist

Maintainer checklist

basil Sep 26, 2023

daniel-beck Sep 26, 2023

basil Sep 26, 2023

daniel-beck Sep 26, 2023 •

edited

Loading

basil Sep 26, 2023

timja left a comment

MarkEWaite commented Oct 2, 2023 •

edited

Loading

basil commented Oct 2, 2023

MarkEWaite commented Oct 2, 2023

Automate Java version recommendation administrative monitor #8526

Automate Java version recommendation administrative monitor #8526

Conversation

basil commented Sep 26, 2023 • edited by MarkEWaite Loading

Testing done

Proposed changelog entries

Proposed upgrade guidelines

Submitter checklist

Desired reviewers

Maintainer checklist

basil Sep 26, 2023

Choose a reason for hiding this comment

daniel-beck Sep 26, 2023

Choose a reason for hiding this comment

basil Sep 26, 2023

Choose a reason for hiding this comment

daniel-beck Sep 26, 2023 • edited Loading

Choose a reason for hiding this comment

basil Sep 26, 2023

Choose a reason for hiding this comment

timja left a comment

Choose a reason for hiding this comment

nice

MarkEWaite commented Oct 2, 2023 • edited Loading

basil commented Oct 2, 2023

MarkEWaite commented Oct 2, 2023

basil commented Sep 26, 2023 •

edited by MarkEWaite

Loading

daniel-beck Sep 26, 2023 •

edited

Loading

MarkEWaite commented Oct 2, 2023 •

edited

Loading