Merge pull request #205 from hmcts/dev/AMP433

AMP-433 changes

Author: srivanimuddineni

build.gradle

@@ -32,7 +32,7 @@ apply {
 // Sadly, dependabot does not track dependencies in the apply-from files
 dependencies {
   // Api spec
-  implementation('uk.gov.hmcts.cp:api-cp-crime-hearing-case-event-subscription:2.0.0')
+  implementation('uk.gov.hmcts.cp:api-cp-crime-hearing-case-event-subscription:2.0.1')
   implementation('io.swagger.core.v3:swagger-annotations:2.2.46')
 
 

src/main/java/uk/gov/hmcts/cp/subscription/controllers/NotificationController.java

@@ -20,6 +20,7 @@
 import uk.gov.hmcts.cp.filters.ClientIdResolutionFilter;
 import uk.gov.hmcts.cp.openapi.api.InternalApi;
 import uk.gov.hmcts.cp.openapi.api.NotificationApi;
+import uk.gov.hmcts.cp.openapi.model.EventNotificationPayload;
 import uk.gov.hmcts.cp.openapi.model.EventPayload;
 import uk.gov.hmcts.cp.servicebus.config.ServiceBusProperties;
 import uk.gov.hmcts.cp.servicebus.services.ServiceBusClientService;
@@ -56,7 +57,7 @@ public Optional<NativeWebRequest> getRequest() {
     }
 
     @Override
-    public ResponseEntity<Void> createNotification(
+    public ResponseEntity<EventNotificationPayload> createNotification(
             @Valid @RequestBody final EventPayload eventPayload,
             // note the X-Correlation-Id is handled by TracingFilter but we need to declare it because its in the spec
             @RequestHeader(value = "X-Correlation-Id", required = false) final UUID xCorrelationId) {
@@ -67,10 +68,10 @@ public ResponseEntity<Void> createNotification(
         if (serviceBusConfig.isEnabled()) {
             final String pcrEventjson = jsonMapper.toJson(eventPayload);
             clientService.queueMessage(NOTIFICATIONS_INBOUND_QUEUE, null, pcrEventjson, 0);
-        } else {
-            notificationManager.processPcrNotification(eventPayload);
+            return new ResponseEntity<>(HttpStatus.ACCEPTED);
         }
-        return new ResponseEntity<>(HttpStatus.ACCEPTED);
+        final EventNotificationPayload payload = notificationManager.processPcrNotification(eventPayload);
+        return new ResponseEntity<>(payload, HttpStatus.ACCEPTED);
     }
 
     @Override

src/main/java/uk/gov/hmcts/cp/subscription/managers/NotificationManager.java

@@ -5,6 +5,7 @@
 import org.springframework.http.HttpStatus;
 import org.springframework.stereotype.Component;
 import org.springframework.web.server.ResponseStatusException;
+import uk.gov.hmcts.cp.openapi.model.EventNotificationPayload;
 import uk.gov.hmcts.cp.openapi.model.EventPayload;
 import uk.gov.hmcts.cp.subscription.model.DocumentContent;
 import uk.gov.hmcts.cp.subscription.services.CallbackDeliveryService;
@@ -28,11 +29,12 @@ public class NotificationManager {
     private final SubscriptionService subscriptionService;
     private final CallbackDeliveryService callbackDeliveryService;
 
-    public void processPcrNotification(final EventPayload eventPayload) {
+    public EventNotificationPayload processPcrNotification(final EventPayload eventPayload) {
         log.info("processPcrNotification eventId:{} materialId:{}", eventPayload.getEventId(), eventPayload.getMaterialId());
         final UUID documentId = notificationService.processInboundEvent(eventPayload);
-        callbackDeliveryService.submitOutboundPcrEvents(eventPayload, documentId);
+        final EventNotificationPayload payload = callbackDeliveryService.submitOutboundPcrEvents(eventPayload, documentId);
         log.info("processPcrNotification complete eventId:{} documentId:{}", eventPayload.getEventId(), documentId);
+        return payload;
     }
 
     public DocumentContent getPcrDocumentContent(final UUID clientSubscriptionId, final UUID documentId) {

src/main/java/uk/gov/hmcts/cp/subscription/services/CallbackDeliveryService.java

@@ -38,7 +38,7 @@ public class CallbackDeliveryService {
     private final CallbackService callbackService;
     private final HmacManager hmacManager;
 
-    public void submitOutboundPcrEvents(final EventPayload eventPayload, final UUID documentId) {
+    public EventNotificationPayload submitOutboundPcrEvents(final EventPayload eventPayload, final UUID documentId) {
         final String eventType = eventPayload.getEventType();
         final List<ClientEntity> clients = clientEventRepository.findClientsByEventType(eventType);
         final EventNotificationPayload eventNotificationPayload = notificationMapper.mapToPayload(documentId, eventPayload);
@@ -59,5 +59,6 @@ public void submitOutboundPcrEvents(final EventPayload eventPayload, final UUID
                 log.info("Subscriber {} notified via callbackUrl {} for documentId {}", client.getSubscriptionId(), client.getCallbackUrl(), eventNotificationPayload.getDocumentId());
             }
         }
+        return eventNotificationPayload;
     }
 }

src/test/java/uk/gov/hmcts/cp/servicebus/integration/ServiceBusAdminIntegrationTest.java

@@ -15,6 +15,7 @@
 import java.util.List;
 
 import static org.assertj.core.api.Assertions.assertThat;
+import static org.junit.jupiter.api.Assumptions.assumeTrue;
 
 @Slf4j
 @SpringBootTest

src/test/java/uk/gov/hmcts/cp/subscription/unit/controllers/NotificationControllerTest.java

@@ -13,6 +13,7 @@
 import org.springframework.http.MediaType;
 import org.springframework.http.ResponseEntity;
 import uk.gov.hmcts.cp.filters.ClientIdResolutionFilter;
+import uk.gov.hmcts.cp.openapi.model.EventNotificationPayload;
 import uk.gov.hmcts.cp.openapi.model.EventPayload;
 import uk.gov.hmcts.cp.servicebus.config.ServiceBusProperties;
 import uk.gov.hmcts.cp.servicebus.services.ServiceBusClientService;
@@ -62,20 +63,28 @@ void clearMdcClientId() {
 
     @SneakyThrows
     @Test
-    void service_bus_disabled_should_process_notification_synchronously() {
+    void service_bus_disabled_should_process_notification_synchronously_and_return_payload() {
+        final EventNotificationPayload expectedPayload = new EventNotificationPayload();
         when(configService.isEnabled()).thenReturn(false);
-        ResponseEntity<Void> response = notificationController.createNotification(payload, null);
+        when(notificationManager.processPcrNotification(eq(payload))).thenReturn(expectedPayload);
+
+        ResponseEntity<EventNotificationPayload> response = notificationController.createNotification(payload, null);
+
         verify(notificationManager).processPcrNotification(eq(payload));
         assertThat(response.getStatusCode()).isEqualTo(ACCEPTED);
+        assertThat(response.getBody()).isEqualTo(expectedPayload);
     }
 
     @Test
-    void service_bus_enabled_should_queue_to_service_bus() {
+    void service_bus_enabled_should_queue_to_service_bus_and_return_202_no_body() {
         when(configService.isEnabled()).thenReturn(true);
         when(jsonMapper.toJson(payload)).thenReturn("payload-json");
-        ResponseEntity<Void> response = notificationController.createNotification(payload, null);
+
+        ResponseEntity<EventNotificationPayload> response = notificationController.createNotification(payload, null);
+
         verify(clientService).queueMessage(NOTIFICATIONS_INBOUND_QUEUE, null, "payload-json", 0);
         assertThat(response.getStatusCode()).isEqualTo(ACCEPTED);
+        assertThat(response.getBody()).isNull();
     }
 
     @Test

src/test/java/uk/gov/hmcts/cp/subscription/unit/managers/NotificationManagerTest.java

@@ -8,6 +8,7 @@
 import org.springframework.http.HttpStatus;
 import org.springframework.http.MediaType;
 import org.springframework.web.server.ResponseStatusException;
+import uk.gov.hmcts.cp.openapi.model.EventNotificationPayload;
 import uk.gov.hmcts.cp.openapi.model.EventPayload;
 import uk.gov.hmcts.cp.subscription.managers.NotificationManager;
 import uk.gov.hmcts.cp.subscription.model.DocumentContent;
@@ -60,13 +61,16 @@ class NotificationManagerTest {
             .build();
 
     @Test
-    void processPcrNotification_should_process_deliver() {
+    void processPcrNotification_should_process_deliver_and_return_notification_payload() {
+        final EventNotificationPayload expectedPayload = new EventNotificationPayload();
         when(notificationService.processInboundEvent(payload)).thenReturn(documentId);
+        when(callbackDeliveryService.submitOutboundPcrEvents(payload, documentId)).thenReturn(expectedPayload);
 
-        notificationManager.processPcrNotification(payload);
+        final EventNotificationPayload result = notificationManager.processPcrNotification(payload);
 
         verify(notificationService).processInboundEvent(eq(payload));
         verify(callbackDeliveryService).submitOutboundPcrEvents(payload, documentId);
+        assertThat(result).isEqualTo(expectedPayload);
     }
 
     @Test