vs-threading icon indicating copy to clipboard operation
vs-threading copied to clipboard

JoinableTaskContext.IsOnMainThread should satisfy VSTHRD010

Open zivkan opened this issue 2 years ago • 1 comments

Is your feature request related to a problem? Please describe.

Previously commented in another issue: https://github.com/microsoft/vs-threading/issues/272#issuecomment-387459857

I have a method I want to be free-threaded, but I have dependencies which are not. How I implement my method depends whether it's running on the main thread, or a background thread. Copying the example from the other issue:

public void NotAffinitized() {
  if (IsOnMainThread()) {
    // This incorrectly marks the enclosing method as affinitized, which then propagates
    SomeAffinitizedMethod();
  } else {
    SomeNonAffinitizedMethod();
  }
}

Describe the solution you'd like

No VSTHRD010 within the if block.

Describe alternatives you've considered

An await jtf.SwitchToMainThreadAsync(alwaysYield: false) does suppress the warning, but feels inefficient. Even if it's fast, it's still extra work that isn't necessary for program correctness, just to satisfy the analyzer.

Additional context

zivkan avatar Oct 29 '22 10:10 zivkan

Here's some test code that I believe should be made to work:

        var test = @"
using System.Threading.Tasks;
using Microsoft.VisualStudio.Shell;
using Microsoft.VisualStudio.Shell.Interop;
using Task = System.Threading.Tasks.Task;

class Test
{
    void Foo()
    {
        ThreadHelper.ThrowIfNotOnUIThread();
        IVsSolution solution = Package.GetGlobalService(typeof(SVsSolution)) as IVsSolution;
    }
    async Task FirstAsync()
    {
        if (ThreadHelper.JoinableTaskFactory.Context.IsOnMainThread)
        {
            Foo(); // this generates a warning, even though Reset() doesn't assert
        }
    }
}
";
        await CSVerify.VerifyAnalyzerAsync(test);

However, I haven't yet been able to get the product code to make the test pass. I don't have any experience with the Roslyn APIs, so it's a learning curve to contribute. As much as I'd love to get my own name in the commit history, if someone else can get this implemented before me, I'll be happy to be able to take advantage of the improvement.

zivkan avatar Oct 29 '22 10:10 zivkan