Merge branch 'master' into vulnerable-dependency

.github/workflows/ci.yml

@@ -122,7 +122,10 @@ jobs:
           dotnet-version: "8.0.x"
 
       - name: Restore .NET workloads
-        run: dotnet workload install android
+        # since windows image 20241113.3.0, not specifying a version here
+        # installs the .NET 7 version of android workload for very unknown reasons.
+        # revisit once we upgrade to .NET 9, it's probably fixed there.
+        run: dotnet workload install android --version (dotnet --version)
 
       - name: Compile
         run: dotnet build -c Debug osu-framework.Android.slnf

.github/workflows/deploy-pack.yml

@@ -131,7 +131,10 @@ jobs:
           java-version: 11
 
       - name: Restore .NET workloads
-        run: dotnet workload install android
+        # since windows image 20241113.3.0, not specifying a version here
+        # installs the .NET 7 version of android workload for very unknown reasons.
+        # revisit once we upgrade to .NET 9, it's probably fixed there.
+        run: dotnet workload install android --version (dotnet --version)
 
       - name: Pack (Android Framework)
         run: dotnet pack -c Release osu.Framework.Android /p:Version=${{ github.ref_name }} /p:GenerateDocumentationFile=true  -o ${{steps.artifactsPath.outputs.nuget_artifacts}}

.globalconfig

@@ -46,8 +46,49 @@ dotnet_diagnostic.IDE0130.severity = warning
 # IDE1006: Naming style
 dotnet_diagnostic.IDE1006.severity = warning
 
-#Disable operator overloads requiring alternate named methods
-dotnet_diagnostic.CA2225.severity = none
+# CA1305: Specify IFormatProvider
+# Too many noisy warnings for parsing/formatting numbers
+dotnet_diagnostic.CA1305.severity = none
+
+# CA1806: Do not ignore method results
+# Not sure why it's performance, but causing too much noise
+dotnet_diagnostic.CA1806.severity = none
+
+# CA1822: Mark members as static
+# Potential false positive around reflection/too much noise
+dotnet_diagnostic.CA1822.severity = none
+
+# CA1826: Do not use Enumerable methods on indexable collections
+# Noise for FirstOrDefault and LastOrDefault
+dotnet_diagnostic.CA1826.severity = none
+
+# CA1859: Use concrete types when possible for improved performance
+# Involves design considerations
+dotnet_diagnostic.CA1859.severity = none
+
+# CA1861: Avoid constant arrays as arguments
+# Outdated with collection expressions
+dotnet_diagnostic.CA1861.severity = none
+
+# CA1868: Unnecessary call to 'Contains(item)'
+# Causing noises only
+dotnet_diagnostic.CA1868.severity = none
+
+# CA2007: Consider calling ConfigureAwait on the awaited task
+dotnet_diagnostic.CA2007.severity = warning
+
+# CA2101: Specify marshaling for P/Invoke string arguments
+# Reports warning for all non-UTF16 usages on DllImport; consider migrating to LibraryImport
+dotnet_diagnostic.CA2101.severity = none
+
+# CA2201: Do not raise reserved exception types
+dotnet_diagnostic.CA2201.severity = warning
+
+# CA2208: Instantiate argument exceptions correctly
+dotnet_diagnostic.CA2208.severity = warning
+
+# CA2242: Test for NaN correctly
+dotnet_diagnostic.CA2242.severity = warning
 
 # Banned APIs
 dotnet_diagnostic.RS0030.severity = error

CodeAnalysis/BannedSymbols.txt

