Changed: Fixed large buffer rent caused by the default implementation of Stream.Read(Span<byte>)

Changed: Nuget package publishing
Removed: qodana.yml
Removed: NOTICE.md reference

Signed-off-by: JOSE FUXA <[email protected]>

Author: j-fuxa

.editorconfig

@@ -1,5 +1,4 @@
-# EditorConfig is awesome:
-http://EditorConfig.org
+# EditorConfig is awesome: http://EditorConfig.org
 
 # top-most EditorConfig file
 root = true
@@ -12,6 +11,8 @@ trim_trailing_whitespace = true
 
 # C# files
 [*.cs]
+charset = utf-8
+
 # New line preferences
 csharp_new_line_before_open_brace = none
 csharp_new_line_before_catch = false
@@ -21,6 +22,13 @@ csharp_new_line_before_members_in_anonymous_types = false
 csharp_new_line_before_members_in_object_initializers = false
 csharp_new_line_within_query_expression_clauses = true
 
+# use file-scoped namespaces
+csharp_style_namespace_declarations = file_scoped
+dotnet_diagnostic.IDE0161.severity = error
+
+# use ValueTasks correctly
+dotnet_diagnostic.CA2012.severity = error
+
 # Indentation preferences
 csharp_indent_block_contents = true
 csharp_indent_braces = false

.github/workflows/qodana.yml

@@ -3,6 +3,11 @@ on:
   push:
     tags:
       - "v*"
+
+permissions:
+    contents: read
+    packages: write
+
 jobs:
   release:
     runs-on: ubuntu-latest
@@ -22,7 +27,7 @@ jobs:
       - name: Build, Pack and Publish
         run: |
           dotnet pack /p:Version=${{ steps.get_version.outputs.version }} -o artefacts -c Release src/EventStore.Plugins/EventStore.Plugins.csproj
-          dotnet nuget push artefacts/EventStore.Plugins.${{ steps.get_version.outputs.version }}.nupkg -k ${{ secrets.nugetkey }} -s https://api.nuget.org/v3/index.json
+          dotnet nuget push artefacts/EventStore.Plugins.${{ steps.get_version.outputs.version }}.nupkg -k ${{ secrets.GITHUB_TOKEN }} -s https://nuget.pkg.github.com/TrogonStack/index.json
       - name: Create Release
         id: create_release
         uses: actions/create-release@v1

.github/workflows/release.yml

@@ -12,7 +12,6 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution
 		.editorconfig = .editorconfig
 		.gitignore = .gitignore
 		LICENSE.md = LICENSE.md
-		NOTICE.md = NOTICE.md
 		qodana.yaml = qodana.yaml
 		README.md = README.md
 	EndProjectSection

EventStore.Plugins.sln

@@ -8,7 +8,7 @@
 		<Nullable>enable</Nullable>
 		<InvariantGlobalization>true</InvariantGlobalization>
 	</PropertyGroup>
-	
+
 	<PropertyGroup>
 		<PackageId>EventStore.Plugins</PackageId>
 		<Authors>Event Store Ltd</Authors>
@@ -21,19 +21,24 @@
 		<Copyright>Copyright 2012-2024 Event Store Ltd</Copyright>
 		<PackageTags>eventstore plugins</PackageTags>
 	</PropertyGroup>
-	
+
+	<PropertyGroup>
+		<RepositoryUrl>https://github.com/TrogonStack/TrogonEventStore.Plugins</RepositoryUrl>
+		<RepositoryType>git</RepositoryType>
+	</PropertyGroup>
+
 	<ItemGroup>
 		<PackageReference Include="Microsoft.IdentityModel.JsonWebTokens" Version="7.6.0" />
 		<PackageReference Include="System.Diagnostics.DiagnosticSource" Version="8.0.1" />
 		<PackageReference Include="YamlDotNet" Version="15.1.4" />
 		<PackageReference Include="JetBrains.Annotations" Version="2023.3.0" />
 		<PackageReference Include="System.Reactive" Version="6.0.1" />
 	</ItemGroup>
