Add doCheckDisplayNameOrNull to jenkins core

[krisstern]

See JENKINS-69916.

Testing done

Double checked no existing test has been caused to fail by runnig mvn verfiy. No test has been added since this will be done downstream.

Proposed changelog entries

• Move doCheckDisplayNameOrNull from AbstractProject to TopLevelItemDescriptor to allow reuse in pipeline.

Proposed upgrade guidelines

N/A

Submitter checklist

Beta Give feedback

1. The Jira issue, if it exists, is well-described.
2. 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.
3. There is automated testing or an explanation as to why this change has no tests.
4. New public classes, fields, and methods are annotated with @Restricted or have @since TODO Javadocs, as appropriate.
5. New deprecations are annotated with @Deprecated(since = "TODO") or @Deprecated(forRemoval = true, since = "TODO"), if applicable.
6. 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).
7. For dependency updates, there are links to external changelogs and, if possible, full differentials.
8. For new APIs and extension points, there is a link to at least one consumer.

Desired reviewers

N/A

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

Maintainer checklist

Beta Give feedback

1. There are at least two (2) approvals for the pull request and no outstanding requests for change.
2. Conversations in the pull request are over, or it is explicit that a reviewer is not blocking the change.
3. Changelog entries in the pull request title and/or Proposed changelog entries are accurate, human-readable, and in the imperative mood.
4. Proper changelog labels are set so that the changelog can be generated automatically.
5. 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).
6. 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).

[daniel-beck]

This needs an explanation, because the code location is unexpected.

Why did you choose to do this rather than pull up

jenkins/core/src/main/java/hudson/model/AbstractProject.java

Lines 1943 to 1946 in b0baeba

	@Restricted(DoNotUse.class)
	public FormValidation doCheckDisplayNameOrNull(@AncestorInPath AbstractProject project, @QueryParameter String value) {
	return Jenkins.get().doCheckDisplayName(value, project.getName());
	}

into Job? Seems like that would automatically take care of the plugin.

[workflow-job] Un-inlining WorkflowJob/configure-entries.jelly

Would you expect an average Jenkins admin to be able to understand this change and how it impacts them?

[jglick]

What does this new method have to do with detached plugins?

[krisstern]

It doesn't, I wasn't sure where to place the code at first actually

[jglick]

Does not seem to align with

an AbstractItemDescriptor interface with a default implementation for that doCheckDisplayNameOrNull

by @mawinter69 in jenkinsci/workflow-job-plugin#411 (comment)

[mawinter69]

I would expect this to be in TopLevelItemDescriptor or a dedicated interface that plugins implement, Job is not sufficient as we also need to check for duplicates with Folders.

[krisstern]

This needs an explanation, because the code location is unexpected.

Why did you choose to do this rather than pull up

jenkins/core/src/main/java/hudson/model/AbstractProject.java

Lines 1943 to 1946 in b0baeba

	@Restricted(DoNotUse.class)
	public FormValidation doCheckDisplayNameOrNull(@AncestorInPath AbstractProject project, @QueryParameter String value) {
	return Jenkins.get().doCheckDisplayName(value, project.getName());
	}

into Job? Seems like that would automatically take care of the plugin.

[workflow-job] Un-inlining WorkflowJob/configure-entries.jelly

Would you expect an average Jenkins admin to be able to understand this change and how it impacts them?

Sure, I just moved the code to Job. Actually I wasn't sure where to place the code originally, so I was making a wild guess. For more context please see jenkinsci/workflow-job-plugin#411.

[krisstern]

TopLevelItemDescriptor

No problem, let me move it again.

[mawinter69]

I just noticed that the doCheckDisplayName method in Jenkins is broken (unrelated to this addition). When you check the displayname of something that is inside a folder it will actually check against items in root.

[mawinter69]

created https://issues.jenkins.io/browse/JENKINS-72988 for the wrong check

[daniel-beck]

Looks reasonable now. Please file a downstream PR once the incremental is deployed, demonstrating this works as expected, then check

For new APIs and extension points, there is a link to at least one consumer.

[mawinter69]

We should remove the implementation from AbstractProject as it is obsolete now

[mawinter69]

Looks reasonable now. Please file a downstream PR once the incremental is deployed, demonstrating this works as expected, then check

For new APIs and extension points, there is a link to at least one consumer.

we would need PRs in folder and matrix project plugins that remove the implementation there

[krisstern]

We should remove the implementation from AbstractProject as it is obsolete now

Done

[daniel-beck]

Still needs downstream PRs.

Also, the proposed changelog entry needs work:

[workflow-job] Un-inlining WorkflowJob/configure-entries.jelly

Changelog audience is generally Jenkins users and administrators who we need to assume know nothing about Jenkins development.

[krisstern]

Updated the "proposed changelog entries" in the description above

[krisstern]

Still needs downstream PRs.

Also, the proposed changelog entry needs work:

[workflow-job] Un-inlining WorkflowJob/configure-entries.jelly

Changelog audience is generally Jenkins users and administrators who we need to assume know nothing about Jenkins development.

Downstream changes made in jenkinsci/workflow-job-plugin#411.

[daniel-beck]

Works great with the PR build and the downstream PR build.

[timja]

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

[krisstern]

Is it okay for merge this?