Introduce `Named`, `FullyNamed`, `FullyNamedModelObject` interfaces by Vlatombe · Pull Request #10827 · jenkinsci/jenkins

Vlatombe · 2025-07-10T07:39:25Z

These correspond to methods getName, getFullName, getFullDisplayName that did not have any common interface to call them, causing some inconvenient usages of switch statements or even reflection in CloudBees CI HA.

See JENKINS-XXXXX.

Testing done

Proposed changelog entries

Developer: objects with getName, getFullName, getFullDisplayName can now be referred through dedicated interfaces.

Proposed changelog category

/label

Proposed upgrade guidelines

N/A

Submitter checklist

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.

Desired reviewers

@mention

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

Maintainer checklist

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).

…erfaces These correspond to methods `getName`, `getFullName`, `getFullDisplayName` that did not have any common interface to call them, causing some inconvenient usages of switch statements or even reflection in CloudBees CI HA.

core/src/main/java/jenkins/model/Nameable.java

core/src/main/java/jenkins/model/FullyNamedModelObject.java

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

jglick · 2025-07-18T00:12:04Z

core/src/main/java/jenkins/model/queue/QueueItem.java

+        // TODO review usage of this method and replace with getFullDisplayName() where appropriate
+        return getTask().getFullDisplayName();


Not sure I understand the comment. Did you mean

Suggested change

// TODO review usage of this method and replace with getFullDisplayName() where appropriate

return getTask().getFullDisplayName();

return getTask().getDisplayName();

? And should ResourceActivity implement ModelObject?

The name of the method implies this would be the natural implementation, but since it actually uses the full display name, these could cause some UI inconsistencies if changed without reviewing all current usages.

And should ResourceActivity implement ModelObject?

I had missed this interface, I guess it should, for consistency with ITask

So do I understand the comment to mean that you propose switching QueueItem.displayName to use Task.displayName but looking up existing callers (probably in Jelly) and switching them from ${i.displayName} to ${i.fullDisplayName} where appropriate? If so, that was not clear to me from the comment text.

Co-authored-by: Jesse Glick <jglick@cloudbees.com>

jglick · 2025-07-18T16:35:28Z

core/src/main/java/jenkins/model/queue/QueueItem.java

+        // TODO review usage of this method and replace with getFullDisplayName() where appropriate
+        return getTask().getFullDisplayName();


So do I understand the comment to mean that you propose switching QueueItem.displayName to use Task.displayName but looking up existing callers (probably in Jelly) and switching them from ${i.displayName} to ${i.fullDisplayName} where appropriate? If so, that was not clear to me from the comment text.

A1exKH

LGTM.

NotMyFault

/label ready-for-merge

This PR is now ready for merge. We will merge it after ~24 hours if there is no negative feedback.
Please see the merge process documentation for more information about the merge process.
Thanks!

Fix two tests that are blocking the Jenkins plugin BOM upgrade from Jenkins 2.522 to 2.523. Blocked pull request is: * jenkinsci/bom#5519 New interface was added in Jenkins core pull request: * jenkinsci/jenkins#10827 Add a script approval for jenkins.model.FullyNamed.getFullName() since the tests already have a script approval for hudson.model.Item.getFullName(). Keeps the tests consistent and allows the tests to pass with both older and newer Jenkins versions. Testing done: Confirmed that tests pass with Jenkins 2.523 and with default Jenkins version.

Vlatombe added the developer Changes which impact plugin developers label Jul 10, 2025

Vlatombe mentioned this pull request Jul 10, 2025

[JENKINS-26091] Addressable and AddressableModelObject interfaces #10828

Draft

14 tasks

Vlatombe requested a review from jglick July 10, 2025 08:47

Vlatombe mentioned this pull request Jul 10, 2025

FolderComputation implements FullyNamedModelObject jenkinsci/cloudbees-folder-plugin#515

Merged

4 tasks

jglick reviewed Jul 10, 2025

View reviewed changes

core/src/main/java/jenkins/model/Nameable.java Outdated Show resolved Hide resolved

