[FEATURE] Allow changing url generator context for url*builder (#60)

sensiolabs · Jun 5, 2024 · 8e75b85 · 8e75b85
1 parent 6f80a82
commit 8e75b85
Show file tree

Hide file tree

Showing 13 changed files with 510 additions and 303 deletions.
diff --git a/composer.json b/composer.json
@@ -1,6 +1,7 @@
 {
     "name": "sensiolabs/gotenberg-bundle",
     "description": "Gotenberg support for Symfony",
+    "keywords": ["gotenberg", "symfony", "pdf", "screenshot", "office", "bundle"],
     "type": "symfony-bundle",
     "license": "MIT",
     "autoload": {
@@ -20,24 +21,28 @@
         }
     ],
     "require": {
-        "php": ">=8.2",
+        "php": ">=8.1",
+        "ext-json": "*",
         "symfony/config": "^6.4 || ^7.0",
         "symfony/dependency-injection": "^6.4 || ^7.0",
+        "symfony/filesystem": "^6.4 || ^7.0",
+        "symfony/http-client": "^6.4 || ^7.0",
+        "symfony/http-foundation": "^6.4 || ^7.0",
         "symfony/http-kernel": "^6.4 || ^7.0",
         "symfony/mime": "^6.4 || ^7.0",
-        "symfony/string": "^6.4 || ^7.0",
-        "symfony/http-client": "^6.4 || ^7.0",
-        "symfony/filesystem": "^6.4 || ^7.0"
+        "symfony/string": "^6.4 || ^7.0"
     },
     "require-dev": {
         "friendsofphp/php-cs-fixer": "^3.41",
-        "phpstan/phpstan": "^1.10",
         "phpstan/extension-installer": "^1.3",
+        "phpstan/phpstan": "^1.10",
         "phpstan/phpstan-symfony": "^1.3",
         "phpunit/phpunit": "^10.4",
         "symfony/framework-bundle": "^6.4 || ^7.0",
+        "symfony/monolog-bundle": "^3.10",
+        "symfony/stopwatch": "^6.4 || ^7.0",
         "symfony/twig-bundle": "^6.4 || ^7.0",
-        "symfony/stopwatch": "^6.4 || ^7.0"
+        "symfony/var-dumper": "^6.4 || ^7.0"
     },
     "config": {
         "allow-plugins": {
@@ -46,6 +51,7 @@
         "sort-packages": true
     },
     "suggest": {
+        "symfony/monolog-bundle": "Enables logging througout the generating process.",
         "symfony/twig-bundle": "Allows you to use Twig to render templates into PDF"
     }
 }
diff --git a/config/builder_pdf.php b/config/builder_pdf.php
@@ -28,6 +28,7 @@
             service('twig')->nullOnInvalid(),
             service('router')->nullOnInvalid(),
         ])
+        ->call('setRequestContext', [service('.sensiolabs_gotenberg.request_context')->nullOnInvalid()])
         ->tag('sensiolabs_gotenberg.pdf_builder')
     ;
 

diff --git a/config/builder_screenshot.php b/config/builder_screenshot.php
@@ -27,6 +27,7 @@
             service('twig')->nullOnInvalid(),
             service('router')->nullOnInvalid(),
         ])
+        ->call('setRequestContext', [service('.sensiolabs_gotenberg.request_context')->nullOnInvalid()])
         ->tag('sensiolabs_gotenberg.screenshot_builder')
     ;
 

diff --git a/phpstan.neon b/phpstan.neon
@@ -5,6 +5,30 @@ parameters:
 		- 'src'
 		- 'tests'
 	ignoreErrors:
