AYS-516 | User Update Flow and User-Role Relations Have Been Optimized for Working Less Queries (#393)

Author: agitrubard

src/main/java/org/ays/auth/model/AysUser.java

@@ -15,6 +15,8 @@
 
 import java.time.LocalDateTime;
 import java.util.List;
+import java.util.Set;
+import java.util.stream.Collectors;
 
 /**
  * Domain model representing a user entity for data transfer between the service layer and controller.
@@ -70,6 +72,37 @@ public boolean isDeleted() {
     }
 
 
+    /**
+     * Updates the user information with the specified details.
+     * </p>
+     *
+     * @param emailAddress the email address of the user
+     * @param firstName    the first name of the user
+     * @param lastName     the last name of the user
+     * @param phoneNumber  the {@link AysPhoneNumber} containing the user's phone information
+     * @param city         the city where the user is located
+     * @param roleIds      the set of role IDs assigned to the user
+     * @param updatedUser  the identifier of the user who performed the update
+     */
+    public void update(final String emailAddress,
+                       final String firstName,
+                       final String lastName,
+                       final AysPhoneNumber phoneNumber,
+                       final String city,
+                       final Set<String> roleIds,
+                       final String updatedUser) {
+
+        this.emailAddress = emailAddress;
+        this.firstName = firstName;
+        this.lastName = lastName;
+        this.phoneNumber = phoneNumber;
+        this.city = city;
+        this.roles = roleIds.stream()
+                .map(roleId -> AysRole.builder().id(roleId).build())
+                .collect(Collectors.toList());
+        this.updatedUser = updatedUser;
+    }
+
     /**
      * Sets the user's status to {@link AysUserStatus#ACTIVE}, marking the user as active.
      */

src/main/java/org/ays/auth/model/entity/AysUserEntity.java

@@ -24,7 +24,7 @@
 import org.ays.institution.model.entity.InstitutionEntity;
 
 import java.time.LocalDateTime;
-import java.util.List;
+import java.util.Set;
 
 /**
  * Represents a user entity in the application, extending from {@link BaseEntity}.
@@ -94,7 +94,7 @@ public class AysUserEntity extends BaseEntity {
             joinColumns = @JoinColumn(name = "USER_ID"),
             inverseJoinColumns = @JoinColumn(name = "ROLE_ID")
     )
-    private List<AysRoleEntity> roles;
+    private Set<AysRoleEntity> roles;
 
 
     /**

src/main/java/org/ays/auth/service/impl/AysUserUpdateServiceImpl.java

@@ -24,6 +24,7 @@
 
 import java.util.List;
 import java.util.Set;
+import java.util.stream.Collectors;
 
 /**
  * Service implementation for updating users.
@@ -56,7 +57,7 @@ public void update(final String id,
         final AysUser user = userReadPort.findById(id)
                 .orElseThrow(() -> new AysUserNotExistByIdException(id));
 
-        String institutionId = identity.getInstitutionId();
+        final String institutionId = identity.getInstitutionId();
         if (!institutionId.equals(user.getInstitution().getId())) {
             throw new AysUserNotExistByIdException(id);
         }
@@ -70,23 +71,33 @@ public void update(final String id,
                 .lineNumber(updateRequest.getPhoneNumber().getLineNumber())
                 .build();
 
-        if (!user.getPhoneNumber().equals(phoneNumber)) {
+        final boolean isPhoneNumberChanged = !user.getPhoneNumber().equals(phoneNumber);
+        if (isPhoneNumberChanged) {
             this.validatePhoneNumber(user, phoneNumber);
-            user.setPhoneNumber(phoneNumber);
         }
 
-        if (!user.getEmailAddress().equals(updateRequest.getEmailAddress())) {
+        final boolean isEmailChanged = !user.getEmailAddress().equals(updateRequest.getEmailAddress());
+        if (isEmailChanged) {
             this.validateEmailAddress(user, updateRequest.getEmailAddress());
-            user.setEmailAddress(updateRequest.getEmailAddress());
         }
 
-        this.validateRolesAndSet(user, updateRequest.getRoleIds(), institutionId);
-
-        user.setFirstName(updateRequest.getFirstName());
-        user.setLastName(updateRequest.getLastName());
-        user.setCity(updateRequest.getCity());
-        user.setUpdatedUser(identity.getUserId());
+        final Set<String> existingRoleIds = user.getRoles().stream()
+                .map(AysRole::getId)
+                .collect(Collectors.toSet());
+        final boolean isRoleChanged = !existingRoleIds.equals(updateRequest.getRoleIds());
+        if (isRoleChanged) {
+            this.validateRoles(updateRequest.getRoleIds(), institutionId);
+        }
 
+        user.update(
+                updateRequest.getEmailAddress(),
+                updateRequest.getFirstName(),
+                updateRequest.getLastName(),
+                phoneNumber,
+                updateRequest.getCity(),
+                updateRequest.getRoleIds(),
+                identity.getUserId()
+        );
         userSavePort.save(user);
     }
 
@@ -212,36 +223,33 @@ private void validateEmailAddress(AysUser user, String emailAddress) {
 
 
     /**
-     * Checks the existence of roles by their IDs and returns the corresponding role entities.
+     * Validates if all specified roles exist and are active within the given institution.
+     * <p>
+     * This method checks if each role ID corresponds to an active role in the specified institution.
+     * If any role is not found or not active, an exception is thrown with the list of invalid role IDs.
+     * </p>
      *
-     * @param user    The user being updated.
-     * @param roleIds The set of role IDs to be checked and retrieved.
-     * @throws AysRolesNotExistException if any of the provided role IDs do not exist.
+     * @param roleIds       the set of role IDs to validate
+     * @param institutionId the ID of the institution where the roles should exist
+     * @throws AysRolesNotExistException if any of the specified roles do not exist or are not valid for the institution
      */
-    private void validateRolesAndSet(final AysUser user, final Set<String> roleIds, final String institutionId) {
-
-        boolean isRoleNotChanged = user.getRoles().stream()
-                .allMatch(role -> roleIds.contains(role.getId()));
-        if (isRoleNotChanged) {
-            return;
-        }
+    private void validateRoles(final Set<String> roleIds, final String institutionId) {
 
         final List<AysRole> roles = roleReadPort.findAllByIds(roleIds).stream()
                 .filter(AysRole::isActive)
                 .filter(role -> institutionId.equals(role.getInstitution().getId()))
                 .toList();
 
-        if (roles.size() == roleIds.size()) {
-            user.setRoles(roles);
-            return;
-        }
+        if (roles.size() != roleIds.size()) {
 
-        final List<String> notExistsRoleIds = roleIds.stream()
-                .filter(roleId -> roles.stream()
-                        .noneMatch(roleEntity -> roleEntity.getId().equals(roleId)))
-                .toList();
+            final List<String> notExistsRoleIds = roleIds.stream()
+                    .filter(roleId -> roles.stream()
+                            .noneMatch(roleEntity -> roleEntity.getId().equals(roleId)))
+                    .toList();
+
+            throw new AysRolesNotExistException(notExistsRoleIds);
+        }
 
-        throw new AysRolesNotExistException(notExistsRoleIds);
     }
 
 }

src/test/java/org/ays/auth/model/entity/AysUserEntityBuilder.java

@@ -10,7 +10,7 @@
 import org.ays.util.AysValidTestData;
 
 import java.time.LocalDateTime;
-import java.util.List;
+import java.util.Set;
 
 public class AysUserEntityBuilder extends TestDataBuilder<AysUserEntity> {
 
@@ -30,8 +30,10 @@ public AysUserEntityBuilder withValidValues() {
                 .withValidValues()
                 .build();
 
-        List<AysRoleEntity> roleEntities = List.of(
-                new AysRoleEntityBuilder().withValidValues().build()
+        Set<AysRoleEntity> roleEntities = Set.of(
+                new AysRoleEntityBuilder()
+                        .withValidValues()
+                        .build()
         );
 
         InstitutionEntity institutionEntity = new InstitutionEntityBuilder().withValidValues().build();
@@ -78,7 +80,7 @@ public AysUserEntityBuilder withLoginAttempt(AysUserEntity.LoginAttemptEntity lo
         return this;
     }
 
-    public AysUserEntityBuilder withRoles(List<AysRoleEntity> roles) {
+    public AysUserEntityBuilder withRoles(Set<AysRoleEntity> roles) {
         data.setRoles(roles);
         return this;
     }