Merge pull request #48968 from sharwell/require-token

Update RegisterNotification to require a CancellationToken
dotnet · Oct 28, 2020 · b1d8852 · b1d8852
2 parents fbf1583 + 7660d18
commit b1d8852
Show file tree

Hide file tree

Showing 4 changed files with 21 additions and 13 deletions.
diff --git a/src/EditorFeatures/Core/IForegroundNotificationService.cs b/src/EditorFeatures/Core/IForegroundNotificationService.cs
@@ -15,15 +15,15 @@ namespace Microsoft.CodeAnalysis.Editor
     /// </summary>
     internal interface IForegroundNotificationService
     {
-        void RegisterNotification(Action action, IAsyncToken asyncToken, CancellationToken cancellationToken = default);
+        void RegisterNotification(Action action, IAsyncToken asyncToken, CancellationToken cancellationToken);
 
-        void RegisterNotification(Action action, int delayInMS, IAsyncToken asyncToken, CancellationToken cancellationToken = default);
+        void RegisterNotification(Action action, int delayInMS, IAsyncToken asyncToken, CancellationToken cancellationToken);
 
         /// <summary>
         /// if action return true, the service will call it back again when it has time.
         /// </summary>
-        void RegisterNotification(Func<bool> action, IAsyncToken asyncToken, CancellationToken cancellationToken = default);
+        void RegisterNotification(Func<bool> action, IAsyncToken asyncToken, CancellationToken cancellationToken);
 
-        void RegisterNotification(Func<bool> action, int delayInMS, IAsyncToken asyncToken, CancellationToken cancellationToken = default);
+        void RegisterNotification(Func<bool> action, int delayInMS, IAsyncToken asyncToken, CancellationToken cancellationToken);
     }
 }
diff --git a/...ditorFeatures/Core/Implementation/ForegroundNotification/ForegroundNotificationService.cs b/...ditorFeatures/Core/Implementation/ForegroundNotification/ForegroundNotificationService.cs
@@ -49,13 +49,13 @@ public ForegroundNotificationService(IThreadingContext threadingContext)
             }
         }
 
-        public void RegisterNotification(Action action, IAsyncToken asyncToken, CancellationToken cancellationToken = default)
+        public void RegisterNotification(Action action, IAsyncToken asyncToken, CancellationToken cancellationToken)
             => RegisterNotification(action, DefaultTimeSliceInMS, asyncToken, cancellationToken);
 
-        public void RegisterNotification(Func<bool> action, IAsyncToken asyncToken, CancellationToken cancellationToken = default)
+        public void RegisterNotification(Func<bool> action, IAsyncToken asyncToken, CancellationToken cancellationToken)
             => RegisterNotification(action, DefaultTimeSliceInMS, asyncToken, cancellationToken);
 
-        public void RegisterNotification(Action action, int delay, IAsyncToken asyncToken, CancellationToken cancellationToken = default)
+        public void RegisterNotification(Action action, int delay, IAsyncToken asyncToken, CancellationToken cancellationToken)
         {
             Debug.Assert(delay >= 0);
 
@@ -73,7 +73,7 @@ public void RegisterNotification(Action action, int delay, IAsyncToken asyncToke
             _workQueue.Enqueue(new PendingWork(current + delay, action, asyncToken, cancellationToken));
         }
 
-        public void RegisterNotification(Func<bool> action, int delay, IAsyncToken asyncToken, CancellationToken cancellationToken = default)
+        public void RegisterNotification(Func<bool> action, int delay, IAsyncToken asyncToken, CancellationToken cancellationToken)
         {
             Debug.Assert(delay >= 0);
 

diff --git a/src/VisualStudio/Core/Def/Implementation/InfoBar/VisualStudioInfoBarService.cs b/src/VisualStudio/Core/Def/Implementation/InfoBar/VisualStudioInfoBarService.cs
@@ -52,7 +52,7 @@ public void ShowInfoBar(string message, params InfoBarUI[] items)
                 {
                     CreateInfoBar(infoBarHost, message, items);
                 }
-            }, _listener.BeginAsyncOperation(nameof(ShowInfoBar)));
+            }, _listener.BeginAsyncOperation(nameof(ShowInfoBar)), ThreadingContext.DisposalToken);
         }
 
         private bool TryGetInfoBarData(out IVsInfoBarHost infoBarHost)

diff --git a/.../Core/Def/Implementation/ProjectSystem/RuleSets/VisualStudioRuleSetManager.RuleSetFile.cs b/.../Core/Def/Implementation/ProjectSystem/RuleSets/VisualStudioRuleSetManager.RuleSetFile.cs
@@ -7,9 +7,8 @@
 using System;
 using System.Collections.Generic;
 using System.Collections.Immutable;
+using System.Threading;
 using Microsoft.CodeAnalysis;
-using Microsoft.VisualStudio.Shell.Interop;
-using Roslyn.Utilities;
 
 namespace Microsoft.VisualStudio.LanguageServices.Implementation.ProjectSystem
 {
@@ -19,6 +18,8 @@ private sealed class RuleSetFile : IRuleSetFile, IDisposable
         {
             private readonly VisualStudioRuleSetManager _ruleSetManager;
             private readonly object _gate = new();
+            private readonly CancellationTokenSource _disposalCancellationSource;
+            private readonly CancellationToken _disposalToken;
 
             private FileChangeWatcher.IContext _fileChangeContext;
 
@@ -34,6 +35,9 @@ public RuleSetFile(string filePath, VisualStudioRuleSetManager ruleSetManager)
             {
                 FilePath = filePath;
                 _ruleSetManager = ruleSetManager;
+
+                _disposalCancellationSource = new();
+                _disposalToken = _disposalCancellationSource.Token;
             }
 
             public void InitializeFileTracking(FileChangeWatcher fileChangeWatcher)
@@ -140,7 +144,11 @@ private void EnsureDiagnosticOptionsRead()
             }
 
             public void Dispose()
-                => RemoveFromRuleSetManagerAndDisconnectFileTrackers();
+            {
+                RemoveFromRuleSetManagerAndDisconnectFileTrackers();
+                _disposalCancellationSource.Cancel();
+                _disposalCancellationSource.Dispose();
+            }
 
             private void RemoveFromRuleSetManagerAndDisconnectFileTrackers()
             {
@@ -170,7 +178,7 @@ private void IncludeUpdated(object sender, string fileChanged)
                 // To avoid this, just queue up a Task to do the work on the foreground thread later, after
                 // the lock on the file change service has been released.
                 _ruleSetManager._foregroundNotificationService.RegisterNotification(
-                    () => IncludeUpdateCore(), _ruleSetManager._listener.BeginAsyncOperation("IncludeUpdated"));
+                    () => IncludeUpdateCore(), _ruleSetManager._listener.BeginAsyncOperation("IncludeUpdated"), _disposalToken);
             }
 
             private void IncludeUpdateCore()