Feat: Add doCheckDisplayNameOrNull to jenkins core #9150

krisstern · 2024-04-09T15:33:00Z

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

JENKINS-69916, Add doCheckDisplayNameOrNull to jenkins core

Proposed upgrade guidelines

N/A

Submitter checklist

Give feedback

The Jira issue, if it exists, is well-described.

The Jira issue, if it exists, is well-described.
Options
Successfully updated the issue's project

There was an error updating the issue's project
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](https://github.com/jenkins-infra/jenkins.io/blob/master/content/_data/changelogs/weekly.yml)). Fill in the **Proposed upgrade guidelines** section only if there are breaking changes or changes that may require extra steps from users during upgrade.

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.
Options
Successfully updated the issue's project

There was an error updating the issue's project
There is automated testing or an explanation as to why this change has no tests.

There is automated testing or an explanation as to why this change has no tests.
Options
Successfully updated the issue's project

There was an error updating the issue's project
New public classes, fields, and methods are annotated with `@Restricted` or have `@since TODO` Javadocs, as appropriate.

New public classes, fields, and methods are annotated with @Restricted or have @since TODO Javadocs, as appropriate.
Options
Successfully updated the issue's project

There was an error updating the issue's project
New deprecations are annotated with `@Deprecated(since = "TODO")` or `@Deprecated(forRemoval = true, since = "TODO")`, if applicable.

New deprecations are annotated with @Deprecated(since = "TODO") or @Deprecated(forRemoval = true, since = "TODO"), if applicable.
Options
Successfully updated the issue's project

There was an error updating the issue's project
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](https://www.jenkins.io/doc/developer/security/csp/)).

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).
Options
Successfully updated the issue's project

There was an error updating the issue's project
For dependency updates, there are links to external changelogs and, if possible, full differentials.

For dependency updates, there are links to external changelogs and, if possible, full differentials.
Options
Successfully updated the issue's project

There was an error updating the issue's project
For new APIs and extension points, there is a link to at least one consumer.

For new APIs and extension points, there is a link to at least one consumer.
Options
Successfully updated the issue's project

There was an error updating the issue's project
Options

Desired reviewers

N/A

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.

There are at least two (2) approvals for the pull request and no outstanding requests for change.
Options
Successfully updated the issue's project

There was an error updating the issue's project
Conversations in the pull request are over, or it is explicit that a reviewer is not blocking the change.

Conversations in the pull request are over, or it is explicit that a reviewer is not blocking the change.
Options
Successfully updated the issue's project

There was an error updating the issue's project
Changelog entries in the pull request title and/or **Proposed changelog entries** are accurate, human-readable, and in the imperative mood.

Changelog entries in the pull request title and/or Proposed changelog entries are accurate, human-readable, and in the imperative mood.
Options
Successfully updated the issue's project

There was an error updating the issue's project
Proper changelog labels are set so that the changelog can be generated automatically.

Proper changelog labels are set so that the changelog can be generated automatically.
Options
Successfully updated the issue's project

There was an error updating the issue's project
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](https://github.com/jenkinsci/jenkins/pull/4387)).

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).
Options
Successfully updated the issue's project

