DataContext resource binding: GridView support

exyi · exyi · commit cfae6e19e967 · 2022-09-07T11:46:01.000+02:00
diff --git a/src/DynamicData/DynamicData/DataContextStackHelper.cs b/src/DynamicData/DynamicData/DataContextStackHelper.cs
@@ -40,4 +40,4 @@ public static DataContextStack CreateChildStack(this DataContextStack dataContex
                 dataContextStack.BindingPropertyResolvers);
         }
     }
-}
+}
diff --git a/src/Framework/Framework/Binding/BindingHelper.cs b/src/Framework/Framework/Binding/BindingHelper.cs
@@ -340,10 +340,12 @@ public static Func<TParam, TResult> Cache<TParam, TResult>(this Func<TParam, TRe
             return f => cache.GetOrAdd(f, func);
         }
 
-        public static IValueBinding GetThisBinding(this DotvvmBindableObject obj)
+        public static IStaticValueBinding GetThisBinding(this DotvvmBindableObject obj)
         {
-            var dataContext = obj.GetValueBinding(DotvvmBindableObject.DataContextProperty);
-            return (IValueBinding)dataContext!.GetProperty<ThisBindingProperty>().binding;
+            var dataContext = (IStaticValueBinding?)obj.GetBinding(DotvvmBindableObject.DataContextProperty);
+            if (dataContext is null)
+                throw new InvalidOperationException("DataContext must be set to a binding to allow creation of a {value: _this} binding");
+            return (IStaticValueBinding)dataContext!.GetProperty<ThisBindingProperty>().binding;
         }
 
         private static readonly ConditionalWeakTable<Expression, BindingParameterAnnotation> _expressionAnnotations =
diff --git a/src/Framework/Framework/Binding/ControlPropertyTypeDataContextChangeAttribute.cs b/src/Framework/Framework/Binding/ControlPropertyTypeDataContextChangeAttribute.cs
@@ -47,7 +47,7 @@ public ControlPropertyTypeDataContextChangeAttribute(string propertyName, int or
                 throw new Exception($"The property '{PropertyName}' was not found on control '{controlType}'!");
             }
 
-            if (control.properties.Contains(controlProperty) && control.GetValueBinding(controlProperty) is IValueBinding valueBinding)
+            if (control.properties.Contains(controlProperty) && control.GetBinding(controlProperty) is IStaticValueBinding valueBinding)
             {
                 return valueBinding.ResultType;
             }
diff --git a/src/Framework/Framework/Compilation/ControlTree/ControlTreeResolverBase.cs b/src/Framework/Framework/Compilation/ControlTree/ControlTreeResolverBase.cs
@@ -12,6 +12,7 @@
 using System.Diagnostics.CodeAnalysis;
 using DotVVM.Framework.Compilation.Directives;
 using DotVVM.Framework.Binding.Expressions;
