BREAKING: Logging via mail

This refactor a few classes around, change of names, and add support
to log via emails, while ignoring some specific error for emails via
the marker interface `NoMailLogging`.

Author: PowerKiKi

src/Api/ExceptionWithoutMailLogging.php

@@ -0,0 +1,15 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Ecodev\Felix\Api;
+
+use Ecodev\Felix\Log\Filter\NoMailLogging;
+
+/**
+ * Exception that will show its message to end-user even on production server, but
+ * will not be sent to developers as emails
+ */
+class ExceptionWithoutMailLogging extends Exception implements NoMailLogging
+{
+}

src/Api/Server.php

@@ -100,7 +100,7 @@ public function sendCli(ExecutionResult $result): void
     private function handleError(Throwable $exception, callable $formatter): array
     {
         // Always log exception in DB (and by email)
-        _log()->err($exception->__toString());
+        _log()->err($exception->__toString(), ['exception' => $exception]);
 
         // If we are absolutely certain that the error comes from one of our trigger with a custom message for end-user,
         // then wrap the exception to make it showable to the end-user

src/Log/DbWriter.php renamed to src/Log/EventCompleter.php

@@ -5,40 +5,24 @@
 namespace Ecodev\Felix\Log;
 
 use Ecodev\Felix\Model\CurrentUser;
-use Ecodev\Felix\Repository\LogRepository;
-use Laminas\Log\Writer\AbstractWriter;
+use Laminas\Log\Processor\ProcessorInterface;
 
-class DbWriter extends AbstractWriter
+class EventCompleter implements ProcessorInterface
 {
-    /**
-     * @var LogRepository
-     */
-    private $logRepository;
-
     /**
      * @var string
      */
     private $baseUrl;
 
-    public function __construct(LogRepository $logRepository, string $baseUrl, $options = null)
+    public function __construct(string $baseUrl)
     {
-        parent::__construct($options);
-        $this->logRepository = $logRepository;
         $this->baseUrl = $baseUrl;
     }
 
     /**
-     * Write a message to the log
-     *
-     * @param array $event log data event
+     * Complete a log event with extra data, including stacktrace and any global stuff relevant to the app
      */
-    final protected function doWrite(array $event): void
-    {
-        $completedEvent = $this->completeEvent($event);
-        $this->logRepository->log($completedEvent);
-    }
-
-    protected function completeEvent(array $event): array
+    public function process(array $event): array
     {
         $envData = $this->getEnvData();
         $event = array_merge($event, $envData);
@@ -78,6 +62,7 @@ private function getEnvData(): array
 
         $envData = [
             'creator_id' => $user ? $user->getId() : null,
+            'login' => $user ? $user->getLogin() : null,
             'url' => $url,
             'referer' => $referer,
             'request' => json_encode($request, JSON_PRETTY_PRINT),

src/Log/EventCompleterFactory.php

@@ -0,0 +1,22 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Ecodev\Felix\Log;
+
+use Interop\Container\ContainerInterface;
+use Laminas\ServiceManager\Factory\FactoryInterface;
+
+class EventCompleterFactory implements FactoryInterface
+{
+    /**
+     * @param string $requestedName
+     */
+    public function __invoke(ContainerInterface $container, $requestedName, ?array $options = null): EventCompleter
+    {
+        $config = $container->get('config');
+        $baseUrl = 'https://' . $config['hostname'];
+
+        return new EventCompleter($baseUrl);
+    }
+}

src/Log/Filter/NoMail.php

@@ -0,0 +1,25 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Ecodev\Felix\Log\Filter;
+
+use GraphQL\Error\Error;
+use Laminas\Log\Filter\FilterInterface;
+
+final class NoMail implements FilterInterface
+{
+    /**
+     * Ignore exception that are explicitly marked as ignored
+     */
+    public function filter(array $event): bool
+    {
+        $exception = $event['extra']['exception'] ?? null;
+
+        if ($exception instanceof NoMailLogging || ($exception instanceof Error && $exception->getPrevious() instanceof NoMailLogging)) {
+            return false;
+        }
+
+        return true;
+    }
+}

src/Log/Filter/NoMailLogging.php

@@ -0,0 +1,12 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Ecodev\Felix\Log\Filter;
+
+/**
+ * Marker interface to be used on exception that should be logged via emails
+ */
+interface NoMailLogging
+{
+}

src/Log/Formatter/Extras.php

@@ -0,0 +1,36 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Ecodev\Felix\Log\Formatter;
+
+use Laminas\Log\Formatter\Simple;
+
+/**
+ * Simple formatter that show the Felix extras fields
+ */
+final class Extras extends Simple
+{
+    /**
+     * Class constructor
+     */
+    public function __construct()
+    {
+        $format = '
+Time    : %timestamp%
+Priority: %priorityName% (%priority%)
+Login   : %login%
+URL     : %url%
+REFERER : %referer%
+IP      : %ip%
+
+REQUEST:
+%request%
+
+MESSAGE:
+%message%
+
+';
+        parent::__construct($format);
+    }
+}

src/Log/LoggerFactory.php

@@ -4,6 +4,8 @@
 
 namespace Ecodev\Felix\Log;
 
+use Ecodev\Felix\Log\Writer\Db;
+use Ecodev\Felix\Log\Writer\Mail;
 use Interop\Container\ContainerInterface;
 use Laminas\Log\Logger;
 use Laminas\Log\Writer\Stream;
@@ -22,16 +24,23 @@ final class LoggerFactory implements FactoryInterface
     public function __invoke(ContainerInterface $container, $requestedName, ?array $options = null): Logger
     {
         if (!$this->logger) {
-            // Log to file
             $this->logger = new Logger();
+
+            // Log to file
             $fileWriter = new Stream('logs/all.log');
             $this->logger->addWriter($fileWriter);
 
             // Log to DB
-            $dbWriter = $container->get(DbWriter::class);
+            $dbWriter = $container->get(Db::class);
             $dbWriter->addFilter(Logger::INFO);
             $this->logger->addWriter($dbWriter);
 
+            // Maybe log to emails
+            $mailWriter = $container->get(Mail::class);
+            if ($mailWriter) {
+                $this->logger->addWriter($mailWriter);
+            }
+
             // Register to log all kind of PHP errors
             Logger::registerErrorHandler($this->logger, true);
             Logger::registerFatalErrorShutdownFunction($this->logger);

src/Log/Writer/Db.php

@@ -0,0 +1,40 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Ecodev\Felix\Log\Writer;
+
+use Ecodev\Felix\Log\EventCompleter;
+use Ecodev\Felix\Repository\LogRepository;
+use Laminas\Log\Writer\AbstractWriter;
+
+class Db extends AbstractWriter
+{
+    /**
+     * @var LogRepository
+     */
+    private $logRepository;
+
+    /**
+     * @var EventCompleter
+     */
+    private $eventCompleter;
+
+    public function __construct(LogRepository $logRepository, EventCompleter $extrasCompleter, $options = null)
+    {
+        parent::__construct($options);
+        $this->logRepository = $logRepository;
+        $this->eventCompleter = $extrasCompleter;
+    }
+
+    /**
+     * Write a message to the log
+     *
+     * @param array $event log data event
+     */
+    final protected function doWrite(array $event): void
+    {
+        $completedEvent = $this->eventCompleter->process($event);
+        $this->logRepository->log($completedEvent);
+    }
+}

src/Log/Writer/Mail.php

@@ -0,0 +1,34 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Ecodev\Felix\Log\Writer;
+
+use Ecodev\Felix\Log\EventCompleter;
+use Laminas\Mail\Message;
+use Laminas\Mail\Transport\TransportInterface;
+
+class Mail extends \Laminas\Log\Writer\Mail
+{
+    /**
+     * @var EventCompleter
+     */
+    private $eventCompleter;
+
+    public function __construct(Message $mail, TransportInterface $transport, EventCompleter $extrasCompleter)
+    {
+        parent::__construct($mail, $transport);
+        $this->eventCompleter = $extrasCompleter;
+    }
+
+    /**
+     * Write a message to the log
+     *
+     * @param array $event log data event
+     */
+    final protected function doWrite(array $event): void
+    {
+        $completedEvent = $this->eventCompleter->process($event);
+        parent::doWrite($completedEvent);
+    }
+}