mirrors/CleanArchitecture
0
0
Fork 0
mirror of https://github.com/alex289/CleanArchitecture.git synced 2025-06-29 18:21:08 +00:00
Code

feat: Convert deleted flag to timestamp (#83)

Browse Source
This commit is contained in:
Alex 2024-12-09 11:10:50 +01:00 committed by GitHub
commit 3360b59de1
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
23 changed files with 348 additions and 34 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
CleanArchitecture.Application/Queries/Tenants/GetAll/GetAllTenantsQueryHandler.cs
View File

@ -33,8 +33,8 @@ public sealed class GetAllTenantsQueryHandler :
var tenantsQuery = _tenantRepository
.GetAllNoTracking()
.IgnoreQueryFilters()
.Include(x => x.Users.Where(y => request.IncludeDeleted || !y.Deleted))
.Where(x => request.IncludeDeleted || !x.Deleted);
.Include(x => x.Users.Where(y => request.IncludeDeleted || y.DeletedAt == null))
.Where(x => request.IncludeDeleted || x.DeletedAt == null );
if (!string.IsNullOrWhiteSpace(request.SearchTerm))
{

2
CleanArchitecture.Application/Queries/Users/GetAll/GetAllUsersQueryHandler.cs
View File

@ -33,7 +33,7 @@ public sealed class GetAllUsersQueryHandler :
var usersQuery = _userRepository
.GetAllNoTracking()
.IgnoreQueryFilters()
.Where(x => request.IncludeDeleted || !x.Deleted);
.Where(x => request.IncludeDeleted || x.DeletedAt == null);
if (!string.IsNullOrWhiteSpace(request.SearchTerm))
{

2
CleanArchitecture.Application/gRPC/TenantsApiImplementation.cs
View File

@ -40,7 +40,7 @@ public sealed class TenantsApiImplementation : TenantsApi.TenantsApiBase
{
Id = tenant.Id.ToString(),
Name = tenant.Name,
IsDeleted = tenant.Deleted
DeletedAt = tenant.DeletedAt == null ? "": tenant.DeletedAt.ToString()
})
.ToListAsync();

2
CleanArchitecture.Application/gRPC/UsersApiImplementation.cs
View File

@ -42,7 +42,7 @@ public sealed class UsersApiImplementation : UsersApi.UsersApiBase
Email = user.Email,
FirstName = user.FirstName,
LastName = user.LastName,
IsDeleted = user.Deleted
DeletedAt = user.DeletedAt == null ? "": user.DeletedAt.ToString()
})
.ToListAsync();

6
CleanArchitecture.Domain/Entities/Entity.cs
View File

