Merge pull request #58 from ChristopherLenz/list-users

Adding the ListUsers API

Author: hiranya911

FirebaseAdmin/FirebaseAdmin.IntegrationTests/FirebaseAdmin.IntegrationTests.csproj

@@ -8,7 +8,7 @@
   </PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Include="Google.Apis.Auth" Version="1.35.1" />
+    <PackageReference Include="Google.Apis.Auth" Version="1.40.0" />
     <PackageReference Include="Microsoft.NET.Test.Sdk" Version="15.7.0" />
     <PackageReference Include="xunit" Version="2.3.1" />
     <PackageReference Include="xunit.runner.visualstudio" Version="2.3.1" />

FirebaseAdmin/FirebaseAdmin.Snippets/FirebaseAdmin.Snippets.csproj

@@ -8,7 +8,7 @@
   </PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Include="Google.Apis.Auth" Version="1.35.1" />
+    <PackageReference Include="Google.Apis.Auth" Version="1.40.0" />
   </ItemGroup>
 
   <ItemGroup>

FirebaseAdmin/FirebaseAdmin.Tests/Auth/FirebaseUserManagerTest.cs

@@ -14,10 +14,13 @@
 
 using System;
 using System.Collections.Generic;
+using System.Linq;
 using System.Net;
 using System.Net.Http;
 using System.Threading.Tasks;
 using FirebaseAdmin.Tests;
+using Google.Api.Gax;
+using Google.Api.Gax.Rest;
 using Google.Apis.Auth.OAuth2;
 using Google.Apis.Json;
 using Newtonsoft.Json.Linq;
@@ -296,6 +299,146 @@ public async Task GetUserByPhoneNumberEmpty()
             await Assert.ThrowsAsync<ArgumentException>(() => userManager.GetUserByPhoneNumberAsync(string.Empty));
         }
 
