Implement FluidValue.WriteToAsync

Fixes #647
sebastienros · May 29, 2024 · 9588669 · 9588669
1 parent 1e9c992
commit 9588669
Show file tree

Hide file tree

Showing 34 changed files with 420 additions and 99 deletions.
diff --git a/Fluid.MvcViewEngine/Fluid.MvcViewEngine.csproj b/Fluid.MvcViewEngine/Fluid.MvcViewEngine.csproj
@@ -1,7 +1,7 @@
 <Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
-    <TargetFrameworks>net6.0;net8.0</TargetFrameworks>
+    <TargetFrameworks>net6.0;net7.0;net8.0</TargetFrameworks>
     <LangVersion>latest</LangVersion>
     <PackageIcon>logo_64x64.png</PackageIcon>
     <IsPackable>true</IsPackable>

diff --git a/Fluid.Tests/Domain/WithInterfaces/PetValue.cs b/Fluid.Tests/Domain/WithInterfaces/PetValue.cs
@@ -3,6 +3,7 @@
 using System.Globalization;
 using System.IO;
 using System.Text.Encodings.Web;
+using System.Threading.Tasks;
 
 namespace Fluid.Tests.Domain.WithInterfaces
 {
@@ -42,11 +43,17 @@ public override string ToStringValue()
             throw new NotImplementedException();
         }
 
+        [Obsolete("WriteTo is obsolete, prefer the WriteToAsync method.")]
         public override void WriteTo(TextWriter writer, TextEncoder encoder, CultureInfo cultureInfo)
         {
             throw new NotImplementedException();
         }
 
+        public override ValueTask WriteToAsync(TextWriter writer, TextEncoder encoder, CultureInfo cultureInfo)
+        {
+            throw new NotImplementedException();
+        }
+
         protected override FluidValue GetValue(string name, TemplateContext context)
         {
             if (name == "Name")

diff --git a/Fluid.Tests/MvcViewEngine/NoSyncStream.cs b/Fluid.Tests/MvcViewEngine/NoSyncStream.cs
@@ -0,0 +1,30 @@
+using System;
+using System.IO;
+using System.Threading;
+using System.Threading.Tasks;
+
+namespace Fluid.Tests.MvcViewEngine
+{
+    /// <summary>
+    /// Stream implementation that prevents non-async usages.
+    /// </summary>
+    public sealed class NoSyncStream : Stream
+    {
+        public override Task FlushAsync(CancellationToken cancellationToken) => Task.CompletedTask;
+        public override Task WriteAsync(byte[] buffer, int offset, int count, CancellationToken cancellationToken) => Task.CompletedTask;
+        public override ValueTask WriteAsync(ReadOnlyMemory<byte> source, CancellationToken cancellationToken = default) => ValueTask.CompletedTask;
+
+
+        public override void Flush() => throw new InvalidOperationException();
+        public override int Read(byte[] buffer, int offset, int count) => throw new InvalidOperationException();
+        public override long Seek(long offset, SeekOrigin origin) => throw new InvalidOperationException();
+        public override void SetLength(long value) => throw new InvalidOperationException();
+        public override void Write(byte[] buffer, int offset, int count) => throw new InvalidOperationException();
+
+        public override bool CanRead { get; } = false;
+        public override bool CanSeek { get; } = false;
+        public override bool CanWrite { get; } = true;
+        public override long Length { get; }
+        public override long Position { get; set; }
+    }
+}
diff --git a/Fluid.Tests/MvcViewEngine/ViewEngineTests.cs b/Fluid.Tests/MvcViewEngine/ViewEngineTests.cs
@@ -1,12 +1,15 @@
 using Fluid.Tests.Mocks;
 using Fluid.ViewEngine;
+using System;
 using System.IO;
+using System.Linq;
+using System.Threading;
 using System.Threading.Tasks;
 using Xunit;
 
 namespace Fluid.Tests.MvcViewEngine
 {
-    public class ViewEngineTests
+    public partial class ViewEngineTests
     {
         FluidViewEngineOptions _options = new ();
         FluidViewRenderer _renderer;
@@ -278,5 +281,29 @@ public async Task LayoutShouldBeAbleToIncludeVarsFromViewStart()
 
             Assert.Equal("[TITLE][SUBTITLE][ViewStart][View]", sw.ToString());
         }
+
+        [Fact]
+        public async Task RenderViewOnlyAsyncStream_LargePropertyValue_Nested_SmallBuffer_BiggerThan128LengthString()
+        {
+            _mockFileProvider.Add("Views/Index.liquid", "{% layout '_Layout' %}{% section bigboy %}{{BigString}}{% endsection %} ");
+            _mockFileProvider.Add("Views/_Layout.liquid", "{% rendersection bigboy %}");
+
+            await using var sw = new StreamWriter(new NoSyncStream(), bufferSize: 10);
+            var template = new TemplateContext(new { BigString = new string(Enumerable.Range(0, 129).Select(x => 'b').ToArray()) });
+            await _renderer.RenderViewAsync(sw, "Index.liquid", template);
+            await sw.FlushAsync();
+        }
+
+        [Fact]
+        public async Task RenderViewOnlyAsyncStream_LargePropertyValue_Nested()
+        {
+            _mockFileProvider.Add("Views/Index.liquid", "{% layout '_Layout' %}{% section bigboy %}{{BigString}}{% endsection %} ");
+            _mockFileProvider.Add("Views/_Layout.liquid", "{% rendersection bigboy %}");
+
+            await using var sw = new StreamWriter(new NoSyncStream());
+            var template = new TemplateContext(new { BigString = new string(Enumerable.Range(0, 1500).Select(_ => 'b').ToArray()) });
+            await _renderer.RenderViewAsync(sw, "Index.liquid", template);
+            await sw.FlushAsync();
+        }
     }
 }
