LBRYCommunity/lbry-sdk
1
0
Fork 1
Code Issues Pull requests Projects Releases 282 Packages Wiki Activity

improved the data structure returned from RPC for errors by adding a error name and other metadata

Browse source
This commit is contained in:
Lex Berezhny 2019-12-14 15:21:26 -05:00
parent f6fcfb6dde
commit ba414742a6
2 changed files with 36 additions and 63 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

60
lbry/lbry/extras/daemon/Daemon.py
View file

@ -26,7 +26,8 @@ from lbry.blob.blob_file import is_valid_blobhash, BlobBuffer
from lbry.blob_exchange.downloader import download_blob from lbry.blob_exchange.downloader import download_blob
from lbry.dht.peer import make_kademlia_peer from lbry.dht.peer import make_kademlia_peer
from lbry.error import ( from lbry.error import (
DownloadSDTimeoutError, ComponentsNotStartedError, ComponentStartConditionNotMetError DownloadSDTimeoutError, ComponentsNotStartedError, ComponentStartConditionNotMetError,
CommandError, CommandInvalidArgumentError, CommandDoesNotExistError
) )
from lbry.extras import system_info from lbry.extras import system_info
from lbry.extras.daemon import analytics from lbry.extras.daemon import analytics
@ -169,10 +170,6 @@ def paginate_list(items: List, page: Optional[int], page_size: Optional[int]):
} }
def sort_claim_results(claims):
claims.sort(key=lambda d: (d['height'], d['name'], d['claim_id'], d['txid'], d['nout']))
DHT_HAS_CONTACTS = "dht_has_contacts" DHT_HAS_CONTACTS = "dht_has_contacts"
@ -215,10 +212,11 @@ class JSONRPCError:
CODE_AUTHENTICATION_ERROR: 401, CODE_AUTHENTICATION_ERROR: 401,
} }
def __init__(self, message, code=CODE_APPLICATION_ERROR, traceback=None, data=None): def __init__(self, message, code=CODE_APPLICATION_ERROR, traceback=None, data=None, name=None):
assert isinstance(code, int), "'code' must be an int" assert isinstance(code, int), "'code' must be an int"
assert (data is None or isinstance(data, dict)), "'data' must be None or a dict" assert (data is None or isinstance(data, dict)), "'data' must be None or a dict"
self.code = code self.code = code
self.name = name or 'Exception'
if message is None: if message is None:
message = self.MESSAGES[code] if code in self.MESSAGES else "API Error" message = self.MESSAGES[code] if code in self.MESSAGES else "API Error"
self.message = message self.message = message
@ -235,13 +233,23 @@ class JSONRPCError:
def to_dict(self): def to_dict(self):
return { return {
'code': self.code, 'code': self.code,
'name': self.name,
'message': self.message, 'message': self.message,
'data': self.traceback 'data': self.data,
'traceback': self.traceback
} }
@classmethod @classmethod
def create_from_exception(cls, message, code=CODE_APPLICATION_ERROR, traceback=None): def create_command_exception(cls, e, command, args, kwargs, traceback):
return cls(message, code=code, traceback=traceback) if 'password' in kwargs and isinstance(kwargs['password'], str):
kwargs['password'] = '*'*len(kwargs['password'])
return cls(str(e), traceback=traceback, name=e.__class__.__name__, data={
'command': command, 'args': args, 'kwargs': kwargs,
})
@classmethod
def create_rpc_exception(cls, e, code):
return cls(str(e), name=e.__class__.__name__, code=code)
class UnknownAPIMethodError(Exception): class UnknownAPIMethodError(Exception):
@ -493,7 +501,8 @@ class Daemon(metaclass=JSONRPCServerType):
async def handle_old_jsonrpc(self, request): async def handle_old_jsonrpc(self, request):
data = await request.json() data = await request.json()
include_protobuf = data.get('params', {}).pop('include_protobuf', False) params = data.get('params', {})
include_protobuf = params.pop('include_protobuf', False) if isinstance(params, dict) else False
result = await self._process_rpc_call(data) result = await self._process_rpc_call(data)
ledger = None ledger = None
if 'wallet' in self.component_manager.get_components_status(): if 'wallet' in self.component_manager.get_components_status():
@ -560,30 +569,34 @@ class Daemon(metaclass=JSONRPCServerType):
try: try:
function_name = data['method'] function_name = data['method']
except KeyError: except KeyError:
return JSONRPCError( return JSONRPCError.create_rpc_exception(
"Missing 'method' value in request.", JSONRPCError.CODE_METHOD_NOT_FOUND CommandError("Missing 'method' value in request."),
JSONRPCError.CODE_METHOD_NOT_FOUND
) )
try: try:
fn = self._get_jsonrpc_method(function_name) fn = self._get_jsonrpc_method(function_name)
except UnknownAPIMethodError: except UnknownAPIMethodError:
return JSONRPCError( return JSONRPCError.create_rpc_exception(
f"Invalid method requested: {function_name}.", JSONRPCError.CODE_METHOD_NOT_FOUND CommandDoesNotExistError(function_name),
JSONRPCError.CODE_METHOD_NOT_FOUND
) )
if args in ([{}], []): if args in ([{}], []):
_args, _kwargs = (), {} _args, _kwargs = (), {}
elif isinstance(args, dict): elif isinstance(args, dict):
_args, _kwargs = (), args _args, _kwargs = (), args
elif len(args) == 1 and isinstance(args[0], dict): elif isinstance(args, list) and len(args) == 1 and isinstance(args[0], dict):
# TODO: this is for backwards compatibility. Remove this once API and UI are updated # TODO: this is for backwards compatibility. Remove this once API and UI are updated
# TODO: also delete EMPTY_PARAMS then # TODO: also delete EMPTY_PARAMS then
_args, _kwargs = (), args[0] _args, _kwargs = (), args[0]
elif len(args) == 2 and isinstance(args[0], list) and isinstance(args[1], dict): elif isinstance(args, list) and len(args) == 2 and\
isinstance(args[0], list) and isinstance(args[1], dict):
_args, _kwargs = args _args, _kwargs = args
else: else:
return JSONRPCError( return JSONRPCError.create_rpc_exception(
f"Invalid parameters format.", JSONRPCError.CODE_INVALID_PARAMS CommandError(f"Invalid parameters format: {args}"),
JSONRPCError.CODE_INVALID_PARAMS
) )
if is_transactional_function(function_name): if is_transactional_function(function_name):
@ -595,8 +608,9 @@ class Daemon(metaclass=JSONRPCServerType):
params_error, function_name, ', '.join(erroneous_params) params_error, function_name, ', '.join(erroneous_params)
) )
log.warning(params_error_message) log.warning(params_error_message)
return JSONRPCError( return JSONRPCError.create_rpc_exception(
params_error_message, JSONRPCError.CODE_INVALID_PARAMS CommandError(params_error_message),
JSONRPCError.CODE_INVALID_PARAMS
) )
try: try:
@ -609,10 +623,8 @@ class Daemon(metaclass=JSONRPCServerType):
raise raise
except Exception as e: # pylint: disable=broad-except except Exception as e: # pylint: disable=broad-except
log.exception("error handling api request") log.exception("error handling api request")
return JSONRPCError( return JSONRPCError.create_command_exception(
f"Error calling {function_name} with args {args}\n" + str(e), e, function_name, _args, _kwargs, format_exc()
JSONRPCError.CODE_APPLICATION_ERROR,
format_exc()
) )
def _verify_method_is_callable(self, function_path): def _verify_method_is_callable(self, function_path):

