-
Notifications
You must be signed in to change notification settings - Fork 45
fix: quote fields containing a carriage return in CsvWriter #128
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
Open
stevehansen
wants to merge
2
commits into
master
Choose a base branch
from
fix/csvwriter-carriage-return-quoting
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
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
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 |
|---|---|---|
|
|
@@ -26,7 +26,13 @@ public static class CsvWriter | |
| // Keep the fixed escape chars cached and check the separator with a separate Contains. | ||
| // Without this caching, MemoryExtensions.IndexOfAny(ReadOnlySpan, ReadOnlySpan)/char[] | ||
| // builds a fresh SearchValues<char> on the heap every call. | ||
| private static readonly SearchValues<char> FixedEscapeChars = SearchValues.Create("'\n"); | ||
| private static readonly SearchValues<char> FixedEscapeChars = SearchValues.Create("'\n\r"); | ||
| #else | ||
| // RFC 4180: a field must be quoted when it contains a quote, the separator, CR, or LF. | ||
| // Kept as a shared array (scanned alongside a separate separator check) so WriteLine | ||
| // doesn't allocate a per-row char[] on the netstandard2.0 path. NET8+ uses the | ||
| // vectorized SearchValues above instead. | ||
| private static readonly char[] FixedEscapeCharsArray = { '\'', '\n', '\r' }; | ||
| #endif | ||
|
|
||
| /// <summary> | ||
|
|
@@ -468,7 +474,6 @@ public static async Task<string> WriteToTextAsync(ReadOnlyMemory<char>[]? header | |
|
|
||
| private static void WriteLine(TextWriter writer, string[] data, int columnCount, char separator) | ||
| { | ||
| var escapeChars = new[] { separator, '\'', '\n' }; | ||
| for (var i = 0; i < columnCount; i++) | ||
| { | ||
| if (i > 0) | ||
|
|
@@ -487,7 +492,11 @@ private static void WriteLine(TextWriter writer, string[] data, int columnCount, | |
| escape = true; | ||
| cell = cell.Replace("\"", "\"\""); | ||
| } | ||
| else if (cell.IndexOfAny(escapeChars) >= 0) | ||
| #if NET8_0_OR_GREATER | ||
| else if (cell.Contains(separator) || cell.AsSpan().IndexOfAny(FixedEscapeChars) >= 0) | ||
| #else | ||
| else if (cell.IndexOf(separator) >= 0 || cell.IndexOfAny(FixedEscapeCharsArray) >= 0) | ||
| #endif | ||
| escape = true; | ||
|
|
||
| if (escape) | ||
|
|
@@ -503,7 +512,6 @@ private static void WriteLine(TextWriter writer, string[] data, int columnCount, | |
|
|
||
| private static async Task WriteLineAsync(TextWriter writer, string[] data, int columnCount, char separator) | ||
| { | ||
| var escapeChars = new[] { separator, '\'', '\n' }; | ||
| for (var i = 0; i < columnCount; i++) | ||
| { | ||
| if (i > 0) | ||
|
|
@@ -555,7 +563,11 @@ private static async Task WriteLineAsync(TextWriter writer, string[] data, int c | |
| // Write closing quote | ||
| await writer.WriteAsync('"').ConfigureAwait(false); | ||
| } | ||
| else if (cell.IndexOfAny(escapeChars) >= 0) | ||
| #if NET8_0_OR_GREATER | ||
| else if (cell.Contains(separator) || cell.AsSpan().IndexOfAny(FixedEscapeChars) >= 0) | ||
| #else | ||
| else if (cell.IndexOf(separator) >= 0 || cell.IndexOfAny(FixedEscapeCharsArray) >= 0) | ||
|
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. Similarly to the synchronous #if NET8_0_OR_GREATER
else if (cell.Contains(separator) || cell.AsSpan().IndexOfAny(FixedEscapeChars) >= 0)
#else
else if (cell.IndexOf(separator) >= 0 || cell.IndexOfAny(FixedEscapeCharsArray) >= 0)
#endif |
||
| #endif | ||
| { | ||
| await writer.WriteAsync('"').ConfigureAwait(false); | ||
| await writer.WriteAsync(cell).ConfigureAwait(false); | ||
|
|
||
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
On .NET 8.0 and greater, we can leverage the pre-defined
SearchValues<char>(FixedEscapeChars) andstring.Contains(char)to avoid the overhead of searching with achar[]array. This improves performance on the hot path when writing rows.