Fix transport encoding header obsoletion (#1208)

* Fix obsoletion warning for SendTransportEncodingHeader to indicate we will no longer be sending this header in the next version to align it with the transport extension

* Remove DoNotSendTransportEncodingHeader APIs since they have never been shipped (only as alpha to MT connector)

---------

Co-authored-by: Daniel Marbach <[email protected]>

Author: danielmarbach

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

@@ -16,19 +16,16 @@ namespace NServiceBus
             "ersion 6.0.0.", true)]
         public AzureServiceBusTransport(string fullyQualifiedNamespace, Azure.Core.TokenCredential tokenCredential) { }
         public AzureServiceBusTransport(string fullyQualifiedNamespace, Azure.Core.TokenCredential tokenCredential, NServiceBus.TopicTopology topology) { }
-        [System.Obsolete(@"The transport by default no longer sends the transport encoding header for wire compatibility with NServiceBus.AzureServiceBus, requiring an opt-in for the header to be sent. Use `SendTransportEncodingHeader` instead. The member currently throws a NotImplementedException. Will be removed in version 6.0.0.", true)]
-        public bool DoNotSendTransportEncodingHeader { get; set; }
         public bool EnablePartitioning { get; set; }
         public int EntityMaximumSize { get; set; }
         public System.TimeSpan? MaxAutoLockRenewalDuration { get; set; }
         public System.Action<NServiceBus.Transport.IOutgoingTransportOperation, Azure.Messaging.ServiceBus.ServiceBusMessage>? OutgoingNativeMessageCustomization { get; set; }
         public int? PrefetchCount { get; set; }
         public int PrefetchMultiplier { get; set; }
         public Azure.Messaging.ServiceBus.ServiceBusRetryOptions? RetryPolicyOptions { get; set; }
-        [System.Obsolete("Next versions of the transport will by default no longer send the transport encod" +
-            "ing header for wire compatibility, requiring an opt-in for the header to be sent" +
-            ". Will be treated as an error from version 6.0.0. Will be removed in version 7.0" +
-            ".0.", false)]
+        [System.Obsolete("Next versions of the transport will no longer support sending the transport encod" +
+            "ing header. Will be treated as an error from version 6.0.0. Will be removed in v" +
+            "ersion 7.0.0.", false)]
         public bool SendTransportEncodingHeader { get; set; }
         [System.Obsolete("Setting the subscription name is accessible via the topology. Use `OverrideSubscr" +
             "iptionNameFor` instead. The member currently throws a NotImplementedException. W" +
@@ -61,8 +58,6 @@ namespace NServiceBus
             "viceBusTransport or via UseTransport<AzureServiceBusTransport> method. Will be r" +
             "emoved in version 6.0.0.", true)]
         public static NServiceBus.TransportExtensions<NServiceBus.AzureServiceBusTransport> CustomTokenCredential(this NServiceBus.TransportExtensions<NServiceBus.AzureServiceBusTransport> transportExtensions, string fullyQualifiedNamespace, Azure.Core.TokenCredential tokenCredential) { }
-        [System.Obsolete(@"The transport by default no longer sends the transport encoding header for wire compatibility with NServiceBus.AzureServiceBus, requiring an opt-in for the header to be sent. Use `SendTransportEncodingHeader(this TransportExtensions<AzureServiceBusTransport> transportExtensions)` instead. Will be treated as an error from version 6.0.0. The member currently throws a NotImplementedException. Will be removed in version 7.0.0.", false)]
-        public static NServiceBus.TransportExtensions<NServiceBus.AzureServiceBusTransport> DoNotSendTransportEncodingHeader(this NServiceBus.TransportExtensions<NServiceBus.AzureServiceBusTransport> transportExtensions) { }
         public static NServiceBus.TransportExtensions<NServiceBus.AzureServiceBusTransport> EnablePartitioning(this NServiceBus.TransportExtensions<NServiceBus.AzureServiceBusTransport> transportExtensions) { }
         public static NServiceBus.TransportExtensions<NServiceBus.AzureServiceBusTransport> EntityMaximumSize(this NServiceBus.TransportExtensions<NServiceBus.AzureServiceBusTransport> transportExtensions, int maximumSizeInGB) { }
         public static NServiceBus.TransportExtensions<NServiceBus.AzureServiceBusTransport> MaxAutoLockRenewalDuration(this NServiceBus.TransportExtensions<NServiceBus.AzureServiceBusTransport> transportExtensions, System.TimeSpan maximumAutoLockRenewalDuration) { }

src/Transport/AzureServiceBusTransport.cs

@@ -310,7 +310,7 @@ public IWebProxy? WebProxy
     /// <summary>
     /// When set will add `NServiceBus.Transport.Encoding` header for wire compatibility with NServiceBus.AzureServiceBus. The default value is <c>false</c>.
     /// </summary>
-    [ObsoleteEx(Message = "Next versions of the transport will by default no longer send the transport encoding header for wire compatibility, requiring an opt-in for the header to be sent.",
+    [ObsoleteEx(Message = "Next versions of the transport will no longer support sending the transport encoding header.",
         TreatAsErrorFromVersion = "6",
         RemoveInVersion = "7")]
     public bool SendTransportEncodingHeader

src/Transport/obsoletes-v5.cs

@@ -49,18 +49,6 @@ public Func<Type, string> SubscriptionRuleNamingConvention
             get => throw new NotImplementedException();
             set => throw new NotImplementedException();
         }
-
-        [ObsoleteEx(
-            Message =
-                "The transport by default no longer sends the transport encoding header for wire compatibility with NServiceBus.AzureServiceBus, requiring an opt-in for the header to be sent.",
-            TreatAsErrorFromVersion = "5",
-            RemoveInVersion = "6",
-            ReplacementTypeOrMember = "SendTransportEncodingHeader")]
-        public bool DoNotSendTransportEncodingHeader
-        {
-            get => throw new NotImplementedException();
-            set => throw new NotImplementedException();
-        }
     }
 
     public static partial class AzureServiceBusTransportSettingsExtensions
@@ -95,17 +83,6 @@ public static TransportExtensions<AzureServiceBusTransport> SubscriptionNamingCo
         public static TransportExtensions<AzureServiceBusTransport> SubscriptionRuleNamingConvention(
             this TransportExtensions<AzureServiceBusTransport> transportExtensions,
             Func<Type, string> subscriptionRuleNamingConvention) => throw new NotImplementedException();
-
-        [ObsoleteEx(
-            Message =
-                "The transport by default no longer sends the transport encoding header for wire compatibility with NServiceBus.AzureServiceBus, requiring an opt-in for the header to be sent.",
-            TreatAsErrorFromVersion = "6",
-            RemoveInVersion = "7",
-            ReplacementTypeOrMember =
-                "SendTransportEncodingHeader(this TransportExtensions<AzureServiceBusTransport> transportExtensions)")]
-        public static TransportExtensions<AzureServiceBusTransport> DoNotSendTransportEncodingHeader(
-            this TransportExtensions<AzureServiceBusTransport> transportExtensions) =>
-            throw new NotImplementedException();
     }
 
     public abstract partial class TopicTopology