Cleaning up public API and tests

Author: hiranya911

FirebaseAdmin/FirebaseAdmin.Tests/Auth/FirebaseUserManagerTest.cs

@@ -95,8 +95,111 @@ public async Task GetUserById()
                     ProjectId = MockProjectId,
                     ClientFactory = factory,
                 });
+
+            var userRecord = await userManager.GetUserById("user1");
+            Assert.Equal("user1", userRecord.Uid);
+            Assert.Null(userRecord.DisplayName);
+            Assert.Null(userRecord.Email);
+            Assert.Null(userRecord.PhoneNumber);
+            Assert.Null(userRecord.PhotoUrl);
+            Assert.Equal("firebase", userRecord.ProviderId);
+            Assert.Empty(userRecord.CustomClaims);
+            Assert.Empty(userRecord.ProviderData);
+            Assert.False(userRecord.Disabled);
+            Assert.False(userRecord.EmailVerified);
+            Assert.Equal(UserRecord.UnixEpoch, userRecord.TokensValidAfterTimestamp);
+            Assert.Equal(0, userRecord.UserMetaData.CreationTimestamp);
+            Assert.Equal(0, userRecord.UserMetaData.LastSignInTimestamp);
+        }
+
+        [Fact]
+        public async Task GetUserByIdWithProperties()
+        {
+            var handler = new MockMessageHandler()
+            {
+                Response = new GetAccountInfoResponse()
+                {
+                    Kind = "identitytoolkit#GetAccountInfoResponse",
+                    Users = new List<GetAccountInfoResponse.User>()
+                    {
+                        new GetAccountInfoResponse.User()
+                        {
+                            UserId = "user1",
+                            DisplayName = "Test User",
+                            Email = "[email protected]",
+                            PhoneNumber = "+11234567890",
+                            PhotoUrl = "https://domain.com/user.png",
+                            Disabled = true,
+                            EmailVerified = true,
+                            ValidSince = 3600,
+                            CreatedAt = 100,
+                            LastLoginAt = 150,
+                            CustomClaims = @"{""admin"": true, ""level"": 10}",
+                            Providers = new List<GetAccountInfoResponse.Provider>()
+                            {
+                                new GetAccountInfoResponse.Provider()
+                                {
+                                    ProviderID = "google.com",
+                                    UserId = "googleuid",
+                                },
+                                new GetAccountInfoResponse.Provider()
+                                {
+                                    ProviderID = "other.com",
+                                    UserId = "otheruid",
+                                    DisplayName = "Other Name",
+                                },
+                            },
+                        },
+                    },
+                },
+            };
+
+            var factory = new MockHttpClientFactory(handler);
+            var userManager = new FirebaseUserManager(
+                new FirebaseUserManagerArgs
+                {
+                    Credential = MockCredential,
+                    ProjectId = MockProjectId,
+                    ClientFactory = factory,
+                });
+
             var userRecord = await userManager.GetUserById("user1");
             Assert.Equal("user1", userRecord.Uid);
+            Assert.Equal("Test User", userRecord.DisplayName);
+            Assert.Equal("[email protected]", userRecord.Email);
+            Assert.Equal("+11234567890", userRecord.PhoneNumber);
+            Assert.Equal("https://domain.com/user.png", userRecord.PhotoUrl);
+            Assert.Equal("firebase", userRecord.ProviderId);
+
+            var claims = new Dictionary<string, object>()
+            {
+                { "admin", true },
+                { "level", 10L },
+            };
+            Assert.Equal(claims, userRecord.CustomClaims);
+
+            Assert.Equal(2, userRecord.ProviderData.Length);
+            var provider = userRecord.ProviderData[0];
+            Assert.Equal("google.com", provider.ProviderId);
+            Assert.Equal("googleuid", provider.Uid);
+            Assert.Null(provider.DisplayName);
+            Assert.Null(provider.Email);
+            Assert.Null(provider.PhoneNumber);
+            Assert.Null(provider.PhotoUrl);
+
+            provider = userRecord.ProviderData[1];
+            Assert.Equal("other.com", provider.ProviderId);
+            Assert.Equal("otheruid", provider.Uid);
+            Assert.Equal("Other Name", provider.DisplayName);
+            Assert.Null(provider.Email);
+            Assert.Null(provider.PhoneNumber);
+            Assert.Null(provider.PhotoUrl);
+
+            Assert.True(userRecord.Disabled);
+            Assert.True(userRecord.EmailVerified);
+            Assert.Equal(UserRecord.UnixEpoch.AddSeconds(3600), userRecord.TokensValidAfterTimestamp);
+            Assert.Equal(100, userRecord.UserMetaData.CreationTimestamp);
+            Assert.Equal(150, userRecord.UserMetaData.LastSignInTimestamp);
         }
 
         [Fact]

FirebaseAdmin/FirebaseAdmin/Auth/UserRecord.cs

