Incorporate feedback

Co-authored-by: Indu Alagarsamy <[email protected]>
Particular · Feb 25, 2020 · 6420c36 · 6420c36
1 parent eb4418e
commit 6420c36
Show file tree

Hide file tree

Showing 3 changed files with 28 additions and 25 deletions.
diff --git a/src/NServiceBus.Persistence.AzureStorage/Timeout/AzureStorageTimeoutPersistence.cs b/src/NServiceBus.Persistence.AzureStorage/Timeout/AzureStorageTimeoutPersistence.cs
@@ -9,7 +9,7 @@ namespace NServiceBus
     using Persistence.AzureStorage.Config;
 
     /// <summary></summary>
-    [ObsoleteEx(Message = "Azure transports support timeouts natively and do not require timeout persistence.",
+    [ObsoleteEx(Message = "Azure Storage Queues supports timeouts natively and does not require timeout persistence.",
         TreatAsErrorFromVersion = "3",
         RemoveInVersion = "4")]
     public class AzureStorageTimeoutPersistence : Feature

diff --git a/src/NServiceBus.Persistence.AzureStorage/Timeout/ConfigureAzureTimeoutStorage.cs b/src/NServiceBus.Persistence.AzureStorage/Timeout/ConfigureAzureTimeoutStorage.cs
@@ -9,11 +9,14 @@
     /// </summary>
     public static class ConfigureAzureTimeoutStorage
     {
+        const string ObsoleteMessage = "Azure Storage Queues transport supports timeouts natively and does not require timeout persistence. Refer to the delayed delivery API.";
+        const string ReplacementTypeOrMember = "EndpointConfiguration.UseTransport<AzureStorageQueueTransport>().DelayedDelivery()";
+
         /// <summary>
         /// Connection string to use for timeouts storage.
         /// </summary>
-        [ObsoleteEx(Message = "Azure transports support timeouts natively and do not require timeout persistence. For Azure Storage Queues transport refer to the delayed delivery API.",
-            ReplacementTypeOrMember = "EndpointConfiguration.UseTransport<AzureStorageQueueTransport>().DelayedDelivery()",
+        [ObsoleteEx(Message = ObsoleteMessage,
+            ReplacementTypeOrMember = ReplacementTypeOrMember,
             TreatAsErrorFromVersion = "3",
             RemoveInVersion = "4")]
         public static PersistenceExtensions<AzureStoragePersistence, StorageType.Timeouts> ConnectionString(this PersistenceExtensions<AzureStoragePersistence, StorageType.Timeouts> config, string connectionString)
@@ -25,8 +28,8 @@ public static class ConfigureAzureTimeoutStorage
         }
 
         /// <summary></summary>
-        [ObsoleteEx(Message = "Azure transports support timeouts natively and do not require timeout persistence. For Azure Storage Queues transport refer to the delayed delivery API.",
-            ReplacementTypeOrMember = "EndpointConfiguration.UseTransport<AzureStorageQueueTransport>().DelayedDelivery()",
+        [ObsoleteEx(Message = ObsoleteMessage,
+            ReplacementTypeOrMember = ReplacementTypeOrMember,
             TreatAsErrorFromVersion = "3",
             RemoveInVersion = "4")]
         public static PersistenceExtensions<AzureStoragePersistence, StorageType.Timeouts> TimeoutStateContainerName(this PersistenceExtensions<AzureStoragePersistence, StorageType.Timeouts> config, string blobName)
@@ -39,8 +42,8 @@ public static class ConfigureAzureTimeoutStorage
         /// Should an attempt at startup be made to verify if storage tables for timeouts exist or not and if not create those.
         /// <remarks>Operation will fail if connection string does not allow access to create storage tables</remarks>
         /// </summary>
-        [ObsoleteEx(Message = "Azure transports support timeouts natively and do not require timeout persistence. For Azure Storage Queues transport refer to the delayed delivery API.",
-            ReplacementTypeOrMember = "EndpointConfiguration.UseTransport<AzureStorageQueueTransport>().DelayedDelivery()",
+        [ObsoleteEx(Message = ObsoleteMessage,
+            ReplacementTypeOrMember = ReplacementTypeOrMember,
             TreatAsErrorFromVersion = "3",
             RemoveInVersion = "4")]
         public static PersistenceExtensions<AzureStoragePersistence, StorageType.Timeouts> CreateSchema(this PersistenceExtensions<AzureStoragePersistence, StorageType.Timeouts> config, bool createSchema)
@@ -52,8 +55,8 @@ public static class ConfigureAzureTimeoutStorage
         /// <summary>
         /// Set the name of the table where the timeout manager stores it's internal state.
         /// </summary>
-        [ObsoleteEx(Message = "Azure transports support timeouts natively and do not require timeout persistence. For Azure Storage Queues transport refer to the delayed delivery API.",
-            ReplacementTypeOrMember = "EndpointConfiguration.UseTransport<AzureStorageQueueTransport>().DelayedDelivery()",
+        [ObsoleteEx(Message = ObsoleteMessage,
+            ReplacementTypeOrMember = ReplacementTypeOrMember,
             TreatAsErrorFromVersion = "3",
             RemoveInVersion = "4")]
         public static PersistenceExtensions<AzureStoragePersistence, StorageType.Timeouts> TimeoutManagerDataTableName(this PersistenceExtensions<AzureStoragePersistence, StorageType.Timeouts> config, string tableName)
@@ -67,8 +70,8 @@ public static class ConfigureAzureTimeoutStorage
         /// <summary>
         ///  Set the name of the table where the timeouts themselves are stored.
         /// </summary>
-        [ObsoleteEx(Message = "Azure transports support timeouts natively and do not require timeout persistence. For Azure Storage Queues transport refer to the delayed delivery API.",
-            ReplacementTypeOrMember = "EndpointConfiguration.UseTransport<AzureStorageQueueTransport>().DelayedDelivery()",
+        [ObsoleteEx(Message = ObsoleteMessage,
+            ReplacementTypeOrMember = ReplacementTypeOrMember,
             TreatAsErrorFromVersion = "3",
             RemoveInVersion = "4")]
         public static PersistenceExtensions<AzureStoragePersistence, StorageType.Timeouts> TimeoutDataTableName(this PersistenceExtensions<AzureStoragePersistence, StorageType.Timeouts> config, string tableName)
@@ -84,8 +87,8 @@ public static class ConfigureAzureTimeoutStorage
         /// </summary>
         /// <param name="catchUpInterval">Catch up interval in seconds</param>
         /// <param name="config"></param>
-        [ObsoleteEx(Message = "Azure transports support timeouts natively and do not require timeout persistence. For Azure Storage Queues transport refer to the delayed delivery API.",
-            ReplacementTypeOrMember = "EndpointConfiguration.UseTransport<AzureStorageQueueTransport>().DelayedDelivery()",
+        [ObsoleteEx(Message = ObsoleteMessage,
+            ReplacementTypeOrMember = ReplacementTypeOrMember,
             TreatAsErrorFromVersion = "3",
             RemoveInVersion = "4")]
         public static PersistenceExtensions<AzureStoragePersistence, StorageType.Timeouts> CatchUpInterval(this PersistenceExtensions<AzureStoragePersistence, StorageType.Timeouts> config, int catchUpInterval)
@@ -102,8 +105,8 @@ public static class ConfigureAzureTimeoutStorage
         /// <param name="partitionKeyScope">Partition key DateTime format string.</param>
         /// <param name="config"></param>
         /// <remarks>For optimal performance, this should be in line with the CatchUpInterval.</remarks>
-        [ObsoleteEx(Message = "Azure transports support timeouts natively and do not require timeout persistence. For Azure Storage Queues transport refer to the delayed delivery API.",
-            ReplacementTypeOrMember = "EndpointConfiguration.UseTransport<AzureStorageQueueTransport>().DelayedDelivery()",
+        [ObsoleteEx(Message = ObsoleteMessage,
+            ReplacementTypeOrMember = ReplacementTypeOrMember,
             TreatAsErrorFromVersion = "3",
             RemoveInVersion = "4")]
         public static PersistenceExtensions<AzureStoragePersistence, StorageType.Timeouts> PartitionKeyScope(this PersistenceExtensions<AzureStoragePersistence, StorageType.Timeouts> config, string partitionKeyScope)

diff --git a/src/Tests/ApprovalFiles/APIApprovals.ApproveAzureStoragePersistence.approved.txt b/src/Tests/ApprovalFiles/APIApprovals.ApproveAzureStoragePersistence.approved.txt
@@ -10,9 +10,9 @@ namespace NServiceBus
     {
         protected override void Setup(NServiceBus.Features.FeatureConfigurationContext context) { }
     }
-    [System.ObsoleteAttribute("Azure transports support timeouts natively and do not require timeout persistence" +
-        ". Will be treated as an error from version 3.0.0. Will be removed in version 4.0" +
-        ".0.", false)]
+    [System.ObsoleteAttribute("Azure Storage Queues supports timeouts natively and does not require timeout pers" +
+        "istence. Will be treated as an error from version 3.0.0. Will be removed in vers" +
+        "ion 4.0.0.", false)]
     public class AzureStorageTimeoutPersistence : NServiceBus.Features.Feature
     {
         protected override void Setup(NServiceBus.Features.FeatureConfigurationContext context) { }
@@ -36,19 +36,19 @@ namespace NServiceBus
     }
     public class static ConfigureAzureTimeoutStorage
     {
-        [System.ObsoleteAttribute(@"Azure transports support timeouts natively and do not require timeout persistence. For Azure Storage Queues transport refer to the delayed delivery API. Use `EndpointConfiguration.UseTransport<AzureStorageQueueTransport>().DelayedDelivery()` instead. Will be treated as an error from version 3.0.0. Will be removed in version 4.0.0.", false)]
+        [System.ObsoleteAttribute(@"Azure Storage Queues transport supports timeouts natively and does not require timeout persistence. Refer to the delayed delivery API. Use `EndpointConfiguration.UseTransport<AzureStorageQueueTransport>().DelayedDelivery()` instead. Will be treated as an error from version 3.0.0. Will be removed in version 4.0.0.", false)]
         public static NServiceBus.PersistenceExtensions<NServiceBus.AzureStoragePersistence, NServiceBus.StorageType.Timeouts> CatchUpInterval(this NServiceBus.PersistenceExtensions<NServiceBus.AzureStoragePersistence, NServiceBus.StorageType.Timeouts> config, int catchUpInterval) { }
-        [System.ObsoleteAttribute(@"Azure transports support timeouts natively and do not require timeout persistence. For Azure Storage Queues transport refer to the delayed delivery API. Use `EndpointConfiguration.UseTransport<AzureStorageQueueTransport>().DelayedDelivery()` instead. Will be treated as an error from version 3.0.0. Will be removed in version 4.0.0.", false)]
+        [System.ObsoleteAttribute(@"Azure Storage Queues transport supports timeouts natively and does not require timeout persistence. Refer to the delayed delivery API. Use `EndpointConfiguration.UseTransport<AzureStorageQueueTransport>().DelayedDelivery()` instead. Will be treated as an error from version 3.0.0. Will be removed in version 4.0.0.", false)]
         public static NServiceBus.PersistenceExtensions<NServiceBus.AzureStoragePersistence, NServiceBus.StorageType.Timeouts> ConnectionString(this NServiceBus.PersistenceExtensions<NServiceBus.AzureStoragePersistence, NServiceBus.StorageType.Timeouts> config, string connectionString) { }
-        [System.ObsoleteAttribute(@"Azure transports support timeouts natively and do not require timeout persistence. For Azure Storage Queues transport refer to the delayed delivery API. Use `EndpointConfiguration.UseTransport<AzureStorageQueueTransport>().DelayedDelivery()` instead. Will be treated as an error from version 3.0.0. Will be removed in version 4.0.0.", false)]
+        [System.ObsoleteAttribute(@"Azure Storage Queues transport supports timeouts natively and does not require timeout persistence. Refer to the delayed delivery API. Use `EndpointConfiguration.UseTransport<AzureStorageQueueTransport>().DelayedDelivery()` instead. Will be treated as an error from version 3.0.0. Will be removed in version 4.0.0.", false)]
         public static NServiceBus.PersistenceExtensions<NServiceBus.AzureStoragePersistence, NServiceBus.StorageType.Timeouts> CreateSchema(this NServiceBus.PersistenceExtensions<NServiceBus.AzureStoragePersistence, NServiceBus.StorageType.Timeouts> config, bool createSchema) { }
-        [System.ObsoleteAttribute(@"Azure transports support timeouts natively and do not require timeout persistence. For Azure Storage Queues transport refer to the delayed delivery API. Use `EndpointConfiguration.UseTransport<AzureStorageQueueTransport>().DelayedDelivery()` instead. Will be treated as an error from version 3.0.0. Will be removed in version 4.0.0.", false)]
+        [System.ObsoleteAttribute(@"Azure Storage Queues transport supports timeouts natively and does not require timeout persistence. Refer to the delayed delivery API. Use `EndpointConfiguration.UseTransport<AzureStorageQueueTransport>().DelayedDelivery()` instead. Will be treated as an error from version 3.0.0. Will be removed in version 4.0.0.", false)]
         public static NServiceBus.PersistenceExtensions<NServiceBus.AzureStoragePersistence, NServiceBus.StorageType.Timeouts> PartitionKeyScope(this NServiceBus.PersistenceExtensions<NServiceBus.AzureStoragePersistence, NServiceBus.StorageType.Timeouts> config, string partitionKeyScope) { }
-        [System.ObsoleteAttribute(@"Azure transports support timeouts natively and do not require timeout persistence. For Azure Storage Queues transport refer to the delayed delivery API. Use `EndpointConfiguration.UseTransport<AzureStorageQueueTransport>().DelayedDelivery()` instead. Will be treated as an error from version 3.0.0. Will be removed in version 4.0.0.", false)]
+        [System.ObsoleteAttribute(@"Azure Storage Queues transport supports timeouts natively and does not require timeout persistence. Refer to the delayed delivery API. Use `EndpointConfiguration.UseTransport<AzureStorageQueueTransport>().DelayedDelivery()` instead. Will be treated as an error from version 3.0.0. Will be removed in version 4.0.0.", false)]
         public static NServiceBus.PersistenceExtensions<NServiceBus.AzureStoragePersistence, NServiceBus.StorageType.Timeouts> TimeoutDataTableName(this NServiceBus.PersistenceExtensions<NServiceBus.AzureStoragePersistence, NServiceBus.StorageType.Timeouts> config, string tableName) { }
-        [System.ObsoleteAttribute(@"Azure transports support timeouts natively and do not require timeout persistence. For Azure Storage Queues transport refer to the delayed delivery API. Use `EndpointConfiguration.UseTransport<AzureStorageQueueTransport>().DelayedDelivery()` instead. Will be treated as an error from version 3.0.0. Will be removed in version 4.0.0.", false)]
+        [System.ObsoleteAttribute(@"Azure Storage Queues transport supports timeouts natively and does not require timeout persistence. Refer to the delayed delivery API. Use `EndpointConfiguration.UseTransport<AzureStorageQueueTransport>().DelayedDelivery()` instead. Will be treated as an error from version 3.0.0. Will be removed in version 4.0.0.", false)]
         public static NServiceBus.PersistenceExtensions<NServiceBus.AzureStoragePersistence, NServiceBus.StorageType.Timeouts> TimeoutManagerDataTableName(this NServiceBus.PersistenceExtensions<NServiceBus.AzureStoragePersistence, NServiceBus.StorageType.Timeouts> config, string tableName) { }
-        [System.ObsoleteAttribute(@"Azure transports support timeouts natively and do not require timeout persistence. For Azure Storage Queues transport refer to the delayed delivery API. Use `EndpointConfiguration.UseTransport<AzureStorageQueueTransport>().DelayedDelivery()` instead. Will be treated as an error from version 3.0.0. Will be removed in version 4.0.0.", false)]
+        [System.ObsoleteAttribute(@"Azure Storage Queues transport supports timeouts natively and does not require timeout persistence. Refer to the delayed delivery API. Use `EndpointConfiguration.UseTransport<AzureStorageQueueTransport>().DelayedDelivery()` instead. Will be treated as an error from version 3.0.0. Will be removed in version 4.0.0.", false)]
         public static NServiceBus.PersistenceExtensions<NServiceBus.AzureStoragePersistence, NServiceBus.StorageType.Timeouts> TimeoutStateContainerName(this NServiceBus.PersistenceExtensions<NServiceBus.AzureStoragePersistence, NServiceBus.StorageType.Timeouts> config, string blobName) { }
     }
 }