Added more tests for list users API

Author: hiranya911

FirebaseAdmin/FirebaseAdmin.Tests/Auth/FirebaseUserManagerTest.cs

@@ -36,6 +36,24 @@ public class FirebaseUserManagerTest
             GoogleCredential.FromAccessToken("test-token");
 
         private static readonly string CreateUserResponse = @"{""localId"": ""user1""}";
+        private static readonly IList<string> ListUsersResponse = new List<string>()
+        {
+            @"{
+                ""nextPageToken"": ""token"",
+                ""users"": [
+                    {""localId"": ""user1""},
+                    {""localId"": ""user2""},
+                    {""localId"": ""user3""}
+                ]
+            }",
+            @"{
+                ""users"": [
+                    {""localId"": ""user4""},
+                    {""localId"": ""user5""},
+                    {""localId"": ""user6""}
+                ]
+            }",
+        };
 
         [Fact]
         public async Task GetUserById()
@@ -304,24 +322,7 @@ public async Task ListUsersPaged()
         {
             var handler = new MockMessageHandler()
             {
-                Response = new List<string>()
-                {
-                    @"{
-                        ""nextPageToken"": ""token"",
-                        ""users"": [
-                            {""localId"": ""user1""},
-                            {""localId"": ""user2""},
-                            {""localId"": ""user3""}
-                        ]
-                    }",
-                    @"{
-                        ""users"": [
-                            {""localId"": ""user4""},
-                            {""localId"": ""user5""},
-                            {""localId"": ""user6""}
-                        ]
-                    }",
-                },
+                Response = ListUsersResponse,
             };
             var userManager = this.CreateFirebaseUserManager(handler);
             var users = new List<ExportedUserRecord>();
@@ -334,7 +335,7 @@ public async Task ListUsersPaged()
                 pageCounter++;
                 tokens.Add(userPage.NextPageToken);
                 users.AddRange(userPage);
-                if (string.IsNullOrEmpty(userPage.NextPageToken))
+                if (userPage.NextPageToken == null)
                 {
                     break;
                 }
@@ -352,15 +353,12 @@ public async Task ListUsersPaged()
             Assert.Equal("user6", users[5].Uid);
 
             Assert.Equal(2, handler.Requests.Count);
-            var req = handler.Requests[0];
-            var query = req.Url.Query.Substring(1).Split('&').ToDictionary(
-                entry => entry.Split('=')[0], entry => entry.Split('=')[1]);
+            var query = this.ExtractQueryParams(handler.Requests[0]);
+            Assert.Single(query);
             Assert.Equal("3", query["maxResults"]);
-            Assert.Equal(string.Empty, query["nextPageToken"]);
 
-            req = handler.Requests[1];
-            query = req.Url.Query.Substring(1).Split('&').ToDictionary(
-                entry => entry.Split('=')[0], entry => entry.Split('=')[1]);
+            query = this.ExtractQueryParams(handler.Requests[1]);
+            Assert.Equal(2, query.Count);
             Assert.Equal("3", query["maxResults"]);
             Assert.Equal("token", query["nextPageToken"]);
         }
@@ -370,29 +368,12 @@ public void ListUsersByEntries()
         {
             var handler = new MockMessageHandler()
             {
-                Response = new List<string>()
-                {
-                    @"{
-                        ""nextPageToken"": ""token"",
-                        ""users"": [
-                            {""localId"": ""user1""},
-                            {""localId"": ""user2""},
-                            {""localId"": ""user3""}
-                        ]
-                    }",
-                    @"{
-                        ""users"": [
-                            {""localId"": ""user4""},
-                            {""localId"": ""user5""},
-                            {""localId"": ""user6""}
-                        ]
-                    }",
-                },
+                Response = ListUsersResponse,
             };
             var userManager = this.CreateFirebaseUserManager(handler);
-
-            var pagedEnumerable = userManager.ListUsers(new ListUsersOptions());
             var users = new List<ExportedUserRecord>();
