Add Jira site property to configure max number of returned Jira issues

src/main/java/hudson/plugins/jira/JiraSession.java

@@ -39,8 +39,6 @@
 public class JiraSession {
     private static final Logger LOGGER = Logger.getLogger(JiraSession.class.getName());
 
-    public static final Integer MAX_ISSUES = 100;
-
     public final JiraRestService service;
 
     /**
@@ -50,9 +48,12 @@
 
     private final String jiraSiteName;
 
-    /* package */ JiraSession(JiraSite site, JiraRestService jiraRestService) {
+    private final int maxIssuesFromJqlSearch;
+
+    /* package */ JiraSession(JiraSite site, JiraRestService jiraRestService, int maxIssuesFromJqlSearch) {
         this.service = jiraRestService;
         this.jiraSiteName = site.getName();
+        this.maxIssuesFromJqlSearch = maxIssuesFromJqlSearch;
     }
 
     /**
@@ -131,102 +132,102 @@
      * @return issues matching the JQL query
      */
     public List<Issue> getIssuesFromJqlSearch(final String jqlSearch) throws TimeoutException {
-        return service.getIssuesFromJqlSearch(jqlSearch, MAX_ISSUES);
+        return service.getIssuesFromJqlSearch(jqlSearch, maxIssuesFromJqlSearch);
     }
 
     /**
      * Get all versions from the given project
      *
      * @param projectKey The key for the project
      * @return An array of versions
      */
     public List<ExtendedVersion> getVersions(String projectKey) {
         LOGGER.fine("Fetching versions from project: " + projectKey);
         return service.getVersions(projectKey);
     }
 
     /**
      * Get a version by its name
      *
      * @param projectKey The key for the project
      * @param name       The version name
      * @return A RemoteVersion, or null if not found
      */
     public ExtendedVersion getVersionByName(String projectKey, String name) {
         LOGGER.fine("Fetching versions from project: " + projectKey);
         List<ExtendedVersion> versions = getVersions(projectKey);
         if (versions == null) {
             return null;
         }
         for (ExtendedVersion version : versions) {
             if (version.getName().equals(name)) {
                 return version;
             }
         }
         return null;
     }
 
     public List<Issue> getIssuesWithFixVersion(String projectKey, String version) throws TimeoutException {
         return getIssuesWithFixVersion(projectKey, version, "");
     }
 
     public List<Issue> getIssuesWithFixVersion(String projectKey, String version, String filter)
             throws TimeoutException {
         LOGGER.fine("Fetching versions from project: " + projectKey + " with fixVersion:" + version);
         if (isNotEmpty(filter)) {
             return service.getIssuesFromJqlSearch(
                     String.format("project = \"%s\" and fixVersion = \"%s\" and " + filter, projectKey, version),
-                    MAX_ISSUES);
+                    maxIssuesFromJqlSearch);
         }
         return service.getIssuesFromJqlSearch(
-                String.format("project = \"%s\" and fixVersion = \"%s\"", projectKey, version), MAX_ISSUES);
+                String.format("project = \"%s\" and fixVersion = \"%s\"", projectKey, version), maxIssuesFromJqlSearch);
     }
 
     /**
      * Get all issue types
      *
      * @return An array of issue types
      */
     public List<IssueType> getIssueTypes() {
         LOGGER.fine("Fetching issue types");
         return service.getIssueTypes();
     }
 
     /**
      * Get all priorities
      *
      * @return An array of priorities
      */
     public List<Priority> getPriorities() {
         LOGGER.fine("Fetching priorities");
         return service.getPriorities();
     }
 
     /**
      * Release given version in given project
      */
     public void releaseVersion(String projectKey, ExtendedVersion version) {
         LOGGER.fine("Releasing version: " + version.getName());
         service.releaseVersion(projectKey, version);
     }
 
     /**
      * Replaces the fix version list of all issues matching the JQL Query with the version specified.
      *
      * @param projectKey The Jira Project key
      * @param version    The replacement version
      * @param query      The JQL Query
      */
     public void migrateIssuesToFixVersion(String projectKey, String version, String query) throws TimeoutException {
 
         Version newVersion = getVersionByName(projectKey, version);
         if (newVersion == null) {
             LOGGER.warning("Version " + version + " was not found");
             return;
         }
 
         LOGGER.fine("Fetching versions with JQL:" + query);
-        List<Issue> issues = service.getIssuesFromJqlSearch(query, MAX_ISSUES);
+        List<Issue> issues = service.getIssuesFromJqlSearch(query, maxIssuesFromJqlSearch);
         if (issues == null || issues.isEmpty()) {
             return;
         }
@@ -256,7 +257,7 @@
         }
 
         LOGGER.fine("Fetching versions with JQL:" + query);
