Merge pull request #7 from mortenlaursen/main

Allow custom JSON serialization options by @mortenlaursen

Author: christianhelle

README.md

@@ -77,6 +77,29 @@ builder.Services.AddSwaggerGen();
 builder.Services.ConfigureMessagingServices(builder.Configuration, true);
 ```
 
+## Custom JsonSerializerOptions
+
+You can customize JSON serialization in your application by injecting `JsonSerializerOptions` into the `ConfigureMessagingServices` method.
+
+### How to Use
+Pass your `JsonSerializerOptions` when setting up messaging services. If not provided, default settings are used.
+
+```csharp
+var builder = WebApplication.CreateBuilder(args);
+
+var jsonOptions = new JsonSerializerOptions
+{
+    PropertyNamingPolicy = JsonNamingPolicy.CamelCase,
+    WriteIndented = true,
+};
+
+builder.Services.ConfigureMessagingServices(
+    builder.Configuration,
+    useAzureCredentials: true,
+    jsonSerializerOptions: jsonOptions
+);
+```
+
 ## Publishing to EventHub
 
 To publish events to an EventHub you need an instance of `IEventHubPublisher`, this can be constructed via the `IEventHubPublisherFactory` which exposes the `Create(string eventHubName)` method

src/Atc.Azure.Messaging/EventHub/EventHubCredentialsPublisherFactory.cs

@@ -1,3 +1,5 @@
+using Atc.Azure.Messaging.Serialization;
+
 namespace Atc.Azure.Messaging.EventHub;
 
 [SuppressMessage(
@@ -8,24 +10,28 @@ internal sealed class EventHubCredentialsPublisherFactory : IEventHubPublisherFa
 {
     private readonly string fullyQualifiedNamespace;
     private readonly DefaultAzureCredentialOptions credentialOptions;
+    private readonly IMessagePayloadSerializer messagePayloadSerializer;
 
     public EventHubCredentialsPublisherFactory(
         EventHubOptions options,
         EnvironmentOptions environmentOptions,
         ClientAuthorizationOptions clientCredentialOptions,
-        IAzureCredentialOptionsProvider credentialOptionsProvider)
+        IAzureCredentialOptionsProvider credentialOptionsProvider,
+        IMessagePayloadSerializer messagePayloadSerializer)
     {
-        this.fullyQualifiedNamespace = options.FullyQualifiedNamespace;
-        this.credentialOptions = credentialOptionsProvider
-            .GetAzureCredentialOptions(
-                environmentOptions,
-                clientCredentialOptions);
+        this.messagePayloadSerializer = messagePayloadSerializer;
+        this.fullyQualifiedNamespace = options.FullyQualifiedNamespace;
+        this.credentialOptions = credentialOptionsProvider
+            .GetAzureCredentialOptions(
+                environmentOptions,
+                clientCredentialOptions);
     }
-
-    public IEventHubPublisher Create(string eventHubName)
+
+    public IEventHubPublisher Create(string eventHubName)
         => new EventHubPublisher(
-                new EventHubProducerClient(
-                    fullyQualifiedNamespace,
-                    eventHubName,
-                    new DefaultAzureCredential(credentialOptions)));
+            new EventHubProducerClient(
+                fullyQualifiedNamespace,
+                eventHubName,
+                new DefaultAzureCredential(credentialOptions)),
+            messagePayloadSerializer);
 }

src/Atc.Azure.Messaging/EventHub/EventHubPublisher.cs

@@ -1,12 +1,18 @@
+using Atc.Azure.Messaging.Serialization;
+
 namespace Atc.Azure.Messaging.EventHub;
 
 internal sealed class EventHubPublisher : IEventHubPublisher
 {
     private readonly EventHubProducerClient client;
+    private readonly IMessagePayloadSerializer messagePayloadSerializer;
 
-    public EventHubPublisher(EventHubProducerClient client)
+    public EventHubPublisher(
+        EventHubProducerClient client,
+        IMessagePayloadSerializer messagePayloadSerializer)
     {
         this.client = client;
+        this.messagePayloadSerializer = messagePayloadSerializer;
     }
 
     public Task PublishAsync(
@@ -15,7 +21,18 @@ public Task PublishAsync(
         CancellationToken cancellationToken = default)
     {
         return PerformPublishAsync(
-            JsonSerializer.Serialize(message),
+            messagePayloadSerializer.Serialize(message),
+            messageProperties,
+            cancellationToken);
+    }
+
+    public Task PublishAsync(
+        string message,
+        IDictionary<string, string>? messageProperties = null,
+        CancellationToken cancellationToken = default)
+    {
+        return PerformPublishAsync(
+            message,
             messageProperties,
             cancellationToken);
     }
@@ -39,10 +56,7 @@ private Task PerformPublishAsync(
         }
 
         return client.SendAsync(
-            new[]
-            {
-                eventData,
-            },
+            new[] { eventData, },
             cancellationToken);
     }
 

src/Atc.Azure.Messaging/EventHub/EventHubPublisherFactory.cs

@@ -1,3 +1,5 @@
+using Atc.Azure.Messaging.Serialization;
+
 namespace Atc.Azure.Messaging.EventHub;
 
 [SuppressMessage(
@@ -7,15 +9,20 @@ namespace Atc.Azure.Messaging.EventHub;
 internal sealed class EventHubPublisherFactory : IEventHubPublisherFactory
 {
     private readonly string connectionString;
+    private readonly IMessagePayloadSerializer messagePayloadSerializer;
 
-    public EventHubPublisherFactory(EventHubOptions options)
+    public EventHubPublisherFactory(
+        EventHubOptions options,
+        IMessagePayloadSerializer messagePayloadSerializer)
     {
-        this.connectionString = options.ConnectionString;
+        this.messagePayloadSerializer = messagePayloadSerializer;
+        connectionString = options.ConnectionString;
     }
 
     public IEventHubPublisher Create(string eventHubName)
         => new EventHubPublisher(
             new EventHubProducerClient(
                 connectionString,
-                eventHubName));
+                eventHubName),
+            messagePayloadSerializer);
 }

src/Atc.Azure.Messaging/EventHub/IEventHubPublisher.cs

@@ -1,7 +1,7 @@
 namespace Atc.Azure.Messaging.EventHub;
 
-/// <summary>
-/// Publisher responsible for publishing objects with metadata to a specific EventHub.
+/// <summary>
+/// Publisher responsible for publishing objects with metadata to a specific EventHub.
 /// </summary>
 /// <remarks>
 /// Is safe to cache and use in singletons for the lifetime of the application.
@@ -12,4 +12,9 @@ Task PublishAsync(
         object message,
         IDictionary<string, string>? messageProperties = null,
         CancellationToken cancellationToken = default);
+
+    Task PublishAsync(
+        string message,
+        IDictionary<string, string>? messageProperties = null,
+        CancellationToken cancellationToken = default);
 }

src/Atc.Azure.Messaging/Serialization/IMessagePayloadSerializer.cs

@@ -0,0 +1,6 @@
+namespace Atc.Azure.Messaging.Serialization;
+
+public interface IMessagePayloadSerializer
+{
+    string Serialize<T>(T value);
+}

src/Atc.Azure.Messaging/Serialization/MessagePayloadSerializer.cs

@@ -0,0 +1,14 @@
+namespace Atc.Azure.Messaging.Serialization;
+
+public class MessagePayloadSerializer : IMessagePayloadSerializer
+{
+    private readonly JsonSerializerOptions options;
+
+    public MessagePayloadSerializer(JsonSerializerOptions options)
+    {
+        this.options = options;
+    }
+
+    public string Serialize<T>(T value)
+        => JsonSerializer.Serialize(value, options);
+}

src/Atc.Azure.Messaging/ServiceBus/IServiceBusPublisher.cs

@@ -1,10 +1,10 @@
-namespace Atc.Azure.Messaging.ServiceBus;
-
+namespace Atc.Azure.Messaging.ServiceBus;
+
 /// <summary>
 /// Publisher responsible for publishing objects with metadata to a specific ServiceBus.
-/// </summary>
-public interface IServiceBusPublisher
-{
+/// </summary>
+public interface IServiceBusPublisher
+{
     /// <summary>
     /// Publishes a message.
     /// </summary>
@@ -13,14 +13,32 @@ public interface IServiceBusPublisher
     /// <param name="sessionId">Optional id for appending the message to a known session. If not set, then defaults to a new session.</param>
     /// <param name="properties">Optional custom metadata about the message.</param>
     /// <param name="timeToLive">Optional <see cref="TimeSpan"/> for message to be consumed. If not set, then defaults to the value specified on queue or topic.</param>
-    /// <param name="cancellationToken">The <see cref="CancellationToken"/> used.</param>
-    /// <returns>A <see cref="Task"/> representing the asynchronous operation.</returns>
-    Task PublishAsync(
-        string topicOrQueue,
-        object message,
-        string? sessionId = null,
-        IDictionary<string, string>? properties = null,
-        TimeSpan? timeToLive = null,
+    /// <param name="cancellationToken">The <see cref="CancellationToken"/> used.</param>
+    /// <returns>A <see cref="Task"/> representing the asynchronous operation.</returns>
+    Task PublishAsync(
+        string topicOrQueue,
+        object message,
+        string? sessionId = null,
+        IDictionary<string, string>? properties = null,
+        TimeSpan? timeToLive = null,
+        CancellationToken cancellationToken = default);
+
+    /// <summary>
+    /// Publishes a message.
+    /// </summary>
+    /// <param name="topicOrQueue">The topic or queue name.</param>
+    /// <param name="message">The message to be published, in a serialized format.</param>
+    /// <param name="sessionId">Optional id for appending the message to a known session. If not set, then defaults to a new session.</param>
+    /// <param name="properties">Optional custom metadata about the message.</param>
+    /// <param name="timeToLive">Optional <see cref="TimeSpan"/> for message to be consumed. If not set, then defaults to the value specified on queue or topic.</param>
+    /// <param name="cancellationToken">The <see cref="CancellationToken"/> used.</param>
+    /// <returns>A <see cref="Task"/> representing the asynchronous operation.</returns>
+    Task PublishAsync(
+        string topicOrQueue,
+        string message,
+        string? sessionId = null,
+        IDictionary<string, string>? properties = null,
+        TimeSpan? timeToLive = null,
         CancellationToken cancellationToken = default);
 
     /// <summary>
@@ -31,14 +49,14 @@ Task PublishAsync(
     /// <param name="sessionId">Optional id for appending the message to a known session. If not set, then defaults to a new session.</param>
     /// <param name="properties">Optional custom metadata about the message.</param>
     /// <param name="timeToLive">Optional <see cref="TimeSpan"/> for message to be consumed. If not set, then defaults to the value specified on queue or topic.</param>
-    /// <param name="cancellationToken">The <see cref="CancellationToken"/> used.</param>
-    /// <returns>A <see cref="Task"/> representing the asynchronous operation.</returns>
-    Task PublishAsync(
-        string topicOrQueue,
-        IReadOnlyCollection<object> messages,
-        string? sessionId = null,
-        IDictionary<string, string>? properties = null,
-        TimeSpan? timeToLive = null,
+    /// <param name="cancellationToken">The <see cref="CancellationToken"/> used.</param>
+    /// <returns>A <see cref="Task"/> representing the asynchronous operation.</returns>
+    Task PublishAsync(
+        string topicOrQueue,
+        IReadOnlyCollection<object> messages,
+        string? sessionId = null,
+        IDictionary<string, string>? properties = null,
+        TimeSpan? timeToLive = null,
         CancellationToken cancellationToken = default);
 
     /// <summary>
@@ -50,26 +68,26 @@ Task PublishAsync(
     /// <param name="sessionId">Optional id for appending the message to a known session. If not set, then defaults to a new session.</param>
     /// <param name="properties">Optional custom metadata about the message.</param>
     /// <param name="timeToLive">Optional <see cref="TimeSpan"/> for message to be consumed. If not set, then defaults to the value specified on queue or topic.</param>
-    /// <param name="cancellationToken">The <see cref="CancellationToken"/> used.</param>
-    /// <returns>A <see cref="Task"/> containing the sequence number of the scheduled message.</returns>
-    Task<long> SchedulePublishAsync(
-        string topicOrQueue,
-        object message,
-        DateTimeOffset scheduledEnqueueTime,
-        string? sessionId = null,
-        IDictionary<string, string>? properties = null,
-        TimeSpan? timeToLive = null,
+    /// <param name="cancellationToken">The <see cref="CancellationToken"/> used.</param>
+    /// <returns>A <see cref="Task"/> containing the sequence number of the scheduled message.</returns>
+    Task<long> SchedulePublishAsync(
+        string topicOrQueue,
+        object message,
+        DateTimeOffset scheduledEnqueueTime,
+        string? sessionId = null,
+        IDictionary<string, string>? properties = null,
+        TimeSpan? timeToLive = null,
         CancellationToken cancellationToken = default);
 
     /// <summary>
     /// Cancels a scheduled publish of a message if it has not been published yet.
     /// </summary>
     /// <param name="topicOrQueue">The topic or queue name.</param>
     /// <param name="sequenceNumber">The sequence number of the scheduled message to cancel.</param>
-    /// <param name="cancellationToken">The <see cref="CancellationToken"/> used.</param>
-    /// <returns>A <see cref="Task"/> representing the asynchronous operation.</returns>
-    Task CancelScheduledPublishAsync(
-        string topicOrQueue,
-        long sequenceNumber,
-        CancellationToken cancellationToken = default);
+    /// <param name="cancellationToken">The <see cref="CancellationToken"/> used.</param>
+    /// <returns>A <see cref="Task"/> representing the asynchronous operation.</returns>
+    Task CancelScheduledPublishAsync(
+        string topicOrQueue,
+        long sequenceNumber,
+        CancellationToken cancellationToken = default);
 }