chore: Better error message for when there is a sl4j version mismatch #32360
Conversation
| private val capturingAppender = | ||
| try { | ||
| CapturingAppender.get("") | ||
| } catch { | ||
| case iae: IllegalArgumentException if iae.getMessage.contains("it was a [org.slf4j.helpers.NOPLogger]") => | ||
| throw new RuntimeException( | ||
| "SLF could not initialize the logger, this is may be caused by accidentally having the slf4j-api dependency " + | ||
| "evicted/bumped to 2.2 by transitive dependencies while Akka only supports slf4j-api 1.7", | ||
| iae) | ||
| } |
There was a problem hiding this comment.
If I understand it correctly, previous slf4j version would return a valid logger when we lookup for "" and then we would check if its appender is CapturingAppender, correct?
It would be better to not rely on this but find another way of lookup the declared appender.
There was a problem hiding this comment.
Ok maybe looking up for "" was the how we could find the root logger?
There was a problem hiding this comment.
Ok, I dug a little more in the code to better understand it.
When looking up for org.slf4j.Logger.ROOT_LOGGER_NAME, we get back the NOPLogger if using slf4j 2.2. Isn't that strange?
There was a problem hiding this comment.
If getting slf4j-api 2.2 on path, and a logging provider that doesn't implement 2.2, it is ignored and falls back to that no-op logger, which throws the IAE higher upp in the call chain. I think this is a good place to catch that and ammend some details that may not be obvious.
This dummy lookup makes sure that failure happens early rather than intermingled with test logic where it would possibly seem like an actual test failure.
No description provided.