Merge pull request #13 from aivis/master

format message field

Author: aivis

src/Understand/UnderstandLaravel5/Logger.php

@@ -79,7 +79,15 @@ public function bulkLog(array $events, array $additional = [])
     protected function prepare($log, array $additional = [])
     {
         // integer, float, string or boolean as message
-        $log = is_scalar($log) ? ['message' => $log] : $log;
+        if (is_scalar($log))
+        {
+            $log = ['message' => $log];
+        }
+        
+        if (isset($log['message']))
+        {
+            $log['message'] = $this->formatMessage($log['message']);
+        }
 
         // resolve additonal properties from field providers
         $data = $this->fieldProvider->resolveValues($additional);
@@ -93,6 +101,28 @@ protected function prepare($log, array $additional = [])
 
         return $event;
     }
+    
+    /**
+     * Format message field
+     * 
+     * @param string $message
+     * @return string
+     */
+    protected function formatMessage($message)
+    {
+        if ( ! is_bool($message))
+        {
+            return (string)$message;
+        }
+        
+        // cast boolean values to "1" or "0" strings
+        if ($message)
+        {
+            return '1';
+        }
+        
+        return '0';
+    }
 
     /**
      * Set handler

src/Understand/UnderstandLaravel5/UnderstandLaravel5ServiceProvider.php

@@ -251,6 +251,8 @@ protected function listenLaravelEvents()
      */
     protected function handleEvent($level, $message, $context)
     {
+        $log = [];
+        
         if ($message instanceof Exceptions\HandlerException)
         {
             return;
@@ -260,14 +262,15 @@ protected function handleEvent($level, $message, $context)
             $log = $this->app['understand.exception-encoder']->exceptionToArray($message);
             $log['tags'] = ['exception_log'];
         }
-        else if (is_string($message))
+        // // integer, float, string or boolean as message
+        else if (is_scalar($message))
         {
             $log['message'] = $message;
             $log['tags'] = ['laravel_log'];
         }
         else
         {
-            $log = $message;
+            $log = (array)$message;
             $log['tags'] = ['laravel_log'];
         }
 

tests/EventListenerTest.php

@@ -122,4 +122,94 @@ public function testTokenProviderValue()
         $this->assertNotEmpty($token2);
         $this->assertSame($token2, $token);
     }
+    
+    /**
+     * @return void
+     */
+    public function testLoggerMessageInteger()
+    {
+        $called = 0;
+        $message = 123;
+        $messageSame = false;
+        $laravelLogTag = false;
+
+        $callback = function($data) use(&$called, &$messageSame, &$laravelLogTag, $message)
+        {
+            $called++;
+            $decoded = json_decode($data, true);
+
+            $messageSame = (string)$message === $decoded['message'];
+            $laravelLogTag = in_array('exception_log', $decoded['tags'], true);
+        };
+
+        $fieldProvider = $this->app['understand.field-provider'];
+        $handler = new CallbackHandler($callback);
+
+        $this->app['understand.logger'] = new Logger($fieldProvider, $handler, false);
+
+        $this->app['Psr\Log\LoggerInterface']->error($message);
+
+        $this->assertSame($called, 1);
+        $this->assertTrue($messageSame);
+    }
+    
+    /**
+     * @return void
+     */
+    public function testLoggerMessageBoolean()
+    {
+        $called = 0;
+        $messageSame = false;
+        $laravelLogTag = false;
+
+        $callback = function($data) use(&$called, &$messageSame, &$laravelLogTag)
+        {
+            $called++;
+            $decoded = json_decode($data, true);
+
+            // `false` should be casted to `0`
+            $messageSame = '0' === $decoded['message'];
+            $laravelLogTag = in_array('exception_log', $decoded['tags'], true);
+        };
+
+        $fieldProvider = $this->app['understand.field-provider'];
+        $handler = new CallbackHandler($callback);
+
+        $this->app['understand.logger'] = new Logger($fieldProvider, $handler, false);
+
+        $this->app['Psr\Log\LoggerInterface']->error(false);
+
+        $this->assertSame($called, 1);
+        $this->assertTrue($messageSame);
+    }
+    
+    /**
+     * @return void
+     */
+    public function testLoggerMessageObject()
+    {
+        $called = 0;
+        $object = new \Illuminate\Support\Fluent(['test' => 123]);
+        $messageSame = false;
+        $laravelLogTag = false;
+
+        $callback = function($data) use(&$called, &$messageSame, &$laravelLogTag, $object)
+        {
+            $called++;
+            $decoded = json_decode($data, true);
+
+            $messageSame = $object->toJson() === $decoded['message'];
+            $laravelLogTag = in_array('exception_log', $decoded['tags'], true);
+        };
+
+        $fieldProvider = $this->app['understand.field-provider'];
+        $handler = new CallbackHandler($callback);
+
+        $this->app['understand.logger'] = new Logger($fieldProvider, $handler, false);
+
+        $this->app['Psr\Log\LoggerInterface']->error($object);
+
+        $this->assertSame($called, 1);
+        $this->assertTrue($messageSame);
+    }
 }