From 585c5c8537eb21dfc9f16108548e63d9ced3d971 Mon Sep 17 00:00:00 2001 From: ivarlovlie Date: Mon, 24 Oct 2022 12:29:23 +0800 Subject: feat: Before move to FastEndpoints --- .../Internal/Account/CreateAccountRoute.cs | 6 +- .../src/Endpoints/Internal/Account/LoginRoute.cs | 2 +- .../Internal/Account/UpdateAccountRoute.cs | 6 +- .../Endpoints/Internal/Account/UserArchiveDto.cs | 131 +++++++++++++++++++++ code/api/src/Endpoints/Internal/BaseRoute.cs | 16 --- .../api/src/Endpoints/Internal/INT_EndpointBase.cs | 9 ++ .../PasswordResetRequests/Create/RequestModel.cs | 6 + .../Internal/PasswordResetRequests/Create/Route.cs | 57 +++++++++ .../CreateResetRequestRoute.cs | 59 ---------- .../FulfillResetRequestRoute.cs | 2 +- .../IsResetRequestValidRoute.cs | 2 +- code/api/src/Endpoints/Internal/RouteBaseAsync.cs | 16 +-- code/api/src/Endpoints/Internal/RouteBaseSync.cs | 16 +-- 13 files changed, 228 insertions(+), 100 deletions(-) create mode 100644 code/api/src/Endpoints/Internal/Account/UserArchiveDto.cs delete mode 100644 code/api/src/Endpoints/Internal/BaseRoute.cs create mode 100644 code/api/src/Endpoints/Internal/INT_EndpointBase.cs create mode 100644 code/api/src/Endpoints/Internal/PasswordResetRequests/Create/RequestModel.cs create mode 100644 code/api/src/Endpoints/Internal/PasswordResetRequests/Create/Route.cs delete mode 100644 code/api/src/Endpoints/Internal/PasswordResetRequests/CreateResetRequestRoute.cs (limited to 'code/api/src/Endpoints/Internal') diff --git a/code/api/src/Endpoints/Internal/Account/CreateAccountRoute.cs b/code/api/src/Endpoints/Internal/Account/CreateAccountRoute.cs index 954fbf5..0f4a383 100644 --- a/code/api/src/Endpoints/Internal/Account/CreateAccountRoute.cs +++ b/code/api/src/Endpoints/Internal/Account/CreateAccountRoute.cs @@ -22,16 +22,16 @@ public class CreateAccountRoute : RouteBaseAsync.WithRequest HandleAsync(CreateAccountPayload request, CancellationToken cancellationToken = default) { if (request.Username.IsValidEmailAddress() == false) { - return BadRequest(new ErrorResult("Invalid form", request.Username + " does not look like a valid email")); + return BadRequest(new KnownProblemModel("Invalid form", request.Username + " does not look like a valid email")); } if (request.Password.Length < 6) { - return BadRequest(new ErrorResult("Invalid form", "The password requires 6 or more characters.")); + return BadRequest(new KnownProblemModel("Invalid form", "The password requires 6 or more characters.")); } var username = request.Username.Trim(); if (_context.Users.Any(c => c.Username == username)) { - return BadRequest(new ErrorResult("Username is not available", "There is already a user registered with email: " + username)); + return BadRequest(new KnownProblemModel("Username is not available", "There is already a user registered with email: " + username)); } var user = new User(username); diff --git a/code/api/src/Endpoints/Internal/Account/LoginRoute.cs b/code/api/src/Endpoints/Internal/Account/LoginRoute.cs index 5b41c61..e4ef54c 100644 --- a/code/api/src/Endpoints/Internal/Account/LoginRoute.cs +++ b/code/api/src/Endpoints/Internal/Account/LoginRoute.cs @@ -28,7 +28,7 @@ public class LoginRoute : RouteBaseAsync var user = _context.Users.SingleOrDefault(u => u.Username == request.Username); if (user == default || !user.VerifyPassword(request.Password)) { - return BadRequest(new ErrorResult("Invalid username or password")); + return BadRequest(new KnownProblemModel("Invalid username or password")); } await _userService.LogInUser(HttpContext, user, request.Persist); diff --git a/code/api/src/Endpoints/Internal/Account/UpdateAccountRoute.cs b/code/api/src/Endpoints/Internal/Account/UpdateAccountRoute.cs index a997dcb..31ff10b 100644 --- a/code/api/src/Endpoints/Internal/Account/UpdateAccountRoute.cs +++ b/code/api/src/Endpoints/Internal/Account/UpdateAccountRoute.cs @@ -24,11 +24,11 @@ public class UpdateAccountRoute : RouteBaseAsync.WithRequest.With } if (request.Password.IsNullOrWhiteSpace() && request.Username.IsNullOrWhiteSpace()) { - return BadRequest(new ErrorResult("Invalid request", "No data was submitted")); + return BadRequest(new KnownProblemModel("Invalid request", "No data was submitted")); } if (request.Password.HasValue() && request.Password.Length < 6) { - return BadRequest(new ErrorResult("Invalid request", + return BadRequest(new KnownProblemModel("Invalid request", "The new password must contain at least 6 characters")); } @@ -37,7 +37,7 @@ public class UpdateAccountRoute : RouteBaseAsync.WithRequest.With } if (request.Username.HasValue() && !request.Username.IsValidEmailAddress()) { - return BadRequest(new ErrorResult("Invalid request", + return BadRequest(new KnownProblemModel("Invalid request", "The new username does not look like a valid email address")); } diff --git a/code/api/src/Endpoints/Internal/Account/UserArchiveDto.cs b/code/api/src/Endpoints/Internal/Account/UserArchiveDto.cs new file mode 100644 index 0000000..5d259ab --- /dev/null +++ b/code/api/src/Endpoints/Internal/Account/UserArchiveDto.cs @@ -0,0 +1,131 @@ + +namespace IOL.GreatOffice.Api.Endpoints.Internal.Account; + +/// +/// Represents a user archive as it is provided to users. +/// +public class UserArchiveDto +{ + /// + public UserArchiveDto(User user) { + Meta = new MetaDto { + GeneratedAt = AppDateTime.UtcNow.ToString("yyyy-MM-ddTHH:mm:ssZ") + }; + User = new UserDto(user); + Entries = new List(); + } + + /// + /// Metadata for the user archive. + /// + public MetaDto Meta { get; } + + /// + /// Relevant user data for the archive. + /// + public UserDto User { get; } + + /// + /// List of entries that the user has created. + /// + public List Entries { get; } + + public void CountEntries() { + Meta.EntryCount = Entries.Count; + } + + /// + /// Represents a time entry in the data archive. + /// + public class EntryDto + { + public string CreatedAt { get; init; } + + [JsonIgnore] + public DateTime StartDateTime { get; init; } + + /// + /// ISO 8601 string of the UTC date the time entry started. + /// + public string Start => StartDateTime.ToString("yyyy-MM-ddTHH:mm:ssZ"); + + [JsonIgnore] + public DateTime StopDateTime { get; init; } + + /// + /// ISO 8601 string of the UTC date the time entry stopped. + /// + public string Stop => StopDateTime.ToString("yyyy-MM-ddTHH:mm:ssZ"); + + /// + /// Total amount of minutes elapsed from start to stop on this time entry. + /// + public double Minutes => StopDateTime.Subtract(StartDateTime).TotalMinutes; + + public string Description { get; init; } + + /// + /// Archive spesific category for this time entry. + /// + public CategoryDto Category { get; init; } + + /// + /// Archive spesific list of labels for this time entry. + /// + public List Labels { get; init; } + } + + /// + /// Time entry category as it is written to the user archive. + /// + public class CategoryDto + { + public string Name { get; init; } + public string Color { get; init; } + } + + /// + /// Time entry label as it is written to the user archive. + /// + public class LabelDto + { + public string Name { get; init; } + public string Color { get; init; } + } + + + /// + /// Represents the user who this archive's data is based on. + /// + public class UserDto + { + /// + public UserDto(User user) { + Username = user.Username; + CreatedAt = user.CreatedAt; + } + + /// + /// UTC date this user was created. + /// + public DateTime CreatedAt { get; } + + public string Username { get; } + } + + /// + /// Represents the meta object which contains metdata for this archive. + /// + public class MetaDto + { + /// + /// ISO 8601 UTC date string for when this archive was created. + /// + public string GeneratedAt { get; init; } + + /// + /// Amount of entries in the archive. + /// + public int EntryCount { get; set; } + } +} diff --git a/code/api/src/Endpoints/Internal/BaseRoute.cs b/code/api/src/Endpoints/Internal/BaseRoute.cs deleted file mode 100644 index 3e2c6af..0000000 --- a/code/api/src/Endpoints/Internal/BaseRoute.cs +++ /dev/null @@ -1,16 +0,0 @@ -namespace IOL.GreatOffice.Api.Endpoints.Internal; - -[Authorize] -[ApiController] -[ApiExplorerSettings(IgnoreApi = true)] -[ApiVersionNeutral] -public class BaseRoute : ControllerBase -{ - /// - /// User data for the currently logged on user. - /// - protected LoggedInUserModel LoggedInUser => new() { - Username = User.FindFirstValue(AppClaims.NAME), - Id = User.FindFirstValue(AppClaims.USER_ID).AsGuid(), - }; -} diff --git a/code/api/src/Endpoints/Internal/INT_EndpointBase.cs b/code/api/src/Endpoints/Internal/INT_EndpointBase.cs new file mode 100644 index 0000000..699a976 --- /dev/null +++ b/code/api/src/Endpoints/Internal/INT_EndpointBase.cs @@ -0,0 +1,9 @@ +namespace IOL.GreatOffice.Api.Endpoints.Internal; + +[Authorize] +[ApiExplorerSettings(IgnoreApi = true)] +[ApiVersionNeutral] +public class INT_EndpointBase : EndpointBase +{ + +} diff --git a/code/api/src/Endpoints/Internal/PasswordResetRequests/Create/RequestModel.cs b/code/api/src/Endpoints/Internal/PasswordResetRequests/Create/RequestModel.cs new file mode 100644 index 0000000..236c650 --- /dev/null +++ b/code/api/src/Endpoints/Internal/PasswordResetRequests/Create/RequestModel.cs @@ -0,0 +1,6 @@ +namespace IOL.GreatOffice.Api.Endpoints.Internal.PasswordResetRequests.Create; + +public class RequestModel +{ + public string Username { get; set; } +} \ No newline at end of file diff --git a/code/api/src/Endpoints/Internal/PasswordResetRequests/Create/Route.cs b/code/api/src/Endpoints/Internal/PasswordResetRequests/Create/Route.cs new file mode 100644 index 0000000..f837fc0 --- /dev/null +++ b/code/api/src/Endpoints/Internal/PasswordResetRequests/Create/Route.cs @@ -0,0 +1,57 @@ +namespace IOL.GreatOffice.Api.Endpoints.Internal.PasswordResetRequests.Create; + +public class Route : RouteBaseAsync.WithRequest.WithActionResult +{ + private readonly ILogger _logger; + private readonly PasswordResetService _passwordResetService; + private readonly AppDbContext _context; + + public Route(ILogger logger, PasswordResetService passwordResetService, AppDbContext context) { + _logger = logger; + _passwordResetService = passwordResetService; + _context = context; + } + + /// + /// Create a new password reset request. + /// + /// + /// + /// + [AllowAnonymous] + [HttpPost("~/_/password-reset-request/create")] + public override async Task HandleAsync(RequestModel request, CancellationToken cancellationToken = default) { + if (!request.Username.IsValidEmailAddress()) { + _logger.LogInformation("Username is invalid, not doing request for password change"); + return KnownProblem("Invalid email address", request.Username + " looks like an invalid email address"); + } + + Request.Headers.TryGetValue(AppHeaders.BROWSER_TIME_ZONE, out var timeZoneHeader); + var tz = TimeZoneInfo.FindSystemTimeZoneById(timeZoneHeader.ToString().HasValue() ? timeZoneHeader.ToString() : "UTC"); + var offset = tz.BaseUtcOffset.Hours; + + // this is fine as long as the client is not connecting from Australia: Lord Howe Island + // according to https://en.wikipedia.org/wiki/Daylight_saving_time_by_country + if (tz.IsDaylightSavingTime(AppDateTime.UtcNow)) { + offset++; + } + + _logger.LogInformation("Request time zone (" + tz.Id + ") offset is: " + offset + " hours"); + var requestDateTime = TimeZoneInfo.ConvertTimeFromUtc(AppDateTime.UtcNow, tz); + _logger.LogInformation("Creating forgot password request with date time: " + requestDateTime.ToString("u")); + + try { + var user = _context.Users.SingleOrDefault(c => c.Username.Equals(request.Username)); + if (user != default) { + await _passwordResetService.AddRequestAsync(user, tz, cancellationToken); + return Ok(); + } + + _logger.LogInformation("User was not found, not doing request for password change"); + return Ok(); + } catch (Exception e) { + _logger.LogError(e, "_/password-reset-request/create threw an exception"); + return Ok(); + } + } +} \ No newline at end of file diff --git a/code/api/src/Endpoints/Internal/PasswordResetRequests/CreateResetRequestRoute.cs b/code/api/src/Endpoints/Internal/PasswordResetRequests/CreateResetRequestRoute.cs deleted file mode 100644 index 8fbc9a0..0000000 --- a/code/api/src/Endpoints/Internal/PasswordResetRequests/CreateResetRequestRoute.cs +++ /dev/null @@ -1,59 +0,0 @@ -namespace IOL.GreatOffice.Api.Endpoints.Internal.PasswordResetRequests; - -/// -public class CreateResetRequestRoute : RouteBaseAsync.WithRequest.WithActionResult -{ - private readonly ILogger _logger; - private readonly PasswordResetService _passwordResetService; - private readonly AppDbContext _context; - - /// - public CreateResetRequestRoute(ILogger logger, PasswordResetService passwordResetService, AppDbContext context) { - _logger = logger; - _passwordResetService = passwordResetService; - _context = context; - } - - /// - /// Create a new password reset request. - /// - /// - /// - /// - [AllowAnonymous] - [HttpGet("~/_/forgot-password-requests/create")] - public override async Task HandleAsync(string username, CancellationToken cancellationToken = default) { - if (!username.IsValidEmailAddress()) { - _logger.LogInformation("Username is invalid, not doing request for password change"); - return BadRequest(new ErrorResult("Invalid email address", username + " looks like an invalid email address")); - } - - Request.Headers.TryGetValue(AppHeaders.BROWSER_TIME_ZONE, out var timeZoneHeader); - var tz = TimeZoneInfo.FindSystemTimeZoneById(timeZoneHeader.ToString().HasValue() ? timeZoneHeader.ToString() : "UTC"); - var offset = tz.BaseUtcOffset.Hours; - - // this is fine as long as the client is not connecting from Australia: Lord Howe Island - // according to https://en.wikipedia.org/wiki/Daylight_saving_time_by_country - if (tz.IsDaylightSavingTime(AppDateTime.UtcNow)) { - offset++; - } - - _logger.LogInformation("Request time zone (" + tz.Id + ") offset is: " + offset + " hours"); - var requestDateTime = TimeZoneInfo.ConvertTimeFromUtc(AppDateTime.UtcNow, tz); - _logger.LogInformation("Creating forgot password request with date time: " + requestDateTime.ToString("u")); - - try { - var user = _context.Users.SingleOrDefault(c => c.Username.Equals(username)); - if (user != default) { - await _passwordResetService.AddRequestAsync(user, tz, cancellationToken); - return Ok(); - } - - _logger.LogInformation("User was not found, not doing request for password change"); - return Ok(); - } catch (Exception e) { - _logger.LogError(e, "ForgotAction failed badly"); - return Ok(); - } - } -} diff --git a/code/api/src/Endpoints/Internal/PasswordResetRequests/FulfillResetRequestRoute.cs b/code/api/src/Endpoints/Internal/PasswordResetRequests/FulfillResetRequestRoute.cs index 96f344a..a0ad4d0 100644 --- a/code/api/src/Endpoints/Internal/PasswordResetRequests/FulfillResetRequestRoute.cs +++ b/code/api/src/Endpoints/Internal/PasswordResetRequests/FulfillResetRequestRoute.cs @@ -18,7 +18,7 @@ public class FulfillResetRequestRoute : RouteBaseAsync.WithRequest /// [AllowAnonymous] - [HttpPost("~/_/forgot-password-requests/fulfill")] + [HttpPost("~/_/password-reset-request/fulfill")] public override async Task HandleAsync(FulfillResetRequestPayload request, CancellationToken cancellationToken = default) { try { var fulfilled = await _passwordResetService.FullFillRequestAsync(request.Id, request.NewPassword, cancellationToken); diff --git a/code/api/src/Endpoints/Internal/PasswordResetRequests/IsResetRequestValidRoute.cs b/code/api/src/Endpoints/Internal/PasswordResetRequests/IsResetRequestValidRoute.cs index c4dcd22..917c4f0 100644 --- a/code/api/src/Endpoints/Internal/PasswordResetRequests/IsResetRequestValidRoute.cs +++ b/code/api/src/Endpoints/Internal/PasswordResetRequests/IsResetRequestValidRoute.cs @@ -17,7 +17,7 @@ public class IsResetRequestValidRoute : RouteBaseAsync.WithRequest.WithAct /// /// [AllowAnonymous] - [HttpGet("~/_/forgot-password-requests/is-valid")] + [HttpGet("~/_/password-reset-request/is-valid")] public override async Task HandleAsync(Guid id, CancellationToken cancellationToken = default) { var request = await _passwordResetService.GetRequestAsync(id, cancellationToken); if (request == default) { diff --git a/code/api/src/Endpoints/Internal/RouteBaseAsync.cs b/code/api/src/Endpoints/Internal/RouteBaseAsync.cs index 1bb0af0..a87facf 100644 --- a/code/api/src/Endpoints/Internal/RouteBaseAsync.cs +++ b/code/api/src/Endpoints/Internal/RouteBaseAsync.cs @@ -7,7 +7,7 @@ public static class RouteBaseAsync { public static class WithRequest { - public abstract class WithResult : BaseRoute + public abstract class WithResult : INT_EndpointBase { public abstract Task HandleAsync( TRequest request, @@ -15,7 +15,7 @@ public static class RouteBaseAsync ); } - public abstract class WithoutResult : BaseRoute + public abstract class WithoutResult : INT_EndpointBase { public abstract Task HandleAsync( TRequest request, @@ -23,7 +23,7 @@ public static class RouteBaseAsync ); } - public abstract class WithActionResult : BaseRoute + public abstract class WithActionResult : INT_EndpointBase { public abstract Task> HandleAsync( TRequest request, @@ -31,7 +31,7 @@ public static class RouteBaseAsync ); } - public abstract class WithActionResult : BaseRoute + public abstract class WithActionResult : INT_EndpointBase { public abstract Task HandleAsync( TRequest request, @@ -42,28 +42,28 @@ public static class RouteBaseAsync public static class WithoutRequest { - public abstract class WithResult : BaseRoute + public abstract class WithResult : INT_EndpointBase { public abstract Task HandleAsync( CancellationToken cancellationToken = default ); } - public abstract class WithoutResult : BaseRoute + public abstract class WithoutResult : INT_EndpointBase { public abstract Task HandleAsync( CancellationToken cancellationToken = default ); } - public abstract class WithActionResult : BaseRoute + public abstract class WithActionResult : INT_EndpointBase { public abstract Task> HandleAsync( CancellationToken cancellationToken = default ); } - public abstract class WithActionResult : BaseRoute + public abstract class WithActionResult : INT_EndpointBase { public abstract Task HandleAsync( CancellationToken cancellationToken = default diff --git a/code/api/src/Endpoints/Internal/RouteBaseSync.cs b/code/api/src/Endpoints/Internal/RouteBaseSync.cs index 173999d..9d9bd5a 100644 --- a/code/api/src/Endpoints/Internal/RouteBaseSync.cs +++ b/code/api/src/Endpoints/Internal/RouteBaseSync.cs @@ -7,22 +7,22 @@ public static class RouteBaseSync { public static class WithRequest { - public abstract class WithResult : BaseRoute + public abstract class WithResult : INT_EndpointBase { public abstract TResponse Handle(TRequest request); } - public abstract class WithoutResult : BaseRoute + public abstract class WithoutResult : INT_EndpointBase { public abstract void Handle(TRequest request); } - public abstract class WithActionResult : BaseRoute + public abstract class WithActionResult : INT_EndpointBase { public abstract ActionResult Handle(TRequest request); } - public abstract class WithActionResult : BaseRoute + public abstract class WithActionResult : INT_EndpointBase { public abstract ActionResult Handle(TRequest request); } @@ -30,22 +30,22 @@ public static class RouteBaseSync public static class WithoutRequest { - public abstract class WithResult : BaseRoute + public abstract class WithResult : INT_EndpointBase { public abstract TResponse Handle(); } - public abstract class WithoutResult : BaseRoute + public abstract class WithoutResult : INT_EndpointBase { public abstract void Handle(); } - public abstract class WithActionResult : BaseRoute + public abstract class WithActionResult : INT_EndpointBase { public abstract ActionResult Handle(); } - public abstract class WithActionResult : BaseRoute + public abstract class WithActionResult : INT_EndpointBase { public abstract ActionResult Handle(); } -- cgit v1.3