S28 2069: Search Users by firstName and lastName

pre-api-stg.yaml

@@ -5186,6 +5186,14 @@ paths:
           in: query
           name: name
           type: string
+        - description: The first name of the user to search by
+          in: query
+          name: firstName
+          type: string
+        - description: The last name of the user to search by
+          in: query
+          name: lastName
+          type: string
         - description: The email of the user to search by
           in: query
           name: email

src/integrationTest/java/uk/gov/hmcts/reform/preapi/services/RecordingServiceIT.java

@@ -19,7 +19,6 @@
 import uk.gov.hmcts.reform.preapi.entities.Court;
 import uk.gov.hmcts.reform.preapi.entities.Recording;
 import uk.gov.hmcts.reform.preapi.enums.CaseState;
-import uk.gov.hmcts.reform.preapi.enums.CaseState;
 import uk.gov.hmcts.reform.preapi.enums.CourtType;
 import uk.gov.hmcts.reform.preapi.enums.RecordingOrigin;
 import uk.gov.hmcts.reform.preapi.enums.UpsertResult;

src/integrationTest/java/uk/gov/hmcts/reform/preapi/services/TermsAndConditionsServiceIT.java

@@ -20,7 +20,8 @@ class TermsAndConditionsServiceIT extends IntegrationTestBase {
 
     @BeforeEach
     public void setUp() {
-        termsAndConditionsApp = HelperFactory.createTermsAndConditions(TermsAndConditionsType.APP, "app content");
+        termsAndConditionsApp = HelperFactory.createTermsAndConditions(TermsAndConditionsType.APP,
+                                                                       "app content");
         entityManager.persist(termsAndConditionsApp);
 
         termsAndConditionsPortal = HelperFactory.createTermsAndConditions(
@@ -32,30 +33,33 @@ public void setUp() {
 
     @Test
     @Transactional
-    void getLatestTermsAndConditionsApp() {
-        var latestAppTerms1 = termsAndConditionsService.getLatestTermsAndConditions(TermsAndConditionsType.APP);
+    void getLatestTermsAndConditionsByTypeApp() {
+        var latestAppTerms1 = termsAndConditionsService.getLatestTermsAndConditionsByType(TermsAndConditionsType.APP);
 
         assertThat(latestAppTerms1.getId()).isEqualTo(termsAndConditionsApp.getId());
 
         var newTerms = HelperFactory.createTermsAndConditions(TermsAndConditionsType.APP, "app content 2");
         entityManager.persist(newTerms);
 
-        var latestAppTerms2 = termsAndConditionsService.getLatestTermsAndConditions(TermsAndConditionsType.APP);
+        var latestAppTerms2 = termsAndConditionsService.getLatestTermsAndConditionsByType(TermsAndConditionsType.APP);
         assertThat(latestAppTerms2.getId()).isEqualTo(newTerms.getId());
         assertThat(latestAppTerms2.getCreatedAt()).isAfter(latestAppTerms1.getCreatedAt());
     }
 
     @Test
     @Transactional
-    void getLatestTermsAndConditionsPortal() {
-        var latestPortalTerms1 = termsAndConditionsService.getLatestTermsAndConditions(TermsAndConditionsType.PORTAL);
+    void getLatestTermsAndConditionsByTypePortal() {
+        var latestPortalTerms1 = termsAndConditionsService
+            .getLatestTermsAndConditionsByType(TermsAndConditionsType.PORTAL);
 
         assertThat(latestPortalTerms1.getId()).isEqualTo(termsAndConditionsPortal.getId());
 
-        var newTerms = HelperFactory.createTermsAndConditions(TermsAndConditionsType.PORTAL, "portal content 2");
+        var newTerms = HelperFactory.createTermsAndConditions(TermsAndConditionsType.PORTAL,
+                                                              "portal content 2");
         entityManager.persist(newTerms);
 
-        var latestPortalTerms2 = termsAndConditionsService.getLatestTermsAndConditions(TermsAndConditionsType.PORTAL);
+        var latestPortalTerms2 = termsAndConditionsService
+            .getLatestTermsAndConditionsByType(TermsAndConditionsType.PORTAL);
         assertThat(latestPortalTerms2.getId()).isEqualTo(newTerms.getId());
         assertThat(latestPortalTerms2.getCreatedAt()).isAfter(latestPortalTerms1.getCreatedAt());
     }

src/integrationTest/java/uk/gov/hmcts/reform/preapi/services/UserServiceIT.java

@@ -8,6 +8,7 @@
 import org.springframework.data.domain.PageRequest;
 import org.springframework.data.domain.Pageable;
 import org.springframework.security.access.AccessDeniedException;
+import uk.gov.hmcts.reform.preapi.controllers.params.SearchUsers;
 import uk.gov.hmcts.reform.preapi.dto.base.BaseUserDTO;
 import uk.gov.hmcts.reform.preapi.entities.AppAccess;
 import uk.gov.hmcts.reform.preapi.entities.Court;
@@ -114,14 +115,18 @@ void searchUsersAsAdmin() {
         entityManager.persist(userEntity);
         entityManager.flush();
 
-        var users = userService.findAllBy(null, null, null, null, null, null, false, null, Pageable.unpaged()).toList();
+        var users = userService
+            .findAllBy(null, Pageable.unpaged()).toList();
 
         Assertions.assertEquals(users.size(), 2);
         Assertions.assertTrue(users.stream().anyMatch(user -> user.getId().equals(portalUserEntity.getId())));
         Assertions.assertTrue(users.stream().anyMatch(user -> user.getId().equals(appUserEntity.getId())));
         Assertions.assertFalse(users.stream().anyMatch(user -> user.getId().equals(userEntity.getId())));
 
-        var users2 = userService.findAllBy(null, null, null, null, null, null, true, null, Pageable.unpaged()).toList();
+        SearchUsers params = new SearchUsers();
+        params.setIncludeDeleted(true);
+        var users2 = userService
+            .findAllBy(params, Pageable.unpaged()).toList();
 
         Assertions.assertEquals(users2.size(), 3);
         Assertions.assertTrue(users2.stream().anyMatch(user -> user.getId().equals(portalUserEntity.getId())));
@@ -137,7 +142,10 @@ public void searchUsersAsNonAdmin() {
         entityManager.persist(userEntity);
         entityManager.flush();
 
-        var users = userService.findAllBy(null, null, null, null, null, null, false, null, Pageable.unpaged()).toList();
+        var users = userService.findAllBy(
+            null,
+            Pageable.unpaged()
+        ).toList();
 
         Assertions.assertEquals(users.size(), 2);
         Assertions.assertTrue(users.stream().anyMatch(user -> user.getId().equals(portalUserEntity.getId())));
@@ -146,7 +154,10 @@ public void searchUsersAsNonAdmin() {
 
         var message = Assertions.assertThrows(
             AccessDeniedException.class,
-            () -> userService.findAllBy(null, null, null, null, null, null, true, null, Pageable.unpaged()).toList()
+            () -> userService.findAllBy(
+                null,
+                Pageable.unpaged()
+            ).toList()
         ).getMessage();
 
         Assertions.assertEquals(message, "Access Denied");
@@ -156,15 +167,10 @@ public void searchUsersAsNonAdmin() {
     @Transactional
     @Test
     void testGetUserByAccessType() {
+        SearchUsers params = new SearchUsers();
+        params.setAccessType(AccessType.APP);
         var resultApp = userService.findAllBy(
-            null,
-            null,
-            null,
-            null,
-            null,
-            AccessType.APP,
-            false,
-            null,
+            params,
             PageRequest.of(0, 20)
         );
         Assertions.assertEquals(2, resultApp.getContent().size());
@@ -173,15 +179,9 @@ void testGetUserByAccessType() {
         Assertions.assertEquals(appUserEntity.getId(), usersApp.get(0).getId());
         Assertions.assertEquals(userEntity.getId(), usersApp.get(1).getId());
 
+        params.setAccessType(AccessType.PORTAL);
         var resultPortal = userService.findAllBy(
-            null,
-            null,
-            null,
-            null,
-            null,
-            AccessType.PORTAL,
-            false,
-            null,
+            params,
             PageRequest.of(0, 20)
         );
         Assertions.assertEquals(2, resultPortal.getContent().size());
@@ -190,7 +190,11 @@ void testGetUserByAccessType() {
         Assertions.assertEquals(userEntity.getFirstName(), usersPortal.get(0).getFirstName());
         Assertions.assertEquals(portalUserEntity.getId(), usersPortal.get(1).getId());
 
-        var resultAll = userService.findAllBy(null, null, null, null, null, null, false,null, PageRequest.of(0, 20));
+        params.setAccessType(null);
+        var resultAll = userService.findAllBy(
+            params,
+            PageRequest.of(0, 20)
+        );
         Assertions.assertEquals(3, resultAll.getContent().size());
         var usersAll = resultAll.getContent().stream()
                                 .sorted(Comparator.comparing(BaseUserDTO::getFirstName)).toList();
@@ -199,15 +203,9 @@ void testGetUserByAccessType() {
         Assertions.assertEquals(portalUserEntity.getId(), usersAll.get(2).getId());
 
         portalAccessEntity2.setStatus(AccessStatus.INACTIVE);
+        params.setAccessType(AccessType.PORTAL);
         var resultPortal2 = userService.findAllBy(
-            null,
-            null,
-            null,
-            null,
-            null,
-            AccessType.PORTAL,
-            false,
-            null,
+            params,
             PageRequest.of(0, 20)
         );
         Assertions.assertEquals(1, resultPortal2.getContent().size());

src/main/java/uk/gov/hmcts/reform/preapi/controllers/TermsAndConditionsController.java

@@ -34,7 +34,8 @@ public TermsAndConditionsController(TermsAndConditionsService termsAndConditions
         summary = "Get the latest terms and conditions for the app"
     )
     public ResponseEntity<TermsAndConditionsDTO> getLatestAppTermsAndConditions() {
-        return ResponseEntity.ok(termsAndConditionsService.getLatestTermsAndConditions(TermsAndConditionsType.APP));
+        return ResponseEntity.ok(termsAndConditionsService
+                                     .getLatestTermsAndConditionsByType(TermsAndConditionsType.APP));
     }
 
     @GetMapping("/portal-terms-and-conditions/latest")
@@ -43,7 +44,8 @@ public ResponseEntity<TermsAndConditionsDTO> getLatestAppTermsAndConditions() {
         summary = "Get the latest terms and conditions for the portal"
     )
     public ResponseEntity<TermsAndConditionsDTO> getLatestPortalTermsAndConditions() {
-        return ResponseEntity.ok(termsAndConditionsService.getLatestTermsAndConditions(TermsAndConditionsType.PORTAL));
+        return ResponseEntity.ok(termsAndConditionsService
+                                     .getLatestTermsAndConditionsByType(TermsAndConditionsType.PORTAL));
     }
 
     @PostMapping("/accept-terms-and-conditions/{termsId}")

src/main/java/uk/gov/hmcts/reform/preapi/controllers/UserController.java

@@ -77,6 +77,16 @@ public ResponseEntity<UserDTO> getUserById(@PathVariable UUID userId) {
         description = "The name of the user to search by",
         schema = @Schema(implementation = String.class)
     )
+    @Parameter(
+        name = "firstName",
+        description = "The first name of the user to search by",
+        schema = @Schema(implementation = String.class)
+    )
+    @Parameter(
+        name = "lastName",
+        description = "The last name of the user to search by",
+        schema = @Schema(implementation = String.class)
+    )
     @Parameter(
         name = "email",
         description = "The email of the user to search by",
@@ -133,17 +143,7 @@ public ResponseEntity<PagedModel<EntityModel<UserDTO>>> getUsers(
         @Parameter(hidden = true) Pageable pageable,
         @Parameter(hidden = true) PagedResourcesAssembler<UserDTO> assembler
     ) {
-        Page<UserDTO> resultPage = userService.findAllBy(
-            params.getName(),
-            params.getEmail(),
-            params.getOrganisation(),
-            params.getCourtId(),
-            params.getRoleId(),
-            params.getAccessType(),
-            params.getIncludeDeleted() != null && params.getIncludeDeleted(),
-            params.getAppActive(),
-            pageable
-        );
+        Page<UserDTO> resultPage = userService.findAllBy(params, pageable);
 
         if (pageable.getPageNumber() > resultPage.getTotalPages()) {
             throw new RequestedPageOutOfRangeException(pageable.getPageNumber(), resultPage.getTotalPages());

src/main/java/uk/gov/hmcts/reform/preapi/controllers/params/SearchUsers.java

@@ -8,6 +8,8 @@
 @Data
 public class SearchUsers {
     private String name;
+    private String firstName;
+    private String lastName;
     private String email;
     private String organisation;
     private UUID courtId;
@@ -20,6 +22,14 @@ public String getName() {
         return name != null && !name.isEmpty() ? name : null;
     }
 
+    public String getFirstName() {
+        return firstName != null && !firstName.isEmpty() ? firstName : null;
+    }
+
+    public String getLastName() {
+        return lastName != null && !lastName.isEmpty() ? lastName : null;
+    }
+
     public String getEmail() {
         return email != null && !email.isEmpty() ? email : null;
     }

src/main/java/uk/gov/hmcts/reform/preapi/dto/validators/PortalAppAccessValidator.java

@@ -13,7 +13,7 @@ public class PortalAppAccessValidator
 
     private final RoleRepository roleRepository;
 
-    private static final String PORTAL_ROLE_NAME = "Level 3";
+    public static final String PORTAL_ROLE_NAME = "Level 3";
 
     @Autowired
     public PortalAppAccessValidator(final RoleRepository roleRepository) {

src/main/java/uk/gov/hmcts/reform/preapi/repositories/UserRepository.java

@@ -1,6 +1,5 @@
 package uk.gov.hmcts.reform.preapi.repositories;
 
-
 import org.springframework.data.domain.Page;
 import org.springframework.data.domain.Pageable;
 import org.springframework.data.jpa.repository.EntityGraph;
@@ -44,6 +43,8 @@ public interface UserRepository extends JpaRepository<User, UUID> {
                 ELSE 0
             END = 1
         )
+        AND (:firstName IS NULL OR u.firstName ILIKE %:firstName%)
+        AND (:lastName IS NULL OR u.lastName ILIKE %:lastName%)
         AND (:organisation IS NULL OR u.organisation ILIKE %:organisation%)
         AND (CAST(:courtId as uuid) IS NULL OR EXISTS (SELECT 1 FROM u.appAccess aa WHERE aa.court.id = :courtId))
         AND (CAST(:roleId as uuid) IS NULL OR EXISTS (SELECT 1 FROM u.appAccess aa WHERE aa.role.id = :roleId))
@@ -58,8 +59,11 @@ OR EXISTS (
         AND (:isAppUser = false OR EXISTS (SELECT 1 FROM u.appAccess aa WHERE aa.user = u AND aa.deletedAt IS NULL))
         """
     )
+    @SuppressWarnings("PMD.ExcessiveParameterList")
     Page<User> searchAllBy(
         @Param("name") String name,
+        @Param("firstName") String firstName,
+        @Param("lastName") String lastName,
         @Param("email") String email,
         @Param("organisation") String organisation,
         @Param("courtId") UUID courtId,

src/main/java/uk/gov/hmcts/reform/preapi/services/AppAccessService.java

@@ -90,4 +90,26 @@ public void deleteById(UUID appId) {
                     appAccessRepository.save(access);
                 });
     }
+
+    @Transactional
+    public void deleteByUserId(UUID userId) {
+        appAccessRepository
+            .findAllByUser_IdAndDeletedAtNullAndUser_DeletedAtNull(userId)
+            .forEach(access -> {
+                access.setActive(false);
+                access.setDeletedAt(Timestamp.from(Instant.now()));
+                appAccessRepository.save(access);
+            });
+    }
+
+    @Transactional
+    public void undeleteByUserId(UUID userId) {
+        appAccessRepository
+            .findAllByUser_IdAndDeletedAtIsNotNull(userId)
+            .forEach(a -> {
+                a.setDeletedAt(null);
+                a.setActive(true);
+                appAccessRepository.save(a);
+            });
+    }
 }

src/main/java/uk/gov/hmcts/reform/preapi/services/PortalAccessService.java

@@ -6,6 +6,7 @@
 import org.springframework.transaction.annotation.Transactional;
 import uk.gov.hmcts.reform.preapi.dto.CreatePortalAccessDTO;
 import uk.gov.hmcts.reform.preapi.entities.PortalAccess;
+import uk.gov.hmcts.reform.preapi.entities.User;
 import uk.gov.hmcts.reform.preapi.enums.AccessStatus;
 import uk.gov.hmcts.reform.preapi.enums.UpsertResult;
 import uk.gov.hmcts.reform.preapi.exception.NotFoundException;
@@ -53,6 +54,51 @@ public void deleteById(UUID portalId) {
                 });
     }
 
+    @Transactional
+    public void deleteByUserId(UUID userId) {
+        portalAccessRepository
+            .findByUser_IdAndDeletedAtNullAndUser_DeletedAtNull(userId)
+            .ifPresent(access -> {
+                access.setStatus(AccessStatus.INACTIVE);
+                access.setDeletedAt(Timestamp.from(Instant.now()));
+                portalAccessRepository.save(access);
+            });
+    }
+
+    @Transactional
+    public void undeleteByUserId(UUID userId) {
+        portalAccessRepository
+            .findAllByUser_IdAndDeletedAtIsNotNull(userId)
+            .forEach(p -> {
+                p.setDeletedAt(null);
+                portalAccessRepository.save(p);
+            });
+    }
+
+    public Boolean exists(UUID id) {
+        return portalAccessRepository.existsById(id);
+    }
+
+    public Boolean isNotDeletedPortalUser(UUID userId) {
+        return portalAccessRepository
+            .findByUser_IdAndDeletedAtNullAndUser_DeletedAtNull(userId)
+            .isPresent();
+    }
+
+    public void upsertPortalAccessEntity(UUID id,
+                                         User userEntity,
+                                         AccessStatus accessStatus,
+                                         Timestamp timestamp) {
+        PortalAccess portalAccessEntity = portalAccessRepository
+            .findByUser_IdAndDeletedAtNullAndUser_DeletedAtNull(id)
+            .orElse(new PortalAccess());
+
+        portalAccessEntity.setUser(userEntity);
+        portalAccessEntity.setStatus(accessStatus);
+        portalAccessEntity.setInvitedAt(timestamp);
+        portalAccessRepository.save(portalAccessEntity);
+    }
+
     private AccessStatus getNewStatus(CreatePortalAccessDTO dto) {
         if (dto.getStatus() == AccessStatus.ACTIVE && dto.getRegisteredAt() == null) {
             return AccessStatus.INVITATION_SENT;