Ticket #1843 - Fix stapler request double completion#1905
Open
pauljohnston2009 wants to merge 2 commits into
Open
Ticket #1843 - Fix stapler request double completion#1905pauljohnston2009 wants to merge 2 commits into
pauljohnston2009 wants to merge 2 commits into
Conversation
Fix issue with status pngs throwing java.lang.IllegalStateException: COMMITTED Stapler calls getDynamic, and will keep calling getDynamic on each part of the url, eventualy it hits the end of the parts of the url and thingks the response has not been handled Stapler sees it as 'not handled' and so eventually trys to complete the response itself, resulting in the double commit error Instead we can use doDynamic which means we will fill out the response in all cases, and stapler does not call the rest of the chain https://github.com/jenkinsci/stapler/blob/master/docs/reference.adoc "The doDynamic action method is the final consumer of the request."
pauljohnston2009
force-pushed
the
ticket-1843-prevent-duplicate-commit
branch
from
9735105 to
aa07105
Compare
Member
|
@pauljohnston2009 Thanks for the PR! Let me review this shortly |
Contributor
There was a problem hiding this comment.
Pull request overview
This PR fixes a Stapler “double completion”/double-commit issue (e.g., java.lang.IllegalStateException: COMMITTED) when serving status badge endpoints by switching the webhook entrypoint from getDynamic (which can be invoked repeatedly during URL traversal) to doDynamic (the final request consumer). This ensures the plugin completes the response exactly once for the request.
Changes:
- Replace
GitLabWebHook#getDynamic(projectName, req, rsp)withGitLabWebHook#doDynamic(req, rsp)to stop Stapler from continuing the traversal chain. - Update
ActionResolverto parse theprojectNamefromrequest.getRestOfPath()and adjust call sites accordingly. - Update
ActionResolverTestexpectations/mocks to reflect the new request path layout and resolver signature.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
src/main/java/com/dabsquared/gitlabjenkins/webhook/GitLabWebHook.java |
Switches the webhook handler to doDynamic so Stapler treats it as the terminal consumer and avoids double-commit. |
src/main/java/com/dabsquared/gitlabjenkins/webhook/ActionResolver.java |
Extracts projectName from restOfPath so the resolver works with doDynamic routing. |
src/test/java/com/dabsquared/gitlabjenkins/webhook/ActionResolverTest.java |
Updates tests to mock restOfPath including the project name and uses the new resolver signature. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
| public void getDynamic(final String projectName, final StaplerRequest2 request, StaplerResponse2 response) { | ||
| LOGGER.log(Level.INFO, "WebHook called with url: {0}", request.getRequestURIWithQueryString()); | ||
| actionResolver.resolve(projectName, request).execute(response); | ||
| public void doDynamic(final StaplerRequest2 request, StaplerResponse2 response) { |
| public void getDynamic(final String projectName, final StaplerRequest2 request, StaplerResponse2 response) { | ||
| LOGGER.log(Level.INFO, "WebHook called with url: {0}", request.getRequestURIWithQueryString()); | ||
| actionResolver.resolve(projectName, request).execute(response); | ||
| public void doDynamic(final StaplerRequest2 request, StaplerResponse2 response) { |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Resolves #1843
Fix issue with status pngs throwing java.lang.IllegalStateException: COMMITTED
Stapler calls getDynamic, and will keep calling getDynamic on each part of the url, eventualy it hits the end of the parts of the url and thinks the response has not been handled. Stapler sees it as 'not handled' and so eventually trys to complete the response itself, resulting in the double commit error.
Instead we can use doDynamic which means we will fill out the response in all cases, and stapler does not call the rest of the chain https://github.com/jenkinsci/stapler/blob/master/docs/reference.adoc "The doDynamic action method is the final consumer of the request.".
Testing done
Manually tested on our jenkins server, logs are no longer spamming the exception on every statsu.png request.
Submitter checklist