@@ -27,7 +27,10 @@ namespace FirebaseAdmin.Auth
     /// </summary>
     public sealed class UserRecord : IUserInfo
     {
-        private const string PROVIDERID = "firebase";
+        internal static readonly DateTime UnixEpoch = new DateTime(
+            1970, 1, 1, 0, 0, 0, DateTimeKind.Utc);
+
+        private const string DefaultProviderId = "firebase";
 
         private string uid;
         private string email;
@@ -36,8 +39,8 @@ public sealed class UserRecord : IUserInfo
         private string displayName;
         private string photoUrl;
         private bool disabled;
-        private List<ProviderUserInfo> providers;
-        private long tokensValidAfterTimestamp;
+        private IUserInfo[] providers;
+        private long validSinceTimestampInSeconds;
         private UserMetadata userMetaData;
         private IReadOnlyDictionary<string, object> customClaims;
 
@@ -80,20 +83,19 @@ internal UserRecord(GetAccountInfoResponse.User user)
 
             if (user.Providers == null || user.Providers.Count == 0)
             {
-                this.providers = new List<ProviderUserInfo>();
+                this.providers = new IUserInfo[0];
             }
             else
             {
                 var count = user.Providers.Count;
-                this.providers = new List<ProviderUserInfo>(count);
-
+                this.providers = new IUserInfo[count];
                 for (int i = 0; i < count; i++)
                 {
-                    this.providers.Add(new ProviderUserInfo(user.Providers[i]));
+                    this.providers[i] = new ProviderUserInfo(user.Providers[i]);
                 }
             }
 
-            this.tokensValidAfterTimestamp = user.ValidSince * 1000;
+            this.validSinceTimestampInSeconds = user.ValidSince;
             this.userMetaData = new UserMetadata(user.CreatedAt, user.LastLoginAt);
             this.customClaims = UserRecord.ParseCustomClaims(user.CustomClaims);
         }
@@ -112,49 +114,43 @@ private set
         }
 
         /// <summary>
-        /// Gets the user's display name, if available.
+        /// Gets the user's display name, if available. Otherwise null.
         /// </summary>
-        /// <returns>a display name string or null.</returns>
         public string DisplayName
         {
             get => this.displayName;
         }
 
         /// <summary>
-        /// Gets the user's email address, if available.
+        /// Gets the user's email address, if available. Otherwise null.
         /// </summary>
-        /// <returns>an email address string or null.</returns>
         public string Email
         {
             get => this.email;
         }
 
         /// <summary>
-        /// Gets the user's phone number.
+        /// Gets the user's phone number, if available. Otherwise null.
         /// </summary>
-        /// <returns>a phone number string or null.</returns>
         public string PhoneNumber
         {
             get => this.phoneNumber;
         }
 
         /// <summary>
-        /// Gets the user's photo URL, if available.
+        /// Gets the user's photo URL, if available. Otherwise null.
         /// </summary>
-        /// <returns>a URL string or null.</returns>
         public string PhotoUrl
         {
             get => this.photoUrl;
         }
 
         /// <summary>
-        /// Gets the ID of the identity provider. This can be a short domain name (e.g. google.com) or
-        /// the identifier of an OpenID identity provider.
+        /// Gets the ID of the identity provider. This has the constant value <c>firebase</c>.
         /// </summary>
-        /// <returns>an ID string that uniquely identifies the identity provider.</returns>
         public string ProviderId
         {
-            get => UserRecord.PROVIDERID;
+            get => UserRecord.DefaultProviderId;
         }
 
         /// <summary>
@@ -168,28 +164,36 @@ public string ProviderId
         public bool Disabled => this.disabled;
 
         /// <summary>
-        /// Gets a list of provider data for this user.
+        /// Gets a non-null array of provider data for this user. Possibly empty.
         /// </summary>
-        public IEnumerable<IUserInfo> Providers => this.providers;
+        public IUserInfo[] ProviderData => this.providers;
 
         /// <summary>
-        /// Gets a timestamp representing the date and time that this token will become active.
+        /// Gets a timestamp that indicates the earliest point in time at which a valid ID token
+        /// could have been issued to this user. Tokens issued prior to this  timestamp are
+        /// considered invalid.
         /// </summary>
-        public long TokensValidAfterTimestamp => this.tokensValidAfterTimestamp;
+        public DateTime TokensValidAfterTimestamp
+        {
+            get
+            {
+                return UnixEpoch.AddSeconds(this.validSinceTimestampInSeconds);
+            }
+        }
 
         /// <summary>
         /// Gets additional user metadata.
         /// </summary>
         public UserMetadata UserMetaData => this.userMetaData;
 
         /// <summary>
-        /// Gets or sets the custom claims set on this user.
+        /// Gets the custom claims set on this user.
         /// </summary>
         [JsonIgnore]
         public IReadOnlyDictionary<string, object> CustomClaims
         {
             get => this.customClaims;
-            set
+            internal set
             {
                 CheckCustomClaims(value);
                 this.customClaims = value;
@@ -204,7 +208,7 @@ public IReadOnlyDictionary<string, object> CustomClaims
         /// </summary>
         /// <param name="uid">The user ID. Must not be null or longer than
         /// 128 characters.</param>
-        public static void CheckUid(string uid)
+        private static void CheckUid(string uid)
         {
             if (string.IsNullOrEmpty(uid))
             {
@@ -222,7 +226,7 @@ public static void CheckUid(string uid)
         /// <param name="customClaims">The custom claims. Claim names must
         /// not be null or empty and must not be reserved and the serialized
         /// claims have to be less than 1000 bytes.</param>
-        internal static void CheckCustomClaims(IReadOnlyDictionary<string, object> customClaims)
+        private static void CheckCustomClaims(IReadOnlyDictionary<string, object> customClaims)
         {
             if (customClaims == null)
             {