[RELEASE-V8] Add new fields

docs/configuration.rst

@@ -10,7 +10,7 @@ The default configuration for the bundle looks like :
     sensiolabs_gotenberg:
         base_uri: 'http://localhost:3000'
         base_directory: '%kernel.project_dir%'
-        http_client: null # Defaults to 'http_client'
+        http_client: null   # Defaults to 'http_client'
         default_options:
             html:
                 paper_width: null                   # 8.5
@@ -28,8 +28,11 @@ The default configuration for the bundle looks like :
                 wait_delay: null                    # None
                 wait_for_expression: null           # None
                 emulated_media_type: null           # 'print'
+                cookies: null                       # None
                 extra_http_headers: null            # None
+                fail_on_http_status_codes: null     # [499-599]
                 fail_on_console_exceptions: null    # false
+                skip_network_idle_event: null       # false
                 pdf_format: null                    # None
                 pdf_universal_access: null          # false
             url:
@@ -48,8 +51,11 @@ The default configuration for the bundle looks like :
                 wait_delay: null                    # None
                 wait_for_expression: null           # None
                 emulated_media_type: null           # 'print'
+                cookies: null                       # None
                 extra_http_headers: null            # None
+                fail_on_http_status_codes: null     # [499-599]
                 fail_on_console_exceptions: null    # false
+                skip_network_idle_event: null       # false
                 pdf_format: null                    # None
                 pdf_universal_access: null          # false
             markdown:
@@ -68,8 +74,11 @@ The default configuration for the bundle looks like :
                 wait_delay: null                    # None
                 wait_for_expression: null           # None
                 emulated_media_type: null           # 'print'
+                cookies: null                       # None
                 extra_http_headers: null            # None
+                fail_on_http_status_codes: null     # [499-599]
                 fail_on_console_exceptions: null    # false
+                skip_network_idle_event: null       # false
                 pdf_format: null                    # None
                 pdf_universal_access: null          # false
             office:
@@ -100,13 +109,51 @@ HTTP headers to send by Chromium while loading the HTML document.
 
     sensiolabs_gotenberg:
         base_uri: 'http://localhost:3000'
-        options:
-            extra_http_headers:
-                - { name: 'My-Header', value: 'MyValue' }
+        default_options:
+            html:
+                extra_http_headers:
+                    - { name: 'My-Header', value: 'MyValue' }
+
+.. tip::
+
+    For more information about `custom HTTP headers`_.
+
+Invalid HTTP Status Codes
+~~~~~~~~~~~~~~~~~~~~~~~~~
+
+To return a 409 Conflict response if the HTTP status code from the main page is not acceptable.
+
+.. code-block:: yaml
+
+    sensiolabs_gotenberg:
+        base_uri: 'http://localhost:3000'
+        default_options:
+            html:
+                fail_on_http_status_codes: [401, 403]
+
+.. tip::
+
+    For more information about `Invalid HTTP Status Codes`_.
+
+Cookies
+~~~~~~~
+
+Cookies to store in the Chromium cookie jar.
+
+.. code-block:: yaml
+
+    sensiolabs_gotenberg:
+        base_uri: 'http://localhost:3000'
+        default_options:
+            html:
+                cookies:
+                    - { name: 'yummy_cookie', value: 'choco', domain: 'example.com' }
+                    - { name: 'my_cookie', value: 'symfony', domain: 'symfony.com', secure: true, httpOnly: true, sameSite: 'Lax'  }
 
 .. tip::
 
     For more information about `custom HTTP headers`_.
 
 .. _defaults properties: https://gotenberg.dev/docs/routes#page-properties-chromium
 .. _custom HTTP headers: https://gotenberg.dev/docs/routes#custom-http-headers
+.. _Invalid HTTP Status Codes: https://gotenberg.dev/docs/routes#invalid-http-status-codes-chromium

docs/customization.rst

@@ -304,6 +304,54 @@ Some websites have dedicated CSS rules for print. Using ``screen`` allows you to
 
     For more information about `emulated Media Type`_.
 