+        [Fact]
+        public async Task ListUsersPaged()
+        {
+            var nextPageToken = Guid.NewGuid().ToString();
+            var firstCallHandler = 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" },
+                    },
+                },
+            };
+
+            var secondCallHandler = new MockMessageHandler()
+            {
+                Response = new DownloadAccountResponse()
+                {
+                    NextPageToken = string.Empty,
+                    Users = new List<GetAccountInfoResponse.User>()
+                    {
+                        new GetAccountInfoResponse.User() { UserId = "user4" },
+                        new GetAccountInfoResponse.User() { UserId = "user5" },
+                        new GetAccountInfoResponse.User() { UserId = "user6" },
+                    },
+                },
+            };
+
+            var factory = new MockHttpClientFactory(new MultipleMockMessageHandler(new Dictionary<Func<HttpRequestMessage, bool>, MockMessageHandler>
+            {
+                { initMessage => initMessage.RequestUri.Query.Equals("?maxResults=3&nextPageToken="), firstCallHandler },
+                { initMessage => initMessage.RequestUri.Query.Equals($"?maxResults=3&nextPageToken={nextPageToken}"), secondCallHandler },
+            }));
+
+            var userManager = new FirebaseUserManager(
+                new FirebaseUserManagerArgs
+                {
+                    Credential = MockCredential,
+                    ProjectId = MockProjectId,
+                    ClientFactory = factory,
+                });
+
+            var usersPage = userManager.ListUsers(new ListUsersOptions());
+
+            var users = new List<ExportedUserRecord>();
+            var pageCounter = 0;
+
+            for (Page<ExportedUserRecord> userPage; (userPage = await usersPage.ReadPageAsync(3)) != null;)
+            {
+                pageCounter++;
+                users.AddRange(userPage);
+
+                if (string.IsNullOrEmpty(userPage.NextPageToken))
+                {
+                    break;
+                }
+            }
+
+            Assert.Equal(6, users.Count);
+            Assert.Equal(2, pageCounter);
+            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);
+        }
+
+        [Fact]
+        public async Task ListUsers()
+        {
+            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" },
+                    },
+                },
+            };
+
+            var factory = new MockHttpClientFactory(handler);
+            var userManager = new FirebaseUserManager(
+                new FirebaseUserManagerArgs
+                {
+                    Credential = MockCredential,
+                    ProjectId = MockProjectId,
+                    ClientFactory = factory,
+                });
+
+            var usersPage = userManager.ListUsers(new ListUsersOptions());
+            var listUsersRequest = await usersPage.ReadPageAsync(3);
+            var userRecords = listUsersRequest.ToList();
+            Assert.Equal(nextPageToken, listUsersRequest.NextPageToken);
+            Assert.Equal(3, userRecords.Count);
+            Assert.Equal("user1", userRecords[0].Uid);
+            Assert.Equal("user2", userRecords[1].Uid);
+            Assert.Equal("user3", userRecords[2].Uid);
+        }
+
+        [Fact]
+        public void ListUsersRequestOptionsAreSet()
+        {
+            var handler = new MockMessageHandler()
+            {
+            };
+
+            var factory = new MockHttpClientFactory(handler);
+            var userManager = new FirebaseUserManager(
+                new FirebaseUserManagerArgs
+                {
+                    Credential = MockCredential,
+                    ProjectId = MockProjectId,
+                    ClientFactory = factory,
+                });
+
+            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()
         {

FirebaseAdmin/FirebaseAdmin.Tests/FirebaseAdmin.Tests.csproj

@@ -10,7 +10,7 @@
   </PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Include="Google.Apis.Auth" Version="1.35.1" />
+    <PackageReference Include="Google.Apis.Auth" Version="1.40.0" />
     <PackageReference Include="Microsoft.NET.Test.Sdk" Version="15.6.0" />
     <PackageReference Include="xunit" Version="2.3.1" />
     <PackageReference Include="xunit.runner.visualstudio" Version="2.3.1" />

FirebaseAdmin/FirebaseAdmin.Tests/MockMessageHandler.cs

@@ -13,6 +13,7 @@
 // limitations under the License.
 
 using System;
+using System.Collections.Generic;
 using System.Net;
 using System.Net.Http;
 using System.Net.Http.Headers;
@@ -53,7 +54,7 @@ public MockMessageHandler()
 
         public SetContentHeaders ApplyContentHeaders { get; set; }
 
-        protected override async Task<HttpResponseMessage> SendAsyncCore(
+        protected internal override async Task<HttpResponseMessage> SendAsyncCore(
             HttpRequestMessage request, CancellationToken cancellationToken)
         {
             if (request.Content != null)
@@ -116,15 +117,41 @@ public int Calls
             get { return this.calls; }
         }
 
+        protected internal abstract Task<HttpResponseMessage> SendAsyncCore(
+            HttpRequestMessage request, CancellationToken cancellationToken);
+
         protected sealed override Task<HttpResponseMessage> SendAsync(
           HttpRequestMessage request, CancellationToken cancellationToken)
         {
             Interlocked.Increment(ref this.calls);
             return this.SendAsyncCore(request, cancellationToken);
         }
+    }
 
-        protected abstract Task<HttpResponseMessage> SendAsyncCore(
-            HttpRequestMessage request, CancellationToken cancellationToken);
+    internal class MultipleMockMessageHandler : CountableMessageHandler
+    {
+        private readonly IDictionary<Func<HttpRequestMessage, bool>, MockMessageHandler> messageHandlers;
+
+        public MultipleMockMessageHandler(IDictionary<Func<HttpRequestMessage, bool>, MockMessageHandler> messageHandlers)
+        {
+            this.messageHandlers = messageHandlers;
+        }
+
+        protected internal override async Task<HttpResponseMessage> SendAsyncCore(
+            HttpRequestMessage request, CancellationToken cancellationToken)
+        {
+            foreach (var (requestCheck, mockMessageHandler) in this.messageHandlers)
+            {
+                // check if the messagehandler is responsible for the current request
+                if (requestCheck.Invoke(request))
+                {
+                    this.messageHandlers.Remove(requestCheck);
+                    return await mockMessageHandler.SendAsyncCore(request, cancellationToken);
+                }
+            }
+
+            return new HttpResponseMessage(HttpStatusCode.NotFound);
+        }
     }
 
     internal class MockHttpClientFactory : HttpClientFactory

FirebaseAdmin/FirebaseAdmin/Auth/ExportedUserRecord.cs

@@ -0,0 +1,57 @@
+// 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.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+namespace FirebaseAdmin.Auth
+{
+    /// <summary>
+    /// Contains metadata associated with a Firebase user account, along with password hash and salt.
+    /// Instances of this class are immutable and thread safe.
+    /// </summary>
+    public sealed class ExportedUserRecord : UserRecord
+    {
+        private readonly string passwordHash;
+        private readonly string passwordSalt;
+
+        internal ExportedUserRecord(GetAccountInfoResponse.User user)
+            : base(user)
+        {
+            this.passwordHash = user.PasswordHash;
+            this.passwordSalt = user.PasswordSalt;
+        }
+
+        /// <summary>
+        /// Gets the user's password hash as a base64-encoded string.
+        /// If the Firebase Auth hashing algorithm (SCRYPT) was used to create the user account,
+        /// returns the base64-encoded password hash of the user.If a different hashing algorithm was
+        /// used to create this user, as is typical when migrating from another Auth system, returns
+        /// an empty string. Returns null if no password is set.
+        /// </summary>
+        public string PasswordHash
+        {
+            get => this.passwordHash;
+        }
+
+        /// <summary>
+        /// Gets the user's password salt as a base64-encoded string.
+        /// If the Firebase Auth hashing algorithm (SCRYPT) was used to create the user account,
+        /// returns the base64-encoded password salt of the user.If a different hashing algorithm was
+        /// used to create this user, as is typical when migrating from another Auth system, returns
+        /// an empty string. Returns null if no password is set.
+        /// </summary>
+        public string PasswordSalt
+        {
+            get => this.passwordSalt;
+        }
+    }
+}

FirebaseAdmin/FirebaseAdmin/Auth/ExportedUserRecords.cs

@@ -0,0 +1,34 @@
+// 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.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+using System.Collections.Generic;
+
+namespace FirebaseAdmin.Auth
+{
+    /// <summary>
+    /// Contains a collection of Firebase user accounts.
+    /// </summary>
+    public sealed class ExportedUserRecords
+    {
+        /// <summary>
+        /// Gets or sets the next page link.
+        /// </summary>
+        public string NextPageToken { get; set; }
+
+        /// <summary>
+        /// Gets or sets the users.
+        /// </summary>
+        public List<ExportedUserRecord> Users { get; set; }
+    }
+}

FirebaseAdmin/FirebaseAdmin/Auth/FirebaseAuth.cs

@@ -16,6 +16,8 @@
 using System.Collections.Generic;
 using System.Threading;
 using System.Threading.Tasks;
+using Google.Api.Gax;
+using Google.Api.Gax.Rest;
 
 namespace FirebaseAdmin.Auth
 {
@@ -523,6 +525,18 @@ public async Task SetCustomUserClaimsAsync(
             await userManager.UpdateUserAsync(user, cancellationToken).ConfigureAwait(false);
         }
 
+        /// <summary>
+        /// Gets an async enumerable to page users starting from the specified pageToken. If the pageToken is empty, it 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)
+        {
+            var userManager = this.IfNotDeleted(() => this.userManager.Value);
+
+            return userManager.ListUsers(requestOptions);
+        }
+
         /// <summary>
         /// Deletes this <see cref="FirebaseAuth"/> service instance.
         /// </summary>