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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fix: Catch and surface BaseException() #1108

Merged
merged 3 commits into from
Mar 6, 2024
Merged

fix: Catch and surface BaseException() #1108

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d43c2e3
fix: Catch and surface BaseException()
mukund-ananthu Mar 5, 2024
d9429e7
馃 Updates from OwlBot post-processor
gcf-owl-bot[bot] Mar 5, 2024
558d4ac
Merge branch 'main' into be
mukund-ananthu Mar 6, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
Next Next commit
fix: Catch and surface BaseException() 
Currently, the behavior of the library is to catch Exception() when encountered in the user provided callback, surface it to the calling code and shut down the client.

However, for BaseException() encountered in the user provided callback, the BaseException() is not surfaced to the calling code and the client is not shut down.

Make the behavior of the client when BaseException() is encountered consistent with the behavior of the client when Exception() is encountered.
  • Loading branch information
@mukund-ananthu
mukund-ananthu committed Mar 5, 2024
commit d43c2e3188e6d9379435e536e672b204d1ef1f66
4 changes: 2 additions & 2 deletions google/cloud/pubsub_v1/subscriber/_protocol/streaming_pull_manager.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ def _wrap_as_exception(maybe_exception: Any) -> BaseException:

def _wrap_callback_errors(
callback: Callable[["google.cloud.pubsub_v1.subscriber.message.Message"], Any],
on_callback_error: Callable[[Exception], Any],
on_callback_error: Callable[[BaseException], Any],
message: "google.cloud.pubsub_v1.subscriber.message.Message",
):
"""Wraps a user callback so that if an exception occurs the message is
Expand All @@ -124,7 +124,7 @@ def _wrap_callback_errors(
"""
try:
callback(message)
except Exception as exc:
except BaseException as exc:
# Note: the likelihood of this failing is extremely low. This just adds
# a message to a queue, so if this doesn't work the world is in an
# unrecoverable state and this thread should just bail.
Expand Down
10 changes: 8 additions & 2 deletions tests/unit/pubsub_v1/subscriber/test_streaming_pull_manager.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,8 +77,14 @@ def test__wrap_callback_errors_no_error():
on_callback_error.assert_not_called()


def test__wrap_callback_errors_error():
callback_error = ValueError("meep")
@pytest.mark.parametrize(
"callback_error",
[
(ValueError("ValueError")),
(BaseException("BaseException")),
],
)
def test__wrap_callback_errors_error(callback_error):

msg = mock.create_autospec(message.Message, instance=True)
callback = mock.Mock(side_effect=callback_error)
Expand Down