Optimize prefixed parameters when assembling model name.

Added an option to optimize model names where the model name is the same
as one of its properties when binding the model name. This should only
be used when this is the desired behavior. Tests have been added to
assert this behavior when passing parameters whose model name is the
same as the property to be bound.

This was introduced to allow circumventing the bug where the parameter
name is the same as the name of one of its properties, causing the
model to trick the PrefixContainer into considering that parameter
as prefixed (model.property), even when it is not.

```C#
class SomeClass
{
  public string Parameter { get; set; } = "";
}
```

and later we define the model name as parameter (e.g in a ActionMethod for example)

```C#
public IActionResult SomeEndpoint([FromQuery] SomeClass parameter) { /* elided */ }
```

internally, when we pass the query "?parameter=somecoolparametervalue", it will classify
it as prefixed (parameter.Parameter instead of only parameter), because of the internal
logic of PrefixContainer. However, it is not prefixed, so later on when it try to bind the
key (the keys from the query, in this case parameter) with the internal keys (wrong classified
as parameter.Parameter) the ModelBinder would not find an valid candidate for matching with the
key.

Now the optimization option allows to treat the modelName and the propertyName with only one if
both are equal.

Author: sami-daniel

src/Mvc/Mvc.Core/src/ModelBinding/Binders/ComplexObjectModelBinder.cs

@@ -364,7 +364,7 @@ internal void CreateModel(ModelBindingContext bindingContext)
             }
 
             var fieldName = property.BinderModelName ?? property.PropertyName!;
-            var modelName = ModelNames.CreatePropertyModelName(bindingContext.ModelName, fieldName);
+            var modelName = ModelNames.CreatePropertyModelName(bindingContext.ModelName, fieldName, skipOptimization: false);
             var result = await BindPropertyAsync(bindingContext, property, propertyBinder, fieldName, modelName);
 
             if (result.IsModelSet)

src/Mvc/Mvc.Core/src/ModelBinding/ModelNames.cs

@@ -39,8 +39,9 @@ public static string CreateIndexModelName(string parentName, string index)
     /// </summary>
     /// <param name="prefix">The prefix to use.</param>
     /// <param name="propertyName">The property name.</param>
+    /// <param name="skipOptimization">Skip the optimization of property name and prefix.</param>
     /// <returns>The property model name.</returns>
-    public static string CreatePropertyModelName(string? prefix, string? propertyName)
+    public static string CreatePropertyModelName(string? prefix, string? propertyName, bool skipOptimization = true)
     {
         if (string.IsNullOrEmpty(prefix))
         {
@@ -59,6 +60,17 @@ public static string CreatePropertyModelName(string? prefix, string? propertyNam
             return prefix + propertyName;
         }
 
+        if (!skipOptimization)
+        {
+            if (string.Equals(prefix, propertyName, StringComparison.OrdinalIgnoreCase))
+            {
+                // if we are dealing with with something like:
+                // prefix = parameter and propertyName = parameter
+                // it should fallback to the property name.
+                return propertyName;
+            }
+        }
+
         return prefix + "." + propertyName;
     }
 }

src/Mvc/Mvc.Core/src/PublicAPI.Shipped.txt

@@ -2190,7 +2190,6 @@ static Microsoft.AspNetCore.Mvc.ModelBinding.ModelBinderProviderExtensions.Remov
 static Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadataProviderExtensions.GetMetadataForProperty(this Microsoft.AspNetCore.Mvc.ModelBinding.IModelMetadataProvider! provider, System.Type! containerType, string! propertyName) -> Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata!
 static Microsoft.AspNetCore.Mvc.ModelBinding.ModelNames.CreateIndexModelName(string! parentName, int index) -> string!
 static Microsoft.AspNetCore.Mvc.ModelBinding.ModelNames.CreateIndexModelName(string! parentName, string! index) -> string!
-static Microsoft.AspNetCore.Mvc.ModelBinding.ModelNames.CreatePropertyModelName(string? prefix, string? propertyName) -> string!
 static Microsoft.AspNetCore.Mvc.ModelBinding.Validation.ModelValidatorProviderExtensions.RemoveType(this System.Collections.Generic.IList<Microsoft.AspNetCore.Mvc.ModelBinding.Validation.IModelValidatorProvider!>! list, System.Type! type) -> void
 static Microsoft.AspNetCore.Mvc.ModelBinding.Validation.ModelValidatorProviderExtensions.RemoveType<TModelValidatorProvider>(this System.Collections.Generic.IList<Microsoft.AspNetCore.Mvc.ModelBinding.Validation.IModelValidatorProvider!>! list) -> void
 static Microsoft.AspNetCore.Mvc.ModelBinding.Validation.ValidationVisitor.StateManager.Recurse(Microsoft.AspNetCore.Mvc.ModelBinding.Validation.ValidationVisitor! visitor, string! key, Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata! metadata, object? model, Microsoft.AspNetCore.Mvc.ModelBinding.Validation.IValidationStrategy! strategy) -> Microsoft.AspNetCore.Mvc.ModelBinding.Validation.ValidationVisitor.StateManager

src/Mvc/Mvc.Core/src/PublicAPI.Unshipped.txt

@@ -6,3 +6,4 @@ Microsoft.AspNetCore.Mvc.ProducesDefaultResponseTypeAttribute.Description.get ->
 Microsoft.AspNetCore.Mvc.ProducesDefaultResponseTypeAttribute.Description.set -> void
 Microsoft.AspNetCore.Mvc.ProducesResponseTypeAttribute.Description.get -> string?
 Microsoft.AspNetCore.Mvc.ProducesResponseTypeAttribute.Description.set -> void
+static Microsoft.AspNetCore.Mvc.ModelBinding.ModelNames.CreatePropertyModelName(string? prefix, string? propertyName, bool skipOptimization = true) -> string!

src/Mvc/test/Mvc.IntegrationTests/CollectionModelBinderIntegrationTest.cs

@@ -96,6 +96,40 @@ public async Task CollectionModelBinder_BindsListOfSimpleType_WithExplicitPrefix
         Assert.True(modelState.IsValid);
     }
 
+    class TestClass
+    {
+        public string Parameter { get; set; } = "";
+    }
+
+    [Fact]
+    public async Task CollectionModelBinder_CanBindProperties_WithSameNameOfParameter()
+    {
+        // Arrange
+        var parameterBinder = ModelBindingTestHelper.GetParameterBinder();
+        var parameter = new ParameterDescriptor()
+        {
+            Name = "parameter",
+            ParameterType = typeof(TestClass)
+        };
+
+        var testContext = ModelBindingTestHelper.GetTestContext(request =>
+        {
+            request.QueryString = new QueryString("?parameter=testing");
+        });
+
+        var modelState = testContext.ModelState;
+
+        // Act
+        var modelBindingResult = await parameterBinder.BindModelAsync(parameter, testContext);
+
+        // Assert
+        Assert.True(modelBindingResult.IsModelSet);
+
+        var model = Assert.IsType<TestClass>(modelBindingResult.Model);
+        Assert.True(model.Parameter == "testing");
+        Assert.True(modelState.IsValid);
+    }
+
     [Theory]
     [InlineData("?[0]=10&[1]=11")]
     [InlineData("?index=low&index=high&[high]=11&[low]=10")]