mirror of
https://github.com/jellyfin/jellyfin.git
synced 2026-01-15 15:48:03 +00:00
Fix sync disposal of async-created IAsyncDisposable objects (#14755)
Some checks failed
CodeQL / Analyze (csharp) (push) Has been cancelled
OpenAPI / OpenAPI - HEAD (push) Has been cancelled
OpenAPI / OpenAPI - BASE (push) Has been cancelled
OpenAPI / OpenAPI - Difference (push) Has been cancelled
OpenAPI / OpenAPI - Publish Unstable Spec (push) Has been cancelled
OpenAPI / OpenAPI - Publish Stable Spec (push) Has been cancelled
Tests / run-tests (macos-latest) (push) Has been cancelled
Tests / run-tests (ubuntu-latest) (push) Has been cancelled
Tests / run-tests (windows-latest) (push) Has been cancelled
Project Automation / Project board (push) Has been cancelled
Merge Conflict Labeler / Labeling (push) Has been cancelled
Stale PR Check / Check PRs with merge conflicts (push) Has been cancelled
Some checks failed
CodeQL / Analyze (csharp) (push) Has been cancelled
OpenAPI / OpenAPI - HEAD (push) Has been cancelled
OpenAPI / OpenAPI - BASE (push) Has been cancelled
OpenAPI / OpenAPI - Difference (push) Has been cancelled
OpenAPI / OpenAPI - Publish Unstable Spec (push) Has been cancelled
OpenAPI / OpenAPI - Publish Stable Spec (push) Has been cancelled
Tests / run-tests (macos-latest) (push) Has been cancelled
Tests / run-tests (ubuntu-latest) (push) Has been cancelled
Tests / run-tests (windows-latest) (push) Has been cancelled
Project Automation / Project board (push) Has been cancelled
Merge Conflict Labeler / Labeling (push) Has been cancelled
Stale PR Check / Check PRs with merge conflicts (push) Has been cancelled
This commit is contained in:
9
src/Jellyfin.CodeAnalysis/AnalyzerReleases.Shipped.md
Normal file
9
src/Jellyfin.CodeAnalysis/AnalyzerReleases.Shipped.md
Normal file
@@ -0,0 +1,9 @@
|
||||
; Shipped analyzer releases
|
||||
; https://github.com/dotnet/roslyn/blob/main/src/RoslynAnalyzers/Microsoft.CodeAnalysis.Analyzers/ReleaseTrackingAnalyzers.Help.md
|
||||
|
||||
## Release 1.0
|
||||
|
||||
### New Rules
|
||||
Rule ID | Category | Severity | Notes
|
||||
--------|----------|----------|-------
|
||||
JF0001 | Usage | Warning | Async-created IAsyncDisposable objects should use 'await using'
|
||||
82
src/Jellyfin.CodeAnalysis/AsyncDisposalPatternAnalyzer.cs
Normal file
82
src/Jellyfin.CodeAnalysis/AsyncDisposalPatternAnalyzer.cs
Normal file
@@ -0,0 +1,82 @@
|
||||
using System;
|
||||
using System.Collections.Immutable;
|
||||
using System.Linq;
|
||||
using Microsoft.CodeAnalysis;
|
||||
using Microsoft.CodeAnalysis.CSharp;
|
||||
using Microsoft.CodeAnalysis.CSharp.Syntax;
|
||||
using Microsoft.CodeAnalysis.Diagnostics;
|
||||
|
||||
namespace Jellyfin.CodeAnalysis;
|
||||
|
||||
/// <summary>
|
||||
/// Analyzer to detect sync disposal of async-created IAsyncDisposable objects.
|
||||
/// </summary>
|
||||
[DiagnosticAnalyzer(LanguageNames.CSharp)]
|
||||
public class AsyncDisposalPatternAnalyzer : DiagnosticAnalyzer
|
||||
{
|
||||
/// <summary>
|
||||
/// Diagnostic descriptor for sync disposal of async-created IAsyncDisposable objects.
|
||||
/// </summary>
|
||||
public static readonly DiagnosticDescriptor AsyncDisposableSyncDisposal = new(
|
||||
id: "JF0001",
|
||||
title: "Async-created IAsyncDisposable objects should use 'await using'",
|
||||
messageFormat: "Using 'using' with async-created IAsyncDisposable object '{0}'. Use 'await using' instead to prevent resource leaks.",
|
||||
category: "Usage",
|
||||
defaultSeverity: DiagnosticSeverity.Error,
|
||||
isEnabledByDefault: true,
|
||||
description: "Objects that implement IAsyncDisposable and are created using 'await' should be disposed using 'await using' to prevent resource leaks.");
|
||||
|
||||
/// <inheritdoc/>
|
||||
public override ImmutableArray<DiagnosticDescriptor> SupportedDiagnostics => [AsyncDisposableSyncDisposal];
|
||||
|
||||
/// <inheritdoc/>
|
||||
public override void Initialize(AnalysisContext context)
|
||||
{
|
||||
context.ConfigureGeneratedCodeAnalysis(GeneratedCodeAnalysisFlags.None);
|
||||
context.EnableConcurrentExecution();
|
||||
context.RegisterSyntaxNodeAction(AnalyzeUsingStatement, SyntaxKind.UsingStatement);
|
||||
}
|
||||
|
||||
private static void AnalyzeUsingStatement(SyntaxNodeAnalysisContext context)
|
||||
{
|
||||
var usingStatement = (UsingStatementSyntax)context.Node;
|
||||
|
||||
// Skip 'await using' statements
|
||||
if (usingStatement.AwaitKeyword.IsKind(SyntaxKind.AwaitKeyword))
|
||||
{
|
||||
return;
|
||||
}
|
||||
|
||||
// Check if there's a variable declaration
|
||||
if (usingStatement.Declaration?.Variables is null)
|
||||
{
|
||||
return;
|
||||
}
|
||||
|
||||
foreach (var variable in usingStatement.Declaration.Variables)
|
||||
{
|
||||
if (variable.Initializer?.Value is AwaitExpressionSyntax awaitExpression)
|
||||
{
|
||||
var typeInfo = context.SemanticModel.GetTypeInfo(awaitExpression);
|
||||
var type = typeInfo.Type;
|
||||
|
||||
if (type is not null && ImplementsIAsyncDisposable(type))
|
||||
{
|
||||
var diagnostic = Diagnostic.Create(
|
||||
AsyncDisposableSyncDisposal,
|
||||
usingStatement.GetLocation(),
|
||||
type.Name);
|
||||
|
||||
context.ReportDiagnostic(diagnostic);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
private static bool ImplementsIAsyncDisposable(ITypeSymbol type)
|
||||
{
|
||||
return type.AllInterfaces.Any(i =>
|
||||
string.Equals(i.Name, "IAsyncDisposable", StringComparison.Ordinal)
|
||||
&& string.Equals(i.ContainingNamespace?.ToDisplayString(), "System", StringComparison.Ordinal));
|
||||
}
|
||||
}
|
||||
17
src/Jellyfin.CodeAnalysis/Jellyfin.CodeAnalysis.csproj
Normal file
17
src/Jellyfin.CodeAnalysis/Jellyfin.CodeAnalysis.csproj
Normal file
@@ -0,0 +1,17 @@
|
||||
<Project Sdk="Microsoft.NET.Sdk">
|
||||
|
||||
<PropertyGroup>
|
||||
<TargetFramework>netstandard2.0</TargetFramework>
|
||||
<LangVersion>latest</LangVersion>
|
||||
<IncludeBuildOutput>false</IncludeBuildOutput>
|
||||
<GeneratePackageOnBuild>false</GeneratePackageOnBuild>
|
||||
<EnforceExtendedAnalyzerRules>true</EnforceExtendedAnalyzerRules>
|
||||
<GenerateDocumentationFile>true</GenerateDocumentationFile>
|
||||
</PropertyGroup>
|
||||
|
||||
<ItemGroup>
|
||||
<PackageReference Include="Microsoft.CodeAnalysis.CSharp" PrivateAssets="all" />
|
||||
<PackageReference Include="Microsoft.CodeAnalysis.Analyzers" PrivateAssets="all" />
|
||||
</ItemGroup>
|
||||
|
||||
</Project>
|
||||
Reference in New Issue
Block a user