CCMSPUI-376: Migrate notification summary from SOA-API to EBS-API (#312)

* CCMSPUI-376: Added notification summary method to EbsApiClient, removed old method from SoaApiClient, and updated HomeController to correlate with these changes. * CCMSPUI-376: Added javadoc to EbsApiClient to fix checkstyle violation * CCMSPUI-376: Updated guild.gradle to include snapshot versions and updated references to correct NotificationSummary package * CCMSPUI-376: Pulled main and resolved conflicts * CCMSPUI-376: Removed old SoaApi test and added new EBS notification summary tests Signed-off-by: Jamie Briggs <jamie.briggs@digital.justice.gov.uk>
ministryofjustice · Dec 9, 2024 · b456b16 · b456b16
1 parent 1f53078
commit b456b16
Show file tree

Hide file tree

Showing 11 changed files with 135 additions and 130 deletions.
diff --git a/build.gradle b/build.gradle
@@ -37,9 +37,9 @@ repositories {
 dependencies {
 
 
-	implementation 'uk.gov.laa.ccms.data:data-api:0.0.21'
+	implementation 'uk.gov.laa.ccms.data:data-api:0.0.22-ef3e97c-SNAPSHOT'
 
-	implementation 'uk.gov.laa.ccms.soa.gateway:soa-gateway-api:0.0.37'
+	implementation 'uk.gov.laa.ccms.soa.gateway:soa-gateway-api:0.0.38-cfdf45d-SNAPSHOT'
 
 	implementation 'uk.gov.laa.ccms.caab:caab-api:0.0.37'
 

diff --git a/src/integrationTest/java/uk/gov/laa/ccms/caab/client/EbsApiClientIntegrationTest.java b/src/integrationTest/java/uk/gov/laa/ccms/caab/client/EbsApiClientIntegrationTest.java
@@ -32,6 +32,7 @@
 import uk.gov.laa.ccms.data.model.CommonLookupDetail;
 import uk.gov.laa.ccms.data.model.CommonLookupValueDetail;
 import uk.gov.laa.ccms.data.model.ContactDetail;
+import uk.gov.laa.ccms.data.model.NotificationSummary;
 import uk.gov.laa.ccms.data.model.OfficeDetail;
 import uk.gov.laa.ccms.data.model.ProviderDetail;
 import uk.gov.laa.ccms.data.model.UserDetail;
@@ -195,6 +196,41 @@ public void testGetUsers_notFound() {
   }
 
 
+  @Test
+  public void testGetUserNotificationSummary_returnData() throws Exception {
+    final String loginId = "user1";
+    final NotificationSummary expectedNotificationsummary = buildUserNotificationSummary();
+    final String notificationSummaryJson = objectMapper.writeValueAsString(
+        expectedNotificationsummary);
+
+    wiremock.stubFor(get(String.format("/users/%s/notifications/summary", loginId))
+        .willReturn(okJson(notificationSummaryJson)));
+
+    final Mono<NotificationSummary> userNotificationSummary = ebsApiClient.getUserNotificationSummary(
+        loginId);
+
+    final NotificationSummary userDetails = userNotificationSummary.block();
+
+    assertEquals(notificationSummaryJson, objectMapper.writeValueAsString(userDetails));
+  }
+
+  @Test
+  public void testGetUserNotificationSummary_notFound() {
+    final String loginId = "user1";
+    final String expectedMessage = String.format(USER_ERROR_MESSAGE, loginId);
+
+    wiremock.stubFor(get(String.format("/users/%s/notifications/summary", loginId))
+        .willReturn(notFound()));
+
+    final Mono<NotificationSummary> notificationSummary = ebsApiClient.getUserNotificationSummary(
+        loginId);
+
+    StepVerifier.create(notificationSummary)
+        .expectErrorMatches(throwable -> throwable instanceof EbsApiClientException
+            && throwable.getMessage().equals(expectedMessage)
+        ).verify();
+  }
+
   // You may need to build the AmendmentTypeLookupDetail for the test
   private AmendmentTypeLookupDetail buildAmendmentTypeLookupDetail() {
     final AmendmentTypeLookupDetail detail = new AmendmentTypeLookupDetail();
@@ -263,4 +299,8 @@ private ProviderDetail buildProviderDetail() {
                 .name("FeeEarner1")));
   }
 
+  private NotificationSummary buildUserNotificationSummary() {
+    return new NotificationSummary().notifications(5).overdueActions(3).standardActions(7);
+  }
+
 }
diff --git a/src/integrationTest/java/uk/gov/laa/ccms/caab/client/SoaApiClientIntegrationTest.java b/src/integrationTest/java/uk/gov/laa/ccms/caab/client/SoaApiClientIntegrationTest.java
@@ -33,7 +33,6 @@
 import uk.gov.laa.ccms.soa.gateway.model.CoverSheet;
 import uk.gov.laa.ccms.soa.gateway.model.Document;
 import uk.gov.laa.ccms.soa.gateway.model.Notification;
-import uk.gov.laa.ccms.soa.gateway.model.NotificationSummary;
 import uk.gov.laa.ccms.soa.gateway.model.Notifications;
 import uk.gov.laa.ccms.soa.gateway.model.UserDetail;
 import uk.gov.laa.ccms.soa.gateway.model.UserOptions;
@@ -84,26 +83,6 @@ public void testGetContractDetails_returnData() throws Exception {
     assertEquals(contractDetailsJson, objectMapper.writeValueAsString(response.block()));
   }
 
-  @Test
-  public void testGetNotificationsSummary_returnData() throws Exception {
-    String loginId = USER_1;
-    String userType = USER_TYPE;
-    NotificationSummary expectedSummary = buildNotificationSummary();
-    String summaryJson = objectMapper.writeValueAsString(expectedSummary);
-
-    wiremock.stubFor(get(String.format("/users/%s/notifications/summary", loginId))
-        .withHeader(SOA_GATEWAY_USER_LOGIN_ID, equalTo(loginId))
-        .withHeader(SOA_GATEWAY_USER_ROLE, equalTo(userType))
-        .willReturn(okJson(summaryJson)));
-
-    Mono<NotificationSummary> summaryMono =
-        soaApiClient.getNotificationsSummary(loginId, userType);
-
-    NotificationSummary summary = summaryMono.block();
-
-    assertEquals(summaryJson, objectMapper.writeValueAsString(summary));
-  }
-
   @Test
   public void testGetCases_returnData() throws Exception {
     String loginId = USER_1;
@@ -382,13 +361,6 @@ public void testUpdateUserOptions_returnsData() throws Exception {
     assertEquals(clientTransactionResponse, response);
   }
 
-  private NotificationSummary buildNotificationSummary() {
-    return new NotificationSummary()
-        .notifications(10)
-        .standardActions(5)
-        .overdueActions(2);
-  }
-
   private ContractDetails buildContractDetails() {
     return new ContractDetails()
         .addContractsItem(new ContractDetail()

diff --git a/src/main/java/uk/gov/laa/ccms/caab/client/EbsApiClient.java b/src/main/java/uk/gov/laa/ccms/caab/client/EbsApiClient.java
@@ -1,6 +1,5 @@
 package uk.gov.laa.ccms.caab.client;
 
-import java.util.Objects;
 import java.util.Optional;
 import lombok.RequiredArgsConstructor;
 import lombok.extern.slf4j.Slf4j;
@@ -20,6 +19,7 @@
 import uk.gov.laa.ccms.data.model.EvidenceDocumentTypeLookupDetail;
 import uk.gov.laa.ccms.data.model.LevelOfServiceLookupDetail;
 import uk.gov.laa.ccms.data.model.MatterTypeLookupDetail;
+import uk.gov.laa.ccms.data.model.NotificationSummary;
 import uk.gov.laa.ccms.data.model.OutcomeResultLookupDetail;
 import uk.gov.laa.ccms.data.model.PriorAuthorityTypeDetails;
 import uk.gov.laa.ccms.data.model.ProceedingDetail;
@@ -68,6 +68,22 @@ public Mono<UserDetail> getUser(final String loginId) {
                 e, "User", "login id", loginId));
   }
 
+  /**
+   * Retrieves a summary of notification counts for a user based on their login ID.
+   *
+   * @param loginId the login ID of the user whose notification summary is to be retrieved
+   * @return a Mono emitting the NotificationSummary for the specified user
+   */
+  public Mono<NotificationSummary> getUserNotificationSummary(final String loginId) {
+    return ebsApiWebClient
+        .get()
+        .uri("/users/{loginId}/notifications/summary", loginId)
+        .retrieve()
+        .bodyToMono(NotificationSummary.class)
+        .onErrorResume(e -> ebsApiClientErrorHandler.handleApiRetrieveError(
+            e, "User", "login id", loginId));
+  }
+
   /**
    * Retrieves details for a specific provider.
    *

diff --git a/src/main/java/uk/gov/laa/ccms/caab/client/SoaApiClient.java b/src/main/java/uk/gov/laa/ccms/caab/client/SoaApiClient.java
@@ -28,7 +28,6 @@
 import uk.gov.laa.ccms.soa.gateway.model.ContractDetails;
 import uk.gov.laa.ccms.soa.gateway.model.CoverSheet;
 import uk.gov.laa.ccms.soa.gateway.model.Document;
-import uk.gov.laa.ccms.soa.gateway.model.NotificationSummary;
 import uk.gov.laa.ccms.soa.gateway.model.Notifications;
 import uk.gov.laa.ccms.soa.gateway.model.OrganisationDetail;
 import uk.gov.laa.ccms.soa.gateway.model.OrganisationDetails;
@@ -53,28 +52,6 @@ public class SoaApiClient {
 
   private final SoaApiClientErrorHandler soaApiClientErrorHandler;
 
-  /**
-   * Retrieve the summary of notifications for a given user.
-   *
-   * @param loginId  The login identifier for the user.
-   * @param userType Type of the user (e.g., admin, user).
-   * @return A Mono wrapping the NotificationSummary for the specified user.
-   */
-  public Mono<NotificationSummary> getNotificationsSummary(
-      final String loginId,
-      final String userType) {
-
-    return soaApiWebClient
-        .get()
-        .uri("/users/{loginId}/notifications/summary", loginId)
-        .header(SOA_GATEWAY_USER_LOGIN_ID, loginId)
-        .header(SOA_GATEWAY_USER_ROLE, userType)
-        .retrieve()
-        .bodyToMono(NotificationSummary.class)
-        .onErrorResume(e -> soaApiClientErrorHandler.handleApiRetrieveError(
-            e, "Notification summary", "user login id", loginId));
-  }
-
   /**
    * Fetches the contract details for the given criteria.
    *

diff --git a/src/main/java/uk/gov/laa/ccms/caab/controller/HomeController.java b/src/main/java/uk/gov/laa/ccms/caab/controller/HomeController.java
@@ -11,8 +11,8 @@
 import uk.gov.laa.ccms.caab.config.UserRole;
 import uk.gov.laa.ccms.caab.service.NotificationService;
 import uk.gov.laa.ccms.caab.util.UserRoleUtil;
+import uk.gov.laa.ccms.data.model.NotificationSummary;
 import uk.gov.laa.ccms.data.model.UserDetail;
-import uk.gov.laa.ccms.soa.gateway.model.NotificationSummary;
 
 /**
  * Controller handling home page requests.
@@ -38,7 +38,7 @@ public String home(Model model, HttpSession session) {
 
     // Retrieve a summary of the User's Notifications & Actions from the SOA Gateway
     NotificationSummary notificationSummary = notificationService.getNotificationsSummary(
-            user.getLoginId(), user.getUserType()).block();
+        user.getLoginId()).block();
 
     boolean showNotifications =
         notificationSummary != null && UserRoleUtil.hasRole(user, UserRole.VIEW_NOTIFICATIONS);

diff --git a/src/main/java/uk/gov/laa/ccms/caab/service/NotificationService.java b/src/main/java/uk/gov/laa/ccms/caab/service/NotificationService.java
@@ -15,6 +15,7 @@
 import reactor.core.publisher.Mono;
 import uk.gov.laa.ccms.caab.bean.NotificationSearchCriteria;
 import uk.gov.laa.ccms.caab.client.CaabApiClient;
+import uk.gov.laa.ccms.caab.client.EbsApiClient;
 import uk.gov.laa.ccms.caab.client.S3ApiClient;
 import uk.gov.laa.ccms.caab.client.SoaApiClient;
 import uk.gov.laa.ccms.caab.exception.CaabApplicationException;
@@ -23,9 +24,9 @@
 import uk.gov.laa.ccms.caab.model.NotificationAttachmentDetail;
 import uk.gov.laa.ccms.caab.model.NotificationAttachmentDetails;
 import uk.gov.laa.ccms.caab.util.FileUtil;
+import uk.gov.laa.ccms.data.model.NotificationSummary;
 import uk.gov.laa.ccms.soa.gateway.model.CoverSheet;
 import uk.gov.laa.ccms.soa.gateway.model.Document;
-import uk.gov.laa.ccms.soa.gateway.model.NotificationSummary;
 import uk.gov.laa.ccms.soa.gateway.model.Notifications;
 
 /**
@@ -36,6 +37,7 @@
 @Slf4j
 public class NotificationService {
 
+  private final EbsApiClient ebsApiClient;
   private final SoaApiClient soaApiClient;
   private final CaabApiClient caabApiClient;
   private final S3ApiClient s3ApiClient;
@@ -48,11 +50,10 @@ public class NotificationService {
    * Retrieve the summary of notifications for a given user.
    *
    * @param loginId  The login identifier for the user.
-   * @param userType Type of the user (e.g., admin, user).
    * @return A Mono wrapping the NotificationSummary for the specified user.
    */
-  public Mono<NotificationSummary> getNotificationsSummary(String loginId, String userType) {
-    return soaApiClient.getNotificationsSummary(loginId, userType);
+  public Mono<NotificationSummary> getNotificationsSummary(String loginId) {
+    return ebsApiClient.getUserNotificationSummary(loginId);
   }
 
   /**

diff --git a/src/test/java/uk/gov/laa/ccms/caab/client/EbsApiClientTest.java b/src/test/java/uk/gov/laa/ccms/caab/client/EbsApiClientTest.java
@@ -37,6 +37,7 @@
 import uk.gov.laa.ccms.data.model.EvidenceDocumentTypeLookupDetail;
 import uk.gov.laa.ccms.data.model.LevelOfServiceLookupDetail;
 import uk.gov.laa.ccms.data.model.MatterTypeLookupDetail;
+import uk.gov.laa.ccms.data.model.NotificationSummary;
 import uk.gov.laa.ccms.data.model.OutcomeResultLookupDetail;
 import uk.gov.laa.ccms.data.model.PriorAuthorityTypeDetails;
 import uk.gov.laa.ccms.data.model.ProceedingDetail;
@@ -69,8 +70,6 @@ public class EbsApiClientTest {
   @InjectMocks
   private EbsApiClient ebsApiClient;
 
-
-
   ArgumentCaptor<Function<UriBuilder, URI>> uriCaptor = ArgumentCaptor.forClass(Function.class);
 
   @Test
@@ -114,6 +113,62 @@ void getUser_notFound() {
         .verifyComplete();
   }
 
+  @Test
+  void getUserNotificationSummary_returnsData() {
+    final String loginId = "user1";
+    final String expectedUri = "/users/{loginId}/notifications/summary";
+
+    final NotificationSummary mockNotificationSummary = new NotificationSummary();
+    mockNotificationSummary.setNotifications(1);
+    mockNotificationSummary.setStandardActions(3);
+    mockNotificationSummary.setOverdueActions(2);
+
+    when(webClientMock.get()).thenReturn(requestHeadersUriMock);
+    when(requestHeadersUriMock.uri(expectedUri, loginId)).thenReturn(requestHeadersMock);
+    when(requestHeadersMock.retrieve()).thenReturn(responseMock);
+    when(responseMock.bodyToMono(NotificationSummary.class)).thenReturn(
+        Mono.just(mockNotificationSummary));
+
+    final Mono<NotificationSummary> notificationSummary = ebsApiClient.getUserNotificationSummary(
+        loginId);
+
+    StepVerifier.create(notificationSummary)
+        .expectNextMatches(summary ->
+            summary.getNotifications().equals(1) &&
+                summary.getStandardActions().equals(3) &&
+                summary.getOverdueActions().equals(2)
+        )
+        .verifyComplete();
+  }
+
+  @Test
+  void getUserNotificationSummary_NotFound() {
+    final String loginId = "user1";
+    final String expectedUri = "/users/{loginId}/notifications/summary";
+
+    final NotificationSummary mockNotificationSummary = new NotificationSummary();
+    mockNotificationSummary.setNotifications(1);
+    mockNotificationSummary.setStandardActions(3);
+    mockNotificationSummary.setOverdueActions(2);
+
+    when(webClientMock.get()).thenReturn(requestHeadersUriMock);
+    when(requestHeadersUriMock.uri(expectedUri, loginId)).thenReturn(requestHeadersMock);
+    when(requestHeadersMock.retrieve()).thenReturn(responseMock);
+    when(responseMock.bodyToMono(NotificationSummary.class)).thenReturn(
+        Mono.just(mockNotificationSummary));
+
+    final Mono<NotificationSummary> notificationSummary = ebsApiClient.getUserNotificationSummary(
+        loginId);
+
+    StepVerifier.create(notificationSummary)
+        .expectNextMatches(summary ->
+            summary.getNotifications().equals(1) &&
+                summary.getStandardActions().equals(3) &&
+                summary.getOverdueActions().equals(2)
+        )
+        .verifyComplete();
+  }
+
   @Test
   void getCommonValues_returnsData() {
     final String type = "type1";