Added more tests; Updated docs

Author: hiranya911

FirebaseAdmin/FirebaseAdmin.Tests/Auth/FirebaseUserManagerTest.cs

@@ -331,15 +331,17 @@ public async Task ListUsers()
             while (await enumerator.MoveNext())
             {
                 users.Add(enumerator.Current);
+                if (users.Count % 3 == 0)
+                {
+                    Assert.Equal(users.Count / 3, handler.Requests.Count);
+                }
             }
 
             Assert.Equal(6, users.Count);
-            Assert.Equal("user1", users[0].Uid);
-            Assert.Equal("user2", users[1].Uid);
-            Assert.Equal("user3", users[2].Uid);
-            Assert.Equal("user4", users[3].Uid);
-            Assert.Equal("user5", users[4].Uid);
-            Assert.Equal("user6", users[5].Uid);
+            for (int i = 0; i < 6; i++)
+            {
+                Assert.Equal($"user{i + 1}", users[i].Uid);
+            }
 
             Assert.Equal(2, handler.Requests.Count);
             var query = this.ExtractQueryParams(handler.Requests[0]);
@@ -363,8 +365,7 @@ public void ListUsersForEach()
             var users = new List<ExportedUserRecord>();
 
             var pagedEnumerable = userManager.ListUsers(null);
-            var enumerator = pagedEnumerable.ToEnumerable();
-            foreach (var user in enumerator)
+            foreach (var user in pagedEnumerable.ToEnumerable())
             {
                 users.Add(user);
                 if (users.Count % 3 == 0)
@@ -374,12 +375,10 @@ public void ListUsersForEach()
             }
 
             Assert.Equal(6, users.Count);
-            Assert.Equal("user1", users[0].Uid);
-            Assert.Equal("user2", users[1].Uid);
-            Assert.Equal("user3", users[2].Uid);
-            Assert.Equal("user4", users[3].Uid);
-            Assert.Equal("user5", users[4].Uid);
-            Assert.Equal("user6", users[5].Uid);
+            for (int i = 0; i < 6; i++)
+            {
+                Assert.Equal($"user{i + 1}", users[i].Uid);
+            }
 
             Assert.Equal(2, handler.Requests.Count);
             var query = this.ExtractQueryParams(handler.Requests[0]);
@@ -414,12 +413,10 @@ public void ListUsersCustomOptions()
             }
 
             Assert.Equal(6, users.Count);
-            Assert.Equal("user1", users[0].Uid);
-            Assert.Equal("user2", users[1].Uid);
-            Assert.Equal("user3", users[2].Uid);
-            Assert.Equal("user4", users[3].Uid);
-            Assert.Equal("user5", users[4].Uid);
-            Assert.Equal("user6", users[5].Uid);
+            for (int i = 0; i < 6; i++)
+            {
+                Assert.Equal($"user{i + 1}", users[i].Uid);
+            }
 
             Assert.Equal(2, handler.Requests.Count);
             var query = this.ExtractQueryParams(handler.Requests[0]);
@@ -434,7 +431,7 @@ public void ListUsersCustomOptions()
         }
 
         [Fact]
-        public async Task ListUsersPage()
+        public async Task ListUsersReadPage()
         {
             var handler = new MockMessageHandler()
             {
@@ -446,27 +443,75 @@ public async Task ListUsersPage()
             };
             var userManager = this.CreateFirebaseUserManager(handler);
 
+            // Retrieve a page of users.
             var pagedEnumerable = userManager.ListUsers(null);
-            for (int i = 0; i < 2; i++)
-            {
-                var userPage = await pagedEnumerable.ReadPageAsync(3);
+            var userPage = await pagedEnumerable.ReadPageAsync(3);
 
-                Assert.Equal("token", userPage.NextPageToken);
-                Assert.Equal(3, userPage.Count());
-            }
+            Assert.Equal("token", userPage.NextPageToken);
+            Assert.Equal(3, userPage.Count());
+            Assert.Equal(1, handler.Requests.Count);
+            var query = this.ExtractQueryParams(handler.Requests[0]);
+            Assert.Single(query);
+            Assert.Equal("3", query["maxResults"]);
 
+            // Retrieve the same page of users again.
+            userPage = await pagedEnumerable.ReadPageAsync(3);
+
+            Assert.Equal("token", userPage.NextPageToken);
+            Assert.Equal(3, userPage.Count());
             Assert.Equal(2, handler.Requests.Count);
+            query = this.ExtractQueryParams(handler.Requests[1]);
+            Assert.Single(query);
+            Assert.Equal("3", query["maxResults"]);
+        }
+
+        [Fact]
+        public async Task ListUsersByPages()
+        {
+            var handler = new MockMessageHandler()
+            {
+                Response = ListUsersResponse,
+            };
+            var userManager = this.CreateFirebaseUserManager(handler);
+            var users = new List<ExportedUserRecord>();
+
+            // Read page 1.
+            var pagedEnumerable = userManager.ListUsers(null);
+            var userPage = await pagedEnumerable.ReadPageAsync(3);
+
+            Assert.Equal(3, userPage.Count());
+            Assert.Equal("token", userPage.NextPageToken);
+            Assert.Single(handler.Requests);
             var query = this.ExtractQueryParams(handler.Requests[0]);
             Assert.Single(query);
             Assert.Equal("3", query["maxResults"]);
+            users.AddRange(userPage);
+
+            // Read page 2.
+            pagedEnumerable = userManager.ListUsers(new ListUsersOptions()
+            {
+                PageToken = userPage.NextPageToken,
+            });
+            userPage = await pagedEnumerable.ReadPageAsync(3);
 
+            Assert.Equal(3, userPage.Count());
+            Assert.Null(userPage.NextPageToken);
+            Assert.Equal(2, handler.Requests.Count);
             query = this.ExtractQueryParams(handler.Requests[1]);
-            Assert.Single(query);
+            Assert.Equal(2, query.Count);
             Assert.Equal("3", query["maxResults"]);
+            Assert.Equal("token", query["nextPageToken"]);
+            users.AddRange(userPage);
+
+            Assert.Equal(6, users.Count);
+            for (int i = 0; i < 6; i++)
+            {
+                Assert.Equal($"user{i + 1}", users[i].Uid);
+            }
         }
 
         [Fact]
