Merged with master

Author: hiranya911

CHANGELOG.md

@@ -1,6 +1,11 @@
 # Unreleased
 
+- [added] Implemented the `UpdateUserAsync()` API.
 - [added] Implemented the `CreateUserAsync()` and `UserRecordArgs` APIs.
+
+# v1.6.0
+
+- [added] `WebpushFcmOptions` added to the `WebpushConfig` class.
 - [added] Implemented the `GetUserByEmailAsync()` and `GetUserByPhoneNumberAsync()`
   APIs in the `FirebaseAuth` class.
 

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;
@@ -285,6 +288,90 @@ public async Task GetUserByPhoneNumberEmpty()
             await Assert.ThrowsAsync<ArgumentException>(() => auth.GetUserByPhoneNumberAsync(string.Empty));
         }
 
+        [Fact]
+        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""}
+                        ]
+                    }",
+                },
+            };
+            var auth = this.CreateFirebaseAuth(handler);
+
+            var usersPage = auth.ListUsersAsync(new ListUsersOptions());
+
+            var users = new List<ExportedUserRecord>();
+            var tokens = new List<string>();
+            var pageCounter = 0;
+            for (Page<ExportedUserRecord> userPage; (userPage = await usersPage.ReadPageAsync(3)) != null;)
+            {
+                pageCounter++;
+                tokens.Add(userPage.NextPageToken);
+                users.AddRange(userPage);
+                if (string.IsNullOrEmpty(userPage.NextPageToken))
+                {
+                    break;
+                }
+            }
+
+            Assert.Equal(2, pageCounter);
+            Assert.Equal(6, users.Count);
+            Assert.Equal("token", tokens[0]);
+            Assert.Null(tokens[1]);
+            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 auth = this.CreateFirebaseAuth(handler);
+
+            var usersPage = auth.ListUsersAsync(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 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/Messaging/MessageTest.cs

@@ -1558,6 +1558,98 @@ public void ApnsInvalidCriticalSoundVolumeTooHigh()
             Assert.Throws<ArgumentException>(() => message.CopyAndValidate());
         }
 
+        [Fact]
+        public void WebpushNotificationWithLinkUrl()
+        {
+            var message = new Message()
+            {
+                Topic = "test-topic",
+                Webpush = new WebpushConfig()
+                {
+                    Notification = new WebpushNotification()
+                    {
+                        Title = "title",
+                        Body = "body",
+                        Icon = "icon",
+                    },
+                    FcmOptions = new WebpushFcmOptions()
+                    {
+                        Link = "https://www.firebase.io/",
+                    },
+                },
+            };
+            var expected = new JObject()
+            {
+                { "topic", "test-topic" },
+                {
+                    "webpush", new JObject()
+                    {
+                        {
+                            "notification", new JObject()
+                            {
+                                { "title", "title" },
+                                { "body", "body" },
+                                { "icon", "icon" },
+                            }
+                        },
+                        {
+                            "fcm_options", new JObject()
+                            {
+                                { "link", "https://www.firebase.io/" },
+                            }
+                        },
+                    }
+                },
+            };
+            this.AssertJsonEquals(expected, message);
+        }
+
+        [Fact]
+        public void WebpushNotificationWithInvalidHttpLinkUrl()
+        {
+            var message = new Message()
+            {
+                Topic = "test-topic",
+                Webpush = new WebpushConfig()
+                {
+                    Notification = new WebpushNotification()
+                    {
+                        Title = "title",
+                        Body = "body",
+                        Icon = "icon",
+                    },
+                    FcmOptions = new WebpushFcmOptions()
+                    {
+                        Link = "http://www.firebase.io/",
+                    },
+                },
+            };
+            Assert.Throws<ArgumentException>(() => message.CopyAndValidate());
+        }
+
+        [Fact]
+        public void WebpushNotificationWithInvalidHttpsLinkUrl()
+        {
+            var message = new Message()
+            {
+                Topic = "test-topic",
+                Webpush = new WebpushConfig()
+                {
+                    Notification = new WebpushNotification()
+                    {
+                        Title = "title",
+                        Body = "body",
+                        Icon = "icon",
+                    },
+                    FcmOptions = new WebpushFcmOptions()
+                    {
+                        Link = "https whatever",
+                    },
+                },
+            };
+            Assert.Throws<ArgumentException>(() => message.CopyAndValidate());
+        }
+
         private void AssertJsonEquals(JObject expected, Message actual)
         {
             var json = NewtonsoftJsonSerializer.Instance.Serialize(actual.CopyAndValidate());

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,7 @@
 using System.Collections.Generic;
 using System.Threading;
 using System.Threading.Tasks;
+using Google.Api.Gax;
 using Google.Apis.Util;
 
 namespace FirebaseAdmin.Auth
@@ -520,6 +521,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>