feat: events api integration (#125)

* feat: events api integration

Refs: #124

* chore: add test

* chore: support deprecated breadcrumb classes

* chore: move deprecation check in service provider

* chore: test for deprecated in all the places

* fix: do not replace double quoters

Co-authored-by: Benjamin Curtis <[email protected]>

---------

Co-authored-by: Benjamin Curtis <[email protected]>

Author: subzero10

CHANGELOG.md

@@ -6,6 +6,15 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## [Unreleased]
 
+## [4.1.0] - 2024-06-29
+### Added
+- Events: Honeybadger.event() method to send events to Honeybadger Insights
+- Events: Custom logger channel to send logs as events to Honeybadger Insights
+- Events: Automatic logging of application events to Honeybadger Insights
+
+### Refactored
+- Breadcrumbs: Modified automatic breadcrumbs collection to reusable classes to share with Events integration 
+
 ## [4.0.0] - 2024-03-22
 ### Added
 - Support for Laravel 11

composer.json

@@ -22,7 +22,7 @@
     ],
     "require": {
         "php": "^8.1",
-        "honeybadger-io/honeybadger-php": "^2.18.0",
+        "honeybadger-io/honeybadger-php": ">=2.19.1",
         "sixlive/dotenv-editor": "^1.1|^2.0",
         "illuminate/console": "^10.0|^11.0",
         "illuminate/support": "^10.0|^11.0",

config/honeybadger.php

@@ -1,6 +1,7 @@
 <?php
 
-use Honeybadger\HoneybadgerLaravel\Breadcrumbs;
+use Honeybadger\BulkEventDispatcher;
+use Honeybadger\HoneybadgerLaravel\HoneybadgerLaravel;
 
 return [
     /**
@@ -77,10 +78,12 @@
     /**
      * Older PHP functions use the Error class, while modern PHP mostly uses Exception.
      * Specify if you'd like Honeybadger to report both types of errors.
+     * The shutdown handler is required flushing any remaining events that were queued using Honeybadger.event().
      */
     'handlers' => [
         'exception' => true,
         'error' => true,
+        'shutdown' => true,
     ],
 
     /**
@@ -111,27 +114,10 @@
         'enabled' => true,
 
         /**
-         * Events which should automatically be recorded by the Honeybadger client.
+         * Events which should automatically be recorded by the Honeybadger client as breadcrumbs.
          * Note that to track redis events, you need to call `Redis::enableEvents()` in your app.
          */
-        'automatic' => [
-            Breadcrumbs\DatabaseQueryExecuted::class,
-            Breadcrumbs\DatabaseTransactionStarted::class,
-            Breadcrumbs\DatabaseTransactionCommitted::class,
-            Breadcrumbs\DatabaseTransactionRolledBack::class,
-            Breadcrumbs\CacheHit::class,
-            Breadcrumbs\CacheMiss::class,
-            Breadcrumbs\JobQueued::class,
-            Breadcrumbs\MailSending::class,
-            Breadcrumbs\MailSent::class,
-            Breadcrumbs\MessageLogged::class,
-            Breadcrumbs\NotificationSending::class,
-            Breadcrumbs\NotificationSent::class,
-            Breadcrumbs\NotificationFailed::class,
-            Breadcrumbs\RedisCommandExecuted::class,
-            Breadcrumbs\RouteMatched::class,
-            Breadcrumbs\ViewRendered::class,
-        ],
+        'automatic' => HoneybadgerLaravel::DEFAULT_EVENTS,
     ],
 
     /**
@@ -141,4 +127,28 @@
      * Learn more about checkins at https://docs.honeybadger.io/api/reporting-check-ins/.
      */
     'checkins' => [],
+
+    'events' => [
+        /**
+         * Enable sending application events to Honeybadger Insights.
+         * Setting this to false will disable automatic events collection and the event() function.
+         */
+        'enabled' => false,
+
+        /**
+         * The number of events to queue before sending them to Honeybadger.
+         */
+        'bulk_threshold' => BulkEventDispatcher::BULK_THRESHOLD,
+
+        /**
+         * The number of seconds to wait before sending queued events to Honeybadger.
+         */
+        'dispatch_interval_seconds' => BulkEventDispatcher::DISPATCH_INTERVAL_SECONDS,
+
+        /**
+         * Events which should automatically be sent to Honeybadger Insights.
+         * Note that to track redis events, you need to call `Redis::enableEvents()` in your app.
+         */
+        'automatic' => HoneybadgerLaravel::DEFAULT_EVENTS,
+    ],
 ];

src/Breadcrumbs/Breadcrumb.php

@@ -2,15 +2,9 @@
 
 namespace Honeybadger\HoneybadgerLaravel\Breadcrumbs;
 
-use Honeybadger\HoneybadgerLaravel\Facades\Honeybadger;
-use Illuminate\Cache\Events\CacheHit as LaravelCacheHit;
-
-class CacheHit extends Breadcrumb
+/**
+ * @deprecated Use {@link \Honeybadger\HoneybadgerLaravel\Events\CacheHit} instead
+ */
+class CacheHit extends \Honeybadger\HoneybadgerLaravel\Events\CacheHit
 {
-    public $handles = LaravelCacheHit::class;
-
-    public function handleEvent(LaravelCacheHit $event)
-    {
-        Honeybadger::addBreadcrumb('Cache hit', ['key' => $event->key], 'query');
-    }
 }

src/Breadcrumbs/CacheHit.php

@@ -2,15 +2,9 @@
 
 namespace Honeybadger\HoneybadgerLaravel\Breadcrumbs;
 
