Merge pull request #17 from sixlive/custom-log-handler

Custom log handler and driver

Author: shalvah

.styleci.yml

@@ -3,3 +3,4 @@ preset: laravel
 disabled:
   - laravel_braces
   - single_class_element_per_statement
+  - alpha_ordered_imports

CHANGELOG.md

@@ -5,9 +5,10 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
+### Added
+- Added custom log driver ([#17](https://github.com/honeybadger-io/honeybadger-laravel/pull/17))
 
 ## [3.11.0] - 2021-06-16
-### Added
 - Set default client timeout ([#87](https://github.com/honeybadger-io/honeybadger-laravel/pull/87))
 
 ## [3.10.0] - 2021-05-09

composer.json

@@ -26,6 +26,7 @@
         "sixlive/dotenv-editor": "^1.1",
         "illuminate/console": "^7.0|^8.0",
         "illuminate/support": "^7.0|^8.0",
+        "monolog/monolog": "^2.0",
         "ext-json": "*"
     },
     "require-dev": {

src/HoneybadgerLogDriver.php

@@ -0,0 +1,17 @@
+<?php
+
+namespace Honeybadger\HoneybadgerLaravel;
+
+use Honeybadger\LogHandler;
+use Illuminate\Support\Facades\App;
+use Monolog\Logger;
+
+class HoneybadgerLogDriver
+{
+    public function __invoke(array $config): Logger
+    {
+        return tap(new Logger($config['name'] ?? 'honeybadger'), function ($logger) {
+            $logger->pushHandler(App::make(LogHandler::class));
+        });
+    }
+}

src/HoneybadgerServiceProvider.php

@@ -3,9 +3,10 @@
 namespace Honeybadger\HoneybadgerLaravel;
 
 use GuzzleHttp\Client;
+use Honeybadger\LogHandler;
+use Honeybadger\Honeybadger;
 use Honeybadger\Contracts\Reporter;
 use Honeybadger\Exceptions\ServiceException;
-use Honeybadger\Honeybadger;
 use Honeybadger\HoneybadgerLaravel\Commands\HoneybadgerCheckinCommand;
 use Honeybadger\HoneybadgerLaravel\Commands\HoneybadgerDeployCommand;
 use Honeybadger\HoneybadgerLaravel\Commands\HoneybadgerInstallCommand;
@@ -44,23 +45,10 @@ public function register()
     {
         $this->mergeConfigFrom(__DIR__.'/../config/honeybadger.php', 'honeybadger');
 
-        $this->app->singleton(Reporter::class, function ($app) {
-            return HoneybadgerLaravel::make($app['config']['honeybadger']);
-        });
-
-        $this->app->alias(Reporter::class, Honeybadger::class);
-        $this->app->alias(Reporter::class, 'honeybadger');
-
-        // In some cases (like the test command), we definitely want to throw any errors
-        // Laravel's contextual binding doesn't support method injection,
-        // so the handle() method will have to request this client specifically.
-        $this->app->singleton('honeybadger.loud', function ($app) {
-            $config = $app['config']['honeybadger'];
-            $config['service_exception_handler'] = function (ServiceException $e) {
-                throw $e;
-            };
+        $this->registerReporters();
 
-            return HoneybadgerLaravel::make($config);
+        $this->app->bind(LogHandler::class, function ($app) {
+            return new LogHandler($app[Reporter::class]);
         });
 
         $this->app->singleton('honeybadger.isLumen', function () {
@@ -185,4 +173,26 @@ protected function setUpAutomaticBreadcrumbs()
             (new $breadcrumb)->register();
         }
     }
+
+    protected function registerReporters(): void
+    {
+        $this->app->singleton(Reporter::class, function ($app) {
+            return HoneybadgerLaravel::make($app['config']['honeybadger']);
+        });
+
+        $this->app->alias(Reporter::class, Honeybadger::class);
+        $this->app->alias(Reporter::class, 'honeybadger');
+
+        // In some cases (like the test command), we definitely want to throw any errors
+        // Laravel's contextual binding doesn't support method injection,
+        // so the handle() method will have to request this client specifically.
+        $this->app->singleton('honeybadger.loud', function ($app) {
+            $config = $app['config']['honeybadger'];
+            $config['service_exception_handler'] = function (ServiceException $e) {
+                throw $e;
+            };
+
+            return HoneybadgerLaravel::make($config);
+        });
+    }
 }

tests/HoneybadgerServiceProviderTest.php

@@ -2,8 +2,9 @@
 
 namespace Honeybadger\Tests;
 
-use Honeybadger\Contracts\Reporter;
+use Honeybadger\LogHandler;
 use Honeybadger\Honeybadger;
+use Honeybadger\Contracts\Reporter;
 use Honeybadger\HoneybadgerLaravel\Facades\Honeybadger as HoneybadgerFacade;
 
 class HoneybadgerServiceProviderTest extends TestCase
@@ -21,4 +22,10 @@ public function aliases_are_set()
         $this->assertInstanceOf(Honeybadger::class, $this->app[Honeybadger::class]);
         $this->assertInstanceOf(Honeybadger::class, $this->app['honeybadger']);
     }
+
+    /** @test */
+    public function it_registers_the_log_handler()
+    {
+        $this->assertInstanceOf(LogHandler::class, $this->app[LogHandler::class]);
+    }
 }

tests/LogDriverTest.php

@@ -0,0 +1,37 @@
+<?php
+
+namespace Honeybadger\Tests;
+
+use Illuminate\Support\Facades\Log;
+use Honeybadger\HoneybadgerLaravel\HoneybadgerLogDriver;
+use Honeybadger\LogHandler;
+
+class LogDriverTest extends TestCase
+{
+    /** @test */
+    public function the_log_driver_can_be_correctly_registered_and_used()
+    {
+        $this->app['config']->set('logging.channels.honeybadger', [
+            'driver'  => 'custom',
+            'via' => HoneybadgerLogDriver::class,
+            'name' => 'asdf', // optional point of customization
+        ]);
+
+        $logHandler = $this->getMockBuilder(LogHandler::class)
+            ->disableOriginalConstructor()
+            ->setMethods(['write'])
+            ->getMock();
+
+        $logHandler->expects($this->once())
+                   ->method('write')
+                   ->with($this->callback(function ($record) {
+                       return $record['message'] === 'Test message'
+                           && $record['level_name'] === 'INFO'
+                           && $record['channel'] === 'asdf';
+                   }));
+
+        $this->app[LogHandler::class] = $logHandler;
+
+        Log::channel('honeybadger')->info('Test message');
+    }
+}