JENKINS-48737 Fixing lightweight pull request checkouts, also for files in subdirectories#174
Conversation
|
Suggested fix for https://issues.jenkins-ci.org/browse/JENKINS-48737. |
|
@seb-lie I think this could be better implemented: |
| private static final String API_PULL_REQUEST_PATH = API_REPOSITORY_PATH + "/pull-requests/{id}"; | ||
| private static final String API_PULL_REQUEST_MERGE_PATH = API_REPOSITORY_PATH + "/pull-requests/{id}/merge"; | ||
| private static final String API_BROWSE_PATH = API_REPOSITORY_PATH + "/browse{/path*}{?at}"; | ||
| private static final String API_BROWSE_PATH = API_REPOSITORY_PATH + "/browse{/path*}?at={+at}"; |
There was a problem hiding this comment.
Please use handy uri as intended. the ?at makes at optional.
if your worried about quoting there is a way to fix that in handy uri, I suggest you read the docs :)
There was a problem hiding this comment.
Thanks for the review! Yes, I was concerned that forward slashes were escaped which broke the path in subdirs. I looked through rfc6570 but could not find an example or spec of an optional parameter with a path. Probably I'm missing the obvious - do you have something in mind that enables an expansion like ?at=refs/pull-requests/1184/from ?
There was a problem hiding this comment.
?at=refs/pull-requests/1184/from should be safe already though. We are not talking about the path part of the URL where you should be concerned. We are talking about the parameter/query part and slashes are perfectly fine.
There was a problem hiding this comment.
if anything that would break subdirs it's the {/path*} part of the
API_BROWSE_PATH
There was a problem hiding this comment.
Let me test this in a couple of hours so that I can revisit my reasoning for this change.
There was a problem hiding this comment.
Write a test that verifies the issue?
There was a problem hiding this comment.
The API endpoint has been wrong the whole time 😆
| private static final String API_BROWSE_PATH = API_REPOSITORY_PATH + "/browse{/path*}?at={+at}"; | |
| private static final String API_BROWSE_PATH = API_REPOSITORY_PATH + "/browse/{+path}{?at}"; |
Did some testing:
The current template that is wrong expands to this
http://bitbucket/rest/api/1.0/projects/test/repos/test/browse/folder%2FJenkinsfile?at=fix%2Ftest
The new template that is correct expands to this
http://bitbucket/rest/api/1.0/projects/test/repos/test/browse/folder/Jenkinsfile?at=fix%2Ftest
This template /browse/{+path}?at={+at} works too and it expands to
http://bitbucket/rest/api/1.0/projects/test/repos/test/browse/folder/Jenkinsfile?at=fix/test
There was a problem hiding this comment.
I have added some test locally that I will push soon
src/main/java/com/cloudbees/jenkins/plugins/bitbucket/filesystem/BitbucketSCMFile.java
Outdated
Show resolved
Hide resolved
src/main/java/com/cloudbees/jenkins/plugins/bitbucket/filesystem/BitbucketSCMFileSystem.java
Outdated
Show resolved
Hide resolved
src/main/java/com/cloudbees/jenkins/plugins/bitbucket/filesystem/BitbucketSCMFileSystem.java
Outdated
Show resolved
Hide resolved
src/main/java/com/cloudbees/jenkins/plugins/bitbucket/filesystem/BitbucketSCMFileSystem.java
Outdated
Show resolved
Hide resolved
src/main/java/com/cloudbees/jenkins/plugins/bitbucket/filesystem/BitbucketSCMFileSystem.java
Outdated
Show resolved
Hide resolved
src/main/java/com/cloudbees/jenkins/plugins/bitbucket/filesystem/BitbucketSCMFileSystem.java
Outdated
Show resolved
Hide resolved
This reverts commit 83075a2.
jetersen
force-pushed
the
fix_lightweight_checkouts_2.4.2
branch
from
54002da to
cacc5e7
Compare
| if (pr.getCheckoutStrategy() == ChangeRequestCheckoutStrategy.MERGE) { | ||
| return null; | ||
| } else if (pr.getCheckoutStrategy() == ChangeRequestCheckoutStrategy.HEAD) { | ||
| ref = pr.getOriginName(); |
There was a problem hiding this comment.
Testing out whether this is even possible
There was a problem hiding this comment.
Yup only possible when the PR is coming from the same repository.
Atlassian is the one to blame for having an issue open for six years and counting.
|
Hi, This does not work for me. The Jenkins falls back to heavy weight checkout when using a Bitbucket Team project. Jenkins version: [2.391] Regards, |
4 participants
Fixing lightweight checkout for PRs for merge and head revisions. The easiest way seemed to pull more data (SCMHead) into BitbucketSCMFile to be able to distinguish between merge and head PRs in a central location.
Validated on Atlassian Bitbucket Server (DC) v5.8.2 for Jenkinsfiles as well as arbitrary files directly in a repo as well as in subdirectories.
There's still the corner case left for lightweight checkouts on conflicted PRs - these are still checked out in full, also on Jenkins masters.