Skip to content

Commit

Permalink
Merge pull request #7347 from MartyIX/feature/2024-07-07-CA2213-override
Browse files Browse the repository at this point in the history
CA2213: Handle overriden `DisposeCoreAsync` / `DisposeAsyncCore`
  • Loading branch information
Evangelink committed Aug 6, 2024
2 parents b70b320 + 3c81f1d commit 3211f48
Show file tree
Hide file tree
Showing 2 changed files with 93 additions and 4 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -3739,6 +3739,95 @@ public async ValueTask DisposeAsync()
}.RunAsync();
}

[Fact]
public async Task DisposeCoreAsync_Override_NoDiagnosticAsync()
{
await new VerifyCS.Test
{
ReferenceAssemblies = AdditionalMetadataReferences.DefaultWithAsyncInterfaces,
TestCode = @"
using System;
using System.Threading.Tasks;
class A : IAsyncDisposable
{
private readonly object disposedValueLock = new object();
private bool disposedValue;
private readonly Inner innerA;
public A()
{
innerA = new Inner();
}
protected virtual async ValueTask DisposeCoreAsync()
{
lock (disposedValueLock)
{
if (disposedValue)
{
return;
}
disposedValue = true;
}
await innerA.DisposeAsync().ConfigureAwait(false);
}
public ValueTask DisposeAsync()
{
return default(ValueTask);
}
}
class B : A
{
private readonly object disposedValueLock = new object();
private bool disposedValue;
// Newly, we want to test that no diagnostic is reported on this line.
private readonly Inner innerB;
public B() : base()
{
innerB = new Inner();
}
protected override async ValueTask DisposeCoreAsync()
{
lock (disposedValueLock)
{
if (disposedValue)
{
return;
}
disposedValue = true;
}
await innerB.DisposeAsync().ConfigureAwait(false);
await base.DisposeCoreAsync().ConfigureAwait(false);
}
}
// Declares an IAsyncDisposable type.
class Inner : IAsyncDisposable
{
public Inner()
{
}
public ValueTask DisposeAsync()
{
return default(ValueTask);
}
}
"
}.RunAsync();
}

[Fact, WorkItem(5099, "https://github.com/dotnet/roslyn-analyzers/issues/5099")]
public async Task OwnDisposableButDoesNotOverrideDisposableMember_Dispose()
{
Expand Down
8 changes: 4 additions & 4 deletions src/Utilities/Compiler/Extensions/IMethodSymbolExtensions.cs
Original file line number Diff line number Diff line change
Expand Up @@ -301,13 +301,13 @@ private static bool HasOverriddenDisposeCoreAsyncMethodSignature(this IMethodSym
}

/// <summary>
/// Checks if the given method has the signature "virtual ValueTask DisposeCoreAsync()" or "virtual ValueTask DisposeAsyncCore()".
/// Checks if the given method has the signature "{virtual|override} ValueTask DisposeCoreAsync()" or "{virtual|override} ValueTask DisposeAsyncCore()".
/// </summary>
private static bool HasVirtualDisposeCoreAsyncMethodSignature(this IMethodSymbol method, [NotNullWhen(returnValue: true)] INamedTypeSymbol? valueTask)
private static bool HasVirtualOrOverrideDisposeCoreAsyncMethodSignature(this IMethodSymbol method, [NotNullWhen(returnValue: true)] INamedTypeSymbol? valueTask)
{
return (method.Name == "DisposeAsyncCore" || method.Name == "DisposeCoreAsync") &&
method.MethodKind == MethodKind.Ordinary &&
method.IsVirtual &&
(method.IsVirtual || method.IsOverride) &&
SymbolEqualityComparer.Default.Equals(method.ReturnType, valueTask) &&
method.Parameters.Length == 0;
}
Expand Down Expand Up @@ -363,7 +363,7 @@ public static DisposeMethodKind GetDisposeMethodKind(
{
return DisposeMethodKind.DisposeCoreAsync;
}
else if (method.HasVirtualDisposeCoreAsyncMethodSignature(valueTask))
else if (method.HasVirtualOrOverrideDisposeCoreAsyncMethodSignature(valueTask))
{
return DisposeMethodKind.DisposeCoreAsync;
}
Expand Down

0 comments on commit 3211f48

Please sign in to comment.