move ThrowIfUnmappedEventTypes to its own subtype of topologyoptions so that it doesn't interefere with other topology types

Author: PhilBastian

src/Tests/ApprovalFiles/APIApprovals.Approve.approved.txt

@@ -54,7 +54,6 @@ namespace NServiceBus
     {
         protected TopicTopology(NServiceBus.Transport.AzureServiceBus.TopologyOptions options, Microsoft.Extensions.Options.IValidateOptions<NServiceBus.Transport.AzureServiceBus.TopologyOptions> optionsValidator) { }
         public Microsoft.Extensions.Options.IValidateOptions<NServiceBus.Transport.AzureServiceBus.TopologyOptions> OptionsValidator { get; set; }
-        public bool ThrowIfUnmappedEventTypes { get; set; }
         public static NServiceBus.Transport.AzureServiceBus.TopicPerEventTopology Default { get; }
         protected abstract string GetPublishDestinationCore(string eventTypeFullName);
         public void Validate() { }
@@ -173,8 +172,13 @@ namespace NServiceBus.Transport.AzureServiceBus
         public void SubscribeTo<TEventType, TEventTypeImplementation>()
             where TEventTypeImplementation : TEventType { }
     }
+    public class TopicPerEventTopologyOptions : NServiceBus.Transport.AzureServiceBus.TopologyOptions
+    {
+        public TopicPerEventTopologyOptions() { }
+        public bool ThrowIfUnmappedEventTypes { get; set; }
+    }
     [System.Text.Json.Serialization.JsonDerivedType(typeof(NServiceBus.Transport.AzureServiceBus.MigrationTopologyOptions), "migration-topology-options")]
