[JENKINS-71355] Avoid Fetching all branches and Tags to retrieve SCM … (#708)

* [JENKINS-71355] Avoid Fetching all branches and Tags to retrieve SCM Head

* [JENKINS-71355] Adjust tests mocks

* [JENKINS-71355] Retrieve commits from source/target branches for Bitbucket Cloud

---------

Co-authored-by: Günter Grodotzki <[email protected]>

Author: Dohbedoh

src/main/java/com/cloudbees/jenkins/plugins/bitbucket/BitbucketSCMSource.java

@@ -819,59 +819,106 @@ private void retrieveTags(final BitbucketSCMSourceRequest request) throws IOExce
     protected SCMRevision retrieve(SCMHead head, TaskListener listener) throws IOException, InterruptedException {
         final BitbucketApi bitbucket = buildBitbucketClient();
         try {
-            List<? extends BitbucketBranch> branches = bitbucket.getBranches();
             if (head instanceof PullRequestSCMHead) {
                 PullRequestSCMHead h = (PullRequestSCMHead) head;
-                BitbucketCommit targetRevision = findCommit(h.getTarget().getName(), branches, listener);
-                if (targetRevision == null) {
-                    LOGGER.log(Level.WARNING, "No branch found in {0}/{1} with name [{2}]",
-                        new Object[]{repoOwner, repository, h.getTarget().getName()});
-                    return null;
-                }
                 BitbucketCommit sourceRevision;
+                BitbucketCommit targetRevision;
+
                 if (bitbucket instanceof BitbucketCloudApiClient) {
-                    branches = head.getOrigin() == SCMHeadOrigin.DEFAULT
-                        ? branches
-                        : buildBitbucketClient(h).getBranches();
-                    sourceRevision = findCommit(h.getBranchName(), branches, listener);
+                    // Bitbucket Cloud /pullrequests/{id} API endpoint only returns short commit IDs of the source
+                    // and target branch. We therefore retrieve the branches directly
+                    BitbucketBranch targetBranch = bitbucket.getBranch(h.getTarget().getName());
+
+                    if(targetBranch == null) {
+                        listener.getLogger().format("No branch found in {0}/{1} with name [{2}]",
+                            repoOwner, repository, h.getTarget().getName());
+                        return null;
+                    }
+                    targetRevision = findCommit(targetBranch, listener);
+
+                    if (targetRevision == null) {
+                        listener.getLogger().format("No branch found in {0}/{1} with name [{2}]",
+                            repoOwner, repository, h.getTarget().getName());
+                        return null;
+                    }
+
+                    // Retrieve the source branch commit
+                    BitbucketBranch branch;
+                    if (head.getOrigin() == SCMHeadOrigin.DEFAULT) {
+                        branch = bitbucket.getBranch(h.getBranchName());
+                    } else {
+                        // In case of a forked branch, retrieve the branch as that owner
+                        branch = buildBitbucketClient(h).getBranch(h.getBranchName());
+                    }
+
+                    if(branch == null) {
+                        listener.getLogger().format("No branch found in {0}/{1} with name [{2}]",
+                            repoOwner, repository, head.getName());
+                        return null;
+                    }
+
+                    sourceRevision = findCommit(branch, listener);
+
                 } else {
+                    BitbucketPullRequest pr;
                     try {
-                        BitbucketPullRequest pr = bitbucket.getPullRequestById(Integer.parseInt(h.getId()));
-                        sourceRevision = findPRCommit(pr, listener);
+                        pr = bitbucket.getPullRequestById(Integer.parseInt(h.getId()));
                     } catch (NumberFormatException nfe) {
                         LOGGER.log(Level.WARNING, "Cannot parse the PR id {0}", h.getId());
-                        sourceRevision = null;
+                        return null;
                     }
+
+                    targetRevision = findPRDestinationCommit(pr, listener);
+
+                    if (targetRevision == null) {
+                        listener.getLogger().format("No branch found in {0}/{1} with name [{2}]",
+                            repoOwner, repository, h.getTarget().getName());
+                        return null;
+                    }
+
+                    sourceRevision = findPRSourceCommit(pr, listener);
                 }
+
                 if (sourceRevision == null) {
-                    LOGGER.log(Level.WARNING, "No revision found in {0}/{1} for PR-{2} [{3}]",
-                        new Object[]{
-                            h.getRepoOwner(),
-                            h.getRepository(),
-                            h.getId(),
-                            h.getBranchName()
-                        });
+                    listener.getLogger().format("No revision found in {0}/{1} for PR-{2} [{3}]",
+                        h.getRepoOwner(),
+                        h.getRepository(),
+                        h.getId(),
+                        h.getBranchName());
                     return null;
                 }
+
                 return new PullRequestSCMRevision<>(
                     h,
                     new BitbucketGitSCMRevision(h.getTarget(), targetRevision),
                     new BitbucketGitSCMRevision(h, sourceRevision)
                 );
             } else if (head instanceof BitbucketTagSCMHead) {
                 BitbucketTagSCMHead tagHead = (BitbucketTagSCMHead) head;
-                List<? extends BitbucketBranch> tags = bitbucket.getTags();
-                BitbucketCommit revision = findCommit(head.getName(), tags, listener);
+                BitbucketBranch tag = bitbucket.getTag(tagHead.getName());
+                if(tag == null) {
+                    listener.getLogger().format( "No tag found in {0}/{1} with name [{2}]",
+                        repoOwner, repository, head.getName());
+                    return null;
+                }
+                BitbucketCommit revision = findCommit(tag, listener);
                 if (revision == null) {
-                    LOGGER.log(Level.WARNING, "No tag found in {0}/{1} with name [{2}]", new Object[]{repoOwner, repository, head.getName()});
+                    listener.getLogger().format( "No revision found in {0}/{1} with name [{2}]",
+                        repoOwner, repository, head.getName());
                     return null;
                 }
                 return new BitbucketTagSCMRevision(tagHead, revision);
             } else {
-                BitbucketCommit revision = findCommit(head.getName(), branches, listener);
+                BitbucketBranch branch = bitbucket.getBranch(head.getName());
+                if(branch == null) {
+                    listener.getLogger().format("No branch found in {0}/{1} with name [{2}]",
+                        repoOwner, repository, head.getName());
+                    return null;
+                }
+                BitbucketCommit revision = findCommit(branch, listener);
                 if (revision == null) {
-                    LOGGER.log(Level.WARNING, "No branch found in {0}/{1} with name [{2}]",
-                        new Object[]{repoOwner, repository, head.getName()});
+                    listener.getLogger().format("No revision found in {0}/{1} with name [{2}]",
+                        repoOwner, repository, head.getName());
                     return null;
                 }
                 return new BitbucketGitSCMRevision(head, revision);
@@ -890,29 +937,23 @@ protected SCMRevision retrieve(SCMHead head, TaskListener listener) throws IOExc
         }
     }
 
-    private BitbucketCommit findCommit(@NonNull String branchName, List<? extends BitbucketBranch> branches, TaskListener listener) {
-        for (final BitbucketBranch b : branches) {
-            if (branchName.equals(b.getName())) {
-                String revision = b.getRawNode();
-                if (revision == null) {
-                    if (BitbucketCloudEndpoint.SERVER_URL.equals(getServerUrl())) {
-                        listener.getLogger().format("Cannot resolve the hash of the revision in branch %s%n",
-                                branchName);
-                    } else {
-                        listener.getLogger().format("Cannot resolve the hash of the revision in branch %s. "
-                                        + "Perhaps you are using Bitbucket Server previous to 4.x%n",
-                                branchName);
-                    }
-                    return null;
-                }
-                return new BranchHeadCommit(b);
+    private BitbucketCommit findCommit(@NonNull BitbucketBranch branch, TaskListener listener) {
+        String revision = branch.getRawNode();
+        if (revision == null) {
+            if (BitbucketCloudEndpoint.SERVER_URL.equals(getServerUrl())) {
+                listener.getLogger().format("Cannot resolve the hash of the revision in branch %s%n",
+                    branch.getName());
+            } else {
+                listener.getLogger().format("Cannot resolve the hash of the revision in branch %s. "
+                        + "Perhaps you are using Bitbucket Server previous to 4.x%n",
+                    branch.getName());
             }
+            return null;
         }
-        listener.getLogger().format("Cannot find the branch %s%n", branchName);
-        return null;
+        return new BranchHeadCommit(branch);
     }
 
-    private BitbucketCommit findPRCommit(BitbucketPullRequest pr, TaskListener listener) {
+    private BitbucketCommit findPRSourceCommit(BitbucketPullRequest pr, TaskListener listener) {
         // if I use getCommit() the branch closure is trigger immediately
         BitbucketBranch branch = pr.getSource().getBranch();
         String hash = branch.getRawNode();
@@ -930,6 +971,24 @@ private BitbucketCommit findPRCommit(BitbucketPullRequest pr, TaskListener liste
         return new BranchHeadCommit(branch);
     }
 
+    private BitbucketCommit findPRDestinationCommit(BitbucketPullRequest pr, TaskListener listener) {
+        // if I use getCommit() the branch closure is trigger immediately
+        BitbucketBranch branch = pr.getDestination().getBranch();
+        String hash = branch.getRawNode();
+        if (hash == null) {
+            if (BitbucketCloudEndpoint.SERVER_URL.equals(getServerUrl())) {
+                listener.getLogger().format("Cannot resolve the hash of the revision in PR-%s%n",
+                    pr.getId());
+            } else {
+                listener.getLogger().format("Cannot resolve the hash of the revision in PR-%s. "
+                        + "Perhaps you are using Bitbucket Server previous to 4.x%n",
+                    pr.getId());
+            }
+            return null;
+        }
+        return new BranchHeadCommit(branch);
+    }
+
     @Override
     public SCM build(SCMHead head, SCMRevision revision) {
         BitbucketRepositoryType type;

src/main/java/com/cloudbees/jenkins/plugins/bitbucket/api/BitbucketApi.java

@@ -136,6 +136,16 @@ boolean checkPathExists(@NonNull String branchOrHash, @NonNull String path)
     @CheckForNull
     String getDefaultBranch() throws IOException, InterruptedException;
 
+    /**
+     * Returns a branch in the repository.
+     *
+     * @return a branch in the repository.
+     * @throws IOException if there was a network communications error.
+     * @throws InterruptedException if interrupted while waiting on remote communications.
+     */
+    @CheckForNull
+    BitbucketBranch getBranch(@NonNull String branchName) throws IOException, InterruptedException;
+
     /**
      * Returns the branches in the repository.
      *
@@ -146,6 +156,16 @@ boolean checkPathExists(@NonNull String branchOrHash, @NonNull String path)
     @NonNull
     List<? extends BitbucketBranch> getBranches() throws IOException, InterruptedException;
 
+    /**
+     * Returns a tag in the repository.
+     *
+     * @return a tag in the repository.
+     * @throws IOException if there was a network communications error.
+     * @throws InterruptedException if interrupted while waiting on remote communications.
+     */
+    @CheckForNull
+    BitbucketBranch getTag(@NonNull String tagName) throws IOException, InterruptedException;
+
      /**
      * Returns the tags in the repository.
      *

src/main/java/com/cloudbees/jenkins/plugins/bitbucket/client/BitbucketCloudApiClient.java

@@ -472,6 +472,24 @@ public String getDefaultBranch() throws IOException, InterruptedException {
         return cachedDefaultBranch;
     }
 
+    /**
+     * {@inheritDoc}
+     */
+    @Override
+    public BitbucketCloudBranch getTag(@NonNull String tagName) throws IOException, InterruptedException {
+        String url = UriTemplate.fromTemplate(REPO_URL_TEMPLATE + "/refs/tags/{name}")
+            .set("owner", owner)
+            .set("repo", repositoryName)
+            .set("name", tagName)
+            .expand();
+        String response = getRequest(url);
+        try {
+            return getSingleBranch(response);
+        } catch (IOException e) {
+            throw new IOException("I/O error when parsing response from URL: " + url, e);
+        }
+    }
+
     /**
      * {@inheritDoc}
      */
@@ -481,6 +499,24 @@ public List<BitbucketCloudBranch> getTags() throws IOException, InterruptedExcep
         return getBranchesByRef("/refs/tags");
     }
 
+    /**
+     * {@inheritDoc}
+     */
+    @Override
+    public BitbucketCloudBranch getBranch(@NonNull String branchName) throws IOException, InterruptedException {
+        String url = UriTemplate.fromTemplate(REPO_URL_TEMPLATE + "/refs/branches/{name}")
+            .set("owner", owner)
+            .set("repo", repositoryName)
+            .set("name", branchName)
+            .expand();
+        String response = getRequest(url);
+        try {
+            return getSingleBranch(response);
+        } catch (IOException e) {
+            throw new IOException("I/O error when parsing response from URL: " + url, e);
+        }
+    }
+
     /**
      * {@inheritDoc}
      */
@@ -1065,6 +1101,10 @@ private List<BitbucketCloudBranch> getAllBranches(String response) throws IOExce
         return activeBranches;
     }
 
+    private BitbucketCloudBranch getSingleBranch(String response) throws IOException {
+        return JsonParser.mapper.readValue(response, new TypeReference<BitbucketCloudBranch>(){});
+    }
+
     @Override
     public Iterable<SCMFile> getDirectoryContent(final BitbucketSCMFile parent) throws IOException, InterruptedException {
         String url = UriTemplate.fromTemplate(REPO_URL_TEMPLATE + "/src{/branchOrHash,path}")