-        List<Issue> issues = service.getIssuesFromJqlSearch(query, MAX_ISSUES);
+        List<Issue> issues = service.getIssuesFromJqlSearch(query, maxIssuesFromJqlSearch);
         if (issues == null) {
             return;
         }
@@ -309,7 +310,7 @@
         }
 
         LOGGER.fine("Fetching issues with JQL:" + query);
-        List<Issue> issues = service.getIssuesFromJqlSearch(query, MAX_ISSUES);
+        List<Issue> issues = service.getIssuesFromJqlSearch(query, maxIssuesFromJqlSearch);
         if (issues == null || issues.isEmpty()) {
             return;
         }

src/main/java/hudson/plugins/jira/JiraSessionFactory.java

@@ -55,6 +55,6 @@ public static JiraSession create(JiraSite jiraSite, URI uri, StandardUsernamePas
                     jiraSite.getReadTimeout());
         }
 
-        return new JiraSession(jiraSite, jiraRestService);
+        return new JiraSession(jiraSite, jiraRestService, jiraSite.getMaxIssuesFromJqlSearch());
     }
 }

src/main/java/hudson/plugins/jira/JiraSite.java

@@ -117,6 +117,8 @@ public class JiraSite extends AbstractDescribableImpl<JiraSite> {
 
     public static final int DEFAULT_THREAD_EXECUTOR_NUMBER = 10;
 
+    public static final int DEFAULT_MAX_ISSUES = 100;
+
     /**
      * URL of Jira for Jenkins access, like {@code http://jira.codehaus.org/}.
      * Mandatory. Normalized to end with '/'
@@ -242,6 +244,11 @@ public class JiraSite extends AbstractDescribableImpl<JiraSite> {
      */
     private boolean appendChangeTimestamp;
 
+    /**
+     * To allow configurable value of max issues from jql search via jira site global configuration.
+     */
+    private int maxIssuesFromJqlSearch = DEFAULT_MAX_ISSUES;
+
     private int ioThreadCount = Integer.getInteger(JiraSite.class.getName() + ".httpclient.options.ioThreadCount", 2);
 
     /**
@@ -275,7 +282,8 @@ public JiraSite(
             boolean updateJiraIssueForAllStatus,
             @CheckForNull String groupVisibility,
             @CheckForNull String roleVisibility,
-            boolean useHTTPAuth) {
+            boolean useHTTPAuth,
+            int maxIssuesFromJqlSearch) {
         this(
                 url,
                 alternativeUrl,
@@ -289,7 +297,8 @@ public JiraSite(
                 useHTTPAuth,
                 DEFAULT_TIMEOUT,
                 DEFAULT_READ_TIMEOUT,
-                DEFAULT_THREAD_EXECUTOR_NUMBER);
+                DEFAULT_THREAD_EXECUTOR_NUMBER,
+                DEFAULT_MAX_ISSUES);
     }
 
     // Deprecate the previous constructor but leave it in place for Java-level compatibility.
@@ -347,7 +356,8 @@ public JiraSite(
                 useHTTPAuth,
                 DEFAULT_TIMEOUT,
                 DEFAULT_READ_TIMEOUT,
-                DEFAULT_THREAD_EXECUTOR_NUMBER);
+                DEFAULT_THREAD_EXECUTOR_NUMBER,
+                DEFAULT_MAX_ISSUES);
         if (credentials != null) {
             // we verify the credential really exists otherwise we migrate it
             StandardUsernamePasswordCredentials standardUsernamePasswordCredentials =
@@ -375,7 +385,8 @@ public JiraSite(
             boolean useHTTPAuth,
             int timeout,
             int readTimeout,
-            int threadExecutorNumber) {
+            int threadExecutorNumber,
+            int maxIssuesFromJqlSearch) {
         if (url != null) {
             url = toURL(url.toExternalForm());
         }
@@ -398,6 +409,7 @@ public JiraSite(
         setRoleVisibility(roleVisibility);
         this.useHTTPAuth = useHTTPAuth;
         this.jiraSession = null;
+        this.maxIssuesFromJqlSearch = maxIssuesFromJqlSearch;
     }
 
     @DataBoundConstructor
@@ -424,7 +436,8 @@ public JiraSite(
             boolean useHTTPAuth,
             int timeout,
             int readTimeout,
-            int threadExecutorNumber) {
+            int threadExecutorNumber,
+            int maxIssuesFromJqlSearch) {
         this(
                 url,
                 alternativeUrl,
@@ -438,7 +451,8 @@ public JiraSite(
                 useHTTPAuth,
                 timeout,
                 readTimeout,
-                threadExecutorNumber);
+                threadExecutorNumber,
+                maxIssuesFromJqlSearch);
     }
 
     // Deprecate the previous constructor but leave it in place for Java-level compatibility.
@@ -457,7 +471,8 @@ public JiraSite(
             int timeout,
             int readTimeout,
             int threadExecutorNumber,
-            boolean useBearerAuth) {
+            boolean useBearerAuth,
+            int maxIssuesFromJqlSearch) {
         this(
                 url,
                 alternativeUrl,
@@ -471,7 +486,8 @@ public JiraSite(
                 useHTTPAuth,
                 timeout,
                 readTimeout,
-                threadExecutorNumber);
+                threadExecutorNumber,
+                maxIssuesFromJqlSearch);
         this.useBearerAuth = useBearerAuth;
     }
 
@@ -646,6 +662,15 @@ public void setUpdateJiraIssueForAllStatus(boolean updateJiraIssueForAllStatus)
         this.updateJiraIssueForAllStatus = updateJiraIssueForAllStatus;
     }
 
+    @DataBoundSetter
+    public void setMaxIssuesFromJqlSearch(int maxIssuesFromJqlSearch) {
+        this.maxIssuesFromJqlSearch = maxIssuesFromJqlSearch;
+    }
+
+    public int getMaxIssuesFromJqlSearch() {
+        return maxIssuesFromJqlSearch;
+    }
+
     @SuppressWarnings("unused")
     protected Object readResolve() throws FormException {
         JiraSite jiraSite;
@@ -677,7 +702,8 @@ protected Object readResolve() throws FormException {
                     useHTTPAuth,
                     timeout,
                     readTimeout,
-                    threadExecutorNumber);
+                    threadExecutorNumber,
+                    maxIssuesFromJqlSearch);
         }
         jiraSite.setAppendChangeTimestamp(appendChangeTimestamp);
         jiraSite.setDisableChangelogAnnotations(disableChangelogAnnotations);
@@ -1350,6 +1376,7 @@ public FormValidation doValidate(
                 @QueryParameter int readTimeout,
                 @QueryParameter int threadExecutorNumber,
                 @QueryParameter boolean useBearerAuth,
+                @QueryParameter int maxIssuesFromJqlSearch,
                 @AncestorInPath Item item) {
 
             if (item == null) {
@@ -1403,6 +1430,7 @@ public FormValidation doValidate(
             site.setReadTimeout(readTimeout);
             site.setThreadExecutorNumber(threadExecutorNumber);
             site.setUseBearerAuth(useBearerAuth);
+            site.setMaxIssuesFromJqlSearch(maxIssuesFromJqlSearch);
             try {
                 JiraSession session = site.getSession(item, true);
                 if (session == null) {
@@ -1451,6 +1479,7 @@ static class Builder {
         private String groupVisibility;
         private String roleVisibility;
         private boolean useHTTPAuth;
+        private int maxIssuesFromJqlSearch;
 
         public Builder withMainURL(URL mainURL) {
             this.mainURL = mainURL;
@@ -1513,7 +1542,8 @@ public JiraSite build() {
                     updateJiraIssueForAllStatus,
                     groupVisibility,
                     roleVisibility,
-                    useHTTPAuth);
+                    useHTTPAuth,
+                    maxIssuesFromJqlSearch);
         }
     }
 

src/main/resources/hudson/plugins/jira/JiraSite/config.jelly

@@ -51,6 +51,9 @@
   <f:entry title="${%Jira comments timestamp format}" field="dateTimePattern">
     <f:textbox />
   </f:entry>
+  <f:entry title="${%Max Issues From Jql Search}" field="maxIssuesFromJqlSearch">
+    <f:number default="100" />
+  </f:entry>
   <f:entry>
     <f:validateButton title="${%Validate Settings}"
             method="validate" with="url,credentialsId,groupVisibility,roleVisibility,useHTTPAuth,alternativeUrl,timeout,readTimeout,threadExecutorNumber,useBearerAuth" />

src/main/resources/hudson/plugins/jira/JiraSite/help-maxIssuesFromJqlSearch.html

@@ -0,0 +1,3 @@
+<div>
+Specifies the maximum number of issues to load from the JQL search query. If this number exceeds the limit configured in Jira, only the maximum allowed by Jira will be retrieved.
+</div>

src/test/java/JiraTester.java

@@ -5,7 +5,6 @@
 import com.atlassian.jira.rest.client.api.domain.Transition;
 import com.atlassian.jira.rest.client.api.domain.User;
 import hudson.plugins.jira.JiraRestService;
-import hudson.plugins.jira.JiraSession;
 import hudson.plugins.jira.JiraSite;
 import hudson.plugins.jira.JiraSite.ExtendedAsynchronousJiraRestClientFactory;
 import hudson.plugins.jira.extension.ExtendedJiraRestClient;
@@ -57,7 +56,8 @@ public static void main(String[] args) throws Exception {
         //        restService.createIssue("TESTPROJECT", "This is a test issue created using Jira jenkins plugin. Please
         // ignore it.", "TESTUSER", components1, "test issue from Jira jenkins plugin");
 
-        final List<Issue> searchResults = restService.getIssuesFromJqlSearch("project = \"TESTPROJECT\"", 3);
+        final List<Issue> searchResults =
+                restService.getIssuesFromJqlSearch("project = \"TESTPROJECT\"", JiraSite.DEFAULT_MAX_ISSUES);
         for (Issue searchResult : searchResults) {
             System.out.println("JQL search result: " + searchResult);
         }
@@ -102,8 +102,8 @@ public static void main(String[] args) throws Exception {
 
     private static void callUniq(final JiraRestService restService) throws Exception {
         long start = System.currentTimeMillis();
-        List<Issue> issues =
-                restService.getIssuesFromJqlSearch("key in ('JENKINS-53320','JENKINS-51057')", JiraSession.MAX_ISSUES);
+        List<Issue> issues = restService.getIssuesFromJqlSearch(
+                "key in ('JENKINS-53320','JENKINS-51057')", JiraSite.DEFAULT_MAX_ISSUES);
         long end = System.currentTimeMillis();
         System.out.println("time uniq " + (end - start));
     }
@@ -112,7 +112,7 @@ private static void callDuplicate(final JiraRestService restService) throws Exce
         long start = System.currentTimeMillis();
         List<Issue> issues = restService.getIssuesFromJqlSearch(
                 "key in ('JENKINS-53320','JENKINS-53320','JENKINS-53320','JENKINS-53320','JENKINS-53320','JENKINS-51057','JENKINS-51057','JENKINS-51057','JENKINS-51057','JENKINS-51057')",
-                JiraSession.MAX_ISSUES);
+                JiraSite.DEFAULT_MAX_ISSUES);
         long end = System.currentTimeMillis();
         System.out.println("time duplicate " + (end - start));
     }

src/test/java/JiraTesterBearerAuth.java

@@ -5,7 +5,6 @@
 import com.atlassian.jira.rest.client.api.domain.Transition;
 import com.atlassian.jira.rest.client.api.domain.User;
 import hudson.plugins.jira.JiraRestService;
-import hudson.plugins.jira.JiraSession;
 import hudson.plugins.jira.JiraSite;
 import hudson.plugins.jira.JiraSite.ExtendedAsynchronousJiraRestClientFactory;
 import hudson.plugins.jira.auth.BearerHttpAuthenticationHandler;
@@ -59,7 +58,8 @@ public static void main(String[] args) throws Exception {
         //        restService.createIssue("TESTPROJECT", "This is a test issue created using Jira jenkins plugin. Please
         // ignore it.", "TESTUSER", components1, "test issue from Jira jenkins plugin");
 
-        final List<Issue> searchResults = restService.getIssuesFromJqlSearch("project = \"TESTPROJECT\"", 3);
+        final List<Issue> searchResults =
+                restService.getIssuesFromJqlSearch("project = \"TESTPROJECT\"", JiraSite.DEFAULT_MAX_ISSUES);
         for (Issue searchResult : searchResults) {
             System.out.println("JQL search result: " + searchResult);
         }
@@ -104,8 +104,8 @@ public static void main(String[] args) throws Exception {
 
     private static void callUniq(final JiraRestService restService) throws Exception {
         long start = System.currentTimeMillis();
-        List<Issue> issues =
-                restService.getIssuesFromJqlSearch("key in ('JENKINS-53320','JENKINS-51057')", JiraSession.MAX_ISSUES);
+        List<Issue> issues = restService.getIssuesFromJqlSearch(
+                "key in ('JENKINS-53320','JENKINS-51057')", JiraSite.DEFAULT_MAX_ISSUES);
         long end = System.currentTimeMillis();
         System.out.println("time uniq " + (end - start));
     }
@@ -114,7 +114,7 @@ private static void callDuplicate(final JiraRestService restService) throws Exce
         long start = System.currentTimeMillis();
         List<Issue> issues = restService.getIssuesFromJqlSearch(
                 "key in ('JENKINS-53320','JENKINS-53320','JENKINS-53320','JENKINS-53320','JENKINS-53320','JENKINS-51057','JENKINS-51057','JENKINS-51057','JENKINS-51057','JENKINS-51057')",
-                JiraSession.MAX_ISSUES);
+                JiraSite.DEFAULT_MAX_ISSUES);
         long end = System.currentTimeMillis();
         System.out.println("time duplicate " + (end - start));
     }

src/test/java/hudson/plugins/jira/ChangingWorkflowTest.java

@@ -59,7 +59,7 @@ public class ChangingWorkflowTest {
 
     @BeforeEach
     void setupSpy() {
-        spySession = spy(new JiraSession(site, restService));
+        spySession = spy(new JiraSession(site, restService, site.getMaxIssuesFromJqlSearch()));
     }
 
     @Test

src/test/java/hudson/plugins/jira/DescriptorImplTest.java

@@ -138,6 +138,7 @@ void validateFormConnectionErrors(JenkinsRule r) throws Exception {
                 JiraSite.DEFAULT_READ_TIMEOUT,
                 JiraSite.DEFAULT_THREAD_EXECUTOR_NUMBER,
                 false,
+                JiraSite.DEFAULT_MAX_ISSUES,
                 project);
 
         assertEquals(FormValidation.Kind.ERROR, validation.kind);
@@ -154,6 +155,7 @@ void validateFormConnectionErrors(JenkinsRule r) throws Exception {
                 JiraSite.DEFAULT_READ_TIMEOUT,
                 JiraSite.DEFAULT_THREAD_EXECUTOR_NUMBER,
                 false,
+                JiraSite.DEFAULT_MAX_ISSUES,
                 project);
         assertEquals(Messages.JiraSite_timeoutMinimunValue("1"), validation.getLocalizedMessage());
         assertEquals(FormValidation.Kind.ERROR, validation.kind);
@@ -170,6 +172,7 @@ void validateFormConnectionErrors(JenkinsRule r) throws Exception {
                 -1,
                 JiraSite.DEFAULT_THREAD_EXECUTOR_NUMBER,
                 false,
+                JiraSite.DEFAULT_MAX_ISSUES,
                 project);
 
         assertEquals(Messages.JiraSite_readTimeoutMinimunValue("1"), validation.getMessage());
@@ -187,6 +190,7 @@ void validateFormConnectionErrors(JenkinsRule r) throws Exception {
                 JiraSite.DEFAULT_READ_TIMEOUT,
                 -1,
                 false,
+                JiraSite.DEFAULT_MAX_ISSUES,
                 project);
         assertEquals(Messages.JiraSite_threadExecutorMinimunSize("1"), validation.getMessage());
         assertEquals(FormValidation.Kind.ERROR, validation.kind);
@@ -213,6 +217,7 @@ void validateFormConnectionOK(JenkinsRule r) throws Exception {
                 JiraSite.DEFAULT_READ_TIMEOUT,
                 JiraSite.DEFAULT_THREAD_EXECUTOR_NUMBER,
                 false,
+                JiraSite.DEFAULT_MAX_ISSUES,
                 project);
 
         verify(builder).build();