+
+            var pagedEnumerable = userManager.ListUsers(null);
             foreach (var user in pagedEnumerable.ToEnumerable())
             {
                 users.Add(user);
@@ -407,15 +388,99 @@ public void ListUsersByEntries()
             Assert.Equal("user6", users[5].Uid);
 
             Assert.Equal(2, handler.Requests.Count);
-            var req = handler.Requests[0];
-            var query = req.Url.Query.Substring(1).Split('&').ToDictionary(
-                entry => entry.Split('=')[0], entry => entry.Split('=')[1]);
+            var query = this.ExtractQueryParams(handler.Requests[0]);
+            Assert.Single(query);
             Assert.Equal("1000", query["maxResults"]);
-            Assert.Equal(string.Empty, query["nextPageToken"]);
 
-            req = handler.Requests[1];
-            query = req.Url.Query.Substring(1).Split('&').ToDictionary(
-                entry => entry.Split('=')[0], entry => entry.Split('=')[1]);
+            query = this.ExtractQueryParams(handler.Requests[1]);
+            Assert.Equal(2, query.Count);
+            Assert.Equal("1000", query["maxResults"]);
+            Assert.Equal("token", query["nextPageToken"]);
+        }
+
+        [Fact]
+        public void ListUsersPageSizeTooLarge()
+        {
+            var handler = new MockMessageHandler()
+            {
+                Response = ListUsersResponse,
+            };
+            var userManager = this.CreateFirebaseUserManager(handler);
+            var options = new ListUsersOptions()
+            {
+                PageSize = 1001,
+            };
+
+            Assert.Throws<ArgumentException>(() => userManager.ListUsers(options));
+            Assert.Empty(handler.Requests);
+        }
+
+        [Fact]
+        public void ListUsersPageSizeZero()
+        {
+            var handler = new MockMessageHandler()
+            {
+                Response = ListUsersResponse,
+            };
+            var userManager = this.CreateFirebaseUserManager(handler);
+            var options = new ListUsersOptions()
+            {
+                PageSize = 0,
+            };
+
+            Assert.Throws<ArgumentException>(() => userManager.ListUsers(options));
+            Assert.Empty(handler.Requests);
+        }
+
+        [Fact]
+        public void ListUsersPageSizeNegative()
+        {
+            var handler = new MockMessageHandler()
+            {
+                Response = ListUsersResponse,
+            };
+            var userManager = this.CreateFirebaseUserManager(handler);
+            var options = new ListUsersOptions()
+            {
+                PageSize = -1,
+            };
+
+            Assert.Throws<ArgumentException>(() => userManager.ListUsers(options));
+            Assert.Empty(handler.Requests);
+        }
+
+        [Fact]
+        public void ListUsersAsRawResponses()
+        {
+            var handler = new MockMessageHandler()
+            {
+                Response = ListUsersResponse,
+            };
+            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);
+            }
+
+            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"]);
         }
@@ -450,11 +515,9 @@ public async Task ListUsers()
             Assert.Equal("user3", userRecords[2].Uid);
 
             Assert.Single(handler.Requests);
-            var req = handler.Requests[0];
-            var query = req.Url.Query.Substring(1).Split('&').ToDictionary(
-                entry => entry.Split('=')[0], entry => entry.Split('=')[1]);
+            var query = this.ExtractQueryParams(handler.Requests[0]);
+            Assert.Single(query);
             Assert.Equal("3", query["maxResults"]);
-            Assert.Equal(string.Empty, query["nextPageToken"]);
         }
 
         [Fact]
@@ -484,33 +547,11 @@ public void ListUsersMaxDefault()
             Assert.Equal("user3", userRecords[2].Uid);
             Assert.Single(handler.Requests);
 
-            var req = handler.Requests[0];
-            var query = req.Url.Query.Substring(1).Split('&').ToDictionary(
-                entry => entry.Split('=')[0], entry => entry.Split('=')[1]);
+            var query = this.ExtractQueryParams(handler.Requests[0]);
+            Assert.Single(query);
             Assert.Equal("1000", query["maxResults"]);
-            Assert.Equal(string.Empty, query["nextPageToken"]);
         }
 
-        /* [Fact]
-        public void ListUsersRequestOptionsAreSet()
-        {
-            var userManager = this.CreateFirebaseUserManager(new MockMessageHandler());
-
-            var listUsersRequest = userManager.CreateListUserRequest(new ListUsersOptions());
-
-            // by default they are set
-            Assert.True(listUsersRequest.RequestParameters.ContainsKey("maxResults"));
-            Assert.True(listUsersRequest.RequestParameters.ContainsKey("nextPageToken"));
-            Assert.Equal(FirebaseUserManager.MaxListUsersResults, int.Parse(listUsersRequest.RequestParameters["maxResults"].DefaultValue));
-            Assert.Null(listUsersRequest.RequestParameters["nextPageToken"].DefaultValue);
-
-            // change the values and check again
-            listUsersRequest.SetPageSize(10);
-            listUsersRequest.SetPageToken("theNewNextPageToken");
-            Assert.Equal(10, int.Parse(listUsersRequest.RequestParameters["maxResults"].DefaultValue));
-            Assert.Equal("theNewNextPageToken", listUsersRequest.RequestParameters["nextPageToken"].DefaultValue);
-        } */
-
         [Fact]
         public async Task CreateUser()
         {
@@ -1219,5 +1260,11 @@ private FirebaseUserManager CreateFirebaseUserManager(HttpMessageHandler handler
             };
             return new FirebaseUserManager(args);
         }
