I think the hook gets called any time any exception makes it to this function:

Lines 1374 to 1440 in 950cc76

    
           async def handle_500(self, request, send, exception): 
        
               if self.ds.pdb: 
        
                   import pdb 
        
                   pdb.post_mortem(exception.__traceback__) 
        
               if rich is not None: 
        
                   rich.get_console().print_exception(show_locals=True) 
        
               title = None 
        
               if isinstance(exception, Forbidden): 
        
                   status = 403 
        
                   info = {} 
        
                   message = exception.args[0] 
        
                   # Try the forbidden() plugin hook 
        
                   for custom_response in pm.hook.forbidden( 
        
                       datasette=self.ds, request=request, message=message 
        
                   ): 
        
                       custom_response = await await_me_maybe(custom_response) 
        
                       if custom_response is not None: 
        
                           await custom_response.asgi_send(send) 
        
                           return 
        
               elif isinstance(exception, Base400): 
        
                   status = exception.status 
        
                   info = {} 
        
                   message = exception.args[0] 
        
               elif isinstance(exception, DatasetteError): 
        
                   status = exception.status 
        
                   info = exception.error_dict 
        
                   message = exception.message 
        
                   if exception.message_is_html: 
        
                       message = Markup(message) 
        
                   title = exception.title 
        
               else: 
        
                   status = 500 
        
                   info = {} 
        
                   message = str(exception) 
        
                   traceback.print_exc() 
        
               templates = [f"{status}.html", "error.html"] 
        
               info.update( 
        
                   { 
        
                       "ok": False, 
        
                       "error": message, 
        
                       "status": status, 
        
                       "title": title, 
        
                   } 
        
               ) 
        
               headers = {} 
        
               if self.ds.cors: 
        
                   add_cors_headers(headers) 
        
               if request.path.split("?")[0].endswith(".json"): 
        
                   await asgi_send_json(send, info, status=status, headers=headers) 
        
               else: 
        
                   template = self.ds.jinja_env.select_template(templates) 
        
                   await asgi_send_html( 
        
                       send, 
        
                       await template.render_async( 
        
                           dict( 
        
                               info, 
        
                               urls=self.ds.urls, 
        
                               app_css_hash=self.ds.app_css_hash(), 
        
                               menu_links=lambda: [], 
        
                           ) 
        
                       ), 
        
                       status=status, 
        
                       headers=headers, 
        
                   )

Multiple plugins can register for the hook. If they return a Response then that's returned to the user - if they return None then they can quietly do something with the error (log it to Sentry for example) and let some other handler return a response.

I think Datasette should have a default plugin hook implementation which returns the 500 error page.

	async def handle_500(self, request, send, exception):
	if self.ds.pdb:
	import pdb

	pdb.post_mortem(exception.__traceback__)

	if rich is not None:
	rich.get_console().print_exception(show_locals=True)

	title = None
	if isinstance(exception, Forbidden):
	status = 403
	info = {}
	message = exception.args[0]
	# Try the forbidden() plugin hook
	for custom_response in pm.hook.forbidden(
	datasette=self.ds, request=request, message=message
	):
	custom_response = await await_me_maybe(custom_response)
	if custom_response is not None:
	await custom_response.asgi_send(send)
	return
	elif isinstance(exception, Base400):
	status = exception.status
	info = {}
	message = exception.args[0]
	elif isinstance(exception, DatasetteError):
	status = exception.status
	info = exception.error_dict
	message = exception.message
	if exception.message_is_html:
	message = Markup(message)
	title = exception.title
	else:
	status = 500
	info = {}
	message = str(exception)
	traceback.print_exc()
	templates = [f"{status}.html", "error.html"]
	info.update(
	{
	"ok": False,
	"error": message,
	"status": status,
	"title": title,
	}
	)
	headers = {}
	if self.ds.cors:
	add_cors_headers(headers)
	if request.path.split("?")[0].endswith(".json"):
	await asgi_send_json(send, info, status=status, headers=headers)
	else:
	template = self.ds.jinja_env.select_template(templates)
	await asgi_send_html(
	send,
	await template.render_async(
	dict(
	info,
	urls=self.ds.urls,
	app_css_hash=self.ds.app_css_hash(),
	menu_links=lambda: [],
	)
	),
	status=status,
	headers=headers,
	)

Uh oh!

handle_exception plugin hook for custom error handling #1770

Description

Metadata

Metadata

Assignees

Labels

Projects

Milestone

Relationships

Development

Issue actions

`handle_exception` plugin hook for custom error handling #1770