[1.x] Proper async/await usage in resolving props (kapi2289#29)

* Proper async/await usage in resolving props

* Resolve when invoking object is a Task

Author: kapi2289

InertiaCore/Props/AlwaysProp.cs

@@ -1,25 +1,16 @@
 namespace InertiaCore.Props;
 
-public class AlwaysProp
+public class AlwaysProp : InvokableProp
 {
-    private readonly object? _value;
+    internal AlwaysProp(object? value) : base(value)
+    {
+    }
 
-    public AlwaysProp(object? value)
+    internal AlwaysProp(Func<object?> value) : base(value)
     {
-        _value = value;
     }
 
-    public object? Invoke()
+    internal AlwaysProp(Func<Task<object?>> value) : base(value)
     {
-        // Check if the value is a callable delegate
-        return Task.Run(async () =>
-        {
-            return _value switch
-            {
-                Func<Task<object?>> asyncCallable => await asyncCallable.Invoke(),
-                Func<object?> callable => callable.Invoke(),
-                _ => _value
-            };
-        }).GetAwaiter().GetResult();
     }
 }

InertiaCore/Props/InvokableProp.cs

@@ -0,0 +1,19 @@
+namespace InertiaCore.Props;
+
+public class InvokableProp
+{
+    private readonly object? _value;
+
+    protected InvokableProp(object? value) => _value = value;
+
+    internal Task<object?> Invoke()
+    {
+        return _value switch
+        {
+            Func<Task<object?>> asyncCallable => asyncCallable.Invoke(),
+            Func<object?> callable => Task.Run(() => callable.Invoke()),
+            Task<object?> value => value,
+            _ => Task.FromResult(_value)
+        };
+    }
+}

InertiaCore/Props/LazyProp.cs

@@ -1,11 +1,12 @@
 namespace InertiaCore.Props;
 
-public class LazyProp
+public class LazyProp : InvokableProp
 {
-    private readonly Func<Task<object?>> _callback;
+    internal LazyProp(Func<object?> value) : base(value)
+    {
+    }
 
-    public LazyProp(Func<object?> callback) => _callback = async () => await Task.FromResult(callback());
-    public LazyProp(Func<Task<object?>> callback) => _callback = callback;
-
-    public object? Invoke() => Task.Run(() => _callback.Invoke()).GetAwaiter().GetResult();
+    internal LazyProp(Func<Task<object?>> value) : base(value)
+    {
+    }
 }

InertiaCore/Response.cs

@@ -27,19 +27,20 @@ public Response(string component, object props, string rootView, string? version
     public async Task ExecuteResultAsync(ActionContext context)
     {
         SetContext(context);
-        ProcessResponse();
+        await ProcessResponse();
 
         await GetResult().ExecuteResultAsync(_context!);
     }
 
-    protected internal void ProcessResponse()
+    protected internal async Task ProcessResponse()
     {
         var page = new Page
         {
             Component = _component,
             Version = _version,
             Url = _context!.RequestedUri(),
-            Props = ResolveProperties(_props.GetType().GetProperties().ToDictionary(o => o.Name.ToCamelCase(), o => o.GetValue(_props)))
+            Props = await ResolveProperties(_props.GetType().GetProperties()
+                .ToDictionary(o => o.Name.ToCamelCase(), o => o.GetValue(_props)))
         };
 
         var shared = _context!.HttpContext.Features.Get<InertiaSharedData>();
@@ -51,15 +52,15 @@ protected internal void ProcessResponse()
         SetPage(page);
     }
 
-    private static Dictionary<string, object?> PrepareProps(Dictionary<string, object?> props)
+    private static async Task<Dictionary<string, object?>> PrepareProps(Dictionary<string, object?> props)
     {
-        return props.ToDictionary(pair => pair.Key, pair => pair.Value switch
+        return (await Task.WhenAll(props.Select(async pair => pair.Value switch
         {
-            Func<object?> f => f.Invoke(),
-            LazyProp l => l.Invoke(),
-            AlwaysProp l => l.Invoke(),
-            _ => pair.Value
-        });
+            Func<object?> f => (pair.Key, f.Invoke()),
+            LazyProp l => (pair.Key, await l.Invoke()),
+            AlwaysProp l => (pair.Key, await l.Invoke()),
+            _ => (pair.Key, pair.Value)
+        }))).ToDictionary(pair => pair.Key, pair => pair.Item2);
     }
 
     protected internal JsonResult GetJson()
@@ -111,7 +112,7 @@ public Response WithViewData(IDictionary<string, object> viewData)
         return this;
     }
 