diff --git a/Fluid.ViewEngine/Fluid.ViewEngine.csproj b/Fluid.ViewEngine/Fluid.ViewEngine.csproj
@@ -1,7 +1,7 @@
 <Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
-    <TargetFrameworks>netstandard2.0;net6.0;net8.0</TargetFrameworks>
+    <TargetFrameworks>netstandard2.0;netstandard2.1;net6.0;net7.0;net8.0</TargetFrameworks>
     <LangVersion>latest</LangVersion>
     <IsPackable>true</IsPackable>
     <PackageIcon>logo_64x64.png</PackageIcon>

diff --git a/Fluid/Accessors/PropertyInfoAccessor.cs b/Fluid/Accessors/PropertyInfoAccessor.cs
@@ -12,7 +12,7 @@ public PropertyInfoAccessor(PropertyInfo propertyInfo)
             var d = propertyInfo.GetGetMethod().CreateDelegate(delegateType);
 
             var invokerType = typeof(Invoker<,>).MakeGenericType(propertyInfo.DeclaringType, propertyInfo.PropertyType);
-            _invoker = Activator.CreateInstance(invokerType, [d]) as IInvoker;
+            _invoker = Activator.CreateInstance(invokerType, new object[] { d }) as IInvoker;
         }
 
         public object Get(object obj, string name, TemplateContext ctx)

diff --git a/Fluid/Ast/CycleStatement.cs b/Fluid/Ast/CycleStatement.cs
@@ -32,7 +32,7 @@ public override async ValueTask<Completion> WriteToAsync(TextWriter writer, Text
             var value = await Values[(int)index].EvaluateAsync(context);
             context.SetValue(groupValue, NumberValue.Create(index + 1));
 
-            value.WriteTo(writer, encoder, context.CultureInfo);
+            await value.WriteToAsync(writer, encoder, context.CultureInfo);
 
             return Completion.Normal;
         }

diff --git a/Fluid/Ast/DecrementStatement.cs b/Fluid/Ast/DecrementStatement.cs
@@ -12,7 +12,7 @@ public DecrementStatement(string identifier)
 
         public string Identifier { get; }
 