krisstern requested a review from a team July 10, 2025 18:54

Vlatombe added 2 commits July 15, 2025 13:52

Merge branch 'master' into fully-nameable-model-object

63e6780

Nameable -> Named

bedb579

Vlatombe changed the title ~~Introduce Nameable, FullyNameable, FullyNameableModelObject interfaces~~ Introduce Named, FullyNamed, FullyNamedModelObject interfaces Jul 16, 2025

Vlatombe requested a review from jglick July 16, 2025 12:43

jglick reviewed Jul 18, 2025

View reviewed changes

core/src/main/java/jenkins/model/FullyNamedModelObject.java Outdated Show resolved Hide resolved

jglick reviewed Jul 18, 2025

View reviewed changes

core/src/main/java/hudson/model/Queue.java Show resolved Hide resolved

jglick reviewed Jul 18, 2025

View reviewed changes

jglick approved these changes Jul 18, 2025

View reviewed changes

Vlatombe and others added 3 commits July 18, 2025 09:07

Improve javadoc

99c1aa2

Co-authored-by: Jesse Glick <jglick@cloudbees.com>

Make ResourceActivity extend ModelObject

a68bb22

Use full name for affinity key if available.

cfcb729

jglick approved these changes Jul 18, 2025

View reviewed changes

A1exKH approved these changes Jul 20, 2025

View reviewed changes

Vlatombe and others added 2 commits July 23, 2025 11:36

Merge branch 'master' into fully-nameable-model-object

6825fc8

Merge branch 'master' into fully-nameable-model-object

40080d9

NotMyFault approved these changes Aug 7, 2025

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 Aug 7, 2025

MarkEWaite merged commit 0673bc6 into jenkinsci:master Aug 8, 2025
18 checks passed

basil mentioned this pull request Aug 13, 2025

Update dependency org.jenkins-ci.main:jenkins-war to v2.523 jenkinsci/bom#5519

Merged

1 task

MarkEWaite mentioned this pull request Aug 13, 2025

Adapt tests to jenkins.model.FullyNamed interface in 2.523 jenkinsci/extensible-choice-parameter-plugin#120

Merged

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Introduce `Named`, `FullyNamed`, `FullyNamedModelObject` interfaces#10827

Introduce `Named`, `FullyNamed`, `FullyNamedModelObject` interfaces#10827
MarkEWaite merged 8 commits intojenkinsci:masterfrom
Vlatombe:fully-nameable-model-object

Vlatombe commented Jul 10, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

jglick Jul 18, 2025

Uh oh!

Vlatombe Jul 18, 2025 •

edited

Loading

Uh oh!

Vlatombe Jul 18, 2025 •

edited

Loading

Uh oh!

jglick Jul 18, 2025

Uh oh!

jglick Jul 18, 2025

Uh oh!

A1exKH left a comment

Uh oh!

NotMyFault left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

		// TODO review usage of this method and replace with getFullDisplayName() where appropriate
		return getTask().getFullDisplayName();

	// TODO review usage of this method and replace with getFullDisplayName() where appropriate
	return getTask().getFullDisplayName();
	return getTask().getDisplayName();

Uh oh!

Conversation

Vlatombe commented Jul 10, 2025

Testing done

Proposed changelog entries

Proposed changelog category

Proposed upgrade guidelines

Submitter checklist

Desired reviewers

Maintainer checklist

Uh oh!

Uh oh!

Uh oh!

Uh oh!

jglick Jul 18, 2025

Choose a reason for hiding this comment

Uh oh!

Vlatombe Jul 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Vlatombe Jul 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jglick Jul 18, 2025

Choose a reason for hiding this comment

Uh oh!

jglick Jul 18, 2025

Choose a reason for hiding this comment

Uh oh!

A1exKH left a comment

Choose a reason for hiding this comment

Uh oh!

NotMyFault left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Vlatombe Jul 18, 2025 •

edited

Loading

Vlatombe Jul 18, 2025 •

edited

Loading