There was an error updating the issue's project
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](https://issues.jenkins.io/issues/?filter=12146)).

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
Successfully updated the issue's project

There was an error updating the issue's project
Options

daniel-beck · 2024-04-09T16:56:38Z

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 · 2024-04-09T17:07:02Z

core/src/main/java/jenkins/plugins/DetachedPluginsUtil.java

 import org.apache.commons.io.IOUtils;
 import org.kohsuke.accmod.Restricted;
 import org.kohsuke.accmod.restrictions.NoExternalUse;
+import org.kohsuke.stapler.AncestorInPath;
+import org.kohsuke.stapler.QueryParameter;

 /**
 * Dedicated class to handle the logic related to so-called <em>detached plugins</em>.


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

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

jglick · 2024-04-09T17:09:16Z

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 · 2024-04-09T17:11:07Z

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 · 2024-04-09T17:13:01Z

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 · 2024-04-09T17:14:47Z

TopLevelItemDescriptor

No problem, let me move it again.

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

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

mawinter69 · 2024-04-09T17:28:57Z

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 · 2024-04-09T17:37:33Z

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

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

daniel-beck · 2024-04-09T18:08:29Z

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 · 2024-04-09T18:39:30Z

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 · 2024-04-10T11:36:27Z

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

Done

daniel-beck · 2024-04-21T07:58:12Z

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 · 2024-05-04T10:22:10Z

Updated the "proposed changelog entries" in the description above

krisstern mentioned this pull request Apr 9, 2024

[JENKINS-69916] Un-inline WorkflowJob/configure-entries.jelly jenkinsci/workflow-job-plugin#411

Open

jglick reviewed Apr 9, 2024

View reviewed changes

krisstern changed the title ~~Feat/add do check display name or null to jenkins core~~ Feat: Add doCheckDisplayNameOrNull to jenkins core Apr 9, 2024

daniel-beck added the squash-merge-me Unclean or useless commit history, should be merged only with squash-merge label Apr 9, 2024

daniel-beck reviewed Apr 9, 2024

View reviewed changes

core/src/main/java/hudson/model/Job.java Outdated Show resolved Hide resolved

daniel-beck reviewed Apr 9, 2024

View reviewed changes

core/src/main/java/hudson/model/TopLevelItemDescriptor.java Outdated Show resolved Hide resolved

daniel-beck reviewed Apr 9, 2024

View reviewed changes

core/src/main/java/hudson/model/TopLevelItemDescriptor.java Outdated Show resolved Hide resolved

mawinter69 reviewed Apr 9, 2024

View reviewed changes

core/src/main/java/hudson/model/TopLevelItemDescriptor.java Outdated Show resolved Hide resolved

krisstern force-pushed the feat/add-doCheckDisplayNameOrNull-to-jenkins-core branch from 8a63360 to 3aa9d08 Compare April 9, 2024 17:26

MarkEWaite added the rfe For changelog: Minor enhancement. use `major-rfe` for changes to be highlighted label Apr 9, 2024

daniel-beck reviewed Apr 9, 2024

View reviewed changes

core/src/main/java/hudson/model/Job.java Outdated Show resolved Hide resolved

mawinter69 suggested changes Apr 9, 2024

View reviewed changes

mawinter69 mentioned this pull request Apr 9, 2024

[JENKINS-72988] validate displayname against items in the same ItemGroup #9152

Draft

krisstern added 8 commits April 10, 2024 19:35

[JENKINS-69916]: adding doCheckDisplayNameOrNull to Jenkins core

3086fe4

fix: spotless patch

18c0224

fix: move code to its proper place in Job.java

64fa70d

fix: move doCheckDisplayNameOrNull code to TopLevelItemDescriptor.java

8bd0ddd

apply suggestions from code review

9988fe6

revert star imports

0d4fb2c

add missing imports

2575565

fix: revert an out-of-scope change

c4db068

fix: remove an obsoleted previous implementation

e5c9e75

krisstern force-pushed the feat/add-doCheckDisplayNameOrNull-to-jenkins-core branch from 4be5bd0 to e5c9e75 Compare April 10, 2024 11:35

krisstern requested review from daniel-beck, mawinter69 and jglick April 10, 2024 11:42

mawinter69 approved these changes Apr 12, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Feat: Add doCheckDisplayNameOrNull to jenkins core #9150

Feat: Add doCheckDisplayNameOrNull to jenkins core #9150

krisstern commented Apr 9, 2024 •

edited

Submitter checklist

Maintainer checklist

daniel-beck commented Apr 9, 2024 •

edited

jglick Apr 9, 2024

krisstern Apr 9, 2024

jglick commented Apr 9, 2024

mawinter69 commented Apr 9, 2024

krisstern commented Apr 9, 2024

krisstern commented Apr 9, 2024

mawinter69 commented Apr 9, 2024

mawinter69 commented Apr 9, 2024

daniel-beck commented Apr 9, 2024

mawinter69 left a comment

mawinter69 commented Apr 9, 2024 •

edited

krisstern commented Apr 10, 2024

daniel-beck commented Apr 21, 2024

krisstern commented May 4, 2024

Feat: Add doCheckDisplayNameOrNull to jenkins core #9150

Are you sure you want to change the base?

Feat: Add doCheckDisplayNameOrNull to jenkins core #9150

Conversation

krisstern commented Apr 9, 2024 • edited

Testing done

Proposed changelog entries

Proposed upgrade guidelines

Submitter checklist

Desired reviewers

Maintainer checklist

daniel-beck commented Apr 9, 2024 • edited

jglick Apr 9, 2024

Choose a reason for hiding this comment

krisstern Apr 9, 2024

Choose a reason for hiding this comment

jglick commented Apr 9, 2024

mawinter69 commented Apr 9, 2024

krisstern commented Apr 9, 2024

krisstern commented Apr 9, 2024

mawinter69 commented Apr 9, 2024

mawinter69 commented Apr 9, 2024

daniel-beck commented Apr 9, 2024

mawinter69 left a comment

Choose a reason for hiding this comment

mawinter69 commented Apr 9, 2024 • edited

krisstern commented Apr 10, 2024

daniel-beck commented Apr 21, 2024

krisstern commented May 4, 2024

krisstern commented Apr 9, 2024 •

edited

daniel-beck commented Apr 9, 2024 •

edited

mawinter69 commented Apr 9, 2024 •

edited