+
+        private IDictionary<string, string> ExtractQueryParams(MockMessageHandler.IncomingRequest req)
+        {
+            return req.Url.Query.Substring(1).Split('&').ToDictionary(
+                entry => entry.Split('=')[0], entry => entry.Split('=')[1]);
+        }
     }
 }

FirebaseAdmin/FirebaseAdmin/Auth/FirebaseAuth.cs

@@ -526,15 +526,18 @@ public async Task SetCustomUserClaimsAsync(
         }
 
         /// <summary>
-        /// Gets an async enumerable to page users starting from the specified pageToken. If the pageToken is empty, it starts from the first page.
+        /// 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.
         /// </summary>
-        /// <param name="requestOptions">The options for the next remote call.</param>
-        /// <returns>A <see cref="PagedAsyncEnumerable{DownloadAccountResponse, UserRecord}"/> instance.</returns>
-        public PagedAsyncEnumerable<ExportedUserRecords, ExportedUserRecord> ListUsersAsync(ListUsersOptions requestOptions)
+        /// <param name="options">The options to control the starting point and page size.</param>
+        /// <returns>A <see cref="PagedAsyncEnumerable{ExportedUserRecords, ExportedUserRecord}"/> instance.</returns>
+        public PagedAsyncEnumerable<ExportedUserRecords, ExportedUserRecord> ListUsersAsync(
+            ListUsersOptions options)
         {
             var userManager = this.IfNotDeleted(() => this.userManager.Value);
 
-            return userManager.ListUsers(requestOptions);
+            return userManager.ListUsers(options);
         }
 
         /// <summary>

FirebaseAdmin/FirebaseAdmin/Auth/FirebaseUserManager.cs

@@ -1,4 +1,4 @@
-// Copyright 2019, Google Inc. All rights reserved.
+// Copyright 2019, Google Inc. All rights reserved.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -140,9 +140,9 @@ internal async Task<UserRecord> GetUserByPhoneNumberAsync(
         }
 
         internal PagedAsyncEnumerable<ExportedUserRecords, ExportedUserRecord> ListUsers(
-            ListUsersOptions requestOptions)
+            ListUsersOptions options)
         {
-            var request = new ListUsersRequest(this.baseUrl, this.httpClient, requestOptions);
+            var request = new ListUsersRequest(this.baseUrl, this.httpClient, options);
             return new RestPagedAsyncEnumerable<ListUsersRequest, ExportedUserRecords, ExportedUserRecord>(
                 () => request, new ListUsersPageManager());
         }

FirebaseAdmin/FirebaseAdmin/Auth/ListUsersOptions.cs

@@ -21,17 +21,25 @@ namespace FirebaseAdmin.Auth
     /// </summary>
     public sealed class ListUsersOptions
     {
+        /// <summary>
+        /// Initializes a new instance of the <see cref="ListUsersOptions"/> class.
+        /// </summary>
+        public ListUsersOptions() { }
+
+        internal ListUsersOptions(ListUsersOptions source)
+        {
+            this.PageSize = source?.PageSize;
+            this.PageToken = source?.PageToken;
+        }
+
         /// <summary>
         /// Gets or sets the number of results to return per page. This modifies the per-request page size.
-        /// It does not affect the total number of results returned.
+        /// It does not affect the total number of results returned. Must not exceed 1000.
         /// </summary>
         public int? PageSize { get; set; }
 
         /// <summary>
-        /// Gets or sets the page-token. If set, this token is used to indicate a continued list operation.
-        /// The value should be taken from the <c>NextPageToken</c> property of either a
-        /// <see cref="Page{TResource}"/> or a raw response from
-        /// <see cref="PagedEnumerable{TResponse, TResource}.AsRawResponses"/>.
+        /// Gets or sets the page token. If set, this token is used to indicate a continued list operation.
         /// </summary>
         public string PageToken { get; set; }
     }

FirebaseAdmin/FirebaseAdmin/Auth/ListUsersPageManager.cs

@@ -34,12 +34,7 @@ public void SetPageToken(ListUsersRequest request, string pageToken)
 
         public IEnumerable<ExportedUserRecord> GetResources(ExportedUserRecords response)
         {
-            if (response?.Users == null)
-            {
-                return new ExportedUserRecord[0];
-            }
-
-            return response.Users;
+            return response?.Users;
         }
 
         public string GetNextPageToken(ExportedUserRecords response)