fix: return notice id from notify (#232)

Fixes #231

Author: stympy

honeybadger/connection.py

@@ -9,7 +9,6 @@
 from .utils import StringReprJSONEncoder
 from .types import EventsSendResult, EventsSendStatus
 
-
 logger = logging.getLogger(__name__)
 
 

honeybadger/core.py

@@ -46,13 +46,13 @@ def _send_notice(self, notice):
 
         if not isinstance(notice, Notice):
             logger.debug("Notice was filtered out by before_notify callback")
-            return
+            return None
 
         if notice.excluded_exception():
             logger.debug("Notice was excluded by exception filter")
-            return
+            return None
 
-        self._connection().send_notice(self.config, notice)
+        return self._connection().send_notice(self.config, notice)
 
     def begin_request(self, _):
         error_context.clear()

honeybadger/tests/test_core.py

@@ -591,3 +591,56 @@ def test_payload(request):
         hb.configure(api_key="aaa", force_report_data=True)
         # This should fail according to breaking change, but currently creates malformed payload
         hb.notify(error_message="Some error message", context={"foo": "bar"})
+
+
+def test_notify_returns_notice_id():
+    """Test that notify() returns a notice_id (UUID) when sending succeeds"""
+    hb = Honeybadger()
+    hb.configure(api_key="aaa", environment="production")
+
+    with patch(
+        "honeybadger.connection.send_notice",
+        return_value="test-notice-uuid-123",
+    ) as mock_send:
+        result = hb.notify(
+            error_class="Exception",
+            error_message="Test message.",
+        )
+
+        assert mock_send.call_count == 1
+        assert result == "test-notice-uuid-123"
+
+
+def test_notify_returns_none_when_filtered_by_before_notify():
+    """Test that notify() returns None when before_notify filters out the notice"""
+
+    def before_notify(notice):
+        return None  # Filter out the notice
+
+    hb = Honeybadger()
+    hb.configure(api_key="aaa", environment="production", before_notify=before_notify)
+
+    with patch("honeybadger.connection.send_notice") as mock_send:
+        result = hb.notify(
+            error_class="Exception",
+            error_message="Test message.",
+        )
+
+        assert mock_send.call_count == 0
+        assert result is None
+
+
+def test_notify_returns_none_when_exception_excluded():
+    """Test that notify() returns None when the exception is excluded"""
+    hb = Honeybadger()
+    hb.configure(
+        api_key="aaa",
+        environment="production",
+        excluded_exceptions=["ValueError"],
+    )
+
+    with patch("honeybadger.connection.send_notice") as mock_send:
+        result = hb.notify(ValueError("excluded error"))
+
+        assert mock_send.call_count == 0
+        assert result is None

honeybadger/tests/utils.py

@@ -23,7 +23,7 @@ def mock_was_called(*args, **kwargs):
     ) as request_mock:
         yield request_mock
         mock_called_event.wait(0.5)
-        ((request_object,), mock_kwargs) = request_mock.call_args
+        (request_object,), mock_kwargs = request_mock.call_args
         func(request_object)