chore(service-bus): deprecate service-bus encoding message-context ex…

…tension (#490)
arcus-azure · Feb 18, 2025 · 425788d · 425788d
1 parent 8601c03
commit 425788d
Show file tree

Hide file tree

Showing 2 changed files with 29 additions and 2 deletions.
diff --git a/src/Arcus.Messaging.Abstractions.ServiceBus/MessageHandling/AzureServiceBusMessageRouter.cs b/src/Arcus.Messaging.Abstractions.ServiceBus/MessageHandling/AzureServiceBusMessageRouter.cs
@@ -272,8 +272,7 @@ private async Task<MessageProcessingResult> TryRouteMessageWithPotentialFallback
                     return MessageProcessingResult.Failure(message.MessageId, CannotFindMatchedHandler, "Failed to process message in the message pump as no message handler is registered in the dependency container");
                 }
 
-                Encoding encoding = messageContext.GetMessageEncodingProperty(Logger);
-                string messageBody = encoding.GetString(message.Body.ToArray());
+                string messageBody = LoadMessageBody(message, messageContext);
                 bool hasGoneThroughMessageHandler = false;
 
                 foreach (MessageHandler messageHandler in messageHandlers)
@@ -335,6 +334,32 @@ private async Task<MessageProcessingResult> TryRouteMessageWithPotentialFallback
             }
         }
 
+        private static string LoadMessageBody(ServiceBusReceivedMessage message, AzureServiceBusMessageContext context)
+        {
+            Encoding encoding = DetermineEncoding();
+            string messageBody = encoding.GetString(message.Body.ToArray());
+
+            return messageBody;
+
+            Encoding DetermineEncoding()
+            {
+                Encoding fallbackEncoding = Encoding.UTF8;
+
+                if (context.Properties.TryGetValue(PropertyNames.Encoding, out object encodingNameObj)
+                    && encodingNameObj is string encodingName
+                    && !string.IsNullOrWhiteSpace(encodingName))
+                {
+                    EncodingInfo foundEncoding =
+                        Encoding.GetEncodings()
+                                .FirstOrDefault(e => e.Name.Equals(encodingName, StringComparison.OrdinalIgnoreCase));
+
+                    return foundEncoding?.GetEncoding() ?? fallbackEncoding;
+                }
+
+                return fallbackEncoding;
+            }
+        }
+
         private async Task DeadLetterMessageNoHandlerRegisteredAsync(ServiceBusReceiver messageReceiver, ServiceBusReceivedMessage message, AzureServiceBusMessageContext messageContext)
         {
             if (messageReceiver != null)

diff --git a/src/Arcus.Messaging.ServiceBus.Core/Extensions/MessageContextExtensions.cs b/src/Arcus.Messaging.ServiceBus.Core/Extensions/MessageContextExtensions.cs
@@ -17,6 +17,7 @@ public static class MessageContextExtensions
         /// Gets the encoding property value in the messaging context, using UTF-8 as default if no such encoding value can be retrieved.
         /// </summary>
         /// <param name="messageContext">The context of the message.</param>
+        [Obsolete("Will be removed in v3.0, please use the " + nameof(PropertyNames.Encoding) + " to extract the encoding yourself from the message context")]
         public static Encoding GetMessageEncodingProperty(this MessageContext messageContext)
         {
             Encoding encoding = GetMessageEncodingProperty(messageContext, NullLogger.Instance);
@@ -28,6 +29,7 @@ public static Encoding GetMessageEncodingProperty(this MessageContext messageCon
         /// </summary>
         /// <param name="messageContext">The context of the message.</param>
         /// <param name="logger"></param>
+        [Obsolete("Will be removed in v3.0, please use the " + nameof(PropertyNames.Encoding) + " to extract the encoding yourself from the message context")]
         public static Encoding GetMessageEncodingProperty(this MessageContext messageContext, ILogger logger)
         {
             if (messageContext is null)