39
lbry/tests/unit/lbrynet_daemon/test_claims_comparator.py
View file

@ -1,39 +0,0 @@
import unittest
from lbry.extras.daemon.Daemon import sort_claim_results
class ClaimsComparatorTest(unittest.TestCase):
def test_sort_claim_results_when_sorted_by_claim_id(self):
results = [{"height": 1, "name": "res", "claim_id": "ccc", "nout": 0, "txid": "fdsafa"},
{"height": 1, "name": "res", "claim_id": "aaa", "nout": 0, "txid": "w5tv8uorgt"},
{"height": 1, "name": "res", "claim_id": "bbb", "nout": 0, "txid": "aecfaewcfa"}]
self.run_test(results, 'claim_id', ['aaa', 'bbb', 'ccc'])
def test_sort_claim_results_when_sorted_by_height(self):
results = [{"height": 1, "name": "res", "claim_id": "ccc", "nout": 0, "txid": "aecfaewcfa"},
{"height": 3, "name": "res", "claim_id": "ccc", "nout": 0, "txid": "aecfaewcfa"},
{"height": 2, "name": "res", "claim_id": "ccc", "nout": 0, "txid": "aecfaewcfa"}]
self.run_test(results, 'height', [1, 2, 3])
def test_sort_claim_results_when_sorted_by_name(self):
results = [{"height": 1, "name": "res1", "claim_id": "ccc", "nout": 0, "txid": "aecfaewcfa"},
{"height": 1, "name": "res3", "claim_id": "ccc", "nout": 0, "txid": "aecfaewcfa"},
{"height": 1, "name": "res2", "claim_id": "ccc", "nout": 0, "txid": "aecfaewcfa"}]
self.run_test(results, 'name', ['res1', 'res2', 'res3'])
def test_sort_claim_results_when_sorted_by_txid(self):
results = [{"height": 1, "name": "res1", "claim_id": "ccc", "nout": 2, "txid": "111"},
{"height": 1, "name": "res1", "claim_id": "ccc", "nout": 1, "txid": "222"},
{"height": 1, "name": "res1", "claim_id": "ccc", "nout": 3, "txid": "333"}]
self.run_test(results, 'txid', ['111', '222', '333'])
def test_sort_claim_results_when_sorted_by_nout(self):
results = [{"height": 1, "name": "res1", "claim_id": "ccc", "nout": 2, "txid": "aecfaewcfa"},
{"height": 1, "name": "res1", "claim_id": "ccc", "nout": 1, "txid": "aecfaewcfa"},
{"height": 1, "name": "res1", "claim_id": "ccc", "nout": 3, "txid": "aecfaewcfa"}]
self.run_test(results, 'nout', [1, 2, 3])
def run_test(self, results, field, expected):
sort_claim_results(results)
self.assertListEqual(expected, [r[field] for r in results])