Add JSON RPC response parsing
Requirements
- Filling out the template is required. Any pull request that does not include enough information to be reviewed in a timely manner may be closed at the maintainers' discretion.
- All new code requires tests to ensure against regressions.
- If pull request breaks tests it would not be merged.
Description of the Change
This PR adds methods needed for parsing JSON RPC responses from a received JSON string. In order to accomplish that the following changes have been made:
- new exception class:
JSONRPCInvalidResponseException(just likeJSONRPCInvalidRequestException); - new class:
JSONRPCResponse- JSON RPC version agnostic parser, based onJSONRPCRequest. It exposes two class methods:from_jsonandfrom_data- the former just deserializes JSON string and the latter relays parsing to version-specific class. The mechanism is the exact copy of the one used inJSONRPCRequest; - updated
JSONRPC10ResponseandJSONRPC20Responseclasses:- updated
errorsetters - verify whetherresultfield is None prior to assigning the error object (raiseValueErrorif it is not), deleteresultkey in case ofJSONRPC20Response(resultanderrorfields are mutually exclusive), attempt to construct error object before assigning the value; - added
resultanderrordeleters toJSONRPC20Response; - added
from_jsonandfrom_dataclass methods - the mechanism reflects the one found inJSONRPC10RequestandJSONRPC20Request.
- updated
To ensure proper implementation new tests have been added:
-
test_jsonrpc1.py:-
test_from_json_invalid_response_result- tests whether the parser raises anJSONRPCInvalidResponseExceptionif supplied with JSON string with missingresultfield; -
test_from_json_invalid_response_error- tests whether the parser raises anJSONRPCInvalidResponseExceptionif supplied with JSON string with missingerrorfield; -
test_from_json_invalid_response_id- tests whether the parser raises anJSONRPCInvalidResponseExceptionif supplied with JSON string with missingidfield; -
test_from_json_invalid_response_both_result_and_error- tests whether the parser raises anJSONRPCInvalidResponseExceptionif supplied with JSON string with bothresultanderrorfields other thanNone; -
test_from_json_invalid_response_extra_data- tests whether the parser raises anJSONRPCInvalidResponseExceptionif supplied with JSON string with extra fields; -
test_from_json_response_result- tests whether parsing is correct for a specifiedresultfield; -
test_from_json_response_error- tests whether parsing is correct for a specifiederrorfield -
test_from_json_string_not_dict- tests whether the parser raises aValueErrorif supplied JSON string does not represent a dictionary.
-
-
test_jsonrpc2.py:-
test_from_json_invalid_response_jsonrpc- tests whether the parser raises anJSONRPCInvalidResponseExceptionif supplied with JSON string with missingjsonrpcfield; -
test_from_json_invalid_response_id- tests whether the parser raises anJSONRPCInvalidResponseExceptionif supplied with JSON string with missingidfield; -
test_from_json_invalid_response_no_result_error- tests whether the parser raises anJSONRPCInvalidResponseExceptionif supplied with JSON string with neitherresultnorerrorfields specified; -
test_from_json_invalid_response_result_and_error- tests whether the parser raises anJSONRPCInvalidResponseExceptionif supplied with JSON string with bothresultanderrorfields specified; -
test_from_json_invalid_response_extra_data- tests whether the parser raises anJSONRPCInvalidResponseExceptionif supplied with JSON string with extra fields; -
test_from_json_response_result_null- tests whether the parsing is correct for aNoneas aresult; -
test_from_json_response_result- tests whether the parsing is correct for alistas aresult; -
test_from_json_response_error- tests whether the parsing is correct for an error response.
-
Benefits
This change provides a symmetrical interface for both JSONRPCRequest and JSONRPCResponse. This provides an easy and consistent way to implement symmetrical interfaces, in which either side of an connection acts as a server-client hybrid, e.g. server that sends notifications to connected clients.
Possible Drawbacks
Should be none. All tests are passing (except for the Python 3.3 environment, but that is an upstream issue), however it may be reasonable to closely inspect whether error.setter update (in JSONRPC10Response and JSONRPC20Response) did not break anything.