Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[JENKINS-71200] Fix elements property overload in ListView #7942

Merged
merged 2 commits into from
May 22, 2023

Conversation

Dohbedoh
Copy link
Contributor

@Dohbedoh Dohbedoh commented May 5, 2023

See JENKINS-71200.

ListView produces <input ..> elements for each items within the ItemGroup that are named directly after the item name itself. If an item name is elements, this kind of overloads the form.elements attribute which causes a bad form submission.

The propose fix is to prefix the input names with item_ to avoid the overload.

Testing done

  • Started Jenkins
  • create an freestyle job named elements
  • create a view and Save

Proposed changelog entries

  • Prefix the name of input elements of ListView to prevent form submission issues when an Item (job) is named elements.

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

Maintainer checklist

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

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

@Dohbedoh
Copy link
Contributor Author

Dohbedoh commented May 5, 2023

First commit is a test that reproduces the problem and show the failure.
Second commit is the fix.

@Dohbedoh Dohbedoh changed the title [JENKINS-71200] Add test for ListView attributes overloads [JENKINS-71200] Fix elements property overload in ListView May 5, 2023
@NotMyFault NotMyFault added the regression-fix Pull request that fixes a regression in one of the previous Jenkins releases label May 5, 2023
@NotMyFault NotMyFault requested a review from a team May 5, 2023 07:49
@timja timja added regression-fix Pull request that fixes a regression in one of the previous Jenkins releases bug For changelog: Minor bug. Will be listed after features and removed regression-fix Pull request that fixes a regression in one of the previous Jenkins releases bug For changelog: Minor bug. Will be listed after features labels May 7, 2023
@timja
Copy link
Member

timja commented May 7, 2023

@NotMyFault / @Dohbedoh was this introduced in 2.403?

@Dohbedoh
Copy link
Contributor Author

Dohbedoh commented May 7, 2023

@timja I don't think so. I find this out on an instance running 2.361.3. And I could reproduce this although in the latest weekly 2.403. This has probably been around for a while.

@NotMyFault
Copy link
Member

@NotMyFault / Dohbedoh was this introduced in 2.403?

Unlikely, I just labeled it as regression because I recall it working at some point.

@timja
Copy link
Member

timja commented May 8, 2023

I doubt this ever worked

@timja timja added bug For changelog: Minor bug. Will be listed after features and removed regression-fix Pull request that fixes a regression in one of the previous Jenkins releases labels May 8, 2023
@NotMyFault NotMyFault requested review from a team May 10, 2023 17:16
Copy link
Member

@timja timja left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

@comment-ops-bot 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 May 21, 2023
@NotMyFault NotMyFault merged commit a45f060 into jenkinsci:master May 22, 2023
@daniel-beck
Copy link
Member

I doubt this ever worked

FTR this hasn't worked in many years, if ever (at least for some attribute names), see #6959 / JENKINS-10693.

basil added a commit to basil/categorized-view-plugin that referenced this pull request Jul 14, 2023
@@ -452,7 +452,7 @@ protected void submit(StaplerRequest req) throws ServletException, FormException
}
for (TopLevelItem item : items) {
String relativeNameFrom = item.getRelativeNameFrom(getOwner().getItemGroup());
if (req.getParameter(relativeNameFrom) != null) {
if (req.getParameter("item_" + relativeNameFrom) != null) {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

basil added a commit to jenkinsci/categorized-view-plugin that referenced this pull request Jul 14, 2023
basil added a commit to basil/jenkins-build-monitor-plugin that referenced this pull request Jul 14, 2023
@basil
Copy link
Member

basil commented Jul 14, 2023

Caused JENKINS-71403.

basil added a commit to jenkinsci/build-monitor-plugin that referenced this pull request Jul 14, 2023
@basil basil added the upgrade-guide-needed This changes might be breaking in rare circumstances, an entry in the LTS upgrade guide is needed label Jul 17, 2023
@basil
Copy link
Member

basil commented Jul 17, 2023

Added upgrade-guide-needed to cover the fact that the following plugins must be upgraded in lockstep with this change:

https://plugins.jenkins.io/radiatorviewplugin/ is also impacted, but likely too old to be relevant. Should likely be deprecated.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug For changelog: Minor bug. Will be listed after features ready-for-merge The PR is ready to go, and it will be merged soon if there is no negative feedback upgrade-guide-needed This changes might be breaking in rare circumstances, an entry in the LTS upgrade guide is needed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants