Enable .NET source code analysis

.editorconfig

@@ -94,3 +94,6 @@ csharp_space_between_method_call_empty_parameter_list_parentheses = false
 # Wrapping preferences
 csharp_preserve_single_line_statements = true
 csharp_preserve_single_line_blocks = true
+
+# .NET source code analysis
+dotnet_code_quality.CA1826.exclude_ordefault_methods = true

src/BaGet.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/BaGet.Azure/Search/ExactMatchCustomAnalyzer.cs

@@ -1,4 +1,5 @@
 using System.Collections.Generic;
+using System.Diagnostics.CodeAnalysis;
 using Microsoft.Azure.Search.Models;
 
 namespace BaGet.Azure
@@ -10,6 +11,7 @@ public static class ExactMatchCustomAnalyzer
  {
  public const string Name = "baget-exact-match-analyzer";
 
+ [SuppressMessage("Usage", "CA2211:Non-constant fields should not be visible", Justification = "Would be a breaking change")]
  public static CustomAnalyzer Instance = new CustomAnalyzer(
  Name,
  TokenizerName.Keyword,

src/BaGet.Azure/Search/IndexActionBuilder.cs

@@ -21,7 +21,7 @@ public class IndexActionBuilder
  return AddOrUpdatePackage(registration, isUpdate: true);
  }
 
- private IReadOnlyList<IndexAction<KeyedDocument>> AddOrUpdatePackage(
+ private static IReadOnlyList<IndexAction<KeyedDocument>> AddOrUpdatePackage(
  PackageRegistration registration,
  bool isUpdate)
  {
@@ -105,7 +105,7 @@ public class IndexActionBuilder
  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/BaGet.Azure/Table/TableOperationBuilder.cs

@@ -1,5 +1,6 @@
 using System;
 using System.Collections.Generic;
+using System.Diagnostics.CodeAnalysis;
 using System.Linq;
 using BaGet.Core;
 using Microsoft.Azure.Cosmos.Table;
@@ -8,6 +9,7 @@
 
 namespace BaGet.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/BaGet.Azure/Table/TablePackageDatabase.cs

@@ -82,8 +82,8 @@ public async Task<PackageAddResult> AddAsync(Package package, CancellationToken
  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/BaGet.Azure/Table/TableSearchService.cs

@@ -133,7 +133,7 @@ public Task<DependentsResponse> FindDependentsAsync(string packageId, Cancellati
  return results;
  }
 
- private string GenerateSearchFilter(string searchText, bool includePrerelease, bool includeSemVer2)
+ private static string GenerateSearchFilter(string searchText, bool includePrerelease, bool includeSemVer2)
  {
  var result = "";
 

src/BaGet.Core/Extensions/PackageArchiveReaderExtensions.cs

@@ -109,14 +109,14 @@ private static Uri ParseUri(string uriString)
 
  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);
  }

src/BaGet.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 @@ bool IsValidSymbolFileInfo(FileInfo file)
  {
  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/BaGet.Core/Metadata/RegistrationBuilder.cs

@@ -32,7 +32,7 @@ public virtual BaGetRegistrationIndexResponse BuildIndex(PackageRegistration reg
  new BaGetRegistrationIndexPage
  {
  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 @@ public virtual RegistrationLeafResponse BuildLeaf(Package package)
  },
  };
 
- private IReadOnlyList<DependencyGroupItem> ToDependencyGroups(Package package)
+ private static IReadOnlyList<DependencyGroupItem> ToDependencyGroups(Package package)
  {
  return package.Dependencies
  .GroupBy(d => d.TargetFramework)

src/BaGet.Core/PackageDatabase.cs

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

src/BaGet.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/BaGet.Core/ServiceIndex/BaGetServiceIndex.cs

@@ -15,7 +15,7 @@ public BaGetServiceIndex(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/BaGet.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/BaGet.Core/Upstream/Clients/V2UpstreamClient.cs

@@ -126,7 +126,11 @@ public async Task<IReadOnlyList<NuGetVersion>> ListPackageVersionsAsync(string i
  }
  }
 
- public void Dispose() => _cache.Dispose();
+ public void Dispose()
+ {
+ _cache.Dispose();
+ GC.SuppressFinalize(this);
+ }
 
  private Package ToPackage(IPackageSearchMetadata package)
  {
@@ -157,7 +161,7 @@ private Package ToPackage(IPackageSearchMetadata package)
  };
  }
 
- private string[] ParseAuthors(string authors)
+ private static string[] ParseAuthors(string authors)
  {
  if (string.IsNullOrEmpty(authors)) return Array.Empty<string>();
 

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

@@ -117,7 +117,7 @@ private Package ToPackage(PackageMetadata metadata)
  };
  }
 
- private Uri ParseUri(string uriString)
+ private static Uri ParseUri(string uriString)
  {
  if (uriString == null) return null;
 
@@ -129,7 +129,7 @@ private Uri ParseUri(string uriString)
  return uri;
  }
 
- private string[] ParseAuthors(string authors)
+ private static string[] ParseAuthors(string authors)
  {
  if (string.IsNullOrEmpty(authors)) return Array.Empty<string>();
 

src/BaGet.Core/Upstream/DownloadsImporter.cs

@@ -29,7 +29,7 @@ public class DownloadsImporter
  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++)

src/BaGet.Protocol/Catalog/CatalogProcessor.cs

@@ -133,7 +133,7 @@ private async Task<bool> ProcessIndexAsync(DateTimeOffset minCommitTimestamp, Ca
 
  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/BaGet.Protocol/Search/SearchClient.cs

@@ -28,7 +28,7 @@ public SearchClient(NuGetClientFactory clientFactory)
  // 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/BaGet.Web/BaGetEndpointBuilder.cs

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

src/BaGet.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

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>