CA2213:Disposable fields should be disposed and support for `DisposeCoreAsync` #6976

MartyIX · 2023-10-09T21:53:27Z

Attempts to fix #4950 but I don't have any clue if the approach of the PR is correct or not.

However, this seems to be in line with https://learn.microsoft.com/en-us/dotnet/standard/garbage-collection/implementing-disposeasync#implement-the-async-dispose-pattern except for naming DisposeCoreAsync vs DisposeAsyncCore:

public class ExampleAsyncDisposable : IAsyncDisposable
{
    private IAsyncDisposable? _example;

    public ExampleAsyncDisposable() =>
        _example = new NoopAsyncDisposable();

    public async ValueTask DisposeAsync()
    {
        await DisposeAsyncCore().ConfigureAwait(false);

        GC.SuppressFinalize(this);
    }

    protected virtual async ValueTask DisposeAsyncCore()
    {
        if (_example is not null)
        {
            await _example.DisposeAsync().ConfigureAwait(false);
        }

        _example = null;
    }
}

Somewhat unrelated: I created a PR in vs-threading repo where I claimed that DisposeAsyncCore seemed to be the correct name for the method but this repo uses DisposeCoreAsync (AFAIK). It's confusing.

codecov · 2023-10-09T22:18:59Z

Codecov Report

Merging #6976 (a907d86) into main (8b1675a) will increase coverage by 0.00%.
Report is 59 commits behind head on main.
The diff coverage is 100.00%.

❗ Current head a907d86 differs from pull request most recent head 905cc3f. Consider uploading reports for the commit 905cc3f to get more accurate results

@@           Coverage Diff            @@
##             main    #6976    +/-   ##
========================================
  Coverage   96.42%   96.43%            
========================================
  Files        1410     1412     +2     
  Lines      335956   336528   +572     
  Branches    11095    11119    +24     
========================================
+ Hits       323956   324527   +571     
+ Misses       9207     9200     -7     
- Partials     2793     2801     +8

MartyIX · 2023-10-10T06:26:12Z

@Youssef1313 @mavasani Any feedback please?

src/Utilities/Compiler/Extensions/IMethodSymbolExtensions.cs

mavasani · 2023-10-10T08:17:15Z

Implementation of the fix looks fine to me, but I am not familiar with the semantics and naming requirements of the API for recommended dispose patterns. I'll let someone from the runtime team comment on it - @buyaa-n @carlossanlop @stephentoub @jeffhandley

MartyIX · 2023-10-13T14:00:47Z

Any feedback @buyaa-n @carlossanlop @stephentoub @jeffhandley please?

MartyIX · 2023-10-28T16:46:01Z

Friendly ping. Any feedback @buyaa-n @carlossanlop @stephentoub @jeffhandley please?

buyaa-n · 2023-10-30T05:13:22Z

Sorry for late reply @MartyIX, the latest Framework Design Guidelines suggests the name DisposeAsyncCore, so we should use DisposeAsyncCore.

I have never seen DisposeCoreAsync usage, though got 2 hits from source.net search, seems it is rare but used, probably only in old code. Not sure if we should cover both names.

MartyIX · 2023-10-30T18:32:33Z

@buyaa-n I can see in this repo:

https://github.com/dotnet/roslyn-analyzers/blob/main/src/NetAnalyzers/Core/Microsoft.NetCore.Analyzers/Runtime/DisposeMethodsShouldCallBaseClassDispose.cs

roslyn-analyzers/src/Utilities/Compiler/DisposeMethodKind.cs

Lines 31 to 35 in cf0cf55

    
           /// <summary> 
        
           /// An overridden method named DisposeCoreAsync that takes a single Boolean parameter and returns Task, as 
        
           /// is used when implementing the standard DisposeAsync pattern. 
        
           /// </summary> 
        
           DisposeCoreAsync,

So IMHO this repo supports DisposeCoreAsync and not DisposeAsyncCore. So I think you are right that DisposeAsyncCore is the proper name but that name might not play well with other analyzers.

probably only in old code. Not sure if we should cover both names.

Not necessarily, I found

So I think that Github Search just does not return all results as one might expect and it might be more used (not by majority but by some non-trivial minority of users).

@buyaa-n Any next step idea?

buyaa-n · 2023-10-30T19:27:08Z