-        public async Task ListUsersPageMultipleCalls()
+        public async Task ListUsersReadLargePageSize()
         {
             var handler = new MockMessageHandler()
             {
@@ -479,7 +524,6 @@ public async Task ListUsersPageMultipleCalls()
 
             Assert.Null(userPage.NextPageToken);
             Assert.Equal(6, userPage.Count());
-
             Assert.Equal(2, handler.Requests.Count);
             var query = this.ExtractQueryParams(handler.Requests[0]);
             Assert.Single(query);
@@ -516,12 +560,10 @@ public async Task ListUsersAsRawResponses()
             Assert.Null(tokens[1]);
 
             Assert.Equal(6, users.Count);
-            Assert.Equal("user1", users[0].Uid);
-            Assert.Equal("user2", users[1].Uid);
-            Assert.Equal("user3", users[2].Uid);
-            Assert.Equal("user4", users[3].Uid);
-            Assert.Equal("user5", users[4].Uid);
-            Assert.Equal("user6", users[5].Uid);
+            for (int i = 0; i < 6; i++)
+            {
+                Assert.Equal($"user{i + 1}", users[i].Uid);
+            }
 
             Assert.Equal(2, handler.Requests.Count);
             var query = this.ExtractQueryParams(handler.Requests[0]);
@@ -573,7 +615,7 @@ public void ListUsersPageSizeTooSmall()
         }
 
         [Fact]
-        public void ListUsersStartingPageTokenEmpty()
+        public void ListUsersPageTokenEmpty()
         {
             var handler = new MockMessageHandler()
             {

FirebaseAdmin/FirebaseAdmin/Auth/ListUsersPageManager.cs

@@ -18,7 +18,7 @@
 namespace FirebaseAdmin.Auth
 {
     /// <summary>
-    /// Utility for paging through user accounts in the Google API client.
+    /// Utility for paging through user accounts using the Google API client.
     /// </summary>
     internal sealed class ListUsersPageManager
     : IPageManager<ListUsersRequest, ExportedUserRecords, ExportedUserRecord>

FirebaseAdmin/FirebaseAdmin/Auth/ListUsersRequest.cs

@@ -38,13 +38,13 @@ internal sealed class ListUsersRequest : IClientServiceRequest<ExportedUserRecor
         private readonly HttpClient httpClient;
 
         private ListUsersRequest(
-            string baseUrl, HttpClient httpClient, ListUsersOptions options = null)
+            string baseUrl, HttpClient httpClient, ListUsersOptions options)
         {
             this.baseUrl = baseUrl;
             this.httpClient = httpClient;
             this.RequestParameters = new Dictionary<string, IParameter>();
-            this.SetPageSize(options?.PageSize ?? MaxListUsersResults);
-            var pageToken = options?.PageToken;
+            this.SetPageSize(options.PageSize ?? MaxListUsersResults);
+            var pageToken = options.PageToken;
             if (pageToken != null)
             {
                 this.SetPageToken(pageToken);
@@ -200,6 +200,10 @@ private async Task<HttpResponseMessage> SendAsync(
                 .ConfigureAwait(false);
         }
 
+        /// <summary>
+        /// Factory class that validates arguments, and then creates new instances of the
+        /// <see cref="ListUsersRequest"/> class.
+        /// </summary>
         internal class Factory
         {
             private readonly string baseUrl;
@@ -223,7 +227,7 @@ internal Factory(
                 }
                 else if (this.options.PageSize <= 0)
                 {
-                    throw new ArgumentException("Page size must be a positive integer.");
+                    throw new ArgumentException("Page size must be positive.");
                 }
                 else if (this.options.PageToken == string.Empty)
                 {