From 23c58b62b94174d65ca6158fe6b8e89ed86714d4 Mon Sep 17 00:00:00 2001 From: pcarmo <32819509+pcarmo@users.noreply.github.com> Date: Mon, 25 Dec 2023 06:19:38 +0000 Subject: [PATCH] chore: removing deprecated code (#308) * chore: removed the deprecated CanProcessMessage method from the MessageHandler in the Arcus.Messaging.Abstractions project - issue #297 * chore: removed the AsServiceBusMessage to create a ServiceBusMessage instance in the Arcus.Messaging.ServiceBus.Core project - issue #296 * chore: removed ObjectExtensions.cs since the extension class got empty after removing AsServiceBusMessage deprecated method - related to issue #296 * chore: removed deprecated MessageCorrelationInfoEnricher in pump namespace - issue #300 * Removed unexistant namespace Arcus.Messaging.Pumps.Abstractions.Telemetry due to deprecated MessageCorrelationInfoEnricher deletion - issue #300 * Fixed unit test related with the deletion of the deprecated CanProcessMessage method - issue #297 * Fixed unit tests related with the removal of the object extension AsServiceBusMessage - issue #296 --------- Co-authored-by: Stijn Moreels <9039753+stijnmoreels@users.noreply.github.com> --- .../MessageHandling/MessageHandler.cs | 16 ----- .../ObsoleteMessageCorrelationInfoEnricher.cs | 48 --------------- .../Extensions/ObjectExtensions.cs | 59 ------------------- .../ServiceBusMessagePumpDockerTests.cs | 1 + .../MessageHandling/MessageHandlerTests.cs | 4 +- .../ServiceBus/ObjectExtensionsTests.cs | 13 ++-- 6 files changed, 12 insertions(+), 129 deletions(-) delete mode 100644 src/Arcus.Messaging.Abstractions/Telemetry/ObsoleteMessageCorrelationInfoEnricher.cs delete mode 100644 src/Arcus.Messaging.ServiceBus.Core/Extensions/ObjectExtensions.cs diff --git a/src/Arcus.Messaging.Abstractions/MessageHandling/MessageHandler.cs b/src/Arcus.Messaging.Abstractions/MessageHandling/MessageHandler.cs index 84e72981..8153c770 100644 --- a/src/Arcus.Messaging.Abstractions/MessageHandling/MessageHandler.cs +++ b/src/Arcus.Messaging.Abstractions/MessageHandling/MessageHandler.cs @@ -214,22 +214,6 @@ public Type GetMessageHandlerType() return _messageHandlerInstanceType; } - /// - /// Determines if the given matches the generic parameter of this message handler. - /// - /// The messaging context information that holds information about the currently processing message. - /// - /// [true] if the registered predicate holds; [false] otherwise. - /// - /// The type of the message context. - [Obsolete("Use the " + nameof(CanProcessMessageBasedOnContext) + " specific message context overload instead")] - public bool CanProcessMessage(TMessageContext messageContext) - where TMessageContext : MessageContext - { - bool canProcessMessageBasedOnContext = CanProcessMessageBasedOnContext(messageContext); - return canProcessMessageBasedOnContext; - } - /// /// Determines if the given matches the generic parameter of this message handler. /// diff --git a/src/Arcus.Messaging.Abstractions/Telemetry/ObsoleteMessageCorrelationInfoEnricher.cs b/src/Arcus.Messaging.Abstractions/Telemetry/ObsoleteMessageCorrelationInfoEnricher.cs deleted file mode 100644 index 494b661c..00000000 --- a/src/Arcus.Messaging.Abstractions/Telemetry/ObsoleteMessageCorrelationInfoEnricher.cs +++ /dev/null @@ -1,48 +0,0 @@ -using System; -using Arcus.Messaging.Abstractions; -using Arcus.Observability.Correlation; -using Arcus.Observability.Telemetry.Serilog.Enrichers; -using Serilog.Core; -using Serilog.Events; - -// ReSharper disable once CheckNamespace - made deprecated. -namespace Arcus.Messaging.Pumps.Abstractions.Telemetry -{ - /// - /// Logger enrichment of the model. - /// - [Obsolete("Use the message correlation enricher in a different namespace instead: " + nameof(Messaging.Abstractions.Telemetry.MessageCorrelationInfoEnricher) + " without 'Pumps'")] - public class MessageCorrelationInfoEnricher : CorrelationInfoEnricher - { - private const string CycleId = "CycleId"; - - /// - /// Initializes a new instance of the class. - /// - /// The accessor implementation for the custom model. - public MessageCorrelationInfoEnricher(ICorrelationInfoAccessor correlationInfoAccessor) - : base(correlationInfoAccessor) - { - } - - /// - /// Enrich the with the given model. - /// - /// The log event to enrich with correlation information. - /// The log property factory to create log properties with correlation information. - /// The correlation model that contains the current correlation information. - protected override void EnrichCorrelationInfo( - LogEvent logEvent, - ILogEventPropertyFactory propertyFactory, - MessageCorrelationInfo correlationInfo) - { - base.EnrichCorrelationInfo(logEvent, propertyFactory, correlationInfo); - - if (!String.IsNullOrEmpty(correlationInfo.CycleId)) - { - LogEventProperty property = propertyFactory.CreateProperty(CycleId, correlationInfo.CycleId); - logEvent.AddPropertyIfAbsent(property); - } - } - } -} diff --git a/src/Arcus.Messaging.ServiceBus.Core/Extensions/ObjectExtensions.cs b/src/Arcus.Messaging.ServiceBus.Core/Extensions/ObjectExtensions.cs deleted file mode 100644 index 7bd34ffa..00000000 --- a/src/Arcus.Messaging.ServiceBus.Core/Extensions/ObjectExtensions.cs +++ /dev/null @@ -1,59 +0,0 @@ -using System; -using System.Text; -using Arcus.Messaging.Abstractions; -using Azure.Messaging.ServiceBus; -using GuardNet; -using Newtonsoft.Json; - -// ReSharper disable once CheckNamespace -namespace Microsoft.Azure.ServiceBus -{ - /// - /// Extensions on message bodies to more easily create s from them. - /// - public static class ObjectExtensions - { - private const string JsonContentType = "application/json"; - - /// - /// Creates an Azure Service Bus Message for a message body - /// - /// Body of the Service Bus message to process - /// Unique identifier that spans one operation end-to-end - /// Unique identifier that spans one or more operations and are considered a transaction/session - /// Encoding to use during serialization. Defaults to UTF8 - /// Thrown when the is null. - /// an . - [Obsolete("Use the " + nameof(ServiceBusMessageBuilder) + " instead to create " + nameof(ServiceBusMessage) + " instances")] - public static ServiceBusMessage AsServiceBusMessage(this object messageBody, string operationId = null, string transactionId = null, Encoding encoding = null) - { - Guard.NotNull(messageBody, nameof(messageBody), "Requires a message body to create an Azure Service Bus message this message body"); - - encoding = encoding ?? Encoding.UTF8; - - string serializedMessageBody = JsonConvert.SerializeObject(messageBody); - byte[] rawMessage = encoding.GetBytes(serializedMessageBody); - - var serviceBusMessage = new ServiceBusMessage(rawMessage) - { - ApplicationProperties = - { - { PropertyNames.ContentType, JsonContentType }, - { PropertyNames.Encoding, encoding.WebName } - } - }; - - if (operationId != null) - { - serviceBusMessage.CorrelationId = operationId; - } - - if (string.IsNullOrWhiteSpace(transactionId) == false) - { - serviceBusMessage.ApplicationProperties.Add(PropertyNames.TransactionId, transactionId); - } - - return serviceBusMessage; - } - } -} \ No newline at end of file diff --git a/src/Arcus.Messaging.Tests.Integration/MessagePump/ServiceBusMessagePumpDockerTests.cs b/src/Arcus.Messaging.Tests.Integration/MessagePump/ServiceBusMessagePumpDockerTests.cs index c0ae957d..1b464eda 100644 --- a/src/Arcus.Messaging.Tests.Integration/MessagePump/ServiceBusMessagePumpDockerTests.cs +++ b/src/Arcus.Messaging.Tests.Integration/MessagePump/ServiceBusMessagePumpDockerTests.cs @@ -35,6 +35,7 @@ public async Task ServiceBusTopicMessagePump_PublishServiceBusMessage_MessageSuc // Arrange var traceParent = TraceParent.Generate(); Order order = OrderGenerator.Generate(); + var orderMessage = new ServiceBusMessage(BinaryData.FromObjectAsJson(order)) .WithDiagnosticId(traceParent); diff --git a/src/Arcus.Messaging.Tests.Unit/MessageHandling/MessageHandlerTests.cs b/src/Arcus.Messaging.Tests.Unit/MessageHandling/MessageHandlerTests.cs index 431030cd..74b0a084 100644 --- a/src/Arcus.Messaging.Tests.Unit/MessageHandling/MessageHandlerTests.cs +++ b/src/Arcus.Messaging.Tests.Unit/MessageHandling/MessageHandlerTests.cs @@ -216,7 +216,7 @@ public void CustomMessageHandlerConstructor_WithContextFilterObsolete_SubtractsR Assert.NotNull(messageHandler); var context = TestMessageContext.Generate(); - Assert.Equal(matchesContext, messageHandler.CanProcessMessage(messageContext: context)); + Assert.Equal(matchesContext, messageHandler.CanProcessMessageBasedOnContext(messageContext: context)); } [Theory] @@ -264,7 +264,7 @@ public void CustomMessageHandlerFactory_WithDefaultContextFilterObsolete_Subtrac Assert.NotNull(messageHandler); var context = new MessageContext("message-id", new Dictionary()); - Assert.Equal(matchesContext, messageHandler.CanProcessMessage(messageContext: context)); + Assert.Equal(matchesContext, messageHandler.CanProcessMessageBasedOnContext(messageContext: context)); } [Fact] diff --git a/src/Arcus.Messaging.Tests.Unit/ServiceBus/ObjectExtensionsTests.cs b/src/Arcus.Messaging.Tests.Unit/ServiceBus/ObjectExtensionsTests.cs index 3ad3204f..bd3683b9 100644 --- a/src/Arcus.Messaging.Tests.Unit/ServiceBus/ObjectExtensionsTests.cs +++ b/src/Arcus.Messaging.Tests.Unit/ServiceBus/ObjectExtensionsTests.cs @@ -25,7 +25,7 @@ public void WrapInServiceBusMessage_BasicWithoutOptions_ReturnsValidServiceBusMe Order messagePayload = OrderGenerator.Generate(); // Act - ServiceBusMessage serviceBusMessage = messagePayload.AsServiceBusMessage(); + ServiceBusMessage serviceBusMessage = ServiceBusMessageBuilder.CreateForBody(messagePayload).Build(); // Assert Assert.NotNull(serviceBusMessage); @@ -47,7 +47,9 @@ public void WrapInServiceBusMessage_BasicWithOperationId_ReturnsValidServiceBusM var operationId = Guid.NewGuid().ToString(); // Act - ServiceBusMessage serviceBusMessage = messagePayload.AsServiceBusMessage(operationId: operationId); + var serviceBusMessageBuilder = ServiceBusMessageBuilder.CreateForBody(messagePayload); + serviceBusMessageBuilder.WithOperationId(operationId); + ServiceBusMessage serviceBusMessage = serviceBusMessageBuilder.Build(); // Assert Assert.NotNull(serviceBusMessage); @@ -69,7 +71,9 @@ public void WrapInServiceBusMessage_BasicWithTransactionId_ReturnsValidServiceBu var expectedTransactionId = Guid.NewGuid().ToString(); // Act - ServiceBusMessage serviceBusMessage = messagePayload.AsServiceBusMessage(transactionId: expectedTransactionId); + var serviceBusMessageBuilder = ServiceBusMessageBuilder.CreateForBody(messagePayload); + serviceBusMessageBuilder.WithTransactionId(transactionId: expectedTransactionId); + ServiceBusMessage serviceBusMessage = serviceBusMessageBuilder.Build(); // Assert Assert.NotNull(serviceBusMessage); @@ -92,7 +96,8 @@ public void WrapInServiceBusMessage_BasicWithEncoding_ReturnsValidServiceBusMess Encoding expectedEncoding = Encoding.ASCII; // Act - ServiceBusMessage serviceBusMessage = originalMessagePayload.AsServiceBusMessage(encoding: expectedEncoding); + var serviceBusMessageBuilder = ServiceBusMessageBuilder.CreateForBody(originalMessagePayload, encoding: expectedEncoding); + ServiceBusMessage serviceBusMessage = serviceBusMessageBuilder.Build(); // Assert Assert.NotNull(serviceBusMessage);