Thanks @MartyIX, definitely we need to support both names. Looks we could just adjust the name check in HasOverriddenDisposeCoreAsyncMethodSignature and HasVirtualDisposeCoreAsyncMethodSignature, plus update the doc/comments that it covers both versions. Doesn't not necessarily need to change the method name and Enum member name DisposeCoreAsync, what you think? I'll leave that up to you and @mavasani.

mavasani · 2023-10-31T04:22:34Z

Thanks @MartyIX, definitely we need to support both names. Looks we could just adjust the name check in HasOverriddenDisposeCoreAsyncMethodSignature and HasVirtualDisposeCoreAsyncMethodSignature, plus update the doc/comments that it covers both versions. Doesn't not necessarily need to change the method name and Enum member name DisposeCoreAsync, what you think? I'll leave that up to you and @mavasani.

Agree with all of @buyaa-n's assessment.

MartyIX · 2023-11-03T10:10:05Z

I have updated the code based on the @buyaa-n's suggestion.

I'm struggling with the VB test though. Does anyone know how to fix https://github.com/dotnet/roslyn-analyzers/pull/6976/files#diff-5a72cda0b6e4fe072ec3ad611132009049afb0a1d445e15b2997688a9f82ac4eR3741 please?

...yzers/UnitTests/Microsoft.NetCore.Analyzers/Runtime/DisposableFieldsShouldBeDisposedTests.cs

MartyIX · 2023-11-07T11:13:48Z

@mavasani @buyaa-n Could you please check the latest version of the PR?

I'm having difficulty with the VB test but then I'm not sure if it is required at all.

paulomorgado · 2023-11-07T11:18:53Z

@mavasani @buyaa-n Could you please check the latest version of the PR?

I'm having difficulty with the VB test but then I'm not sure if it is required at all.

What VB code are you having issues with?

MartyIX · 2023-11-07T11:32:45Z

@mavasani @buyaa-n Could you please check the latest version of the PR?
I'm having difficulty with the VB test but then I'm not sure if it is required at all.

What VB code are you having issues with?

Please see #6976 (comment). It's commented out. I can't figure out how to rewrite C# code above the commented out VB code.

paulomorgado · 2023-11-07T11:55:28Z

@mavasani @buyaa-n Could you please check the latest version of the PR?
I'm having difficulty with the VB test but then I'm not sure if it is required at all.

What VB code are you having issues with?

Please see #6976 (comment). It's commented out. I can't figure out how to rewrite C# code above the commented out VB code.

It would help if you said what particular line of code is getting that error.

Looks like Visual Basic's Asynchronous programming with Async and Await does not support ValueTask.

MartyIX · 2023-11-07T11:59:18Z

This line is problematic: https://github.com/dotnet/roslyn-analyzers/pull/6976/files#diff-5a72cda0b6e4fe072ec3ad611132009049afb0a1d445e15b2997688a9f82ac4eR3784

MartyIX · 2023-11-07T12:01:14Z

Looks like Visual Basic's Asynchronous programming with Async and Await does not support ValueTask.

Yes, something like this. Btw, not even MSVS did give me a useful suggestion how to fix my VB code.

MartyIX · 2023-11-07T13:32:24Z

I removed the VB test.

mavasani · 2023-11-08T03:51:20Z

@buyaa-n Please review the PR and merge if it looks good to you.

src/Utilities/Compiler/Extensions/IMethodSymbolExtensions.cs

Co-authored-by: Buyaa Namnan <buyankhishig.namnan@microsoft.com>

src/Utilities/Compiler/Extensions/IMethodSymbolExtensions.cs

Co-authored-by: Buyaa Namnan <buyankhishig.namnan@microsoft.com>

buyaa-n

LGTM, thank you @MartyIX

WIP

574e949

github-actions bot added the Community label Oct 9, 2023

mavasani reviewed Oct 10, 2023

View reviewed changes

src/Utilities/Compiler/Extensions/IMethodSymbolExtensions.cs Outdated Show resolved Hide resolved

mavasani reviewed Oct 10, 2023

View reviewed changes

src/Utilities/Compiler/Extensions/IMethodSymbolExtensions.cs Outdated Show resolved Hide resolved

feedback

2975f53

feedback

e3c71e4

MartyIX marked this pull request as ready for review November 7, 2023 11:11

MartyIX requested a review from a team as a code owner November 7, 2023 11:11

MartyIX commented Nov 7, 2023

View reviewed changes

