merged branch davedevelopment/better-exception-logging (PR #523)

This PR was merged into the master branch.

Commits
-------

5c5dae19 Flipped condition
9f4a122f Log a little more information about exceptions

Discussion
----------

Log a little more information about exceptions

This takes a little from Symfony's ExceptionListener, logging a little more appropriate information. Without this code, 404's etc are logged with a blank message.

---------------------------------------------------------------------------

by MarcinKleczek at 2012-10-29T11:53:41Z

+1

src/Silex/Provider/MonologServiceProvider.php

@@ -18,6 +18,7 @@ use Silex\ServiceProviderInterface;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpFoundation\Response;
 use Symfony\Bridge\Monolog\Handler\DebugHandler;
+use Symfony\Component\HttpKernel\Exception\HttpExceptionInterface;
 
 /**
  * Monolog Provider.
@@ -75,7 +76,12 @@ class MonologServiceProvider implements ServiceProviderInterface
         });
 
         $app->error(function (\Exception $e) use ($app) {
-            $app['monolog']->addError($e->getMessage());
+            $message = sprintf('%s: %s (uncaught exception) at %s line %s', get_class($e), $e->getMessage(), $e->getFile(), $e->getLine());
+            if ($e instanceof HttpExceptionInterface && $e->getStatusCode() < 500) {
+                $app['monolog']->addError($message);
+            } else {
+                $app['monolog']->addCritical($message);
+            }
         }, 255);
 
         $app->after(function (Request $request, Response $response) use ($app) {

tests/Silex/Tests/Provider/MonologServiceProviderTest.php

@@ -12,6 +12,7 @@
 namespace Silex\Tests\Provider;
 
 use Monolog\Handler\TestHandler;
+use Monolog\Logger;
 use Silex\Application;
 use Silex\Provider\MonologServiceProvider;
 use Symfony\Component\HttpFoundation\Request;
@@ -68,20 +69,49 @@ class MonologServiceProviderTest extends \PHPUnit_Framework_TestCase
     {
         $app = $this->getApplication();
 
-        $app->get('/error', function () {
-            throw new \RuntimeException('very bad error');
-        });
-
         $app->error(function (\Exception $e) {
             return 'error handled';
         });
 
+        /**
+         * Simulate 404, logged to error level
+         */
         $this->assertFalse($app['monolog.handler']->hasErrorRecords());
 
         $request = Request::create('/error');
         $app->handle($request);
 
-        $this->assertTrue($app['monolog.handler']->hasError('very bad error'));
+        $records = $app['monolog.handler']->getRecords();
+        $pattern = "#Symfony\\\\Component\\\\HttpKernel\\\\Exception\\\\NotFoundHttpException: No route found for \"GET /error\" \(uncaught exception\) at .* line \d+#";
+        $this->assertMatchingRecord($pattern, Logger::ERROR, $app['monolog.handler']);
+
+        /**
+         * Simulate unhandled exception, logged to critical
+         */
+        $app->get('/error', function () {
+            throw new \RuntimeException('very bad error');
+        });
+
+        $this->assertFalse($app['monolog.handler']->hasCriticalRecords());
+
+        $request = Request::create('/error');
+        $app->handle($request);
+
+        $pattern = "#RuntimeException: very bad error \(uncaught exception\) at .*Silex/Tests/Provider/MonologServiceProviderTest\.php line \d+#";
+        $this->assertMatchingRecord($pattern, Logger::CRITICAL, $app['monolog.handler']);
+    }
+
+    protected function assertMatchingRecord($pattern, $level, $handler)
+    {
+        $found = false;
+        $records = $handler->getRecords();
+        foreach ($records as $record) {
+            if (preg_match($pattern, $record['message']) && $record['level'] == $level) {
+                $found = true;
+                continue;
+            }
+        }
+        $this->assertTrue($found, "Trying to find record matching $pattern with level $level");
     }
 
     protected function getApplication()
@@ -97,3 +127,4 @@ class MonologServiceProviderTest extends \PHPUnit_Framework_TestCase
         return $app;
     }
 }
+