Improve readability of proto decode exception message #2768
Conversation
xiaozhikang0916
force-pushed
the
feature/wire-type-message
branch
from
5ce64b3
to
453e164
Compare
|
@sandwwraith can you take a look on this PR? |
|
@xiaozhikang0916 sure |
|
It seems there are some tests failing |
formats/protobuf/commonMain/src/kotlinx/serialization/protobuf/internal/Helpers.kt
Show resolved
Hide resolved
formats/protobuf/commonMain/src/kotlinx/serialization/protobuf/internal/Helpers.kt
Outdated
Show resolved
Hide resolved
formats/protobuf/commonMain/src/kotlinx/serialization/protobuf/internal/Helpers.kt
Show resolved
Hide resolved
formats/protobuf/commonMain/src/kotlinx/serialization/protobuf/internal/ProtobufDecoding.kt
Outdated
Show resolved
Hide resolved
formats/protobuf/commonMain/src/kotlinx/serialization/protobuf/internal/ProtobufDecoding.kt
Outdated
Show resolved
Hide resolved
formats/protobuf/commonMain/src/kotlinx/serialization/protobuf/internal/ProtobufReader.kt
Outdated
Show resolved
Hide resolved
formats/protobuf/commonTest/src/kotlinx/serialization/protobuf/ProtoTagExceptionTest.kt
Outdated
Show resolved
Hide resolved
formats/protobuf/commonTest/src/kotlinx/serialization/protobuf/ProtoTagExceptionTest.kt
Outdated
Show resolved
Hide resolved
formats/protobuf/commonTest/src/kotlinx/serialization/protobuf/TestFunctions.kt
Outdated
Show resolved
Hide resolved
formats/protobuf/commonTest/src/kotlinx/serialization/protobuf/TestFunctions.kt
Outdated
Show resolved
Hide resolved
| val currentMessage = message[index] | ||
| assertNotNull(currentException, "Expected exception to have a cause with message $currentMessage, but it was null") | ||
| require(currentException != null) | ||
| assertEquals(currentMessage, currentException.message, "Expected exception to have a cause with message <$currentMessage>, but it was <${currentException.message}> at cause stack ${index + depth}") |
There was a problem hiding this comment.
IDEA can show nice 'Click to see the difference' pop-up to compare between expected and actual values on test failure, but only if the exception message satisfies JUnit4's exception message regex (https://stackoverflow.com/questions/10934743/formatting-output-so-that-intellij-idea-shows-diffs-for-two-texts). So you may want to rephrase your message a bit for it to include expected:<bla-blah> but was:<blah-blah-blah> substring.
There was a problem hiding this comment.
After diving into assertEquals I found that it would append the Expected <$expected>, actual <$actual>. string after message passing in. So I would just simplify the input message.
It works in my IntelliJ IDEA 2024.2.1 RC and you can comment out the Ignore annotation in the new TestFunctionTest to see if it also works in other environments. And since these tests are for checking IDEA behaviours, I would just leave it failing, not wraping another assertFailWith with message check.
Found it hard to debug when exceptions with message like
Expected wire type 0, but found 1were got. This PR is about to make some improvement of these messages for better tracability and readability.ProtoWireTypeto show both name and id in message,ProtobufDecodingExceptionin mostdecodeXXXfunctions, with proto number and type name in new exception message.