Add diagnostic for Logging Generator: can't have malformed format strings #52040
Conversation
This file contains 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
…rly brackets, etc.)
|
Tagging subscribers to this area: @maryamariyan |
maryamariyan
commented
Apr 29, 2021
src/libraries/Microsoft.Extensions.Logging/gen/LoggerMessageGenerator.Parser.cs
Outdated
Show resolved
Hide resolved
…nerator.Parser.cs
eerhardt
reviewed
Apr 29, 2021
| else | ||
| { | ||
| // dangling }, fail | ||
| throw new ArgumentException($"Dangling }} in format string at position {pos}", nameof(format)); |
There was a problem hiding this comment.
I assume these strings will be shown to the developer. If so, we should put them in a resource so they can be localized.
eerhardt
reviewed
Apr 29, 2021
src/libraries/Microsoft.Extensions.Logging/gen/LoggerMessageGenerator.Parser.cs
Show resolved
Hide resolved
eerhardt
reviewed
Apr 29, 2021
tarekgh
reviewed
Apr 29, 2021
tarekgh
reviewed
Apr 29, 2021
| ReadOnlySpan<char> format = msg.AsSpan(); | ||
| var builder = new StringBuilder(msg.Length); | ||
| var pos = 0; | ||
| var len = format.Length; |
tarekgh
reviewed
Apr 29, 2021
tarekgh
reviewed
Apr 29, 2021
tarekgh
reviewed
Apr 29, 2021
| // classic composite format string | ||
|
|
||
| pos++; | ||
| if (pos == len || (ch = format[pos]) < '0' || ch > '9') |
tarekgh
reviewed
Apr 29, 2021
| { | ||
| // we need a template name | ||
| throw new ArgumentException($"Missing template name in format string at position {pos}", nameof(format)); | ||
| } |
There was a problem hiding this comment.
you can move this block before the condition
if (templates == null) so you don't have to repeat the same code
tarekgh
reviewed
Apr 29, 2021
| } | ||
|
|
||
| // skip whitespace | ||
| while (pos < len && (ch = format[pos]) == ' ') |
There was a problem hiding this comment.
you need to do that in other places to check space char?
tarekgh
reviewed
Apr 29, 2021
| } | ||
| } | ||
|
|
||
| private static bool ValidTemplateNameChar(char ch, bool first) |
tarekgh
reviewed
Apr 29, 2021
| /// <summary> | ||
| /// Parses the message template and throws exception for malformed messages. | ||
| /// </summary> | ||
| internal static string Parse(this string msg, List<string>? templates) |
|
@maryamariyan is the PR still active, or is it stale now due to conflicts? |
ghost
locked as resolved and limited conversation to collaborators
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
A follow up PR for: #51064
Took parsing logic from https://github.com/geeknoid/FastFormatting/blob/8878f2b829b2ebc023ddabc5b12f584d024d2591/Text.Formatting/CompositeFormat.cs#L204-L486
cc: @geeknoid @eerhardt
Fixes #52226