Release v4.3.0

Author: imjoehaines

CHANGELOG.md

@@ -1,6 +1,16 @@
 Changelog
 =========
 
+## v4.3.0 (2022-11-02)
+
+### Enhancements
+
+* Allow preventing an exception from being reported to Bugsnag by setting the `skip_bugsnag` attr to `True`
+  [#325](https://github.com/bugsnag/bugsnag-python/pull/325)
+
+* Prevent duplicate events from being notified in the Django integration
+  [#326](https://github.com/bugsnag/bugsnag-python/pull/326)
+
 ## v4.2.1 (2022-05-16)
 
 ### Bug fixes

bugsnag/configuration.py

@@ -15,7 +15,11 @@
     OnBreadcrumbCallback
 )
 from bugsnag.sessiontracker import SessionMiddleware
-from bugsnag.middleware import DefaultMiddleware, MiddlewareStack
+from bugsnag.middleware import (
+    DefaultMiddleware,
+    MiddlewareStack,
+    skip_bugsnag_middleware
+)
 from bugsnag.utils import (fully_qualified_class_name, validate_str_setter,
                            validate_bool_setter, validate_iterable_setter,
                            validate_required_str_setter, validate_int_setter)
@@ -72,6 +76,7 @@ def __init__(self, logger=_sentinel):
         self.middleware = MiddlewareStack()
 
         self.internal_middleware = MiddlewareStack()
+        self.internal_middleware.before_notify(skip_bugsnag_middleware)
         self.internal_middleware.append(DefaultMiddleware)
         self.internal_middleware.append(SessionMiddleware)
 

bugsnag/django/__init__.py

@@ -90,10 +90,7 @@ def configure():
     config.runtime_versions['django'] = django.__version__
 
     request_started.connect(__track_session)
-    got_request_exception.connect(
-        __handle_request_exception(config.logger),
-        weak=False
-    )
+    got_request_exception.connect(__handle_request_exception)
 
     return config
 
@@ -103,19 +100,17 @@ def __track_session(sender, **extra):
         bugsnag.start_session()
 
 
-def __handle_request_exception(logger):
-    def inner(sender, **kwargs):
-        request = kwargs.get('request', None)
+def __handle_request_exception(sender, **kwargs):
+    request = kwargs.get('request', None)
 
-        if request is not None:
-            bugsnag.configure_request(django_request=request)
+    if request is not None:
+        bugsnag.configure_request(django_request=request)
 
-        try:
-            bugsnag.auto_notify_exc_info(severity_reason={
-                "type": "unhandledExceptionMiddleware",
-                "attributes": {"framework": "Django"}
-            })
-        except Exception:
-            logger.exception("Error in exception middleware")
-
-    return inner
+    try:
+        bugsnag.auto_notify_exc_info(severity_reason={
+            "type": "unhandledExceptionMiddleware",
+            "attributes": {"framework": "Django"}
+        })
+
+    except Exception:
+        bugsnag.configure().logger.exception("Error in exception middleware")

bugsnag/django/middleware.py

@@ -48,6 +48,10 @@ def process_exception(self, request, exception):
                 }
             )
 
+            # ensure the 'got_request_exception' signal doesn't also notify
+            # this exception
+            setattr(exception, 'skip_bugsnag', True)
+
         except Exception:
             self.config.logger.exception("Error in exception middleware")
 

bugsnag/middleware.py

@@ -64,6 +64,15 @@ def __call__(self, event: Event):
         self.bugsnag(event)
 
 
+def skip_bugsnag_middleware(event: Event):
+    """
+    A callback-based middleware that prevents notifying an event where the
+    'original_error' has a 'skip_bugsnag' attr set to 'True'.
+    """
+    if getattr(event.original_error, 'skip_bugsnag', False) is True:
+        return False
+
+
 class MiddlewareStack:
     """
     Manages a stack of Bugsnag middleware.

setup.py

@@ -14,7 +14,7 @@
 
 setup(
     name='bugsnag',
-    version='4.2.1',
+    version='4.3.0',
     description='Automatic error monitoring for django, flask, etc.',
     long_description=__doc__,
     author='Simon Maynard',
@@ -37,9 +37,11 @@
         'Programming Language :: Python :: 3.7',
         'Programming Language :: Python :: 3.8',
         'Programming Language :: Python :: 3.9',
+        'Programming Language :: Python :: 3.10',
+        'Programming Language :: Python :: 3.11',
         'Topic :: Software Development'
     ],
-    package_data = {
+    package_data={
         'bugsnag': ['py.typed'],
     },
     test_suite='tests',

tests/integrations/test_django.py

@@ -52,6 +52,9 @@ def test_notify(bugsnag_server, django_client):
     assert response.status_code == 200
 
     bugsnag_server.wait_for_request()
+
+    assert bugsnag_server.sent_report_count == 1
+
     payload = bugsnag_server.received[0]['json_body']
     event = payload['events'][0]
     exception = event['exceptions'][0]
@@ -102,6 +105,9 @@ def test_enable_environment(bugsnag_server, django_client):
     assert response.status_code == 200
 
     bugsnag_server.wait_for_request()
+
+    assert bugsnag_server.sent_report_count == 1
+
     payload = bugsnag_server.received[0]['json_body']
     event = payload['events'][0]
     assert event['metaData']['environment']['REQUEST_METHOD'] == 'GET'
@@ -110,6 +116,9 @@ def test_enable_environment(bugsnag_server, django_client):
 def test_notify_custom_info(bugsnag_server, django_client):
     django_client.get('/notes/handled-exception-custom/')
     bugsnag_server.wait_for_request()
+
+    assert bugsnag_server.sent_report_count == 1
+
     payload = bugsnag_server.received[0]['json_body']
     event = payload['events'][0]
 
@@ -126,6 +135,9 @@ def test_notify_post_body(bugsnag_server, django_client):
     assert response.status_code == 200
 
     bugsnag_server.wait_for_request()
+
+    assert bugsnag_server.sent_report_count == 1
+
     payload = bugsnag_server.received[0]['json_body']
     event = payload['events'][0]
     exception = event['exceptions'][0]
@@ -168,6 +180,9 @@ def test_unhandled_exception(bugsnag_server, django_client):
         django_client.get('/notes/unhandled-crash/')
 
     bugsnag_server.wait_for_request()
+
+    assert bugsnag_server.sent_report_count == 1
+
     payload = bugsnag_server.received[0]['json_body']
     event = payload['events'][0]
     exception = event['exceptions'][0]
@@ -213,6 +228,9 @@ def test_unhandled_exception_chain(bugsnag_server, django_client):
         django_client.get('/notes/unhandled-crash-chain/')
 
     bugsnag_server.wait_for_request()
+
+    assert bugsnag_server.sent_report_count == 1
+
     payload = bugsnag_server.received[0]['json_body']
     event = payload['events'][0]
     exception = event['exceptions'][0]
@@ -258,6 +276,9 @@ def test_unhandled_exception_in_template(bugsnag_server, django_client):
         django_client.get('/notes/unhandled-template-crash/')
 
     bugsnag_server.wait_for_request()
+
+    assert bugsnag_server.sent_report_count == 1
+
     payload = bugsnag_server.received[0]['json_body']
     event = payload['events'][0]
     exception = event['exceptions'][0]
@@ -289,14 +310,17 @@ def test_ignores_http404(bugsnag_server, django_client):
     with pytest.raises(MissingRequestError):
         bugsnag_server.wait_for_request()
 
-    assert len(bugsnag_server.received) == 0
+    assert bugsnag_server.sent_report_count == 0
 
 
 def test_report_error_from_http404handler(bugsnag_server, django_client):
     with pytest.raises(Exception):
         django_client.get('/notes/poorly-handled-404')
 
     bugsnag_server.wait_for_request()
+
+    assert bugsnag_server.sent_report_count == 1
+
     payload = bugsnag_server.received[0]['json_body']
     event = payload['events'][0]
     exception = event['exceptions'][0]
@@ -342,6 +366,9 @@ def test_notify_appends_user_data(bugsnag_server, django_client):
     assert response.status_code == 200
 
     bugsnag_server.wait_for_request()
+
+    assert bugsnag_server.sent_report_count == 1
+
     payload = bugsnag_server.received[0]['json_body']
     event = payload['events'][0]
     exception = event['exceptions'][0]
@@ -386,6 +413,9 @@ def test_crash_appends_user_data(bugsnag_server, django_client):
         django_client.get('/notes/unhandled-crash/')
 
     bugsnag_server.wait_for_request()
+
+    assert bugsnag_server.sent_report_count == 1
+
     payload = bugsnag_server.received[0]['json_body']
     event = payload['events'][0]
     exception = event['exceptions'][0]
@@ -431,6 +461,9 @@ def test_read_request_in_callback(bugsnag_server, django_client):
         django_client.get('/notes/crash-with-callback/?user_id=foo')
 
     bugsnag_server.wait_for_request()
+
+    assert bugsnag_server.sent_report_count == 1
+
     payload = bugsnag_server.received[0]['json_body']
     event = payload['events'][0]
     assert event['context'] == 'foo'
@@ -448,6 +481,9 @@ def test_bugsnag_middleware_leaves_breadcrumb_with_referer(
     assert response.status_code == 200
 
     bugsnag_server.wait_for_request()
+
+    assert bugsnag_server.sent_report_count == 1
+
     payload = bugsnag_server.received[0]['json_body']
     event = payload['events'][0]
     exception = event['exceptions'][0]

tests/test_client.py

@@ -1456,6 +1456,43 @@ def test_ignore_classes_has_no_exception_chain_with_no_cause(self):
 
         assert self.sent_report_count == 1
 
+    def test_skip_bugsnag_attr_prevents_notify_when_true(self):
+        exception = Exception('Testing Notify')
+        self.client.notify(exception)
+
+        assert self.sent_report_count == 1
+
+        exception.skip_bugsnag = True
+        self.client.notify(exception)
+
+        assert self.sent_report_count == 1
+
+    def test_setting_skip_bugsnag_attr_to_false_allows_notify(self):
+        exception = Exception('Testing Notify')
+        exception.skip_bugsnag = True
+
+        self.client.notify(exception)
+
+        assert self.sent_report_count == 0
+
+        exception.skip_bugsnag = False
+        self.client.notify(exception)
+
+        assert self.sent_report_count == 1
+
+    def test_deleting_skip_bugsnag_attr_allows_notify(self):
+        exception = Exception('Testing Notify')
+        exception.skip_bugsnag = True
+
+        self.client.notify(exception)
+
+        assert self.sent_report_count == 0
+
+        delattr(exception, 'skip_bugsnag')
+        self.client.notify(exception)
+
+        assert self.sent_report_count == 1
+
 
 @pytest.mark.parametrize("metadata,type", [
     (1234, 'int'),

tests/test_configuration.py

@@ -11,7 +11,7 @@
 from bugsnag.breadcrumbs import BreadcrumbType
 from bugsnag.configuration import Configuration
 from bugsnag.error import Error
-from bugsnag.middleware import DefaultMiddleware
+from bugsnag.middleware import DefaultMiddleware, SimpleMiddleware
 from bugsnag.sessiontracker import SessionMiddleware
 
 import pytest
@@ -85,9 +85,13 @@ def test_session_tracking_defaults(self):
 
     def test_default_middleware_location(self):
         c = Configuration()
-        self.assertEqual(c.internal_middleware.stack,
-                         [DefaultMiddleware, SessionMiddleware])
-        self.assertEqual(len(c.middleware.stack), 0)
+
+        assert len(c.internal_middleware.stack) == 3
+        assert isinstance(c.internal_middleware.stack[0], SimpleMiddleware)
+        assert c.internal_middleware.stack[1] is DefaultMiddleware
+        assert c.internal_middleware.stack[2] is SessionMiddleware
+
+        assert len(c.middleware.stack) == 0
 
     def test_validate_api_key(self):
         c = Configuration()

tests/test_middleware.py

@@ -1,7 +1,7 @@
 import unittest
 
 import bugsnag
-from bugsnag.middleware import MiddlewareStack
+from bugsnag.middleware import MiddlewareStack, skip_bugsnag_middleware
 from bugsnag.configuration import RequestConfiguration
 
 
@@ -41,9 +41,9 @@ def __call__(self, item):
         return
 
 
-def create_event() -> bugsnag.Event:
+def create_event(exception=None) -> bugsnag.Event:
     return bugsnag.Event(
-        RuntimeError('oh no!'),
+        exception or RuntimeError('oh no!'),
         bugsnag.configure(),
         RequestConfiguration.get_instance()
     )
@@ -153,3 +153,17 @@ def test_callback_not_run_if_middleware_returns(self):
         m.run(a, lambda: a.append('Callback'))
 
         self.assertEqual(a, ['A'])
+
+    def test_skip_bugsnag_middleware_returns_false_when_attr_is_present(self):
+        exception = Exception('oh no')
+        exception.skip_bugsnag = True
+
+        event = create_event(exception)
+
+        assert skip_bugsnag_middleware(event) is False
+
+    def test_skip_bugsnag_middleware_returns_none_when_attr_is_missing(self):
+        exception = Exception('oh no')
+        event = create_event(exception)
+
+        assert skip_bugsnag_middleware(event) is None