-use Honeybadger\HoneybadgerLaravel\Facades\Honeybadger;
-use Illuminate\Cache\Events\CacheMissed;
-
-class CacheMiss extends Breadcrumb
+/**
+ * @deprecated Use {@link \Honeybadger\HoneybadgerLaravel\Events\CacheMiss} instead
+ */
+class CacheMiss extends \Honeybadger\HoneybadgerLaravel\Events\CacheMiss
 {
-    public $handles = CacheMissed::class;
-
-    public function handleEvent(CacheMissed $event)
-    {
-        Honeybadger::addBreadcrumb('Cache miss', ['key' => $event->key], 'query');
-    }
 }

src/Breadcrumbs/CacheMiss.php

@@ -2,44 +2,9 @@
 
 namespace Honeybadger\HoneybadgerLaravel\Breadcrumbs;
 
-use Honeybadger\HoneybadgerLaravel\Facades\Honeybadger;
-use Illuminate\Database\Connection;
-use Illuminate\Database\Events\QueryExecuted;
-
-class DatabaseQueryExecuted extends Breadcrumb
+/**
+* @deprecated Use {@link \Honeybadger\HoneybadgerLaravel\Events\DatabaseQueryExecuted} instead
+*/
+class DatabaseQueryExecuted extends \Honeybadger\HoneybadgerLaravel\Events\DatabaseQueryExecuted
 {
-    public $handles = QueryExecuted::class;
-
-    public function handleEvent(QueryExecuted $event)
-    {
-        $metadata = [
-            'connectionName' => $event->connectionName,
-            'sql' => $this->sanitize($event->sql, $event->connection),
-            'duration' => number_format($event->time, 2, '.', '').'ms',
-        ];
-
-        Honeybadger::addBreadcrumb('Database query executed', $metadata, 'query');
-    }
-
-    /**
-     * Even though Laravel gives us the sanitized query, let's err on the side of caution by removing any quoted data.
-     */
-    public function sanitize(string $sql, Connection $connection): string
-    {
-        $escapedQuotes = '#/(\\"|\\\')/#';
-        $numericData = '#\b\d+\b#';
-        $singleQuotedData = "#'(?:[^']|'')*'#";
-        $newlines = '#\n#';
-        $doubleQuotedData = '#"(?:[^"]|"")*"#';
-
-        $sql = preg_replace($escapedQuotes, '', $sql);
-        $sql = preg_replace([$numericData, $singleQuotedData, $newlines], '?', $sql);
-
-        $doubleQuoters = ['pgsql', 'sqlite', 'postgis'];
-        if (in_array($connection->getConfig('driver'), $doubleQuoters)) {
-            $sql = preg_replace($doubleQuotedData, '?', $sql);
-        }
-
-        return $sql;
-    }
 }

src/Breadcrumbs/DatabaseQueryExecuted.php

@@ -2,17 +2,9 @@
 
 namespace Honeybadger\HoneybadgerLaravel\Breadcrumbs;
 
-use Honeybadger\HoneybadgerLaravel\Facades\Honeybadger;
-use Illuminate\Database\Events\TransactionCommitted;
-
-class DatabaseTransactionCommitted extends Breadcrumb
+/**
+ * @deprecated Use {@link \Honeybadger\HoneybadgerLaravel\Events\DatabaseTransactionCommitted} instead
+ */
+class DatabaseTransactionCommitted extends \Honeybadger\HoneybadgerLaravel\Events\DatabaseTransactionCommitted
 {
-    public $handles = TransactionCommitted::class;
-
-    public function handleEvent(TransactionCommitted $event)
-    {
-        Honeybadger::addBreadcrumb('Database transaction committed', [
-            'connectionName' => $event->connectionName,
-        ], 'query');
-    }
 }

src/Breadcrumbs/DatabaseTransactionCommitted.php

@@ -2,17 +2,9 @@
 
 namespace Honeybadger\HoneybadgerLaravel\Breadcrumbs;
 
-use Honeybadger\HoneybadgerLaravel\Facades\Honeybadger;
-use Illuminate\Database\Events\TransactionRolledBack;
-
-class DatabaseTransactionRolledBack extends Breadcrumb
+/**
+ * @deprecated Use {@link \Honeybadger\HoneybadgerLaravel\Events\DatabaseTransactionRolledBack} instead
+ */
+class DatabaseTransactionRolledBack extends \Honeybadger\HoneybadgerLaravel\Events\DatabaseTransactionRolledBack
 {
-    public $handles = TransactionRolledBack::class;
-
-    public function handleEvent(TransactionRolledBack $event)
-    {
-        Honeybadger::addBreadcrumb('Database transaction rolled back', [
-            'connectionName' => $event->connectionName,
-        ], 'query');
-    }
 }

src/Breadcrumbs/DatabaseTransactionRolledBack.php

@@ -2,17 +2,9 @@
 
 namespace Honeybadger\HoneybadgerLaravel\Breadcrumbs;
 
-use Honeybadger\HoneybadgerLaravel\Facades\Honeybadger;
-use Illuminate\Database\Events\TransactionBeginning;
-
-class DatabaseTransactionStarted extends Breadcrumb
+/**
+ * @deprecated Use {@link \Honeybadger\HoneybadgerLaravel\Events\DatabaseTransactionStarted} instead
+ */
+class DatabaseTransactionStarted extends \Honeybadger\HoneybadgerLaravel\Events\DatabaseTransactionStarted
 {
-    public $handles = TransactionBeginning::class;
-
-    public function handleEvent(TransactionBeginning $event)
-    {
-        Honeybadger::addBreadcrumb('Database transaction started', [
-            'connectionName' => $event->connectionName,
-        ], 'query');
-    }
 }