Normalize message skeleton (#1331)

* normalize message skeleton

* pitest coverage

* pitest coverage

* pitest coverage

* test removal

Author: ORybak5

gp2gp-translator/src/main/java/uk/nhs/adaptors/pss/translator/service/SkeletonProcessingService.java

@@ -21,7 +21,6 @@
 @RequiredArgsConstructor(onConstructor = @__(@Autowired))
 public class SkeletonProcessingService {
 
-    private static final int XML_CONCAT_CONSTANT_LENGTH = 100;
 
     private final AttachmentHandlerService attachmentHandlerService;
     private final XmlParseUtilService xmlParseUtilService;
@@ -38,11 +37,11 @@ public InboundMessage updateInboundMessageWithSkeleton(PatientAttachmentLog skel
         var skeletonFileAsString = new String(skeletonAttachment, StandardCharsets.UTF_8);
 
         try {
+            var normalizedSkeleton = normalizeSkeletonXml(skeletonFileAsString);
             // if the skeleton starts with the RCMR tag, then we are replacing the whole message.
             // this behaviour is not a part of the specification but we have found this format in some messages
-            var replaceEntirePayload = skeletonFileAsString
-                .substring(0, XML_CONCAT_CONSTANT_LENGTH).contains("<RCMR_IN030000UK06");
-            var skeletonExtractDocument = xPathService.parseDocumentFromXml(skeletonFileAsString);
+            var replaceEntirePayload = isEntireRcmrSkeleton(normalizedSkeleton);
+            var skeletonExtractDocument = xPathService.parseDocumentFromXml(normalizedSkeleton);
 
             if (replaceEntirePayload) {
                 // replace the entire inbound message payload
@@ -61,6 +60,21 @@ public InboundMessage updateInboundMessageWithSkeleton(PatientAttachmentLog skel
         }
     }
 
+    private String normalizeSkeletonXml(String skeletonFileAsString) {
+        if (skeletonFileAsString == null || skeletonFileAsString.isBlank()) {
+            return skeletonFileAsString;
+        }
+
+        return skeletonFileAsString
+            .replace("\uFEFF", "")
+            .replaceFirst("^(?s)\\s*<\\?xml[^>]*>\\s*", "")
+            .stripLeading();
+    }
+
+    private boolean isEntireRcmrSkeleton(String normalizedSkeleton) {
+        return normalizedSkeleton != null && normalizedSkeleton.startsWith("<RCMR_IN030000UK06");
+    }
+
     private InboundMessage insertSkeletonIntoInboundMessagePayload(PatientAttachmentLog skeletonLog,
         InboundMessage inboundMessage, Document skeletonExtractDocument)
         throws SAXException, TransformerException {

gp2gp-translator/src/test/java/uk/nhs/adaptors/pss/translator/service/SkeletonProcessingServiceTests.java

@@ -3,7 +3,10 @@
 import static java.util.UUID.randomUUID;
 
 import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertFalse;
+import static org.junit.jupiter.api.Assertions.assertNull;
 import static org.junit.jupiter.api.Assertions.assertThrows;
+import static org.junit.jupiter.api.Assertions.assertTrue;
 import static org.mockito.ArgumentMatchers.any;
 
 import static org.mockito.ArgumentMatchers.eq;
@@ -143,6 +146,83 @@ void When_HappyPathWithSkeletonAsRCMRMessage_Expect_ThrowNoErrors() throws Trans
         skeletonProcessingService.updateInboundMessageWithSkeleton(attachmentLog, inboundMessage, CONVERSATION_ID);
     }
 
+    @Test
+    void When_SkeletonAsWholeRCMRMessageHasLeadingWhitespace_Expect_InboundMessagePayloadIsNewRCMRMessage()
+        throws TransformerException, SAXException {
+        var inboundMessage = new InboundMessage();
+        var attachmentLog = createSkeletonPatientAttachmentLog();
+        var skeletonMessage = "\n  " + readInboundMessagePayloadFromFile();
+
+        inboundMessage.setPayload(readInboundMessagePayloadFromFile());
+        inboundMessage.setEbXML(readInboundMessageEbXmlFromFile());
+
+        when(attachmentHandlerService.getAttachment(any(), any())).thenReturn(skeletonMessage.getBytes(StandardCharsets.UTF_8));
+        when(xmlParseUtilService.getStringFromDocument(any())).thenReturn(readInboundMessagePayloadFromFile());
+
+        var newInboundMessage =
+            skeletonProcessingService.updateInboundMessageWithSkeleton(attachmentLog, inboundMessage, CONVERSATION_ID);
+
+        assertTrue(newInboundMessage.getPayload().contains("<RCMR_IN030000UK06"));
+    }
+
+    @Test
+    void When_NormalizeSkeletonXmlCalledWithNull_Expect_ReturnsNull() throws Exception {
+        var method = SkeletonProcessingService.class.getDeclaredMethod("normalizeSkeletonXml", String.class);
+        method.setAccessible(true);
+
+        assertNull(method.invoke(skeletonProcessingService, new Object[] {null}));
+    }
+
+    @Test
+    void When_NormalizeSkeletonXmlCalledWithBlankString_Expect_ReturnsOriginalBlankString() throws Exception {
+        var method = SkeletonProcessingService.class.getDeclaredMethod("normalizeSkeletonXml", String.class);
+        method.setAccessible(true);
+
+        var blankInput = " \n\t ";
+        assertEquals(blankInput, method.invoke(skeletonProcessingService, blankInput));
+    }
+
+    @Test
+    void When_IsEntireRcmrSkeletonCalledWithNonRcmrPayload_Expect_ReturnsFalse() throws Exception {
+        var method = SkeletonProcessingService.class.getDeclaredMethod("isEntireRcmrSkeleton", String.class);
+        method.setAccessible(true);
+
+        assertFalse((Boolean) method.invoke(skeletonProcessingService, "<MCCI_IN010000UK13>"));
+    }
+
+    @Test
+    void When_NormalizeSkeletonXmlCalledWithXmlDeclaration_Expect_StripsDeclarationBeforeRcmrCheck() throws Exception {
+        var normalizeMethod = SkeletonProcessingService.class.getDeclaredMethod("normalizeSkeletonXml", String.class);
+        normalizeMethod.setAccessible(true);
+        var isRcmrMethod = SkeletonProcessingService.class.getDeclaredMethod("isEntireRcmrSkeleton", String.class);
+        isRcmrMethod.setAccessible(true);
+
+        var xmlWithDeclaration = "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<RCMR_IN030000UK06>";
+        var normalized = (String) normalizeMethod.invoke(skeletonProcessingService, xmlWithDeclaration);
+
+        assertTrue(normalized.startsWith("<RCMR_IN030000UK06"));
+        assertTrue((Boolean) isRcmrMethod.invoke(skeletonProcessingService, normalized));
+    }
+
+    @Test
+    void When_SkeletonAsWholeRCMRMessageHasBomPrefix_Expect_InboundMessagePayloadIsNewRCMRMessage()
+        throws TransformerException, SAXException {
+        var inboundMessage = new InboundMessage();
+        var attachmentLog = createSkeletonPatientAttachmentLog();
+        var skeletonMessage = "\uFEFF" + readInboundMessagePayloadFromFile();
+
+        inboundMessage.setPayload(readInboundMessagePayloadFromFile());
+        inboundMessage.setEbXML(readInboundMessageEbXmlFromFile());
+
+        when(attachmentHandlerService.getAttachment(any(), any())).thenReturn(skeletonMessage.getBytes(StandardCharsets.UTF_8));
+        when(xmlParseUtilService.getStringFromDocument(any())).thenReturn(readInboundMessagePayloadFromFile());
+
+        var newInboundMessage =
+            skeletonProcessingService.updateInboundMessageWithSkeleton(attachmentLog, inboundMessage, CONVERSATION_ID);
+
+        assertTrue(newInboundMessage.getPayload().contains("<RCMR_IN030000UK06"));
+    }
+
     @Test
     void When_HappyPathWithSkeletonAsRCMRMessage_Expect_InboundMessagePayloadIsNewRCMRMessage()
         throws TransformerException, SAXException {