chore: Cleanup Access Layer

Author: Soap-141

CHANGELOG.md

@@ -8,6 +8,8 @@ Prefix your items with `(Template)` if the change is about the template and not
 ## 3.10.X
 - Added Dependency Injection validation in the development environment.
 - Cleaned up the persistence configuration files (removed unused parameters and updated documentation).
+- Updated Contributing documentation.
+- Cleanup the 'Access' layer's code (renamed repositories into API clients, removed unused namespaces, and sealed some classes).
 
 ## 3.9.X
 - Removed unnecessary `IsExternalInit.cs` files.
@@ -20,7 +22,6 @@ Prefix your items with `(Template)` if the change is about the template and not
 - Optimized the .NET workloads install process.
 - Fixed the iOS application icon size.
 - Added VM Disposal in Functional Tests.
-- Updated Contributing documentation.
 
 ## 3.8.X
 - Updated from .NET 8 to .NET 9.

src/app/ApplicationTemplate.Access/ApiClients/Authentication/AuthenticationApiClientMock.cs

@@ -45,30 +45,26 @@ public async Task<AuthenticationData> RefreshToken(CancellationToken ct, Authent
 
 		await SimulateDelay(ct);
 
-		return CreateAuthenticationData(unauthorizedToken.AccessTokenPayload);
+		return CreateAuthenticationData(unauthorizedToken.AccessToken.Payload);
 	}
 
-	private AuthenticationData CreateAuthenticationData(AuthenticationToken token = null, TimeSpan? timeToLive = null)
+	private AuthenticationData CreateAuthenticationData(AuthenticationToken token = null)
 	{
-		var encodedJwt = CreateJsonWebToken(token, timeToLive);
-		var jwt = new JwtData<AuthenticationToken>(encodedJwt, _serializerOptions);
+		var encodedJwt = CreateJsonWebToken(token);
 
 		return new AuthenticationData()
 		{
-			AccessToken = jwt.Token,
+			AccessToken = new JwtData<AuthenticationToken>(encodedJwt, _serializerOptions),
 			RefreshToken = Guid.NewGuid().ToString(format: null, CultureInfo.InvariantCulture),
-			Expiration = jwt.Payload.Expiration,
 		};
 	}
 
