expose random extensions

lucasteles · lucasteles · commit ccc959e5278c · 2026-02-11T12:08:03.000-03:00
diff --git a/Directory.Build.props b/Directory.Build.props
@@ -58,7 +58,7 @@
       <PrivateAssets>all</PrivateAssets>
       <IncludeAssets>runtime; build; native; contentfiles; analyzers</IncludeAssets>
     </PackageReference>
-    <PackageReference Include="SonarAnalyzer.CSharp" Version="10.18.*">
+    <PackageReference Include="SonarAnalyzer.CSharp" Version="10.19.*">
       <PrivateAssets>all</PrivateAssets>
       <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
     </PackageReference>
diff --git a/benchmarks/Backdash.Benchmarks/Cases/CompareSerializationBenchmark.cs b/benchmarks/Backdash.Benchmarks/Cases/CompareSerializationBenchmark.cs
@@ -127,21 +127,21 @@ public static TestData Generate(Random random)
         TestData testData = new()
         {
             Field1 = random.NextBool(),
-            Field2 = random.Next<ulong>(),
+            Field2 = random.Generate<ulong>(),
         };
 
         for (int i = 0; i < testData.Field3.Length; i++)
         {
             ref var entry = ref testData.Field3[i];
             entry.Field1 = random.Next();
-            entry.Field2 = random.Next<uint>();
-            entry.Field3 = random.Next<ulong>();
-            entry.Field4 = random.Next<long>();
-            entry.Field5 = random.Next<short>();
-            entry.Field6 = random.Next<ushort>();
-            entry.Field7 = random.Next<byte>();
-            entry.Field8 = random.Next<sbyte>();
-            random.Next(entry.Field9.AsSpan());
+            entry.Field2 = random.Generate<uint>();
+            entry.Field3 = random.Generate<ulong>();
+            entry.Field4 = random.Generate<long>();
+            entry.Field5 = random.Generate<short>();
+            entry.Field6 = random.Generate<ushort>();
+            entry.Field7 = random.Generate<byte>();
+            entry.Field8 = random.Generate<sbyte>();
+            random.Generate(entry.Field9.AsSpan());
         }
 
         return testData;
