Release 5.17.1

Author: sakno

CHANGELOG.md

@@ -1,6 +1,10 @@
 Release Notes
 ====
 
+# 12-30-2024
+<a href="https://www.nuget.org/packages/dotnext.io/5.17.1">DotNext.IO 5.17.1</a>
+* Fixed `EndOfStreamException` caused by async read from `PoolingBufferedStream`
+
 # 12-29-2024
 This release is aimed to improve AOT compatibility. All the examples in the repo are now AOT compatible.
 <a href="https://www.nuget.org/packages/dotnext/5.17.0">DotNext 5.17.0</a>

README.md

@@ -66,7 +66,7 @@ This release is aimed to improve AOT compatibility. All the examples in the repo
 <a href="https://www.nuget.org/packages/dotnext.threading/5.17.0">DotNext.Threading 5.17.0</a>
 * Improved AOT support
 
-<a href="https://www.nuget.org/packages/dotnext.io/5.17.0">DotNext.IO 5.17.0</a>
+<a href="https://www.nuget.org/packages/dotnext.io/5.17.1">DotNext.IO 5.17.1</a>
 * Reduced memory consumption for applications that use `FileReader` and `FileWriter` classes. These classes are now implemented by using lazy buffer pattern. It means that the different instances can reuse the same buffer taken from the pool
 * Fixed [255](https://github.com/dotnet/dotNext/issues/255)
 * `PoolingBufferedStream` is introduced to replace classic [BufferedStream](https://learn.microsoft.com/en-us/dotnet/api/system.io.bufferedstream). This class supports memory pooling and implements lazy buffer pattern

src/DotNext.IO/DotNext.IO.csproj

@@ -11,7 +11,7 @@
     <Authors>.NET Foundation and Contributors</Authors>
     <Company />
     <Product>.NEXT Family of Libraries</Product>
-    <VersionPrefix>5.17.0</VersionPrefix>
+    <VersionPrefix>5.17.1</VersionPrefix>
     <VersionSuffix></VersionSuffix>
     <AssemblyName>DotNext.IO</AssemblyName>
     <PackageLicenseExpression>MIT</PackageLicenseExpression>

src/DotNext.IO/IO/PoolingBufferedStream.cs

@@ -477,7 +477,7 @@ public override ValueTask<int> ReadAsync(Memory<byte> data, CancellationToken to
         {
             task = ValueTask.FromException<int>(new NotSupportedException());
         }
-        else if (buffer.IsEmpty)
+        else if (data.IsEmpty)
         {
             task = new(result: 0);
         }

src/DotNext.Tests/IO/PoolingBufferedStreamTests.cs

@@ -341,4 +341,36 @@ public static void ResetBuffer()
         bufferedStream.Reset();
         False(bufferedStream.HasBufferedDataToWrite);
     }
+
+    [Fact]
+    public static void ReadFromFile()
+    {
+        var expected = RandomBytes(4096);
+        using var handle = File.OpenHandle(Path.Combine(Path.GetTempPath(), Path.GetRandomFileName()), FileMode.CreateNew, FileAccess.ReadWrite,
+            options: FileOptions.DeleteOnClose);
+        RandomAccess.Write(handle, expected, fileOffset: 0L);
+        RandomAccess.FlushToDisk(handle);
+
+        using var bufferedStream = new PoolingBufferedStream(handle.AsUnbufferedStream(FileAccess.Read)) { MaxBufferSize = 128 };
+        var actual = new byte[expected.Length];
+        bufferedStream.ReadExactly(actual);
+
+        Equal(expected, actual);
+    }
+    
+    [Fact]
+    public static async Task ReadFromFileAsync()
+    {
+        var expected = RandomBytes(4096);
+        using var handle = File.OpenHandle(Path.Combine(Path.GetTempPath(), Path.GetRandomFileName()), FileMode.CreateNew, FileAccess.ReadWrite,
+            options: FileOptions.DeleteOnClose | FileOptions.Asynchronous);
+        await RandomAccess.WriteAsync(handle, expected, fileOffset: 0L);
+        RandomAccess.FlushToDisk(handle);
+
+        await using var bufferedStream = new PoolingBufferedStream(handle.AsUnbufferedStream(FileAccess.Read)) { MaxBufferSize = 128 };
+        var actual = new byte[expected.Length];
+        await bufferedStream.ReadExactlyAsync(actual);
+
+        Equal(expected, actual);
+    }
 }

src/examples/HyParViewPeer/Program.cs

@@ -132,8 +132,8 @@ static Task PrintNeighborsAsync(HttpContext context)
 
 file sealed class RumorSender : Disposable, IRumorSender
 {
-    internal const string SenderAddressHeader = "X-Sender-Address";
-    internal const string SenderIdHeader = "X-Rumor-ID";
+    private const string SenderAddressHeader = "X-Sender-Address";
+    private const string SenderIdHeader = "X-Rumor-ID";
 
     internal const string RumorResource = "/rumor";
     internal const string BroadcastResource = "/broadcast";