www

commit cb5e1fa431378e88fa2d0e136c46191af6288bc0
parent a9dda10a7dbd2f8a1834d56606fed750edf2013a
Author: Dan Stillman <dstillman@zotero.org>
Date:   Fri, 24 Feb 2017 18:41:37 -0500

Handle paginated results in Zotero.Sync.APIClient.getGroups()

Diffstat:
M
chrome/content/zotero/xpcom/sync/syncAPIClient.js
 | 
9
++++++---
M
test/tests/syncAPIClientTest.js
 | 
68
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++

2 files changed, 74 insertions(+), 3 deletions(-)
diff --git a/chrome/content/zotero/xpcom/sync/syncAPIClient.js b/chrome/content/zotero/xpcom/sync/syncAPIClient.js
@@ -83,10 +83,13 @@ Zotero.Sync.APIClient.prototype = {
 	 */	
 	getGroups: Zotero.Promise.coroutine(function* (userID) {
 		if (!userID) throw new Error("User ID not provided");
-
+		
 		var uri = this.baseURL + "users/" + userID + "/groups";
-		var xmlhttp = yield this.makeRequest("GET", uri);
-		return this._parseJSON(xmlhttp.responseText);
+		return yield this.getPaginatedResults(
+			uri,
+			(previous, xmlhttp, restart) => [...previous, ...this._parseJSON(xmlhttp.responseText)],
+			[]
+		);
 	}),
 	
 	
diff --git a/test/tests/syncAPIClientTest.js b/test/tests/syncAPIClientTest.js
@@ -81,4 +81,72 @@ describe("Zotero.Sync.APIClient", function () {
 			assert.equal(e.message, Zotero.getString('sync.error.checkConnection'));
 		})
 	})
+	
+	describe("#getGroups()", function () {
+		it("should automatically fetch multiple pages of results", function* () {
+			function groupJSON(groupID) {
+				return {
+					id: groupID,
+					version: 1,
+					data: {
+						id: groupID,
+						version: 1,
+						name: "Group " + groupID
+					}
+				};
+			}
+			
+			server.respond(function (req) {
+				if (req.method == "GET" && req.url.startsWith(baseURL + "users/1/groups")) {
+					// TODO: Use a real parser
+					let matches = req.url.match(/start=(\d+)/);
+					let start = matches ? parseInt(matches[1]) : null;
+					matches = req.url.match(/limit=(\d+)/);
+					let limit = matches ? parseInt(matches[1]) : null;
+					if (start === null && limit === null) {
+						req.respond(
+							200,
+							{
+								Link: `<${baseURL}users/1/groups?limit=2&start=2>; rel="next", <${baseURL}users/1/groups?limit=2&start=4>; rel="last", <${baseURL}users/1/groups>; rel="alternate"`,
+								"Total-Results": 2
+							},
+							JSON.stringify([
+								groupJSON(1),
+								groupJSON(2)
+							])
+						);
+					}
+					else if (start == 2 && limit == 2) {
+						req.respond(
+							200,
+							{
+								Link: `<${baseURL}users/1/groups?limit=2&start=4>; rel="next", <${baseURL}users/1/groups?limit=2&start=4>; rel="last", <${baseURL}users/1/groups>; rel="alternate"`,
+								"Total-Results": 5
+							},
+							JSON.stringify([
+								groupJSON(3),
+								groupJSON(4)
+							])
+						);
+					}
+					else if (start == 4 && limit == 2) {
+						req.respond(
+							200,
+							{
+								Link: `<${baseURL}users/1/groups?limit=2&start=4>; rel="last", <${baseURL}users/1/groups>; rel="alternate"`,
+								"Total-Results": 5
+							},
+							JSON.stringify([
+								groupJSON(5),
+							])
+						);
+					}
+				}
+			});
+			
+			var results = yield client.getGroups(1);
+			assert.lengthOf(results, 5);
+			assert.sameMembers(results.map(o => o.id), [1, 2, 3, 4, 5]);
+		});
+	});
 })