Move CascadingParameterAttributeBase.Name into subclasses. It shouldn't have been in the base because the meaning varies.

SteveSandersonMS · SteveSandersonMS · commit a8acc607f503 · 2023-08-22T09:29:50.000+01:00
diff --git a/src/Components/Components/src/CascadingParameterAttribute.cs b/src/Components/Components/src/CascadingParameterAttribute.cs
@@ -20,5 +20,5 @@ public sealed class CascadingParameterAttribute : CascadingParameterAttributeBas
     /// <see cref="CascadingValue{T}"/>  that supplies a value with a compatible
     /// type.
     /// </summary>
-    public override string? Name { get; set; }
+    public string? Name { get; set; }
 }
diff --git a/src/Components/Components/src/CascadingParameterAttributeBase.cs b/src/Components/Components/src/CascadingParameterAttributeBase.cs
@@ -8,12 +8,6 @@ namespace Microsoft.AspNetCore.Components;
 /// </summary>
 public abstract class CascadingParameterAttributeBase : Attribute
 {
-    /// <summary>
-    /// Gets or sets the name for the parameter, which correlates to the name
-    /// of a cascading value.
-    /// </summary>
-    public abstract string? Name { get; set; }
-
     /// <summary>
     /// Gets a flag indicating whether the cascading parameter should
     /// be supplied only once per component.
diff --git a/src/Components/Components/src/PublicAPI.Unshipped.txt b/src/Components/Components/src/PublicAPI.Unshipped.txt
@@ -1,6 +1,4 @@
 #nullable enable
-abstract Microsoft.AspNetCore.Components.CascadingParameterAttributeBase.Name.get -> string?
-abstract Microsoft.AspNetCore.Components.CascadingParameterAttributeBase.Name.set -> void
 abstract Microsoft.AspNetCore.Components.RenderModeAttribute.Mode.get -> Microsoft.AspNetCore.Components.IComponentRenderMode!
 Microsoft.AspNetCore.Components.CascadingParameterAttributeBase
 Microsoft.AspNetCore.Components.CascadingParameterAttributeBase.CascadingParameterAttributeBase() -> void
@@ -83,20 +81,12 @@ Microsoft.AspNetCore.Components.Rendering.RenderTreeBuilder.AddComponentParamete
 Microsoft.AspNetCore.Components.StreamRenderingAttribute
 Microsoft.AspNetCore.Components.StreamRenderingAttribute.Enabled.get -> bool
 Microsoft.AspNetCore.Components.StreamRenderingAttribute.StreamRenderingAttribute(bool enabled) -> void
-*REMOVED*Microsoft.AspNetCore.Components.CascadingParameterAttribute.Name.get -> string?
-*REMOVED*Microsoft.AspNetCore.Components.CascadingParameterAttribute.Name.set -> void
 Microsoft.AspNetCore.Components.SupplyParameterFromQueryProviderServiceCollectionExtensions
 Microsoft.Extensions.DependencyInjection.CascadingValueServiceCollectionExtensions
-override Microsoft.AspNetCore.Components.CascadingParameterAttribute.Name.get -> string?
-override Microsoft.AspNetCore.Components.CascadingParameterAttribute.Name.set -> void
 override Microsoft.AspNetCore.Components.EventCallback.GetHashCode() -> int
 override Microsoft.AspNetCore.Components.EventCallback.Equals(object? obj) -> bool
 override Microsoft.AspNetCore.Components.EventCallback<TValue>.GetHashCode() -> int
 override Microsoft.AspNetCore.Components.EventCallback<TValue>.Equals(object? obj) -> bool
-*REMOVED*Microsoft.AspNetCore.Components.SupplyParameterFromQueryAttribute.Name.get -> string?
-*REMOVED*Microsoft.AspNetCore.Components.SupplyParameterFromQueryAttribute.Name.set -> void
-override Microsoft.AspNetCore.Components.SupplyParameterFromQueryAttribute.Name.get -> string?
-override Microsoft.AspNetCore.Components.SupplyParameterFromQueryAttribute.Name.set -> void
 static Microsoft.AspNetCore.Components.SupplyParameterFromQueryProviderServiceCollectionExtensions.AddSupplyValueFromQueryProvider(this Microsoft.Extensions.DependencyInjection.IServiceCollection! services) -> Microsoft.Extensions.DependencyInjection.IServiceCollection!
 static Microsoft.Extensions.DependencyInjection.CascadingValueServiceCollectionExtensions.AddCascadingValue<TValue>(this Microsoft.Extensions.DependencyInjection.IServiceCollection! serviceCollection, string! name, System.Func<System.IServiceProvider!, TValue>! valueFactory) -> Microsoft.Extensions.DependencyInjection.IServiceCollection!
 static Microsoft.Extensions.DependencyInjection.CascadingValueServiceCollectionExtensions.AddCascadingValue<TValue>(this Microsoft.Extensions.DependencyInjection.IServiceCollection! serviceCollection, System.Func<System.IServiceProvider!, Microsoft.AspNetCore.Components.CascadingValueSource<TValue>!>! sourceFactory) -> Microsoft.Extensions.DependencyInjection.IServiceCollection!
diff --git a/src/Components/Components/src/Reflection/ComponentProperties.cs b/src/Components/Components/src/Reflection/ComponentProperties.cs
@@ -184,8 +184,7 @@ private static void ThrowForUnknownIncomingParameterName([DynamicallyAccessedMem
             {
                 throw new InvalidOperationException(
                     $"Object of type '{targetType.FullName}' has a property matching the name '{parameterName}', " +
-                    $"but it does not have [{nameof(ParameterAttribute)}], [{nameof(CascadingParameterAttribute)}] or " +
-                    $"[SupplyParameterFromFormAttribute] applied.");
+                    $"but it does not have [Parameter], [CascadingParameter], or any other parameter-supplying attribute.");
             }
             else
             {
diff --git a/src/Components/Components/src/SupplyParameterFromQueryAttribute.cs b/src/Components/Components/src/SupplyParameterFromQueryAttribute.cs
@@ -14,5 +14,5 @@ public sealed class SupplyParameterFromQueryAttribute : CascadingParameterAttrib
     /// Gets or sets the name of the querystring parameter. If null, the querystring
     /// parameter is assumed to have the same name as the associated property.
     /// </summary>
-    public override string? Name { get; set; }
+    public string? Name { get; set; }
 }
diff --git a/src/Components/Components/src/SupplyParameterFromQueryProviderServiceCollectionExtensions.cs b/src/Components/Components/src/SupplyParameterFromQueryProviderServiceCollectionExtensions.cs
@@ -50,7 +50,8 @@ public bool CanSupplyValue(in CascadingParameterInfo parameterInfo)
                 UpdateQueryParameters();
             }
 
-            var queryParameterName = parameterInfo.Attribute.Name ?? parameterInfo.PropertyName;
+            var attribute = (SupplyParameterFromQueryAttribute)parameterInfo.Attribute; // Must be a valid cast because we check in CanSupplyValue
+            var queryParameterName = attribute.Name ?? parameterInfo.PropertyName;
             return _queryParameterValueSupplier.GetQueryParameterValue(parameterInfo.PropertyType, queryParameterName);
         }
 
