More error handling and tests

Author: hiranya911

FirebaseAdmin/FirebaseAdmin.Tests/Auth/FirebaseUserManagerTest.cs

@@ -317,6 +317,82 @@ public async Task GetUserByPhoneNumberEmpty()
             await Assert.ThrowsAsync<ArgumentException>(() => userManager.GetUserByPhoneNumberAsync(string.Empty));
         }
 
+        [Fact]
+        public void ListUsers()
+        {
+            var handler = new MockMessageHandler()
+            {
+                Response = ListUsersResponse,
+            };
+            var userManager = this.CreateFirebaseUserManager(handler);
+            var users = new List<ExportedUserRecord>();
+
+            var pagedEnumerable = userManager.ListUsers(null);
+            foreach (var user in pagedEnumerable.ToEnumerable())
+            {
+                users.Add(user);
+            }
+
+            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);
+
+            Assert.Equal(2, handler.Requests.Count);
+            var query = this.ExtractQueryParams(handler.Requests[0]);
+            Assert.Single(query);
+            Assert.Equal("1000", query["maxResults"]);
+
+            query = this.ExtractQueryParams(handler.Requests[1]);
+            Assert.Equal(2, query.Count);
+            Assert.Equal("1000", query["maxResults"]);
+            Assert.Equal("token", query["nextPageToken"]);
+        }
+
+        [Fact]
+        public void ListUsersCustomOptions()
+        {
+            var handler = new MockMessageHandler()
+            {
+                Response = ListUsersResponse,
+            };
+            var userManager = this.CreateFirebaseUserManager(handler);
+            var users = new List<ExportedUserRecord>();
+            var customOptions = new ListUsersOptions()
+            {
+                PageSize = 3,
+                PageToken = "custom-token",
+            };
+
+            var pagedEnumerable = userManager.ListUsers(customOptions);
+            foreach (var user in pagedEnumerable.ToEnumerable())
+            {
+                users.Add(user);
+            }
+
+            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);
+
+            Assert.Equal(2, handler.Requests.Count);
+            var query = this.ExtractQueryParams(handler.Requests[0]);
+            Assert.Equal(2, query.Count);
+            Assert.Equal("3", query["maxResults"]);
+            Assert.Equal("custom-token", query["nextPageToken"]);
+
+            query = this.ExtractQueryParams(handler.Requests[1]);
+            Assert.Equal(2, query.Count);
+            Assert.Equal("3", query["maxResults"]);
+            Assert.Equal("token", query["nextPageToken"]);
+        }
+
         [Fact]
         public async Task ListUsersPaged()
         {
@@ -327,12 +403,10 @@ public async Task ListUsersPaged()
             var userManager = this.CreateFirebaseUserManager(handler);
             var users = new List<ExportedUserRecord>();
             var tokens = new List<string>();
-            var pageCounter = 0;
 
             var pagedEnumerable = userManager.ListUsers(new ListUsersOptions());
             for (Page<ExportedUserRecord> userPage; (userPage = await pagedEnumerable.ReadPageAsync(3)) != null;)
             {
-                pageCounter++;
                 tokens.Add(userPage.NextPageToken);
                 users.AddRange(userPage);
                 if (userPage.NextPageToken == null)
@@ -341,10 +415,11 @@ public async Task ListUsersPaged()
                 }
             }
 
-            Assert.Equal(2, pageCounter);
-            Assert.Equal(6, users.Count);
+            Assert.Equal(2, tokens.Count);
             Assert.Equal("token", tokens[0]);
             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);
@@ -364,21 +439,28 @@ public async Task ListUsersPaged()
         }
 
         [Fact]
