Skip to content

Add exception for Utf8JsonReader/Writer to AZC0014 #8752

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
pshao25 merged 3 commits into from
Aug 14, 2024
Merged

Add exception for Utf8JsonReader/Writer to AZC0014 #8752

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1f6970c
update
Aug 1, 2024
add0c54
update
Aug 9, 2024
f8cf059
update
Aug 12, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions src/dotnet/Azure.ClientSdk.Analyzers/Azure.ClientSdk.Analyzers.Tests/AZC0014Tests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,8 @@ public class SomeClient


[Theory]
[InlineData("public void JsonModelWriteCore(Utf8JsonWriter writer) {}")]
[InlineData("public void JsonModelCreateCore(ref Utf8JsonReader reader) {}")]
[InlineData("internal class Class: System.IProgress<JsonElement> { public void Report (JsonElement value) {} }")]
[InlineData("public void Report(string value) {}")]
public async Task AZC0014NotProducedForNonPublicApisOrAllowedTypes(string usage)
Expand Down
15 changes: 14 additions & 1 deletion src/dotnet/Azure.ClientSdk.Analyzers/Azure.ClientSdk.Analyzers/BannedAssembliesAnalyzer.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,10 @@ static void CheckType(ISymbolAnalysisContext context, ITypeSymbol type, ISymbol
{
if (BannedAssemblies.Contains(type.ContainingAssembly.Name))
{
context.ReportDiagnostic(Diagnostic.Create(Descriptors.AZC0014, symbol.Locations.First(), BannedAssembliesMessageArgs), symbol);
if (!IsUtf8JsonReaderWriter(type))
{
context.ReportDiagnostic(Diagnostic.Create(Descriptors.AZC0014, symbol.Locations.First(), BannedAssembliesMessageArgs), symbol);
}
}

if (namedTypeSymbol.IsGenericType)
Expand Down Expand Up @@ -86,5 +89,15 @@ static void CheckType(ISymbolAnalysisContext context, ITypeSymbol type, ISymbol
break;
}
}

private static bool IsUtf8JsonReaderWriter(ITypeSymbol type)
{
return (type.Name == "Utf8JsonReader" || type.Name == "Utf8JsonWriter") && GetFullNamespace(type.ContainingNamespace) == "System.Text.Json";
}

private static string GetFullNamespace(INamespaceSymbol namespaceSymbol)
{
return namespaceSymbol.ContainingNamespace.Name == "" ? namespaceSymbol.Name : $"{GetFullNamespace(namespaceSymbol.ContainingNamespace)}.{namespaceSymbol.Name}";
}
}
}