Skip to content

Commit 66390d6

Browse files
iammukeshmjarvis
iammukeshm
and
jarvis
authored
refactor: Add DDD patterns to Identity domain entities (#1172)
Applied Domain-Driven Design patterns to Identity module entities: - Group.cs: Private setters, private constructor, Create() factory, Update() and SetAsDefault() domain methods - UserGroup.cs: Private setters, private constructor, Create() factory - GroupRole.cs: Private setters, private constructor, Create() factory - UserSession.cs: Private setters, private constructor, Create() factory, UpdateActivity(), UpdateRefreshToken(), and Revoke() domain methods - PasswordHistory.cs: Private setters, private constructor, Create() factory Updated all usages in: - IdentityDbInitializer.cs - CreateGroupCommandHandler.cs - UpdateGroupCommandHandler.cs - AddUsersToGroupCommandHandler.cs - UserService.cs - SessionService.cs - PasswordHistoryService.cs Note: FshUser and FshRole were skipped as they inherit from ASP.NET Identity base classes. Co-authored-by: jarvis <jarvis@codewithmukesh.com>
1 parent 7611a7b commit 66390d6

12 files changed

Lines changed: 207 additions & 143 deletions

File tree

‎src/Modules/Identity/Modules.Identity/Data/IdentityDbInitializer.cs‎

Lines changed: 13 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -109,15 +109,12 @@ private async Task SeedSystemGroupsAsync()
109109

110110
if (allUsersGroup is null)
111111
{
112-
allUsersGroup = new Group
113-
{
114-
Name = allUsersGroupName,
115-
Description = "Default group for all users. New users are automatically added to this group.",
116-
IsDefault = true,
117-
IsSystemGroup = true,
118-
CreatedAt = timeProvider.GetUtcNow().UtcDateTime,
119-
CreatedBy = "System"
120-
};
112+
allUsersGroup = Group.Create(
113+
name: allUsersGroupName,
114+
description: "Default group for all users. New users are automatically added to this group.",
115+
isDefault: true,
116+
isSystemGroup: true,
117+
createdBy: "System");
121118

122119
await context.Groups.AddAsync(allUsersGroup);
123120
logger.LogInformation("Seeding '{GroupName}' system group for '{TenantId}' Tenant.", allUsersGroupName, tenantId);
@@ -130,15 +127,12 @@ private async Task SeedSystemGroupsAsync()
130127

131128
if (administratorsGroup is null)
132129
{
133-
administratorsGroup = new Group
134-
{
135-
Name = administratorsGroupName,
136-
Description = "System group for administrators with full administrative privileges.",
137-
IsDefault = false,
138-
IsSystemGroup = true,
139-
CreatedAt = timeProvider.GetUtcNow().UtcDateTime,
140-
CreatedBy = "System"
141-
};
130+
administratorsGroup = Group.Create(
131+
name: administratorsGroupName,
132+
description: "System group for administrators with full administrative privileges.",
133+
isDefault: false,
134+
isSystemGroup: true,
135+
createdBy: "System");
142136

143137
await context.Groups.AddAsync(administratorsGroup);
144138
logger.LogInformation("Seeding '{GroupName}' system group for '{TenantId}' Tenant.", administratorsGroupName, tenantId);
@@ -155,11 +149,7 @@ private async Task SeedSystemGroupsAsync()
155149

156150
if (existingGroupRole is null)
157151
{
158-
context.GroupRoles.Add(new GroupRole
159-
{
160-
GroupId = administratorsGroup.Id,
161-
RoleId = adminRole.Id
162-
});
152+
context.GroupRoles.Add(GroupRole.Create(administratorsGroup.Id, adminRole.Id));
163153

164154
await context.SaveChangesAsync();
165155
logger.LogInformation("Assigned Admin role to '{GroupName}' group for '{TenantId}' Tenant.", administratorsGroupName, tenantId);

‎src/Modules/Identity/Modules.Identity/Domain/Group.cs‎

Lines changed: 42 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -4,22 +4,53 @@ namespace FSH.Modules.Identity.Domain;
44

55
public class Group : ISoftDeletable
66
{
7-
public Guid Id { get; set; } = Guid.NewGuid();
8-
public string Name { get; set; } = default!;
9-
public string? Description { get; set; }
10-
public bool IsDefault { get; set; }
11-
public bool IsSystemGroup { get; set; }
12-
public DateTime CreatedAt { get; set; } = DateTime.UtcNow;
13-
public string? CreatedBy { get; set; }
14-
public DateTime? ModifiedAt { get; set; }
15-
public string? ModifiedBy { get; set; }
7+
public Guid Id { get; private set; }
8+
public string Name { get; private set; } = default!;
9+
public string? Description { get; private set; }
10+
public bool IsDefault { get; private set; }
11+
public bool IsSystemGroup { get; private set; }
12+
public DateTime CreatedAt { get; private set; }
13+
public string? CreatedBy { get; private set; }
14+
public DateTime? ModifiedAt { get; private set; }
15+
public string? ModifiedBy { get; private set; }
1616

1717
// ISoftDeletable implementation
1818
public bool IsDeleted { get; set; }
1919
public DateTimeOffset? DeletedOnUtc { get; set; }
2020
public string? DeletedBy { get; set; }
2121

2222
// Navigation properties
23-
public virtual ICollection<GroupRole> GroupRoles { get; set; } = [];
24-
public virtual ICollection<UserGroup> UserGroups { get; set; } = [];
23+
public virtual ICollection<GroupRole> GroupRoles { get; private set; } = [];
24+
public virtual ICollection<UserGroup> UserGroups { get; private set; } = [];
25+
26+
private Group() { } // EF Core
27+
28+
public static Group Create(string name, string? description = null, bool isDefault = false, bool isSystemGroup = false, string? createdBy = null)
29+
{
30+
return new Group
31+
{
32+
Id = Guid.NewGuid(),
33+
Name = name,
34+
Description = description,
35+
IsDefault = isDefault,
36+
IsSystemGroup = isSystemGroup,
37+
CreatedAt = DateTime.UtcNow,
38+
CreatedBy = createdBy
39+
};
40+
}
41+
42+
public void Update(string name, string? description, string? modifiedBy = null)
43+
{
44+
Name = name;
45+
Description = description;
46+
ModifiedAt = DateTime.UtcNow;
47+
ModifiedBy = modifiedBy;
48+
}
49+
50+
public void SetAsDefault(bool isDefault, string? modifiedBy = null)
51+
{
52+
IsDefault = isDefault;
53+
ModifiedAt = DateTime.UtcNow;
54+
ModifiedBy = modifiedBy;
55+
}
2556
}

‎src/Modules/Identity/Modules.Identity/Domain/GroupRole.cs‎

Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,21 @@ namespace FSH.Modules.Identity.Domain;
22

33
public class GroupRole
44
{
5-
public Guid GroupId { get; set; }
6-
public string RoleId { get; set; } = default!;
5+
public Guid GroupId { get; private set; }
6+
public string RoleId { get; private set; } = default!;
77

88
// Navigation properties
9-
public virtual Group? Group { get; set; }
10-
public virtual FshRole? Role { get; set; }
9+
public virtual Group? Group { get; private set; }
10+
public virtual FshRole? Role { get; private set; }
11+
12+
private GroupRole() { } // EF Core
13+
14+
public static GroupRole Create(Guid groupId, string roleId)
15+
{
16+
return new GroupRole
17+
{
18+
GroupId = groupId,
19+
RoleId = roleId
20+
};
21+
}
1122
}

‎src/Modules/Identity/Modules.Identity/Domain/PasswordHistory.cs‎

Lines changed: 17 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,23 @@ namespace FSH.Modules.Identity.Domain;
22

33
public class PasswordHistory
44
{
5-
public int Id { get; set; }
6-
public string UserId { get; set; } = default!;
7-
public string PasswordHash { get; set; } = default!;
8-
public DateTime CreatedAt { get; set; } = DateTime.UtcNow;
5+
public int Id { get; private set; }
6+
public string UserId { get; private set; } = default!;
7+
public string PasswordHash { get; private set; } = default!;
8+
public DateTime CreatedAt { get; private set; }
99

1010
// Navigation property
11-
public virtual FshUser? User { get; set; }
11+
public virtual FshUser? User { get; private set; }
12+
13+
private PasswordHistory() { } // EF Core
14+
15+
public static PasswordHistory Create(string userId, string passwordHash)
16+
{
17+
return new PasswordHistory
18+
{
19+
UserId = userId,
20+
PasswordHash = passwordHash,
21+
CreatedAt = DateTime.UtcNow
22+
};
23+
}
1224
}

‎src/Modules/Identity/Modules.Identity/Domain/UserGroup.cs‎

Lines changed: 19 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,25 @@ namespace FSH.Modules.Identity.Domain;
22

33
public class UserGroup
44
{
5-
public string UserId { get; set; } = default!;
6-
public Guid GroupId { get; set; }
7-
public DateTime AddedAt { get; set; } = DateTime.UtcNow;
8-
public string? AddedBy { get; set; }
5+
public string UserId { get; private set; } = default!;
6+
public Guid GroupId { get; private set; }
7+
public DateTime AddedAt { get; private set; }
8+
public string? AddedBy { get; private set; }
99

1010
// Navigation properties
11-
public virtual FshUser? User { get; set; }
12-
public virtual Group? Group { get; set; }
11+
public virtual FshUser? User { get; private set; }
12+
public virtual Group? Group { get; private set; }
13+
14+
private UserGroup() { } // EF Core
15+
16+
public static UserGroup Create(string userId, Guid groupId, string? addedBy = null)
17+
{
18+
return new UserGroup
19+
{
20+
UserId = userId,
21+
GroupId = groupId,
22+
AddedAt = DateTime.UtcNow,
23+
AddedBy = addedBy
24+
};
25+
}
1326
}

‎src/Modules/Identity/Modules.Identity/Domain/UserSession.cs‎

Lines changed: 70 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -2,24 +2,76 @@ namespace FSH.Modules.Identity.Domain;
22

33
public class UserSession
44
{
5-
public Guid Id { get; set; } = Guid.NewGuid();
6-
public string UserId { get; set; } = default!;
7-
public string RefreshTokenHash { get; set; } = default!;
8-
public string IpAddress { get; set; } = default!;
9-
public string UserAgent { get; set; } = default!;
10-
public string? DeviceType { get; set; }
11-
public string? Browser { get; set; }
12-
public string? BrowserVersion { get; set; }
13-
public string? OperatingSystem { get; set; }
14-
public string? OsVersion { get; set; }
15-
public DateTime CreatedAt { get; set; } = DateTime.UtcNow;
16-
public DateTime LastActivityAt { get; set; } = DateTime.UtcNow;
17-
public DateTime ExpiresAt { get; set; }
18-
public bool IsRevoked { get; set; }
19-
public DateTime? RevokedAt { get; set; }
20-
public string? RevokedBy { get; set; }
21-
public string? RevokedReason { get; set; }
5+
public Guid Id { get; private set; }
6+
public string UserId { get; private set; } = default!;
7+
public string RefreshTokenHash { get; private set; } = default!;
8+
public string IpAddress { get; private set; } = default!;
9+
public string UserAgent { get; private set; } = default!;
10+
public string? DeviceType { get; private set; }
11+
public string? Browser { get; private set; }
12+
public string? BrowserVersion { get; private set; }
13+
public string? OperatingSystem { get; private set; }
14+
public string? OsVersion { get; private set; }
15+
public DateTime CreatedAt { get; private set; }
16+
public DateTime LastActivityAt { get; private set; }
17+
public DateTime ExpiresAt { get; private set; }
18+
public bool IsRevoked { get; private set; }
19+
public DateTime? RevokedAt { get; private set; }
20+
public string? RevokedBy { get; private set; }
21+
public string? RevokedReason { get; private set; }
2222

2323
// Navigation property
24-
public virtual FshUser? User { get; set; }
24+
public virtual FshUser? User { get; private set; }
25+
26+
private UserSession() { } // EF Core
27+
28+
public static UserSession Create(
29+
string userId,
30+
string refreshTokenHash,
31+
string ipAddress,
32+
string userAgent,
33+
DateTime expiresAt,
34+
string? deviceType = null,
35+
string? browser = null,
36+
string? browserVersion = null,
37+
string? operatingSystem = null,
38+
string? osVersion = null)
39+
{
40+
return new UserSession
41+
{
42+
Id = Guid.NewGuid(),
43+
UserId = userId,
44+
RefreshTokenHash = refreshTokenHash,
45+
IpAddress = ipAddress,
46+
UserAgent = userAgent,
47+
DeviceType = deviceType,
48+
Browser = browser,
49+
BrowserVersion = browserVersion,
50+
OperatingSystem = operatingSystem,
51+
OsVersion = osVersion,
52+
CreatedAt = DateTime.UtcNow,
53+
LastActivityAt = DateTime.UtcNow,
54+
ExpiresAt = expiresAt
55+
};
56+
}
57+
58+
public void UpdateActivity()
59+
{
60+
LastActivityAt = DateTime.UtcNow;
61+
}
62+
63+
public void UpdateRefreshToken(string refreshTokenHash, DateTime expiresAt)
64+
{
65+
RefreshTokenHash = refreshTokenHash;
66+
ExpiresAt = expiresAt;
67+
LastActivityAt = DateTime.UtcNow;
68+
}
69+
70+
public void Revoke(string? revokedBy = null, string? reason = null)
71+
{
72+
IsRevoked = true;
73+
RevokedAt = DateTime.UtcNow;
74+
RevokedBy = revokedBy;
75+
RevokedReason = reason;
76+
}
2577
}

‎src/Modules/Identity/Modules.Identity/Features/v1/Groups/AddUsersToGroup/AddUsersToGroupCommandHandler.cs‎

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -57,12 +57,7 @@ public async ValueTask<AddUsersToGroupResponse> Handle(AddUsersToGroupCommand co
5757
var currentUserId = _currentUser.GetUserId().ToString();
5858
foreach (var userId in usersToAdd)
5959
{
60-
_dbContext.UserGroups.Add(new UserGroup
61-
{
62-
UserId = userId,
63-
GroupId = command.GroupId,
64-
AddedBy = currentUserId
65-
});
60+
_dbContext.UserGroups.Add(UserGroup.Create(userId, command.GroupId, currentUserId));
6661
}
6762

6863
await _dbContext.SaveChangesAsync(cancellationToken);

‎src/Modules/Identity/Modules.Identity/Features/v1/Groups/CreateGroup/CreateGroupCommandHandler.cs‎

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -48,21 +48,19 @@ public async ValueTask<GroupDto> Handle(CreateGroupCommand command, Cancellation
4848
}
4949
}
5050

51-
var group = new Group
52-
{
53-
Name = command.Name,
54-
Description = command.Description,
55-
IsDefault = command.IsDefault,
56-
IsSystemGroup = false,
57-
CreatedBy = _currentUser.GetUserId().ToString()
58-
};
51+
var group = Group.Create(
52+
name: command.Name,
53+
description: command.Description,
54+
isDefault: command.IsDefault,
55+
isSystemGroup: false,
56+
createdBy: _currentUser.GetUserId().ToString());
5957

6058
// Add role assignments
6159
if (command.RoleIds is { Count: > 0 })
6260
{
6361
foreach (var roleId in command.RoleIds)
6462
{
65-
group.GroupRoles.Add(new GroupRole { GroupId = group.Id, RoleId = roleId });
63+
_dbContext.GroupRoles.Add(GroupRole.Create(group.Id, roleId));
6664
}
6765
}
6866

‎src/Modules/Identity/Modules.Identity/Features/v1/Groups/UpdateGroup/UpdateGroupCommandHandler.cs‎

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -54,11 +54,8 @@ public async ValueTask<GroupDto> Handle(UpdateGroupCommand command, Cancellation
5454
}
5555

5656
// Update group properties
57-
group.Name = command.Name;
58-
group.Description = command.Description;
59-
group.IsDefault = command.IsDefault;
60-
group.ModifiedAt = DateTime.UtcNow;
61-
group.ModifiedBy = _currentUser.GetUserId().ToString();
57+
group.Update(command.Name, command.Description, _currentUser.GetUserId().ToString());
58+
group.SetAsDefault(command.IsDefault, _currentUser.GetUserId().ToString());
6259

6360
// Update role assignments
6461
var currentRoleIds = group.GroupRoles.Select(gr => gr.RoleId).ToHashSet();
@@ -74,7 +71,7 @@ public async ValueTask<GroupDto> Handle(UpdateGroupCommand command, Cancellation
7471
// Add new role assignments
7572
foreach (var roleId in newRoleIds.Where(id => !currentRoleIds.Contains(id)))
7673
{
77-
group.GroupRoles.Add(new GroupRole { GroupId = group.Id, RoleId = roleId });
74+
group.GroupRoles.Add(GroupRole.Create(group.Id, roleId));
7875
}
7976

8077
await _dbContext.SaveChangesAsync(cancellationToken);

‎src/Modules/Identity/Modules.Identity/Services/PasswordHistoryService.cs‎

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -73,12 +73,7 @@ public async Task SavePasswordHistoryAsync(string userId, CancellationToken canc
7373
return;
7474
}
7575

76-
var passwordHistoryEntry = new PasswordHistory
77-
{
78-
UserId = userId,
79-
PasswordHash = user.PasswordHash,
80-
CreatedAt = DateTime.UtcNow
81-
};
76+
var passwordHistoryEntry = PasswordHistory.Create(userId, user.PasswordHash);
8277

8378
_db.Set<PasswordHistory>().Add(passwordHistoryEntry);
8479
await _db.SaveChangesAsync(cancellationToken);

0 commit comments

Comments
 (0)