-    [System.Text.Json.Serialization.JsonDerivedType(typeof(NServiceBus.Transport.AzureServiceBus.TopologyOptions), "topology-options")]
+    [System.Text.Json.Serialization.JsonDerivedType(typeof(NServiceBus.Transport.AzureServiceBus.TopicPerEventTopologyOptions), "topology-options")]
     public class TopologyOptions
     {
         public TopologyOptions() { }
@@ -186,7 +190,6 @@ namespace NServiceBus.Transport.AzureServiceBus
         [NServiceBus.Transport.AzureServiceBus.AzureServiceBusTopics]
         [System.Text.Json.Serialization.JsonConverter(typeof(NServiceBus.Transport.AzureServiceBus.SubscribedEventToTopicsMapConverter))]
         public System.Collections.Generic.Dictionary<string, System.Collections.Generic.HashSet<string>> SubscribedEventToTopicsMap { get; init; }
-        public bool ThrowIfUnmappedEventTypes { get; set; }
     }
     public sealed class TopologyOptionsDisableValidationValidator : Microsoft.Extensions.Options.IValidateOptions<NServiceBus.Transport.AzureServiceBus.TopologyOptions>
     {
@@ -207,6 +210,7 @@ namespace NServiceBus.Transport.AzureServiceBus
         public System.Text.Json.Serialization.Metadata.JsonTypeInfo<System.Collections.Generic.HashSet<string>> HashSetString { get; }
         public System.Text.Json.Serialization.Metadata.JsonTypeInfo<NServiceBus.Transport.AzureServiceBus.MigrationTopologyOptions> MigrationTopologyOptions { get; }
         public System.Text.Json.Serialization.Metadata.JsonTypeInfo<string> String { get; }
+        public System.Text.Json.Serialization.Metadata.JsonTypeInfo<NServiceBus.Transport.AzureServiceBus.TopicPerEventTopologyOptions> TopicPerEventTopologyOptions { get; }
         public System.Text.Json.Serialization.Metadata.JsonTypeInfo<NServiceBus.Transport.AzureServiceBus.TopologyOptions> TopologyOptions { get; }
         public static NServiceBus.Transport.AzureServiceBus.TopologyOptionsSerializationContext Default { get; }
         public override System.Text.Json.Serialization.Metadata.JsonTypeInfo? GetTypeInfo(System.Type type) { }

src/Tests/EventRouting/TopicPerEventSubscriptionManagerTests.cs

@@ -13,7 +13,7 @@ public class TopicPerEventSubscriptionManagerTests
     [Test]
     public async Task Should_create_topology_for_mapped_events()
     {
-        var topologyOptions = new TopologyOptions
+        var topologyOptions = new TopicPerEventTopologyOptions
         {
             SubscribedEventToTopicsMap =
             {
@@ -42,7 +42,7 @@ public async Task Should_create_topology_for_mapped_events()
     [Test]
     public async Task Should_create_topology_for_unmapped_events()
     {
-        var topologyOptions = new TopologyOptions
+        var topologyOptions = new TopicPerEventTopologyOptions
         {
             QueueNameToSubscriptionNameMap = { { "SubscribingQueue", "MySubscriptionName" } },
         };

src/Tests/EventRouting/TopicPerEventTopologyTests.cs

@@ -10,7 +10,7 @@ public class TopicPerEventTopologyTests
     [Test]
     public void PublishDestination_Should_return_mapped_topic_when_event_is_mapped()
     {
-        var topologyOptions = new TopologyOptions
+        var topologyOptions = new TopicPerEventTopologyOptions
         {
             PublishedEventToTopicsMap =
             {
@@ -28,7 +28,7 @@ public void PublishDestination_Should_return_mapped_topic_when_event_is_mapped()
     [Test]
     public void PublishDestination_Should_default_topic_to_event_name()
     {
-        var topologyOptions = new TopologyOptions();
+        var topologyOptions = new TopicPerEventTopologyOptions();
 
         var topology = TopicTopology.FromOptions(topologyOptions);
 
@@ -40,7 +40,7 @@ public void PublishDestination_Should_default_topic_to_event_name()
     [Test]
     public void Should_self_validate()
     {
-        var topologyOptions = new TopologyOptions
+        var topologyOptions = new TopicPerEventTopologyOptions
         {
             PublishedEventToTopicsMap = { { typeof(MyEvent).FullName, new string('c', 261) } },
             SubscribedEventToTopicsMap = { { typeof(MyEvent).FullName, [new string('d', 261), new string('e', 261)] } },
@@ -59,7 +59,7 @@ public void Should_self_validate()
     [Test]
     public void Should_allow_disabling_validation()
     {
-        var topologyOptions = new TopologyOptions
+        var topologyOptions = new TopicPerEventTopologyOptions
         {
             PublishedEventToTopicsMap = { { typeof(MyEvent).FullName, new string('c', 261) } }
         };
@@ -73,10 +73,12 @@ public void Should_allow_disabling_validation()
     [Test]
     public void ThrowIfUnmappedEventTypes_Should_throw_when_type_unmapped()
     {
-        var topologyOptions = new TopologyOptions();
+        var topologyOptions = new TopicPerEventTopologyOptions
+        {
+            ThrowIfUnmappedEventTypes = true
+        };
 
         var topology = TopicTopology.FromOptions(topologyOptions);
-        topology.ThrowIfUnmappedEventTypes = true;
 
         Assert.Throws<System.Exception>(() => topology.GetPublishDestination(typeof(MyEvent)));
     }

src/Transport/EventRouting/TopicPerEventTopology.cs

@@ -7,7 +7,7 @@ namespace NServiceBus.Transport.AzureServiceBus;
 /// </summary>
 public sealed class TopicPerEventTopology : TopicTopology
 {
-    internal TopicPerEventTopology(TopologyOptions options) : base(options, new TopologyOptionsValidator())
+    internal TopicPerEventTopology(TopicPerEventTopologyOptions options) : base(options, new TopologyOptionsValidator())
     {
     }
 
@@ -105,14 +105,14 @@ public void OverrideSubscriptionNameFor(string queueName, string subscriptionNam
     /// <inheritdoc />
     protected override string GetPublishDestinationCore(string eventTypeFullName)
     {
-        if (!Options.PublishedEventToTopicsMap.TryGetValue(eventTypeFullName, out string? topic) && Options.ThrowIfUnmappedEventTypes)
+        if (!Options.PublishedEventToTopicsMap.TryGetValue(eventTypeFullName, out string? topic) && (Options is TopicPerEventTopologyOptions tpeOptions) && tpeOptions.ThrowIfUnmappedEventTypes)
         {
-            throw new Exception($"Unmapped event type '{eventTypeFullName}'. All events must be mapped in `PublishedEventToTopicsMap` when `ThrowIfUnmappedEventTypes` is set");
+            throw new Exception($"Unmapped event type '{eventTypeFullName}'. All events must be mapped in `{nameof(TopologyOptions.PublishedEventToTopicsMap)}` when `{nameof(TopicPerEventTopologyOptions.ThrowIfUnmappedEventTypes)}` is set");
         }
         return topic ?? eventTypeFullName;
     }
 
     internal override SubscriptionManager CreateSubscriptionManager(
         SubscriptionManagerCreationOptions creationOptions) =>
-        new TopicPerEventTopologySubscriptionManager(creationOptions, Options);
+        new TopicPerEventTopologySubscriptionManager(creationOptions, (TopicPerEventTopologyOptions)Options);
 }

src/Transport/EventRouting/TopicPerEventTopologyOptions.cs

@@ -0,0 +1,12 @@
+namespace NServiceBus.Transport.AzureServiceBus;
+
+/// <summary>
+/// Serializable object that defines the topic-per-event topology
+/// </summary>
+public class TopicPerEventTopologyOptions : TopologyOptions
+{
+    /// <summary>
+    /// Determines if an exception should be thrown when attempting to publish an event not mapped in PublishedEventToTopicsMap
+    /// </summary>
+    public bool ThrowIfUnmappedEventTypes { get; set; } = false;
+}

src/Transport/EventRouting/TopicPerEventTopologySubscriptionManager.cs

@@ -13,11 +13,11 @@ namespace NServiceBus.Transport.AzureServiceBus;
 
 sealed class TopicPerEventTopologySubscriptionManager : SubscriptionManager
 {
-    readonly TopologyOptions topologyOptions;
+    readonly TopicPerEventTopologyOptions topologyOptions;
     readonly string subscriptionName;
 
     public TopicPerEventTopologySubscriptionManager(SubscriptionManagerCreationOptions creationOptions,
-        TopologyOptions topologyOptions) : base(creationOptions)
+        TopicPerEventTopologyOptions topologyOptions) : base(creationOptions)
     {
         this.topologyOptions = topologyOptions;
         subscriptionName = topologyOptions.QueueNameToSubscriptionNameMap.GetValueOrDefault(CreationOptions.SubscribingQueueName, CreationOptions.SubscribingQueueName);

src/Transport/EventRouting/TopicTopology.cs

@@ -3,6 +3,7 @@ namespace NServiceBus
     using System;
     using System.ComponentModel.DataAnnotations;
     using Microsoft.Extensions.Options;
+    using NServiceBus.Logging;
     using Particular.Obsoletes;
     using Transport.AzureServiceBus;
 
@@ -28,33 +29,34 @@ protected TopicTopology(TopologyOptions options, IValidateOptions<TopologyOption
 
         internal TopologyOptions Options { get; }
 
-        /// <summary>
-        /// Determines if an exception should be thrown when attempting to publish an event not mapped in PublishedEventToTopicsMap
-        /// </summary>
-        public bool ThrowIfUnmappedEventTypes
-        {
-            get => Options.ThrowIfUnmappedEventTypes;
-            set => Options.ThrowIfUnmappedEventTypes = value;
-        }
-
-
         /// <summary>
         /// Creates an instance of the topology object based on serializable state.
         /// </summary>
         /// <param name="options">Serializable topology configuration.</param>
-        public static TopicTopology FromOptions(TopologyOptions options) =>
-            options switch
+        public static TopicTopology FromOptions(TopologyOptions options)
+        {
+            static TopicPerEventTopology Default()
+            {
+#pragma warning disable CS0618 // Type or member is obsolete
+                Log.Warn($"Unknown options type, expected '{nameof(TopicPerEventTopologyOptions)}' or '{nameof(MigrationTopologyOptions)}'");
+#pragma warning restore CS0618 // Type or member is obsolete
+                return TopicTopology.Default;
+            }
+
+            return options switch
             {
 #pragma warning disable CS0618 // Type or member is obsolete
                 MigrationTopologyOptions migrationOptions => new MigrationTopology(migrationOptions),
 #pragma warning restore CS0618 // Type or member is obsolete
-                _ => new TopicPerEventTopology(options)
+                TopicPerEventTopologyOptions tpeOptions => new TopicPerEventTopology(tpeOptions),
+                _ => Default()
             };
+        }
 
         /// <summary>
         /// Returns the default topology that uses topic per event type.
         /// </summary>
-        public static TopicPerEventTopology Default => new(new TopologyOptions());
+        public static TopicPerEventTopology Default => new(new());
 
         /// <summary>
         /// Returns a migration topology using a single topic named <c>bundle-1</c> for <see cref="MigrationTopology.TopicToPublishTo"/> and <see cref="MigrationTopology.TopicToSubscribeOn"/>
@@ -130,5 +132,7 @@ internal string GetPublishDestination(Type eventType)
         /// </summary>
         /// <param name="eventTypeFullName">Full type name of the event.</param>
         protected abstract string GetPublishDestinationCore(string eventTypeFullName);
+
+        static ILog Log = LogManager.GetLogger<TopicTopology>();
     }
 }

src/Transport/EventRouting/TopologyOptions.cs

@@ -4,9 +4,9 @@ namespace NServiceBus.Transport.AzureServiceBus;
 using System.Text.Json.Serialization;
 
 /// <summary>
-/// Serializable object that defines the topic-per-event topology
+/// Serializable object that defines the topology
 /// </summary>
-[JsonDerivedType(typeof(TopologyOptions), typeDiscriminator: "topology-options")]
+[JsonDerivedType(typeof(TopicPerEventTopologyOptions), typeDiscriminator: "topology-options")]
 #pragma warning disable CS0618 // Type or member is obsolete
 [JsonDerivedType(typeof(MigrationTopologyOptions), typeDiscriminator: "migration-topology-options")]
 #pragma warning restore CS0618 // Type or member is obsolete
@@ -43,9 +43,4 @@ public Dictionary<string, string> QueueNameToSubscriptionNameMap
         get;
         init => field = value ?? [];
     } = [];
-
-    /// <summary>
-    /// Determines if an exception should be thrown when attempting to publish an event not mapped in PublishedEventToTopicsMap
-    /// </summary>
-    public bool ThrowIfUnmappedEventTypes { get; set; } = false;
 }