diff --git a/benchmarks/Backdash.Benchmarks/Cases/SerializationBenchmark.cs b/benchmarks/Backdash.Benchmarks/Cases/SerializationBenchmark.cs
@@ -83,7 +83,7 @@ public TestData(Random random, int itemsSize, bool useIn, bool useRef, bool with
             this(itemsSize, useIn, useRef)
         {
             Field1 = random.NextBool();
-            Field2 = random.Next<ulong>();
+            Field2 = random.Generate<ulong>();
 
             for (int i = 0; i < Field3.Length; i++)
                 Field3[i] = new(random, useIn, useRef, withValues);
@@ -159,14 +159,14 @@ public struct TestEntryData(bool useIn, bool useRef, bool withValues)
         public TestEntryData(Random random, bool useIn, bool useRef, bool withValues) : this(useIn, useRef, withValues)
         {
             Field1 = random.Next();
-            Field2 = random.Next<uint>();
-            Field3 = random.Next<ulong>();
-            Field4 = random.Next<long>();
-            Field5 = random.Next<short>();
-            Field6 = random.Next<ushort>();
-            Field7 = random.Next<byte>();
-            Field8 = random.Next<sbyte>();
-            Field9 = random.Next<Int128>();
+            Field2 = random.Generate<uint>();
+            Field3 = random.Generate<ulong>();
+            Field4 = random.Generate<long>();
+            Field5 = random.Generate<short>();
+            Field6 = random.Generate<ushort>();
+            Field7 = random.Generate<byte>();
+            Field8 = random.Generate<sbyte>();
+            Field9 = random.Generate<Int128>();
             Field10 = withValues ? new(random) : new();
         }
 
@@ -257,6 +257,6 @@ public static bool Equals(in TestEntryData left, in TestEntryData right) =>
     public struct TestDataValues
     {
         int element0;
-        public TestDataValues(Random random) => random.Next((Span<int>)this);
+        public TestDataValues(Random random) => random.Generate((Span<int>)this);
     }
 }
diff --git a/benchmarks/Backdash.Benchmarks/Cases/StructWriteBenchmark.cs b/benchmarks/Backdash.Benchmarks/Cases/StructWriteBenchmark.cs
@@ -11,16 +11,16 @@ namespace Backdash.Benchmarks.Cases;
 [InProcess, MemoryDiagnoser]
 public class StructWriteSingleBenchmark
 {
-    static readonly int tSize = Unsafe.SizeOf<StructData>();
-    readonly byte[] arrayBuffer = new byte[tSize];
+    static readonly int typeSize = Unsafe.SizeOf<StructData>();
+    readonly byte[] arrayBuffer = new byte[typeSize];
 
     StructData data;
 
     [GlobalSetup]
     public void Setup()
     {
         Random random = new(42);
-        data = random.Next<StructData>();
+        data = random.Generate<StructData>();
     }
 
     [IterationSetup]
@@ -67,7 +67,7 @@ public class StructWriteSpanBenchmark
     public void Setup()
     {
         Random random = new(42);
-        dataArray = random.Next<StructData>(N);
+        dataArray = random.Generate<StructData>(N);
         resultArray = new StructData[N];
     }
 
diff --git a/benchmarks/Backdash.Benchmarks/Extensions.cs b/benchmarks/Backdash.Benchmarks/Extensions.cs
diff --git a/samples/Backdash.Samples.sln b/samples/Backdash.Samples.sln
@@ -37,6 +37,7 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "_files", "_files", "{0F1370
 		..\GitVersion.yml = ..\GitVersion.yml
 		..\global.json = ..\global.json
 		..\.config\dotnet-tools.json = ..\.config\dotnet-tools.json
+		..\Directory.Build.props = ..\Directory.Build.props
 	EndProjectSection
 EndProject
 Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "samples", "samples", "{79955002-3B66-49BE-82D3-6EA518A87F5E}"
diff --git a/samples/LobbyServer b/samples/LobbyServer
@@ -1 +1 @@
-Subproject commit 68868ae445cbb0dce44af9814d5e89f3ddfeb1cd
+Subproject commit 3643fc0f797bf502a4cab6ee11e22f98f9b408c8
diff --git a/samples/SpaceWar.Lobby/Game1.cs b/samples/SpaceWar.Lobby/Game1.cs
@@ -33,14 +33,13 @@ protected override void Initialize()
     protected override void LoadContent()
     {
         SpriteBatch = new(GraphicsDevice);
+        SceneManager = new(this, startScene: new ChooseLobbyScene());
 
-        Services.AddService(new GameAssets(Content, GraphicsDevice));
-        Services.AddService(settings);
         Services.AddService(SpriteBatch);
-        Services.AddService(new LobbyHttpClient(settings));
-
-        SceneManager = new(this, startScene: new ChooseLobbyScene());
         Services.AddService(SceneManager);
+        Services.AddService(settings);
+        Services.AddService(new GameAssets(Content, GraphicsDevice));
+        Services.AddService(new LobbyHttpClient(settings));
     }
 
     protected override void Update(GameTime gameTime)
diff --git a/samples/SpaceWar.Lobby/README.md b/samples/SpaceWar.Lobby/README.md
@@ -39,6 +39,7 @@ Ensure the server submodule is updated in the [server directory](https://github.
 
 ```bash
 git submodule update --init --recursive
+git submodule update --recursive --remote
 ```
 
 > [!TIP]
diff --git a/samples/SpaceWar.Shared/SpaceWar.Shared.csproj b/samples/SpaceWar.Shared/SpaceWar.Shared.csproj
@@ -7,10 +7,11 @@
     <Nullable>enable</Nullable>
     <PublishReadyToRun>false</PublishReadyToRun>
     <TieredCompilation>false</TieredCompilation>
+    <CopyLocalLockFileAssemblies>true</CopyLocalLockFileAssemblies>
   </PropertyGroup>
   <ItemGroup>
-    <PackageReference Include="MonoGame.Framework.DesktopGL" Version="3.8.4.1" />
-    <PackageReference Include="MonoGame.Content.Builder.Task" Version="3.8.4.1" />
+    <PackageReference Include="MonoGame.Framework.DesktopGL" Version="3.8.4.1"/>
+    <PackageReference Include="MonoGame.Content.Builder.Task" Version="3.8.4.1"/>
   </ItemGroup>
   <ItemGroup>
     <ProjectReference Include="..\..\src\Backdash\Backdash.csproj"/>
diff --git a/src/Backdash/Core/Extensions.cs b/src/Backdash/Core/Extensions.cs
@@ -1,30 +1,82 @@
-using Backdash.Network;
-using Backdash.Network.Protocol;
+using System.Runtime.InteropServices;
+using Backdash.Core;
 
 namespace Backdash;
 
-static class InternalExtensions
+/// <summary>
+/// Library extensions
+/// </summary>
+public static class NetcodeExtensions
 {
-    public static void EnqueueNext<T>(this Queue<T> queue, in T value)
+    internal static void PushFirst<T>(this Queue<T> queue, in T value)
     {
         var count = queue.Count;
         queue.Enqueue(value);
         for (var i = 0; i < count; i++)
             queue.Enqueue(queue.Dequeue());
     }
 
-    public static PlayerConnectionStatus ToPlayerStatus(this ProtocolStatus status) => status switch
+    /// <summary>
+    /// Return random gaussian number.
+    /// </summary>
+    public static double NextGaussian(this Random @this)
     {
-        ProtocolStatus.Syncing => PlayerConnectionStatus.Syncing,
-        ProtocolStatus.Running => PlayerConnectionStatus.Connected,
-        ProtocolStatus.Disconnected => PlayerConnectionStatus.Disconnected,
-        _ => PlayerConnectionStatus.Unknown,
-    };
+        double u, v, s;
+        do
+        {
+            u = (2.0 * @this.NextDouble()) - 1.0;
+            v = (2.0 * @this.NextDouble()) - 1.0;
+            s = (u * u) + (v * v);
+        } while (s >= 1.0);
 
-    public static IEnumerable<string> SplitToLines(this string value, int size)
+        var fac = Math.Sqrt(-2.0 * Math.Log(s) / s);
+        return u * fac;
+    }
+
+    /// <summary>
+    /// Returns a random <see cref="bool"/>
+    /// </summary>
+    public static bool NextBool(this Random random) => random.Next(2) is 0;
+
+    /// <summary>
+    /// Returns a random <see cref="bool"/> using a success percentage defined by the parameter <paramref name="percentage"/>.
+    /// The <paramref name="percentage"/> must be in between 0 and 1.
+    /// </summary>
+    public static bool NextBool(this Random random, double percentage) =>
+        random.NextDouble() < Math.Clamp(percentage, 0.0, 1.0);
+
+    /// <summary>
+    /// Fill <paramref name="value"/> with random values.
+    /// </summary>
+    public static void Generate<T>(this Random random, scoped ref T value) where T : unmanaged
+    {
+        var bytes = Mem.AsBytes(ref value);
+        random.NextBytes(bytes);
+    }
+
+    /// <summary>
+    /// Return a random <typeparamref name="T"/> value.
+    /// </summary>
+    public static T Generate<T>(this Random random) where T : unmanaged
+    {
+        T result = new();
+        random.Generate(ref result);
+        return result;
+    }
+
+    /// <summary>
+    /// Fill <paramref name="buffer"/> with random <typeparamref name="T"/> values.
+    /// </summary>
+    public static void Generate<T>(this Random random, Span<T> buffer) where T : unmanaged =>
+        random.NextBytes(MemoryMarshal.AsBytes(buffer));
+
+    /// <summary>
+    /// Return an  array with random <typeparamref name="T"/> values.
+    /// </summary>
+    public static T[] Generate<T>(this Random random, int count) where T : unmanaged
     {
-        var chunks = value.Chunk(size);
-        foreach (var chars in chunks)
-            yield return new(chars);
+        var result = new T[count];
+        random.Generate(result.AsSpan());
+        return result;
     }
 }
diff --git a/src/Backdash/Core/Jobs/INetcodeJob.cs b/src/Backdash/Core/Jobs/INetcodeJob.cs
@@ -1,4 +1,4 @@
-﻿namespace Backdash.Core;
+namespace Backdash.Core;
 
 /// <summary>
 /// Defines an asynchronous background job
@@ -14,4 +14,4 @@ public interface INetcodeJob
     /// Job task
     /// </summary>
     Task Start(CancellationToken cancellationToken);
-}
+}
diff --git a/src/Backdash/Core/Mem.cs b/src/Backdash/Core/Mem.cs
@@ -18,7 +18,7 @@ static class Mem
     public static Span<byte> AsBytes<T>(scoped ref readonly T data) where T : unmanaged =>
         MemoryMarshal.AsBytes(new Span<T>(ref Unsafe.AsRef(in data)));
 
-    public static bool ByteEqual(ReadOnlySpan<byte> left, ReadOnlySpan<byte> right, bool truncate = false)
+    public static bool EqualBytes(ReadOnlySpan<byte> left, ReadOnlySpan<byte> right, bool truncate = false)
     {
         if (!truncate) return right.SequenceEqual(left);
         var minLength = Math.Min(left.Length, right.Length);
diff --git a/src/Backdash/Core/RandomNumberGenerator.cs b/src/Backdash/Core/RandomNumberGenerator.cs
@@ -21,17 +21,5 @@ public ushort SyncNumber()
 
     public int NextInt() => random.Next();
 
-    public double NextGaussian()
-    {
-        double u, v, s;
-        do
-        {
-            u = (2.0 * random.NextDouble()) - 1.0;
-            v = (2.0 * random.NextDouble()) - 1.0;
-            s = (u * u) + (v * v);
-        } while (s >= 1.0);
-
-        var fac = Math.Sqrt(-2.0 * Math.Log(s) / s);
-        return u * fac;
-    }
+    public double NextGaussian() => random.NextGaussian();
 }
diff --git a/src/Backdash/Network/Messages/InputMessage.cs b/src/Backdash/Network/Messages/InputMessage.cs
@@ -91,11 +91,11 @@ public readonly bool Equals(in InputMessage other) =>
         PeerConnectStatus.Equals(other.PeerConnectStatus) &&
         Bits.Equals(other.Bits);
 
-    public override readonly bool Equals(object? obj) => obj is InputMessage other && Equals(in other);
+    public readonly override bool Equals(object? obj) => obj is InputMessage other && Equals(in other);
 
     readonly bool IEquatable<InputMessage>.Equals(InputMessage other) => Equals(in other);
 
-    public override readonly int GetHashCode() => HashCode.Combine(
+    public readonly override int GetHashCode() => HashCode.Combine(
         PeerCount, PeerConnectStatus, StartFrame,
         DisconnectRequested, AckFrame, NumBits, InputSize,
         Bits
@@ -113,7 +113,7 @@ struct PeerStatusBuffer : IEquatable<PeerStatusBuffer>
     ConnectStatus element0;
     public PeerStatusBuffer(ReadOnlySpan<ConnectStatus> buffer) => buffer.CopyTo(this);
 
-    public override readonly string ToString()
+    public readonly override string ToString()
     {
         ReadOnlySpan<ConnectStatus> values = this;
         StringBuilder builder = new();
@@ -138,9 +138,9 @@ public override readonly string ToString()
         return builder.ToString();
     }
 
-    public override readonly int GetHashCode() => Mem.GetHashCode<ConnectStatus>(this);
+    public readonly override int GetHashCode() => Mem.GetHashCode<ConnectStatus>(this);
     public readonly bool Equals(PeerStatusBuffer other) => this[..].SequenceEqual(other);
-    public override readonly bool Equals(object? obj) => obj is PeerStatusBuffer other && Equals(other);
+    public readonly override bool Equals(object? obj) => obj is PeerStatusBuffer other && Equals(other);
 }
 
 [Serializable, InlineArray(Max.CompressedBytes)]
@@ -149,12 +149,12 @@ struct InputMessageBuffer : IEquatable<InputMessageBuffer>
     byte element0;
     public InputMessageBuffer(ReadOnlySpan<byte> bits) => bits.CopyTo(this);
 
-    public override readonly string ToString() => Mem.GetBitString(this);
-    public override readonly int GetHashCode() => Mem.GetHashCode<byte>(this);
+    public readonly override string ToString() => Mem.GetBitString(this);
+    public readonly override int GetHashCode() => Mem.GetHashCode<byte>(this);
 
-    public readonly bool Equals(in InputMessageBuffer other) => Mem.ByteEqual(this, other, truncate: true);
+    public readonly bool Equals(in InputMessageBuffer other) => Mem.EqualBytes(this, other, truncate: true);
 
-    public override readonly bool Equals(object? obj) => obj is InputMessageBuffer other && Equals(other);
+    public readonly override bool Equals(object? obj) => obj is InputMessageBuffer other && Equals(other);
 
     readonly bool IEquatable<InputMessageBuffer>.Equals(InputMessageBuffer other) => Equals(in other);
 }
