Merge pull request #69 from rameel/multitarget-net6-net8

Add net6.0/net8.0 multitargeting with polyfills

Author: rameel

.github/workflows/tests.yml

@@ -28,10 +28,14 @@ jobs:
             10.x
       - name: Checkout
         uses: actions/checkout@v4
-      - name: Build
+      - name: Build (Debug)
         run: dotnet build -c Debug
-      - name: Test
-        run: dotnet test --no-build --filter "TestCategory!~Cloud"
+      - name: Build (Release)
+        run: dotnet build -c Release
+      - name: Test (Debug)
+        run: dotnet test -c Debug --no-build --filter "TestCategory!~Cloud"
+      - name: Test (Release)
+        run: dotnet test -c Release --no-build --filter "TestCategory!~Cloud"
 
   azure:
     name: "Test: AzureFileSystem"
@@ -88,4 +92,4 @@ jobs:
       - name: Build
         run: dotnet build -c Debug
       - name: Test
-        run: dotnet test --no-build --filter TestCategory=Cloud:Amazon
+        run: dotnet test --no-build --filter TestCategory=Cloud:Amazon -maxcpucount:1

Directory.Packages.props

@@ -8,7 +8,7 @@
     <PackageVersion Include="Azure.Storage.Blobs" Version="12.27.0" />
     <PackageVersion Include="Azure.Storage.Blobs.Batch" Version="12.24.0" />
     <PackageVersion Include="Google.Cloud.Storage.V1" Version="4.14.0" />
-    <PackageVersion Include="Microsoft.Extensions.FileProviders.Abstractions" Version="6.0.1" />
+    <PackageVersion Include="Microsoft.Extensions.FileProviders.Abstractions" Version="8.0.0" />
     <PackageVersion Include="Microsoft.Extensions.FileProviders.Physical" Version="6.0.1" />
     <PackageVersion Include="Microsoft.NET.Test.Sdk" Version="17.13.0" />
     <PackageVersion Include="Microsoft.SourceLink.GitHub" Version="8.0.0" />

src/Ramstack.FileSystem.Abstractions/Ramstack.FileSystem.Abstractions.csproj

@@ -1,7 +1,7 @@
 <Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
-    <TargetFramework>net6.0</TargetFramework>
+    <TargetFrameworks>net6.0;net8.0</TargetFrameworks>
     <Description>A .NET library that provides a virtual file system abstraction.</Description>
     <ImplicitUsings>enable</ImplicitUsings>
     <Nullable>enable</Nullable>

src/Ramstack.FileSystem.Abstractions/Utilities/StreamReaderExtensions.cs

@@ -0,0 +1,62 @@
+#if NET6_0
+using System.Buffers;
+using System.Text;
+
+// ReSharper disable once CheckNamespace
+namespace System.IO;
+/// <summary>
+/// Provides extension methods for the <see cref="StreamReader"/> to offer API compatibility with newer .NET versions.
+/// </summary>
+public static class StreamReaderExtensions
+{
+    /// <summary>
+    /// Reads a line of characters asynchronously from the current stream and returns the data as a string.
+    /// </summary>
+    /// <param name="reader">The <see cref="StreamReader"/> to read from.</param>
+    /// <param name="cancellationToken">An optional cancellation token to cancel the operation.</param>
+    /// <returns>
+    /// A <see cref="ValueTask{TResult}"/> that represents the asynchronous read operation.
+    /// The value of the task contains the next line from the stream, or is <see langword="null"/>
+    /// if the end of the stream is reached.
+    /// </returns>
+    public static ValueTask<string?> ReadLineAsync(this StreamReader reader, CancellationToken cancellationToken = default)
+    {
+        if (cancellationToken.IsCancellationRequested)
+            return ValueTask.FromCanceled<string?>(cancellationToken);
+
+        return new ValueTask<string?>(reader.ReadLineAsync());
+    }
+
+    /// <summary>
+    /// Reads all characters from the current position to the end of the stream asynchronously and returns them as one string.
+    /// </summary>
+    /// <param name="reader">The <see cref="StreamReader"/> to read from.</param>
+    /// <param name="cancellationToken">An optional cancellation token to cancel the operation.</param>
+    /// <returns>
+    /// A <see cref="Task{TResult}"/> that represents the asynchronous read operation.
+    /// The value of the task contains a string with the characters from the current position to the end of the stream.
+    /// </returns>
+    public static async Task<string> ReadToEndAsync(this StreamReader reader, CancellationToken cancellationToken = default)
+    {
+        const int BufferSize = 4096;
+
+        var chars = ArrayPool<char>.Shared.Rent(BufferSize);
+        var sb = new StringBuilder();
+
+        while (true)
+        {
+            var count = await reader
+                .ReadAsync(new Memory<char>(chars), cancellationToken)
+                .ConfigureAwait(false);
+
+            if (count == 0)
+                break;
+
+            sb.Append(chars.AsSpan(0, count));
+        }
+
+        ArrayPool<char>.Shared.Return(chars);
+        return sb.ToString();
+    }
+}
+#endif

