[JENKINS-74795] Job created via REST API attaches to default view #9947

basil · 2024-11-05T20:38:26Z

Problem

See JENKINS-74795. Creating jobs via the createItem REST API erroneously attaches those items to the default view after #9672.

Evaluation

In the working scenario prior to #9672, the Jenkins#doCreateItem method is invoked by Stapler via its routable interface method ModifiableItemGroup#doCreateItem. In the failing scenario after #9672, the (incorrect) ListView#doCreateItem method is invoked by Stapler via its routable superclass method View#doCreateItem. This (mostly) works by accident, since View#doCreateItem happens to delegate to Jenkins#doCreateItem, but the incorrect behavior is still apparent when the item is incorrectly added to the default view. View#doCreateItem should never be invoked in this scenario, and the only reason it is was a regression in routing in #9672.

Solution

Make the Jenkins#doCreateItem(StaplerRequest2, StaplerResponse2) default method routable, as the equivalent interface method was prior to #9672. For consistency with View#doCreateItem(StaplerRequest2, StaplerResponse2), add a @RequirePOST annotation as well. The deprecated compatibility methods remain non-routable as before.

Testing done

Functional testing: new integration test passes before [JENKINS-73278] Migrate core from EE 8 to EE 9 #9672, fails after [JENKINS-73278] Migrate core from EE 8 to EE 9 #9672, and passes with this PR.
Regression testing: CI build of Jenkins core, ATH, and BOM/PCT

Proposed changelog entries

Do not add jobs created via the REST API to the default view.

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

Closes #9933

Co-authored-by: Mark Waite <mark.earl.waite@gmail.com>

daniel-beck

Compared Stapler traces of 2.474, 2.484, and PR build, for both Jenkins and Folder (legacy types without 2), and XML POST and copy mode, and this essentially restores the previous behavior. GET gets rejected as expected.

(Note to myself: RFE idea: Show parameter types in Stapler traces for web methods.)

MarkEWaite

I compared 2.474, 2.475, and the pre-release build from this pull request. The results from this build match the results from 2.474. I checked:

Job created with createItem at root no longer assigns the job to the primary view
Job created with createItem inside a view assigns the job to the view

Those behaviors are consistent between 2.474 and the build of this pull request. Thanks very much!

This PR is now ready for merge. We will merge it after approximately 24 hours if there is no negative feedback.

/label ready-for-merge

test/src/test/java/hudson/jobs/CreateItemTest.java

Co-authored-by: Mark Waite <mark.earl.waite@gmail.com>

…nkinsci#9947) Co-authored-by: Mark Waite <mark.earl.waite@gmail.com> (cherry picked from commit 8298257)

basil added the regression-fix Pull request that fixes a regression in one of the previous Jenkins releases label Nov 5, 2024

[JENKINS-74795] Job created via REST API attaches to default view

aea0a3d

Co-authored-by: Mark Waite <mark.earl.waite@gmail.com>

basil force-pushed the JENKINS-74795 branch from 051d0e8 to aea0a3d Compare November 5, 2024 21:05

basil added a commit to basil/acceptance-test-harness that referenced this pull request Nov 5, 2024

Test jenkinsci/jenkins#9947

58bbc91

basil mentioned this pull request Nov 5, 2024

Test jenkinsci/jenkins#9947 jenkinsci/acceptance-test-harness#1828

Closed

basil added a commit to basil/bom that referenced this pull request Nov 5, 2024

Test jenkinsci/jenkins#9947

840e76d

basil mentioned this pull request Nov 5, 2024

Test jenkinsci/jenkins#9947 jenkinsci/bom#3913

Closed

basil added the needs-security-review Awaiting review by a security team member label Nov 5, 2024

basil requested a review from a team November 5, 2024 22:11

basil marked this pull request as ready for review November 5, 2024 22:11

MarkEWaite mentioned this pull request Nov 5, 2024

[JENKINS-74795] createItem API should not assign new jobs to default view #9933

Closed

basil added a commit to basil/bom that referenced this pull request Nov 6, 2024

Test jenkinsci/jenkins#9947

6fd5a0b

daniel-beck added security-approved @jenkinsci/core-security-review reviewed this PR for security issues and removed needs-security-review Awaiting review by a security team member labels Nov 7, 2024

daniel-beck approved these changes Nov 7, 2024

View reviewed changes

basil requested a review from a team November 7, 2024 16:08

MarkEWaite approved these changes Nov 7, 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 Nov 7, 2024

MarkEWaite reviewed Nov 7, 2024

View reviewed changes

test/src/test/java/hudson/jobs/CreateItemTest.java Outdated Show resolved Hide resolved

Update test/src/test/java/hudson/jobs/CreateItemTest.java

dbeeeb3

Co-authored-by: Mark Waite <mark.earl.waite@gmail.com>

basil merged commit 8298257 into jenkinsci:master Nov 8, 2024
16 checks passed

krisstern pushed a commit to krisstern/jenkins that referenced this pull request Nov 9, 2024

[JENKINS-74795] Job created via REST API attaches to default view (je…

cd4cf63

…nkinsci#9947) Co-authored-by: Mark Waite <mark.earl.waite@gmail.com> (cherry picked from commit 8298257)

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[JENKINS-74795] Job created via REST API attaches to default view #9947

[JENKINS-74795] Job created via REST API attaches to default view #9947

basil commented Nov 5, 2024 •

edited

Loading

Submitter checklist

Maintainer checklist

daniel-beck left a comment

MarkEWaite left a comment

[JENKINS-74795] Job created via REST API attaches to default view #9947

[JENKINS-74795] Job created via REST API attaches to default view #9947

Conversation

basil commented Nov 5, 2024 • edited Loading

Problem

Evaluation

Solution

Testing done

Proposed changelog entries

Proposed upgrade guidelines

Submitter checklist

Desired reviewers

Maintainer checklist

daniel-beck left a comment

Choose a reason for hiding this comment

MarkEWaite left a comment

Choose a reason for hiding this comment

basil commented Nov 5, 2024 •

edited

Loading