diff --git a/src/Components/Components/test/CascadingParameterStateTest.cs b/src/Components/Components/test/CascadingParameterStateTest.cs
@@ -476,8 +476,6 @@ class ComponentWithNamedCascadingParam : TestComponentBase
 
     class SupplyParameterWithSingleDeliveryAttribute : CascadingParameterAttributeBase
     {
-        public override string Name { get; set; }
-
         internal override bool SingleDelivery => true;
     }
 
@@ -523,19 +521,3 @@ public TestNavigationManager()
         }
     }
 }
-
-[AttributeUsage(AttributeTargets.Property, AllowMultiple = false, Inherited = true)]
-public sealed class SupplyParameterFromFormAttribute : CascadingParameterAttributeBase
-{
-    /// <summary>
-    /// Gets or sets the name for the parameter. The name is used to match
-    /// the form data and decide whether or not the value needs to be bound.
-    /// </summary>
-    public override string Name { get; set; }
-
-    /// <summary>
-    /// Gets or sets the name for the handler. The name is used to match
-    /// the form data and decide whether or not the value needs to be bound.
-    /// </summary>
-    public string Handler { get; set; }
-}
diff --git a/src/Components/Components/test/CascadingParameterTest.cs b/src/Components/Components/test/CascadingParameterTest.cs
@@ -734,8 +734,6 @@ private class SingleDeliveryValue(string text)
 
     private class SingleDeliveryCascadingParameterAttribute : CascadingParameterAttributeBase
     {
-        public override string Name { get; set; }
-
         internal override bool SingleDelivery => true;
     }
 
