Add pagination logic when checking for versions (#1)

* Add pagination logic when checking for versions This prevents older versions from no longer being considered installable if they are on page2+ of the github releases API.
arduino · Jul 29, 2020 · dd1eeb5 · dd1eeb5
1 parent 7ad700d
commit dd1eeb5
Show file tree

Hide file tree

Showing 16 changed files with 40,915 additions and 20,937 deletions.
diff --git a/__tests__/main.test.ts b/__tests__/main.test.ts
@@ -49,8 +49,17 @@ describe("installer tests", () => {
   describe("Gets the latest release of protoc", () => {
     beforeEach(() => {
       nock("https://api.github.com")
-        .get("/repos/protocolbuffers/protobuf/releases")
-        .replyWithFile(200, path.join(dataDir, "releases.json"));
+        .get("/repos/protocolbuffers/protobuf/releases?page=1")
+        .replyWithFile(200, path.join(dataDir, "releases-1.json"));
+
+      nock("https://api.github.com")
+      .get("/repos/protocolbuffers/protobuf/releases?page=2")
+      .replyWithFile(200, path.join(dataDir, "releases-2.json"));
+
+
+      nock("https://api.github.com")
+      .get("/repos/protocolbuffers/protobuf/releases?page=3")
+      .replyWithFile(200, path.join(dataDir, "releases-3.json"));
     });
 
     afterEach(() => {
@@ -74,7 +83,7 @@ describe("installer tests", () => {
 
     it("Gets latest version of protoc using 3.x and no matching version is installed", async () => {
       await installer.getProtoc("3.x", true, GITHUB_TOKEN);
-      const protocDir = path.join(toolDir, "protoc", "3.9.1", os.arch());
+      const protocDir = path.join(toolDir, "protoc", "3.12.4", os.arch());
 
       expect(fs.existsSync(`${protocDir}.complete`)).toBe(true);
       if (IS_WINDOWS) {
@@ -90,9 +99,18 @@ describe("installer tests", () => {
   describe("Gets the latest release of protoc with broken latest rc tag", () => {
     beforeEach(() => {
       nock("https://api.github.com")
-        .get("/repos/protocolbuffers/protobuf/releases")
+        .get("/repos/protocolbuffers/protobuf/releases?page=1")
         .replyWithFile(200, path.join(dataDir, "releases-broken-rc-tag.json"));
-    });
+
+        nock("https://api.github.com")
+        .get("/repos/protocolbuffers/protobuf/releases?page=2")
+        .replyWithFile(200, path.join(dataDir, "releases-2.json"));
+
+
+        nock("https://api.github.com")
+        .get("/repos/protocolbuffers/protobuf/releases?page=3")
+        .replyWithFile(200, path.join(dataDir, "releases-3.json"));
+      });
 
     afterEach(() => {
       nock.cleanAll();

diff --git a/__tests__/testdata/releases-1.json b/__tests__/testdata/releases-1.json
diff --git a/__tests__/testdata/releases-2.json b/__tests__/testdata/releases-2.json
diff --git a/__tests__/testdata/releases-3.json b/__tests__/testdata/releases-3.json
@@ -0,0 +1,3 @@
+[
+
+]
diff --git a/__tests__/testdata/releases.json b/__tests__/testdata/releases.json
diff --git a/lib/installer.js b/lib/installer.js
@@ -133,7 +133,16 @@ function fetchVersions(includePreReleases, repoToken) {
         else {
             rest = new restm.RestClient("setup-protoc");
         }
-        let tags = (yield rest.get("https://api.github.com/repos/protocolbuffers/protobuf/releases")).result || [];
+        let tags = [];
+        for (let pageNum = 1, morePages = true; morePages; pageNum++) {
+            let nextPage = (yield rest.get("https://api.github.com/repos/protocolbuffers/protobuf/releases?page=" + pageNum)).result || [];
+            if (nextPage.length > 0) {
+                tags = tags.concat(nextPage);
+            }
+            else {
+                morePages = false;
+            }
+        }
         return tags
             .filter(tag => tag.tag_name.match(/v\d+\.[\w\.]+/g))
             .filter(tag => includePrerelease(tag.prerelease, includePreReleases))

diff --git a/node_modules/@actions/core/package.json b/node_modules/@actions/core/package.json
diff --git a/node_modules/@actions/exec/package.json b/node_modules/@actions/exec/package.json
diff --git a/node_modules/@actions/io/package.json b/node_modules/@actions/io/package.json
diff --git a/node_modules/@actions/tool-cache/package.json b/node_modules/@actions/tool-cache/package.json
diff --git a/node_modules/semver/package.json b/node_modules/semver/package.json
diff --git a/node_modules/tunnel/package.json b/node_modules/tunnel/package.json
diff --git a/node_modules/typed-rest-client/package.json b/node_modules/typed-rest-client/package.json
diff --git a/node_modules/underscore/package.json b/node_modules/underscore/package.json
diff --git a/node_modules/uuid/package.json b/node_modules/uuid/package.json
diff --git a/src/installer.ts b/src/installer.ts
@@ -149,10 +149,17 @@ async function fetchVersions(
     rest = new restm.RestClient("setup-protoc");
   }
 
-  let tags: IProtocRelease[] =
-    (await rest.get<IProtocRelease[]>(
-      "https://api.github.com/repos/protocolbuffers/protobuf/releases"
+  let tags: IProtocRelease[] = [];
+  for (let pageNum=1,morePages=true; morePages; pageNum++) {
+    let nextPage: IProtocRelease[] = (await rest.get<IProtocRelease[]>(
+      "https://api.github.com/repos/protocolbuffers/protobuf/releases?page=" + pageNum
     )).result || [];
+    if (nextPage.length > 0) {
+      tags = tags.concat(nextPage);
+    } else {
+      morePages = false;
+    }
+  }
 
   return tags
     .filter(tag => tag.tag_name.match(/v\d+\.[\w\.]+/g))