Refactor/Improve InvokeAsync to address disposing issues of the cancellation token.

Author: KlausLoeffelmann

src/System.Windows.Forms/GlobalSuppressions.cs

@@ -2,6 +2,8 @@
 // The .NET Foundation licenses this file to you under the MIT license.
 
 // Publicly shipped API
+
+
 [assembly: SuppressMessage("Naming", "CA1725:Parameter names should match base declaration", Justification = "Public API", Scope = "member", Target = "~M:System.Windows.Forms.ButtonBase.OnKeyDown(System.Windows.Forms.KeyEventArgs)")]
 [assembly: SuppressMessage("Naming", "CA1725:Parameter names should match base declaration", Justification = "Public API", Scope = "member", Target = "~M:System.Windows.Forms.ButtonBase.OnKeyUp(System.Windows.Forms.KeyEventArgs)")]
 [assembly: SuppressMessage("Naming", "CA1725:Parameter names should match base declaration", Justification = "Public API", Scope = "member", Target = "~M:System.Windows.Forms.ButtonBase.OnMouseDown(System.Windows.Forms.MouseEventArgs)")]
@@ -268,3 +270,5 @@
 [assembly: SuppressMessage("ApiDesign", "RS0026:Do not add multiple public overloads with optional parameters", Justification = "Analyzer wrongly complains for new APIs - known issue.", Scope = "member", Target = "~M:System.Windows.Forms.TaskDialog.ShowDialogAsync(System.Windows.Forms.TaskDialogPage,System.Windows.Forms.TaskDialogStartupLocation)~System.Threading.Tasks.Task{System.Windows.Forms.TaskDialogButton}")]
 [assembly: SuppressMessage("ApiDesign", "RS0026:Do not add multiple public overloads with optional parameters", Justification = "Analyzer wrongly complains for new APIs - known issue.", Scope = "member", Target = "~M:System.Windows.Forms.TaskDialog.ShowDialogAsync(System.Windows.Forms.IWin32Window,System.Windows.Forms.TaskDialogPage,System.Windows.Forms.TaskDialogStartupLocation)~System.Threading.Tasks.Task{System.Windows.Forms.TaskDialogButton}")]
 [assembly: SuppressMessage("ApiDesign", "RS0026:Do not add multiple public overloads with optional parameters", Justification = "Analyzer wrongly complains for new APIs - known issue.", Scope = "member", Target = "~M:System.Windows.Forms.TaskDialog.ShowDialogAsync(System.IntPtr,System.Windows.Forms.TaskDialogPage,System.Windows.Forms.TaskDialogStartupLocation)~System.Threading.Tasks.Task{System.Windows.Forms.TaskDialogButton}")]
+[assembly: SuppressMessage("Reliability", "CA2007:Consider calling ConfigureAwait on the awaited task", Justification = "<Pending>", Scope = "member", Target = "~M:System.Windows.Forms.Control.InvokeAsync(System.Func{System.Threading.CancellationToken,System.Threading.Tasks.ValueTask},System.Threading.CancellationToken)~System.Threading.Tasks.Task")]
+[assembly: SuppressMessage("Reliability", "CA2007:Consider calling ConfigureAwait on the awaited task", Justification = "<Pending>", Scope = "member", Target = "~M:System.Windows.Forms.Control.InvokeAsync``1(System.Func{System.Threading.CancellationToken,System.Threading.Tasks.ValueTask{``0}},System.Threading.CancellationToken)~System.Threading.Tasks.Task{``0}")]

src/System.Windows.Forms/System/Windows/Forms/Control_InvokeAsync.cs

@@ -142,6 +142,7 @@ void WrappedCallback()
     ///  A task representing the operation.
     /// </returns>
     /// <exception cref="InvalidOperationException">Thrown if the control's handle is not yet created.</exception>
+    /// <exception cref="ArgumentNullException">Thrown if the callback is null.</exception>
     /// <remarks>
     ///  <para>
     ///   <b>Note:</b> The callback will be marshalled to the thread that owns the control's handle,
@@ -162,31 +163,37 @@ public async Task InvokeAsync(Func<CancellationToken, ValueTask> callback, Cance
     {
         ArgumentNullException.ThrowIfNull(callback);
 
+        if (!IsHandleCreated)
+        {
+            throw new InvalidOperationException(SR.ErrorNoMarshalingThread);
+        }
+
         if (cancellationToken.IsCancellationRequested)
         {
             return;
         }
 
         TaskCompletionSource completion = new(TaskCreationOptions.RunContinuationsAsynchronously);
+        CancellationTokenRegistration registration = cancellationToken.Register(completion.SetCanceled, useSynchronizationContext: false);
 
-        using (cancellationToken.Register(completion.SetCanceled, useSynchronizationContext: false))
-        {
-            BeginInvoke(async () => await WrappedCallbackAsync().ConfigureAwait(false));
-            await completion.Task.ConfigureAwait(false);
-        }
+        BeginInvoke(async () => await WrappedCallbackAsync());
+        await completion.Task.ConfigureAwait(false);
 
         async Task WrappedCallbackAsync()
         {
             try
             {
-                if (cancellationToken.IsCancellationRequested)
+                using (registration)
                 {
-                    completion.TrySetCanceled(cancellationToken);
-                    return;
-                }
+                    if (cancellationToken.IsCancellationRequested)
+                    {
+                        completion.TrySetCanceled(cancellationToken);
+                        return;
+                    }
 
-                await callback(cancellationToken).ConfigureAwait(false);
-                completion.TrySetResult();
+                    await callback(cancellationToken).ConfigureAwait(false);
+                    completion.TrySetResult();
+                }
             }
             catch (Exception ex)
             {
@@ -226,25 +233,37 @@ public async Task<T> InvokeAsync<T>(Func<CancellationToken, ValueTask<T>> callba
     {
         ArgumentNullException.ThrowIfNull(callback);
 
+        if (!IsHandleCreated)
+        {
+            throw new InvalidOperationException(SR.ErrorNoMarshalingThread);
+        }
+
         if (cancellationToken.IsCancellationRequested)
         {
             return default!;
         }
 
         TaskCompletionSource<T> completion = new(TaskCreationOptions.RunContinuationsAsynchronously);
+        CancellationTokenRegistration registration = cancellationToken.Register(completion.SetCanceled, useSynchronizationContext: false);
 
-        using (cancellationToken.Register(completion.SetCanceled, useSynchronizationContext: false))
-        {
-            BeginInvoke(async () => await WrappedCallbackAsync().ConfigureAwait(false));
-            return await completion.Task.ConfigureAwait(false);
-        }
+        BeginInvoke(async () => await WrappedCallbackAsync());
+        return await completion.Task.ConfigureAwait(false);
 
         async Task WrappedCallbackAsync()
         {
             try
             {
-                var returnValue = await callback(cancellationToken).ConfigureAwait(false);
-                completion.TrySetResult(returnValue);
+                using (registration)
+                {
+                    if (cancellationToken.IsCancellationRequested)
+                    {
+                        completion.TrySetCanceled(cancellationToken);
+                        return;
+                    }
+
+                    T returnValue = await callback(cancellationToken).ConfigureAwait(false);
+                    completion.TrySetResult(returnValue);
+                }
             }
             catch (Exception ex)
             {