Merge pull request #109 from rollbar/bug/CH-81893/cannot-use-rollbar-agent

Add support for rollbar-agent

Author: Bishop Bettini

.gitignore

@@ -1,3 +1,4 @@
 /vendor
 composer.lock
 .DS_Store
+.phpunit.result.cache

src/AgentHandler.php

@@ -0,0 +1,24 @@
+<?php
+
+namespace Rollbar\Laravel;
+
+/**
+ * Adaptor for [rollbar-agent][1] in Laravel logging configuration.
+ *
+ * The configuration for logging in Laravel requires an instance of
+ * [`Monolog\Handler\HandlerInterface`][2], but the Rollbar library requires
+ * a string with value of "agent" to use the agent.
+ *
+ * This class carries the HandlerInterface requirement to satisfy the Laravel
+ * logging configuration and is recognized in the ServiceProvider, which
+ * converts it to the appropriate agent configuration just in time.
+ *
+ * This issue was raised by [Issue 85][3].
+ *
+ * [1]:https://github.com/rollbar/rollbar-agent
+ * [2]:https://github.com/Seldaek/monolog/blob/main/src/Monolog/Handler/HandlerInterface.php
+ * [3]:https://github.com/rollbar/rollbar-php-laravel/issues/85
+ */
+class AgentHandler extends MonologHandler
+{
+}

src/RollbarServiceProvider.php

@@ -42,6 +42,13 @@ public function register()
             $handleError = (bool) Arr::pull($config, 'handle_error');
             $handleFatal = (bool) Arr::pull($config, 'handle_fatal');
 
+            // Convert a request for the Rollbar agent to handle the logs to
+            // the format expected by `Rollbar::init`.
+            // @see https://github.com/rollbar/rollbar-php-laravel/issues/85
+            $handler = Arr::get($config, 'handler');
+            if ($handler === AgentHandler::class) {
+                $config['handler'] = 'agent';
+            }
             Rollbar::init($config, $handleException, $handleError, $handleFatal);
 
             return Rollbar::logger();

tests/RollbarTest.php

@@ -4,6 +4,7 @@
 
 use Rollbar\Laravel\RollbarServiceProvider;
 use Rollbar\Laravel\MonologHandler;
+use Rollbar\Laravel\AgentHandler;
 use Rollbar\RollbarLogger;
 use Monolog\Logger;
 use Mockery;
@@ -32,6 +33,9 @@ public function testBinding()
 
         $handler = $this->app->make(MonologHandler::class);
         $this->assertInstanceOf(MonologHandler::class, $handler);
+
+        $handler = $this->app->make(AgentHandler::class);
+        $this->assertInstanceOf(AgentHandler::class, $handler);
     }
 
     public function testIsSingleton()
@@ -62,6 +66,20 @@ public function testCustomConfiguration()
         $this->assertEquals(E_ERROR, $config['included_errno']);
     }
 
+    public function testRollbarAgentConfigurationAdapter()
+    {
+        $this->app->config->set('logging.channels.rollbar.handler', AgentHandler::class);
+
+        $client = $this->app->make(RollbarLogger::class);
+        $config = $client->extend([]);
+
+        $this->assertEquals(
+            'agent',
+            $config['handler'],
+            'AgentHandler given as Laravel logging config handler should be given as "agent" to Rollbar::init'
+        );
+    }
+
     // public function testAutomaticContext()
     // {
     //     $this->app->session->put('foo', 'bar');