-        public override ValueTask<Completion> WriteToAsync(TextWriter writer, TextEncoder encoder, TemplateContext context)
+        public override async ValueTask<Completion> WriteToAsync(TextWriter writer, TextEncoder encoder, TemplateContext context)
         {
             context.IncrementSteps();
 
@@ -35,9 +35,9 @@ public override ValueTask<Completion> WriteToAsync(TextWriter writer, TextEncode
 
             context.SetValue(prefixedIdentifier, value);
 
-            value.WriteTo(writer, encoder, context.CultureInfo);
+            await value.WriteToAsync(writer, encoder, context.CultureInfo);
 
-            return Normal();
+            return Completion.Normal;
         }
 
         protected internal override Statement Accept(AstVisitor visitor) => visitor.VisitDecrementStatement(this);

diff --git a/Fluid/Ast/IncrementStatement.cs b/Fluid/Ast/IncrementStatement.cs
@@ -36,9 +36,20 @@ public override ValueTask<Completion> WriteToAsync(TextWriter writer, TextEncode
 
             context.SetValue(prefixedIdentifier, value);
 
-            value.WriteTo(writer, encoder, context.CultureInfo);
+            var task = value.WriteToAsync(writer, encoder, context.CultureInfo);
 
-            return Normal();
+            if (task.IsCompletedSuccessfully)
+            {
+                return new ValueTask<Completion>(Completion.Normal);
+            }
+
+            return Awaited(task);
+
+            static async ValueTask<Completion> Awaited(ValueTask t)
+            {
+                await t;
+                return Completion.Normal;
+            }
         }
 
         protected internal override Statement Accept(AstVisitor visitor) => visitor.VisitIncrementStatement(this);

diff --git a/Fluid/Ast/OutputStatement.cs b/Fluid/Ast/OutputStatement.cs
@@ -23,7 +23,7 @@ static async ValueTask<Completion> Awaited(
                 TemplateContext ctx)
             {
                 var value = await t;
-                value.WriteTo(w, enc, ctx.CultureInfo);
+                await value.WriteToAsync(w, enc, ctx.CultureInfo);
                 return Completion.Normal;
             }
 
@@ -32,8 +32,20 @@ static async ValueTask<Completion> Awaited(
             var task = Expression.EvaluateAsync(context);
             if (task.IsCompletedSuccessfully)
             {
-                task.Result.WriteTo(writer, encoder, context.CultureInfo);
-                return new ValueTask<Completion>(Completion.Normal);
+                var valueTask = task.Result.WriteToAsync(writer, encoder, context.CultureInfo);
+
+                if (valueTask.IsCompletedSuccessfully)
+                {
+                    return new ValueTask<Completion>(Completion.Normal);
+                }
+
+                return AwaitedWriteTo(valueTask);
+
+                static async ValueTask<Completion> AwaitedWriteTo(ValueTask t)
+                {
+                    await t;
+                    return Completion.Normal;
+                }
             }
 
             return Awaited(task, writer, encoder, context);

diff --git a/Fluid/Filters/ColorFilters.cs b/Fluid/Filters/ColorFilters.cs
@@ -635,7 +635,7 @@ public static explicit operator HexColor(RgbColor rgbColor)
         {
             private const double DefaultTransperency = 1.0;
 
-            private static readonly char[] _colorSeparators = ['(', ',', ' ', ')'];
+            private static readonly char[] _colorSeparators = new[] { '(', ',', ' ', ')' };
 
             public static readonly RgbColor Empty = default;
 
@@ -814,7 +814,7 @@ private readonly struct HslColor
         {
             private const double DefaultTransparency = 1.0;
 
-            private static readonly char[] _colorSeparators = ['(', ',', ' ', ')'];
+            private static readonly char[] _colorSeparators = new[] { '(', ',', ' ', ')' };
 
             public static readonly HslColor Empty = default;
 

diff --git a/Fluid/Filters/StringFilters.cs b/Fluid/Filters/StringFilters.cs
@@ -124,7 +124,7 @@ public static ValueTask<FluidValue> RemoveLast(FluidValue input, FilterArguments
 
         public static ValueTask<FluidValue> ReplaceFirst(FluidValue input, FilterArguments arguments, TemplateContext context)
         {
-#if NET6_0_OR_GREATER
+#if NETCOREAPP3_0_OR_GREATER
             var value = input.ToStringValue().AsSpan();
             var remove = arguments.At(0).ToStringValue().AsSpan();
 #else
@@ -138,7 +138,7 @@ public static ValueTask<FluidValue> ReplaceFirst(FluidValue input, FilterArgumen
                 return input;
             }
 
-#if NET6_0_OR_GREATER
+#if NETCOREAPP3_0_OR_GREATER
             var concat = string.Concat(value.Slice(0, index), arguments.At(1).ToStringValue(), value.Slice(index + remove.Length));
 #else
             var concat = string.Concat(value.Substring(0, index), arguments.At(1).ToStringValue(), value.Substring(index + remove.Length));
@@ -153,7 +153,7 @@ public static ValueTask<FluidValue> Replace(FluidValue input, FilterArguments ar
 
         public static ValueTask<FluidValue> ReplaceLast(FluidValue input, FilterArguments arguments, TemplateContext context)
         {
-#if NET6_0_OR_GREATER
+#if NETCOREAPP3_0_OR_GREATER
             var value = input.ToStringValue().AsSpan();
             var remove = arguments.At(0).ToStringValue().AsSpan();
 #else
@@ -167,7 +167,7 @@ public static ValueTask<FluidValue> ReplaceLast(FluidValue input, FilterArgument
                 return input;
             }
 
-#if NET6_0_OR_GREATER
+#if NETCOREAPP3_0_OR_GREATER
             var concat = string.Concat(value.Slice(0, index), arguments.At(1).ToStringValue(), value.Slice(index + remove.Length));
 #else
             var concat = string.Concat(value.Substring(0, index), arguments.At(1).ToStringValue(), value.Substring(index + remove.Length));
@@ -316,7 +316,7 @@ public static ValueTask<FluidValue> Truncate(FluidValue input, FilterArguments a
 
             var l = Math.Max(0, length - ellipsisStr.Length);
 
-#if NET6_0_OR_GREATER
+#if NETCOREAPP3_0_OR_GREATER
             var concat = string.Concat(inputStr.AsSpan().Slice(0, l), ellipsisStr);
 #else
             var concat = string.Concat(inputStr.Substring(0, l), ellipsisStr);

diff --git a/Fluid/FiltersCollection.cs b/Fluid/FiltersCollection.cs
@@ -16,6 +16,10 @@ public FilterCollection(int capacity = 0)
 
         public int Count => _filters == null ? 0 : _filters.Count;
 
+#if NETSTANDARD2_1
+        public void EnsureCapacity(int capacity) => _filters.EnsureCapacity(capacity);
+#endif
+
         public void AddFilter(string name, FilterDelegate d)
         {
             _filters ??= new Dictionary<string, FilterDelegate>();

diff --git a/Fluid/Fluid.csproj b/Fluid/Fluid.csproj
@@ -1,7 +1,7 @@
 <Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
-    <TargetFrameworks>netstandard2.0;net6.0;net8.0</TargetFrameworks>
+    <TargetFrameworks>netstandard2.0;netstandard2.1;net6.0;net7.0;net8.0</TargetFrameworks>
     <AllowUnsafeBlocks>true</AllowUnsafeBlocks>
     <LangVersion>latest</LangVersion>
     <IsPackable>true</IsPackable>
@@ -36,10 +36,18 @@
     <PackageReference Include="Microsoft.CSharp" />
   </ItemGroup>
 
+  <ItemGroup Condition="'$(TargetFramework)'=='netstandard2.1'">
+    <PackageReference Include="System.Text.Json" />
+    <PackageReference Include="Microsoft.CSharp" />
+  </ItemGroup>
+
   <!-- Keep specific targets since it removes some dependencies -->
   <ItemGroup Condition="'$(TargetFramework)'=='net6.0'">
   </ItemGroup>
 
+  <ItemGroup Condition="'$(TargetFramework)'=='net7.0'">
+  </ItemGroup>
+
   <ItemGroup Condition="'$(TargetFramework)'=='net8.0'">
   </ItemGroup>
 

diff --git a/Fluid/FluidParser.cs b/Fluid/FluidParser.cs
@@ -98,7 +98,21 @@ public FluidParser(FluidParserOptions parserOptions)
                     Dot.SkipAnd(Identifier.Then<MemberSegment>(x => new IdentifierSegment(x)))
                     .Or(Indexer)
                     .Or(Call)))
-                .Then(x => new MemberExpression([x.Item1, .. x.Item2]));
+                .Then(x =>
+                {
+                    if (x.Item2.Count == 0)
+                    {
+                        return new MemberExpression(x.Item1);
+                    }
+
+                    var list = new List<MemberSegment>(x.Item2.Count + 1);
+                    list.Add(x.Item1);
+                    list.AddRange(x.Item2);
+
+                    return new MemberExpression(list);
+
+                    // return new MemberExpression([x.Item1, .. x.Item2]);
+                });
 
             var Range = LParen
                 .SkipAnd(OneOf(Integer, Member.Then<Expression>(x => x)))