+		-
+			message: "#^Cannot call method generate\\(\\) on Symfony\\\\Component\\\\Routing\\\\Generator\\\\UrlGeneratorInterface\\|null\\.$#"
+			count: 1
+			path: src/Builder/Pdf/UrlPdfBuilder.php
+		-
+			message: "#^Cannot call method getContext\\(\\) on Symfony\\\\Component\\\\Routing\\\\Generator\\\\UrlGeneratorInterface\\|null\\.$#"
+			count: 1
+			path: src/Builder/Pdf/UrlPdfBuilder.php
+		-
+			message: "#^Cannot call method setContext\\(\\) on Symfony\\\\Component\\\\Routing\\\\Generator\\\\UrlGeneratorInterface\\|null\\.$#"
+			count: 2
+			path: src/Builder/Pdf/UrlPdfBuilder.php
+		-
+			message: "#^Cannot call method generate\\(\\) on Symfony\\\\Component\\\\Routing\\\\Generator\\\\UrlGeneratorInterface\\|null\\.$#"
+			count: 1
+			path: src/Builder/Screenshot/UrlScreenshotBuilder.php
+		-
+			message: "#^Cannot call method getContext\\(\\) on Symfony\\\\Component\\\\Routing\\\\Generator\\\\UrlGeneratorInterface\\|null\\.$#"
+			count: 1
+			path: src/Builder/Screenshot/UrlScreenshotBuilder.php
+		-
+			message: "#^Cannot call method setContext\\(\\) on Symfony\\\\Component\\\\Routing\\\\Generator\\\\UrlGeneratorInterface\\|null\\.$#"
+			count: 2
+			path: src/Builder/Screenshot/UrlScreenshotBuilder.php
 		-
 			message: "#^Cannot use array destructuring on array\\<int, string\\|null\\>\\|null\\.$#"
 			count: 1

diff --git a/src/Builder/Pdf/AbstractChromiumPdfBuilder.php b/src/Builder/Pdf/AbstractChromiumPdfBuilder.php
@@ -523,7 +523,7 @@ protected function withRenderedPart(Part $pdfPart, string $template, array $cont
         return $this;
     }
 
-    private function addConfiguration(string $configurationName, mixed $value): void
+    protected function addConfiguration(string $configurationName, mixed $value): void
     {
         match ($configurationName) {
             'single_page' => $this->singlePage($value),

diff --git a/src/Builder/Pdf/UrlPdfBuilder.php b/src/Builder/Pdf/UrlPdfBuilder.php
@@ -6,19 +6,31 @@
 use Sensiolabs\GotenbergBundle\Exception\MissingRequiredFieldException;
 use Sensiolabs\GotenbergBundle\Formatter\AssetBaseDirFormatter;
 use Symfony\Component\Routing\Generator\UrlGeneratorInterface;
+use Symfony\Component\Routing\RequestContext;
 use Twig\Environment;
 
 final class UrlPdfBuilder extends AbstractChromiumPdfBuilder
 {
     private const ENDPOINT = '/forms/chromium/convert/url';
 
+    private RequestContext|null $requestContext = null;
+
     public function __construct(
         GotenbergClientInterface $gotenbergClient,
         AssetBaseDirFormatter $asset,
         Environment|null $twig = null,
         private readonly UrlGeneratorInterface|null $urlGenerator = null,
     ) {
         parent::__construct($gotenbergClient, $asset, $twig);
+
+        $this->addNormalizer('route', $this->generateUrlFromRoute(...));
+    }
+
+    public function setRequestContext(RequestContext|null $requestContext = null): self
+    {
+        $this->requestContext = $requestContext;
+
+        return $this;
     }
 
     /**
@@ -34,20 +46,50 @@ public function url(string $url): self
     /**
      * @param string       $name       #Route
      * @param array<mixed> $parameters
+     *
+     * @phpstan-assert !null $this->urlGenerator
      */
     public function route(string $name, array $parameters = []): self
     {
         if (null === $this->urlGenerator) {
             throw new \LogicException(sprintf('Router is required to use "%s" method. Try to run "composer require symfony/routing".', __METHOD__));
         }
 
-        return $this->url($this->urlGenerator->generate($name, $parameters, UrlGeneratorInterface::ABSOLUTE_URL));
+        $this->formFields['route'] = [$name, $parameters];
+
+        return $this;
+    }
+
+    /**
+     * @param array{string, array<mixed>} $value
+     *
+     * @return array{url: string}
+     */
+    private function generateUrlFromRoute(array $value): array
+    {
+        [$route, $parameters] = $value;
+
+        $requestContext = $this->urlGenerator->getContext();
+
+        if (null !== $this->requestContext) {
+            $this->urlGenerator->setContext($this->requestContext);
+        }
+
+        try {
+            return ['url' => $this->urlGenerator->generate($route, $parameters, UrlGeneratorInterface::ABSOLUTE_URL)];
+        } finally {
+            $this->urlGenerator->setContext($requestContext);
+        }
     }
 
     public function getMultipartFormData(): array
     {
-        if (!\array_key_exists('url', $this->formFields)) {
-            throw new MissingRequiredFieldException('URL is required');
+        if (!\array_key_exists('url', $this->formFields) && !\array_key_exists('route', $this->formFields)) {
+            throw new MissingRequiredFieldException('URL (or route) is required');
+        }
+
+        if (\array_key_exists('url', $this->formFields) && \array_key_exists('route', $this->formFields)) {
+            throw new MissingRequiredFieldException('Provide only one of ["route", "url"] parameter. Not both.');
         }
 
         return parent::getMultipartFormData();

diff --git a/src/Builder/Screenshot/UrlScreenshotBuilder.php b/src/Builder/Screenshot/UrlScreenshotBuilder.php
@@ -6,19 +6,31 @@
 use Sensiolabs\GotenbergBundle\Exception\MissingRequiredFieldException;
 use Sensiolabs\GotenbergBundle\Formatter\AssetBaseDirFormatter;
 use Symfony\Component\Routing\Generator\UrlGeneratorInterface;
+use Symfony\Component\Routing\RequestContext;
 use Twig\Environment;
 
 final class UrlScreenshotBuilder extends AbstractChromiumScreenshotBuilder
 {
     private const ENDPOINT = '/forms/chromium/screenshot/url';
 
+    private RequestContext|null $requestContext = null;
+
     public function __construct(
         GotenbergClientInterface $gotenbergClient,
         AssetBaseDirFormatter $asset,
         Environment|null $twig = null,
         private readonly UrlGeneratorInterface|null $urlGenerator = null,
     ) {
         parent::__construct($gotenbergClient, $asset, $twig);
+
+        $this->addNormalizer('route', $this->generateUrlFromRoute(...));
+    }
+
+    public function setRequestContext(RequestContext|null $requestContext = null): self
+    {
+        $this->requestContext = $requestContext;
+
+        return $this;
     }
 
     /**
@@ -32,22 +44,52 @@ public function url(string $url): self
     }
 
     /**
-     * @param string               $name       #Route
-     * @param array<string, mixed> $parameters
+     * @param string       $name       #Route
+     * @param array<mixed> $parameters
+     *
+     * @phpstan-assert !null $this->urlGenerator
      */
     public function route(string $name, array $parameters = []): self
     {
         if (null === $this->urlGenerator) {
             throw new \LogicException(sprintf('Router is required to use "%s" method. Try to run "composer require symfony/routing".', __METHOD__));
         }
 
-        return $this->url($this->urlGenerator->generate($name, $parameters, UrlGeneratorInterface::ABSOLUTE_URL));
+        $this->formFields['route'] = [$name, $parameters];
+
+        return $this;
+    }
+
+    /**
+     * @param array{string, array<mixed>} $value
+     *
+     * @return array{url: string}
+     */
+    private function generateUrlFromRoute(array $value): array
+    {
+        [$route, $parameters] = $value;
+
+        $requestContext = $this->urlGenerator->getContext();
+
+        if (null !== $this->requestContext) {
+            $this->urlGenerator->setContext($this->requestContext);
+        }
+
+        try {
+            return ['url' => $this->urlGenerator->generate($route, $parameters, UrlGeneratorInterface::ABSOLUTE_URL)];
+        } finally {
+            $this->urlGenerator->setContext($requestContext);
+        }
     }
 
     public function getMultipartFormData(): array
     {
-        if (!\array_key_exists('url', $this->formFields)) {
-            throw new MissingRequiredFieldException('URL is required');
+        if (!\array_key_exists('url', $this->formFields) && !\array_key_exists('route', $this->formFields)) {
+            throw new MissingRequiredFieldException('URL (or route) is required');
+        }
+
+        if (\array_key_exists('url', $this->formFields) && \array_key_exists('route', $this->formFields)) {
+            throw new MissingRequiredFieldException('Provide only one of ["route", "url"] parameter. Not both.');
         }
 
         return parent::getMultipartFormData();