How to get JSON error response from ErpNext API?

MartinHBramwell · January 10, 2020, 11:03am

Is there a way to tell the ErpNext REST API to return a JSON response when an error occurs?

I’ve been scrolling back and forth through reams of HTML to find error messages and it just occurred to me – “This isn’t even remotely normal! Since when does a computer to computer interface return a computer to human response to report an error?”

tmatteson · January 10, 2020, 1:03pm

It’s an inconsistent design. That said, fixing it would require changing your app.py file or changing the way that errors are handled in the front end of frappe.

github.com

frappe/frappe/blob/develop/frappe/app.py#L141


      
          	"""
          	frappe.flags.read_only = True
          
          
	# If replica is available then just connect replica, else setup read only transaction.
          	if frappe.conf.read_from_replica:
          		frappe.connect_replica()
          	else:
          		frappe.db.begin(read_only=True)
          
          

          
def log_request(request, response):
          	if hasattr(frappe.local, "conf") and frappe.local.conf.enable_frappe_logger:
          		frappe.logger("frappe.web", allow_site=frappe.local.site).info(
          			{
          				"site": get_site_name(request.host),
          				"remote_addr": getattr(request, "remote_addr", "NOTFOUND"),
          				"base_url": getattr(request, "base_url", "NOTFOUND"),
          				"full_path": getattr(request, "full_path", "NOTFOUND"),
          				"method": getattr(request, "method", "NOTFOUND"),
          				"scheme": getattr(request, "scheme", "NOTFOUND"),
          				"http_status_code": getattr(response, "status_code", "NOTFOUND"),

That flag is set to False and is not available outside that function. It’s set another half dozen times below there as well.

MartinHBramwell · January 10, 2020, 1:09pm

So it’s a candidate for a feature request in GitHub?

tmatteson · January 10, 2020, 1:12pm

Yes, I would say so

MartinHBramwell · January 10, 2020, 1:17pm

Sorta what I thought, but …

… am I really the first to ask about this?

It’s quite an egregious breach of the REST “contract”, don’t you think?

rmeyer · January 10, 2020, 2:11pm

nope: Not honoring accept-header when posting invalid JSON · Issue #6201 · frappe/frappe · GitHub

revant_one · January 11, 2020, 5:30am

This is just a workaround, it doesn’t solve the issue. If the api consumer app can handle the response something like following can be done:

https://github.com/frappe/push-biometric-erpnext/blob/master/push_to_erpnext.py#L186

if EMPLOYEE_NOT_FOUND_ERROR_MESSAGE in error_str

avaiskhatri · November 9, 2020, 4:42pm

Any luck ?

rmeyer · November 9, 2020, 4:45pm

Not so easy to solve, as you can read here.