-        public void ListUsersByEntries()
+        public void ListUsersAsRawResponses()
         {
             var handler = new MockMessageHandler()
             {
                 Response = ListUsersResponse,
             };
             var userManager = this.CreateFirebaseUserManager(handler);
             var users = new List<ExportedUserRecord>();
+            var tokens = new List<string>();
 
             var pagedEnumerable = userManager.ListUsers(null);
-            foreach (var user in pagedEnumerable.ToEnumerable())
+            var responses = pagedEnumerable.AsRawResponses();
+            foreach (var records in responses.ToEnumerable())
             {
-                users.Add(user);
+                users.AddRange(records.Users);
+                tokens.Add(records.NextPageToken);
             }
 
+            Assert.Equal(2, tokens.Count);
+            Assert.Equal("token", tokens[0]);
+            Assert.Null(tokens[1]);
+
             Assert.Equal(6, users.Count);
             Assert.Equal("user1", users[0].Uid);
             Assert.Equal("user2", users[1].Uid);
@@ -416,24 +498,28 @@ public void ListUsersPageSizeTooLarge()
         }
 
         [Fact]
-        public void ListUsersPageSizeZero()
+        public void ListUsersPageSizeTooSmall()
         {
             var handler = new MockMessageHandler()
             {
                 Response = ListUsersResponse,
             };
             var userManager = this.CreateFirebaseUserManager(handler);
-            var options = new ListUsersOptions()
+
+            foreach (var pageSize in new int[] { 0, -1 })
             {
-                PageSize = 0,
-            };
+                var options = new ListUsersOptions()
+                {
+                    PageSize = pageSize,
+                };
 
-            Assert.Throws<ArgumentException>(() => userManager.ListUsers(options));
-            Assert.Empty(handler.Requests);
+                Assert.Throws<ArgumentException>(() => userManager.ListUsers(options));
+                Assert.Empty(handler.Requests);
+            }
         }
 
         [Fact]
-        public void ListUsersPageSizeNegative()
+        public void ListUsersStartingPageTokenEmpty()
         {
             var handler = new MockMessageHandler()
             {
@@ -442,114 +528,58 @@ public void ListUsersPageSizeNegative()
             var userManager = this.CreateFirebaseUserManager(handler);
             var options = new ListUsersOptions()
             {
-                PageSize = -1,
+                PageToken = string.Empty,
             };
 
             Assert.Throws<ArgumentException>(() => userManager.ListUsers(options));
             Assert.Empty(handler.Requests);
         }
 
         [Fact]
-        public void ListUsersAsRawResponses()
+        public async Task ListUsersHttpError()
         {
             var handler = new MockMessageHandler()
             {
-                Response = ListUsersResponse,
+                StatusCode = HttpStatusCode.InternalServerError,
             };
             var userManager = this.CreateFirebaseUserManager(handler);
-            var users = new List<ExportedUserRecord>();
 
             var pagedEnumerable = userManager.ListUsers(null);
-            var responses = pagedEnumerable.AsRawResponses();
-            foreach (var records in responses.ToEnumerable())
-            {
-                users.AddRange(records.Users);
-            }
+            await Assert.ThrowsAsync<FirebaseException>(async () => await pagedEnumerable.First());
 
-            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);
-
-            Assert.Equal(2, handler.Requests.Count);
+            Assert.Single(handler.Requests);
             var query = this.ExtractQueryParams(handler.Requests[0]);
             Assert.Single(query);
             Assert.Equal("1000", query["maxResults"]);
-
-            query = this.ExtractQueryParams(handler.Requests[1]);
-            Assert.Equal(2, query.Count);
-            Assert.Equal("1000", query["maxResults"]);
-            Assert.Equal("token", query["nextPageToken"]);
         }
 
         [Fact]
