Merge pull request #4 from joaojacome/master

Added a middleware processor, remove unnecessary code

Author: rendler-denis

ContextualInterface.php

@@ -12,11 +12,11 @@ interface ContextualInterface
     /**
      * Set the context for the logger
      *
-     * @param array $context
+     * @param mixed $context
      *
      * @return mixed
      */
-    public function setContext(array $context);
+    public function setContext($context);
 
     /**
      * Retrieve the context of this class

DependencyInjection/Configuration.php

@@ -40,6 +40,12 @@ public function getConfigTreeBuilder()
                     ->defaultFalse()
                     ->treatNullLike(false)
                 ->end()
+                ->arrayNode('middlewares')
+                    ->info('List of middlewares to use')
+                    ->prototype('scalar')
+                    ->end()
+                    ->treatNullLike([])
+                ->end()
                 ->booleanNode('enable_request_id')
                     ->info('Add a request identifier to all log entries. Allows for easier tracking of logs during a request')
                     ->defaultTrue()

DependencyInjection/OnelogExtension.php

@@ -27,6 +27,7 @@ public function load(array $configs, ContainerBuilder $container)
 
         $container->setParameter('onelog.logger_service', $config['logger_service']);
         $container->setParameter('onelog.register_global', $config['register_global']);
+        $container->setParameter('onelog.middlewares', $config['middlewares']);
         $container->setParameter('onelog.register_monolog_channels', $config['register_monolog_channels']);
         $container->setParameter('onelog.enable_request_id', $config['enable_request_id']);
     }

Helper/ContextualTrait.php

@@ -2,6 +2,8 @@
 
 namespace KoderHut\OnelogBundle\Helper;
 
+use KoderHut\OnelogBundle\ContextualInterface;
+
 /**
  * Trait ContextualTrait
  *
@@ -17,8 +19,14 @@ trait ContextualTrait
     /**
      * @inheritdoc
      */
-    public function setContext(array $context): self
+    public function setContext($context): self
     {
+        if (is_object($context) && $context instanceof ContextualInterface) {
+            $context = $context->getContext();
+        } else if (!is_array($context)) {
+            throw new \InvalidArgumentException();
+        }
+
         $this->contextualData = $context;
 
         return $this;

Middleware/ContextProcessor.php

@@ -0,0 +1,29 @@
+<?php declare(strict_types=1);
+
+namespace KoderHut\OnelogBundle\Middleware;
+
+use KoderHut\OnelogBundle\ContextualInterface;
+
+/**
+ * Class ContextProcessor
+ *
+ * @author Joao Jacome <[email protected]>
+ */
+class ContextProcessor implements MiddlewareInterface
+{
+    /**
+     * @param string $level
+     * @param mixed  $message
+     * @param array  $context
+     *
+     * @return array
+     */
+    public function process($level, $message, $context): array
+    {
+        if ($message instanceof ContextualInterface) {
+            $context = array_merge($context, $message->getContext());
+        }
+
+        return [$message, $context];
+    }
+}

Middleware/ExceptionCodeProcessor.php

@@ -0,0 +1,31 @@
+<?php declare(strict_types=1);
+
+namespace KoderHut\OnelogBundle\Middleware;
+
+use KoderHut\OnelogBundle\ContextualInterface;
+
+/**
+ * Class ExceptionCodeProcessor
+ *
+ * @author Joao Jacome <[email protected]>
+ */
+class ExceptionCodeProcessor implements MiddlewareInterface
+{
+    /**
+     * @param string $level
+     * @param mixed  $message
+     * @param array  $context
+     *
+     * @return array
+     */
+    public function process($level, $message, $context): array
+    {
+        if ($message instanceof \Throwable) {
+            $context = array_merge($context, [
+                'code' => $message->getCode(),
+            ]);
+        }
+
+        return [$message, $context];
+    }
+}

Middleware/MiddlewareInterface.php

@@ -0,0 +1,20 @@
+<?php declare(strict_types=1);
+
+namespace KoderHut\OnelogBundle\Middleware;
+
+/**
+ * Interface MiddlewareInterface
+ *
+ * @author Joao Jacome <[email protected]>
+ */
+interface MiddlewareInterface
+{
+    /**
+     * @param string $level
+     * @param mixed  $message
+     * @param array  $context
+     *
+     * @return array
+     */
+    public function process($level, $message, $context): array;
+}

Middleware/SimpleMessageProcessor.php

@@ -0,0 +1,29 @@
+<?php declare(strict_types=1);
+
+namespace KoderHut\OnelogBundle\Middleware;
+
+use KoderHut\OnelogBundle\ContextualInterface;
+
+/**
+ * Class SimpleMessageProcessor
+ *
+ * @author Joao Jacome <[email protected]>
+ */
+class SimpleMessageProcessor implements MiddlewareInterface
+{
+    /**
+     * @param string $level
+     * @param mixed  $message
+     * @param array  $context
+     *
+     * @return array
+     */
+    public function process($level, $message, $context): array
+    {
+        if ($message instanceof \Throwable) {
+            $message = $message->getMessage();
+        }
+
+        return [$message, $context];
+    }
+}

Middleware/StackTraceProcessor.php

@@ -0,0 +1,32 @@
+<?php declare(strict_types=1);
+
+namespace KoderHut\OnelogBundle\Middleware;
+
+use KoderHut\OnelogBundle\ContextualInterface;
+use KoderHut\OnelogBundle\MiddlewareProcessor;
+
+/**
+ * Class StackTraceProcessor
+ *
+ * @author Joao Jacome <[email protected]>
+ */
+class StackTraceProcessor implements MiddlewareInterface
+{
+    /**
+     * @param string $level
+     * @param mixed  $message
+     * @param array  $context
+     *
+     * @return array
+     */
+    public function process($level, $message, $context): array
+    {
+        if ($message instanceof \Throwable) {
+            $context = array_merge($context, [
+                'stack_trace' => $message->getTraceAsString(),
+            ]);
+        }
+
+        return [$message, $context];
+    }
+}

MiddlewareProcessor.php

@@ -0,0 +1,42 @@
+<?php declare(strict_types=1);
+
+namespace KoderHut\OnelogBundle;
+
+use KoderHut\OnelogBundle\Middleware\MiddlewareInterface;
+
+/**
+ * Class MiddlewareProcessor
+ *
+ * @author Joao Jacome <[email protected]>
+ */
+class MiddlewareProcessor implements MiddlewareInterface
+{
+    /**
+     * @var MiddlewareInterface[]
+     */
+    private $middlewares = [];
+
+    /**
+     * @param MiddlewareInterface $middleware
+     */
+    public function registerMiddleware(MiddlewareInterface $middleware)
+    {
+        $this->middlewares[] = $middleware;
+    }
+
+    /**
+     * @param string $level
+     * @param mixed  $message
+     * @param array  $context
+     *
+     * @return array
+     */
+    public function process($level, $message, $context): array
+    {
+        foreach ($this->middlewares as $middleware) {
+            [$message, $context] = $middleware->process($level, $message, $context);
+        }
+
+        return [$message, $context];
+    }
+}