src/Ramstack.FileSystem.Abstractions/VirtualFileExtensions.cs

@@ -74,44 +74,11 @@ public static ValueTask<string> ReadAllTextAsync(this VirtualFile file, Cancella
     /// </returns>
     public static async ValueTask<string> ReadAllTextAsync(this VirtualFile file, Encoding? encoding, CancellationToken cancellationToken = default)
     {
-        //
-        // Use a manual read loop since .NET 6 lacks a StreamReader.ReadToEndAsync overload that accepts a CancellationToken.
-        // This ensures the operation remains responsive to cancellation requests.
-        //
-
-        const int BufferSize = 4096;
-
         // ReSharper disable once UseAwaitUsing
         using var stream = await file.OpenReadAsync(cancellationToken).ConfigureAwait(false);
-        var reader = new StreamReader(stream, encoding ??= Encoding.UTF8);
-        var buffer = (char[]?)null;
-
-        try
-        {
-            cancellationToken.ThrowIfCancellationRequested();
-
-            buffer = ArrayPool<char>.Shared.Rent(encoding.GetMaxCharCount(BufferSize));
-            var sb = new StringBuilder();
-
-            while (true)
-            {
-                var count = await reader
-                    .ReadAsync(new Memory<char>(buffer), cancellationToken)
-                    .ConfigureAwait(false);
-
-                if (count == 0)
-                    return sb.ToString();
-
-                sb.Append(buffer.AsSpan(0, count));
-            }
-        }
-        finally
-        {
-            reader.Dispose();
+        using var reader = new StreamReader(stream, encoding!);
 
-            if (buffer is not null)
-                ArrayPool<char>.Shared.Return(buffer);
-        }
+        return  await reader.ReadToEndAsync(cancellationToken).ConfigureAwait(false);
     }
 
     /// <summary>
@@ -142,11 +109,8 @@ public static async ValueTask<string[]> ReadAllLinesAsync(this VirtualFile file,
         using var reader = new StreamReader(stream, encoding!);
 
         var list = new List<string>();
-        while (await reader.ReadLineAsync().ConfigureAwait(false) is { } line)
-        {
-            cancellationToken.ThrowIfCancellationRequested();
+        while (await reader.ReadLineAsync(cancellationToken).ConfigureAwait(false) is { } line)
             list.Add(line);
-        }
 
         return list.ToArray();
     }
@@ -165,7 +129,7 @@ public static async ValueTask<byte[]> ReadAllBytesAsync(this VirtualFile file, C
         // ReSharper disable once UseAwaitUsing
         using var stream = await file.OpenReadAsync(cancellationToken).ConfigureAwait(false);
 
-        var length = GetStreamLength(stream);
+        var length = stream.CanSeek ? stream.Length : 0;
         if (length > Array.MaxLength)
             throw new IOException("The file is too large.");
 
@@ -179,15 +143,15 @@ static async ValueTask<byte[]> ReadAllBytesImplAsync(Stream stream, Cancellation
         {
             var bytes = new byte[stream.Length];
             var index = 0;
+
             do
             {
                 var count = await stream.ReadAsync(bytes.AsMemory(index), cancellationToken).ConfigureAwait(false);
                 if (count == 0)
                     Error_EndOfStream();
 
                 index += count;
-            }
-            while (index < bytes.Length);
+            } while (index < bytes.Length);
 
             return bytes;
         }
@@ -225,29 +189,11 @@ static byte[] ResizeBuffer(byte[] oldArray)
                 var newArray = ArrayPool<byte>.Shared.Rent((int)length);
                 oldArray.AsSpan().TryCopyTo(newArray);
 
-                var rented = oldArray;
-                oldArray = newArray;
-
-                ArrayPool<byte>.Shared.Return(rented);
-                return oldArray;
+                ArrayPool<byte>.Shared.Return(oldArray);
+                return newArray;
             }
         }
 
-        static long GetStreamLength(Stream stream)
-        {
-            try
-            {
-                if (stream.CanSeek)
-                    return stream.Length;
-            }
-            catch
-            {
-                // skip
-            }
-
-            return 0;
-        }
-
         static void Error_EndOfStream() =>
             throw new EndOfStreamException();
     }