-	private string CreateJsonWebToken(AuthenticationToken token = null, TimeSpan? timeToLive = null)
+	private string CreateJsonWebToken(AuthenticationToken token = null)
 	{
 		const string header = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9"; // alg=HS256, type=JWT
 		const string signature = "QWqnPP8W6ymexz74P6quP-oG-wxr7vMGqrEL8y_tV6M"; // dummy stuff
 
-		var now = DateTimeOffset.Now;
-
-		token = token ?? new AuthenticationToken(default, DateTimeOffset.MinValue, DateTimeOffset.MinValue);
+		token ??= new AuthenticationToken(default, DateTimeOffset.MinValue, DateTimeOffset.MinValue);
 
 		string payload;
 		using (var stream = new MemoryStream())

src/app/ApplicationTemplate.Access/ApiClients/Authentication/AuthenticationData.cs

@@ -0,0 +1,27 @@
+using System;
+using System.Text.Json.Serialization;
+using MallardMessageHandlers;
+
+namespace ApplicationTemplate.DataAccess;
+
+public sealed class AuthenticationData : IAuthenticationToken
+{
+	[JsonPropertyName("access_token")]
+	[JsonConverter(typeof(JwtDataJsonConverter<AuthenticationToken>))]
+	public JwtData<AuthenticationToken> AccessToken { get; init; }
+
+	[JsonPropertyName("refresh_token")]
+	public string RefreshToken { get; init; }
+
+	[JsonIgnore]
+	string IAuthenticationToken.AccessToken => AccessToken?.Token;
+
+	[JsonIgnore]
+	public bool CanBeRefreshed => !string.IsNullOrEmpty(RefreshToken);
+
+	[JsonIgnore]
+	public string Email => AccessToken?.Payload?.Email;
+
+	[JsonIgnore]
+	public DateTimeOffset? Expiration => AccessToken?.Payload?.Expiration;
+}

src/app/ApplicationTemplate.Access/ApiClients/Authentication/Data/AuthenticationData.cs

@@ -1,13 +1,10 @@
 using System;
-using System.Text.Json;
 using System.Text.Json.Serialization;
 
 namespace ApplicationTemplate.DataAccess;
 
-public class AuthenticationToken
+public sealed class AuthenticationToken
 {
-	public AuthenticationToken() { }
-
 	public AuthenticationToken(string email, DateTimeOffset expiration, DateTimeOffset issuedAt)
 	{
 		Email = email;
@@ -16,13 +13,13 @@ public AuthenticationToken(string email, DateTimeOffset expiration, DateTimeOffs
 	}
 
 	[JsonPropertyName("unique_name")]
-	public string Email { get; set; }
+	public string Email { get; init; }
 
 	[JsonPropertyName("exp")]
 	[JsonConverter(typeof(UnixTimestampJsonConverter))]
-	public DateTimeOffset Expiration { get; set; }
+	public DateTimeOffset Expiration { get; init; }
 
 	[JsonPropertyName("iat")]
 	[JsonConverter(typeof(UnixTimestampJsonConverter))]
-	public DateTimeOffset IssuedAt { get; set; }
+	public DateTimeOffset IssuedAt { get; init; }
 }

src/app/ApplicationTemplate.Access/ApiClients/Authentication/AuthenticationToken.cs renamed to src/app/ApplicationTemplate.Access/ApiClients/Authentication/Data/AuthenticationToken.cs

@@ -1,7 +1,4 @@
-using System;
-using System.Collections.Generic;
-using System.Text;
-using System.Threading;
+using System.Threading;
 using System.Threading.Tasks;
 
 namespace ApplicationTemplate.DataAccess;

src/app/ApplicationTemplate.Access/ApiClients/Authentication/IAuthenticationApiClient.cs

@@ -0,0 +1,5 @@
+namespace ApplicationTemplate.DataAccess;
+
+public sealed class ErrorData
+{
+}

src/app/ApplicationTemplate.Access/ApiClients/Posts/Data/ErrorData.cs

@@ -1,11 +1,8 @@
-using System;
-using System.Collections.Generic;
-using System.Text;
-using System.Text.Json.Serialization;
+using System.Text.Json.Serialization;
 
 namespace ApplicationTemplate.DataAccess;
 
-public record PostData
+public sealed record PostData
 {
 	public PostData(long id, string title, string body, long userIdentifier)
 	{

src/app/ApplicationTemplate.Access/ApiClients/Posts/PostData.cs renamed to src/app/ApplicationTemplate.Access/ApiClients/Posts/Data/PostData.cs

@@ -0,0 +1,8 @@
+namespace ApplicationTemplate.DataAccess;
+
+public sealed class PostErrorResponse
+{
+	public PostData Data { get; }
+
+	public ErrorData Error { get; }
+}

src/app/ApplicationTemplate.Access/ApiClients/Posts/Data/PostErrorResponse.cs

@@ -1,7 +1,4 @@
-using System;
-using System.Collections.Generic;
-using System.Text;
-using System.Threading;
+using System.Threading;
 using System.Threading.Tasks;
 using Refit;
 
@@ -11,7 +8,7 @@ namespace ApplicationTemplate.DataAccess;
 /// Provides access to the posts API.
 /// </summary>
 [Headers("Authorization: Bearer")]
-public interface IPostsRepository
+public interface IPostsApiClient
 {
 	/// <summary>
 	/// Gets the list of all posts.

src/app/ApplicationTemplate.Access/ApiClients/Posts/ErrorData.cs

@@ -0,0 +1,24 @@
+using System;
+
+namespace ApplicationTemplate.DataAccess;
+
+public sealed class PostsApiClientException : Exception
+{
+	public PostsApiClientException()
+	{
+	}
+
+	public PostsApiClientException(string message)
+		: base(message)
+	{
+	}
+
+	public PostsApiClientException(string message, Exception innerException)
+		: base(message, innerException)
+	{
+	}
+
+	public PostsApiClientException(PostErrorResponse errorResponse)
+	{
+	}
+}

src/app/ApplicationTemplate.Access/ApiClients/Posts/IPostRepository.cs renamed to src/app/ApplicationTemplate.Access/ApiClients/Posts/IPostsApiClient.cs

@@ -1,16 +1,13 @@
-using System;
-using System.Collections.Generic;
-using System.Text;
-using System.Text.Json;
+using System.Text.Json;
 using System.Threading;
 using System.Threading.Tasks;
 using Refit;
 
 namespace ApplicationTemplate.DataAccess;
 
-public class PostsRepositoryMock : BaseMock, IPostsRepository
+public sealed class PostsApiClientMock : BaseMock, IPostsApiClient
 {
-	public PostsRepositoryMock(JsonSerializerOptions serializerOptions)
+	public PostsApiClientMock(JsonSerializerOptions serializerOptions)
 		: base(serializerOptions)
 	{
 	}

src/app/ApplicationTemplate.Access/ApiClients/Posts/PostErrorResponse.cs

@@ -1,7 +1,4 @@
-using System;
-using System.Collections.Generic;
-using System.Text;
-using System.Threading;
+using System.Threading;
 using System.Threading.Tasks;
 using Refit;
 
@@ -11,7 +8,7 @@ namespace ApplicationTemplate.DataAccess;
 /// Provides access to the user profile API.
 /// </summary>
 [Headers("Authorization: Bearer")]
-public interface IUserProfileRepository
+public interface IUserProfileApiClient
 {
 	/// <summary>
 	/// Returns the current user profile.

src/app/ApplicationTemplate.Access/ApiClients/Posts/PostRepositoryException.cs

@@ -1,6 +1,4 @@
 using System;
-using System.Collections.Generic;
-using System.Text;
 using System.Text.Json;
 using System.Threading;
 using System.Threading.Tasks;
@@ -9,12 +7,12 @@
 
 namespace ApplicationTemplate.DataAccess;
 
-public class UserProfileRepositoryMock : BaseMock, IUserProfileRepository
+public sealed class UserProfileApiClientMock : BaseMock, IUserProfileApiClient
 {
 	private readonly IAuthenticationTokenProvider<AuthenticationData> _tokenProvider;
 	private readonly IOptionsMonitor<MockOptions> _mockOptionsMonitor;
 
-	public UserProfileRepositoryMock(
+	public UserProfileApiClientMock(
 		IAuthenticationTokenProvider<AuthenticationData> tokenProvider,
 		JsonSerializerOptions serializerOptions,
 		IOptionsMonitor<MockOptions> mockOptionsMonitor)

src/app/ApplicationTemplate.Access/ApiClients/Posts/PostsApiClientException.cs

@@ -10,8 +10,8 @@
 
 	<ItemGroup>
 		<EmbeddedResource Include="ApiClients\DadJokes\DadJokesApiClientMock.FetchData.json" />
-		<EmbeddedResource Include="ApiClients\Posts\PostsRepositoryMock.GetAll.json" />
-		<EmbeddedResource Include="ApiClients\UserProfile\UserProfileRepositoryMock.Get.json" />
+		<EmbeddedResource Include="ApiClients\Posts\PostsApiClientMock.GetAll.json" />
+		<EmbeddedResource Include="ApiClients\UserProfile\UserProfileApiClientMock.Get.json" />
 	</ItemGroup>
 
 	<ItemGroup>

src/app/ApplicationTemplate.Access/ApiClients/Posts/PostsRepositoryMock.GetAll.json renamed to src/app/ApplicationTemplate.Access/ApiClients/Posts/PostsApiClientMock.GetAll.json

@@ -8,9 +8,9 @@ namespace ApplicationTemplate.Business;
 
 public partial class PostService : IPostService
 {
-	private readonly IPostsRepository _postsRepository;
+	private readonly IPostsApiClient _postsRepository;
 
-	public PostService(IPostsRepository postsRepository)
+	public PostService(IPostsApiClient postsRepository)
 	{
 		_postsRepository = postsRepository;
 	}

src/app/ApplicationTemplate.Access/ApiClients/Posts/PostsRepositoryMock.cs renamed to src/app/ApplicationTemplate.Access/ApiClients/Posts/PostsApiClientMock.cs

@@ -12,9 +12,9 @@ namespace ApplicationTemplate.Business;
 
 public partial class UserProfileService : IUserProfileService
 {
-	private readonly IUserProfileRepository _profileRepository;
+	private readonly IUserProfileApiClient _profileRepository;
 
-	public UserProfileService(IUserProfileRepository profileRepository)
+	public UserProfileService(IUserProfileApiClient profileRepository)
 	{
 		_profileRepository = profileRepository ?? throw new ArgumentNullException(nameof(profileRepository));
 	}

src/app/ApplicationTemplate.Access/ApiClients/UserProfile/IUserProfileRepository.cs renamed to src/app/ApplicationTemplate.Access/ApiClients/UserProfile/IUserProfileApiClient.cs

@@ -53,7 +53,7 @@ public static IServiceCollection AddApi(this IServiceCollection services, IConfi
 	private static IServiceCollection AddUserProfile(this IServiceCollection services)
 	{
 		// This one doesn't have an actual remote API yet. It's always a mock implementation.
-		return services.AddSingleton<IUserProfileRepository, UserProfileRepositoryMock>();
+		return services.AddSingleton<IUserProfileApiClient, UserProfileApiClientMock>();
 	}
 
 	private static IServiceCollection AddMinimumVersion(this IServiceCollection services)
@@ -79,10 +79,10 @@ private static IServiceCollection AddPosts(this IServiceCollection services, ICo
 		return services
 			.AddSingleton<IErrorResponseInterpreter<PostErrorResponse>>(s => new ErrorResponseInterpreter<PostErrorResponse>(
 				(request, response, deserializedResponse) => deserializedResponse.Error != null,
-				(request, response, deserializedResponse) => new PostRepositoryException(deserializedResponse)
+				(request, response, deserializedResponse) => new PostsApiClientException(deserializedResponse)
 			))
 			.AddTransient<ExceptionInterpreterHandler<PostErrorResponse>>()
-			.AddApiClient<IPostsRepository, PostsRepositoryMock>(configuration, "PostApiClient", b => b
+			.AddApiClient<IPostsApiClient, PostsApiClientMock>(configuration, "PostApiClient", b => b
 				.AddHttpMessageHandler<ExceptionInterpreterHandler<PostErrorResponse>>()
 				.AddHttpMessageHandler<AuthenticationTokenHandler<AuthenticationData>>()
 			);