feat: ignore breadcrumbs with empty message (#215)

subzero10 · web-flow · commit 645a672f26ce · 2024-11-16T17:40:18.000+02:00
diff --git a/src/Honeybadger.php b/src/Honeybadger.php
@@ -201,7 +201,7 @@ public function resetContext(): void
 
     public function addBreadcrumb(string $message, array $metadata = [], string $category = 'custom'): Reporter
     {
-        if ($this->config['breadcrumbs']['enabled']) {
+        if ($this->config['breadcrumbs']['enabled'] && !empty($message)) {
             $this->breadcrumbs->add([
                 'message' => $message,
                 'metadata' => $metadata,
diff --git a/tests/HoneybadgerTest.php b/tests/HoneybadgerTest.php
@@ -869,6 +869,45 @@ public function can_add_custom_breadcrumbs_if_enabled()
         ], $notification['breadcrumbs']['trail'][1]['metadata']);
     }
 
+    /** @test */
+    public function does_not_add_breadcrumbs_with_empty_message()
+    {
+        $client = HoneybadgerClient::new([
+            new Response(201),
+        ]);
+
+        $badger = Honeybadger::new([
+            'api_key' => 'asdf',
+            'handlers' => [
+                'exception' => false,
+                'error' => false,
+            ],
+        ], $client->make());
+
+        sleep(1);
+        $badger
+            ->addBreadcrumb('', ['this will not be' => 'sent'], 'render')
+            ->setComponent('HomeController')
+            ->setAction('index')
+            ->notify(new Exception('Test exception'));
+
+        $notification = $client->requestBody();
+
+        $this->assertTrue($notification['breadcrumbs']['enabled']);
+
+        // only the notice breadcrumb should be sent
+        $this->assertCount(1, $notification['breadcrumbs']['trail']);
+
+        $noticeBreadcrumb = $notification['breadcrumbs']['trail'][0];
+        $this->assertEquals('Honeybadger Notice', $noticeBreadcrumb['message']);
+        $this->assertEquals('notice', $noticeBreadcrumb['category']);
+        $this->assertInstanceOf(\DateTime::class, date_create($noticeBreadcrumb['timestamp']));
+        $this->assertEquals([
+            'message' => 'Test exception',
+            'name' => Exception::class,
+        ], $noticeBreadcrumb['metadata']);
+    }
+
     /** @test */
     public function wont_send_breadcrumbs_if_disabled()
     {

Original file line number	Diff line number	Diff line change
`@@ -201,7 +201,7 @@ public function resetContext(): void`
`201`	`201`
`202`	`202`	`public function addBreadcrumb(string $message, array $metadata = [], string $category = 'custom'): Reporter`
`203`	`203`	`{`
`204`		`- if ($this->config['breadcrumbs']['enabled']) {`
	`204`	`+ if ($this->config['breadcrumbs']['enabled'] && !empty($message)) {`
`205`	`205`	`$this->breadcrumbs->add([`
`206`	`206`	`'message' => $message,`
`207`	`207`	`'metadata' => $metadata,`