@@ -8,8 +8,4 @@ M:System.Threading.Tasks.Task.Wait();Don't use Task.Wait. Use Task.WaitSafely()
 M:System.Guid.#ctor;Probably meaning to use Guid.NewGuid() instead. If actually wanting empty, use Guid.Empty.
 P:System.Threading.Tasks.Task`1.Result;Don't use Task.Result. Use Task.GetResultSafely() to ensure we avoid deadlocks.
 M:System.Threading.ManualResetEventSlim.Wait();Specify a timeout to avoid waiting forever.
-M:System.Char.ToLower(System.Char);char.ToLower() changes behaviour depending on CultureInfo.CurrentCulture. Use char.ToLowerInvariant() instead. If wanting culture-sensitive behaviour, explicitly provide CultureInfo.CurrentCulture.
-M:System.Char.ToUpper(System.Char);char.ToUpper() changes behaviour depending on CultureInfo.CurrentCulture. Use char.ToUpperInvariant() instead. If wanting culture-sensitive behaviour, explicitly provide CultureInfo.CurrentCulture.
-M:System.String.ToLower();string.ToLower() changes behaviour depending on CultureInfo.CurrentCulture. Use string.ToLowerInvariant() instead. If wanting culture-sensitive behaviour, explicitly provide CultureInfo.CurrentCulture or use LocalisableString.
-M:System.String.ToUpper();string.ToUpper() changes behaviour depending on CultureInfo.CurrentCulture. Use string.ToUpperInvariant() instead. If wanting culture-sensitive behaviour, explicitly provide CultureInfo.CurrentCulture or use LocalisableString.
 M:System.Reflection.Assembly.GetEntryAssembly();Use osu.Framework.RuntimeInfo.EntryAssembly instead

Directory.Build.props

@@ -28,7 +28,17 @@
     <AdditionalFiles Include="$(MSBuildThisFileDirectory)CodeAnalysis\BannedSymbols.txt" />
   </ItemGroup>
   <PropertyGroup Label="Code Analysis">
-    <CodeAnalysisRuleSet>$(MSBuildThisFileDirectory)CodeAnalysis\osu-framework.ruleset</CodeAnalysisRuleSet>
+    <AnalysisMode>Default</AnalysisMode>
+    <AnalysisModeDesign>Default</AnalysisModeDesign>
+    <AnalysisModeDocumentation>Recommended</AnalysisModeDocumentation>
+    <AnalysisModeGlobalization>Recommended</AnalysisModeGlobalization>
+    <AnalysisModeInteroperability>Recommended</AnalysisModeInteroperability>
+    <AnalysisModeMaintainability>Recommended</AnalysisModeMaintainability>
+    <AnalysisModeNaming>Default</AnalysisModeNaming>
+    <AnalysisModePerformance>Minimum</AnalysisModePerformance>
+    <AnalysisModeReliability>Recommended</AnalysisModeReliability>
+    <AnalysisModeSecurity>Default</AnalysisModeSecurity>
+    <AnalysisModeUsage>Default</AnalysisModeUsage>
   </PropertyGroup>
   <PropertyGroup Label="NuGet">
     <Authors>ppy Pty Ltd</Authors>

osu-framework.sln

@@ -31,7 +31,7 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution
 		.globalconfig = .globalconfig
 		Directory.Build.props = Directory.Build.props
 		.config\dotnet-tools.json = .config\dotnet-tools.json
-		CodeAnalysis\osu-framework.ruleset = CodeAnalysis\osu-framework.ruleset
+		global.json = global.json
 		osu-framework.sln.DotSettings = osu-framework.sln.DotSettings
 		osu.Framework.Android.props = osu.Framework.Android.props
 		osu.Framework.iOS.props = osu.Framework.iOS.props
@@ -74,7 +74,6 @@ EndProject
 Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "CodeAnalysis", "CodeAnalysis", "{50334A1F-990D-45FA-A1FE-C92F1994D97B}"
 	ProjectSection(SolutionItems) = preProject
 		CodeAnalysis\BannedSymbols.txt = CodeAnalysis\BannedSymbols.txt
-		CodeAnalysis\osu-framework.ruleset = CodeAnalysis\osu-framework.ruleset
 	EndProjectSection
 EndProject
 Global

osu.Framework.Android/osu.Framework.Android.csproj

@@ -18,7 +18,7 @@
     <ProjectReference Include="..\osu.Framework\osu.Framework.csproj" />
   </ItemGroup>
   <ItemGroup>
-    <PackageReference Include="ppy.SDL3-CS.Android" Version="2024.1022.0" />
+    <PackageReference Include="ppy.SDL3-CS.Android" Version="2024.1128.0" />
     <PackageReference Include="Xamarin.AndroidX.Window" Version="1.2.0.1" PrivateAssets="compile" />
   </ItemGroup>
 </Project>

osu.Framework.SourceGeneration.Tests/GeneratorTestHelper.cs

@@ -22,7 +22,7 @@ public static void VerifyZeroDiagnostics(this GeneratorDriverRunResult runResult
                                                 .Where(d => d.Severity == DiagnosticSeverity.Error)
                                                 .ToArray();
 
-            if (compilationDiagnostics.Any() || generatorDiagnostics.Any())
+            if (compilationDiagnostics.Length > 0 || generatorDiagnostics.Length > 0)
             {
                 var sb = new StringBuilder();
 

osu.Framework.Tests/Audio/AudioThreadTest.cs

@@ -8,6 +8,7 @@
 using System.Threading.Tasks;
 using NUnit.Framework;
 using osu.Framework.Audio.Track;
+using osu.Framework.Extensions;
 using osu.Framework.IO.Stores;
 using osu.Framework.Threading;
 
@@ -87,7 +88,7 @@ void runScheduled() => thread.Scheduler.Add(() =>
 
             runScheduled();
 
-            Task.WaitAll(cts.Task);
+            cts.Task.WaitSafely();
         }
     }
 }

osu.Framework.Tests/Containers/TestSceneContainerState.cs

@@ -16,6 +16,8 @@
 using osu.Framework.Tests.Visual;
 using osuTK;
 
+#pragma warning disable CA1826 // Performance for test is not important
+
 namespace osu.Framework.Tests.Containers
 {
     [System.ComponentModel.Description("ensure valid container state in various scenarios")]

osu.Framework.Tests/IO/TestWebRequest.cs

@@ -891,7 +891,9 @@ private class HttpBinPostResponse
             [JsonProperty("json")]
             public TestObject Json { get; set; }
 
+#pragma warning disable CA1507 // Happens to name the same because of casing preference
             [JsonProperty("form")]
+#pragma warning restore CA1507
             private Dictionary<string, object> form { get; set; }
         }
 
@@ -906,7 +908,9 @@ private class HttpBinPutResponse
             [JsonProperty("args")]
             private Dictionary<string, object> arguments { get; set; }
 
+#pragma warning disable CA1507 // Happens to name the same because of casing preference
             [JsonProperty("form")]
+#pragma warning restore CA1507
             private Dictionary<string, object> form { get; set; }
         }
 

osu.Framework.Tests/Visual/UserInterface/TestSceneTabControl.cs

@@ -17,6 +17,8 @@
 using osu.Framework.Localisation;
 using osuTK;
 
+#pragma warning disable CA1826 // Performance for test is not important
+
 namespace osu.Framework.Tests.Visual.UserInterface
 {
     public partial class TestSceneTabControl : FrameworkTestScene

osu.Framework/Audio/Mixing/Bass/BassAudioMixer.cs

@@ -186,7 +186,7 @@ public long ChannelGetPosition(IBassAudioChannel channel, PositionFlags mode = P
         /// <param name="mode">How to set the position.</param>
         /// <returns>
         /// If successful, then <see langword="true"/> is returned, else <see langword="false"/> is returned.
-        /// Use <see cref="P:ManagedBass.Bass.LastError"/> to get the error code.
+        /// Use <see cref="ManagedBass.Bass.LastError"/> to get the error code.
         /// </returns>
         public bool ChannelSetPosition(IBassAudioChannel channel, long position, PositionFlags mode = PositionFlags.Bytes)
         {
@@ -222,11 +222,11 @@ public bool ChannelGetLevel(IBassAudioChannel channel, [In, Out] float[] levels,
         /// <remarks>See: <see cref="ManagedBass.Bass.ChannelGetData(int, float[], int)"/>.</remarks>
         /// <param name="channel">The <see cref="IBassAudioChannel"/> to retrieve the data of.</param>
         /// <param name="buffer">float[] to write the data to.</param>
-        /// <param name="length">Number of bytes wanted, and/or <see cref="T:ManagedBass.DataFlags"/>.</param>
-        /// <returns>If an error occurs, -1 is returned, use <see cref="P:ManagedBass.Bass.LastError"/> to get the error code.
+        /// <param name="length">Number of bytes wanted, and/or <see cref="DataFlags"/>.</param>
+        /// <returns>If an error occurs, -1 is returned, use <see cref="ManagedBass.Bass.LastError"/> to get the error code.
         /// <para>When requesting FFT data, the number of bytes read from the channel (to perform the FFT) is returned.</para>
-        /// <para>When requesting sample data, the number of bytes written to buffer will be returned (not necessarily the same as the number of bytes read when using the <see cref="F:ManagedBass.DataFlags.Float"/> or DataFlags.Fixed flag).</para>
-        /// <para>When using the <see cref="F:ManagedBass.DataFlags.Available"/> flag, the number of bytes in the channel's buffer is returned.</para>
+        /// <para>When requesting sample data, the number of bytes written to buffer will be returned (not necessarily the same as the number of bytes read when using the <see cref="DataFlags.Float"/> or DataFlags.Fixed flag).</para>
+        /// <para>When using the <see cref="DataFlags.Available"/> flag, the number of bytes in the channel's buffer is returned.</para>
         /// </returns>
         public int ChannelGetData(IBassAudioChannel channel, float[] buffer, int length)
             => BassMix.ChannelGetData(channel.Handle, buffer, length);
@@ -240,24 +240,24 @@ public int ChannelGetData(IBassAudioChannel channel, float[] buffer, int length)
         /// <param name="parameter">The sync parameters, depending on the sync type.</param>
         /// <param name="procedure">The callback function which should be invoked with the sync.</param>
         /// <param name="user">User instance data to pass to the callback function.</param>
-        /// <returns>If successful, then the new synchroniser's handle is returned, else 0 is returned. Use <see cref="P:ManagedBass.Bass.LastError" /> to get the error code.</returns>
+        /// <returns>If successful, then the new synchroniser's handle is returned, else 0 is returned. Use <see cref="ManagedBass.Bass.LastError" /> to get the error code.</returns>
         public int ChannelSetSync(IBassAudioChannel channel, SyncFlags type, long parameter, SyncProcedure procedure, IntPtr user = default)
             => BassMix.ChannelSetSync(channel.Handle, type, parameter, procedure, user);
 
         /// <summary>
         /// Removes a synchroniser from a mixer source channel.
         /// </summary>
         /// <param name="channel">The <see cref="IBassAudioChannel"/> to remove the synchroniser for.</param>
-        /// <param name="sync">Handle of the synchroniser to remove (return value of a previous <see cref="M:ManagedBass.Mix.BassMix.ChannelSetSync(System.Int32,ManagedBass.SyncFlags,System.Int64,ManagedBass.SyncProcedure,System.IntPtr)" /> call).</param>
-        /// <returns>If successful, <see langword="true" /> is returned, else <see langword="false" /> is returned. Use <see cref="P:ManagedBass.Bass.LastError" /> to get the error code.</returns>
+        /// <param name="sync">Handle of the synchroniser to remove (return value of a previous <see cref="BassMix.ChannelSetSync(int,SyncFlags,long,SyncProcedure,IntPtr)" /> call).</param>
+        /// <returns>If successful, <see langword="true" /> is returned, else <see langword="false" /> is returned. Use <see cref="ManagedBass.Bass.LastError" /> to get the error code.</returns>
         public bool ChannelRemoveSync(IBassAudioChannel channel, int sync)
             => BassMix.ChannelRemoveSync(channel.Handle, sync);
 
         /// <summary>
         /// Frees a channel's resources.
         /// </summary>
         /// <param name="channel">The <see cref="IBassAudioChannel"/> to free.</param>
-        /// <returns>If successful, <see langword="true" /> is returned, else <see langword="false" /> is returned. Use <see cref="P:ManagedBass.Bass.LastError" /> to get the error code.</returns>
+        /// <returns>If successful, <see langword="true" /> is returned, else <see langword="false" /> is returned. Use <see cref="ManagedBass.Bass.LastError" /> to get the error code.</returns>
         public bool StreamFree(IBassAudioChannel channel)
         {
             Remove(channel, false);

osu.Framework/Audio/Track/Waveform.cs

@@ -270,7 +270,7 @@ private float computeIntensity(ChannelInfo info, float[] bins, float startFreque
         /// <returns>An async task for the generation of the <see cref="Waveform"/>.</returns>
         public async Task<Waveform> GenerateResampledAsync(int pointCount, CancellationToken cancellationToken = default)
         {
-            if (pointCount < 0) throw new ArgumentOutOfRangeException(nameof(pointCount));
+            ArgumentOutOfRangeException.ThrowIfNegative(pointCount);
 
             if (pointCount == 0)
                 return new Waveform(null);

osu.Framework/Graphics/Containers/FlowContainer.cs

@@ -137,10 +137,10 @@ public void Insert(int position, T drawable)
         /// <returns>The position of the drawable in the layout.</returns>
         public float GetLayoutPosition(Drawable drawable)
         {
-            if (!layoutChildren.ContainsKey(drawable))
+            if (!layoutChildren.TryGetValue(drawable, out float value))
                 throw new InvalidOperationException($"Cannot get layout position of drawable which is not contained within this {nameof(FlowContainer<T>)}.");
 
-            return layoutChildren[drawable];
+            return value;
         }
 
         protected override bool UpdateChildrenLife()

osu.Framework/Graphics/Containers/SearchContainer.cs

@@ -121,7 +121,7 @@ protected void Filter()
         private void performFilter()
         {
             string[] terms = (searchTerm ?? string.Empty).Split(new[] { ' ' }, StringSplitOptions.RemoveEmptyEntries);
-            matchSubTree(this, terms, terms.Any(), allowNonContiguousMatching);
+            matchSubTree(this, terms, terms.Length > 0, allowNonContiguousMatching);
         }
 
         private bool matchSubTree(Drawable drawable, IReadOnlyList<string> searchTerms, bool searchActive, bool nonContiguousMatching)