+using FastExpressionCompiler;
 
 namespace DotVVM.Framework.Compilation.ControlTree
 {
@@ -347,12 +348,19 @@ private void ProcessAttribute(IPropertyDescriptor property, DothtmlAttributeNode
                         attribute.ValueNode.AddError($"The property '{ property.FullName }' cannot contain {bindingNode.Name} binding.");
                 }
                 var binding = ProcessBinding(bindingNode, dataContext, property);
+                if (property.IsBindingProperty)
+                {
+                    // check that binding types are compatible
+                    if (!property.PropertyType.IsAssignableFrom(ResolvedTypeDescriptor.Create(binding.BindingType)))
+                    {
+                        attribute.ValueNode.AddError($"The property '{property.FullName}' cannot contain a binding of type '{binding.BindingType}'!");
+                    }
+                }
                 var bindingProperty = treeBuilder.BuildPropertyBinding(property, binding, attribute);
                 if (!treeBuilder.AddProperty(control, bindingProperty, out var error)) attribute.AddError(error);
             }
             else
             {
-                // hard-coded value in markup
                 var textValue = (DothtmlValueTextNode)attribute.ValueNode;
 
                 try
diff --git a/src/Framework/Framework/Controls/GridView.cs b/src/Framework/Framework/Controls/GridView.cs
@@ -177,6 +177,7 @@ private void DataBind(IDotvvmRequestContext context)
             head = null;
 
             var dataSourceBinding = GetDataSourceBinding();
+            var serverOnly = dataSourceBinding is not IValueBinding;
             var dataSource = DataSource;
 
             var sortCommand = SortChanged;
@@ -196,7 +197,7 @@ private void DataBind(IDotvvmRequestContext context)
                 foreach (var item in GetIEnumerableFromDataSource()!)
                 {
                     // create row
-                    var placeholder = new DataItemContainer { DataItemIndex = index };
+                    var placeholder = new DataItemContainer { DataItemIndex = index, RenderItemBinding = !serverOnly };
                     placeholder.SetDataContextTypeFromDataSource(dataSourceBinding);
                     placeholder.DataContext = item;
                     placeholder.SetValue(Internal.PathFragmentProperty, GetPathFragmentExpression() + "/[" + index + "]");
@@ -431,19 +432,22 @@ protected override void RenderContents(IHtmlWriter writer, IDotvvmRequestContext
             head?.Render(writer, context);
 
             // render body
-            var foreachBinding = TryGetKnockoutForeachExpression().NotNull("GridView does not support DataSource={resource: ...} at this moment.");
-            if (RenderOnServer)
+            var foreachBinding = TryGetKnockoutForeachExpression();
+            if (foreachBinding is {})
             {
-                writer.AddKnockoutDataBind("dotvvm-SSR-foreach", "{data:" + foreachBinding + "}");
-            }
-            else
-            {
-                writer.AddKnockoutForeachDataBind(foreachBinding);
+                if (RenderOnServer)
+                {
+                    writer.AddKnockoutDataBind("dotvvm-SSR-foreach", "{data:" + foreachBinding + "}");
+                }
+                else
+                {
+                    writer.AddKnockoutForeachDataBind(foreachBinding);
+                }
             }
             writer.RenderBeginTag("tbody");
 
             // render contents
-            if (RenderOnServer)
+            if (RenderOnServer || foreachBinding is null)
             {
                 // render on server
                 var index = 0;
@@ -498,16 +502,19 @@ protected override void RenderBeginTag(IHtmlWriter writer, IDotvvmRequestContext
         {
             if (!ShowHeaderWhenNoData)
             {
-                writer.WriteKnockoutDataBindComment("if",
-                    GetForeachDataBindExpression().GetProperty<DataSourceLengthBinding>().Binding.CastTo<IValueBinding>().GetKnockoutBindingExpression(this));
+                if (GetForeachDataBindExpression().GetProperty<DataSourceLengthBinding>().Binding is IValueBinding conditionValueBinding)
+                {
+                    writer.WriteKnockoutDataBindComment("if", conditionValueBinding.GetKnockoutBindingExpression(this));
+                }
             }
 
             base.RenderBeginTag(writer, context);
         }
 
         protected override void RenderControl(IHtmlWriter writer, IDotvvmRequestContext context)
         {
-            if (RenderOnServer && numberOfRows == 0 && !ShowHeaderWhenNoData)
+            var ssr = RenderOnServer || GetForeachDataBindExpression() is not IValueBinding;
+            if (ssr && numberOfRows == 0 && !ShowHeaderWhenNoData)
             {
                 emptyDataContainer?.Render(writer, context);
             }
@@ -521,7 +528,7 @@ protected override void RenderEndTag(IHtmlWriter writer, IDotvvmRequestContext c
         {
             base.RenderEndTag(writer, context);
 
-            if (!ShowHeaderWhenNoData)
+            if (!ShowHeaderWhenNoData && GetForeachDataBindExpression() is IValueBinding)
             {
                 writer.WriteKnockoutDataBindEndComment();
             }
@@ -531,15 +538,15 @@ protected override void RenderEndTag(IHtmlWriter writer, IDotvvmRequestContext c
 
         protected override void AddAttributesToRender(IHtmlWriter writer, IDotvvmRequestContext context)
         {
-            var itemType = ReflectionUtils.GetEnumerableType(GetDataSourceBinding().ResultType);
-            var userColumnMappingService = context.Services.GetRequiredService<UserColumnMappingCache>();
-            var mapping = userColumnMappingService.GetMapping(itemType!);
-            var mappingJson = JsonConvert.SerializeObject(mapping);
-
-            var dataBinding =
-                (GetDataSourceBinding() as IValueBinding ?? throw new DotvvmControlException(this, "GridView does not support DataSource={resource: ...} at this moment."))
-                    .GetKnockoutBindingExpression(this, unwrapped: true);
-            writer.AddKnockoutDataBind("dotvvm-gridviewdataset", $"{{'mapping':{mappingJson},'dataSet':{dataBinding}}}");
+            if (GetBinding(DataSourceProperty) is IValueBinding dataBinding)
+            {
+                var itemType = ReflectionUtils.GetEnumerableType(GetDataSourceBinding().ResultType);
+                var userColumnMappingService = context.Services.GetRequiredService<UserColumnMappingCache>();
+                var mapping = userColumnMappingService.GetMapping(itemType!);
+                var mappingJson = JsonConvert.SerializeObject(mapping);
+
+                writer.AddKnockoutDataBind("dotvvm-gridviewdataset", $"{{'mapping':{mappingJson},'dataSet':{dataBinding.GetKnockoutBindingExpression(this, unwrapped: true)}}}");
+            }
             base.AddAttributesToRender(writer, context);
         }
 
diff --git a/src/Framework/Framework/Controls/GridViewColumn.cs b/src/Framework/Framework/Controls/GridViewColumn.cs
@@ -213,7 +213,7 @@ public virtual void CreateHeaderControls(IDotvvmRequestContext context, GridView
                 var binding = new CommandBindingExpression(context.Services.GetRequiredService<BindingCompilationService>().WithoutInitialization(), h => sortCommand(sortExpression), bindingId);
                 linkButton.SetBinding(ButtonBase.ClickProperty, binding);
 
-                SetSortedCssClass(cell, gridViewDataSet, gridView.GetValueBinding(GridView.DataSourceProperty)!);
+                SetSortedCssClass(cell, gridViewDataSet, (IStaticValueBinding)gridView.GetBinding(GridView.DataSourceProperty)!);
             }
             else
             {
@@ -233,14 +233,13 @@ public virtual void CreateFilterControls(IDotvvmRequestContext context, GridView
             }
         }
 
-        private void SetSortedCssClass(HtmlGenericControl cell, ISortableGridViewDataSet? sortableGridViewDataSet, IValueBinding dataSourceBinding)
+        private void SetSortedCssClass(HtmlGenericControl cell, ISortableGridViewDataSet? sortableGridViewDataSet, IStaticValueBinding dataSourceBinding)
         {
             if (sortableGridViewDataSet != null)
             {
                 var cellAttributes = cell.Attributes;
-                if (!RenderOnServer)
+                if (!RenderOnServer && (dataSourceBinding as IValueBinding)?.GetKnockoutBindingExpression(cell, unwrapped: true) is {} gridViewDataSetExpr)
                 {
-                    var gridViewDataSetExpr = dataSourceBinding.GetKnockoutBindingExpression(cell, unwrapped: true);
                     cellAttributes["data-bind"] = $"css: {{ '{SortDescendingHeaderCssClass}': ({gridViewDataSetExpr}).SortingOptions().SortExpression() == '{GetSortExpression()}' && ({gridViewDataSetExpr}).SortingOptions().SortDescending(), '{SortAscendingHeaderCssClass}': ({gridViewDataSetExpr}).SortingOptions().SortExpression() == '{GetSortExpression()}' && !({gridViewDataSetExpr}).SortingOptions().SortDescending()}}";
                 }
                 else if (sortableGridViewDataSet.SortingOptions.SortExpression == GetSortExpression())
diff --git a/src/Framework/Framework/Controls/GridViewTextColumn.cs b/src/Framework/Framework/Controls/GridViewTextColumn.cs
@@ -43,13 +43,13 @@ public ICommandBinding? ChangedBinding
         /// Gets or sets a binding which retrieves the value to display from the current data item.
         /// </summary>
         [MarkupOptions(Required = true)]
-        public IValueBinding? ValueBinding
+        public IStaticValueBinding? ValueBinding
         {
-            get { return GetValueBinding(ValueBindingProperty); }
+            get { return (IStaticValueBinding?)GetBinding(ValueBindingProperty); }
             set { SetValue(ValueBindingProperty, value); }
         }
         public static readonly DotvvmProperty ValueBindingProperty =
-            DotvvmProperty.Register<IValueBinding?, GridViewTextColumn>(c => c.ValueBinding);
+            DotvvmProperty.Register<IStaticValueBinding?, GridViewTextColumn>(c => c.ValueBinding);
 
         [MarkupOptions(AllowBinding = false)]
         public ValidatorPlacement ValidatorPlacement
@@ -75,13 +75,18 @@ public static readonly DotvvmProperty ValidatorPlacementProperty
 
         public override void CreateControls(IDotvvmRequestContext context, DotvvmControl container)
         {
+            var binding = ValueBinding;
+            if (binding is null)
+                throw new DotvvmControlException(this, "The 'ValueBinding' property is required.");
+
             var literal = new Literal();
             literal.FormatString = FormatString;
 
             CopyProperty(UITests.NameProperty, literal, UITests.NameProperty);
 
-            literal.SetBinding(Literal.TextProperty, ValueBinding);
-            Validator.Place(literal, container.Children, ValueBinding, ValidatorPlacement);
+            literal.SetBinding(Literal.TextProperty, binding);
+            if (binding is IValueBinding v)
+                Validator.Place(literal, container.Children, v, ValidatorPlacement);
             container.Children.Add(literal);
         }
 
@@ -98,7 +103,8 @@ public override void CreateEditControls(IDotvvmRequestContext context, DotvvmCon
 
             textBox.SetBinding(TextBox.TextProperty, ValueBinding);
             textBox.SetBinding(TextBox.ChangedProperty, ChangedBinding);
-            Validator.Place(textBox, container.Children, ValueBinding, ValidatorPlacement);
+            if (ValueBinding is IValueBinding v)
+                Validator.Place(textBox, container.Children, v, ValidatorPlacement);
             container.Children.Add(textBox);
         }
     }
diff --git a/src/Tests/ControlTests/RepeaterTests.cs b/src/Tests/ControlTests/RepeaterTests.cs
@@ -105,7 +105,7 @@ public class RepeaterWrapper : CompositeControl
     {
         public static DotvvmControl GetContents(
             HtmlCapability htmlCapability,
-            [ControlPropertyTypeDataContextChange("DataSource"), CollectionElementDataContextChange(1)]
+            [ControlPropertyBindingDataContextChange("DataSource"), CollectionElementDataContextChange(1)]
             ITemplate itemTemplate,
             IValueBinding<IEnumerable> dataSource
         )
diff --git a/src/Tests/ControlTests/ResourceDataContextTests.cs b/src/Tests/ControlTests/ResourceDataContextTests.cs
@@ -164,6 +164,19 @@ public async Task HierarchyRepeater_SimpleTemplate()
             check.CheckString(r.FormattedHtml, fileExtension: "html");
         }
 
+        [TestMethod]
+        public async Task GridView()
+        {
+            var r = await cth.RunPage(typeof(TestViewModel), @"
+                <dot:GridView DataSource={resource: Customers}>
+                    <dot:GridViewTextColumn HeaderText=Id ValueBinding={resource: Id} />
+                    <dot:GridViewTemplateColumn HeaderText=Name>
+                        {{resource: Name}}
+                    </dot:GridViewTemplateColumn>
+                </dot:GridView>");
+            check.CheckString(r.FormattedHtml, fileExtension: "html");
+        }
+
 
         public class TestViewModel: DotvvmViewModelBase
         {
diff --git a/src/Tests/ControlTests/testoutputs/ResourceDataContextTests.GridView.html b/src/Tests/ControlTests/testoutputs/ResourceDataContextTests.GridView.html
@@ -0,0 +1,31 @@
+<html>
+	<head></head>
+	<body>
+		<table>
+			<thead>
+				<tr>
+					<th>
+						<span>Id</span>
+					</th>
+					<th>
+						<span>Name</span>
+					</th>
+				</tr>
+			</thead>
+			<tbody>
+				<tr>
+					<td>
+						<span>1</span>
+					</td>
+					<td>One</td>
+				</tr>
+				<tr>
+					<td>
+						<span>2</span>
+					</td>
+					<td>Two</td>
+				</tr>
+			</tbody>
+		</table>
+	</body>
+</html>
diff --git a/src/Tests/Runtime/config-tests/ConfigurationSerializationTests.SerializeDefaultConfig.json b/src/Tests/Runtime/config-tests/ConfigurationSerializationTests.SerializeDefaultConfig.json
@@ -740,7 +740,7 @@
         "type": "DotVVM.Framework.Controls.ValidatorPlacement, DotVVM.Framework"
       },
       "ValueBinding": {
-        "type": "DotVVM.Framework.Binding.Expressions.IValueBinding, DotVVM.Framework",
+        "type": "DotVVM.Framework.Binding.Expressions.IStaticValueBinding, DotVVM.Framework",
         "required": true
       }
     },

Original file line number	Diff line number	Diff line change
`@@ -40,4 +40,4 @@ public static DataContextStack CreateChildStack(this DataContextStack dataContex`
`40`	`40`	`dataContextStack.BindingPropertyResolvers);`
`41`	`41`	`}`
`42`	`42`	`}`
`43`		`-}`
	`43`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -340,10 +340,12 @@ public static Func<TParam, TResult> Cache<TParam, TResult>(this Func<TParam, TRe`
`340`	`340`	`return f => cache.GetOrAdd(f, func);`
`341`	`341`	`}`
`342`	`342`
`343`		`- public static IValueBinding GetThisBinding(this DotvvmBindableObject obj)`
	`343`	`+ public static IStaticValueBinding GetThisBinding(this DotvvmBindableObject obj)`
`344`	`344`	`{`
`345`		`- var dataContext = obj.GetValueBinding(DotvvmBindableObject.DataContextProperty);`
`346`		`- return (IValueBinding)dataContext!.GetProperty<ThisBindingProperty>().binding;`
	`345`	`+ var dataContext = (IStaticValueBinding?)obj.GetBinding(DotvvmBindableObject.DataContextProperty);`
	`346`	`+ if (dataContext is null)`
	`347`	`+ throw new InvalidOperationException("DataContext must be set to a binding to allow creation of a {value: _this} binding");`
	`348`	`+ return (IStaticValueBinding)dataContext!.GetProperty<ThisBindingProperty>().binding;`
`347`	`349`	`}`
`348`	`350`
`349`	`351`	`private static readonly ConditionalWeakTable<Expression, BindingParameterAnnotation> _expressionAnnotations =`
Original file line number	Diff line number	Diff line change
`@@ -47,7 +47,7 @@ public ControlPropertyTypeDataContextChangeAttribute(string propertyName, int or`
`47`	`47`	`throw new Exception($"The property '{PropertyName}' was not found on control '{controlType}'!");`
`48`	`48`	`}`
`49`	`49`
`50`		`- if (control.properties.Contains(controlProperty) && control.GetValueBinding(controlProperty) is IValueBinding valueBinding)`
	`50`	`+ if (control.properties.Contains(controlProperty) && control.GetBinding(controlProperty) is IStaticValueBinding valueBinding)`
`51`	`51`	`{`
`52`	`52`	`return valueBinding.ResultType;`
`53`	`53`	`}`
Original file line number	Diff line number	Diff line change
`@@ -213,7 +213,7 @@ public virtual void CreateHeaderControls(IDotvvmRequestContext context, GridView`
`213`	`213`	`var binding = new CommandBindingExpression(context.Services.GetRequiredService<BindingCompilationService>().WithoutInitialization(), h => sortCommand(sortExpression), bindingId);`
`214`	`214`	`linkButton.SetBinding(ButtonBase.ClickProperty, binding);`
`215`	`215`
`216`		`- SetSortedCssClass(cell, gridViewDataSet, gridView.GetValueBinding(GridView.DataSourceProperty)!);`
	`216`	`+ SetSortedCssClass(cell, gridViewDataSet, (IStaticValueBinding)gridView.GetBinding(GridView.DataSourceProperty)!);`
`217`	`217`	`}`
`218`	`218`	`else`
`219`	`219`	`{`
`@@ -233,14 +233,13 @@ public virtual void CreateFilterControls(IDotvvmRequestContext context, GridView`
`233`	`233`	`}`
`234`	`234`	`}`
`235`	`235`
`236`		`- private void SetSortedCssClass(HtmlGenericControl cell, ISortableGridViewDataSet? sortableGridViewDataSet, IValueBinding dataSourceBinding)`
	`236`	`+ private void SetSortedCssClass(HtmlGenericControl cell, ISortableGridViewDataSet? sortableGridViewDataSet, IStaticValueBinding dataSourceBinding)`
`237`	`237`	`{`
`238`	`238`	`if (sortableGridViewDataSet != null)`
`239`	`239`	`{`
`240`	`240`	`var cellAttributes = cell.Attributes;`
`241`		`- if (!RenderOnServer)`
	`241`	`+ if (!RenderOnServer && (dataSourceBinding as IValueBinding)?.GetKnockoutBindingExpression(cell, unwrapped: true) is {} gridViewDataSetExpr)`
`242`	`242`	`{`
`243`		`- var gridViewDataSetExpr = dataSourceBinding.GetKnockoutBindingExpression(cell, unwrapped: true);`
`244`	`243`	`cellAttributes["data-bind"] = $"css: {{ '{SortDescendingHeaderCssClass}': ({gridViewDataSetExpr}).SortingOptions().SortExpression() == '{GetSortExpression()}' && ({gridViewDataSetExpr}).SortingOptions().SortDescending(), '{SortAscendingHeaderCssClass}': ({gridViewDataSetExpr}).SortingOptions().SortExpression() == '{GetSortExpression()}' && !({gridViewDataSetExpr}).SortingOptions().SortDescending()}}";`
`245`	`244`	`}`
`246`	`245`	`else if (sortableGridViewDataSet.SortingOptions.SortExpression == GetSortExpression())`
Original file line number	Diff line number	Diff line change
`@@ -105,7 +105,7 @@ public class RepeaterWrapper : CompositeControl`
`105`	`105`	`{`
`106`	`106`	`public static DotvvmControl GetContents(`
`107`	`107`	`HtmlCapability htmlCapability,`
`108`		`- [ControlPropertyTypeDataContextChange("DataSource"), CollectionElementDataContextChange(1)]`
	`108`	`+ [ControlPropertyBindingDataContextChange("DataSource"), CollectionElementDataContextChange(1)]`
`109`	`109`	`ITemplate itemTemplate,`
`110`	`110`	`IValueBinding<IEnumerable> dataSource`
`111`	`111`	`)`