Activate .NET code analysis

.editorconfig

@@ -36,6 +36,9 @@ indent_size = 4
 
 # .NET Coding Conventions
 
+# .NET source code analysis
+dotnet_code_quality.CA1826.exclude_ordefault_methods = true
+
 # Organize usings
 dotnet_sort_system_directives_first = true:warning
 

src/BaGetter.Aws/S3StorageService.cs

@@ -42,7 +42,7 @@ public async Task<Stream> GetAsync(string path, CancellationToken cancellationTo
             {
                 using (var request = await _client.GetObjectAsync(_bucket, PrepareKey(path), cancellationToken))
                 {
-                    await request.ResponseStream.CopyToAsync(stream);
+                    await request.ResponseStream.CopyToAsync(stream, cancellationToken);
                 }
 
                 stream.Seek(0, SeekOrigin.Begin);

src/BaGetter.Azure/Search/AzureSearchService.cs

@@ -205,7 +205,7 @@ private string BuildSeachQuery(string query, string packageType, string framewor
             return queryBuilder.ToString();
         }
 
-        private string BuildSearchFilter(bool includePrerelease, bool includeSemVer2)
+        private static string BuildSearchFilter(bool includePrerelease, bool includeSemVer2)
         {
             var searchFilters = SearchFilters.Default;
 

src/BaGetter.Azure/Search/IndexActionBuilder.cs

@@ -21,7 +21,7 @@ public virtual IReadOnlyList<IndexAction<KeyedDocument>> UpdatePackage(
             return AddOrUpdatePackage(registration, isUpdate: true);
         }
 
-        private IReadOnlyList<IndexAction<KeyedDocument>> AddOrUpdatePackage(
+        private static IReadOnlyList<IndexAction<KeyedDocument>> AddOrUpdatePackage(
             PackageRegistration registration,
             bool isUpdate)
         {
@@ -105,7 +105,7 @@ private IReadOnlyList<IndexAction<KeyedDocument>> AddOrUpdatePackage(
             return result;
         }
 
-        private string EncodePackageId(string key)
+        private static string EncodePackageId(string key)
         {
             // Keys can only contain letters, digits, underscore(_), dash(-), or equal sign(=).
             // TODO: Align with NuGet.org's algorithm.

src/BaGetter.Azure/Table/TableOperationBuilder.cs

@@ -1,5 +1,6 @@
 using System;
 using System.Collections.Generic;
+using System.Diagnostics.CodeAnalysis;
 using System.Linq;
 using BaGetter.Core;
 using Microsoft.Azure.Cosmos.Table;
@@ -8,6 +9,7 @@
 
 namespace BaGetter.Azure
 {
+    [SuppressMessage("Performance", "CA1822:Mark members as static", Justification = "Would be a breaking change since it's part of the public API")]
     public class TableOperationBuilder
     {
         public TableOperation AddPackage(Package package)

src/BaGetter.Azure/Table/TablePackageDatabase.cs

@@ -82,8 +82,8 @@ public async Task AddDownloadAsync(
                     attempt++;
                     _logger.LogWarning(
                         e,
-                        $"Retrying due to precondition failure, attempt {{Attempt}} of {MaxPreconditionFailures}..",
-                        attempt);
+                        "Retrying due to precondition failure, attempt {Attempt} of {MaxPreconditionFailures}",
+                        attempt, MaxPreconditionFailures);
                 }
             }
         }
@@ -196,7 +196,7 @@ public async Task<bool> UnlistPackageAsync(string id, NuGetVersion version, Canc
                 cancellationToken);
         }
 
-        private List<string> MinimalColumnSet => new List<string> { "PartitionKey" };
+        private static List<string> MinimalColumnSet => new List<string> { "PartitionKey" };
 
         private async Task<bool> TryUpdatePackageAsync(TableOperation operation, CancellationToken cancellationToken)
         {

src/BaGetter.Azure/Table/TableSearchService.cs

@@ -133,7 +133,7 @@ private async Task<IReadOnlyList<Package>> LoadPackagesAsync(
             return results;
         }
 
-        private string GenerateSearchFilter(string searchText, bool includePrerelease, bool includeSemVer2)
+        private static string GenerateSearchFilter(string searchText, bool includePrerelease, bool includeSemVer2)
         {
             var result = "";
 

src/BaGetter.Core/Extensions/PackageArchiveReaderExtensions.cs

@@ -111,16 +111,16 @@
 
         private static string[] ParseAuthors(string authors)
         {
-            if (string.IsNullOrEmpty(authors)) return new string[0];
+            if (string.IsNullOrEmpty(authors)) return Array.Empty<string>();
 
             return authors.Split(new[] { ',', ';', '\t', '\n', '\r' }, StringSplitOptions.RemoveEmptyEntries);
         }
 
         private static string[] ParseTags(string tags)
         {
-            if (string.IsNullOrEmpty(tags)) return new string[0];
+            if (string.IsNullOrEmpty(tags)) return Array.Empty<string>();
 
             return tags.Split(new[] { ',', ';', ' ', '\t', '\n', '\r' }, StringSplitOptions.RemoveEmptyEntries);
         }
 
         private static (Uri repositoryUrl, string repositoryType) GetRepositoryMetadata(NuspecReader nuspec)

src/BaGetter.Core/Indexing/SymbolIndexingService.cs

@@ -133,7 +133,7 @@ bool IsValidSymbolFileInfo(FileInfo file)
             return entries.Select(e => new FileInfo(e)).All(IsValidSymbolFileInfo);
         }
 
-        private async Task<PortablePdb> ExtractPortablePdbAsync(
+        private static async Task<PortablePdb> ExtractPortablePdbAsync(
             PackageArchiveReader symbolPackage,
             string pdbPath,
             CancellationToken cancellationToken)
@@ -147,7 +147,7 @@ private async Task<PortablePdb> ExtractPortablePdbAsync(
             {
                 using (var rawPdbStream = await symbolPackage.GetStreamAsync(pdbPath, cancellationToken))
                 {
-                    pdbStream = await rawPdbStream.AsTemporaryFileStreamAsync();
+                    pdbStream = await rawPdbStream.AsTemporaryFileStreamAsync(cancellationToken);
 
                     string signature;
                     using (var pdbReaderProvider = MetadataReaderProvider.FromPortablePdbStream(pdbStream, MetadataStreamOptions.LeaveOpen))

src/BaGetter.Core/Metadata/RegistrationBuilder.cs

@@ -32,7 +32,7 @@ public virtual BaGetterRegistrationIndexResponse BuildIndex(PackageRegistration
                     new BaGetterRegistrationIndexPage
                     {
                         RegistrationPageUrl = _url.GetRegistrationIndexUrl(registration.PackageId),
-                        Count = registration.Packages.Count(),
+                        Count = registration.Packages.Count,
                         Lower = sortedPackages.First().Version.ToNormalizedString().ToLowerInvariant(),
                         Upper = sortedPackages.Last().Version.ToNormalizedString().ToLowerInvariant(),
                         ItemsOrNull = sortedPackages.Select(ToRegistrationIndexPageItem).ToList(),
@@ -92,7 +92,7 @@ private BaGetRegistrationIndexPageItem ToRegistrationIndexPageItem(Package packa
                 },
             };
 
-        private IReadOnlyList<DependencyGroupItem> ToDependencyGroups(Package package)
+        private static IReadOnlyList<DependencyGroupItem> ToDependencyGroups(Package package)
         {
             return package.Dependencies
                 .GroupBy(d => d.TargetFramework)

src/BaGetter.Core/PackageDatabase.cs

@@ -132,7 +132,7 @@ private async Task<bool> TryUpdatePackageAsync(
             var package = await _context.Packages
                 .Where(p => p.Id == id)
                 .Where(p => p.NormalizedVersionString == version.ToNormalizedString())
-                .FirstOrDefaultAsync();
+                .FirstOrDefaultAsync(cancellationToken);
 
             if (package != null)
             {

src/BaGetter.Core/Search/DatabaseSearchService.cs

@@ -145,7 +145,7 @@ public async Task<DependentsResponse> FindDependentsAsync(string packageId, Canc
             return _searchBuilder.BuildDependents(dependents);
         }
 
-        private IQueryable<Package> ApplySearchQuery(IQueryable<Package> query, string search)
+        private static IQueryable<Package> ApplySearchQuery(IQueryable<Package> query, string search)
         {
             if (string.IsNullOrEmpty(search))
             {
@@ -157,7 +157,7 @@ private IQueryable<Package> ApplySearchQuery(IQueryable<Package> query, string s
             return query.Where(p => p.Id.ToLower().Contains(search));
         }
 
-        private IQueryable<Package> ApplySearchFilters(
+        private static IQueryable<Package> ApplySearchFilters(
             IQueryable<Package> query,
             bool includePrerelease,
             bool includeSemVer2,

src/BaGetter.Core/ServiceIndex/BaGetterServiceIndex.cs

@@ -15,7 +15,7 @@ public BaGetterServiceIndex(IUrlGenerator url)
             _url = url ?? throw new ArgumentNullException(nameof(url));
         }
 
-        private IEnumerable<ServiceIndexItem> BuildResource(string name, string url, params string[] versions)
+        private static IEnumerable<ServiceIndexItem> BuildResource(string name, string url, params string[] versions)
         {
             foreach (var version in versions)
             {

src/BaGetter.Core/Storage/SymbolStorageService.cs

@@ -47,20 +47,20 @@ public async Task<Stream> GetPortablePdbContentStreamOrNullAsync(string filename
             }
         }
 
-        private string GetPathForKey(string filename, string key)
+        private static string GetPathForKey(string filename, string key)
         {
             // Ensure the filename doesn't try to escape out of the current directory.
             var tempPath = Path.GetDirectoryName(Path.GetTempPath());
             var expandedPath = Path.GetDirectoryName(Path.Combine(tempPath, filename));
-            
+
             if (expandedPath != tempPath)
             {
-                throw new ArgumentException(nameof(filename));
+                throw new ArgumentException($"Invalid file name: \"{filename}\" (can't escape the current directory)", nameof(filename));
             }
 
             if (!key.All(char.IsLetterOrDigit))
             {
-                throw new ArgumentException(nameof(key));
+                throw new ArgumentException($"Invalid key: \"{key}\" (must contain exclusively letters and digits)", nameof(key));
             }
 
             // The key's first 32 characters are the GUID, the remaining characters are the age.

src/BaGetter.Core/Upstream/Clients/V2UpstreamClient.cs

@@ -32,7 +32,7 @@
             IOptionsSnapshot<MirrorOptions> options,
             ILogger logger)
         {
             if (options is null)
             {
                 throw new ArgumentNullException(nameof(options));
             }
@@ -126,7 +126,11 @@
             }
         }
 
-        public void Dispose() => _cache.Dispose();
+        public void Dispose()
+        {
+            _cache.Dispose();
+            GC.SuppressFinalize(this);
+        }
 
         private Package ToPackage(IPackageSearchMetadata package)
         {
@@ -151,18 +155,18 @@
                 PackageTypes = new List<PackageType>(),
                 RepositoryUrl = null,
                 RepositoryType = null,
                 Tags = package.Tags?.Split(new[] {';'}, StringSplitOptions.RemoveEmptyEntries),
 
                 Dependencies = ToDependencies(package)
             };
         }
 
-        private string[] ParseAuthors(string authors)
+        private static string[] ParseAuthors(string authors)
         {
             if (string.IsNullOrEmpty(authors)) return Array.Empty<string>();
 
             return authors
                 .Split(new[] { ',', ';', '\t', '\n', '\r' }, StringSplitOptions.RemoveEmptyEntries)
                 .Select(a => a.Trim())
                 .ToArray();
         }

src/BaGetter.Core/Upstream/Clients/V3UpstreamClient.cs

@@ -117,7 +117,7 @@
             };
         }
 
-        private Uri ParseUri(string uriString)
+        private static Uri ParseUri(string uriString)
         {
             if (uriString == null) return null;
 
@@ -129,12 +129,12 @@
             return uri;
         }
 
-        private string[] ParseAuthors(string authors)
+        private static string[] ParseAuthors(string authors)
         {
             if (string.IsNullOrEmpty(authors)) return Array.Empty<string>();
 
             return authors
                 .Split(new[] { ',', ';', '\t', '\n', '\r' }, StringSplitOptions.RemoveEmptyEntries)
                 .Select(a => a.Trim())
                 .ToArray();
         }

src/BaGetter.Core/Upstream/DownloadsImporter.cs

@@ -29,7 +29,7 @@
         public async Task ImportAsync(CancellationToken cancellationToken)
         {
             var packageDownloads = await _downloadsSource.GetPackageDownloadsAsync();
-            var packages = await _context.Packages.CountAsync();
+            var packages = await _context.Packages.CountAsync(cancellationToken);
             var batches = (packages / BatchSize) + 1;
 
             for (var batch = 0; batch < batches; batch++)
@@ -41,7 +41,7 @@
                     var packageId = package.Id.ToLowerInvariant();
                     var packageVersion = package.NormalizedVersionString.ToLowerInvariant();
 
                     if (!packageDownloads.ContainsKey(packageId) ||
                         !packageDownloads[packageId].ContainsKey(packageVersion))
                     {
                         continue;

src/BaGetter.Protocol/Catalog/CatalogProcessor.cs

@@ -133,7 +133,7 @@ private async Task<bool> ProcessPageAsync(
 
             if (newCursor.HasValue && success)
             {
-                await _cursor.SetAsync(newCursor.Value);
+                await _cursor.SetAsync(newCursor.Value, cancellationToken);
             }
 
             return success;
@@ -146,12 +146,12 @@ private async Task<bool> ProcessLeafAsync(CatalogLeafItem leafItem, Cancellation
             {
                 if (leafItem.IsPackageDelete())
                 {
-                    var packageDelete = await _client.GetPackageDeleteLeafAsync(leafItem.CatalogLeafUrl);
+                    var packageDelete = await _client.GetPackageDeleteLeafAsync(leafItem.CatalogLeafUrl, cancellationToken);
                     success = await _leafProcessor.ProcessPackageDeleteAsync(packageDelete, cancellationToken);
                 }
                 else if (leafItem.IsPackageDetails())
                 {
-                    var packageDetails = await _client.GetPackageDetailsLeafAsync(leafItem.CatalogLeafUrl);
+                    var packageDetails = await _client.GetPackageDetailsLeafAsync(leafItem.CatalogLeafUrl, cancellationToken);
                     success = await _leafProcessor.ProcessPackageDetailsAsync(packageDetails, cancellationToken);
                 }
                 else

src/BaGetter.Protocol/Search/SearchClient.cs

@@ -28,7 +28,7 @@ public async Task<SearchResponse> SearchAsync(
                 // See: https://github.com/loic-sharma/BaGet/issues/314
                 var client = await _clientfactory.GetSearchClientAsync(cancellationToken);
 
-                return await client.SearchAsync(query, skip, take, includePrerelease, includeSemVer2);
+                return await client.SearchAsync(query, skip, take, includePrerelease, includeSemVer2, cancellationToken);
             }
         }
     }

src/BaGetter.Web/BaGetterEndpointBuilder.cs

@@ -1,10 +1,12 @@
+using System.Diagnostics.CodeAnalysis;
 using BaGetter.Web;
 using Microsoft.AspNetCore.Builder;
 using Microsoft.AspNetCore.Routing;
 using Microsoft.AspNetCore.Routing.Constraints;
 
 namespace BaGetter
 {
+    [SuppressMessage("Performance", "CA1822:Mark members as static", Justification = "Would be a breaking change since it's part of the public API")]
     public class BaGetterEndpointBuilder
     {
         public void MapEndpoints(IEndpointRouteBuilder endpoints)

src/BaGetter.Web/Pages/Package.cshtml.cs

@@ -110,7 +110,7 @@ public async Task OnGetAsync(string id, string version, CancellationToken cancel
             PackageDownloadUrl = _url.GetPackageDownloadUrl(Package.Id, packageVersion);
         }
 
-        private IReadOnlyList<DependencyGroupModel> ToDependencyGroups(Package package)
+        private static IReadOnlyList<DependencyGroupModel> ToDependencyGroups(Package package)
         {
             return package
                 .Dependencies
@@ -135,7 +135,7 @@ private IReadOnlyList<DependencyGroupModel> ToDependencyGroups(Package package)
                 .ToList();
         }
 
-        private string PrettifyTargetFramework(string targetFramework)
+        private static string PrettifyTargetFramework(string targetFramework)
         {
             if (targetFramework == null) return "All Frameworks";
 
@@ -179,7 +179,7 @@ private string PrettifyTargetFramework(string targetFramework)
             return $"{frameworkName} {frameworkVersion}";
         }
 
-        private IReadOnlyList<VersionModel> ToVersions(IReadOnlyList<Package> packages, NuGetVersion selectedVersion)
+        private static IReadOnlyList<VersionModel> ToVersions(IReadOnlyList<Package> packages, NuGetVersion selectedVersion)
         {
             return packages
                 .Select(p => new VersionModel
@@ -205,7 +205,7 @@ private async Task<HtmlString> GetReadmeHtmlStringOrNullAsync(
 
                 using (var reader = new StreamReader(readmeStream))
                 {
-                    readme = await reader.ReadToEndAsync();
+                    readme = await reader.ReadToEndAsync(cancellationToken);
                 }
             }
 

src/Directory.Build.props

@@ -21,6 +21,12 @@
     <NoWarn>$(NoWarn);1591</NoWarn>
   </PropertyGroup>
 
+  <!-- .NET source code analysis https://learn.microsoft.com/en-us/dotnet/fundamentals/code-analysis/overview -->
+  <PropertyGroup>
+    <EnableNETAnalyzers>true</EnableNETAnalyzers>
+    <AnalysisLevel>latest-Minimum</AnalysisLevel>
+  </PropertyGroup>
+
   <!-- Debugging properties -->
   <PropertyGroup>
     <AllowedOutputExtensionsInPackageBuildOutputFolder>$(AllowedOutputExtensionsInPackageBuildOutputFolder);.pdb</AllowedOutputExtensionsInPackageBuildOutputFolder>