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 <969041+joaojacome@users.noreply.github.com>
+ */
+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 <969041+joaojacome@users.noreply.github.com>
+ */
+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 <969041+joaojacome@users.noreply.github.com>
+ */
+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 <969041+joaojacome@users.noreply.github.com>
+ */
+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 <969041+joaojacome@users.noreply.github.com>
+ */
+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 <969041+joaojacome@users.noreply.github.com>
+ */
+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];
+    }
+}

OneLog.php

@@ -6,15 +6,17 @@
 use KoderHut\OnelogBundle\Helper\NullLogger;
 use Monolog\Logger;
 use Psr\Log\LoggerInterface;
+use Psr\Log\LoggerTrait;
 
 /**
  * Class OneLog
  *
  * @author Denis-Florin Rendler <connect@rendler.me>
+ * @author Joao Jacome <969041+joaojacome@users.noreply.github.com>
  */
-class OneLog
+class OneLog implements LoggerInterface
 {
-    use PSRLoggerTrait;
+    use LoggerTrait;
 
     public const DEFAULT_LOGGER = 'default';
 
@@ -28,6 +30,11 @@ class OneLog
      */
     private $loggers;
 
+    /**
+     * @var MiddlewareProcessor
+     */
+    private $middlewareProcessor;
+
     /**
      * OneLog constructor.
      *
@@ -45,6 +52,14 @@ public function __construct(LoggerInterface $default = null, LoggerInterface ...
         }
     }
 
+    /**
+     * @param MiddlewareProcessor $middlewareProcessor
+     */
+    public function setMiddlewareProcessor(MiddlewareProcessor $middlewareProcessor)
+    {
+        $this->middlewareProcessor = $middlewareProcessor;
+    }
+
     /**
      * Retrieves a registered logger based on the logger name as a
      * public property of the class
@@ -88,4 +103,18 @@ public function registerLogger(LoggerInterface $logger, $name = null): void
 
         $this->loggers[$loggerName] = $logger;
     }
+
+    /**
+     * @param mixed $level
+     * @param mixed $message
+     * @param array $context
+     */
+    public function log($level, $message, array $context = [])
+    {
+        if (null !== $this->middlewareProcessor) {
+            [$message, $context] = $this->middlewareProcessor->process($level, $message, $context);
+        }
+
+        $this->defaultLogger->log($level, $message, $context);
+    }
 }

OnelogBundle.php

@@ -6,9 +6,9 @@
 use KoderHut\OnelogBundle\DependencyInjection\Compiler\RegisterMonologChannels;
 use KoderHut\OnelogBundle\DependencyInjection\Compiler\RequestIdentifierPass;
 use KoderHut\OnelogBundle\Helper\GlobalNamespaceRegister;
+use KoderHut\OnelogBundle\Helper\OneLogStatic;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\HttpKernel\Bundle\Bundle;
-use KoderHut\OnelogBundle\Helper\OneLogStatic;
 
 /**
  * Class KoderHut\OnelogBundle
@@ -24,6 +24,14 @@ public function boot()
             OneLogStatic::setInstance($onelogService);
             GlobalNamespaceRegister::register('\\OneLog', OneLogStatic::class);
         }
+
+        if (!empty($middlewares = $this->container->getParameter('onelog.middlewares'))) {
+            $middlewareProcessor = $this->container->get(MiddlewareProcessor::class);
+            foreach ($middlewares as $middleware) {
+                $middlewareProcessor->registerMiddleware($this->container->get($middleware));
+            }
+            $this->container->get(OneLog::class)->setMiddlewareProcessor($middlewareProcessor);
+        }
     }
 
     public function build(ContainerBuilder $container)