From 414ce5af4d87763f73792701f85740cf66f68923 Mon Sep 17 00:00:00 2001 From: Jimmy Lewis Date: Sun, 4 Aug 2024 01:49:58 -0700 Subject: [PATCH] Address build warnings from .NET 8 analyzers - Mostly CA1307 to specify a StringComparison on string operations. Most of these were fixed with conditional compilation, but I suppressed a couple where it wouldn't matter (non-cased characters) and the code would have been ugly to use conditional compilation. - Some HashCode implementations were changed from XOR of two values to using HashCode.Combine instead for .NET 8. --- src/LibraryManager.Contracts/CompletionSet.cs | 5 +++++ src/LibraryManager/Cache/CacheFileMetadata.cs | 4 ++++ src/LibraryManager/FileIdentifier.cs | 5 ++++- src/LibraryManager/Minimatch/Minimatcher.cs | 6 ++++++ src/LibraryManager/Providers/BaseProvider.cs | 3 ++- src/LibraryManager/Providers/Cdnjs/CdnjsCatalog.cs | 4 ++++ .../Providers/FileSystem/FileSystemCatalog.cs | 3 +++ .../Providers/jsDelivr/JsDelivrCatalog.cs | 2 ++ src/LibraryManager/RelativePathEqualityComparer.cs | 5 +++++ src/LibraryManager/SemanticVersion.cs | 11 ++++++++++- 10 files changed, 45 insertions(+), 3 deletions(-) diff --git a/src/LibraryManager.Contracts/CompletionSet.cs b/src/LibraryManager.Contracts/CompletionSet.cs index 480d6cf6..6ce5d86e 100644 --- a/src/LibraryManager.Contracts/CompletionSet.cs +++ b/src/LibraryManager.Contracts/CompletionSet.cs @@ -140,8 +140,13 @@ public bool Equals(CompletionItem other) /// public override int GetHashCode() { +#if NET8_0_OR_GREATER + return HashCode.Combine(InsertionText, Description); +#else // Much of the time, InsertionText == DisplayText, so XORing those would just cancel out. + // So don't include DisplayText in the hash code. return InsertionText.GetHashCode() ^ Description.GetHashCode(); +#endif } /// diff --git a/src/LibraryManager/Cache/CacheFileMetadata.cs b/src/LibraryManager/Cache/CacheFileMetadata.cs index 6929faf3..27240ddb 100644 --- a/src/LibraryManager/Cache/CacheFileMetadata.cs +++ b/src/LibraryManager/Cache/CacheFileMetadata.cs @@ -46,7 +46,11 @@ public override bool Equals(object obj) /// public override int GetHashCode() { +#if NET8_0_OR_GREATER + return DestinationPath.GetHashCode(StringComparison.Ordinal); // this should be a unique identifier +#else return DestinationPath.GetHashCode(); // this should be a unique identifier +#endif } } } diff --git a/src/LibraryManager/FileIdentifier.cs b/src/LibraryManager/FileIdentifier.cs index 9364ae18..20abbbe8 100644 --- a/src/LibraryManager/FileIdentifier.cs +++ b/src/LibraryManager/FileIdentifier.cs @@ -2,7 +2,6 @@ // The .NET Foundation licenses this file to you under the MIT license. using System; -using System.Collections.Generic; namespace Microsoft.Web.LibraryManager { @@ -35,10 +34,14 @@ public override bool Equals(object obj) public override int GetHashCode() { +#if NET8_0_OR_GREATER + return HashCode.Combine(Path, Version); +#else int hashPath = Path == null ? 0 : Path.GetHashCode(); int hashVersion = Version == null ? 0 : Version.GetHashCode(); return hashPath ^ hashVersion; +#endif } } } diff --git a/src/LibraryManager/Minimatch/Minimatcher.cs b/src/LibraryManager/Minimatch/Minimatcher.cs index 324fc9c2..2c4f83f6 100644 --- a/src/LibraryManager/Minimatch/Minimatcher.cs +++ b/src/LibraryManager/Minimatch/Minimatcher.cs @@ -825,7 +825,13 @@ private bool Match(string input, bool partial) // On other platforms, \ is a valid (albeit bad) filename char. if (options.AllowWindowsPaths) + { +#if NET8_0_OR_GREATER + input = input.Replace("\\", "/", StringComparison.Ordinal); +#else input = input.Replace("\\", "/"); +#endif + } // treat the test path as a set of pathparts. var f = slashSplit.Split(input); diff --git a/src/LibraryManager/Providers/BaseProvider.cs b/src/LibraryManager/Providers/BaseProvider.cs index 2021450e..323a42a9 100644 --- a/src/LibraryManager/Providers/BaseProvider.cs +++ b/src/LibraryManager/Providers/BaseProvider.cs @@ -395,7 +395,8 @@ protected virtual string GetCachedFileLocalPath(ILibraryInstallationState state, /// /// Copies ILibraryInstallationState files to cache /// - /// + /// Desired install state to cache + /// Library resolved from provider /// /// private async Task RefreshCacheAsync(ILibraryInstallationState state, ILibrary library, CancellationToken cancellationToken) diff --git a/src/LibraryManager/Providers/Cdnjs/CdnjsCatalog.cs b/src/LibraryManager/Providers/Cdnjs/CdnjsCatalog.cs index d69a583d..60894fa4 100644 --- a/src/LibraryManager/Providers/Cdnjs/CdnjsCatalog.cs +++ b/src/LibraryManager/Providers/Cdnjs/CdnjsCatalog.cs @@ -50,7 +50,11 @@ public async Task GetLibraryCompletionSetAsync(string value, int Length = value.Length }; +#if NET8_0_OR_GREATER + int at = value.IndexOf('@', StringComparison.Ordinal); +#else int at = value.IndexOf('@'); +#endif string name = at > -1 ? value.Substring(0, at) : value; var completions = new List(); diff --git a/src/LibraryManager/Providers/FileSystem/FileSystemCatalog.cs b/src/LibraryManager/Providers/FileSystem/FileSystemCatalog.cs index 001d2a98..d28e1507 100644 --- a/src/LibraryManager/Providers/FileSystem/FileSystemCatalog.cs +++ b/src/LibraryManager/Providers/FileSystem/FileSystemCatalog.cs @@ -3,6 +3,7 @@ using System; using System.Collections.Generic; +using System.Diagnostics.CodeAnalysis; using System.IO; using System.Linq; using System.Threading; @@ -37,6 +38,7 @@ public FileSystemCatalog(FileSystemProvider provider, bool underTest = false) /// The current state of the library ID. /// The caret position inside the . /// + [SuppressMessage("Globalization", "CA1307:Specify StringComparison for clarity", Justification = "Searching for characters which are not cased")] public Task GetLibraryCompletionSetAsync(string value, int caretPosition) { if (value.Contains("://")) @@ -122,6 +124,7 @@ public Task GetLibraryCompletionSetAsync(string value, int caretP /// /// An instance of or null. /// + [SuppressMessage("Globalization", "CA1307:Specify StringComparison for clarity", Justification = "Searching for characters which are not cased")] public async Task GetLibraryAsync(string libraryName, string version, CancellationToken cancellationToken) { ILibrary library; diff --git a/src/LibraryManager/Providers/jsDelivr/JsDelivrCatalog.cs b/src/LibraryManager/Providers/jsDelivr/JsDelivrCatalog.cs index 888eef01..0a9de869 100644 --- a/src/LibraryManager/Providers/jsDelivr/JsDelivrCatalog.cs +++ b/src/LibraryManager/Providers/jsDelivr/JsDelivrCatalog.cs @@ -3,6 +3,7 @@ using System; using System.Collections.Generic; +using System.Diagnostics.CodeAnalysis; using System.IO; using System.Linq; using System.Threading; @@ -343,6 +344,7 @@ private async Task> GetGithubLibraryVersionsAsync(string nam return versions; } + [SuppressMessage("Globalization", "CA1307:Specify StringComparison for clarity", Justification = "Searching for characters which are not cased")] public static bool IsGitHub(string libraryId) { if (libraryId == null || libraryId.StartsWith("@", StringComparison.Ordinal)) diff --git a/src/LibraryManager/RelativePathEqualityComparer.cs b/src/LibraryManager/RelativePathEqualityComparer.cs index f3da1b2b..5f5ae39c 100644 --- a/src/LibraryManager/RelativePathEqualityComparer.cs +++ b/src/LibraryManager/RelativePathEqualityComparer.cs @@ -1,6 +1,7 @@ // Licensed to the .NET Foundation under one or more agreements. // The .NET Foundation licenses this file to you under the MIT license. +using System; using System.Collections.Generic; using System.IO; @@ -37,7 +38,11 @@ public bool Equals(string x, string y) /// public int GetHashCode(string obj) { +#if NET8_0_OR_GREATER + return NormalizePath(obj)?.GetHashCode(StringComparison.Ordinal) ?? 0; +#else return NormalizePath(obj)?.GetHashCode() ?? 0; +#endif } private string NormalizePath(string path) diff --git a/src/LibraryManager/SemanticVersion.cs b/src/LibraryManager/SemanticVersion.cs index 62509935..69f64545 100644 --- a/src/LibraryManager/SemanticVersion.cs +++ b/src/LibraryManager/SemanticVersion.cs @@ -44,7 +44,11 @@ public class SemanticVersion : IComparable, IEquatable - /// Returns whether the semantic verisons are equal. This includes comparing the build metadata, and does not provide semantic equivalence. + /// Returns whether the semantic versions are equal. This includes comparing the build metadata, and does not provide semantic equivalence. /// public bool Equals(SemanticVersion other) {