Stop passing the request into shortcode-resolving controllers (#15)

Do not try to pass the current `Request` object to controller methods performing the shortcode resolution:

* For ESI-based subrequests, this does not work.
* For `inline` subrequests, it is not necessary since the appropriate `Request` instance can be obtained directly from the `RequestStack`. 

(webfactory Case 134296)

Co-authored-by: Malte Wunsch <mw@webfactory.de>
Co-authored-by: Fabian Schmick <fs@webfactory.de>

Author: 3 people

CHANGELOG.md

@@ -7,8 +7,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased 2.0]
 
+### Removed
+
+- The current request will no longer be passed to controllers generating the shortcode substitution (see #15). For shortcodes being handled `inline`, use the `RequestStack` directly in the substituting controller method to obtain the parent request. For `esi`-based renderers, there is no current solution provided by this bundle (see #14). Check your shortcode controllers for access to the request attribute named `request` to find affected places.
+
 ### Changed
 
-- Logging will now by default be directed to the `shortcode` channel,
-  instead of the `app` channel used previously.
+- Logging will now by default be directed to the `shortcode` channel, instead of the `app` channel used previously.
 - Slightly reduced the logging level in `EmbeddedShortcodeHandler`.

src/Handler/EmbeddedShortcodeHandler.php

@@ -2,7 +2,6 @@
 
 namespace Webfactory\ShortcodeBundle\Handler;
 
-use InvalidArgumentException;
 use Psr\Log\LoggerInterface;
 use Psr\Log\NullLogger;
 use Symfony\Component\HttpFoundation\RequestStack;
@@ -67,20 +66,9 @@ public function __invoke(ShortcodeInterface $shortcode)
             ]
         );
 
-        try {
-            return $this->fragmentHandler->render(
-                new ControllerReference(
-                    $this->controllerName,
-                    array_merge(['request' => $this->requestStack->getCurrentRequest()], $shortcode->getParameters())
-                ),
-                $this->renderer
-            );
-        } catch (InvalidArgumentException $exception) {
-            if ('esi' === $this->renderer) {
-                throw new InvalidArgumentException('An InvalidArgumentException occured while trying to render the shortcode '.$shortcode->getShortcodeText().'. You\'ve probably tried to use the ESI rendering  strategy for '.'your shortcodes while handling a request that contained non-scalar values as part of URI '.'attributes. This can happen e.g. when using Param Converters for your original controller '.'action, as the request (containing the conversion result) is automatically passed to the call of '.'the shortcode controller to allow context sensitive shortcodes. You could use '.'Webfactory\ShortcodeBundle\Handler\EmbeddedShortcodeHandler.inline as parent in your '.'shortcode\'s service defintion, so that the inline instead of ESI rendering strategy will be '.'used.', 0, $exception);
-            }
-
-            throw $exception;
-        }
+        return $this->fragmentHandler->render(
+            new ControllerReference($this->controllerName, $shortcode->getParameters()),
+            $this->renderer
+        );
     }
 }