@@ -852,13 +850,11 @@ class SecondCascadingParameterConsumerComponent<T1, T2> : CascadingParameterCons
     [AttributeUsage(AttributeTargets.Property, AllowMultiple = false, Inherited = true)]
     class CustomCascadingParameter1Attribute : CascadingParameterAttributeBase
     {
-        public override string Name { get; set; }
     }
 
     [AttributeUsage(AttributeTargets.Property, AllowMultiple = false, Inherited = true)]
     class CustomCascadingParameter2Attribute : CascadingParameterAttributeBase
     {
-        public override string Name { get; set; }
     }
 
     class CustomCascadingValueProducer<TAttribute> : AutoRenderComponent, ICascadingValueSupplier
@@ -904,7 +900,7 @@ void ICascadingValueSupplier.Unsubscribe(ComponentState subscriber, in Cascading
 
     class CustomCascadingValueConsumer1 : AutoRenderComponent
     {
-        [CustomCascadingParameter1(Name = nameof(Value))]
+        [CustomCascadingParameter1]
         public object Value { get; set; }
 
         protected override void BuildRenderTree(RenderTreeBuilder builder)
@@ -915,7 +911,7 @@ protected override void BuildRenderTree(RenderTreeBuilder builder)
 
     class CustomCascadingValueConsumer2 : AutoRenderComponent
     {
-        [CustomCascadingParameter2(Name = nameof(Value))]
+        [CustomCascadingParameter2]
         public object Value { get; set; }
 
         protected override void BuildRenderTree(RenderTreeBuilder builder)
diff --git a/src/Components/Components/test/ParameterViewTest.Assignment.cs b/src/Components/Components/test/ParameterViewTest.Assignment.cs
@@ -183,7 +183,7 @@ public void IncomingParameterMatchesPropertyNotDeclaredAsParameter_Throws()
         Assert.Equal(default, target.IntProp);
         Assert.Equal(
             $"Object of type '{typeof(HasPropertyWithoutParameterAttribute).FullName}' has a property matching the name '{nameof(HasPropertyWithoutParameterAttribute.IntProp)}', " +
-            $"but it does not have [{nameof(ParameterAttribute)}], [{nameof(CascadingParameterAttribute)}] or [{nameof(SupplyParameterFromFormAttribute)}] applied.",
+            "but it does not have [Parameter], [CascadingParameter], or any other parameter-supplying attribute.",
             ex.Message);
     }
 
diff --git a/src/Components/Web/src/Forms/Mapping/SupplyParameterFromFormValueProvider.cs b/src/Components/Web/src/Forms/Mapping/SupplyParameterFromFormValueProvider.cs
@@ -73,8 +73,9 @@ void ICascadingValueSupplier.Unsubscribe(ComponentState subscriber, in Cascading
     {
         Debug.Assert(mappingContext != null);
 
-        var parameterName = parameterInfo.Attribute.Name ?? parameterInfo.PropertyName;
-        var restrictToFormName = ((SupplyParameterFromFormAttribute)parameterInfo.Attribute).Handler;
+        var attribute = (SupplyParameterFromFormAttribute)parameterInfo.Attribute; // Must be a valid cast because we check in CanSupplyValue
+        var parameterName = attribute.Name ?? parameterInfo.PropertyName;
+        var restrictToFormName = attribute.Handler;
         Action<string, FormattableString, string?> errorHandler = string.IsNullOrEmpty(restrictToFormName) ?
             mappingContext.AddError :
             (name, message, value) => mappingContext.AddError(restrictToFormName, parameterName, message, value);
diff --git a/src/Components/Web/src/PublicAPI.Unshipped.txt b/src/Components/Web/src/PublicAPI.Unshipped.txt
@@ -65,6 +65,8 @@ Microsoft.AspNetCore.Components.HtmlRendering.Infrastructure.StaticHtmlRenderer.
 Microsoft.AspNetCore.Components.SupplyParameterFromFormAttribute
 Microsoft.AspNetCore.Components.SupplyParameterFromFormAttribute.Handler.get -> string?
 Microsoft.AspNetCore.Components.SupplyParameterFromFormAttribute.Handler.set -> void
+Microsoft.AspNetCore.Components.SupplyParameterFromFormAttribute.Name.get -> string?
+Microsoft.AspNetCore.Components.SupplyParameterFromFormAttribute.Name.set -> void
 Microsoft.AspNetCore.Components.SupplyParameterFromFormAttribute.SupplyParameterFromFormAttribute() -> void
 Microsoft.AspNetCore.Components.Web.AutoRenderMode
 Microsoft.AspNetCore.Components.Web.AutoRenderMode.AutoRenderMode() -> void
@@ -111,8 +113,6 @@ override Microsoft.AspNetCore.Components.Forms.Editor<T>.OnParametersSet() -> vo
 override Microsoft.AspNetCore.Components.HtmlRendering.Infrastructure.StaticHtmlRenderer.Dispatcher.get -> Microsoft.AspNetCore.Components.Dispatcher!
 override Microsoft.AspNetCore.Components.HtmlRendering.Infrastructure.StaticHtmlRenderer.HandleException(System.Exception! exception) -> void
 override Microsoft.AspNetCore.Components.HtmlRendering.Infrastructure.StaticHtmlRenderer.UpdateDisplayAsync(in Microsoft.AspNetCore.Components.RenderTree.RenderBatch renderBatch) -> System.Threading.Tasks.Task!
-override Microsoft.AspNetCore.Components.SupplyParameterFromFormAttribute.Name.get -> string?
-override Microsoft.AspNetCore.Components.SupplyParameterFromFormAttribute.Name.set -> void
 override Microsoft.AspNetCore.Components.Web.RenderModeAutoAttribute.Mode.get -> Microsoft.AspNetCore.Components.IComponentRenderMode!
 override Microsoft.AspNetCore.Components.Web.RenderModeServerAttribute.Mode.get -> Microsoft.AspNetCore.Components.IComponentRenderMode!
 override Microsoft.AspNetCore.Components.Web.RenderModeWebAssemblyAttribute.Mode.get -> Microsoft.AspNetCore.Components.IComponentRenderMode!
diff --git a/src/Components/Web/src/SupplyParameterFromFormAttribute.cs b/src/Components/Web/src/SupplyParameterFromFormAttribute.cs
@@ -11,11 +11,9 @@ namespace Microsoft.AspNetCore.Components;
 public sealed class SupplyParameterFromFormAttribute : CascadingParameterAttributeBase
 {
     /// <summary>
-    /// Gets or sets the name for the parameter. The name is used to determine
-    /// the prefix to use to match the form data and decide whether or not the
-    /// value needs to be bound.
+    /// Gets or sets the name for the form value. If not specified, the property name will be used.
     /// </summary>
-    public override string? Name { get; set; }
+    public string? Name { get; set; }
 
     /// <summary>
     /// Gets or sets the name for the handler. The name is used to match

Original file line number	Diff line number	Diff line change
`@@ -20,5 +20,5 @@ public sealed class CascadingParameterAttribute : CascadingParameterAttributeBas`
`20`	`20`	`/// <see cref="CascadingValue{T}"/> that supplies a value with a compatible`
`21`	`21`	`/// type.`
`22`	`22`	`/// </summary>`
`23`		`- public override string? Name { get; set; }`
	`23`	`+ public string? Name { get; set; }`
`24`	`24`	`}`
Original file line number	Diff line number	Diff line change
`@@ -184,8 +184,7 @@ private static void ThrowForUnknownIncomingParameterName([DynamicallyAccessedMem`
`184`	`184`	`{`
`185`	`185`	`throw new InvalidOperationException(`
`186`	`186`	`$"Object of type '{targetType.FullName}' has a property matching the name '{parameterName}', " +`
`187`		`- $"but it does not have [{nameof(ParameterAttribute)}], [{nameof(CascadingParameterAttribute)}] or " +`
`188`		`- $"[SupplyParameterFromFormAttribute] applied.");`
	`187`	`+ $"but it does not have [Parameter], [CascadingParameter], or any other parameter-supplying attribute.");`
`189`	`188`	`}`
`190`	`189`	`else`
`191`	`190`	`{`
Original file line number	Diff line number	Diff line change
`@@ -14,5 +14,5 @@ public sealed class SupplyParameterFromQueryAttribute : CascadingParameterAttrib`
`14`	`14`	`/// Gets or sets the name of the querystring parameter. If null, the querystring`
`15`	`15`	`/// parameter is assumed to have the same name as the associated property.`
`16`	`16`	`/// </summary>`
`17`		`- public override string? Name { get; set; }`
	`17`	`+ public string? Name { get; set; }`
`18`	`18`	`}`
Original file line number	Diff line number	Diff line change
`@@ -50,7 +50,8 @@ public bool CanSupplyValue(in CascadingParameterInfo parameterInfo)`
`50`	`50`	`UpdateQueryParameters();`
`51`	`51`	`}`
`52`	`52`
`53`		`- var queryParameterName = parameterInfo.Attribute.Name ?? parameterInfo.PropertyName;`
	`53`	`+ var attribute = (SupplyParameterFromQueryAttribute)parameterInfo.Attribute; // Must be a valid cast because we check in CanSupplyValue`
	`54`	`+ var queryParameterName = attribute.Name ?? parameterInfo.PropertyName;`
`54`	`55`	`return _queryParameterValueSupplier.GetQueryParameterValue(parameterInfo.PropertyType, queryParameterName);`
`55`	`56`	`}`
`56`	`57`
Original file line number	Diff line number	Diff line change
`@@ -476,8 +476,6 @@ class ComponentWithNamedCascadingParam : TestComponentBase`
`476`	`476`
`477`	`477`	`class SupplyParameterWithSingleDeliveryAttribute : CascadingParameterAttributeBase`
`478`	`478`	`{`
`479`		`- public override string Name { get; set; }`
`480`		`-`
`481`	`479`	`internal override bool SingleDelivery => true;`
`482`	`480`	`}`
`483`	`481`
`@@ -523,19 +521,3 @@ public TestNavigationManager()`
`523`	`521`	`}`
`524`	`522`	`}`
`525`	`523`	`}`
`526`		`-`
`527`		`-[AttributeUsage(AttributeTargets.Property, AllowMultiple = false, Inherited = true)]`
`528`		`-public sealed class SupplyParameterFromFormAttribute : CascadingParameterAttributeBase`
`529`		`-{`
`530`		`- /// <summary>`
`531`		`- /// Gets or sets the name for the parameter. The name is used to match`
`532`		`- /// the form data and decide whether or not the value needs to be bound.`
`533`		`- /// </summary>`
`534`		`- public override string Name { get; set; }`
`535`		`-`
`536`		`- /// <summary>`
`537`		`- /// Gets or sets the name for the handler. The name is used to match`
`538`		`- /// the form data and decide whether or not the value needs to be bound.`
`539`		`- /// </summary>`
`540`		`- public string Handler { get; set; }`
`541`		`-}`
Original file line number	Diff line number	Diff line change
`@@ -734,8 +734,6 @@ private class SingleDeliveryValue(string text)`
`734`	`734`
`735`	`735`	`private class SingleDeliveryCascadingParameterAttribute : CascadingParameterAttributeBase`
`736`	`736`	`{`
`737`		`- public override string Name { get; set; }`
`738`		`-`
`739`	`737`	`internal override bool SingleDelivery => true;`
`740`	`738`	`}`
`741`	`739`
`@@ -852,13 +850,11 @@ class SecondCascadingParameterConsumerComponent<T1, T2> : CascadingParameterCons`
`852`	`850`	`[AttributeUsage(AttributeTargets.Property, AllowMultiple = false, Inherited = true)]`
`853`	`851`	`class CustomCascadingParameter1Attribute : CascadingParameterAttributeBase`
`854`	`852`	`{`
`855`		`- public override string Name { get; set; }`
`856`	`853`	`}`
`857`	`854`
`858`	`855`	`[AttributeUsage(AttributeTargets.Property, AllowMultiple = false, Inherited = true)]`
`859`	`856`	`class CustomCascadingParameter2Attribute : CascadingParameterAttributeBase`
`860`	`857`	`{`
`861`		`- public override string Name { get; set; }`
`862`	`858`	`}`
`863`	`859`
`864`	`860`	`class CustomCascadingValueProducer<TAttribute> : AutoRenderComponent, ICascadingValueSupplier`
`@@ -904,7 +900,7 @@ void ICascadingValueSupplier.Unsubscribe(ComponentState subscriber, in Cascading`
`904`	`900`
`905`	`901`	`class CustomCascadingValueConsumer1 : AutoRenderComponent`
`906`	`902`	`{`
`907`		`- [CustomCascadingParameter1(Name = nameof(Value))]`
	`903`	`+ [CustomCascadingParameter1]`
`908`	`904`	`public object Value { get; set; }`
`909`	`905`
`910`	`906`	`protected override void BuildRenderTree(RenderTreeBuilder builder)`
`@@ -915,7 +911,7 @@ protected override void BuildRenderTree(RenderTreeBuilder builder)`
`915`	`911`
`916`	`912`	`class CustomCascadingValueConsumer2 : AutoRenderComponent`
`917`	`913`	`{`
`918`		`- [CustomCascadingParameter2(Name = nameof(Value))]`
	`914`	`+ [CustomCascadingParameter2]`
`919`	`915`	`public object Value { get; set; }`
`920`	`916`
`921`	`917`	`protected override void BuildRenderTree(RenderTreeBuilder builder)`
Original file line number	Diff line number	Diff line change
`@@ -183,7 +183,7 @@ public void IncomingParameterMatchesPropertyNotDeclaredAsParameter_Throws()`
`183`	`183`	`Assert.Equal(default, target.IntProp);`
`184`	`184`	`Assert.Equal(`
`185`	`185`	`$"Object of type '{typeof(HasPropertyWithoutParameterAttribute).FullName}' has a property matching the name '{nameof(HasPropertyWithoutParameterAttribute.IntProp)}', " +`
`186`		`- $"but it does not have [{nameof(ParameterAttribute)}], [{nameof(CascadingParameterAttribute)}] or [{nameof(SupplyParameterFromFormAttribute)}] applied.",`
	`186`	`+ "but it does not have [Parameter], [CascadingParameter], or any other parameter-supplying attribute.",`
`187`	`187`	`ex.Message);`
`188`	`188`	`}`
`189`	`189`