Add logging (Case 74474)

Author: MalteWunsch

Handler/EmbeddedShortcodeHandler.php

@@ -2,6 +2,9 @@
 
 namespace Webfactory\ShortcodeBundle\Handler;
 
+use Psr\Log\LoggerInterface;
+use Psr\Log\NullLogger;
+use Symfony\Component\HttpFoundation\RequestStack;
 use Symfony\Component\HttpKernel\Controller\ControllerReference;
 use Symfony\Component\HttpKernel\Fragment\FragmentHandler;
 use Thunder\Shortcode\Shortcode\ShortcodeInterface;
@@ -22,16 +25,31 @@ class EmbeddedShortcodeHandler
     /** @var string */
     private $renderer;
 
+    /** @var LoggerInterface */
+    private $logger;
+
+    /** @var RequestStack */
+    private $requestStack;
+
     /**
      * @param FragmentHandler $fragmentHandler
      * @param string $controllerName
      * @param string $renderer
+     * @param LoggerInterface $logger
+     * @param RequestStack $requestStack
      */
-    public function __construct(FragmentHandler $fragmentHandler, $controllerName, $renderer)
-    {
+    public function __construct(
+        FragmentHandler $fragmentHandler,
+        $controllerName,
+        $renderer,
+        LoggerInterface $logger = null,
+        RequestStack $requestStack
+    ) {
         $this->fragmentHandler = $fragmentHandler;
         $this->controllerName = $controllerName;
         $this->renderer = $renderer;
+        $this->logger = $logger ?: new NullLogger();
+        $this->requestStack = $requestStack;
     }
 
     /**
@@ -40,6 +58,17 @@ public function __construct(FragmentHandler $fragmentHandler, $controllerName, $
      */
     public function __invoke(ShortcodeInterface $shortcode)
     {
+        $this->logger->notice(
+            'Request {controllerName} with parameters {parameters} and renderer {renderer} to resolve shortcode {shortcode}, triggered by a request to {url}.',
+            [
+                'controllerName' => $this->controllerName,
+                'parameters' => json_encode($shortcode->getParameters()),
+                'renderer' => $this->renderer,
+                'shortcode' => $shortcode->getName(),
+                'url' => $this->requestStack->getMasterRequest()->getRequestUri(),
+            ]
+        );
+
         return $this->fragmentHandler->render(
             new ControllerReference($this->controllerName, $shortcode->getParameters()),
             $this->renderer

README.md

@@ -270,7 +270,36 @@ final class ImageTest extends ShortcodeTest
     }
 }
 ```
- 
+
+
+## Logging
+
+When something goes wrong with the resolving of a shortcode, maybe you not only want to know which shortcode with
+which parameters caused the issue (which you can log in your resolving controller), but also which url was called
+that embedded the shortcode.
+
+This is tricky is you embed your shortcode controllers via ESI, as the ESI subrequest is in Symfony terms a master
+request, preventing you from getting your answer from RequestStack::getMasterRequest(). Hence, the
+`EmbedShortcodeHandler` logs with the default monolog handler which controller it will call to resolve the shortcode.
+You can overwrite the `EmbedShortcodeHandler`'s logger, e.g. if you want to change the channel, in the service
+definition of your shortcode:
+
+```xml
+<!-- src/AppBundle/Resources/config/shortcodes.xml -->
+<?xml version="1.0" ?>
+<container xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://symfony.com/schema/dic/services" xsi:schemaLocation="http://symfony.com/schema/dic/services http://symfony.com/schema/dic/services/services-1.0.xsd">
+    <services>
+        <service parent="webfactory.shortcode.embed_esi_for_shortcode_handler">
+            <argument index="1">app.controller.embedded_image:showAction</argument>
+            <tag name="webfactory.shortcode" ... />
+            ...
+            
+            <argument index="3" type="service" id="monolog.logger.your_channel" />
+        </service>
+    </services>
+</container>
+```
+
 
 ## Credits, Copyright and License
 

Resources/config/shortcodes.xml

@@ -21,13 +21,17 @@
             <argument type="service" id="fragment.handler"/>
             <argument><!-- Controller name placeholder argument --></argument>
             <argument>esi</argument>
+            <argument type="service" id="logger" on-invalid="null" />
+            <argument type="service" id="request_stack" />
         </service>
 
         <!-- Base definition for the EmbedForShortcodeHandler with inline renderer. -->
         <service abstract="true" id="webfactory.shortcode.embed_inline_for_shortcode_handler" class="Webfactory\ShortcodeBundle\Handler\EmbeddedShortcodeHandler" lazy="true">
             <argument type="service" id="fragment.handler"/>
             <argument><!-- Controller name placeholder argument --></argument>
             <argument>inline</argument>
+            <argument type="service" id="logger" on-invalid="null" />
+            <argument type="service" id="request_stack" />
         </service>
 
         <!-- Twig extension providing the |shortcodes filter. The content will be passed to the ShortcodeFacade. -->

composer.json

@@ -8,7 +8,8 @@
         "symfony/dependency-injection": "^3.4.11",
         "symfony/http-kernel": "^3.4.11",
         "symfony/twig-bundle": "^3.4.11",
-        "thunderer/Shortcode": "^0.6.5"
+        "thunderer/Shortcode": "^0.6.5",
+        "psr/log": "^1.0.2"
     },
 
     "require-dev": {