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

Adds support of sessionId for External-Job-Monitor #8825

Conversation

Abhishekkr3003
Copy link
Contributor

@Abhishekkr3003 Abhishekkr3003 commented Jan 3, 2024

I was using the External-Job-Monitor plugin and following this Doc, but I was getting 403 responses like this:

Screenshot 2024-01-03 at 10 07 05 PM

On looking into the code, found a bug:
GET request to fetch crumb before POST request for postBuildResult has an extra ', due to which GET request was giving a non-2XX response, and crumb fields were not getting enriched.

Furthermore, I was still getting 403 responses, and then I found this change. which mentioned:

CSRF tokens (crumbs) are now only valid for the web session

So, to make things work, I added the support for sessionId returned in the GET call (to fetch crumb) to be sent in the POST call for postBuildResult.

And then getting the expected results:

image image

To summarize, this PR has the following two changes:

  1. Fixes bug in GET call of crumb
  2. Adds sessionId support

Testing done

Testing is done as mentioned above.

Proposed changelog entries

  • Support Session ID for External Job Monitor to prevent HTTP 503 response.

Proposed upgrade guidelines

N/A

Submitter checklist

Edit tasklist title
Beta Give feedback Tasklist Submitter checklist, more options

Delete tasklist

Delete tasklist block?
Are you sure? All relationships in this tasklist will be removed.
  1. The Jira issue, if it exists, is well-described.
    Options
  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.
    Options
  3. There is automated testing or an explanation as to why this change has no tests.
    Options
  4. New public classes, fields, and methods are annotated with @Restricted or have @since TODO Javadocs, as appropriate.
    Options
  5. New deprecations are annotated with @Deprecated(since = "TODO") or @Deprecated(forRemoval = true, since = "TODO"), if applicable.
    Options
  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).
    Options
  7. For dependency updates, there are links to external changelogs and, if possible, full differentials.
    Options
  8. 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

Edit tasklist title
Beta Give feedback Tasklist Maintainer checklist, more options

Delete tasklist

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

Copy link

welcome bot commented Jan 3, 2024

Yay, your first pull request towards Jenkins core was created successfully! Thank you so much!

A contributor will provide feedback soon. Meanwhile, you can join the chats and community forums to connect with other Jenkins users, developers, and maintainers.

@Abhishekkr3003 Abhishekkr3003 changed the title Adds support of sessionId for Adds support of sessionId for External-Job-Monitor Jan 3, 2024
@MarkEWaite MarkEWaite added the needs-security-review Awaiting review by a security team member label Jan 3, 2024
@mawinter69
Copy link
Contributor

According to https://issues.jenkins.io/browse/JENKINS-70684 this class is probably obsolete. Maybe the documentation needs to be updated in the plugin to no longer point to using things from core

@NotMyFault NotMyFault requested review from a team January 3, 2024 21:14
@Abhishekkr3003
Copy link
Contributor Author

@mawinter69 I think SetExternalBuildResultCommand requires us to store the logs and send them via SSH to the Jenkins Host as mentioned in the doc. But Hudon Main wraps our command, keeps the log, and sends via HTTP to Jenkins, which gives quite a bit of flexibility while using the External-Job-Monitor plugin. So, keeping this class or at least this functionality is better.

@Kevin-CB Kevin-CB 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 Jan 12, 2024
Copy link
Contributor

@Kevin-CB Kevin-CB left a comment

Choose a reason for hiding this comment

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

I tested your PR locally, it looks fine from a security perspective!

@NotMyFault NotMyFault added the rfe For changelog: Minor enhancement. use `major-rfe` for changes to be highlighted label Jan 15, 2024
@NotMyFault NotMyFault requested a review from a team February 16, 2024 21:42
@NotMyFault
Copy link
Member

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

@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 Mar 4, 2024
@NotMyFault NotMyFault merged commit b5c5caa into jenkinsci:master Mar 5, 2024
16 checks passed
Copy link

welcome bot commented Mar 5, 2024

Congratulations on getting your very first Jenkins core pull request merged 🎉🥳

This is a fantastic achievement, and we're thrilled to have you as part of our community! Thank you for your valuable input, and we look forward to seeing more of your contributions in the future!

We would like to invite you to join the community chats and forums to meet other Jenkins contributors 😊
Don't forget to check out the participation page to learn more about how to contribute to Jenkins.


@jglick
Copy link
Member

jglick commented Mar 15, 2024

Hudon Main wraps our command, keeps the log, and sends via HTTP to Jenkins

Fine but as mentioned in Jira please instead move all of this functionality into some utility in the plugin, so we can delete the class from core. It does not belong here and should not be touched.

@daniel-beck
Copy link
Member

@jglick It looks like you may have an opinion on #9023

@jglick
Copy link
Member

jglick commented Mar 16, 2024

Indeed. BTW I think all the logic here to retrieve a crumb ought to be deleted anyway, as it should only be needed if you are using a password rather than an API token.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ready-for-merge The PR is ready to go, and it will be merged soon if there is no negative feedback rfe For changelog: Minor enhancement. use `major-rfe` for changes to be highlighted security-approved @jenkinsci/core-security-review reviewed this PR for security issues
Projects
None yet
7 participants