-        public async Task ListUsers()
+        public async Task ListUsersIntermittentHttpError()
         {
-            var nextPageToken = Guid.NewGuid().ToString();
             var handler = new MockMessageHandler()
             {
-                Response = new DownloadAccountResponse()
-                {
-                    NextPageToken = nextPageToken,
-                    Users = new List<GetAccountInfoResponse.User>()
-                    {
-                        new GetAccountInfoResponse.User() { UserId = "user1" },
-                        new GetAccountInfoResponse.User() { UserId = "user2" },
-                        new GetAccountInfoResponse.User() { UserId = "user3" },
-                    },
-                },
+                Response = ListUsersResponse,
             };
             var userManager = this.CreateFirebaseUserManager(handler);
+            var users = new List<ExportedUserRecord>();
 
-            var pagedEnumerable = userManager.ListUsers(new ListUsersOptions());
-            var usersPage = await pagedEnumerable.ReadPageAsync(3);
+            var pagedEnumerable = userManager.ListUsers(null);
+            var page = await pagedEnumerable.ReadPageAsync(3);
+            Assert.Equal(3, page.Count());
 
-            var userRecords = usersPage.ToList();
-            Assert.Equal(nextPageToken, usersPage.NextPageToken);
-            Assert.Equal(3, userRecords.Count);
-            Assert.Equal("user1", userRecords[0].Uid);
-            Assert.Equal("user2", userRecords[1].Uid);
-            Assert.Equal("user3", userRecords[2].Uid);
+            handler.StatusCode = HttpStatusCode.InternalServerError;
+            await Assert.ThrowsAsync<FirebaseException>(
+                async () => await pagedEnumerable.ReadPageAsync(3));
 
-            Assert.Single(handler.Requests);
+            Assert.Equal(2, handler.Requests.Count);
             var query = this.ExtractQueryParams(handler.Requests[0]);
             Assert.Single(query);
             Assert.Equal("3", query["maxResults"]);
-        }
-
-        [Fact]
-        public void ListUsersMaxDefault()
-        {
-            var nextPageToken = Guid.NewGuid().ToString();
-            var handler = new MockMessageHandler()
-            {
-                Response = new DownloadAccountResponse()
-                {
-                    Users = new List<GetAccountInfoResponse.User>()
-                    {
-                        new GetAccountInfoResponse.User() { UserId = "user1" },
-                        new GetAccountInfoResponse.User() { UserId = "user2" },
-                        new GetAccountInfoResponse.User() { UserId = "user3" },
-                    },
-                },
-            };
-            var userManager = this.CreateFirebaseUserManager(handler);
-
-            var pagedEnumerable = userManager.ListUsers(new ListUsersOptions());
-            var userRecords = pagedEnumerable.ToEnumerable().ToList();
 
-            Assert.Equal(3, userRecords.Count);
-            Assert.Equal("user1", userRecords[0].Uid);
-            Assert.Equal("user2", userRecords[1].Uid);
-            Assert.Equal("user3", userRecords[2].Uid);
-            Assert.Single(handler.Requests);
-
-            var query = this.ExtractQueryParams(handler.Requests[0]);
-            Assert.Single(query);
-            Assert.Equal("1000", query["maxResults"]);
+            query = this.ExtractQueryParams(handler.Requests[1]);
+            Assert.Equal(2, query.Count);
+            Assert.Equal("3", query["maxResults"]);
+            Assert.Equal("token", query["nextPageToken"]);
         }
 
         [Fact]

FirebaseAdmin/FirebaseAdmin/Auth/FirebaseAuth.cs

@@ -528,7 +528,8 @@ public async Task SetCustomUserClaimsAsync(
         /// <summary>
         /// Gets an async enumerable to iterate or page through users starting from the specified
         /// page token. If the page token is null or unspecified, iteration starts from the first
-        /// page.
+        /// page. See <a href="https://googleapis.github.io/google-cloud-dotnet/docs/guides/page-streaming.html">
+        /// Page Streaming</a> for more details on how to use this API.
         /// </summary>
         /// <param name="options">The options to control the starting point and page size.</param>
         /// <returns>A <see cref="PagedAsyncEnumerable{ExportedUserRecords, ExportedUserRecord}"/> instance.</returns>

FirebaseAdmin/FirebaseAdmin/Auth/ListUsersRequest.cs

@@ -46,7 +46,12 @@ internal ListUsersRequest(string baseUrl, HttpClient httpClient, ListUsersOption
             this.options = new ListUsersOptions(options);
             this.RequestParameters = new Dictionary<string, IParameter>();
             this.SetPageSize(this.options.PageSize ?? MaxListUsersResults);
-            if (!string.IsNullOrEmpty(this.options.PageToken))
+
+            if (this.options.PageToken == string.Empty)
+            {
+                throw new ArgumentException("Starting page token must not be empty.");
+            }
+            else if (this.options.PageToken != null)
             {
                 this.SetPageToken(this.options.PageToken);
             }