...yzers/UnitTests/Microsoft.NetCore.Analyzers/Runtime/DisposableFieldsShouldBeDisposedTests.cs Outdated Show resolved Hide resolved

Remove VB test

a907d86

MartyIX requested a review from mavasani November 7, 2023 18:52

mavasani approved these changes Nov 8, 2023

View reviewed changes

buyaa-n reviewed Nov 8, 2023

View reviewed changes

src/Utilities/Compiler/Extensions/IMethodSymbolExtensions.cs Outdated Show resolved Hide resolved

Update src/Utilities/Compiler/Extensions/IMethodSymbolExtensions.cs

4482368

Co-authored-by: Buyaa Namnan <buyankhishig.namnan@microsoft.com>

buyaa-n reviewed Nov 8, 2023

View reviewed changes

src/Utilities/Compiler/Extensions/IMethodSymbolExtensions.cs Outdated Show resolved Hide resolved

Update src/Utilities/Compiler/Extensions/IMethodSymbolExtensions.cs

905cc3f

Co-authored-by: Buyaa Namnan <buyankhishig.namnan@microsoft.com>

buyaa-n approved these changes Nov 8, 2023

View reviewed changes

buyaa-n enabled auto-merge (squash) November 8, 2023 19:10

buyaa-n merged commit b924542 into dotnet:main Nov 8, 2023
10 of 11 checks passed

MartyIX deleted the feature/DisposeCoreAsync branch November 8, 2023 19:32

MartyIX mentioned this pull request Apr 5, 2024

Which version users with EnableNETAnalyzers actually use? #7278

Closed

MartyIX mentioned this pull request May 16, 2024

CA2213 Should Not Give False Positives for classes implementing IAsyncDisposable #6703

Open

MartyIX mentioned this pull request Jul 7, 2024

CA2213: Handle overriden DisposeCoreAsync / DisposeAsyncCore #7347

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

CA2213:Disposable fields should be disposed and support for `DisposeCoreAsync` #6976

CA2213:Disposable fields should be disposed and support for `DisposeCoreAsync` #6976

MartyIX commented Oct 9, 2023 •

edited

Loading

codecov bot commented Oct 9, 2023 •

edited

Loading

MartyIX commented Oct 10, 2023

mavasani commented Oct 10, 2023

MartyIX commented Oct 13, 2023

MartyIX commented Oct 28, 2023

buyaa-n commented Oct 30, 2023

MartyIX commented Oct 30, 2023

buyaa-n commented Oct 30, 2023

mavasani commented Oct 31, 2023

MartyIX commented Nov 3, 2023

MartyIX commented Nov 7, 2023

paulomorgado commented Nov 7, 2023

MartyIX commented Nov 7, 2023

paulomorgado commented Nov 7, 2023

MartyIX commented Nov 7, 2023

MartyIX commented Nov 7, 2023

MartyIX commented Nov 7, 2023

mavasani commented Nov 8, 2023

buyaa-n left a comment

CA2213:Disposable fields should be disposed and support for DisposeCoreAsync #6976

CA2213:Disposable fields should be disposed and support for DisposeCoreAsync #6976

Conversation

MartyIX commented Oct 9, 2023 • edited Loading

codecov bot commented Oct 9, 2023 • edited Loading

Codecov Report

MartyIX commented Oct 10, 2023

mavasani commented Oct 10, 2023

MartyIX commented Oct 13, 2023

MartyIX commented Oct 28, 2023

buyaa-n commented Oct 30, 2023

MartyIX commented Oct 30, 2023

buyaa-n commented Oct 30, 2023

mavasani commented Oct 31, 2023

MartyIX commented Nov 3, 2023

MartyIX commented Nov 7, 2023

paulomorgado commented Nov 7, 2023

MartyIX commented Nov 7, 2023

paulomorgado commented Nov 7, 2023

MartyIX commented Nov 7, 2023

MartyIX commented Nov 7, 2023

MartyIX commented Nov 7, 2023

mavasani commented Nov 8, 2023

buyaa-n left a comment

Choose a reason for hiding this comment

CA2213:Disposable fields should be disposed and support for `DisposeCoreAsync` #6976

CA2213:Disposable fields should be disposed and support for `DisposeCoreAsync` #6976

MartyIX commented Oct 9, 2023 •

edited

Loading

codecov bot commented Oct 9, 2023 •

edited

Loading