-
Notifications
You must be signed in to change notification settings - Fork 10.5k
Use CultureInfo.InvariantCulture when TryParsing minimal action parameters #33624
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
9 commits merged into
dotnet:main
from
wcontayon:use_cultureInvariant_parse_mininalAction_params_#32377
Jun 28, 2021
Merged
Changes from all commits
Commits
Show all changes
9 commits
Select commit
Hold shift + click to select a range
a751fa0
Use CultureInfo.Invariant - WIP
wcontayon 510ffef
Add unit test and fix tryParse error
wcontayon 0eaeb20
Merge branch 'main' into use_cultureInvariant_parse_mininalAction_par…
wcontayon 3b0e8bd
Update TryParseMethodCache and fix build error - WIP
wcontayon b884edc
Refacto TryParseMethodCache
wcontayon 3bf3a0e
PR review
wcontayon a843c58
Merge branch 'master' into use_cultureInvariant_parse_mininalAction_p…
wcontayon 9061776
PR review
wcontayon c85a14c
Add test for TryParse with CultureInfo.Invariant value
wcontayon File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
110 changes: 110 additions & 0 deletions
110
src/Http/Http.Extensions/test/TryParseMethodCacheTests.cs
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,110 @@ | ||
| // Copyright (c) .NET Foundation. All rights reserved. | ||
| // Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information. | ||
|
|
||
| #nullable enable | ||
|
|
||
| using System; | ||
| using System.Globalization; | ||
| using System.Linq.Expressions; | ||
|
|
||
| using Xunit; | ||
|
|
||
| namespace Microsoft.AspNetCore.Http.Extensions.Tests | ||
| { | ||
| public class TryParseMethodCacheTests | ||
| { | ||
| [Theory] | ||
| [InlineData(typeof(int))] | ||
| [InlineData(typeof(double))] | ||
| [InlineData(typeof(float))] | ||
| [InlineData(typeof(Half))] | ||
| [InlineData(typeof(short))] | ||
| [InlineData(typeof(long))] | ||
| [InlineData(typeof(IntPtr))] | ||
| [InlineData(typeof(sbyte))] | ||
| [InlineData(typeof(ushort))] | ||
| [InlineData(typeof(uint))] | ||
| [InlineData(typeof(ulong))] | ||
| public void FindTryParseMethod_ReturnsTheExpectedTryParseMethodWithInvariantCulture(Type @type) | ||
| { | ||
| var methodFound = TryParseMethodCache.FindTryParseMethod(@type); | ||
|
|
||
| Assert.NotNull(methodFound); | ||
|
|
||
| var call = methodFound!(Expression.Variable(type, "parsedValue")); | ||
| var parameters = call.Method.GetParameters(); | ||
|
|
||
| Assert.Equal(4, parameters.Length); | ||
| Assert.Equal(typeof(string), parameters[0].ParameterType); | ||
| Assert.Equal(typeof(NumberStyles), parameters[1].ParameterType); | ||
| Assert.Equal(typeof(IFormatProvider), parameters[2].ParameterType); | ||
| Assert.True(parameters[3].IsOut); | ||
| } | ||
|
|
||
| [Theory] | ||
| [InlineData(typeof(DateTime))] | ||
| [InlineData(typeof(DateOnly))] | ||
| [InlineData(typeof(DateTimeOffset))] | ||
| [InlineData(typeof(TimeOnly))] | ||
| [InlineData(typeof(TimeSpan))] | ||
| public void FindTryParseMethod_ReturnsTheExpectedTryParseMethodWithInvariantCultureDateType(Type @type) | ||
| { | ||
| var methodFound = TryParseMethodCache.FindTryParseMethod(@type); | ||
|
|
||
| Assert.NotNull(methodFound); | ||
|
|
||
| var call = methodFound!(Expression.Variable(type, "parsedValue")); | ||
| var parameters = call.Method.GetParameters(); | ||
|
|
||
| if (@type == typeof(TimeSpan)) | ||
| { | ||
| Assert.Equal(3, parameters.Length); | ||
| Assert.Equal(typeof(string), parameters[0].ParameterType); | ||
| Assert.Equal(typeof(IFormatProvider), parameters[1].ParameterType); | ||
| Assert.True(parameters[2].IsOut); | ||
| } | ||
| else | ||
| { | ||
| Assert.Equal(4, parameters.Length); | ||
| Assert.Equal(typeof(string), parameters[0].ParameterType); | ||
| Assert.Equal(typeof(IFormatProvider), parameters[1].ParameterType); | ||
| Assert.Equal(typeof(DateTimeStyles), parameters[2].ParameterType); | ||
| Assert.True(parameters[3].IsOut); | ||
| } | ||
| } | ||
|
|
||
| [Theory] | ||
| [InlineData(typeof(TryParsableInvariantRecord))] | ||
| public void FindTryParseMethod_ReturnsTheExpectedTryParseMethodWithInvariantCultureCustomType(Type @type) | ||
| { | ||
| var methodFound = TryParseMethodCache.FindTryParseMethod(@type); | ||
|
|
||
| Assert.NotNull(methodFound); | ||
|
|
||
| var call = methodFound!(Expression.Variable(type, "parsedValue")); | ||
| var parameters = call.Method.GetParameters(); | ||
|
|
||
| Assert.Equal(3, parameters.Length); | ||
| Assert.Equal(typeof(string), parameters[0].ParameterType); | ||
| Assert.Equal(typeof(IFormatProvider), parameters[1].ParameterType); | ||
| Assert.True(parameters[2].IsOut); | ||
| Assert.True(((call.Arguments[1] as ConstantExpression)!.Value as CultureInfo)!.Equals(CultureInfo.InvariantCulture)); | ||
| } | ||
|
|
||
| private record TryParsableInvariantRecord(int value) | ||
| { | ||
| public static bool TryParse(string? value, IFormatProvider formatProvider, out TryParsableInvariantRecord? result) | ||
| { | ||
| if (!int.TryParse(value, NumberStyles.Integer, formatProvider, out var val)) | ||
| { | ||
| result = null; | ||
| return false; | ||
| } | ||
|
|
||
| result = new TryParsableInvariantRecord(val); | ||
| return true; | ||
| } | ||
| } | ||
|
|
||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -4,57 +4,90 @@ | |
| using System; | ||
| using System.Collections.Concurrent; | ||
| using System.Diagnostics; | ||
| using System.Diagnostics.CodeAnalysis; | ||
| using System.Globalization; | ||
| using System.Linq; | ||
| using System.Linq.Expressions; | ||
| using System.Numerics; | ||
| using System.Reflection; | ||
|
|
||
| #nullable enable | ||
|
|
||
| namespace Microsoft.AspNetCore.Http | ||
| { | ||
| internal static class TryParseMethodCache | ||
| { | ||
| private static readonly MethodInfo EnumTryParseMethod = GetEnumTryParseMethod(); | ||
|
|
||
| // Since this is shared source, the cache won't be shared between RequestDelegateFactory and the ApiDescriptionProvider sadly :( | ||
| private static readonly ConcurrentDictionary<Type, MethodInfo?> Cache = new(); | ||
| private static readonly ConcurrentDictionary<Type, Func<Expression, MethodCallExpression>?> MethodCallCache = new(); | ||
| internal static readonly ParameterExpression TempSourceStringExpr = Expression.Variable(typeof(string), "tempSourceString"); | ||
|
|
||
| public static bool HasTryParseMethod(ParameterInfo parameter) | ||
| { | ||
| var nonNullableParameterType = Nullable.GetUnderlyingType(parameter.ParameterType) ?? parameter.ParameterType; | ||
| return FindTryParseMethod(nonNullableParameterType) is not null; | ||
| } | ||
|
|
||
| // TODO: Use InvariantCulture where possible? Or is CurrentCulture fine because it's more flexible? | ||
| public static MethodInfo? FindTryParseMethod(Type type) | ||
| public static Func<Expression, MethodCallExpression>? FindTryParseMethod(Type type) | ||
| { | ||
| static MethodInfo? Finder(Type type) | ||
| static Func<Expression, MethodCallExpression>? Finder(Type type) | ||
| { | ||
| MethodInfo? methodInfo; | ||
|
|
||
| if (type.IsEnum) | ||
| { | ||
| return EnumTryParseMethod.MakeGenericMethod(type); | ||
| methodInfo = EnumTryParseMethod.MakeGenericMethod(type); | ||
| if (methodInfo != null) | ||
| { | ||
| return (expression) => Expression.Call(methodInfo!, TempSourceStringExpr, expression); | ||
| } | ||
|
|
||
| return null; | ||
| } | ||
|
|
||
| var staticMethods = type.GetMethods(BindingFlags.Public | BindingFlags.Static); | ||
| if (TryGetDateTimeTryParseMethod(type, out methodInfo)) | ||
| { | ||
| return (expression) => Expression.Call( | ||
| methodInfo!, | ||
| TempSourceStringExpr, | ||
| Expression.Constant(CultureInfo.InvariantCulture), | ||
| Expression.Constant(DateTimeStyles.None), | ||
| expression); | ||
| } | ||
|
|
||
| foreach (var method in staticMethods) | ||
| if (TryGetNumberStylesTryGetMethod(type, out methodInfo, out var numberStyle)) | ||
| { | ||
| if (method.Name != "TryParse" || method.ReturnType != typeof(bool)) | ||
| { | ||
| continue; | ||
| } | ||
| return (expression) => Expression.Call( | ||
| methodInfo!, | ||
| TempSourceStringExpr, | ||
| Expression.Constant(numberStyle), | ||
| Expression.Constant(CultureInfo.InvariantCulture), | ||
| expression); | ||
| } | ||
|
|
||
| var tryParseParameters = method.GetParameters(); | ||
| methodInfo = type.GetMethod("TryParse", BindingFlags.Public | BindingFlags.Static, new[] { typeof(string), typeof(IFormatProvider), type.MakeByRefType() }); | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Can we add a test with a custom type that implements this signature and verify it actually gets called with
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Sure ! 🙂 |
||
|
|
||
| if (tryParseParameters.Length == 2 && | ||
| tryParseParameters[0].ParameterType == typeof(string) && | ||
| tryParseParameters[1].IsOut && | ||
| tryParseParameters[1].ParameterType == type.MakeByRefType()) | ||
| { | ||
| return method; | ||
| } | ||
| if (methodInfo != null) | ||
| { | ||
| return (expression) => Expression.Call( | ||
| methodInfo, | ||
| TempSourceStringExpr, | ||
| Expression.Constant(CultureInfo.InvariantCulture), | ||
| expression); | ||
| } | ||
|
|
||
| methodInfo = type.GetMethod("TryParse", BindingFlags.Public | BindingFlags.Static, new[] { typeof(string), type.MakeByRefType() }); | ||
|
|
||
| if (methodInfo != null) | ||
| { | ||
| return (expression) => Expression.Call(methodInfo, TempSourceStringExpr, expression); | ||
| } | ||
|
|
||
| return null; | ||
| } | ||
|
|
||
| return Cache.GetOrAdd(type, Finder); | ||
| return MethodCallCache.GetOrAdd(type, Finder); | ||
| } | ||
|
|
||
| private static MethodInfo GetEnumTryParseMethod() | ||
|
|
@@ -81,5 +114,97 @@ private static MethodInfo GetEnumTryParseMethod() | |
| Debug.Fail("static bool System.Enum.TryParse<TEnum>(string? value, out TEnum result) not found."); | ||
| throw new Exception("static bool System.Enum.TryParse<TEnum>(string? value, out TEnum result) not found."); | ||
| } | ||
|
|
||
| private static bool TryGetDateTimeTryParseMethod(Type type, [NotNullWhen(true)] out MethodInfo? methodInfo) | ||
| { | ||
| methodInfo = null; | ||
| if (type != typeof(DateTime) && type != typeof(DateOnly) && | ||
| type != typeof(DateTimeOffset) && type != typeof(TimeOnly)) | ||
| { | ||
| return false; | ||
| } | ||
|
|
||
| var staticTryParseDateMethod = type.GetMethod( | ||
| "TryParse", | ||
| BindingFlags.Public | BindingFlags.Static, | ||
| new[] { typeof(string), typeof(IFormatProvider), typeof(DateTimeStyles), type.MakeByRefType() }); | ||
|
|
||
| methodInfo = staticTryParseDateMethod; | ||
|
|
||
| return methodInfo != null; | ||
| } | ||
|
|
||
| private static bool TryGetNumberStylesTryGetMethod(Type type, [NotNullWhen(true)] out MethodInfo? method, [NotNullWhen(true)] out NumberStyles? numberStyles) | ||
| { | ||
| method = null; | ||
| numberStyles = null; | ||
|
|
||
| if (!UseTryParseWithNumberStyleOption(type)) | ||
| { | ||
| return false; | ||
| } | ||
|
|
||
| var staticMethods = type.GetMethods(BindingFlags.Public | BindingFlags.Static) | ||
| .Where(m => m.Name == "TryParse" && m.ReturnType == typeof(bool)) | ||
| .OrderByDescending(m => m.GetParameters().Length); | ||
|
|
||
| var numberStylesToUse = NumberStyles.Integer; | ||
| var methodToUse = default(MethodInfo); | ||
|
|
||
| foreach (var methodInfo in staticMethods) | ||
| { | ||
| var tryParseParameters = methodInfo.GetParameters(); | ||
|
|
||
| if (tryParseParameters.Length == 4 && | ||
| tryParseParameters[0].ParameterType == typeof(string) && | ||
| tryParseParameters[1].ParameterType == typeof(NumberStyles) && | ||
| tryParseParameters[2].ParameterType == typeof(IFormatProvider) && | ||
| tryParseParameters[3].IsOut && | ||
| tryParseParameters[3].ParameterType == type.MakeByRefType()) | ||
| { | ||
| if (type == typeof(int) || type == typeof(short) || type == typeof(IntPtr) || | ||
| type == typeof(long) || type == typeof(byte) || type == typeof(sbyte) || | ||
| type == typeof(ushort) || type == typeof(uint) || type == typeof(ulong) || | ||
| type == typeof(BigInteger)) | ||
| { | ||
| numberStylesToUse = NumberStyles.Integer; | ||
| } | ||
|
|
||
| if (type == typeof(double) || type == typeof(float) || type == typeof(Half)) | ||
| { | ||
| numberStylesToUse = NumberStyles.AllowThousands | NumberStyles.Float; | ||
| } | ||
|
|
||
| if (type == typeof(decimal)) | ||
| { | ||
| numberStylesToUse = NumberStyles.Number; | ||
| } | ||
|
|
||
| methodToUse = methodInfo!; | ||
| break; | ||
| } | ||
| } | ||
|
|
||
| numberStyles = numberStylesToUse!; | ||
| method = methodToUse!; | ||
|
|
||
| return true; | ||
| } | ||
|
|
||
| internal static bool UseTryParseWithNumberStyleOption(Type type) | ||
| => type == typeof(int) || | ||
| type == typeof(double) || | ||
| type == typeof(decimal) || | ||
| type == typeof(float) || | ||
| type == typeof(Half) || | ||
| type == typeof(short) || | ||
| type == typeof(long) || | ||
| type == typeof(IntPtr) || | ||
| type == typeof(byte) || | ||
| type == typeof(sbyte) || | ||
| type == typeof(ushort) || | ||
| type == typeof(uint) || | ||
| type == typeof(ulong) || | ||
| type == typeof(BigInteger); | ||
| } | ||
| } | ||
Submodule googletest
updated
7 files
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.