Logs formatting improvement (#1276)

* logs formatting improvement

* checkstyle

* fixing IT tests

* test update scenario

* adressing pitest

Author: ORybak5

service/src/intTest/java/uk/nhs/adaptors/gp2gp/ehr/EhrContinueTest.java

@@ -82,7 +82,7 @@ public void When_EhrContinueThrowsException_Expect_EhrExtractStatusNotUpdated()
         Exception exception = assertThrows(UnrecognisedInteractionIdException.class,
                                            () -> ehrExtractRequestHandler.handleContinue(conversationId, CONTINUE_ACKNOWLEDGEMENT));
 
-        assertThat(exception.getMessage()).isEqualTo("Received an unrecognized Continue message with conversation_id: "
+        assertThat(exception.getMessage()).isEqualTo("Received an unrecognized Continue message with conversationId: "
             + conversationId);
         verify(taskDispatcher, never()).createTask(any());
     }

service/src/intTest/java/uk/nhs/adaptors/gp2gp/ehr/EhrExtractStatusServiceIT.java

@@ -92,7 +92,7 @@ void When_EhrStatusWithExceededTimeout_Expect_EhrStatusShouldNotBeUpdated() {
         ehrExtractStatusServiceSpy.updateEhrExtractStatusAck(inProgressConversationId, ehrReceivedAcknowledgement);
 
         verify(logger, times(1))
-            .warn("Received an ACK message with conversation_id: {}, "
+            .warn("Received an ACK message with conversationId: {}, "
                   + "but it is being ignored because the EhrExtract has already been marked as failed "
                   + "from not receiving an acknowledgement from the requester in time.",
                   inProgressConversationId);

service/src/main/java/uk/nhs/adaptors/gp2gp/ehr/EhrExtractStatusService.java

@@ -161,7 +161,7 @@ public void saveEhrExtractMessageId(String conversationId, String messageId) {
                 ehrExtractStatusRepository.save(ehrExtractStatus);
             },
             () -> {
-                throw new EhrExtractException("Unable to find EHR Extract status with conversation id " + conversationId);
+                throw new EhrExtractException("Unable to find EHR Extract status with conversationId " + conversationId);
             });
     }
 
@@ -314,8 +314,8 @@ public Optional<EhrExtractStatus> updateEhrExtractStatusContinue(String conversa
                 EhrExtractStatus.class);
 
             if (ehrExtractStatus == null) {
-                throw new EhrExtractException("Received a Continue message with a conversation_id '" + conversationId
-                    + "' that is not recognised");
+                throw new EhrExtractException(format("Received a Continue message with a conversationId %s that is not recognised",
+                                                     conversationId));
             }
 
             LOGGER.info("Database successfully updated with EHRContinue");
@@ -342,34 +342,34 @@ public void updateEhrExtractStatusWithEhrReceivedAckError(String conversationId,
 
         if (ehrExtractStatus == null) {
             throw new EhrExtractException(format(
-                "Couldn't update EHR received acknowledgement with error information because EHR status doesn't exist, conversation_id: %s",
+                "Couldn't update EHR received acknowledgement with error information because EHR status doesn't exist, conversationId: %s",
                 conversationId));
         }
 
         logger().info("EHR status (EHR received acknowledgement) record successfully "
-                      + "updated in the database with error information conversation_id: {}", conversationId);
+                      + "updated in the database with error information conversationId: {}", conversationId);
 
     }
 
     public void updateEhrExtractStatusAck(String conversationId, EhrReceivedAcknowledgement ack) {
 
         if (ack.getErrors() == null && !isEhrStatusWaitingForFinalAck(conversationId)) {
-            logger().warn("Received unexpected acknowledgement of EHR Extract with conversation id=" + conversationId);
+            logger().warn("Received unexpected acknowledgement of EHR Extract with conversationId: {}", conversationId);
             return;
         }
 
         if (hasAcknowledgementExceededAckTimeoutLimit(conversationId, ack.getReceived())
             && hasEhrStatusReceivedAckWithErrors(conversationId)) {
 
-            logger().warn("Received an ACK message with conversation_id: {}, "
+            logger().warn("Received an ACK message with conversationId: {}, "
                           + "but it is being ignored because the EhrExtract has already been marked as failed "
                           + "from not receiving an acknowledgement from the requester in time.",
                           conversationId);
             return;
         }
 
         if (hasFinalAckBeenReceived(conversationId)) {
-            logger().warn("Received an ACK message with a conversation_id: {} that is a duplicate", conversationId);
+            logger().warn("Received an ACK message with a conversationId: {} that is a duplicate", conversationId);
             return;
         }
 
@@ -396,11 +396,11 @@ && hasEhrStatusReceivedAckWithErrors(conversationId)) {
             EhrExtractStatus.class);
 
         if (ehrExtractStatus == null) {
-            throw new EhrExtractException("Received an ACK message with a conversation_id '" + conversationId
-                + "' that is not recognised");
+            throw new EhrExtractException(format("Received an ACK message with a conversationId %s that is not recognised",
+                                                 conversationId));
         }
 
-        logger().info("Database successfully updated with EHRAcknowledgement, conversation_id: {}", conversationId);
+        logger().info("Database successfully updated with EHRAcknowledgement, conversationId: {}", conversationId);
     }
 
     public void saveAckForConversation(String conversationId, EhrReceivedAcknowledgement ack) {
@@ -502,10 +502,10 @@ public EhrExtractStatus updateEhrExtractStatusError(
 
         if (ehrExtractStatus == null) {
             throw new EhrExtractException(format(
-                "Couldn't update EHR status with error information because it doesn't exist conversation_id: %s", conversationId));
+                "Couldn't update EHR status with error information because it doesn't exist conversationId: %s", conversationId));
         }
 