-    private Dictionary<string, object?> ResolveProperties(Dictionary<string, object?> props)
+    private async Task<Dictionary<string, object?>> ResolveProperties(Dictionary<string, object?> props)
     {
         var isPartial = _context!.IsInertiaPartialComponent(_component);
 
@@ -126,37 +127,29 @@ public Response WithViewData(IDictionary<string, object> viewData)
             props = props.ToDictionary(kv => kv.Key, kv => kv.Value);
 
             if (_context!.HttpContext.Request.Headers.ContainsKey(InertiaHeader.PartialOnly))
-            {
                 props = ResolveOnly(props);
-            }
 
             if (_context!.HttpContext.Request.Headers.ContainsKey(InertiaHeader.PartialExcept))
-            {
                 props = ResolveExcept(props);
-            }
         }
 
         props = ResolveAlways(props);
-        props = PrepareProps(props);
+        props = await PrepareProps(props);
 
         return props;
     }
 
     private Dictionary<string, object?> ResolveOnly(Dictionary<string, object?> props)
-    {
-        return _context!.OnlyProps(props);
-    }
+        => _context!.OnlyProps(props);
 
     private Dictionary<string, object?> ResolveExcept(Dictionary<string, object?> props)
-    {
-        return _context!.ExceptProps(props);
-    }
+        => _context!.ExceptProps(props);
 
     private Dictionary<string, object?> ResolveAlways(Dictionary<string, object?> props)
     {
         var alwaysProps = _props.GetType().GetProperties()
-                        .Where(o => o.PropertyType == typeof(AlwaysProp))
-                        .ToDictionary(o => o.Name.ToCamelCase(), o => o.GetValue(_props));
+            .Where(o => o.PropertyType == typeof(AlwaysProp))
+            .ToDictionary(o => o.Name.ToCamelCase(), o => o.GetValue(_props));
 
         return props
             .Where(kv => kv.Value is not AlwaysProp)

InertiaCoreTests/UnitTestAlwaysData.cs

@@ -7,7 +7,7 @@ public partial class Tests
 {
     [Test]
     [Description("Test if the always data is fetched properly.")]
-    public void TestAlwaysData()
+    public async Task TestAlwaysData()
     {
         var response = _factory.Render("Test/Page", new
         {
@@ -19,7 +19,7 @@ public void TestAlwaysData()
         var context = PrepareContext();
 
         response.SetContext(context);
-        response.ProcessResponse();
+        await response.ProcessResponse();
 
         var page = response.GetJson().Value as Page;
 
@@ -34,7 +34,7 @@ public void TestAlwaysData()
 
     [Test]
     [Description("Test if the always data is fetched properly with specified partial props.")]
-    public void TestAlwaysPartialData()
+    public async Task TestAlwaysPartialData()
     {
         var response = _factory.Render("Test/Page", new
         {
@@ -51,7 +51,7 @@ public void TestAlwaysPartialData()
         var context = PrepareContext(headers);
 
         response.SetContext(context);
-        response.ProcessResponse();
+        await response.ProcessResponse();
 
         var page = response.GetJson().Value as Page;
 
@@ -65,7 +65,7 @@ public void TestAlwaysPartialData()
 
     [Test]
     [Description("Test if the always async data is fetched properly.")]
-    public void TestAlwaysAsyncData()
+    public async Task TestAlwaysAsyncData()
     {
         var testFunction = new Func<Task<object?>>(async () =>
         {
@@ -83,7 +83,7 @@ public void TestAlwaysAsyncData()
         var context = PrepareContext();
 
         response.SetContext(context);
-        response.ProcessResponse();
+        await response.ProcessResponse();
 
         var page = response.GetJson().Value as Page;
 
@@ -98,7 +98,7 @@ public void TestAlwaysAsyncData()
 
     [Test]
     [Description("Test if the always async data is fetched properly with specified partial props.")]
-    public void TestAlwaysAsyncPartialData()
+    public async Task TestAlwaysAsyncPartialData()
     {
         var testFunction = new Func<Task<string>>(async () =>
         {
@@ -121,7 +121,7 @@ public void TestAlwaysAsyncPartialData()
         var context = PrepareContext(headers);
 
         response.SetContext(context);
-        response.ProcessResponse();
+        await response.ProcessResponse();
 
         var page = response.GetJson().Value as Page;
 
@@ -135,7 +135,7 @@ public void TestAlwaysAsyncPartialData()
 
     [Test]
     [Description("Test if the always async data is fetched properly without specified partial props.")]
-    public void TestAlwaysAsyncPartialDataOmitted()
+    public async Task TestAlwaysAsyncPartialDataOmitted()
     {
         var testFunction = new Func<Task<string>>(async () =>
         {
@@ -159,7 +159,7 @@ public void TestAlwaysAsyncPartialDataOmitted()
         var context = PrepareContext(headers);
 
         response.SetContext(context);
-        response.ProcessResponse();
+        await response.ProcessResponse();
 
         var page = response.GetJson().Value as Page;
 

InertiaCoreTests/UnitTestLazyData.cs

@@ -7,7 +7,7 @@ public partial class Tests
 {
     [Test]
     [Description("Test if the lazy data is fetched properly.")]
-    public void TestLazyData()
+    public async Task TestLazyData()
     {
         var response = _factory.Render("Test/Page", new
         {
@@ -23,7 +23,7 @@ public void TestLazyData()
         var context = PrepareContext();
 
         response.SetContext(context);
-        response.ProcessResponse();
+        await response.ProcessResponse();
 
         var page = response.GetJson().Value as Page;
 
@@ -37,7 +37,7 @@ public void TestLazyData()
 
     [Test]
     [Description("Test if the lazy data is fetched properly with specified partial props.")]
-    public void TestLazyPartialData()
+    public async Task TestLazyPartialData()
     {
         var response = _factory.Render("Test/Page", new
         {
@@ -54,7 +54,7 @@ public void TestLazyPartialData()
         var context = PrepareContext(headers);
 
         response.SetContext(context);
-        response.ProcessResponse();
+        await response.ProcessResponse();
 
         var page = response.GetJson().Value as Page;
 
@@ -69,7 +69,7 @@ public void TestLazyPartialData()
 
     [Test]
     [Description("Test if the lazy async data is fetched properly.")]
-    public void TestLazyAsyncData()
+    public async Task TestLazyAsyncData()
     {
         var testFunction = new Func<Task<object?>>(async () =>
         {
@@ -88,7 +88,7 @@ public void TestLazyAsyncData()
         var context = PrepareContext();
 
         response.SetContext(context);
-        response.ProcessResponse();
+        await response.ProcessResponse();
 
         var page = response.GetJson().Value as Page;
 
@@ -102,7 +102,7 @@ public void TestLazyAsyncData()
 
     [Test]
     [Description("Test if the lazy async data is fetched properly with specified partial props.")]
-    public void TestLazyAsyncPartialData()
+    public async Task TestLazyAsyncPartialData()
     {
         var testFunction = new Func<Task<string>>(async () =>
         {
@@ -125,7 +125,7 @@ public void TestLazyAsyncPartialData()
         var context = PrepareContext(headers);
 
         response.SetContext(context);
-        response.ProcessResponse();
+        await response.ProcessResponse();
 
         var page = response.GetJson().Value as Page;
 

InertiaCoreTests/UnitTestModelState.cs

@@ -6,7 +6,7 @@ public partial class Tests
 {
     [Test]
     [Description("Test if the model state dictionary is passed to the props correctly.")]
-    public void TestModelState()
+    public async Task TestModelState()
     {
         var response = _factory.Render("Test/Page", new
         {
@@ -19,7 +19,7 @@ public void TestModelState()
         });
 
         response.SetContext(context);
-        response.ProcessResponse();
+        await response.ProcessResponse();
 
         var page = response.GetJson().Value as Page;