@ -5,7 +5,7 @@ namespace CleanArchitecture.Domain.Entities;
public abstract class Entity
{
public Guid Id { get; private set; }
public bool Deleted { get; private set; }
public DateTimeOffset? DeletedAt { get; private set; }
protected Entity(Guid id)
{
@ -24,11 +24,11 @@ public abstract class Entity
public void Delete()
{
Deleted = true;
DeletedAt = DateTimeOffset.UtcNow;
}
public void Undelete()
{
Deleted = false;
DeletedAt = null;
}
}

6
CleanArchitecture.Infrastructure/Database/DbContextUtility.cs
View File

@ -9,17 +9,17 @@ public partial class ApplicationDbContext
{
public static class DbContextUtility
{
public const string IsDeletedProperty = "Deleted";
public const string IsDeletedProperty = "DeletedAt";
public static readonly MethodInfo PropertyMethod = typeof(EF)
.GetMethod(nameof(EF.Property), BindingFlags.Static | BindingFlags.Public)
!.MakeGenericMethod(typeof(bool));
!.MakeGenericMethod(typeof(DateTimeOffset?));
public static LambdaExpression GetIsDeletedRestriction(Type type)
{
var parm = Expression.Parameter(type, "it");
var prop = Expression.Call(PropertyMethod, parm, Expression.Constant(IsDeletedProperty));
var condition = Expression.MakeBinary(ExpressionType.Equal, prop, Expression.Constant(false));
var condition = Expression.MakeBinary(ExpressionType.Equal, prop, Expression.Constant(null));
var lambda = Expression.Lambda(condition, parm);
return lambda;
}

136
CleanArchitecture.Infrastructure/Migrations/20241208214605_AddDeletedTimestamp.Designer.cs generated Normal file
View File

@ -0,0 +1,136 @@
// <auto-generated />
using System;
using CleanArchitecture.Infrastructure.Database;
using Microsoft.EntityFrameworkCore;
using Microsoft.EntityFrameworkCore.Infrastructure;
using Microsoft.EntityFrameworkCore.Metadata;
using Microsoft.EntityFrameworkCore.Migrations;
using Microsoft.EntityFrameworkCore.Storage.ValueConversion;
#nullable disable
namespace CleanArchitecture.Infrastructure.Migrations
{
[DbContext(typeof(ApplicationDbContext))]
[Migration("20241208214605_AddDeletedTimestamp")]
partial class AddDeletedTimestamp
{
/// <inheritdoc />
protected override void BuildTargetModel(ModelBuilder modelBuilder)
{
#pragma warning disable 612, 618
modelBuilder
.HasAnnotation("ProductVersion", "9.0.0")
.HasAnnotation("Proxies:ChangeTracking", false)
.HasAnnotation("Proxies:CheckEquality", false)
.HasAnnotation("Proxies:LazyLoading", true)
.HasAnnotation("Relational:MaxIdentifierLength", 128);
SqlServerModelBuilderExtensions.UseIdentityColumns(modelBuilder);
modelBuilder.Entity("CleanArchitecture.Domain.Entities.Tenant", b =>
{
b.Property<Guid>("Id")
.ValueGeneratedOnAdd()
.HasColumnType("uniqueidentifier");
b.Property<DateTimeOffset?>("DeletedAt")
.HasColumnType("datetimeoffset");
b.Property<string>("Name")
.IsRequired()
.HasMaxLength(255)
.HasColumnType("nvarchar(255)");
b.HasKey("Id");
b.ToTable("Tenants");
b.HasData(
new
{
Id = new Guid("b542bf25-134c-47a2-a0df-84ed14d03c4a"),
Name = "Admin Tenant"
});
});
modelBuilder.Entity("CleanArchitecture.Domain.Entities.User", b =>
{
b.Property<Guid>("Id")
.ValueGeneratedOnAdd()
.HasColumnType("uniqueidentifier");
b.Property<DateTimeOffset?>("DeletedAt")
.HasColumnType("datetimeoffset");
b.Property<string>("Email")
.IsRequired()
.HasMaxLength(320)
.HasColumnType("nvarchar(320)");
b.Property<string>("FirstName")
.IsRequired()
.HasMaxLength(100)
.HasColumnType("nvarchar(100)");
b.Property<DateTimeOffset?>("LastLoggedinDate")
.HasColumnType("datetimeoffset");
b.Property<string>("LastName")
.IsRequired()
.HasMaxLength(100)
.HasColumnType("nvarchar(100)");
b.Property<string>("Password")
.IsRequired()
.HasMaxLength(128)
.HasColumnType("nvarchar(128)");
b.Property<int>("Role")
.HasColumnType("int");
b.Property<int>("Status")
.HasColumnType("int");
b.Property<Guid>("TenantId")
.HasColumnType("uniqueidentifier");
b.HasKey("Id");
b.HasIndex("TenantId");
b.ToTable("Users");
b.HasData(
new
{
Id = new Guid("7e3892c0-9374-49fa-a3fd-53db637a40ae"),
Email = "admin@email.com",
FirstName = "Admin",
LastName = "User",
Password = "$2a$12$Blal/uiFIJdYsCLTMUik/egLbfg3XhbnxBC6Sb5IKz2ZYhiU/MzL2",
Role = 0,
Status = 0,
TenantId = new Guid("b542bf25-134c-47a2-a0df-84ed14d03c4a")
});
});
modelBuilder.Entity("CleanArchitecture.Domain.Entities.User", b =>
{
b.HasOne("CleanArchitecture.Domain.Entities.Tenant", "Tenant")
.WithMany("Users")
.HasForeignKey("TenantId")
.OnDelete(DeleteBehavior.Restrict)
.IsRequired();
b.Navigation("Tenant");
});
modelBuilder.Entity("CleanArchitecture.Domain.Entities.Tenant", b =>
{
b.Navigation("Users");
});
#pragma warning restore 612, 618
}
}
}

95
CleanArchitecture.Infrastructure/Migrations/20241208214605_AddDeletedTimestamp.cs Normal file
View File

@ -0,0 +1,95 @@
using System;
using Microsoft.EntityFrameworkCore.Migrations;
#nullable disable
namespace CleanArchitecture.Infrastructure.Migrations
{
/// <inheritdoc />
public partial class AddDeletedTimestamp : Migration
{
/// <inheritdoc />
protected override void Up(MigrationBuilder migrationBuilder)
{
migrationBuilder.AddColumn<DateTimeOffset>(
name: "DeletedAt",
table: "Users",
type: "datetimeoffset",
nullable: true);
migrationBuilder.AddColumn<DateTimeOffset>(
name: "DeletedAt",
table: "Tenants",
type: "datetimeoffset",
nullable: true);
migrationBuilder.Sql("UPDATE Users SET DeletedAt = SYSDATETIMEOFFSET() WHERE Deleted = 1");
migrationBuilder.Sql("UPDATE Tenants SET DeletedAt = SYSDATETIMEOFFSET() WHERE Deleted = 1");
migrationBuilder.DropColumn(
name: "Deleted",
table: "Users");
migrationBuilder.DropColumn(
name: "Deleted",
table: "Tenants");
migrationBuilder.UpdateData(
table: "Tenants",
keyColumn: "Id",
keyValue: new Guid("b542bf25-134c-47a2-a0df-84ed14d03c4a"),
column: "DeletedAt",
value: null);
migrationBuilder.UpdateData(
table: "Users",
keyColumn: "Id",
keyValue: new Guid("7e3892c0-9374-49fa-a3fd-53db637a40ae"),
column: "DeletedAt",
value: null);
}
/// <inheritdoc />
protected override void Down(MigrationBuilder migrationBuilder)
{
migrationBuilder.AddColumn<bool>(
name: "Deleted",
table: "Users",
type: "bit",
nullable: false,
defaultValue: false);
migrationBuilder.AddColumn<bool>(
name: "Deleted",
table: "Tenants",
type: "bit",
nullable: false,
defaultValue: false);
migrationBuilder.Sql("UPDATE Users SET Deleted = true WHERE DeletedAt IS NOT NULL");
migrationBuilder.Sql("UPDATE Tenants SET Deleted = true WHERE DeletedAt IS NOT NULL");
migrationBuilder.DropColumn(
name: "DeletedAt",
table: "Users");
migrationBuilder.DropColumn(
name: "DeletedAt",
table: "Tenants");
migrationBuilder.UpdateData(
table: "Tenants",
keyColumn: "Id",
keyValue: new Guid("b542bf25-134c-47a2-a0df-84ed14d03c4a"),
column: "Deleted",
value: false);
migrationBuilder.UpdateData(
table: "Users",
keyColumn: "Id",
keyValue: new Guid("7e3892c0-9374-49fa-a3fd-53db637a40ae"),
column: "Deleted",
value: false);
}
}
}

12
CleanArchitecture.Infrastructure/Migrations/ApplicationDbContextModelSnapshot.cs
View File

@ -17,7 +17,7 @@ namespace CleanArchitecture.Infrastructure.Migrations
{
#pragma warning disable 612, 618
modelBuilder
.HasAnnotation("ProductVersion", "7.0.11")
.HasAnnotation("ProductVersion", "9.0.0")
.HasAnnotation("Proxies:ChangeTracking", false)
.HasAnnotation("Proxies:CheckEquality", false)
.HasAnnotation("Proxies:LazyLoading", true)
@ -31,8 +31,8 @@ namespace CleanArchitecture.Infrastructure.Migrations
.ValueGeneratedOnAdd()
.HasColumnType("uniqueidentifier");
b.Property<bool>("Deleted")
.HasColumnType("bit");
b.Property<DateTimeOffset?>("DeletedAt")
.HasColumnType("datetimeoffset");
b.Property<string>("Name")
.IsRequired()
@ -47,7 +47,6 @@ namespace CleanArchitecture.Infrastructure.Migrations
new
{
Id = new Guid("b542bf25-134c-47a2-a0df-84ed14d03c4a"),
Deleted = false,
Name = "Admin Tenant"
});
});
@ -58,8 +57,8 @@ namespace CleanArchitecture.Infrastructure.Migrations
.ValueGeneratedOnAdd()
.HasColumnType("uniqueidentifier");
b.Property<bool>("Deleted")
.HasColumnType("bit");
b.Property<DateTimeOffset?>("DeletedAt")
.HasColumnType("datetimeoffset");
b.Property<string>("Email")
.IsRequired()
@ -103,7 +102,6 @@ namespace CleanArchitecture.Infrastructure.Migrations
new
{
Id = new Guid("7e3892c0-9374-49fa-a3fd-53db637a40ae"),
Deleted = false,
Email = "admin@email.com",
FirstName = "Admin",
LastName = "User",

35
CleanArchitecture.IntegrationTests/Controller/TenantControllerTests.cs
View File

@ -54,8 +54,37 @@ public sealed class TenantControllerTests
.FirstOrDefault(x => x.Id == _fixture.CreatedTenantId)!
.Users.Count().Should().Be(1);
}
[Test, Order(2)]
public async Task Should_Not_Get_Deleted_Tenant_By_Id()
{
var response = await _fixture.ServerClient.GetAsync($"/api/v1/Tenant/{_fixture.DeletedTenantId}");
response.StatusCode.Should().Be(HttpStatusCode.NotFound);
var message = await response.Content.ReadAsJsonAsync<TenantViewModel>();
message?.Data.Should().BeNull();
}
[Test, Order(3)]
public async Task Should_Get_All_Tenants_Including_Deleted()
{
var response = await _fixture.ServerClient.GetAsync(
"api/v1/Tenant?searchTerm=Test&pageSize=5&page=1&includeDeleted=true");
response.StatusCode.Should().Be(HttpStatusCode.OK);
var message = await response.Content.ReadAsJsonAsync<PagedResult<TenantViewModel>>();
message?.Data!.Items.Should().NotBeEmpty();
message!.Data!.Items.Should().HaveCount(2);
message.Data!.Items
.FirstOrDefault(x => x.Id == _fixture.DeletedTenantId)
.Should().NotBeNull();
}
[Test, Order(4)]
public async Task Should_Create_Tenant()
{
var request = new CreateTenantViewModel("Test Tenant 2");
@ -80,7 +109,7 @@ public sealed class TenantControllerTests
tenantMessage.Data.Name.Should().Be(request.Name);
}
[Test, Order(3)]
[Test, Order(5)]
public async Task Should_Update_Tenant()
{
var request = new UpdateTenantViewModel(_fixture.CreatedTenantId, "Test Tenant 3");
@ -107,7 +136,7 @@ public sealed class TenantControllerTests
tenantMessage.Data.Name.Should().Be(request.Name);
}
[Test, Order(4)]
[Test, Order(6)]
public async Task Should_Delete_Tenant()
{
var response = await _fixture.ServerClient.DeleteAsync($"/api/v1/Tenant/{_fixture.CreatedTenantId}");

41
CleanArchitecture.IntegrationTests/Controller/UserControllerTests.cs
View File

@ -61,8 +61,37 @@ public sealed class UserControllerTests
content.FirstName.Should().Be(TestAuthenticationOptions.FirstName);
content.LastName.Should().Be(TestAuthenticationOptions.LastName);
}
[Test, Order(2)]
public async Task Should_Get_All_User_Including_Deleted()
{
var response = await _fixture.ServerClient.GetAsync("/api/v1/user?includeDeleted=true");
response.StatusCode.Should().Be(HttpStatusCode.OK);
var message = await response.Content.ReadAsJsonAsync<PagedResult<UserViewModel>>();
message?.Data.Should().NotBeNull();
var content = message!.Data!.Items.ToList();
content.Count.Should().Be(3);
content.FirstOrDefault(x => x.Id == _fixture.DeletedUserId).Should().NotBeNull();
}
[Test, Order(3)]
public async Task Should_Not_Get_Deleted_User_By_Id()
{
var response = await _fixture.ServerClient.GetAsync("/api/v1/user/" + _fixture.DeletedUserId);
response.StatusCode.Should().Be(HttpStatusCode.NotFound);
var message = await response.Content.ReadAsJsonAsync<UserViewModel>();
message?.Data.Should().BeNull();
}
[Test, Order(4)]
public async Task Should_Create_User()
{
var user = new CreateUserViewModel(
@ -80,7 +109,7 @@ public sealed class UserControllerTests
message?.Data.Should().NotBeEmpty();
}
[Test, Order(3)]
[Test, Order(5)]
public async Task Should_Login_User()
{
var user = new LoginUserViewModel(
@ -95,7 +124,7 @@ public sealed class UserControllerTests
message?.Data.Should().NotBeEmpty();
}
[Test, Order(4)]
[Test, Order(6)]
public async Task Should_Get_The_Current_Active_Users()
{
var response = await _fixture.ServerClient.GetAsync("/api/v1/user/me");
@ -114,7 +143,7 @@ public sealed class UserControllerTests
content.LastName.Should().Be(TestAuthenticationOptions.LastName);
}
[Test, Order(5)]
[Test, Order(7)]
public async Task Should_Update_User()
{
var user = new UpdateUserViewModel(
@ -155,7 +184,7 @@ public sealed class UserControllerTests
userContent.Role.Should().Be(user.Role);
}
[Test, Order(6)]
[Test, Order(8)]
public async Task Should_Change_User_Password()
{
var user = new ChangePasswordViewModel(
@ -188,7 +217,7 @@ public sealed class UserControllerTests
loginMessage?.Data.Should().NotBeEmpty();
}
[Test, Order(7)]
[Test, Order(9)]
public async Task Should_Delete_User()
{
var response = await _fixture.ServerClient.DeleteAsync("/api/v1/user/" + TestAuthenticationOptions.TestUserId);

7
CleanArchitecture.IntegrationTests/Fixtures/TenantTestFixture.cs
View File

@ -10,6 +10,7 @@ namespace CleanArchitecture.IntegrationTests.Fixtures;
public sealed class TenantTestFixture : TestFixtureBase
{
public Guid CreatedTenantId { get; } = Guid.NewGuid();
public Guid DeletedTenantId { get; } = Guid.NewGuid();
public async Task SeedTestData()
{
@ -21,6 +22,12 @@ public sealed class TenantTestFixture : TestFixtureBase
CreatedTenantId,
"Test Tenant"));
var deletedTenant = new Tenant(
DeletedTenantId,
"Test Tenant2");
deletedTenant.Delete();
context.Tenants.Add(deletedTenant);
context.Users.Add(new User(
Guid.NewGuid(),
CreatedTenantId,

16
CleanArchitecture.IntegrationTests/Fixtures/UserTestFixture.cs
View File

@ -1,4 +1,5 @@
using System.Threading.Tasks;
using System;
using System.Threading.Tasks;
using CleanArchitecture.Domain.Constants;
using CleanArchitecture.Domain.Entities;
using CleanArchitecture.Domain.Enums;
@ -10,6 +11,8 @@ namespace CleanArchitecture.IntegrationTests.Fixtures;
public sealed class UserTestFixture : TestFixtureBase
{
public Guid DeletedUserId { get; } = Guid.NewGuid();
public async Task SeedTestData()
{
await GlobalSetupFixture.RespawnDatabaseAsync();
@ -29,6 +32,17 @@ public sealed class UserTestFixture : TestFixtureBase
"$2a$12$Blal/uiFIJdYsCLTMUik/egLbfg3XhbnxBC6Sb5IKz2ZYhiU/MzL2",
UserRole.Admin));
var deletedUsed = new User(
DeletedUserId,
Ids.Seed.TenantId,
"admin2@email.com",
"Admin2",
"User2",
"$2a$12$Blal/uiFIJdYsCLTMUik/egLbfg3XhbnxBC6Sb5IKz2ZYhiU/MzL2",
UserRole.User);
deletedUsed.Delete();
context.Users.Add(deletedUsed);
context.Users.Add(new User(
TestAuthenticationOptions.TestUserId,
Ids.Seed.TenantId,

1
CleanArchitecture.IntegrationTests/Fixtures/gRPC/GetTenantsByIdsTestFixture.cs
View File

@ -27,6 +27,7 @@ public sealed class GetTenantsByIdsTestFixture : TestFixtureBase
using var context = Factory.Services.GetRequiredService<ApplicationDbContext>();
var tenant = CreateTenant();
tenant.Delete();
context.Tenants.Add(tenant);
await context.SaveChangesAsync();

1
CleanArchitecture.IntegrationTests/Fixtures/gRPC/GetUsersByIdsTestFixture.cs
View File

@ -33,6 +33,7 @@ public sealed class GetUsersByIdsTestFixture : TestFixtureBase
"Admin Tenant"));
var user = CreateUser();
user.Delete();
context.Users.Add(user);
await context.SaveChangesAsync();

1
CleanArchitecture.IntegrationTests/gRPC/GetTenantsByIdsTests.cs
View File

@ -31,5 +31,6 @@ public sealed class GetTenantsByIdsTests
new Guid(tenant.Id).Should().Be(createdTenant.Id);
tenant.Name.Should().Be(createdTenant.Name);
tenant.DeletedAt.Should().NotBeNullOrWhiteSpace();
}
}

1
CleanArchitecture.IntegrationTests/gRPC/GetUsersByIdsTests.cs
View File

@ -31,5 +31,6 @@ public sealed class GetUsersByIdsTests
user.Email.Should().Be(createdUser.Email);
user.FirstName.Should().Be(createdUser.FirstName);
user.LastName.Should().Be(createdUser.LastName);
user.DeletedAt.Should().NotBeNullOrWhiteSpace();
}
}

2
CleanArchitecture.Proto/Tenants/Models.proto
View File

@ -5,7 +5,7 @@ option csharp_namespace = "CleanArchitecture.Proto.Tenants";
message Tenant {
string id = 1;
string name = 2;
bool isDeleted = 3;
optional string deletedAt = 3;
}
message GetTenantsByIdsResult {

2
CleanArchitecture.Proto/Users/Models.proto
View File

@ -7,7 +7,7 @@ message GrpcUser {
string firstName = 3;
string lastName = 4;
string email = 5;
bool isDeleted = 6;
optional string deletedAt = 6;
}
message GetUsersByIdsResult {

3
CleanArchitecture.Shared/Tenants/TenantViewModel.cs
View File

@ -4,4 +4,5 @@ namespace CleanArchitecture.Shared.Tenants;
public sealed record TenantViewModel(
Guid Id,
string Name);
string Name,
DateTimeOffset? DeletedAt);

2
CleanArchitecture.Shared/Users/UserViewModel.cs
View File

@ -7,4 +7,4 @@ public sealed record UserViewModel(
string Email,
string FirstName,
string LastName,
bool IsDeleted);
DateTimeOffset? DeletedAt);

3
CleanArchitecture.gRPC/Contexts/TenantsContext.cs
View File

@ -27,6 +27,7 @@ public sealed class TenantsContext : ITenantsContext
return result.Tenants.Select(tenant => new TenantViewModel(
Guid.Parse(tenant.Id),
tenant.Name));
tenant.Name,
string.IsNullOrWhiteSpace(tenant.DeletedAt) ? null : DateTimeOffset.Parse(tenant.DeletedAt)));
}
}

2
CleanArchitecture.gRPC/Contexts/UsersContext.cs
View File

@ -30,6 +30,6 @@ public sealed class UsersContext : IUsersContext
user.Email,
user.FirstName,
user.LastName,
user.IsDeleted));
string.IsNullOrWhiteSpace(user.DeletedAt) ? null : DateTimeOffset.Parse(user.DeletedAt)));
}
}