From f81d7ce79df1b8367f4368cae5f622bd7319daaf Mon Sep 17 00:00:00 2001 From: Joao Rua Date: Fri, 19 Apr 2024 09:14:48 +0100 Subject: [PATCH] login refactor --- .../Components/LoginTestFixture.cs | 17 +++--- COMET.Web.Common/Components/Login.razor | 13 +++-- COMET.Web.Common/Components/Login.razor.cs | 25 ++++----- .../AuthenticationService.cs | 56 ++++++------------- .../IAuthenticationService.cs | 7 ++- .../ViewModels/Components/ILoginViewModel.cs | 12 +++- .../ViewModels/Components/LoginViewModel.cs | 38 +++++++++---- 7 files changed, 84 insertions(+), 84 deletions(-) diff --git a/COMET.Web.Common.Tests/Components/LoginTestFixture.cs b/COMET.Web.Common.Tests/Components/LoginTestFixture.cs index 2111230a..e46b4bd8 100644 --- a/COMET.Web.Common.Tests/Components/LoginTestFixture.cs +++ b/COMET.Web.Common.Tests/Components/LoginTestFixture.cs @@ -36,6 +36,8 @@ namespace COMET.Web.Common.Tests.Components using COMET.Web.Common.Test.Helpers; using COMET.Web.Common.ViewModels.Components; + using FluentResults; + using Microsoft.AspNetCore.Components.Forms; using Microsoft.AspNetCore.Components.Web; using Microsoft.Extensions.DependencyInjection; @@ -143,8 +145,7 @@ public async Task VerifyPerformLogin() var renderer = this.context.RenderComponent(); var editForm = renderer.FindComponent(); - this.authenticationService.Setup(x => x.Login(It.IsAny())) - .ReturnsAsync(AuthenticationStateKind.ServerFail); + this.authenticationService.Setup(x => x.Login(It.IsAny())).ReturnsAsync(Result.Ok); Assert.That(renderer.Instance.FieldsFocusedStatus, Is.EqualTo(new Dictionary() { @@ -158,22 +159,20 @@ public async Task VerifyPerformLogin() Assert.Multiple(() => { Assert.That(renderer.Instance.LoginButtonDisplayText, Is.EqualTo("Retry")); - Assert.That(renderer.Instance.ErrorMessage, Is.Not.Null); + Assert.That(renderer.Instance.ErrorMessages, Is.Not.Null); }); - this.authenticationService.Setup(x => x.Login(It.IsAny())) - .ReturnsAsync(AuthenticationStateKind.Fail); + this.authenticationService.Setup(x => x.Login(It.IsAny())).ReturnsAsync(Result.Ok); await renderer.InvokeAsync(editForm.Instance.OnValidSubmit.InvokeAsync); Assert.Multiple(() => { Assert.That(renderer.Instance.LoginButtonDisplayText, Is.EqualTo("Retry")); - Assert.That(renderer.Instance.ErrorMessage, Is.Not.Null); + Assert.That(renderer.Instance.ErrorMessages, Is.Not.Null); }); - this.authenticationService.Setup(x => x.Login(It.IsAny())) - .ReturnsAsync(AuthenticationStateKind.Success); + this.authenticationService.Setup(x => x.Login(It.IsAny())).ReturnsAsync(Result.Ok); this.viewModel.AuthenticationDto.SourceAddress = "http://localhost.com"; this.viewModel.AuthenticationDto.UserName = "user"; @@ -184,7 +183,7 @@ public async Task VerifyPerformLogin() Assert.Multiple(() => { Assert.That(renderer.Instance.LoginButtonDisplayText, Is.EqualTo("Connecting")); - Assert.That(renderer.Instance.ErrorMessage, Is.Empty); + Assert.That(renderer.Instance.ErrorMessages, Is.Empty); }); } } diff --git a/COMET.Web.Common/Components/Login.razor b/COMET.Web.Common/Components/Login.razor index b4ab8275..68a7bc3a 100644 --- a/COMET.Web.Common/Components/Login.razor +++ b/COMET.Web.Common/Components/Login.razor @@ -87,11 +87,16 @@ } - @if (!string.IsNullOrEmpty(this.ErrorMessage)) + @if (this.ErrorMessages.Any()) { -
- -
+
+
    + @foreach (var errrorMessage in this.ErrorMessages) + { +
  • @errrorMessage
    • + } +
+
}
diff --git a/COMET.Web.Common/Components/Login.razor.cs b/COMET.Web.Common/Components/Login.razor.cs index 89a8f64b..f99ba096 100644 --- a/COMET.Web.Common/Components/Login.razor.cs +++ b/COMET.Web.Common/Components/Login.razor.cs @@ -68,9 +68,9 @@ public partial class Login public string LoginButtonDisplayText { get; private set; } /// - /// An error message to display after a login failure + /// The error messages to display after a login failure /// - public string ErrorMessage { get; private set; } + public IEnumerable ErrorMessages { get; private set; } /// /// Value indicating if the login button is enabled or not @@ -97,8 +97,8 @@ protected override void OnInitialized() { "Password", false } }; - this.Disposables.Add(this.WhenAnyValue(x => x.ViewModel.AuthenticationState) - .Subscribe(_ => this.ComputeDisplayProperties())); + this.Disposables.Add(this.WhenAnyValue(x => x.ViewModel.AuthenticationResult).Subscribe(_ => this.ComputeDisplayProperties())); + this.Disposables.Add(this.WhenAnyValue(x => x.ViewModel.IsLoading).Subscribe(_ => this.ComputeDisplayProperties())); } /// @@ -113,24 +113,19 @@ protected override void OnParametersSet() } /// - /// Compute display properties based on the + /// Compute display properties based on the /// private void ComputeDisplayProperties() { - this.LoginButtonDisplayText = this.ViewModel.AuthenticationState switch + this.LoginButtonDisplayText = this.ViewModel.IsLoading switch { - AuthenticationStateKind.None => "Connect", - AuthenticationStateKind.Authenticating => "Connecting", - AuthenticationStateKind.ServerFail or AuthenticationStateKind.Fail => "Retry", + true => "Connecting", + false when this.ViewModel.AuthenticationResult.IsSuccess => "Connect", + false when this.ViewModel.AuthenticationResult.IsFailed => "Retry", _ => this.LoginButtonDisplayText }; - this.ErrorMessage = this.ViewModel.AuthenticationState switch - { - AuthenticationStateKind.ServerFail => "The server could not be reached", - AuthenticationStateKind.Fail => "Login failed.", - _ => string.Empty - }; + this.ErrorMessages = this.ViewModel.AuthenticationResult.Errors.Select(x => x.Message); this.InvokeAsync(this.StateHasChanged); } diff --git a/COMET.Web.Common/Services/SessionManagement/AuthenticationService.cs b/COMET.Web.Common/Services/SessionManagement/AuthenticationService.cs index 5898f402..0023de58 100644 --- a/COMET.Web.Common/Services/SessionManagement/AuthenticationService.cs +++ b/COMET.Web.Common/Services/SessionManagement/AuthenticationService.cs @@ -27,14 +27,15 @@ namespace COMET.Web.Common.Services.SessionManagement { using CDP4Dal; using CDP4Dal.DAL; - using CDP4Dal.Exceptions; - using CDP4ServicesDal; + using CDP4Web.Extensions; - using COMET.Web.Common.Enumerations; using COMET.Web.Common.Model.DTO; + using FluentResults; + using Microsoft.AspNetCore.Components.Authorization; + using System.Net; /// /// The purpose of the is to authenticate against @@ -52,11 +53,6 @@ public class AuthenticationService : IAuthenticationService /// private readonly ISessionService sessionService; - /// - /// Gets the injected - /// - private readonly ICDPMessageBus messageBus; - /// /// Initializes a new instance of the class. /// @@ -66,10 +62,8 @@ public class AuthenticationService : IAuthenticationService /// /// The (injected) /// - /// The - public AuthenticationService(ISessionService sessionService, AuthenticationStateProvider authenticationStateProvider, ICDPMessageBus messageBus) + public AuthenticationService(ISessionService sessionService, AuthenticationStateProvider authenticationStateProvider) { - this.messageBus = messageBus; this.authStateProvider = authenticationStateProvider; this.sessionService = sessionService; } @@ -81,41 +75,23 @@ public AuthenticationService(ISessionService sessionService, AuthenticationState /// The authentication information with data source, username and password /// /// - /// when the authentication is done and the ISession opened + /// The of the request /// - public async Task Login(AuthenticationDto authenticationDto) + public async Task Login(AuthenticationDto authenticationDto) { - if (authenticationDto.SourceAddress != null) - { - var uri = new Uri(authenticationDto.SourceAddress); - var dal = new CdpServicesDal(); - var credentials = new Credentials(authenticationDto.UserName, authenticationDto.Password, uri); + var result = new Result(); - this.sessionService.Session = new Session(dal, credentials, this.messageBus); - } - else + if (authenticationDto.SourceAddress == null) { - return AuthenticationStateKind.Fail; + result.Reasons.Add(new Error("The source address should not be empty").AddReasonIdentifier(HttpStatusCode.BadRequest)); + return result; } - try - { - await this.sessionService.Session.Open(); - this.sessionService.IsSessionOpen = this.sessionService.GetSiteDirectory() != null; - ((CometWebAuthStateProvider)this.authStateProvider).NotifyAuthenticationStateChanged(); + var uri = new Uri(authenticationDto.SourceAddress); + var credentials = new Credentials(authenticationDto.UserName, authenticationDto.Password, uri); + result = await this.sessionService.OpenSession(credentials); - return this.sessionService.IsSessionOpen ? AuthenticationStateKind.Success : AuthenticationStateKind.Fail; - } - catch (DalReadException) - { - this.sessionService.IsSessionOpen = false; - return AuthenticationStateKind.Fail; - } - catch (HttpRequestException) - { - this.sessionService.IsSessionOpen = false; - return AuthenticationStateKind.ServerFail; - } + return result; } /// @@ -128,7 +104,7 @@ public async Task Logout() { if (this.sessionService.Session != null) { - await this.sessionService.Close(); + await this.sessionService.CloseSession(); } ((CometWebAuthStateProvider)this.authStateProvider).NotifyAuthenticationStateChanged(); diff --git a/COMET.Web.Common/Services/SessionManagement/IAuthenticationService.cs b/COMET.Web.Common/Services/SessionManagement/IAuthenticationService.cs index a0efe624..9798f9cf 100644 --- a/COMET.Web.Common/Services/SessionManagement/IAuthenticationService.cs +++ b/COMET.Web.Common/Services/SessionManagement/IAuthenticationService.cs @@ -25,9 +25,10 @@ namespace COMET.Web.Common.Services.SessionManagement { - using COMET.Web.Common.Enumerations; using COMET.Web.Common.Model.DTO; + using FluentResults; + /// /// The purpose of the is to authenticate against /// a E-TM-10-25 Annex C.2 data source @@ -41,9 +42,9 @@ public interface IAuthenticationService /// The authentication information with data source, username and password /// /// - /// True when the authentication is done + /// The of the request /// - Task Login(AuthenticationDto authenticationDto); + Task Login(AuthenticationDto authenticationDto); /// /// Logout from the data source diff --git a/COMET.Web.Common/ViewModels/Components/ILoginViewModel.cs b/COMET.Web.Common/ViewModels/Components/ILoginViewModel.cs index 30d6d603..5052ac4b 100644 --- a/COMET.Web.Common/ViewModels/Components/ILoginViewModel.cs +++ b/COMET.Web.Common/ViewModels/Components/ILoginViewModel.cs @@ -25,10 +25,11 @@ namespace COMET.Web.Common.ViewModels.Components { - using COMET.Web.Common.Enumerations; using COMET.Web.Common.Model.DTO; using COMET.Web.Common.Services.ConfigurationService; + using FluentResults; + /// /// View Model that enables the user to login against a COMET Server /// @@ -40,9 +41,14 @@ public interface ILoginViewModel IConfigurationService serverConnectionService { get; } /// - /// Gets or sets the + /// Gets or sets the loading state + /// + bool IsLoading { get; } + + /// + /// Gets or sets the of an authentication /// - AuthenticationStateKind AuthenticationState { get; set; } + Result AuthenticationResult { get; } /// /// The used for perfoming a login diff --git a/COMET.Web.Common/ViewModels/Components/LoginViewModel.cs b/COMET.Web.Common/ViewModels/Components/LoginViewModel.cs index 936c3398..39328d22 100644 --- a/COMET.Web.Common/ViewModels/Components/LoginViewModel.cs +++ b/COMET.Web.Common/ViewModels/Components/LoginViewModel.cs @@ -25,10 +25,12 @@ namespace COMET.Web.Common.ViewModels.Components { - using COMET.Web.Common.Enumerations; using COMET.Web.Common.Model.DTO; using COMET.Web.Common.Services.ConfigurationService; using COMET.Web.Common.Services.SessionManagement; + + using FluentResults; + using ReactiveUI; /// @@ -47,9 +49,14 @@ public class LoginViewModel : ReactiveObject, ILoginViewModel public IConfigurationService serverConnectionService { get; } /// - /// Backing field for + /// Backing field for + /// + private bool isLoading; + + /// + /// Backing field for /// - private AuthenticationStateKind authenticationState; + private Result authenticationResult; /// /// Initializes a new instance of the class. @@ -63,12 +70,21 @@ public LoginViewModel(IAuthenticationService authenticationService, IConfigurati } /// - /// Gets or sets the + /// Gets or sets the loading state /// - public AuthenticationStateKind AuthenticationState + public bool IsLoading { - get => this.authenticationState; - set => this.RaiseAndSetIfChanged(ref this.authenticationState, value); + get => this.isLoading; + set => this.RaiseAndSetIfChanged(ref this.isLoading, value); + } + + /// + /// Gets or sets the of an authentication + /// + public Result AuthenticationResult + { + get => this.authenticationResult; + set => this.RaiseAndSetIfChanged(ref this.authenticationResult, value); } /// @@ -82,19 +98,21 @@ public AuthenticationStateKind AuthenticationState /// A public async Task ExecuteLogin() { - this.AuthenticationState = AuthenticationStateKind.Authenticating; + this.IsLoading = true; if(!string.IsNullOrEmpty(this.serverConnectionService.ServerConfiguration.ServerAddress)) { this.AuthenticationDto.SourceAddress = this.serverConnectionService.ServerConfiguration.ServerAddress; } - this.AuthenticationState = await this.authenticationService.Login(this.AuthenticationDto); + this.AuthenticationResult = await this.authenticationService.Login(this.AuthenticationDto); - if (this.authenticationState == AuthenticationStateKind.Success) + if (this.AuthenticationResult.IsSuccess) { this.AuthenticationDto = new AuthenticationDto(); } + + this.IsLoading = false; } } }