-	
+
 	<ItemGroup>
 		<FrameworkReference Include="Microsoft.AspNetCore.App" />
 	</ItemGroup>
-	
+
 	<ItemGroup>
 		<None Include="..\..\LICENSE.md" Pack="true" PackagePath="\" />
 		<None Include="..\..\ouro.png" Pack="true" PackagePath="\" />

src/EventStore.Plugins/EventStore.Plugins.csproj

@@ -1,5 +1,4 @@
-using System;
-using System.IO;
+using System.Runtime.CompilerServices;
 
 namespace EventStore.Plugins.Transforms;
 
@@ -10,12 +9,26 @@ public class ChunkDataReadStream(Stream chunkFileStream) : Stream {
 	public sealed override bool CanSeek => true;
 	public sealed override bool CanWrite => false;
 	public sealed override void Write(byte[] buffer, int offset, int count) => throw new InvalidOperationException();
+	public override void Write(ReadOnlySpan<byte> buffer) => throw new InvalidOperationException();
+	public sealed override void WriteByte(byte value) => throw new InvalidOperationException();
+
 	public sealed override void Flush() => throw new InvalidOperationException();
 	public sealed override void SetLength(long value) => throw new InvalidOperationException();
 	public override long Length => throw new NotSupportedException();
 
-	// reads must always return exactly `count` bytes as we never read past the (flushed) writer checkpoint
-	public override int Read(byte[] buffer, int offset, int count) => ChunkFileStream.Read(buffer, offset, count);
+	public sealed override int Read(byte[] buffer, int offset, int count) {
+		ValidateBufferArguments(buffer, offset, count);
+
+		return Read(buffer.AsSpan(offset, count));
+	}
+
+	// reads must always return exactly `Span<byte>.Length` bytes as we never read past the (flushed) writer checkpoint
+	public override int Read(Span<byte> buffer) => ChunkFileStream.Read(buffer);
+
+	public sealed override int ReadByte() {
+		Unsafe.SkipInit(out byte value);
+		return Read(new(ref value)) is 1 ? value : -1;
+	}
 
 	// seeks need to support only `SeekOrigin.Begin`
 	public override long Seek(long offset, SeekOrigin origin) {

src/EventStore.Plugins/Transforms/ChunkDataReadStream.cs

@@ -12,6 +12,9 @@ public class ChunkDataWriteStream(Stream chunkFileStream, HashAlgorithm checksum
 	public sealed override bool CanSeek => false;
 	public sealed override bool CanWrite => true;
 	public sealed override int Read(byte[] buffer, int offset, int count) => throw new InvalidOperationException();
+	public sealed override int Read(Span<byte> buffer) => throw new InvalidOperationException();
+	public sealed override int ReadByte() => throw new InvalidOperationException();
+
 	public sealed override long Seek(long offset, SeekOrigin origin) => throw new InvalidOperationException();
 
 	public override void Write(byte[] buffer, int offset, int count) {
@@ -22,6 +25,7 @@ public override void Write(byte[] buffer, int offset, int count) {
 	public override void Flush() => ChunkFileStream.Flush();
 	public override void SetLength(long value) => ChunkFileStream.SetLength(value);
 	public override long Length => ChunkFileStream.Length;
+
 	public override long Position {
 		get => ChunkFileStream.Position;
 		set {
@@ -31,7 +35,8 @@ public override long Position {
 			ReadAndChecksum(value);
 
 			if (ChunkFileStream.Position != value)
-				throw new Exception($"Writer's position ({ChunkFileStream.Position:N0}) is not at the expected position ({value:N0})");
+				throw new Exception(
+					$"Writer's position ({ChunkFileStream.Position:N0}) is not at the expected position ({value:N0})");
 		}
 	}