Skip to content
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

Jump to bottom

optimize FeatureDefinitionAnalyzer #938

Merged
merged 3 commits into from
Nov 21, 2023
Merged

optimize FeatureDefinitionAnalyzer #938

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
6bf3514
optimize FeatureDefinitionAnalyzer
omsmith Nov 21, 2023
3396d62
switch
omsmith Nov 21, 2023
f20b07b
tweak
omsmith Nov 21, 2023
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
54 changes: 25 additions & 29 deletions src/D2L.CodeStyle.Analyzers/ApiUsage/LaunchDarkly/FeatureDefinitionAnalyzer.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
using System.Collections.Immutable;
using D2L.CodeStyle.Analyzers.Extensions;
using Microsoft.CodeAnalysis;
using Microsoft.CodeAnalysis.CSharp;
using Microsoft.CodeAnalysis.CSharp.Syntax;
using Microsoft.CodeAnalysis.Diagnostics;

namespace D2L.CodeStyle.Analyzers.ApiUsage.LaunchDarkly {
Expand All @@ -11,13 +9,6 @@ internal sealed class FeatureDefinitionAnalyzer : DiagnosticAnalyzer {

public const string FeatureDefinitionFullName = "D2L.LP.LaunchDarkly.FeatureDefinition`1";

private static readonly ImmutableHashSet<string> ValidTypes = ImmutableHashSet.Create<string>(
"int",
"bool",
"string",
"float"
);

public override ImmutableArray<DiagnosticDescriptor> SupportedDiagnostics => ImmutableArray.Create(
Diagnostics.InvalidLaunchDarklyFeatureDefinition
);
Expand All @@ -38,49 +29,54 @@ private void RegisterAnalysis( CompilationStartAnalysisContext context ) {
return;
}

context.RegisterSyntaxNodeAction(
c => AnalyzeSimpleBaseType( c, featureDefinitionType ),
SyntaxKind.SimpleBaseType
);
context.RegisterSymbolAction(
c => AnalyzeMaybeSubtype( c, featureDefinitionType ),
SymbolKind.NamedType
);
}

private static void AnalyzeSimpleBaseType(
SyntaxNodeAnalysisContext context,
private static void AnalyzeMaybeSubtype(
SymbolAnalysisContext context,
INamedTypeSymbol featureDefinitionType
) {

SimpleBaseTypeSyntax baseTypeSyntax = (SimpleBaseTypeSyntax)context.Node;
SymbolInfo baseTypeSymbol = context.SemanticModel.GetSymbolInfo( baseTypeSyntax.Type, context.CancellationToken );
INamedTypeSymbol maybeSubtype = (INamedTypeSymbol)context.Symbol;

INamedTypeSymbol? baseSymbol = ( baseTypeSymbol.Symbol as INamedTypeSymbol );
if( baseSymbol.IsNullOrErrorType() ) {
if( maybeSubtype.BaseType is null ) {
return;
}

ISymbol originalSymbol = baseSymbol.OriginalDefinition;
if( originalSymbol.IsNullOrErrorType() ) {
if( !SymbolEqualityComparer.Default.Equals( maybeSubtype.BaseType.OriginalDefinition, featureDefinitionType ) ) {
return;
}

if( !originalSymbol.Equals( featureDefinitionType, SymbolEqualityComparer.Default ) ) {
return;
}
ISymbol valueTypeSymbol = maybeSubtype.BaseType.TypeArguments[ 0 ];

ISymbol valueTypeSymbol = baseSymbol.TypeArguments[ 0 ];
if( valueTypeSymbol.IsNullOrErrorType() ) {
return;
}

string valueType = valueTypeSymbol.ToDisplayString();
if( ValidTypes.Contains( valueType ) ) {
if( valueTypeSymbol is INamedTypeSymbol namedValueType
&& IsValidType( namedValueType )
) {
return;
}

var (typeSyntax, baseTypeSyntax) = maybeSubtype.ExpensiveGetSyntaxImplementingType( maybeSubtype.BaseType, context.Compilation, context.CancellationToken );

context.ReportDiagnostic(
Diagnostics.InvalidLaunchDarklyFeatureDefinition,
baseTypeSyntax.GetLocation(),
messageArgs: new[] { valueType }
location: baseTypeSyntax?.GetLocation() ?? typeSyntax?.Identifier.GetLocation() ?? Location.None,
messageArgs: new[] { valueTypeSymbol.ToDisplayString() }
);
}

private static bool IsValidType( INamedTypeSymbol valueType ) => valueType.SpecialType switch {
SpecialType.System_Int32 => true,
SpecialType.System_Boolean => true,
SpecialType.System_String => true,
SpecialType.System_Single => true,
_ => false
};
}
}
41 changes: 24 additions & 17 deletions tests/D2L.CodeStyle.Analyzers.Test/Specs/FeatureDefinitionAnalyzer.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,23 +8,30 @@ namespace SpecTests {
using System;
using D2L.LP.LaunchDarkly;

public sealed class ObjectDefinition :/* InvalidLaunchDarklyFeatureDefinition(long) */ FeatureDefinition<long> /**/{ }
public sealed class LongDefinition :/* InvalidLaunchDarklyFeatureDefinition(long) */ FeatureDefinition<long> /**/{ }
public sealed class ObjectDefinition :/* InvalidLaunchDarklyFeatureDefinition(System.TimeSpan) */ FeatureDefinition<TimeSpan> /**/{ }

public sealed class BoolDefinition : FeatureDefinition<bool> { }
public sealed class FloatDefinition : FeatureDefinition<float> { }
public sealed class IntDefinition : FeatureDefinition<int> { }
public sealed class StringDefinition : FeatureDefinition<string> { }

public sealed class BoolDefinition : FeatureDefinition<Boolean> { }
public sealed class FloatDefinition : FeatureDefinition<Single> { }
public sealed class IntDefinition : FeatureDefinition<Int32> { }
public sealed class StringDefinition : FeatureDefinition<String> { }

public sealed class BoolDefinition : FeatureDefinition<System.Boolean> { }
public sealed class FloatDefinition : FeatureDefinition<System.Single> { }
public sealed class IntDefinition : FeatureDefinition<System.Int32> { }
public sealed class StringDefinition : FeatureDefinition<System.String> { }
public sealed class GenericDefinition<T> : /* InvalidLaunchDarklyFeatureDefinition(T) */ FeatureDefinition<T> /**/ { }

namespace Keywords {
public sealed class BoolDefinition : FeatureDefinition<bool> { }
public sealed class FloatDefinition : FeatureDefinition<float> { }
public sealed class IntDefinition : FeatureDefinition<int> { }
public sealed class StringDefinition : FeatureDefinition<string> { }
}

namespace SystemType {
public sealed class BoolDefinition : FeatureDefinition<Boolean> { }
public sealed class FloatDefinition : FeatureDefinition<Single> { }
public sealed class IntDefinition : FeatureDefinition<Int32> { }
public sealed class StringDefinition : FeatureDefinition<String> { }
}

namespace QualifiedSystemType {
public sealed class BoolDefinition : FeatureDefinition<System.Boolean> { }
public sealed class FloatDefinition : FeatureDefinition<System.Single> { }
public sealed class IntDefinition : FeatureDefinition<System.Int32> { }
public sealed class StringDefinition : FeatureDefinition<System.String> { }
}
}

namespace MissingLaunchDarklyUsingStatement {
Expand All @@ -36,4 +43,4 @@ namespace UnresolvedValueType {
using D2L.LP.LaunchDarkly;

public sealed class ObjectDefinition : FeatureDefinition<YMCA> { }
}
}
Loading