+Cookies
+-------
+
+``default: None``
+
+Cookies to store in the Chromium cookie jar.
+
+.. code-block:: php
+
+    $twigPdfBuilder
+        ->content('path/to/template.html.twig')
+        ->cookies([
+            [
+                'name' => 'my_cookie',
+                'value' => 'symfony',
+                'domain' => 'symfony.com',
+                'secure' => true,
+                'httpOnly' => true,
+                'sameSite' => 'Lax',
+            ],
+        ]);
+
+.. warning::
+
+    `cookies` method overrides any previous cookies.
+
+If you want to add cookies from the ones already loaded in the configuration you
+can use `addCookie`.
+
+.. code-block:: php
+
+    $twigPdfBuilder
+        ->content('path/to/template.html.twig')
+        ->addCookie([
+            [
+                'name' => 'my_cookie',
+                'value' => 'symfony',
+                'domain' => 'symfony.com',
+                'secure' => true,
+                'httpOnly' => true,
+                'sameSite' => 'Lax',
+            ],
+        ]);
+
+.. tip::
+
+    For more information about `cookies`_.
+
 Extra HTTP headers
 ------------------
 
@@ -323,6 +371,23 @@ HTTP headers to send by Chromium while loading the HTML document.
 
     For more information about `custom HTTP headers`_.
 
+Invalid HTTP Status Codes
+-------------------------
+
+``default: [499,599]``
+
+To return a 409 Conflict response if the HTTP status code from the main page is not acceptable..
+
+.. code-block:: php
+
+    $twigPdfBuilder
+        ->content('path/to/template.html.twig')
+        ->failOnHttpStatusCodes([401, 403]);
+
+.. tip::
+
+    For more information about `invalid HTTP Status Codes`_.
+
 Console Exceptions
 ------------------
 
@@ -340,6 +405,25 @@ Return a 409 Conflict response if there are exceptions in the Chromium console.
 
     For more information about `console Exceptions`_.
 
+Performance Mode
+----------------
+
+``default: false``
+
+Gotenberg, by default, waits for the network idle event to ensure that the majority of the page is rendered during conversion.
+However, this often significantly slows down the conversion process.
+Setting this form field to true can greatly enhance the conversion speed.
+
+.. code-block:: php
+
+    $twigPdfBuilder
+        ->content('path/to/template.html.twig')
+        ->skipNetworkIdleEvent();
+
+.. tip::
+
+    For more information about `performance mode`_.
+
 PDF Format
 ----------
 
@@ -381,6 +465,9 @@ Enable PDF for Universal Access for optimal accessibility.
 .. _delay: https://gotenberg.dev/docs/routes#wait-before-rendering
 .. _wait for expression: https://gotenberg.dev/docs/routes#wait-before-rendering
 .. _emulated Media Type: https://gotenberg.dev/docs/routes#emulated-media-type
+.. _cookies: https://gotenberg.dev/docs/routes#cookies-chromium
 .. _custom HTTP headers: https://gotenberg.dev/docs/routes#custom-http-headers
+.. _invalid HTTP Status Codes: https://gotenberg.dev/docs/routes#invalid-http-status-codes-chromium
 .. _console Exceptions: https://gotenberg.dev/docs/routes#console-exceptions
+.. _performance mode: https://gotenberg.dev/docs/routes#performance-mode-chromium
 .. _pdf formats: https://gotenberg.dev/docs/routes#pdfa-chromium

src/Builder/AbstractChromiumPdfBuilder.php

@@ -307,6 +307,33 @@ public function emulatedMediaType(string $mediaType): static
         return $this;
     }
 
+    /**
+     * Cookies to store in the Chromium cookie jar. (overrides any previous cookies).
+     *
+     * @see https://gotenberg.dev/docs/routes#cookies-chromium
+     *
+     * @param list<array{name: string, value: string, domain: string, path: string|null, secure: bool|null, httpOnly: bool|null, sameSite: 'Strict'|'Lax'|null}> $cookies
+     */
+    public function cookies(array $cookies): static
+    {
+        $this->formFields['cookies'] = $cookies;
+        return $this;
+    }
+
+    /**
+     *  Add cookies to store in the Chromium cookie jar.
+     *
+     * @see https://gotenberg.dev/docs/routes#cookies-chromium
+     *
+     * @param list<array{name: string, value: string, domain: string, path: string|null, secure: bool|null, httpOnly: bool|null, sameSite: 'Strict'|'Lax'|null}> $cookies
+     */
+    public function addCookie(array $cookies): static
+    {
+        $this->formFields['cookies'] = array_merge($this->formFields['cookies'] ?? [], $cookies);
+
+        return $this;
+    }
+
     /**
      * Sets extra HTTP headers that Chromium will send when loading the HTML
      * document. (default None). (overrides any previous headers).
@@ -330,13 +357,28 @@ public function extraHttpHeaders(array $headers): static
      *
      * @param array<string, string> $headers
      */
-    public function addExtraHttpHeaders(array $headers): static
+    public function addExtraHttpHeader(array $headers): static
     {
         $this->formFields['extraHttpHeaders'] = array_merge($this->formFields['extraHttpHeaders'] ?? [], $headers);
 
         return $this;
     }
 
+    /**
+     * Return a 409 Conflict response if the HTTP status code from
+     * the main page is not acceptable. (default [499,599]). (overrides any previous configuration).
+     *
+     * @see https://gotenberg.dev/docs/routes#invalid-http-status-codes-chromium
+     *
+     * @param array<int, int> $statusCodes
+     */
+    public function failOnHttpStatusCodes(array $statusCodes): static
+    {
+        $this->formFields['failOnHttpStatusCodes'] = $statusCodes;
+
+        return $this;
+    }
+
     /**
      * Forces Gotenberg to return a 409 Conflict response if there are
      * exceptions in the Chromium console. (default false).
@@ -350,6 +392,13 @@ public function failOnConsoleExceptions(bool $bool = true): static
         return $this;
     }
 
+    public function skipNetworkIdleEvent(bool $bool = true): static
+    {
+        $this->formFields['skipNetworkIdleEvent'] = $bool;
+
+        return $this;
+    }
+
     /**
      * Sets the PDF format of the resulting PDF. (default None).
      *
@@ -429,8 +478,11 @@ private function addConfiguration(string $configurationName, mixed $value): void
             'wait_delay' => $this->waitDelay($value),
             'wait_for_expression' => $this->waitForExpression($value),
             'emulated_media_type' => $this->emulatedMediaType($value),
+            'cookies' => $this->cookies($value),
             'extra_http_headers' => $this->extraHttpHeaders($value),
+            'fail_on_http_status_codes' => $this->failOnHttpStatusCodes($value),
             'fail_on_console_exceptions' => $this->failOnConsoleExceptions($value),
+            'skip_network_idle_event' => $this->skipNetworkIdleEvent($value),
             default => throw new InvalidBuilderConfiguration(sprintf('Invalid option "%s": no method does not exist in class "%s" to configured it.', $configurationName, static::class)),
         };
     }

src/Builder/AbstractPdfBuilder.php

@@ -5,7 +5,7 @@
 use Sensiolabs\GotenbergBundle\Client\GotenbergClientInterface;
 use Sensiolabs\GotenbergBundle\Client\PdfResponse;
 use Sensiolabs\GotenbergBundle\Enum\PdfPart;
-use Sensiolabs\GotenbergBundle\Exception\ExtraHttpHeadersJsonEncodingException;
+use Sensiolabs\GotenbergBundle\Exception\JsonEncodingException;
 use Sensiolabs\GotenbergBundle\Formatter\AssetBaseDirFormatter;
 use Symfony\Component\HttpFoundation\File\File;
 use Symfony\Component\HttpFoundation\HeaderUtils;
@@ -32,14 +32,8 @@ public function __construct(
         protected readonly AssetBaseDirFormatter $asset,
     ) {
         $this->normalizers = [
-            'extraHttpHeaders' => static function (mixed $value): array {
-                try {
-                    $extraHttpHeaders = json_encode($value, \JSON_THROW_ON_ERROR);
-                } catch (\JsonException $exception) {
-                    throw new ExtraHttpHeadersJsonEncodingException('Could not encode extra HTTP headers into JSON', previous: $exception);
-                }
-
-                return ['extraHttpHeaders' => $extraHttpHeaders];
+            'extraHttpHeaders' => function (mixed $value): array {
+                return $this->encodeData('extraHttpHeaders', $value);
             },
             'assets' => static function (array $value): array {
                 return ['files' => $value];
@@ -53,9 +47,29 @@ public function __construct(
             PdfPart::FooterPart->value => static function (DataPart $value): array {
                 return ['files' => $value];
             },
+            'failOnHttpStatusCodes' => function (mixed $value): array {
+                return $this->encodeData('failOnHttpStatusCodes', $value);
+            },
+            'cookies' => function (mixed $value): array {
+                return $this->encodeData('cookies', $value);
+            },
         ];
     }
 
+    /**
+     * @return array<string, mixed>
+     */
+    private function encodeData(string $key, mixed $value): array
+    {
+        try {
+            $encodedValue = json_encode($value, \JSON_THROW_ON_ERROR);
+        } catch (\JsonException $exception) {
+            throw new JsonEncodingException(sprintf('Could not encode property "%s" into JSON', $key), previous: $exception);
+        }
+
+        return [$key => $encodedValue];
+    }
+
     /**
      * The Gotenberg API endpoint path.
      */