@@ -334,7 +280,7 @@ public static async ValueTask WriteAllLinesAsync(this VirtualFile file, IEnumera
         await using var writer = new StreamWriter(stream, encoding, bufferSize: -1, leaveOpen: false);
 
         foreach (var line in contents)
-            await writer.WriteLineAsync(line).ConfigureAwait(false);
+            await writer.WriteLineAsync(line.AsMemory(), cancellationToken).ConfigureAwait(false);
     }
 
     /// <summary>

src/Ramstack.FileSystem.Adapters/Ramstack.FileSystem.Adapters.csproj

@@ -1,7 +1,7 @@
 <Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
-    <TargetFramework>net6.0</TargetFramework>
+    <TargetFrameworks>net6.0;net8.0</TargetFrameworks>
     <Description>Provides adapters for integrating Ramstack.FileSystem with Microsoft.Extensions.FileProviders.</Description>
     <ImplicitUsings>enable</ImplicitUsings>
     <Nullable>enable</Nullable>
@@ -43,8 +43,15 @@
     </Compile>
   </ItemGroup>
 
-  <ItemGroup>
+  <ItemGroup Condition="'$(TargetFramework)' == 'net6.0'">
+    <PackageReference Include="Microsoft.Extensions.FileProviders.Abstractions" VersionOverride="6.0.1" />
+  </ItemGroup>
+
+  <ItemGroup Condition="'$(TargetFramework)' == 'net8.0'">
     <PackageReference Include="Microsoft.Extensions.FileProviders.Abstractions" />
+  </ItemGroup>
+
+  <ItemGroup>
     <PackageReference Include="Microsoft.SourceLink.GitHub">
       <PrivateAssets>all</PrivateAssets>
       <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>

src/Ramstack.FileSystem.Amazon/Ramstack.FileSystem.Amazon.csproj

@@ -1,7 +1,7 @@
 <Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
-    <TargetFramework>net6.0</TargetFramework>
+    <TargetFrameworks>net6.0;net8.0</TargetFrameworks>
     <Description>Provides an implementation of Ramstack.FileSystem using Amazon S3 storage.</Description>
     <ImplicitUsings>enable</ImplicitUsings>
     <Nullable>enable</Nullable>

src/Ramstack.FileSystem.Composite/Ramstack.FileSystem.Composite.csproj

@@ -1,7 +1,7 @@
 <Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
-    <TargetFramework>net6.0</TargetFramework>
+    <TargetFrameworks>net6.0;net8.0</TargetFrameworks>
     <Description>Provides an implementation of Ramstack.FileSystem that combines multiple file systems into a single composite file system.</Description>
     <ImplicitUsings>enable</ImplicitUsings>
     <Nullable>enable</Nullable>

src/Ramstack.FileSystem.Globbing/Internal/PathHelper.cs

@@ -249,7 +249,7 @@ public PathSegmentIterator() =>
                 if (Avx2.IsSupported && (int)_position + Vector256<ushort>.Count <= length)
                 {
                     var chunk = LoadVector256(ref source, _position);
-                    var slash = Vector256.Create('/');
+                    var slash = Vector256.Create((ushort)'/');
                     var comparison = Avx2.CompareEqual(chunk, slash);
 
                     //
@@ -269,7 +269,7 @@ public PathSegmentIterator() =>
                 else if (Sse2.IsSupported && !Avx2.IsSupported && (int)_position + Vector128<ushort>.Count <= length)
                 {
                     var chunk = LoadVector128(ref source, _position);
-                    var slash = Vector128.Create('/');
+                    var slash = Vector128.Create((ushort)'/');
                     var comparison = Sse2.CompareEqual(chunk, slash);
 
                     //
@@ -289,7 +289,7 @@ public PathSegmentIterator() =>
                 else if (AdvSimd.Arm64.IsSupported && (int)_position + Vector128<ushort>.Count <= length)
                 {
                     var chunk = LoadVector128(ref source, _position);
-                    var slash = Vector128.Create('/');
+                    var slash = Vector128.Create((ushort)'/');
                     var comparison = AdvSimd.CompareEqual(chunk, slash);
 
                     //

src/Ramstack.FileSystem.Globbing/Ramstack.FileSystem.Globbing.csproj

@@ -1,7 +1,7 @@
 <Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
-    <TargetFramework>net6.0</TargetFramework>
+    <TargetFrameworks>net6.0;net8.0</TargetFrameworks>
     <Description>Provides an implementation of Ramstack.FileSystem that applies glob-based filtering rules to the underlying file system.</Description>
     <ImplicitUsings>enable</ImplicitUsings>
     <Nullable>enable</Nullable>