-        logger().info("EHR status record successfully updated in the database with error information conversation_id: {}", conversationId);
+        logger().info("EHR status record successfully updated in the database with error information conversationId: {}", conversationId);
 
         return ehrExtractStatus;
     }
@@ -631,8 +631,7 @@ private boolean checkForContinueOutOfOrderAndDuplicate(String conversationId) {
         }
 
         if (ehrExtractStatus.getEhrContinue() != null) {
-            LOGGER.warn("Received a Continue message with a conversation_id '" + conversationId
-                + "' that is duplicate");
+            LOGGER.warn("Received a Continue message with a conversationId {} that is duplicate", conversationId);
             return true;
         }
 

service/src/main/java/uk/nhs/adaptors/gp2gp/ehr/scheduling/EhrExtractTimeoutScheduler.java

@@ -45,7 +45,7 @@ public void processEhrExtractAckTimeouts() {
 
             } catch (EhrExtractException exception) {
 
-                logger().error("An error occurred when updating EHR Extract with Ack erorrs, EHR Extract Status conversation_id: {}",
+                logger().error("An error occurred when updating EHR Extract with Ack erorrs, EHR Extract Status conversationId: {}",
                                ehrExtractStatus.getConversationId(), exception);
                 throw exception;
             } catch (Exception exception) {

service/src/main/java/uk/nhs/adaptors/gp2gp/mhs/exception/UnrecognisedInteractionIdException.java

@@ -2,7 +2,7 @@
 
 public class UnrecognisedInteractionIdException extends RuntimeException {
 
-    private static final String EXCEPTION_MESSAGE = "Received an unrecognized %s message with conversation_id: %s";
+    private static final String EXCEPTION_MESSAGE = "Received an unrecognized %s message with conversationId: %s";
 
     public UnrecognisedInteractionIdException(String messageType, String conversationId) {
         super(EXCEPTION_MESSAGE.formatted(messageType, conversationId));

service/src/test/java/uk/nhs/adaptors/gp2gp/ehr/EhrExtractStatusServiceTest.java

@@ -15,6 +15,7 @@
 import org.springframework.data.mongodb.core.query.Update;
 import org.springframework.data.mongodb.core.query.UpdateDefinition;
 import uk.nhs.adaptors.gp2gp.common.service.TimestampService;
+import uk.nhs.adaptors.gp2gp.ehr.exception.EhrExtractException;
 import uk.nhs.adaptors.gp2gp.ehr.model.EhrExtractStatus;
 import uk.nhs.adaptors.gp2gp.mhs.exception.UnrecognisedInteractionIdException;
 
@@ -26,6 +27,7 @@
 import java.util.Optional;
 import java.util.UUID;
 
+import static java.lang.String.format;
 import static org.junit.jupiter.api.Assertions.assertDoesNotThrow;
 import static org.junit.jupiter.api.Assertions.assertEquals;
 import static org.junit.jupiter.api.Assertions.assertFalse;
@@ -112,7 +114,7 @@ void shouldLogWarningWhenLateAcknowledgementReceivedAfter8DaysAndEhrReceivedAckH
         ehrExtractStatusServiceSpy.updateEhrExtractStatusAck(conversationId, ack);
 
         verify(logger, times(1))
-            .warn("Received an ACK message with conversation_id: {}, "
+            .warn("Received an ACK message with conversationId: {}, "
                   + "but it is being ignored because the EhrExtract has already been marked as failed "
                   + "from not receiving an acknowledgement from the requester in time.",
                   conversationId);
@@ -144,9 +146,9 @@ void shouldNotLogWarningThatAckIsIgnoredWhenAcknowledgementReceivedAfter8Days()
         ehrExtractStatusServiceSpy.updateEhrExtractStatusAck(conversationId, ack);
 
         verify(logger, never())
-            .warn("Received an ACK message with a conversation_id: {}, but it will be ignored", conversationId);
+            .warn("Received an ACK message with a conversationId: {}, but it will be ignored", conversationId);
         verify(logger, times(1))
-            .warn("Received an ACK message with a conversation_id: {} that is a duplicate", conversationId);
+            .warn("Received an ACK message with a conversationId: {} that is a duplicate", conversationId);
     }
 
     @Test
@@ -166,7 +168,7 @@ void shouldUpdateStatusWithErrorAndSpecificErrorCodeAndMessage() {
                                                                                  ERROR_MESSAGE);
 
         verify(logger).info("EHR status (EHR received acknowledgement) record successfully "
-                            + "updated in the database with error information conversation_id: {}", inProgressConversationId);
+                            + "updated in the database with error information conversationId: {}", inProgressConversationId);
         verify(mongoTemplate, times(1)).findAndModify(queryCaptor.capture(),
                                                       updateCaptor.capture(),
                                                       any(FindAndModifyOptions.class),
@@ -219,9 +221,32 @@ void shouldNotLogWarningThatAckIsIgnoredWhenAcknowledgementReceivedAfterWithinAn
         ehrExtractStatusServiceSpy.updateEhrExtractStatusAck(conversationId, ack);
 
         verify(logger, never())
-            .warn("Received an ACK message with a conversation_id: {}, but it will be ignored", conversationId);
+            .warn("Received an ACK message with a conversationId: {}, but it will be ignored", conversationId);
         verify(logger, times(1))
-            .warn("Received an ACK message with a conversation_id: {} that is a duplicate", conversationId);
+            .warn("Received an ACK message with a conversationId: {} that is a duplicate", conversationId);
+    }
+
+    @Test
+    void receiveExceptionWhenEhrExtractStatusIsNull() {
+
+        EhrExtractStatusService ehrExtractStatusServiceSpy = spy(ehrExtractStatusService);
+        String conversationId = generateRandomUppercaseUUID();
+        Instant currentInstant = Instant.now();
+        Optional<EhrExtractStatus> ehrExtractStatus = Optional.of(EhrExtractStatus.builder().ehrExtractCorePending(null).build());
+
+        doReturn(true).when(ehrExtractStatusServiceSpy).isEhrStatusWaitingForFinalAck(conversationId);
+        doReturn(false).when(ehrExtractStatusServiceSpy).hasFinalAckBeenReceived(conversationId);
+        doReturn(ehrExtractStatus).when(ehrExtractStatusRepository).findByConversationId(conversationId);
+        when(ack.getErrors()).thenReturn(null);
+        when(ack.getReceived()).thenReturn(currentInstant);
+        doReturn(null)
+            .when(mongoTemplate).findAndModify(any(Query.class), any(Update.class), any(FindAndModifyOptions.class), any(Class.class));
+
+        Exception ehrExtractException = assertThrows(EhrExtractException.class,
+                                           () -> ehrExtractStatusServiceSpy.updateEhrExtractStatusAck(conversationId, ack));
+
+        assertTrue(ehrExtractException.getMessage()
+                       .contains(format("Received an ACK message with a conversationId %s that is not recognised", conversationId)));
     }
 
     @Test
@@ -243,9 +268,9 @@ void updateEhrExtractStatusWhenEhrExtractCorePendingIsNull() {
 
         ehrExtractStatusServiceSpy.updateEhrExtractStatusAck(conversationId, ack);
 
-        verify(logger, never()).warn("Received an ACK message with a conversation_id={} exceeded 8 days", conversationId);
+        verify(logger, never()).warn("Received an ACK message with a conversationId={} exceeded 8 days", conversationId);
         verify(logger, times(1))
-            .info("Database successfully updated with EHRAcknowledgement, conversation_id: {}", conversationId);
+            .info("Database successfully updated with EHRAcknowledgement, conversationId: {}", conversationId);
     }
 
     @Test
@@ -262,7 +287,7 @@ void ehrExtractStatusThrowsExceptionWhenConversationIdNotFound() {
         Exception exception = assertThrows(UnrecognisedInteractionIdException.class, () ->
             ehrExtractStatusServiceSpy.updateEhrExtractStatusAck(conversationId, ack));
 
-        assertEquals("Received an unrecognized ACK message with conversation_id: " + conversationId,
+        assertEquals("Received an unrecognized ACK message with conversationId: " + conversationId,
                      exception.getMessage());
 
         verify(ehrExtractStatusServiceSpy, never()).updateEhrExtractStatusError(conversationId,
@@ -307,6 +332,31 @@ void doesNotUpdateEhrExtractStatusWhenEhrContinueIsPresent() {
         assertFalse(ehrExtractStatusResult.isPresent());
     }
 
+    @Test
+    void throwsEhrExtractExceptionWhenEhrExtractStatusIsNotFound() {
+        EhrExtractStatusService ehrExtractStatusServiceSpy = spy(ehrExtractStatusService);
+        String conversationId = generateRandomUppercaseUUID();
+
+        Optional<EhrExtractStatus> ehrExtractStatus = Optional.of(EhrExtractStatus.builder()
+                                                                      .ehrExtractCorePending(
+                                                                          EhrExtractStatus
+                                                                              .EhrExtractCorePending
+                                                                              .builder()
+                                                                              .sentAt(Instant.now())
+                                                                              .taskId("22222").build())
+                                                                      .build());
+        doReturn(ehrExtractStatus).when(ehrExtractStatusRepository).findByConversationId(conversationId);
+
+        doReturn(null).when(mongoTemplate).findAndModify(any(Query.class), any(UpdateDefinition.class),
+                                                                            any(FindAndModifyOptions.class), any());
+
+        Exception exception = assertThrows(EhrExtractException.class,
+                                           () -> ehrExtractStatusServiceSpy.updateEhrExtractStatusContinue(conversationId));
+
+        assertTrue(exception.getMessage()
+                       .contains(format("Received a Continue message with a conversationId %s that is not recognised", conversationId)));
+    }
+
     @Test
     void expectTrueWhenEhrExtractStatusWithEhrReceivedAckWithErrorsAndExceededTimeoutLimit() {
 
@@ -404,7 +454,7 @@ void shouldUpdateStatusWithErrorWhenEhrExtractAckTimeoutOccurs() {
                                                                                  ERROR_MESSAGE);
 
         verify(logger).info("EHR status (EHR received acknowledgement) record successfully "
-                            + "updated in the database with error information conversation_id: {}", inProgressConversationId);
+                            + "updated in the database with error information conversationId: {}", inProgressConversationId);
     }
 
 
@@ -521,7 +571,7 @@ void shouldLogWarningWithMsgIgnoredWhenLateAcknowledgementReceivedAfter8DaysAndE
         ehrExtractStatusServiceSpy.updateEhrExtractStatusAck(conversationId, ack);
 
         verify(logger, times(1))
-                                    .warn("Received an ACK message with conversation_id: {}, "
+                                    .warn("Received an ACK message with conversationId: {}, "
                                           + "but it is being ignored because the EhrExtract has already been marked as failed "
                                           + "from not receiving an acknowledgement from the requester in time.",
                                           conversationId);

service/src/test/java/uk/nhs/adaptors/gp2gp/ehr/mapper/AgentPersonMapperTest.java

@@ -2,8 +2,6 @@
 
 import static org.mockito.Mockito.when;
 import static org.assertj.core.api.Assertions.assertThat;
-
-import java.io.IOException;
 import java.util.stream.Stream;
 
 import org.hl7.fhir.dstu3.model.Bundle;
@@ -57,8 +55,7 @@ public void setUp() {
 
     @ParameterizedTest
     @MethodSource("readPractitionerRoleTests")
-    public void When_MappingPractitionerToAgent_Expect_RepresentedAgentXml(String practitionerRoleJson, String outputXml)
-        throws IOException {
+    public void When_MappingPractitionerToAgent_Expect_RepresentedAgentXml(String practitionerRoleJson, String outputXml) {
 
         var jsonInputPractitionerRole = ResourceTestFileUtils.getFileContent(practitionerRoleJson);
         var expectedOutput = ResourceTestFileUtils.getFileContent(outputXml);

service/src/test/java/uk/nhs/adaptors/gp2gp/ehr/scheduling/EhrExtractTimeoutSchedulerTest.java

@@ -297,9 +297,9 @@ void updateEhrExtractStatusListWithEhrReceivedAcknowledgementError() {
 
             () -> assertEquals(
                 "Couldn't update EHR received acknowledgement with error information because EHR status doesn't exist, "
-                        + "conversation_id: " + inProgressConversationId, exception.getMessage()),
+                        + "conversationId: " + inProgressConversationId, exception.getMessage()),
             () -> verify(logger)
-                .error(eq("An error occurred when updating EHR Extract with Ack erorrs, EHR Extract Status conversation_id: {}"),
+                .error(eq("An error occurred when updating EHR Extract with Ack erorrs, EHR Extract Status conversationId: {}"),
                        eq(inProgressConversationId),
                        any(EhrExtractException.class))
         );
@@ -342,8 +342,8 @@ void whenEhrExtractStatusIsNullInterceptExceptionAndLogErrorMsg() {
         var exception = assertThrows(EhrExtractException.class, ehrExtractTimeoutSchedulerSpy::processEhrExtractAckTimeouts);
 
         assertEquals("Couldn't update EHR received acknowledgement with error information because EHR status doesn't exist, "
-                     + "conversation_id: " + inProgressConversationId, exception.getMessage());
-        verify(logger).error(eq("An error occurred when updating EHR Extract with Ack erorrs, EHR Extract Status conversation_id: {}"),
+                     + "conversationId: " + inProgressConversationId, exception.getMessage());
+        verify(logger).error(eq("An error occurred when updating EHR Extract with Ack erorrs, EHR Extract Status conversationId: {}"),
                              eq(inProgressConversationId),
                              any(EhrExtractException.class));
     }