VSTHRD012 wrongly reported on private/internal members #1111

Activity

1. Andrew Arnott (AArnott)

   added

   bug

   help wanted

   analyzers

   good first issue

   on Nov 10, 2022
2. sujitmahapatra commented on Oct 3, 2023

   

   Mr. Sujit (sujitmahapatra)

   on Oct 3, 2023

   More actions

   To address the issue where VSTHRD012 is reported when there is a private overload of a method with a JTF (JoinableTaskFactory) parameter, you can follow these steps:

   1. Identify the Problem: The issue seems to be related to the naming conflict between the public and private methods. When both methods have the same name, it triggers VSTHRD012.

   2. Rename the Private Method: To resolve this issue, you should rename the private method to something that does not conflict with the public method. Here's an example of how you can modify your code:

   static class Extensions
   {
       public static void OnMainThread(Action action) => OnMainThread(Factory, action);
       
       private static void RunOnMainThread(JoinableTaskFactory factory, Action action) => factory.Run(async delegate
       {
           await Factory.SwitchToMainThreadAsync();
           action();
       });
   }

   3. Update the Usage: After renaming the private method, you'll need to update any usage of the private method with the new name. In this case, you should change OnMainThread to RunOnMainThread:

   Extensions.RunOnMainThread(() => { }) // This should no longer report VSTHRD012

   4. Test and Verify: Ensure that the code now works as expected and that VSTHRD012 is no longer reported.

   By renaming the private method to something distinct from the public method, you avoid the naming conflict that was triggering the VSTHRD012 warning. This should resolve the issue as expected.
3. Andrew Arnott (AArnott)

   added a commit that references this issue on Oct 24, 2023

   Fix VSTHRD012 false positive due to inaccessible overloads

   ...

   This issue will close once commit cc63319 is merged into the 'main' branch.

   cc63319
4. Andrew Arnott (AArnott)

   self-assigned this

   on Oct 24, 2023
5. Andrew Arnott (AArnott)

   removed

   help wanted

   good first issue

   on Oct 24, 2023
6. Andrew Arnott (AArnott)

   closed this as completedin #1247on Oct 24, 2023