AaronPo/the-biergarten-app
1
0
Fork 0
mirror of https://github.com/aaronpo97/the-biergarten-app.git synced 2026-02-16 10:42:08 +00:00
Code Issues Packages Projects 1 Releases Wiki Activity

Refactor user entities and repositories, update seeders

Browse Source 
Standardized property naming in user-related entities to use 'Id' suffix (e.g., UserAccountId). Moved and updated repository interfaces and implementations to the DataAccessLayer.Repositories namespace. Refactored DBSeed seeders to use repository classes and improved structure. Updated .gitignore and project references
This commit is contained in:
Aaron Po
2026-01-15 13:23:41 -05:00
parent 60ef65ec52
commit b8cd855916
16 changed files with 660 additions and 760 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
.gitignore vendored
View File

@@ -431,3 +431,4 @@ FodyWeavers.xsd
*/data_source/other
.fake
.idea

1
BusinessLayer/Services/UserService.cs
View File

@@ -1,5 +1,6 @@
using DataAccessLayer;
using DataAccessLayer.Entities;
using DataAccessLayer.Repositories;
namespace BusinessLayer.Services
{

40
DALTests/UserAccountRepositoryTests.cs
View File

@@ -1,20 +1,12 @@
using System;
using System.Collections.Generic;
using System.Linq;
using DataAccessLayer;
using DataAccessLayer.Entities;
using Xunit;
using DataAccessLayer.Repositories;
namespace DALTests
{
public class UserAccountRepositoryTests
{
private readonly IUserAccountRepository _repository;
public UserAccountRepositoryTests()
{
_repository = new UserAccountRepository();
}
private readonly IUserAccountRepository _repository = new UserAccountRepository();
[Fact]
public void Add_ShouldInsertUserAccount()
@@ -22,7 +14,7 @@ namespace DALTests
// Arrange
var userAccount = new UserAccount
{
UserAccountID = Guid.NewGuid(),
UserAccountId = Guid.NewGuid(),
Username = "testuser",
FirstName = "Test",
LastName = "User",
@@ -33,7 +25,7 @@ namespace DALTests
// Act
_repository.Add(userAccount);
var retrievedUser = _repository.GetById(userAccount.UserAccountID);
var retrievedUser = _repository.GetById(userAccount.UserAccountId);
// Assert
Assert.NotNull(retrievedUser);
@@ -47,7 +39,7 @@ namespace DALTests
var userId = Guid.NewGuid();
var userAccount = new UserAccount
{
UserAccountID = userId,
UserAccountId = userId,
Username = "existinguser",
FirstName = "Existing",
LastName = "User",
@@ -62,7 +54,7 @@ namespace DALTests
// Assert
Assert.NotNull(retrievedUser);
Assert.Equal(userId, retrievedUser.UserAccountID);
Assert.Equal(userId, retrievedUser.UserAccountId);
}
[Fact]
@@ -71,7 +63,7 @@ namespace DALTests
// Arrange
var userAccount = new UserAccount
{
UserAccountID = Guid.NewGuid(),
UserAccountId = Guid.NewGuid(),
Username = "updatableuser",
FirstName = "Updatable",
LastName = "User",
@@ -84,7 +76,7 @@ namespace DALTests
// Act
userAccount.FirstName = "Updated";
_repository.Update(userAccount);
var updatedUser = _repository.GetById(userAccount.UserAccountID);
var updatedUser = _repository.GetById(userAccount.UserAccountId);
// Assert
Assert.NotNull(updatedUser);
@@ -97,7 +89,7 @@ namespace DALTests
// Arrange
var userAccount = new UserAccount
{
UserAccountID = Guid.NewGuid(),
UserAccountId = Guid.NewGuid(),
Username = "deletableuser",
FirstName = "Deletable",
LastName = "User",
@@ -108,8 +100,8 @@ namespace DALTests
_repository.Add(userAccount);
// Act
_repository.Delete(userAccount.UserAccountID);
var deletedUser = _repository.GetById(userAccount.UserAccountID);
_repository.Delete(userAccount.UserAccountId);
var deletedUser = _repository.GetById(userAccount.UserAccountId);
// Assert
Assert.Null(deletedUser);
@@ -121,7 +113,7 @@ namespace DALTests
// Arrange
var user1 = new UserAccount
{
UserAccountID = Guid.NewGuid(),
UserAccountId = Guid.NewGuid(),
Username = "user1",
FirstName = "User",
LastName = "One",
@@ -131,7 +123,7 @@ namespace DALTests
};
var user2 = new UserAccount
{
UserAccountID = Guid.NewGuid(),
UserAccountId = Guid.NewGuid(),
Username = "user2",
FirstName = "User",
LastName = "Two",
@@ -158,7 +150,7 @@ namespace DALTests
{
new UserAccount
{
UserAccountID = Guid.NewGuid(),
UserAccountId = Guid.NewGuid(),
Username = $"pageuser_{Guid.NewGuid():N}",
FirstName = "Page",
LastName = "User",
@@ -168,7 +160,7 @@ namespace DALTests
},
new UserAccount
{
UserAccountID = Guid.NewGuid(),
UserAccountId = Guid.NewGuid(),
Username = $"pageuser_{Guid.NewGuid():N}",
FirstName = "Page",
LastName = "User",
@@ -178,7 +170,7 @@ namespace DALTests
},
new UserAccount
{
UserAccountID = Guid.NewGuid(),
UserAccountId = Guid.NewGuid(),
Username = $"pageuser_{Guid.NewGuid():N}",
FirstName = "Page",
LastName = "User",

6
DBSeed/DBSeed.csproj
View File

@@ -12,6 +12,10 @@
Include="Konscious.Security.Cryptography.Argon2"
Version="1.3.1"
/>
<PackageReference Include="Microsoft.Data.SqlClient" Version="6.1.2" />
<PackageReference Include="Microsoft.Data.SqlClient" Version="6.1.3" />
</ItemGroup>
<ItemGroup>
<ProjectReference Include="..\DataAccessLayer\DataAccessLayer.csproj" />
</ItemGroup>
</Project>

5
DBSeed/ISeeder.cs
View File

@@ -1,6 +1,9 @@
using Microsoft.Data.SqlClient;
interface ISeeder
namespace DBSeed
{
internal interface ISeeder
{
Task SeedAsync(SqlConnection connection);
}
}

22
DBSeed/LocationSeeder.cs
View File

@@ -1,10 +1,11 @@
using System.Data;
using Microsoft.Data.SqlClient;
namespace DBSeed;
class LocationSeeder : ISeeder
namespace DBSeed
{
internal class LocationSeeder : ISeeder
{
private static readonly IReadOnlyList<(
string CountryName,
string CountryCode
@@ -15,11 +16,10 @@ class LocationSeeder : ISeeder
("United States", "US"),
];
private static readonly IReadOnlyList<(
string StateProvinceName,
string StateProvinceCode,
string CountryCode
)> States =
private static IReadOnlyList<(string StateProvinceName, string StateProvinceCode, string CountryCode)> States
{
get;
} =
[
("Alabama", "US-AL", "US"),
("Alaska", "US-AK", "US"),
@@ -124,10 +124,7 @@ class LocationSeeder : ISeeder
("Ciudad de México", "MX-CMX", "MX"),
];
private static readonly IReadOnlyList<(
string StateProvinceCode,
string CityName
)> Cities =
private static IReadOnlyList<(string StateProvinceCode, string CityName)> Cities { get; } =
[
("US-CA", "Los Angeles"),
("US-CA", "San Diego"),
@@ -327,4 +324,5 @@ class LocationSeeder : ISeeder
await command.ExecuteNonQueryAsync();
}
}
}

144
DBSeed/UserSeeder.cs
View File

@@ -1,14 +1,20 @@
using System.Data;
using System.Security.Cryptography;
using System.Text;
using DataAccessLayer.Entities;
using DataAccessLayer.Repositories;
using idunno.Password;
using Konscious.Security.Cryptography;
using Microsoft.Data.SqlClient;
namespace DBSeed;
class UserSeeder : ISeeder
namespace DBSeed
{
internal class UserSeeder : ISeeder
{
private UserAccountRepository _userAccountRepository = new UserAccountRepository();
private static readonly IReadOnlyList<(
string FirstName,
string LastName
@@ -119,40 +125,25 @@ class UserSeeder : ISeeder
public async Task SeedAsync(SqlConnection connection)
{
var generator = new PasswordGenerator();
var random = new Random();
var rng = new Random();
int createdUsers = 0;
int createdCredentials = 0;
int createdVerifications = 0;
foreach (var (firstName, lastName) in SeedNames)
{
string username = BuildUsername(firstName, lastName);
string email = BuildEmail(firstName, lastName);
Guid? existingId =
await GetUserAccountIdByUsernameAsync(connection, username)
?? await GetUserAccountIdByEmailAsync(connection, email);
Guid userAccountId;
if (existingId.HasValue)
// create the user in the database
var ua = new UserAccount
{
userAccountId = existingId.Value;
}
else
{
userAccountId = Guid.NewGuid();
DateTime dateOfBirth = GenerateDateOfBirth(random);
await CreateUserAccountAsync(
connection,
userAccountId,
username,
firstName,
lastName,
email,
dateOfBirth
);
createdUsers++;
}
FirstName = firstName,
LastName = lastName,
Email = $"{firstName}.{lastName}@thebiergarten.app",
Username = $"{firstName[0]}.{lastName}",
DateOfBirth = GenerateDateOfBirth(rng)
};
// add user credentials
if (!await HasUserCredentialAsync(connection, userAccountId))
{
string pwd = generator.Generate(
@@ -165,12 +156,11 @@ class UserSeeder : ISeeder
createdCredentials++;
}
if (!await HasUserVerificationAsync(connection, userAccountId))
{
// add user verification
if (await HasUserVerificationAsync(connection, userAccountId)) continue;
await AddUserVerificationAsync(connection, userAccountId);
createdVerifications++;
}
}
Console.WriteLine($"Created {createdUsers} user accounts.");
Console.WriteLine($"Added {createdCredentials} user credentials.");
@@ -193,73 +183,16 @@ class UserSeeder : ISeeder
return $"{Convert.ToBase64String(salt)}:{Convert.ToBase64String(hash)}";
}
private static async Task<Guid?> GetUserAccountIdByUsernameAsync(
SqlConnection connection,
string username
)
{
await using var command = new SqlCommand(
"usp_GetUserAccountByUsername",
connection
);
command.CommandType = CommandType.StoredProcedure;
command.Parameters.AddWithValue("@Username", username);
await using var reader = await command.ExecuteReaderAsync();
return await reader.ReadAsync() ? reader.GetGuid(0) : null;
}
private static async Task<Guid?> GetUserAccountIdByEmailAsync(
SqlConnection connection,
string email
)
{
await using var command = new SqlCommand(
"usp_GetUserAccountByEmail",
connection
);
command.CommandType = CommandType.StoredProcedure;
command.Parameters.AddWithValue("@Email", email);
await using var reader = await command.ExecuteReaderAsync();
return await reader.ReadAsync() ? reader.GetGuid(0) : null;
}
private static async Task CreateUserAccountAsync(
SqlConnection connection,
Guid userAccountId,
string username,
string firstName,
string lastName,
string email,
DateTime dateOfBirth
)
{
await using var command = new SqlCommand(
"usp_CreateUserAccount",
connection
);
command.CommandType = CommandType.StoredProcedure;
command.Parameters.AddWithValue("@UserAccountId", userAccountId);
command.Parameters.AddWithValue("@Username", username);
command.Parameters.AddWithValue("@FirstName", firstName);
command.Parameters.AddWithValue("@LastName", lastName);
command.Parameters.AddWithValue("@DateOfBirth", dateOfBirth);
command.Parameters.AddWithValue("@Email", email);
await command.ExecuteNonQueryAsync();
}
private static async Task<bool> HasUserCredentialAsync(
SqlConnection connection,
Guid userAccountId
)
{
const string sql = """
SELECT 1
FROM dbo.UserCredential
WHERE UserAccountId = @UserAccountId;
""";
const string sql = $"""
SELECT 1
FROM dbo.UserCredential
WHERE UserAccountId = @UserAccountId;
""";
await using var command = new SqlCommand(sql, connection);
command.Parameters.AddWithValue("@UserAccountId", userAccountId);
object? result = await command.ExecuteScalarAsync();
@@ -289,13 +222,13 @@ WHERE UserAccountId = @UserAccountId;
)
{
const string sql = """
SELECT 1
FROM dbo.UserVerification
WHERE UserAccountId = @UserAccountId;
""";
SELECT 1
FROM dbo.UserVerification
WHERE UserAccountId = @UserAccountId;
""";
await using var command = new SqlCommand(sql, connection);
command.Parameters.AddWithValue("@UserAccountId", userAccountId);
object? result = await command.ExecuteScalarAsync();
var result = await command.ExecuteScalarAsync();
return result is not null;
}
@@ -314,18 +247,6 @@ WHERE UserAccountId = @UserAccountId;
await command.ExecuteNonQueryAsync();
}
private static string BuildUsername(string firstName, string lastName)
{
string username = $"{firstName}.{lastName}".ToLowerInvariant();
return username.Length <= 64 ? username : username[..64];
}
private static string BuildEmail(string firstName, string lastName)
{
string email = $"{firstName}.{lastName}@example.com".ToLowerInvariant();
return email.Length <= 128 ? email : email[..128];
}
private static DateTime GenerateDateOfBirth(Random random)
{
int age = 19 + random.Next(0, 30);
@@ -333,4 +254,5 @@ WHERE UserAccountId = @UserAccountId;
int offsetDays = random.Next(0, 365);
return baseDate.AddDays(-offsetDays);
}
}
}

2
DataAccessLayer/Entities/UserAccount.cs
View File

@@ -2,7 +2,7 @@ namespace DataAccessLayer.Entities;
public class UserAccount
{
public Guid UserAccountID { get; set; }
public Guid UserAccountId { get; set; }
public string Username { get; set; } = string.Empty;
public string FirstName { get; set; } = string.Empty;
public string LastName { get; set; } = string.Empty;

4
DataAccessLayer/Entities/UserCredential.cs
View File

@@ -2,8 +2,8 @@ namespace DataAccessLayer.Entities;
public class UserCredential
{
public Guid UserCredentialID { get; set; }
public Guid UserAccountID { get; set; }
public Guid UserCredentialId { get; set; }
public Guid UserAccountId { get; set; }
public DateTime CreatedAt { get; set; }
public DateTime Expiry { get; set; }
public string Hash { get; set; } = string.Empty;

4
DataAccessLayer/Entities/UserVerification.cs
View File

@@ -2,8 +2,8 @@ namespace DataAccessLayer.Entities;
public class UserVerification
{
public Guid UserVerificationID { get; set; }
public Guid UserAccountID { get; set; }
public Guid UserVerificationId { get; set; }
public Guid UserAccountId { get; set; }
public DateTime VerificationDateTime { get; set; }
public byte[]? Timer { get; set; }
}

9
DataAccessLayer/IRepository.cs → DataAccessLayer/Repositories/IRepository.cs
View File

@@ -1,7 +1,8 @@
using System;
using System.Collections.Generic;
namespace DataAccessLayer
using Microsoft.Data.SqlClient;
namespace DataAccessLayer.Repositories
{
public interface IRepository<T>
where T : class
@@ -13,5 +14,7 @@ namespace DataAccessLayer
T? GetById(Guid id);
void Update(T entity);
void Delete(Guid id);
T MapToEntity(SqlDataReader entity);
}
}

4
DataAccessLayer/Repositories/IUserAccountRepository.cs
View File

@@ -1,8 +1,6 @@
using System;
using System.Collections.Generic;
using DataAccessLayer.Entities;
namespace DataAccessLayer
namespace DataAccessLayer.Repositories
{
public interface IUserAccountRepository : IRepository<UserAccount>
{

101
DataAccessLayer/Repositories/UserAccountRepository.cs
View File

@@ -1,30 +1,36 @@
using System;
using System.Collections.Generic;
using DataAccessLayer.Entities;
using Microsoft.Data.SqlClient;
namespace DataAccessLayer
namespace DataAccessLayer.Repositories
{
public class UserAccountRepository : IUserAccountRepository
{
private readonly string _connectionString;
public UserAccountRepository()
{
// Retrieve the connection string from environment variables
_connectionString =
Environment.GetEnvironmentVariable("DB_CONNECTION_STRING")
private readonly string _connectionString = Environment.GetEnvironmentVariable("DB_CONNECTION_STRING")
?? throw new InvalidOperationException(
"The connection string is not set in the environment variables."
);
}
public void Add(UserAccount userAccount)
{
using SqlConnection connection = new(_connectionString);
using SqlCommand command = new("usp_CreateUserAccount", connection);
command.CommandType = System.Data.CommandType.StoredProcedure;
AddUserAccountCreateParameters(command, userAccount);
command.Parameters.AddWithValue(
"@UserAccountId",
userAccount.UserAccountId
);
command.Parameters.AddWithValue("@Username", userAccount.Username);
command.Parameters.AddWithValue(
"@FirstName",
userAccount.FirstName
);
command.Parameters.AddWithValue("@LastName", userAccount.LastName);
command.Parameters.AddWithValue("@Email", userAccount.Email);
command.Parameters.AddWithValue(
"@DateOfBirth",
userAccount.DateOfBirth
);
connection.Open();
command.ExecuteNonQuery();
}
@@ -41,7 +47,7 @@ namespace DataAccessLayer
connection.Open();
using SqlDataReader reader = command.ExecuteReader();
return reader.Read() ? MapUserAccount(reader) : null;
return reader.Read() ? MapToEntity(reader) : null;
}
public void Update(UserAccount userAccount)
@@ -49,7 +55,25 @@ namespace DataAccessLayer
using SqlConnection connection = new(_connectionString);
using SqlCommand command = new("usp_UpdateUserAccount", connection);
command.CommandType = System.Data.CommandType.StoredProcedure;
AddUserAccountUpdateParameters(command, userAccount);
command.Parameters.AddWithValue(
"@UserAccountId",
userAccount.UserAccountId
);
command.Parameters.AddWithValue("@Username", userAccount.Username);
command.Parameters.AddWithValue(
"@FirstName",
userAccount.FirstName
);
command.Parameters.AddWithValue("@LastName", userAccount.LastName);
command.Parameters.AddWithValue("@Email", userAccount.Email);
command.Parameters.AddWithValue(
"@DateOfBirth",
userAccount.DateOfBirth
);
command.Parameters.AddWithValue(
"@UserAccountId",
userAccount.UserAccountId
);
connection.Open();
command.ExecuteNonQuery();
}
@@ -64,9 +88,10 @@ namespace DataAccessLayer
command.ExecuteNonQuery();
}
public IEnumerable<UserAccount> GetAll(int? limit, int? offset)
{
if (limit.HasValue && limit <= 0)
if (limit is <= 0)
{
throw new ArgumentOutOfRangeException(
nameof(limit),
@@ -110,7 +135,7 @@ namespace DataAccessLayer
List<UserAccount> users = new();
while (reader.Read())
{
users.Add(MapUserAccount(reader));
users.Add(MapToEntity(reader));
}
return users;
@@ -127,8 +152,8 @@ namespace DataAccessLayer
command.Parameters.AddWithValue("@Username", username);
connection.Open();
using SqlDataReader reader = command.ExecuteReader();
return reader.Read() ? MapUserAccount(reader) : null;
using SqlDataReader? reader = command.ExecuteReader();
return reader.Read() ? MapToEntity(reader) : null;
}
public UserAccount? GetByEmail(string email)
@@ -143,48 +168,14 @@ namespace DataAccessLayer
connection.Open();
using SqlDataReader reader = command.ExecuteReader();
return reader.Read() ? MapUserAccount(reader) : null;
return reader.Read() ? MapToEntity(reader) : null;
}
private static void AddUserAccountCreateParameters(
SqlCommand command,
UserAccount userAccount
)
{
command.Parameters.AddWithValue(
"@UserAccountId",
userAccount.UserAccountID
);
command.Parameters.AddWithValue("@Username", userAccount.Username);
command.Parameters.AddWithValue(
"@FirstName",
userAccount.FirstName
);
command.Parameters.AddWithValue("@LastName", userAccount.LastName);
command.Parameters.AddWithValue("@Email", userAccount.Email);
command.Parameters.AddWithValue(
"@DateOfBirth",
userAccount.DateOfBirth
);
}
private static void AddUserAccountUpdateParameters(
SqlCommand command,
UserAccount userAccount
)
{
AddUserAccountCreateParameters(command, userAccount);
command.Parameters.AddWithValue(
"@UserAccountId",
userAccount.UserAccountID
);
}
private static UserAccount MapUserAccount(SqlDataReader reader)
public UserAccount MapToEntity(SqlDataReader reader)
{
return new UserAccount
{
UserAccountID = reader.GetGuid(0),
UserAccountId = reader.GetGuid(0),
Username = reader.GetString(1),
FirstName = reader.GetString(2),
LastName = reader.GetString(3),

34
DataAccessLayer/Sql/DatabaseHelper.cs
View File

@@ -4,38 +4,27 @@ using Microsoft.Data.SqlClient;
namespace DataAccessLayer.Sql
{
public class DatabaseHelper
public class DatabaseHelper(string connectionString)
{
private readonly string _connectionString;
public DatabaseHelper(string connectionString)
{
_connectionString = connectionString;
}
public void ExecuteRawSql(string query)
{
try
{
using (
SqlConnection connection = new SqlConnection(
_connectionString
)
)
{
using var connection = new SqlConnection(
connectionString
);
connection.Open();
using (
SqlCommand command = new SqlCommand(query, connection)
)
{
using var command = new SqlCommand(query, connection);
command.CommandType = CommandType.Text;
using (SqlDataReader reader = command.ExecuteReader())
{
using var reader = command.ExecuteReader();
while (reader.Read())
{
for (int i = 0; i < reader.FieldCount; i++)
for (var i = 0; i < reader.FieldCount; i++)
{
Console.WriteLine(
$"{reader.GetName(i)}: {reader.GetValue(i)}"
@@ -43,9 +32,6 @@ namespace DataAccessLayer.Sql
}
}
}
}
}
}
catch (Exception ex)
{
Console.WriteLine($"An error occurred: {ex.Message}");

12
WebAPI/Controllers/UsersController.cs
View File

@@ -65,15 +65,15 @@ namespace WebAPI.Controllers
[HttpPost]
public IActionResult CreateUser([FromBody] UserAccount userAccount)
{
if (userAccount.UserAccountID == Guid.Empty)
if (userAccount.UserAccountId == Guid.Empty)
{
userAccount.UserAccountID = Guid.NewGuid();
userAccount.UserAccountId = Guid.NewGuid();
}
_userService.Add(userAccount);
return CreatedAtAction(
nameof(GetUserById),
new { id = userAccount.UserAccountID },
new { id = userAccount.UserAccountId },
userAccount
);
}
@@ -85,14 +85,14 @@ namespace WebAPI.Controllers
)
{
if (
userAccount.UserAccountID != Guid.Empty
&& userAccount.UserAccountID != id
userAccount.UserAccountId != Guid.Empty
&& userAccount.UserAccountId != id
)
{
return BadRequest("UserAccountID does not match route id.");
}
userAccount.UserAccountID = id;
userAccount.UserAccountId = id;
_userService.Update(userAccount);
return NoContent();
}

1
WebAPI/Program.cs
View File

@@ -1,5 +1,6 @@
using BusinessLayer.Services;
using DataAccessLayer;
using DataAccessLayer.Repositories;
var builder = WebApplication.CreateBuilder(args);