[Blazor] API cleanups for the authentication Package (#19601)

msftbot[bot] · web-flow · commit 28c44ce1c1f0 · 2020-03-05T14:47:47.000Z
* Add missing OIDC provider options

* Convert string to enum

* Revert changes to JS files
diff --git a/src/Components/WebAssembly/Authentication.Msal/src/Interop/AuthenticationService.ts b/src/Components/WebAssembly/Authentication.Msal/src/Interop/AuthenticationService.ts
@@ -27,7 +27,7 @@ enum AuthenticationResultStatus {
     Redirect = "redirect",
     Success = "success",
     Failure = "failure",
-    OperationCompleted = "operation-completed"
+    OperationCompleted = "operationCompleted"
 }
 
 interface AuthenticationResult {
diff --git a/src/Components/WebAssembly/WebAssembly.Authentication/src/Interop/AuthenticationService.ts b/src/Components/WebAssembly/WebAssembly.Authentication/src/Interop/AuthenticationService.ts
@@ -43,7 +43,7 @@ export enum AuthenticationResultStatus {
     Redirect = 'redirect',
     Success = 'success',
     Failure = 'failure',
-    OperationCompleted = 'operation-completed'
+    OperationCompleted = 'operationCompleted'
 };
 
 export interface AuthenticationResult {
diff --git a/src/Components/WebAssembly/WebAssembly.Authentication/src/Models/RemoteAuthenticationResult.cs b/src/Components/WebAssembly/WebAssembly.Authentication/src/Models/RemoteAuthenticationResult.cs
@@ -12,7 +12,7 @@ public class RemoteAuthenticationResult<TState> where TState : class
         /// <summary>
         /// Gets or sets the status of the authentication operation. The status can be one of <see cref="RemoteAuthenticationStatus"/>.
         /// </summary>
-        public string Status { get; set; }
+        public RemoteAuthenticationStatus Status { get; set; }
 
         /// <summary>
         /// Gets or sets the error message of a failed authentication operation.
diff --git a/src/Components/WebAssembly/WebAssembly.Authentication/src/Models/RemoteAuthenticationStatus.cs b/src/Components/WebAssembly/WebAssembly.Authentication/src/Models/RemoteAuthenticationStatus.cs
@@ -6,27 +6,27 @@ namespace Microsoft.AspNetCore.Components.WebAssembly.Authentication
     /// <summary>
     /// Represents the status of an authentication operation.
     /// </summary>
-    public class RemoteAuthenticationStatus
+    public enum RemoteAuthenticationStatus
     {
         /// <summary>
         /// The application is going to be redirected.
         /// </summary>
-        public const string Redirect = "redirect";
+        Redirect,
 
         /// <summary>
         /// The authentication operation completed successfully.
         /// </summary>
-        public const string Success = "success";
+        Success,
 
         /// <summary>
         /// There was an error performing the authentication operation.
         /// </summary>
-        public const string Failure = "failure";
+        Failure,
 
         /// <summary>
         /// The operation in the current navigation context has completed. This signals that the application running on the
         /// current browser context is about to be shut down and no other work is required.
         /// </summary>
-        public const string OperationCompleted = "operation-completed";
+        OperationCompleted,
     }
 }
diff --git a/src/Components/WebAssembly/WebAssembly.Authentication/src/Options/OidcProviderOptions.cs b/src/Components/WebAssembly/WebAssembly.Authentication/src/Options/OidcProviderOptions.cs
@@ -40,5 +40,17 @@ public class OidcProviderOptions
         /// </summary>
         [JsonPropertyName("post_logout_redirect_uri")]
         public string PostLogoutRedirectUri { get; set; }
+
+        /// <summary>
+        /// Gets or sets the response type to use on the authorization flow. The valid values are specified by the identity provider metadata.
+        /// </summary>
+        [JsonPropertyName("response_type")]
+        public string ResponseType { get; set; }
+
+        /// <summary>
+        /// Gets or sets the response mode to use in the authorization flow.
+        /// </summary>
+        [JsonPropertyName("response_mode")]
+        public string ResponseMode { get; set; }
     }
 }
diff --git a/src/Components/WebAssembly/WebAssembly.Authentication/src/RemoteAuthenticatorViewCore.cs b/src/Components/WebAssembly/WebAssembly.Authentication/src/RemoteAuthenticatorViewCore.cs
@@ -300,7 +300,7 @@ private async Task ProcessLogOut(string returnUrl)
                         await NavigateToReturnUrl(uri);
                         break;
                     default:
-                        throw new InvalidOperationException($"Invalid authentication result status '{result.Status ?? "(null)"}'.");
+                        throw new InvalidOperationException($"Invalid authentication result status.");
                 }
             }
             else
@@ -332,7 +332,7 @@ private async Task ProcessLogOutCallback()
                     await NavigateToReturnUrl(uri);
                     break;
                 default:
-                    throw new InvalidOperationException($"Invalid authentication result status '{result.Status ?? "(null)"}'.");
+                    throw new InvalidOperationException($"Invalid authentication result status.");
             }
         }
 
diff --git a/src/Components/WebAssembly/WebAssembly.Authentication/src/Services/AccessTokenResult.cs b/src/Components/WebAssembly/WebAssembly.Authentication/src/Services/AccessTokenResult.cs
@@ -18,7 +18,7 @@ public class AccessTokenResult
         /// <param name="status">The status of the result.</param>
         /// <param name="token">The <see cref="AccessToken"/> in case it was successful.</param>
         /// <param name="redirectUrl">The redirect uri to go to for provisioning the token.</param>
-        public AccessTokenResult(string status, AccessToken token, string redirectUrl)
+        public AccessTokenResult(AccessTokenResultStatus status, AccessToken token, string redirectUrl)
         {
             Status = status;
             _token = token;
@@ -28,7 +28,7 @@ public AccessTokenResult(string status, AccessToken token, string redirectUrl)
         /// <summary>
         /// Gets or sets the status of the current operation. See <see cref="AccessTokenResultStatus"/> for a list of statuses.
         /// </summary>
-        public string Status { get; set; }
+        public AccessTokenResultStatus Status { get; set; }
 
         /// <summary>
         /// Gets or sets the URL to redirect to if <see cref="Status"/> is <see cref="AccessTokenResultStatus.RequiresRedirect"/>.
@@ -42,7 +42,7 @@ public AccessTokenResult(string status, AccessToken token, string redirectUrl)
         /// <returns><c>true</c> when the token request is successful; <c>false</c> otherwise.</returns>
         public bool TryGetToken(out AccessToken accessToken)
         {
-            if (string.Equals(Status, AccessTokenResultStatus.Success, StringComparison.OrdinalIgnoreCase))
+            if (Status == AccessTokenResultStatus.Success)
             {
                 accessToken = _token;
                 return true;
diff --git a/src/Components/WebAssembly/WebAssembly.Authentication/src/Services/AccessTokenResultStatus.cs b/src/Components/WebAssembly/WebAssembly.Authentication/src/Services/AccessTokenResultStatus.cs
@@ -6,16 +6,16 @@ namespace Microsoft.AspNetCore.Components.WebAssembly.Authentication
     /// <summary>
     /// Represents the possible results from trying to acquire an access token.
     /// </summary>
-    public class AccessTokenResultStatus
+    public enum AccessTokenResultStatus
     {
         /// <summary>
         /// The token was successfully acquired.
         /// </summary>
-        public const string Success = "success";
+        Success,
 
         /// <summary>
         /// A redirect is needed in order to provision the token.
         /// </summary>
-        public const string RequiresRedirect = "requiesRedirect";
+        RequiresRedirect,
     }
 }
diff --git a/src/Components/WebAssembly/WebAssembly.Authentication/src/Services/RemoteAuthenticationService.cs b/src/Components/WebAssembly/WebAssembly.Authentication/src/Services/RemoteAuthenticationService.cs
@@ -70,7 +70,8 @@ public virtual async Task<RemoteAuthenticationResult<TRemoteAuthenticationState>
             RemoteAuthenticationContext<TRemoteAuthenticationState> context)
         {
             await EnsureAuthService();
-            var result = await _jsRuntime.InvokeAsync<RemoteAuthenticationResult<TRemoteAuthenticationState>>("AuthenticationService.signIn", context.State);
+            var internalResult = await _jsRuntime.InvokeAsync<InternalRemoteAuthenticationResult<TRemoteAuthenticationState>>("AuthenticationService.signIn", context.State);
+            var result = internalResult.Convert();
             if (result.Status == RemoteAuthenticationStatus.Success)
             {
                 UpdateUser(GetUser());
@@ -84,7 +85,8 @@ public virtual async Task<RemoteAuthenticationResult<TRemoteAuthenticationState>
             RemoteAuthenticationContext<TRemoteAuthenticationState> context)
         {
             await EnsureAuthService();
-            var result = await _jsRuntime.InvokeAsync<RemoteAuthenticationResult<TRemoteAuthenticationState>>("AuthenticationService.completeSignIn", context.Url);
+            var internalResult = await _jsRuntime.InvokeAsync<InternalRemoteAuthenticationResult<TRemoteAuthenticationState>>("AuthenticationService.completeSignIn", context.Url);
+            var result = internalResult.Convert();
             if (result.Status == RemoteAuthenticationStatus.Success)
             {
                 UpdateUser(GetUser());
@@ -98,7 +100,8 @@ public virtual async Task<RemoteAuthenticationResult<TRemoteAuthenticationState>
             RemoteAuthenticationContext<TRemoteAuthenticationState> context)
         {
             await EnsureAuthService();
-            var result = await _jsRuntime.InvokeAsync<RemoteAuthenticationResult<TRemoteAuthenticationState>>("AuthenticationService.signOut", context.State);
+            var internalResult = await _jsRuntime.InvokeAsync<InternalRemoteAuthenticationResult<TRemoteAuthenticationState>>("AuthenticationService.signOut", context.State);
+            var result = internalResult.Convert();
             if (result.Status == RemoteAuthenticationStatus.Success)
             {
                 UpdateUser(GetUser());
@@ -112,7 +115,8 @@ public virtual async Task<RemoteAuthenticationResult<TRemoteAuthenticationState>
             RemoteAuthenticationContext<TRemoteAuthenticationState> context)
         {
             await EnsureAuthService();
-            var result = await _jsRuntime.InvokeAsync<RemoteAuthenticationResult<TRemoteAuthenticationState>>("AuthenticationService.completeSignOut", context.Url);
+            var internalResult = await _jsRuntime.InvokeAsync<InternalRemoteAuthenticationResult<TRemoteAuthenticationState>>("AuthenticationService.completeSignOut", context.Url);
+            var result = internalResult.Convert();
             if (result.Status == RemoteAuthenticationStatus.Success)
             {
                 UpdateUser(GetUser());
@@ -127,13 +131,18 @@ public virtual async ValueTask<AccessTokenResult> RequestAccessToken()
             await EnsureAuthService();
             var result = await _jsRuntime.InvokeAsync<InternalAccessTokenResult>("AuthenticationService.getAccessToken");
 
-            if (string.Equals(result.Status, AccessTokenResultStatus.RequiresRedirect, StringComparison.OrdinalIgnoreCase))
+            if (!Enum.TryParse<AccessTokenResultStatus>(result.Status, ignoreCase: true, out var parsedStatus))
+            {
+                throw new InvalidOperationException($"Invalid access token result status '{result.Status ?? "(null)"}'");
+            }
+
+            if (parsedStatus == AccessTokenResultStatus.RequiresRedirect)
             {
                 var redirectUrl = GetRedirectUrl(null);
                 result.RedirectUrl = redirectUrl.ToString();
             }
 
-            return new AccessTokenResult(result.Status, result.Token, result.RedirectUrl);
+            return new AccessTokenResult(parsedStatus, result.Token, result.RedirectUrl);
         }
 
         /// <inheritdoc />
@@ -147,13 +156,18 @@ public virtual async ValueTask<AccessTokenResult> RequestAccessToken(AccessToken
             await EnsureAuthService();
             var result = await _jsRuntime.InvokeAsync<InternalAccessTokenResult>("AuthenticationService.getAccessToken", options);
 
-            if (string.Equals(result.Status, AccessTokenResultStatus.RequiresRedirect, StringComparison.OrdinalIgnoreCase))
+            if (!Enum.TryParse<AccessTokenResultStatus>(result.Status, ignoreCase: true, out var parsedStatus))
+            {
+                throw new InvalidOperationException($"Invalid access token result status '{result.Status ?? "(null)"}'");
+            }
+
+            if (parsedStatus == AccessTokenResultStatus.RequiresRedirect)
             {
                 var redirectUrl = GetRedirectUrl(options.ReturnUrl);
                 result.RedirectUrl = redirectUrl.ToString();
             }
 
-            return new AccessTokenResult(result.Status, result.Token, result.RedirectUrl);
+            return new AccessTokenResult(parsedStatus, result.Token, result.RedirectUrl);
         }
 
         private Uri GetRedirectUrl(string customReturnUrl)
@@ -242,4 +256,32 @@ internal struct InternalAccessTokenResult
         public AccessToken Token { get; set; }
         public string RedirectUrl { get; set; }
     }
+
+    // Internal for testing purposes
+    internal struct InternalRemoteAuthenticationResult<TRemoteAuthenticationState> where TRemoteAuthenticationState : RemoteAuthenticationState
+    {
+        public string Status { get; set; }
+
+        public string ErrorMessage { get; set; }
+
+        public TRemoteAuthenticationState State { get; set; }
+
+        public RemoteAuthenticationResult<TRemoteAuthenticationState> Convert()
+        {
+            var result = new RemoteAuthenticationResult<TRemoteAuthenticationState>();
+            result.ErrorMessage = ErrorMessage;
+            result.State = State;
+
+            if (Status != null && Enum.TryParse<RemoteAuthenticationStatus>(Status, ignoreCase: true, out var status))
+            {
+                result.Status = status;
+            }
+            else
+            {
+                throw new InvalidOperationException($"Can't convert status '${Status ?? "(null)"}'.");
+            }
+
+            return result;
+        }
+    }
 }
diff --git a/src/Components/WebAssembly/WebAssembly.Authentication/test/RemoteAuthenticationServiceTests.cs b/src/Components/WebAssembly/WebAssembly.Authentication/test/RemoteAuthenticationServiceTests.cs

Original file line number	Diff line number	Diff line change
`@@ -27,7 +27,7 @@ enum AuthenticationResultStatus {`
`27`	`27`	`Redirect = "redirect",`
`28`	`28`	`Success = "success",`
`29`	`29`	`Failure = "failure",`
`30`		`- OperationCompleted = "operation-completed"`
	`30`	`+ OperationCompleted = "operationCompleted"`
`31`	`31`	`}`
`32`	`32`
`33`	`33`	`interface AuthenticationResult {`
Original file line number	Diff line number	Diff line change
`@@ -300,7 +300,7 @@ private async Task ProcessLogOut(string returnUrl)`
`300`	`300`	`await NavigateToReturnUrl(uri);`
`301`	`301`	`break;`
`302`	`302`	`default:`
`303`		`- throw new InvalidOperationException($"Invalid authentication result status '{result.Status ?? "(null)"}'.");`
	`303`	`+ throw new InvalidOperationException($"Invalid authentication result status.");`
`304`	`304`	`}`
`305`	`305`	`}`
`306`	`306`	`else`
`@@ -332,7 +332,7 @@ private async Task ProcessLogOutCallback()`
`332`	`332`	`await NavigateToReturnUrl(uri);`
`333`	`333`	`break;`
`334`	`334`	`default:`
`335`		`- throw new InvalidOperationException($"Invalid authentication result status '{result.Status ?? "(null)"}'.");`
	`335`	`+ throw new InvalidOperationException($"Invalid authentication result status.");`
`336`	`336`	`}`
`337`	`337`	`}`
`338`	`338`
Original file line number	Diff line number	Diff line change
`@@ -6,16 +6,16 @@ namespace Microsoft.AspNetCore.Components.WebAssembly.Authentication`
`6`	`6`	`/// <summary>`
`7`	`7`	`/// Represents the possible results from trying to acquire an access token.`
`8`	`8`	`/// </summary>`
`9`		`- public class AccessTokenResultStatus`
	`9`	`+ public enum AccessTokenResultStatus`
`10`	`10`	`{`
`11`	`11`	`/// <summary>`
`12`	`12`	`/// The token was successfully acquired.`
`13`	`13`	`/// </summary>`
`14`		`- public const string Success = "success";`
	`14`	`+ Success,`
`15`	`15`
`16`	`16`	`/// <summary>`
`17`	`17`	`/// A redirect is needed in order to provision the token.`
`18`	`18`	`/// </summary>`
`19`		`- public const string RequiresRedirect = "requiesRedirect";`
	`19`	`+ RequiresRedirect,`
`20`	`20`	`}`
`21`	`21`	`}`