Add `WithConsoleUrl` interface #9645

Vlatombe · 2024-08-22T13:33:21Z

This simplifies the logic of Functions#getConsoleUrl and makes it pluggable.

This also clarifies ConsoleUrlProvider#getConsoleUrl and make it a requirement for implementations to return relative url w/o leading slash.

Testing done

Checked known implementations (OSS + CloudBees)

pipeline-graph-view
cloudbees-pipeline-explorer

Proposed changelog entries

N/A

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

This simplifies the logic of `Functions#getConsoleUrl` and makes it pluggable.

core/src/main/java/jenkins/console/ConsoleUrlProvider.java

dwnusbaum · 2024-08-22T14:29:12Z

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

@@ -2131,6 +2132,16 @@ default long getEstimatedDuration() {
            return Executables.getParentOf(this).getEstimatedDuration();
        }

+        /**
+         * Handles cases such as {@code PlaceholderExecutable} for Pipeline node steps.


Did you test this case to make sure it works?

This is actually moved code from Functions#getConsoleUrl but I doublechecked to make sure.

Ok, thanks, it just wasn't obvious to me that the recursion was quite the same.

core/src/main/java/hudson/Functions.java

Co-authored-by: Devin Nusbaum <[email protected]>

StefanSpieker · 2024-08-23T19:13:36Z

core/src/main/java/hudson/Functions.java

-     * @param executable the executable (normally a {@link Run})
-     * @return the absolute URL for accessing the build console for the executable, or null if there is no build associated with the executable
+     * Computes the link to the console for the run for the specified object, taking {@link ConsoleUrlProvider} into account.
+     * @param withConsoleUrl the object to compute a console url for (can be {@link Run}, a {@code PlaceholderExecutable}...)


After the last rework it isn't an object any longer, maybe also adjust the javadoc here

Well, a “model object”. Seems OK to me.

jglick · 2024-08-23T20:45:59Z

core/src/main/java/hudson/Functions.java

-     * @param executable the executable (normally a {@link Run})
-     * @return the absolute URL for accessing the build console for the executable, or null if there is no build associated with the executable
+     * Computes the link to the console for the run for the specified object, taking {@link ConsoleUrlProvider} into account.
+     * @param withConsoleUrl the object to compute a console url for (can be {@link Run}, a {@code PlaceholderExecutable}...)


Well, a “model object”. Seems OK to me.

github-actions · 2024-09-03T22:01:35Z

Please take a moment and address the merge conflicts of your pull request. Thanks!

Vlatombe · 2024-09-05T10:53:20Z

/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!

@dwnusbaum

commit c5128f4 Author: Jan Faracik <[email protected]> Date: Thu Sep 12 14:39:02 2024 +0100 Use notice for views lacking jobs commit bb7a30a Author: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> Date: Thu Sep 12 09:02:10 2024 +0100 Update dependency org.jenkins-ci.plugins:script-security to v1361 (jenkinsci#9719) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> commit 5fc92c6 Author: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> Date: Thu Sep 12 09:01:59 2024 +0100 Update jenkins/ath Docker tag to v5992 (jenkinsci#9720) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> commit 36c155e Author: Alexander Brandes <[email protected]> Date: Thu Sep 12 10:01:35 2024 +0200 Automate the since updater (jenkinsci#7240) Co-authored-by: Tim Jacomb <[email protected]> commit 65f374c Author: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> Date: Wed Sep 11 05:13:32 2024 -0600 Update dependency org.jenkins-ci.plugins:junit to v1300 (jenkinsci#9716) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> commit 35d7677 Author: Vincent Latombe <[email protected]> Date: Wed Sep 11 04:32:36 2024 +0200 Introduce `HistoricalBuild` interface (jenkinsci#9674) * Introduce HistoricalBuild interface This allows to display Run-like objects in build history without having concrete Run present in the Jenkins instance. * Remove BuildHistoryWidget#entries.jelly * JDK17 level Co-authored-by: Jesse Glick <[email protected]> --------- Co-authored-by: Jesse Glick <[email protected]> commit 78e132d Author: Basil Crow <[email protected]> Date: Tue Sep 10 19:32:04 2024 -0700 Build tests without forking the compiler (jenkinsci#9717) commit 66a7810 Author: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> Date: Tue Sep 10 20:31:40 2024 -0600 Update dependency org.jenkins-ci.plugins:cloudbees-folder to v6.951.v5f91d88d76b_b_ (jenkinsci#9715) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> commit 53f3203 Author: Daniel Beck <[email protected]> Date: Tue Sep 10 22:52:20 2024 +0200 [JENKINS-73709] Build without forking the compiler (jenkinsci#9709) Co-authored-by: Daniel Beck <[email protected]> commit 905df3d Author: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> Date: Tue Sep 10 09:40:46 2024 -0700 Update dependency org.jenkins-ci.plugins:junit to v1299 (jenkinsci#9714) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> commit 11c405b Author: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> Date: Tue Sep 10 09:40:08 2024 -0700 Update dependency org.apache.maven.plugins:maven-jarsigner-plugin to v3.1.0 (jenkinsci#9712) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> commit eb6be17 Author: Jenkins Release Bot <[email protected]> Date: Tue Sep 10 14:10:20 2024 +0000 [maven-release-plugin] prepare for next development iteration commit 561231f Author: Jenkins Release Bot <[email protected]> Date: Tue Sep 10 14:09:56 2024 +0000 [maven-release-plugin] prepare release jenkins-2.476 commit 0c49380 Author: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> Date: Mon Sep 9 16:47:09 2024 -0700 Update eslint monorepo to v9.10.0 (jenkinsci#9710) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> commit 1b8c198 Author: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> Date: Mon Sep 9 11:19:46 2024 -0700 Update dependency io.jenkins.plugins:font-awesome-api to v6.6.0-2 (jenkinsci#9708) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> commit 85d6358 Author: Basil Crow <[email protected]> Date: Mon Sep 9 08:14:48 2024 -0700 Compatibility for `ChainedServletFilter` (jenkinsci#9696) commit 4334aa0 Author: Juan Jesús Alejo Sillero <[email protected]> Date: Mon Sep 9 17:13:51 2024 +0200 fix(i18n): correct typo in Spanish translation for 'Preparation' (jenkinsci#9702) commit 2431b7c Author: Markus Winter <[email protected]> Date: Mon Sep 9 17:13:20 2024 +0200 [JENKINS-72988] validate displayname against items in the same ItemGroup (jenkinsci#9152) Co-authored-by: Kris Stern <[email protected]> commit bfcb874 Merge: b56e5d7 2f6d77c Author: Vincent Latombe <[email protected]> Date: Mon Sep 9 16:57:03 2024 +0200 Merge pull request jenkinsci#9645 from Vlatombe/with-console-url commit b56e5d7 Merge: c05d756 6b88bfc Author: Vincent Latombe <[email protected]> Date: Mon Sep 9 11:21:50 2024 +0200 Merge pull request jenkinsci#9673 from Vlatombe/computerListener.onIdle commit 2f6d77c Merge: 49618a0 307f680 Author: Vincent Latombe <[email protected]> Date: Wed Sep 4 10:48:53 2024 +0200 Merge branch 'master' into with-console-url commit 6b88bfc Author: Vincent Latombe <[email protected]> Date: Wed Aug 28 16:22:14 2024 +0200 Spotless commit ed93ad0 Author: Vincent Latombe <[email protected]> Date: Wed Aug 28 16:12:09 2024 +0200 Revert "Call listener synchronously, but outside synchronized" This reverts commit 75242cf. commit 75242cf Author: Vincent Latombe <[email protected]> Date: Wed Aug 28 15:47:51 2024 +0200 Call listener synchronously, but outside synchronized commit 9823b8e Author: Vincent Latombe <[email protected]> Date: Wed Aug 28 15:40:43 2024 +0200 Execute ComputerListener#onIdle in another thread. commit 64667af Author: Vincent Latombe <[email protected]> Date: Wed Aug 28 09:54:25 2024 +0200 Implement ComputerListener#onIdle Introduces a new computer listener fired whenever a Computer becomes idle. commit 49618a0 Author: Vincent Latombe <[email protected]> Date: Fri Aug 23 08:14:22 2024 +0200 Updating the test to note the behavioural change commit 2d30cfc Author: Vincent Latombe <[email protected]> Date: Thu Aug 22 17:20:38 2024 +0200 Fix review commit 44602bb Author: Vincent Latombe <[email protected]> Date: Thu Aug 22 17:12:59 2024 +0200 Typo spotted by @dwnusbaum Co-authored-by: Devin Nusbaum <[email protected]> commit 39d30c8 Author: Vincent Latombe <[email protected]> Date: Tue Aug 13 15:04:12 2024 +0200 Add WithConsoleUrl interface This simplifies the logic of `Functions#getConsoleUrl` and makes it pluggable.

Add WithConsoleUrl interface

39d30c8

This simplifies the logic of `Functions#getConsoleUrl` and makes it pluggable.

Vlatombe added the developer Changes which impact plugin developers label Aug 22, 2024

Vlatombe requested review from jglick and a team August 22, 2024 13:33

Vlatombe changed the title ~~Add WithConsoleUrl interface~~ Add WithConsoleUrl interface Aug 22, 2024

Vlatombe requested a review from dwnusbaum August 22, 2024 14:03

dwnusbaum approved these changes Aug 22, 2024

View reviewed changes

Vlatombe and others added 2 commits August 22, 2024 17:12

Typo spotted by @dwnusbaum

44602bb

Co-authored-by: Devin Nusbaum <[email protected]>

Fix review

2d30cfc

dwnusbaum approved these changes Aug 22, 2024

View reviewed changes

Updating the test to note the behavioural change

49618a0

StefanSpieker reviewed Aug 23, 2024

View reviewed changes

jglick approved these changes Aug 23, 2024

View reviewed changes

NotMyFault requested a review from StefanSpieker August 24, 2024 09:57

MarkEWaite added the skip-changelog Should not be shown in the changelog label Aug 27, 2024

github-actions bot added the unresolved-merge-conflict There is a merge conflict with the target branch. label Sep 3, 2024

Merge branch 'master' into with-console-url

2f6d77c

github-actions bot removed the unresolved-merge-conflict There is a merge conflict with the target branch. label Sep 4, 2024

NotMyFault approved these changes Sep 4, 2024

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 5, 2024

Vlatombe merged commit bfcb874 into jenkinsci:master Sep 9, 2024
16 checks passed

Vlatombe deleted the with-console-url branch September 9, 2024 14:57

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add `WithConsoleUrl` interface #9645

Add `WithConsoleUrl` interface #9645

Vlatombe commented Aug 22, 2024 •

edited by MarkEWaite

Loading

Submitter checklist

Maintainer checklist

dwnusbaum Aug 22, 2024

Vlatombe Aug 22, 2024

dwnusbaum Aug 22, 2024

StefanSpieker Aug 23, 2024

jglick Aug 23, 2024

jglick Aug 23, 2024

github-actions bot commented Sep 3, 2024

Vlatombe commented Sep 5, 2024

Add WithConsoleUrl interface #9645

Add WithConsoleUrl interface #9645

Conversation

Vlatombe commented Aug 22, 2024 • edited by MarkEWaite Loading

Testing done

Proposed changelog entries

Proposed upgrade guidelines

Submitter checklist

Desired reviewers

Maintainer checklist

dwnusbaum Aug 22, 2024

Choose a reason for hiding this comment

Vlatombe Aug 22, 2024

Choose a reason for hiding this comment

dwnusbaum Aug 22, 2024

Choose a reason for hiding this comment

StefanSpieker Aug 23, 2024

Choose a reason for hiding this comment

jglick Aug 23, 2024

Choose a reason for hiding this comment

jglick Aug 23, 2024

Choose a reason for hiding this comment

github-actions bot commented Sep 3, 2024

Vlatombe commented Sep 5, 2024

Add `WithConsoleUrl` interface #9645

Add `WithConsoleUrl` interface #9645

Vlatombe commented Aug 22, 2024 •

edited by MarkEWaite

Loading