Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Improve the default handler when raise_error_for_unhandled_request is true #885

Merged
merged 1 commit into from
Apr 18, 2023
Merged

Improve the default handler when raise_error_for_unhandled_request is true #885

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 18 additions & 12 deletions slack_bolt/app/app.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -511,15 +511,18 @@ def middleware_next():
# This should not be an intentional handling in usual use cases.
resp = BoltResponse(status=404, body={"error": "no next() calls in middleware"})
if self._raise_error_for_unhandled_request is True:
self._listener_runner.listener_error_handler.handle(
error=BoltUnhandledRequestError(
try:
raise BoltUnhandledRequestError(
request=req,
current_response=resp,
last_global_middleware_name=middleware.name,
),
request=req,
response=resp,
)
)
except BoltUnhandledRequestError as e:
self._listener_runner.listener_error_handler.handle(
error=e,
request=req,
response=resp,
)
return resp
self._framework_logger.warning(warning_unhandled_by_global_middleware(middleware.name, req))
return resp
Expand Down Expand Up @@ -562,14 +565,17 @@ def middleware_next():
if resp is None:
resp = BoltResponse(status=404, body={"error": "unhandled request"})
if self._raise_error_for_unhandled_request is True:
self._listener_runner.listener_error_handler.handle(
error=BoltUnhandledRequestError(
try:
raise BoltUnhandledRequestError(
request=req,
current_response=resp,
),
request=req,
response=resp,
)
)
except BoltUnhandledRequestError as e:
self._listener_runner.listener_error_handler.handle(
error=e,
request=req,
response=resp,
)
return resp
return self._handle_unmatched_requests(req, resp)
except Exception as error:
Expand Down
30 changes: 18 additions & 12 deletions slack_bolt/app/async_app.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -535,15 +535,18 @@ async def async_middleware_next():
# This should not be an intentional handling in usual use cases.
resp = BoltResponse(status=404, body={"error": "no next() calls in middleware"})
if self._raise_error_for_unhandled_request is True:
await self._async_listener_runner.listener_error_handler.handle(
error=BoltUnhandledRequestError(
try:
raise BoltUnhandledRequestError(
request=req,
current_response=resp,
last_global_middleware_name=middleware.name,
),
request=req,
response=resp,
)
)
except BoltUnhandledRequestError as e:
await self._async_listener_runner.listener_error_handler.handle(
error=e,
request=req,
response=resp,
)
return resp
self._framework_logger.warning(warning_unhandled_by_global_middleware(middleware.name, req))
return resp
Expand Down Expand Up @@ -589,14 +592,17 @@ async def async_middleware_next():
if resp is None:
resp = BoltResponse(status=404, body={"error": "unhandled request"})
if self._raise_error_for_unhandled_request is True:
await self._async_listener_runner.listener_error_handler.handle(
error=BoltUnhandledRequestError(
try:
raise BoltUnhandledRequestError(
request=req,
current_response=resp,
),
request=req,
response=resp,
)
)
except BoltUnhandledRequestError as e:
await self._async_listener_runner.listener_error_handler.handle(
error=e,
request=req,
response=resp,
)
return resp
return self._handle_unmatched_requests(req, resp)

Expand Down
3 changes: 3 additions & 0 deletions slack_bolt/error/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,3 +23,6 @@ def __init__( # type: ignore
self.body = request.body if request is not None else {}
self.current_response = current_response
self.last_global_middleware_name = last_global_middleware_name

def __str__(self) -> str:
return "unhandled request error"
Empty file added tests/slack_bolt/error/__init__.py
View file
Open in desktop
Empty file.
19 changes: 19 additions & 0 deletions tests/slack_bolt/error/test_errors.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
from slack_bolt import BoltRequest
from slack_bolt.error import BoltUnhandledRequestError


class TestErrors:
def setup_method(self):
pass

def teardown_method(self):
pass

def test_say(self):
request = BoltRequest(body="foo=bar")
exception = BoltUnhandledRequestError(
request=request,
current_response={},
last_global_middleware_name="last_middleware",
)
assert str(exception) == "unhandled request error"