[SPARK-48490][CORE] Unescapes any literals for message of MessageWithContext #46824
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
common/utils/src/main/scala/org/apache/spark/internal/Logging.scala
Outdated
Show resolved
Hide resolved
|
@gengliangwang |
gengliangwang
approved these changes
May 31, 2024
|
Thanks, merging to master |
riyaverm-db
pushed a commit
to riyaverm-db/spark
that referenced
this pull request
Jun 7, 2024
…Context
### What changes were proposed in this pull request?
The pr aims to `unescapes` any literals for `message` of `MessageWithContext`
### Why are the changes needed?
- For example, before this PR
```
logInfo("This is a log message\nThis is a new line \t other msg")
```
It will output:
```
24/05/31 22:53:27 INFO PatternLoggingSuite: This is a log message
This is a new line other msg
```
But:
```
logInfo(log"This is a log message\nThis is a new line \t other msg")
```
It will output:
```
24/05/31 22:53:59 ERROR PatternLoggingSuite: This is a log message\nThis is a new line \t other msg
```
Obviously, the latter is not the result we `expected`.
### Does this PR introduce _any_ user-facing change?
Yes, fix bug.
### How was this patch tested?
- Add new UT.
- Pass GA.
### Was this patch authored or co-authored using generative AI tooling?
No.
Closes apache#46824 from panbingkun/SPARK-48490.
Authored-by: panbingkun <[email protected]>
Signed-off-by: Gengliang Wang <[email protected]>
| @@ -99,7 +100,7 @@ case class MessageWithContext(message: String, context: java.util.HashMap[String | |||
| * Companion class for lazy evaluation of the MessageWithContext instance. | |||
| */ | |||
| class LogEntry(messageWithContext: => MessageWithContext) { | |||
| def message: String = messageWithContext.message | |||
| def message: String = StringEscapeUtils.unescapeJava(messageWithContext.message) | |||
There was a problem hiding this comment.
Hi, @panbingkun and @gengliangwang .
This seems to break SparkR somehow. Could you take a look at this?
-- Error ('test_basic.R:25:3'): create DataFrame from list or data.frame -------
Error in `handleErrors(returnStatus, conn)`: java.lang.IllegalArgumentException: Unable to parse unicode value: serF
at org.apache.commons.text.translate.UnicodeUnescaper.translate(UnicodeUnescaper.java:55)
at org.apache.commons.text.translate.AggregateTranslator.translate(AggregateTranslator.java:58)
at org.apache.commons.text.translate.CharSequenceTranslator.translate(CharSequenceTranslator.java:101)
at org.apache.commons.text.translate.CharSequenceTranslator.translate(CharSequenceTranslator.java:63)
at org.apache.commons.text.StringEscapeUtils.unescapeJava(StringEscapeUtils.java:802)
at org.apache.spark.internal.LogEntry.message(Logging.scala:103)
There was a problem hiding this comment.
Okay, Let me investigate it
There was a problem hiding this comment.
@dongjoon-hyun
I have identified the root cause of this issue and am currently attempting to fix it
#46897 (comment)
yaooqinn
pushed a commit
that referenced
this pull request
Jun 21, 2024
### What changes were proposed in this pull request? Even with the fix in #46824, the escape sequences (`\r`, `\n`, `\t`, etc) are not handled properly. For example, when we use `log"\n"`, the StringContext interprets `\n` as a literal backslash `\` followed by `n` instead of a newline character. As a result, the bytes of `log"\n".message` becomes `[92, 110]`, instead of `[10]`. This PR is to fix the issue by using the method StringContext.processEscapes in `LogStringContext`. ### Why are the changes needed? To ensure that escape sequences are properly processed in Spark logs ### Does this PR introduce _any_ user-facing change? No ### How was this patch tested? New UT ### Was this patch authored or co-authored using generative AI tooling? No Closes #47050 from gengliangwang/fixEscape. Authored-by: Gengliang Wang <[email protected]> Signed-off-by: Kent Yao <[email protected]>
attilapiros
pushed a commit
to attilapiros/spark
that referenced
this pull request
Oct 4, 2024
### What changes were proposed in this pull request? Even with the fix in apache#46824, the escape sequences (`\r`, `\n`, `\t`, etc) are not handled properly. For example, when we use `log"\n"`, the StringContext interprets `\n` as a literal backslash `\` followed by `n` instead of a newline character. As a result, the bytes of `log"\n".message` becomes `[92, 110]`, instead of `[10]`. This PR is to fix the issue by using the method StringContext.processEscapes in `LogStringContext`. ### Why are the changes needed? To ensure that escape sequences are properly processed in Spark logs ### Does this PR introduce _any_ user-facing change? No ### How was this patch tested? New UT ### Was this patch authored or co-authored using generative AI tooling? No Closes apache#47050 from gengliangwang/fixEscape. Authored-by: Gengliang Wang <[email protected]> Signed-off-by: Kent Yao <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
What changes were proposed in this pull request?
The pr aims to
unescapesany literals formessageofMessageWithContextWhy are the changes needed?
It will output:
But:
It will output:
Obviously, the latter is not the result we
expected.Does this PR introduce any user-facing change?
Yes, fix bug.
How was this patch tested?
Was this patch authored or co-authored using generative AI tooling?
No.