[LG-71] Improvements to error handling #26
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
This refactoring is made in order to make it easier to introduce stricter checks during message decoding. Request, Response, and Event classes are now inheriting the WirepasMessage class. The class handles decoding of a message using the _get_related_message() method which should be implemented by each child class.
Earlier, it was possible that a protobuf payload not including a certain message was decoded using .from_payload(). For example when using GetConfigsRequest.from_payload() with a message missing GenericMessage::wirepas::get_configs_req, the library was not reporting an error and setting the req_id to 0 even though it was not initialized in the protobuf message. If that happens now, and InvalidMessageType exception is raised. This exception has the GatewayAPIParsingException as its parent to help with backwards compatibility. Also refactoring the tests and having a new test file for decoding related error testing.
If constructing a new SetScratchpadTargetAndActionRequest from payload fails due to invalid values, a new InvalidMessageContents exception is raised. This exception can hold the header of the request message, and it would be possible to generate a response with the corresponding req_id based on the exception.
sgunes-wirepas
force-pushed
the
fix/LG-71
branch
from
38c0827
to
400b1e8
Compare
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.
Includes 2 main changes:
.from_payload() calls now will raise an exception if a message with different type is given. For example when calling GetConfigsRequest.from_payload() with a message missing GenericMessage::wirepas::get_configs_req.
If SetScratchpadTargetAndActionRequest.from_payload() fails due to message contents (such as too large target sequence), it would raise a new InvalidMessageContents exception which contains the request header in it. This would make it possible to construct a response with the right request id.