[data] introduce Environment and improve KyoException #1057
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
fwbrasil
commented
Jan 28, 2025
| Option(message) match | ||
| case Some(message) => message.toString; | ||
| case _ => null, | ||
| class KyoException private[kyo] (message: Text = "", cause: Text | Throwable = "")(using val frame: Frame) |
There was a problem hiding this comment.
fall back to empty string instead of null
fwbrasil
commented
Jan 28, 2025
| object Environment: | ||
|
|
||
| def isDevelopment(): Boolean = | ||
| sys.props.get("kyo.development-mode.enable").map(_.toLowerCase) match |
There was a problem hiding this comment.
development can also be enabled explicitly via the kyo.development-mode.enable system property
There was a problem hiding this comment.
Thanks for adding this. What would you think about kyo.development?
| cause match | ||
| case cause: Throwable => cause; |
There was a problem hiding this comment.
🙀 is the ; the cause of the trouble? I'm so sorry 😿
There was a problem hiding this comment.
No, it's harmless :)
hearnadam
reviewed
Jan 28, 2025
| val msg = frame.render(("⚠️ KyoException".red.bold :: Maybe(message).toList ::: detail.toList).map(_.show)*) | ||
| s"\n$msg\n" | ||
| else | ||
| detail.map(_.toString).getOrElse(null) |
There was a problem hiding this comment.
How about .fold("")(_.take(1000).toString)?
Co-authored-by: Ondra Pelech <[email protected]>
hearnadam
approved these changes
Jan 28, 2025
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.
Problem
KyoExceptionis too verbose in production environments. It's designed to improve the development experience by showing errors with theFrameinformation but, in a production environment, the overhead to log failures can significantly contribute to performance degradation.Solution
Introduce
Environmentthat enables the verbose mode only if the user explicitly enables the development mode or sbt entries are present in the classpath, which should be the case for Kyo development environments since we recommend both sbt and metals. The risk of false positives seems low since the check is strict.Notes
I've also improved
KyoExceptionbecause I noticed aNullPointerException.