diff --git a/src/Backdash/Network/Protocol/Comm/ProtocolInputBuffer.cs b/src/Backdash/Network/Protocol/Comm/ProtocolInputBuffer.cs
@@ -134,7 +134,7 @@ SendInputResult FillInputMessage(ref InputMessage inputMessage)
                 {
                     logger.Write(LogLevel.Warning,
                         $"Max input size reached. Sending inputs until frame {current.Frame.Previous()}");
-                    pendingOutput.EnqueueNext(in current);
+                    pendingOutput.PushFirst(in current);
                     messageBodyOverflow = true;
                     break;
                 }
diff --git a/src/Backdash/Network/Protocol/ProtocolStatus.cs b/src/Backdash/Network/Protocol/ProtocolStatus.cs
diff --git a/src/Backdash/Serialization/Internal/DeltaXorRleEncoder.cs b/src/Backdash/Serialization/Internal/DeltaXorRleEncoder.cs
diff --git a/src/Backdash/Serialization/Internal/EndiannessSerializer.cs b/src/Backdash/Serialization/Internal/EndiannessSerializer.cs
diff --git a/src/Backdash/Synchronizing/Input/IInputGenerator.cs b/src/Backdash/Synchronizing/Input/IInputGenerator.cs

Original file line number	Diff line number	Diff line change
`@@ -11,16 +11,16 @@ namespace Backdash.Benchmarks.Cases;`
`11`	`11`	`[InProcess, MemoryDiagnoser]`
`12`	`12`	`public class StructWriteSingleBenchmark`
`13`	`13`	`{`
`14`		`- static readonly int tSize = Unsafe.SizeOf<StructData>();`
`15`		`- readonly byte[] arrayBuffer = new byte[tSize];`
	`14`	`+ static readonly int typeSize = Unsafe.SizeOf<StructData>();`
	`15`	`+ readonly byte[] arrayBuffer = new byte[typeSize];`
`16`	`16`
`17`	`17`	`StructData data;`
`18`	`18`
`19`	`19`	`[GlobalSetup]`
`20`	`20`	`public void Setup()`
`21`	`21`	`{`
`22`	`22`	`Random random = new(42);`
`23`		`- data = random.Next<StructData>();`
	`23`	`+ data = random.Generate<StructData>();`
`24`	`24`	`}`
`25`	`25`
`26`	`26`	`[IterationSetup]`
`@@ -67,7 +67,7 @@ public class StructWriteSpanBenchmark`
`67`	`67`	`public void Setup()`
`68`	`68`	`{`
`69`	`69`	`Random random = new(42);`
`70`		`- dataArray = random.Next<StructData>(N);`
	`70`	`+ dataArray = random.Generate<StructData>(N);`
`71`	`71`	`resultArray = new StructData[N];`
`72`	`72`	`}`
`73`	`73`