Merge pull request #9867 from drewnoakes/obsolete-apply-changes

Obsolete IProjectHotReloadSession.ApplyChangesAsync

Author: drewnoakes

src/Microsoft.VisualStudio.ProjectSystem.Managed/ProjectSystem/HotReload/Contracts/IProjectHotReloadSession.cs

@@ -24,14 +24,15 @@ public interface IProjectHotReloadSession
     /// <summary>
     /// Starts the Hot Reload Session.
     /// </summary>
+    /// <param name="cancellationToken">A token indicating if the operation has been cancelled.</param>
     Task StartSessionAsync(CancellationToken cancellationToken);
 
-    // TODO: Obsolete this overload
     /// <summary>
     /// Starts the Hot Reload Session.
     /// </summary>
     /// <param name="runningUnderDebugger">Unused</param>
     /// <param name="cancellationToken">A token indicating if the operation has been cancelled.</param>
+    [Obsolete($"Use the overload that takes a {nameof(CancellationToken)} instead.")]
     Task StartSessionAsync(bool runningUnderDebugger, CancellationToken cancellationToken);
 
     /// <summary>
@@ -42,6 +43,7 @@ public interface IProjectHotReloadSession
     /// <summary>
     /// Applies any pending changes to the Hot Reload session.
     /// </summary>
+    [Obsolete]
     Task ApplyChangesAsync(CancellationToken cancellationToken);
 
     /// <summary>

src/Microsoft.VisualStudio.ProjectSystem.Managed/ProjectSystem/HotReload/ProjectHotReloadSession.cs

@@ -83,6 +83,7 @@ internal static string GetInjectedAssemblyPath(string targetFramework, string as
     public IDeltaApplier? DeltaApplier
         => _lazyDeltaApplier;
 
+    [Obsolete]
     public async Task ApplyChangesAsync(CancellationToken cancellationToken)
     {
         if (_sessionActive)
@@ -154,7 +155,7 @@ public async Task<bool> ApplyLaunchVariablesAsync(IDictionary<string, string> en
         return await applier.ApplyProcessEnvironmentVariablesAsync(envVars, cancellationToken);
     }
 
-    // TODO: remove
+    [Obsolete($"Use the overload that takes a {nameof(CancellationToken)} instead.")]
     public Task StartSessionAsync(bool runningUnderDebugger, CancellationToken cancellationToken)
         => StartSessionAsync(cancellationToken);
 

tests/Microsoft.VisualStudio.ProjectSystem.Managed.UnitTests/ProjectSystem/HotReload/ProjectHotReloadSessionTests.cs

@@ -26,6 +26,7 @@ public void Constructor_InitializesProperties()
     }
 
     [Fact]
+    [Obsolete]
     public async Task ApplyChangesAsync_WhenSessionActive_CallsHotReloadAgentManagerClient()
     {
         // Arrange
@@ -48,6 +49,7 @@ public async Task ApplyChangesAsync_WhenSessionActive_CallsHotReloadAgentManager
     }
 
     [Fact]
+    [Obsolete]
     public async Task ApplyChangesAsync_WhenSessionNotActive_DoesNotCallHotReloadAgentManagerClient()
     {
         // Arrange