CDMS-854: adds message type to logs (#138)

TrinhChuongEE · web-flow · commit e172c21e4ebf · 2025-07-02T14:28:19.000+01:00
* CDMS-854: adds message type to logs

* CDMS-854: sonar

* CDMS-854: sonar

* CDMS-854: sonar

* CDMS-854: sonar

* CDMS-854: added tests for checking message type return value

* CDMS-854: added tests for checking message type return value

* CDMS-854: sonar
diff --git a/BtmsGateway.Test/Domain/MessagingConstantsTests.cs b/BtmsGateway.Test/Domain/MessagingConstantsTests.cs
@@ -0,0 +1,17 @@
+using BtmsGateway.Domain;
+using FluentAssertions;
+
+namespace BtmsGateway.Test.Domain;
+
+public class MessagingConstantsTests
+{
+    [Theory]
+    [InlineData(null)]
+    [InlineData("")]
+    [InlineData(" ")]
+    [InlineData("FOO")]
+    public void When_soap_message_type_is_null_Then_message_type_is_unknown(string soapMessageType)
+    {
+        MessagingConstants.MessageTypes.FromSoapMessageType(soapMessageType).Should().Be("UnknownMessageType");
+    }
+}
diff --git a/BtmsGateway/Domain/MessagingConstants.cs b/BtmsGateway/Domain/MessagingConstants.cs
@@ -14,13 +14,46 @@ public static class MessageTypes
         public const string ClearanceRequest = "ClearanceRequest";
         public const string Finalisation = "Finalisation";
         public const string InboundError = "InboundError";
+        public const string DecisionNotification = "DecisionNotification";
+        public const string HMRCErrorNotification = "HMRCErrorNotification";
+        public const string ALVSIPAFFSClearanceRequest = "ALVSIPAFFSClearanceRequest";
+        public const string ALVSIPAFFSFinalisationNotificationRequest = "ALVSIPAFFSFinalisationNotificationRequest";
+        public const string ALVSIPAFFSSearchCertificateRequest = "ALVSIPAFFSSearchCertificateRequest";
+        public const string ALVSIPAFFSPollCertificateRequest = "ALVSIPAFFSPollCertificateRequest";
+        public const string ALVSIPAFFSDecisionNotification = "ALVSIPAFFSDecisionNotification";
+
+        public static string FromSoapMessageType(string? soapMessageType)
+        {
+            return soapMessageType switch
+            {
+                SoapMessageTypes.ALVSClearanceRequest => ClearanceRequest,
+                SoapMessageTypes.FinalisationNotificationRequest => Finalisation,
+                SoapMessageTypes.ALVSErrorNotificationRequest => InboundError,
+                SoapMessageTypes.DecisionNotification => DecisionNotification,
+                SoapMessageTypes.HMRCErrorNotification => HMRCErrorNotification,
+                SoapMessageTypes.ALVSIPAFFSClearanceRequest => ALVSIPAFFSClearanceRequest,
+                SoapMessageTypes.ALVSIPAFFSFinalisationNotificationRequest => ALVSIPAFFSFinalisationNotificationRequest,
+                SoapMessageTypes.ALVSIPAFFSSearchCertificateRequest => ALVSIPAFFSSearchCertificateRequest,
+                SoapMessageTypes.ALVSIPAFFSPollCertificateRequest => ALVSIPAFFSPollCertificateRequest,
+                SoapMessageTypes.ALVSIPAFFSDecisionNotification => ALVSIPAFFSDecisionNotification,
+                _ => "UnknownMessageType",
+            };
+        }
     }
 
     public static class SoapMessageTypes
     {
         public const string ALVSClearanceRequest = "ALVSClearanceRequest";
         public const string FinalisationNotificationRequest = "FinalisationNotificationRequest";
         public const string ALVSErrorNotificationRequest = "ALVSErrorNotificationRequest";
+        public const string DecisionNotification = "DecisionNotification/DecisionNotification";
+        public const string HMRCErrorNotification = "HMRCErrorNotification/HMRCErrorNotification";
+        public const string ALVSIPAFFSClearanceRequest = "ALVSClearanceRequestPost/ALVSClearanceRequest";
+        public const string ALVSIPAFFSFinalisationNotificationRequest =
+            "FinalisationNotificationRequestPost/FinalisationNotificationRequest";
+        public const string ALVSIPAFFSSearchCertificateRequest = "CertificateRequest/Request";
+        public const string ALVSIPAFFSPollCertificateRequest = "CertificatePoll/RequestIdentifier";
+        public const string ALVSIPAFFSDecisionNotification = "DecisionNotificationRequestPost/DecisionNotification";
     }
 
     public enum MessageSource
diff --git a/BtmsGateway/Middleware/RoutingInterceptor.cs b/BtmsGateway/Middleware/RoutingInterceptor.cs
@@ -1,4 +1,5 @@
 using BtmsGateway.Config;
+using BtmsGateway.Domain;
 using BtmsGateway.Exceptions;
 using BtmsGateway.Services.Metrics;
 using BtmsGateway.Services.Routing;
