[JENKINS-71749] Add stable order when searching for repositories in GH organization (#907)

When scanning the organization, repositories are obtained using search GH API. If using pagination a non stable sort order would be used leading to potentially duplicate listings and missing entries.

Provide a stable sort order and eagerly fetch the results.

Author: vanta

src/main/java/org/jenkinsci/plugins/github_branch_source/GitHubSCMNavigator.java

@@ -65,6 +65,8 @@
 import java.util.Set;
 import java.util.logging.Level;
 import java.util.logging.Logger;
+import java.util.stream.Collectors;
+import java.util.stream.StreamSupport;
 import jenkins.model.Jenkins;
 import jenkins.plugins.git.traits.GitBrowserSCMSourceTrait;
 import jenkins.scm.api.SCMNavigator;
@@ -1134,8 +1136,25 @@ public void visitSources(SCMSourceObserver observer) throws IOException, Interru
                     } else {
                         repositories = org.listRepositories(100);
                     }
+
+                    List<String> repoList = StreamSupport.stream(repositories.spliterator(), false)
+                            .map(GHRepository::getName)
+                            .collect(Collectors.toList());
+
+                    String repoString = String.join(",", repoList);
+
+                    listener.getLogger()
+                            .println(GitHubConsoleNote.create(
+                                    System.currentTimeMillis(),
+                                    String.format("Found %d repositories: %s", repoList.size(), repoString)));
+
                     for (GHRepository repo : repositories) {
                         try {
+                            listener.getLogger()
+                                    .println(GitHubConsoleNote.create(
+                                            System.currentTimeMillis(),
+                                            String.format("Processing repository: %s", repo.getName())));
+
                             if (repo.isArchived() && gitHubSCMNavigatorContext.isExcludeArchivedRepositories()) {
                                 // exclude archived repositories
                                 witness.record(repo.getName(), false);
@@ -1306,7 +1325,8 @@ private Iterable<GHRepository> searchRepositories(final GitHub github, final Git
         if (!context.isExcludeForkedRepositories()) {
             ghRepositorySearchBuilder.q("fork:true");
         }
-        return ghRepositorySearchBuilder.list().withPageSize(100);
+        ghRepositorySearchBuilder.q("sort:name-asc");
+        return ghRepositorySearchBuilder.list().withPageSize(100).asList();
     }
 
     private GHOrganization getGhOrganization(final GitHub github) throws IOException {

src/test/resources/api/mappings/mapping-search-repositories-based-on-topics-O8W78.json

@@ -8,7 +8,7 @@
     },
     "queryParameters" : {
       "q" : {
-        "equalTo" : "topic:cool topic:great topic:was-awesome org:stephenc fork:true"
+        "equalTo" : "topic:cool topic:great topic:was-awesome org:stephenc fork:true sort:name-asc"
       }
     }
   },

src/test/resources/api/mappings/mapping-search-repositories-based-on-topics-api-O8W78-exclude-forks.json

@@ -8,7 +8,7 @@
     },
     "queryParameters" : {
       "q" : {
-        "equalTo" : "topic:api org:stephenc"
+        "equalTo" : "topic:api org:stephenc sort:name-asc"
       }
     }
   },

src/test/resources/api/mappings/mapping-search-repositories-based-on-topics-awesome-O8W78.json

@@ -8,7 +8,7 @@
     },
     "queryParameters" : {
       "q" : {
-        "equalTo" : "topic:awesome org:stephenc fork:true"
+        "equalTo" : "topic:awesome org:stephenc fork:true sort:name-asc"
       }
     }
   },

src/test/resources/api/mappings/mapping-search-repositories-based-on-topics-exclude-awesome-O8W78.json

@@ -8,7 +8,7 @@
     },
     "queryParameters" : {
       "q" : {
-        "equalTo" : "-topic:awesome org:stephenc fork:true"
+        "equalTo" : "-topic:awesome org:stephenc fork:true sort:name-asc"
       }
     }
   },

src/test/resources/api/mappings/mapping-search-repositories-based-on-topics-nope-O8W78.json

@@ -8,7 +8,7 @@
     },
     "queryParameters" : {
       "q" : {
-        "equalTo" : "topic:nope org:stephenc fork:true"
+        "equalTo" : "topic:nope org:stephenc fork:true sort:name-asc"
       }
     }
   },

src/test/resources/api/mappings/mapping-search-repositories-based-on-topics-octocat-exclude-awesome-O8W78.json

@@ -8,7 +8,7 @@
     },
     "queryParameters" : {
       "q" : {
-        "equalTo" : "-topic:awesome topic:octocat org:stephenc fork:true"
+        "equalTo" : "-topic:awesome topic:octocat org:stephenc fork:true sort:name-asc"
       }
     }
   },