Merge pull request #44 from Blaisor/async

Added support for TryReadAsync() with CancellationToken

Author: nblumhardt

src/Serilog.Formatting.Compact.Reader/LogEventReader.cs

@@ -102,6 +102,27 @@ public bool TryRead([NotNullWhen(true)] out LogEvent? evt)
         return ParseLine(line);
     }
 
+#if FEATURE_READ_LINE_ASYNC_CANCELLATION
+    /// <inheritdoc cref="TryReadAsync()" />
+    /// <param name="cancellationToken">The token to monitor for cancellation requests.</param>
+    public async Task<LogEvent?> TryReadAsync(CancellationToken cancellationToken)
+    {
+        var line = await _text.ReadLineAsync(cancellationToken).ConfigureAwait(false);
+        _lineNumber++;
+        while (string.IsNullOrWhiteSpace(line))
+        {
+            if (line == null)
+            {
+                return null;
+            }
+            line = await _text.ReadLineAsync(cancellationToken).ConfigureAwait(false);
+            _lineNumber++;
+        }
+
+        return ParseLine(line);
+    }
+#endif
+
     /// <summary>
     /// Read a single log event from a JSON-encoded document.
     /// </summary>

src/Serilog.Formatting.Compact.Reader/Serilog.Formatting.Compact.Reader.csproj

@@ -28,6 +28,10 @@
     <ImplicitUsings>enable</ImplicitUsings>
   </PropertyGroup>
 
+  <PropertyGroup Condition=" '$(TargetFramework)' == 'net8.0' ">
+    <DefineConstants>$(DefineConstants);FEATURE_READ_LINE_ASYNC_CANCELLATION</DefineConstants>
+  </PropertyGroup>
+
   <ItemGroup>
     <PackageReference Include="Newtonsoft.Json" Version="13.0.3" />
     <PackageReference Include="Serilog" Version="4.0.0" />

test/Serilog.Formatting.Compact.Reader.Tests/LogEventReaderTests.cs

@@ -4,6 +4,7 @@
 using System;
 using System.Collections.Generic;
 using System.IO;
+using System.Threading;
 using System.Threading.Tasks;
 using Xunit;
 
@@ -157,6 +158,11 @@ public async Task InvalidDataThrowsInvalidDataException(string document)
         using var asyncReader = new LogEventReader(new StringReader(document));
         await Assert.ThrowsAsync<InvalidDataException>(asyncReader.TryReadAsync);
 
+#if NET7_0_OR_GREATER
+        using var asyncReader2 = new LogEventReader(new StringReader(document));
+        await Assert.ThrowsAsync<InvalidDataException>(async () => await asyncReader2.TryReadAsync(CancellationToken.None));
+#endif
+
         Assert.Throws<InvalidDataException>(() => LogEventReader.ReadFromString(document));
     }
 }