[v2] Fix issues from static analysis

henrikfroehling · Aug 12, 2024 · 3300dd1 · 3300dd1
1 parent 2fd0f4f
commit 3300dd1
Show file tree

Hide file tree

Showing 12 changed files with 71 additions and 85 deletions.
diff --git a/...ributes/Requests/TraktRequestParameter.cs → ...equests/TraktRequestParameterAttribute.cs b/...ributes/Requests/TraktRequestParameter.cs → ...equests/TraktRequestParameterAttribute.cs
@@ -1,7 +1,7 @@
 namespace TraktNET
 {
     [AttributeUsage(AttributeTargets.Property, AllowMultiple = false, Inherited = false)]
-    internal sealed class TraktRequestParameter() : Attribute
+    internal sealed class TraktRequestParameterAttribute() : Attribute
     {
         public bool UseCacheEfficientDateTime { get; set; }
     }

diff --git a/.../Attributes/Requests/TraktRequestQuery.cs → ...es/Requests/TraktRequestQueryAttribute.cs b/.../Attributes/Requests/TraktRequestQuery.cs → ...es/Requests/TraktRequestQueryAttribute.cs
@@ -1,7 +1,7 @@
 namespace TraktNET
 {
     [AttributeUsage(AttributeTargets.Property, AllowMultiple = false, Inherited = false)]
-    internal sealed class TraktRequestQuery(string? queryName = null) : Attribute
+    internal sealed class TraktRequestQueryAttribute(string? queryName = null) : Attribute
     {
         public string? QueryName { get; } = queryName;
 

diff --git a/src/libs/Trakt.NET/Internal/Contexts/TraktContext.cs b/src/libs/Trakt.NET/Internal/Contexts/TraktContext.cs
@@ -108,7 +108,7 @@ public static TraktContext CreateForSandbox(string clientID, string clientSecret
 
         internal HttpClientProvider HttpClientProvider { get; set; }
 
-        internal TraktContext(string clientID, string clientSecret)
+        protected TraktContext(string clientID, string clientSecret)
         {
             ID = Guid.NewGuid().ToString();
             ClientID = clientID;

diff --git a/src/libs/Trakt.NET/Internal/Requests/RequestErrorHandler.cs b/src/libs/Trakt.NET/Internal/Requests/RequestErrorHandler.cs
@@ -2,7 +2,7 @@
 
 namespace TraktNET
 {
-    internal sealed partial class RequestHandler
+    internal static partial class RequestHandler
     {
         private static async Task HandleErrorAsync(RequestBase request, HttpResponseMessage responseMessage, TraktResponseHeaders traktHeaders,
                                                    bool isInAuthorizationPolling, CancellationToken cancellationToken = default)
@@ -129,6 +129,10 @@ private static async Task HandleConflictErrorAsync(ExceptionParameters parameter
                     }
                     catch
                     {
+                        // Exception handling while handling an API exception is not considered.
+                        // This might change in the future, but for now just catch any exceptions.
+                        // In this case these might be JsonException or ArgumentNullException.
+                        // In either case the content is not valid.
                     }
                 }
 
@@ -158,6 +162,10 @@ private static async Task HandleRateLimitErrorAsync(ExceptionParameters paramete
                 }
                 catch
                 {
+                    // Exception handling while handling an API exception is not considered.
+                    // This might change in the future, but for now just catch any exceptions.
+                    // In this case these might be JsonException or ArgumentNullException.
+                    // In either case the content is not valid.
                 }
             }
 

diff --git a/src/libs/Trakt.NET/Internal/Requests/RequestHandler.cs b/src/libs/Trakt.NET/Internal/Requests/RequestHandler.cs
@@ -2,7 +2,7 @@
 
 namespace TraktNET
 {
-    internal sealed partial class RequestHandler
+    internal static partial class RequestHandler
     {
         internal static async Task<TraktResponse<TResponseContentType>> ExecuteSingleItemRequestAsync<TResponseContentType>(
             TraktContext context, RequestBase request, CancellationToken cancellationToken = default)
@@ -54,7 +54,11 @@ private static async Task<RequestResponse> ExecuteRequestAsync(TraktContext cont
                 await HandleErrorAsync(request, responseMessage, traktHeaders, false, cancellationToken).ConfigureAwait(false);
             }
 
+#if NET5_0_OR_GREATER
             Stream responseContentStream = await GetResponseContentStreamAsync(responseMessage, cancellationToken).ConfigureAwait(false);
+#else
+            Stream responseContentStream = await GetResponseContentStreamAsync(responseMessage).ConfigureAwait(false);
+#endif
 
             return new RequestResponse
             {
@@ -87,10 +91,11 @@ private static void AddRequestMessageHeaders(TraktContext context, RequestBase r
             request.Headers.Authorization = new AuthenticationHeaderValue(AuthenticationScheme, context.Authorization!.AccessToken ?? string.Empty);
         }
 
-        private static Task<Stream> GetResponseContentStreamAsync(HttpResponseMessage responseMessage, CancellationToken cancellationToken = default)
 #if NET5_0_OR_GREATER
+        private static Task<Stream> GetResponseContentStreamAsync(HttpResponseMessage responseMessage, CancellationToken cancellationToken = default)
             => responseMessage.Content.ReadAsStreamAsync(cancellationToken);
 #else
+        private static Task<Stream> GetResponseContentStreamAsync(HttpResponseMessage responseMessage)
             => responseMessage.Content.ReadAsStreamAsync();
 #endif
     }

diff --git a/src/libs/Trakt.NET/Internal/Requests/RequestHandlerResponseHeaderParser.cs b/src/libs/Trakt.NET/Internal/Requests/RequestHandlerResponseHeaderParser.cs
@@ -2,7 +2,7 @@
 
 namespace TraktNET
 {
-    internal sealed partial class RequestHandler
+    internal static partial class RequestHandler
     {
         private static TraktResponseHeaders ParseTraktResponseHeaders(HttpResponseHeaders responseHeaders)
         {

diff --git a/.../sourcegeneration/Trakt.NET.SourceGeneration/Enums/Generators/TraktEnumSourceGenerator.cs b/.../sourcegeneration/Trakt.NET.SourceGeneration/Enums/Generators/TraktEnumSourceGenerator.cs
@@ -16,13 +16,15 @@ namespace TraktNET.SourceGeneration.Enums
     public sealed class TraktEnumSourceGenerator : IIncrementalGenerator
     {
         private IncrementalValueProvider<KnownEnumSymbols> _knownEnumTypeSymbols;
-        private IncrementalValuesProvider<EnumGenerationSpecificationTuple> _enumGenerationSpecifications;
 
         public void Initialize(IncrementalGeneratorInitializationContext context)
         {
             _knownEnumTypeSymbols = context.CompilationProvider.Select(static (compilation, _) => new KnownEnumSymbols(compilation));
-            _enumGenerationSpecifications = CombineAndSelectEnumsWithAttribute(context);
-            context.RegisterSourceOutput(_enumGenerationSpecifications, ReportDiagnosticsAndEmitSource);
+
+            IncrementalValuesProvider<EnumGenerationSpecificationTuple> enumGenerationSpecifications =
+                CombineAndSelectEnumsWithAttribute(context);
+
+            context.RegisterSourceOutput(enumGenerationSpecifications, ReportDiagnosticsAndEmitSource);
         }
 
         private IncrementalValuesProvider<EnumGenerationSpecificationTuple> CombineAndSelectEnumsWithAttribute(

diff --git a/...ls/sourcegeneration/Trakt.NET.SourceGeneration/Enums/Parser/TraktEnumDeclarationParser.cs b/...ls/sourcegeneration/Trakt.NET.SourceGeneration/Enums/Parser/TraktEnumDeclarationParser.cs
@@ -66,7 +66,7 @@ private void GetEnumSymbolAndLocation(EnumDeclarationSyntax enumDeclaration, Sem
             _enumDeclarationSymbol = (INamedTypeSymbol?)semanticModel.GetDeclaredSymbol(enumDeclaration, cancellationToken);
             Debug.Assert(_enumDeclarationSymbol != null);
 
-            if (_enumDeclarationSymbol != null && _enumDeclarationSymbol.Locations.Length > 0)
+            if (_enumDeclarationSymbol?.Locations.Length > 0)
             {
                 _enumDeclarationLocation = _enumDeclarationSymbol.Locations[0];
             }
@@ -85,39 +85,33 @@ private bool ParseEnumAttributes(INamedTypeSymbol enumTypeSymbol, CancellationTo
                 if (SymbolEqualityComparer.Default.Equals(attributeClass, _knownEnumSymbols.SystemFlagsAttributeType))
                 {
                     _hasFlagsAttribute = true;
-                }                
+                }
                 else if (SymbolEqualityComparer.Default.Equals(attributeClass, _knownEnumSymbols.TraktEnumAttributeType))
                 {
                     var namedArguments = attributeData.NamedArguments.ToImmutableDictionary();
 
-                    if (namedArguments.TryGetValue(EnumConstants.TraktEnumPropertyQueryName, out TypedConstant queryNameConstant))
+                    if (namedArguments.TryGetValue(EnumConstants.TraktEnumPropertyQueryName, out TypedConstant queryNameConstant)
+                        && queryNameConstant.Value is string queryName)
                     {
-                        if (queryNameConstant.Value is string queryName)
+                        if (string.IsNullOrEmpty(queryName))
                         {
-                            if (string.IsNullOrEmpty(queryName))
-                            {
-                                ReportDiagnostic(DiagnosticDescriptors.InvalidQueryNameValue);
-                                return false;
-                            }
-
-                            _queryName = queryName;
+                            ReportDiagnostic(DiagnosticDescriptors.InvalidQueryNameValue);
+                            return false;
                         }
+
+                        _queryName = queryName;
                     }
 
-                    if (namedArguments.TryGetValue(EnumConstants.TraktEnumPropertyHasPathSupport, out TypedConstant hasPathSupportConstant))
+                    if (namedArguments.TryGetValue(EnumConstants.TraktEnumPropertyHasPathSupport, out TypedConstant hasPathSupportConstant)
+                        && hasPathSupportConstant.Value is bool hasPathSupport)
                     {
-                        if (hasPathSupportConstant.Value is bool hasPathSupport)
-                        {
-                            _hasPathSupport = hasPathSupport;
-                        }
+                        _hasPathSupport = hasPathSupport;
                     }
 
-                    if (namedArguments.TryGetValue(EnumConstants.TraktEnumPropertyHasQuerySupport, out TypedConstant hasQuerySupportConstant))
+                    if (namedArguments.TryGetValue(EnumConstants.TraktEnumPropertyHasQuerySupport, out TypedConstant hasQuerySupportConstant)
+                        && hasQuerySupportConstant.Value is bool hasQuerySupport)
                     {
-                        if (hasQuerySupportConstant.Value is bool hasQuerySupport)
-                        {
-                            _hasQuerySupport = hasQuerySupport;
-                        }
+                        _hasQuerySupport = hasQuerySupport;
                     }
                 }
             }

diff --git a/src/tools/sourcegeneration/Trakt.NET.SourceGeneration/Models/DiagnosticInfo.cs b/src/tools/sourcegeneration/Trakt.NET.SourceGeneration/Models/DiagnosticInfo.cs
@@ -10,19 +10,12 @@ namespace TraktNET.SourceGeneration.Models
         public Location? Location { get; private init; }
 
         public static DiagnosticInfo Create(DiagnosticDescriptor descriptor, Location? location)
-        {
-            Location? trimmedLocation = location == null ? null : GetTrimmedLocation(location);
-
-            return new DiagnosticInfo
+            => new()
             {
                 Descriptor = descriptor,
                 Location = location
             };
 
-            static Location? GetTrimmedLocation(Location location)
-                => Location.Create(location.SourceTree?.FilePath ?? string.Empty, location.SourceSpan, location.GetLineSpan().Span);
-        }
-
         public Diagnostic CreateDiagnostic() => Diagnostic.Create(Descriptor, Location);
 
         public override bool Equals(object obj) => obj is DiagnosticInfo diagnosticInfo && Equals(diagnosticInfo);

diff --git a/src/tools/sourcegeneration/Trakt.NET.SourceGeneration/Requests/Parser/TraktRequestParser.cs b/src/tools/sourcegeneration/Trakt.NET.SourceGeneration/Requests/Parser/TraktRequestParser.cs
@@ -167,12 +167,10 @@ private bool ParseRequestProperty(IPropertySymbol propertySymbol, ImmutableArray
 
                     var namedArguments = attributeData.NamedArguments.ToImmutableDictionary();
 
-                    if (namedArguments.TryGetValue(RequestConstants.TraktRequestParameterOrQueryUseCacheEfficientDateTimeName, out TypedConstant useCacheEfficientDateTimeConstant))
+                    if (namedArguments.TryGetValue(RequestConstants.TraktRequestParameterOrQueryUseCacheEfficientDateTimeName, out TypedConstant useCacheEfficientDateTimeConstant)
+                        && useCacheEfficientDateTimeConstant.Value is bool useCacheEfficientDateTimeValue)
                     {
-                        if (useCacheEfficientDateTimeConstant.Value is bool useCacheEfficientDateTimeValue)
-                        {
-                            useCacheEfficientDateTime = useCacheEfficientDateTimeValue;
-                        }
+                        useCacheEfficientDateTime = useCacheEfficientDateTimeValue;
                     }
                 }
                 else if (SymbolEqualityComparer.Default.Equals(attributeClass, _knownRequestSymbols.TraktRequestQueryAttributeType))
@@ -199,12 +197,10 @@ private bool ParseRequestProperty(IPropertySymbol propertySymbol, ImmutableArray
 
                     var namedArguments = attributeData.NamedArguments.ToImmutableDictionary();
 
-                    if (namedArguments.TryGetValue(RequestConstants.TraktRequestParameterOrQueryUseCacheEfficientDateTimeName, out TypedConstant useCacheEfficientDateTimeConstant))
+                    if (namedArguments.TryGetValue(RequestConstants.TraktRequestParameterOrQueryUseCacheEfficientDateTimeName, out TypedConstant useCacheEfficientDateTimeConstant)
+                        && useCacheEfficientDateTimeConstant.Value is bool useCacheEfficientDateTimeValue)
                     {
-                        if (useCacheEfficientDateTimeConstant.Value is bool useCacheEfficientDateTimeValue)
-                        {
-                            useCacheEfficientDateTime = useCacheEfficientDateTimeValue;
-                        }
+                        useCacheEfficientDateTime = useCacheEfficientDateTimeValue;
                     }
                 }
             }
@@ -342,7 +338,7 @@ private void GetClassSymbolAndLocation(ClassDeclarationSyntax classDeclaration,
             _requestClassDeclarationSymbol = semanticModel.GetDeclaredSymbol(classDeclaration, cancellationToken);
             Debug.Assert(_requestClassDeclarationSymbol != null);
 
-            if (_requestClassDeclarationSymbol != null && _requestClassDeclarationSymbol.Locations.Length > 0)
+            if (_requestClassDeclarationSymbol?.Locations.Length > 0)
             {
                 _requestClassDeclarationLocation = _requestClassDeclarationSymbol.Locations[0];
             }
@@ -369,42 +365,34 @@ private bool ParseRequestAttribute(AttributeData attributeData, Location? attrib
 
             var namedArguments = attributeData.NamedArguments.ToImmutableDictionary();
 
-            if (_knownRequestSymbols.TraktExtendedInfoEnumType != null)
+            if (_knownRequestSymbols.TraktExtendedInfoEnumType != null
+                && namedArguments.TryGetValue(RequestConstants.TraktRequestPropertySupportsExtendedInfoName, out TypedConstant supportsExtendedInfoConstant)
+                && supportsExtendedInfoConstant.Value is bool supportsExtendedInfo)
             {
-                if (namedArguments.TryGetValue(RequestConstants.TraktRequestPropertySupportsExtendedInfoName, out TypedConstant supportsExtendedInfoConstant))
-                {
-                    if (supportsExtendedInfoConstant.Value is bool supportsExtendedInfo)
-                    {
-                        _requestSupportsExtendedInfo = supportsExtendedInfo;
-                    }
-                }
+                _requestSupportsExtendedInfo = supportsExtendedInfo;
             }
 
-            if (namedArguments.TryGetValue(RequestConstants.TraktRequestPropertySupportsPaginationName, out TypedConstant supportsPaginationConstant))
+            if (namedArguments.TryGetValue(RequestConstants.TraktRequestPropertySupportsPaginationName, out TypedConstant supportsPaginationConstant)
+                && supportsPaginationConstant.Value is bool supportsPagination)
             {
-                if (supportsPaginationConstant.Value is bool supportsPagination)
-                {
-                    _requestSupportsPagination = supportsPagination;
-                }
+                _requestSupportsPagination = supportsPagination;
             }
 
             if (_knownRequestSymbols.TraktOAuthRequirementEnumType != null)
             {
                 if (namedArguments.TryGetValue(RequestConstants.TraktRequestPropertyOAuthRequirementName, out TypedConstant oauthRequirementConstant))
                 {
-                    if (SymbolEqualityComparer.Default.Equals(oauthRequirementConstant.Type, _knownRequestSymbols.TraktOAuthRequirementEnumType))
+                    if (SymbolEqualityComparer.Default.Equals(oauthRequirementConstant.Type, _knownRequestSymbols.TraktOAuthRequirementEnumType)
+                        && oauthRequirementConstant.Value is int requirementValue)
                     {
-                        if (oauthRequirementConstant.Value is int requirementValue)
-                        {
-                            _requestHasOAuthRequirementDefined = _knownRequestSymbols.TraktOAuthRequirementValues.Count > 0;
-
-                            IFieldSymbol? enumField = _knownRequestSymbols.TraktOAuthRequirementValues
-                                .FirstOrDefault(x => x.ConstantValue is int enumValue && enumValue == requirementValue);
+                        _requestHasOAuthRequirementDefined = _knownRequestSymbols.TraktOAuthRequirementValues.Count > 0;
 
-                            if (enumField != null)
-                            {
-                                _requestOAuthRequirementValue = enumField.Name;
-                            }
+                        IFieldSymbol? enumField = _knownRequestSymbols.TraktOAuthRequirementValues
+                            .FirstOrDefault(x => x.ConstantValue is int enumValue && enumValue == requirementValue);
+
+                        if (enumField != null)
+                        {
+                            _requestOAuthRequirementValue = enumField.Name;
                         }
                     }
                 }
@@ -436,12 +424,10 @@ private sealed class AttributeHttpMethodCollector : CSharpSyntaxWalker
 
             public override void VisitPrimaryConstructorBaseType(PrimaryConstructorBaseTypeSyntax node)
             {
-                if (node.Type.ToString() == RequestConstants.TraktRequestAttributeName)
+                if (node.Type.ToString() == RequestConstants.TraktRequestAttributeName
+                    && node.ArgumentList.Arguments[0].Expression is MemberAccessExpressionSyntax httpMethodArgument)
                 {
-                    if (node.ArgumentList.Arguments[0].Expression is MemberAccessExpressionSyntax httpMethodArgument)
-                    {
-                        HttpMethod = httpMethodArgument.Name.ToString();
-                    }
+                    HttpMethod = httpMethodArgument.Name.ToString();
                 }
             }
         }

diff --git a/src/tools/sourcegeneration/Trakt.NET.SourceGeneration/Requests/RequestConstants.cs b/src/tools/sourcegeneration/Trakt.NET.SourceGeneration/Requests/RequestConstants.cs
@@ -18,9 +18,9 @@ internal static class RequestConstants
 
         internal const string TraktExtendedInfoName = "TraktExtendedInfo";
 
-        internal const string TraktRequestParameterAttributeName = "TraktRequestParameter";
+        internal const string TraktRequestParameterAttributeName = "TraktRequestParameterAttribute";
 
-        internal const string TraktRequestQueryAttributeName = "TraktRequestQuery";
+        internal const string TraktRequestQueryAttributeName = "TraktRequestQueryAttribute";
 
         internal const string FullTraktExtendedInfoName = Constants.LibraryNamespace + "." + TraktExtendedInfoName;
 

diff --git a/...urcegeneration/Trakt.NET.SourceGeneration/Requests/SourceEmitters/RequestSourceEmitter.cs b/...urcegeneration/Trakt.NET.SourceGeneration/Requests/SourceEmitters/RequestSourceEmitter.cs
@@ -774,7 +774,7 @@ private void WriteBuildUriMethod()
                     if (_hasOptionalQueries)
                     {
                         _sourceWriter.WriteEmptyLine();
-                        
+
                         if (_requestQueries.Count == 1)
                         {
                             WriteGetQueriesEntry(_requestQueries[0], writeDirectlyInBuildMethod: true);
@@ -800,7 +800,7 @@ private void WriteBuildUriMethod()
                     _sourceWriter.WriteLine($"RequestUri = new Uri({RequestUriName}, UriKind.Relative);");
                 }
                 else
-            {
+                {
                     _sourceWriter.WriteLine($"string {RequestUriName} = $\"{_resolvedUriPath}\";");
                     _sourceWriter.WriteLine($"RequestUri = new Uri({RequestUriName}, UriKind.Relative);");
                 }
@@ -947,7 +947,6 @@ private void ParseRequestUri()
                                 });
 
                                 placeHolderName = string.Empty;
-                                placeHolderType = string.Empty;
 
                                 hasQuesionMark = false;
                                 exclamationMarkCount = 0;
@@ -1012,7 +1011,6 @@ private void ParseRequestUri()
                                 });
 
                                 placeHolderName = string.Empty;
-                                placeHolderType = string.Empty;
 
                                 break;
                             default: