Merge pull request #856 from Particular/obsolete-apis

Obsolete timeout manager APIs

Author: HEskandari

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

@@ -29,7 +29,9 @@ namespace NServiceBus.Persistence.Sql
     }
     public class static ScriptRunner
     {
+        [System.ObsoleteAttribute(@"Timeout Manager is being deprecated. See upgrade guide for guidance on migrating to transport native delayed delivery. Use `Install(SqlDialect sqlDialect, string tablePrefix, Func<DbConnection> connectionBuilder, string scriptDirectory, bool shouldInstallOutbox, bool shouldInstallSagas, bool shouldInstallSubscriptions)` instead. Will be treated as an error from version 7.0.0. Will be removed in version 8.0.0.", false)]
         public static System.Threading.Tasks.Task Install(NServiceBus.SqlDialect sqlDialect, string tablePrefix, System.Func<System.Data.Common.DbConnection> connectionBuilder, string scriptDirectory, bool shouldInstallOutbox = True, bool shouldInstallSagas = True, bool shouldInstallSubscriptions = True, bool shouldInstallTimeouts = True) { }
+        [System.ObsoleteAttribute(@"Timeout Manager is being deprecated. See upgrade guide for guidance on migrating to transport native delayed delivery. Use `Install(SqlDialect sqlDialect, string tablePrefix, Func<Type, DbConnection> connectionBuilder, string scriptDirectory, bool shouldInstallOutbox, bool shouldInstallSagas, bool shouldInstallSubscriptions)` instead. Will be treated as an error from version 7.0.0. Will be removed in version 8.0.0.", false)]
         public static System.Threading.Tasks.Task Install(NServiceBus.SqlDialect sqlDialect, string tablePrefix, System.Func<System.Type, System.Data.Common.DbConnection> connectionBuilder, string scriptDirectory, bool shouldInstallOutbox = True, bool shouldInstallSagas = True, bool shouldInstallSubscriptions = True, bool shouldInstallTimeouts = True) { }
     }
     [System.AttributeUsageAttribute(System.AttributeTargets.Assembly | System.AttributeTargets.All)]
@@ -75,6 +77,9 @@ namespace NServiceBus.Persistence.Sql
         public void ConnectionBuilder(System.Func<System.Data.Common.DbConnection> connectionBuilder) { }
         public void DisableCache() { }
     }
+    [System.ObsoleteAttribute("Timeout Manager is being deprecated. See upgrade guide for guidance on migrating " +
+        "to transport native delayed delivery. Will be treated as an error from version 7" +
+        ".0.0. Will be removed in version 8.0.0.", false)]
     public class TimeoutSettings
     {
         public void ConnectionBuilder(System.Func<System.Data.Common.DbConnection> connectionBuilder) { }

src/SqlPersistence/ScriptRunner.cs

@@ -20,6 +20,11 @@ public static class ScriptRunner
         /// <remarks>
         /// Designed to be used in a manual installation without the requirement of starting a full NServiceBus endpoint.
         /// </remarks>
+        [ObsoleteEx(
+            Message = "Timeout Manager is being deprecated. See upgrade guide for guidance on migrating to transport native delayed delivery.",
+            TreatAsErrorFromVersion = "7",
+            RemoveInVersion = "8",
+            ReplacementTypeOrMember = "Install(SqlDialect sqlDialect, string tablePrefix, Func<DbConnection> connectionBuilder, string scriptDirectory, bool shouldInstallOutbox, bool shouldInstallSagas, bool shouldInstallSubscriptions)")]
         public static Task Install(SqlDialect sqlDialect, string tablePrefix, Func<DbConnection> connectionBuilder, string scriptDirectory, bool shouldInstallOutbox = true, bool shouldInstallSagas = true, bool shouldInstallSubscriptions = true, bool shouldInstallTimeouts = true)
         {
             return Install(sqlDialect, tablePrefix, x => connectionBuilder(), scriptDirectory, shouldInstallOutbox, shouldInstallSagas, shouldInstallSubscriptions, shouldInstallTimeouts);
@@ -31,6 +36,11 @@ public static Task Install(SqlDialect sqlDialect, string tablePrefix, Func<DbCon
         /// <remarks>
         /// Designed to be used in a manual installation without the requirement of starting a full NServiceBus endpoint.
         /// </remarks>
+        [ObsoleteEx(
+            Message = "Timeout Manager is being deprecated. See upgrade guide for guidance on migrating to transport native delayed delivery.",
+            TreatAsErrorFromVersion = "7",
+            RemoveInVersion = "8",
+            ReplacementTypeOrMember = "Install(SqlDialect sqlDialect, string tablePrefix, Func<Type, DbConnection> connectionBuilder, string scriptDirectory, bool shouldInstallOutbox, bool shouldInstallSagas, bool shouldInstallSubscriptions)")]
         public static async Task Install(SqlDialect sqlDialect, string tablePrefix, Func<Type, DbConnection> connectionBuilder, string scriptDirectory, bool shouldInstallOutbox = true, bool shouldInstallSagas = true, bool shouldInstallSubscriptions = true, bool shouldInstallTimeouts = true)
         {
             Guard.AgainstNull(nameof(sqlDialect), sqlDialect);

src/SqlPersistence/Timeout/Config/TimeoutSettings_Connection.cs

@@ -3,6 +3,10 @@ namespace NServiceBus.Persistence.Sql
     using System;
     using System.Data.Common;
 
+    [ObsoleteEx(
+        Message = "Timeout Manager is being deprecated. See upgrade guide for guidance on migrating to transport native delayed delivery.",
+        TreatAsErrorFromVersion = "7",
+        RemoveInVersion = "8")]
     public partial class TimeoutSettings
     {
         /// <summary>