@@ -106,12 +107,13 @@ private void LogRouteFoundResults(MessageData messageData, RoutingResult routing
         if (routingResult.RoutingSuccessful)
         {
             logger.Information(
-                "{ContentCorrelationId} {MessageReference} {Action} {Success} for route {RouteUrl} with response {StatusCode} \"{Content}\"",
+                "{ContentCorrelationId} {MessageReference} {Action} {Success} for route {RouteUrl}, message type {MessageType} with response {StatusCode} \"{Content}\"",
                 messageData.ContentMap.CorrelationId,
                 messageData.ContentMap.MessageReference,
                 action,
                 "successful",
                 action == RouteAction ? routingResult.FullRouteLink : routingResult.FullForkLink,
+                MessagingConstants.MessageTypes.FromSoapMessageType(routingResult.MessageSubXPath),
                 routingResult.StatusCode,
                 routingResult.ResponseContent
             );
@@ -127,12 +129,13 @@ private void LogRouteFoundResults(MessageData messageData, RoutingResult routing
         }
 
         logger.Error(
-            "{ContentCorrelationId} {MessageReference} {Action} {Success} for route {RouteUrl} with response {StatusCode} \"{Content}\"",
+            "{ContentCorrelationId} {MessageReference} {Action} {Success} for route {RouteUrl}, message type {MessageType} with response {StatusCode} \"{Content}\"",
             messageData.ContentMap.CorrelationId,
             messageData.ContentMap.MessageReference,
             action,
             "failed",
             action == RouteAction ? routingResult.FullRouteLink : routingResult.FullForkLink,
+            MessagingConstants.MessageTypes.FromSoapMessageType(routingResult.MessageSubXPath),
             routingResult.StatusCode,
             routingResult.ResponseContent
         );
diff --git a/BtmsGateway/Services/Routing/MessageRouter.cs b/BtmsGateway/Services/Routing/MessageRouter.cs
@@ -58,7 +58,7 @@ public async Task<RoutingResult> Route(MessageData messageData, IMetrics metrics
         }
         catch (Exception ex)
         {
-            LogError(ex, messageData, "routing");
+            LogRoutingError(ex, messageData, routingResult);
             return routingResult with
             {
                 StatusCode = HttpStatusCode.ServiceUnavailable,
@@ -108,7 +108,7 @@ public async Task<RoutingResult> Fork(MessageData messageData, IMetrics metrics)
         }
         catch (Exception ex)
         {
-            LogError(ex, messageData, "forking");
+            LogForkingError(ex, messageData, routingResult);
             return routingResult with
             {
                 StatusCode = HttpStatusCode.ServiceUnavailable,
@@ -121,14 +121,25 @@ public async Task<RoutingResult> Fork(MessageData messageData, IMetrics metrics)
         }
     }
 
-    private void LogError(Exception? ex, MessageData messageData, string action)
+    private void LogRoutingError(Exception? ex, MessageData messageData, RoutingResult routingResult)
+    {
+        LogError(ex, messageData, "routing", routingResult);
+    }
+
+    private void LogForkingError(Exception? ex, MessageData messageData, RoutingResult routingResult)
+    {
+        LogError(ex, messageData, "forking", routingResult);
+    }
+
+    private void LogError(Exception? ex, MessageData messageData, string action, RoutingResult routingResult)
     {
         logger.Error(
             ex,
-            "{ContentCorrelationId} {MessageReference} Error {action}",
+            "{ContentCorrelationId} {MessageReference} Error {Action} message type {MessageType}",
             messageData.ContentMap.CorrelationId,
             messageData.ContentMap.MessageReference,
-            action
+            action,
+            MessagingConstants.MessageTypes.FromSoapMessageType(routingResult.MessageSubXPath)
         );
     }
 

Original file line number	Diff line number	Diff line change
`@@ -58,7 +58,7 @@ public async Task<RoutingResult> Route(MessageData messageData, IMetrics metrics`
`58`	`58`	`}`
`59`	`59`	`catch (Exception ex)`
`60`	`60`	`{`
`61`		`- LogError(ex, messageData, "routing");`
	`61`	`+ LogRoutingError(ex, messageData, routingResult);`
`62`	`62`	`return routingResult with`
`63`	`63`	`{`
`64`	`64`	`StatusCode = HttpStatusCode.ServiceUnavailable,`
`@@ -108,7 +108,7 @@ public async Task<RoutingResult> Fork(MessageData messageData, IMetrics metrics)`
`108`	`108`	`}`
`109`	`109`	`catch (Exception ex)`
`110`	`110`	`{`
`111`		`- LogError(ex, messageData, "forking");`
	`111`	`+ LogForkingError(ex, messageData, routingResult);`
`112`	`112`	`return routingResult with`
`113`	`113`	`{`
`114`	`114`	`StatusCode = HttpStatusCode.ServiceUnavailable,`
`@@ -121,14 +121,25 @@ public async Task<RoutingResult> Fork(MessageData messageData, IMetrics metrics)`
`121`	`121`	`}`
`122`	`122`	`}`
`123`	`123`
`124`		`- private void LogError(Exception? ex, MessageData messageData, string action)`
	`124`	`+ private void LogRoutingError(Exception? ex, MessageData messageData, RoutingResult routingResult)`
	`125`	`+ {`
	`126`	`+ LogError(ex, messageData, "routing", routingResult);`
	`127`	`+ }`
	`128`	`+`
	`129`	`+ private void LogForkingError(Exception? ex, MessageData messageData, RoutingResult routingResult)`
	`130`	`+ {`
	`131`	`+ LogError(ex, messageData, "forking", routingResult);`
	`132`	`+ }`
	`133`	`+`
	`134`	`+ private void LogError(Exception? ex, MessageData messageData, string action, RoutingResult routingResult)`
`125`	`135`	`{`
`126`	`136`	`logger.Error(`
`127`	`137`	`ex,`
`128`		`- "{ContentCorrelationId} {MessageReference} Error {action}",`
	`138`	`+ "{ContentCorrelationId} {MessageReference} Error {Action} message type {MessageType}",`
`129`	`139`	`messageData.ContentMap.CorrelationId,`
`130`	`140`	`messageData.ContentMap.MessageReference,`
`131`		`- action`
	`141`	`+ action,`
	`142`	`+ MessagingConstants.MessageTypes.FromSoapMessageType(routingResult.MessageSubXPath)`
`132`	`143`	`);`
`133`	`144`	`}`
`134`	`145`