[RELEASE_8.7.0] Add new field form Chromium (#98)

sensiolabs · Jul 18, 2024 · 560fd1a · 560fd1a
1 parent 17907f1
commit 560fd1a
Show file tree

Hide file tree

Showing 16 changed files with 264 additions and 4 deletions.
diff --git a/docs/configuration.md b/docs/configuration.md
@@ -57,6 +57,7 @@ sensiolabs_gotenberg:
                 wait_for_expression: null           # None
                 emulated_media_type: null           # 'print'
                 cookies: null                       # None
+                user_agent: null                    # None
                 extra_http_headers: null            # None
                 fail_on_http_status_codes: null     # [499-599]
                 fail_on_console_exceptions: null    # false
@@ -88,6 +89,7 @@ sensiolabs_gotenberg:
                 wait_for_expression: null           # None
                 emulated_media_type: null           # 'print'
                 cookies: null                       # None
+                user_agent: null                    # None
                 extra_http_headers: null            # None
                 fail_on_http_status_codes: null     # [499-599]
                 fail_on_console_exceptions: null    # false
@@ -119,6 +121,7 @@ sensiolabs_gotenberg:
                 wait_for_expression: null           # None
                 emulated_media_type: null           # 'print'
                 cookies: null                       # None
+                user_agent: null                    # None
                 extra_http_headers: null            # None
                 fail_on_http_status_codes: null     # [499-599]
                 fail_on_console_exceptions: null    # false
@@ -155,6 +158,7 @@ sensiolabs_gotenberg:
                 wait_for_expression: null           # None
                 emulated_media_type: null           # 'print'
                 cookies: null                       # None
+                user_agent: null                    # None
                 extra_http_headers: null            # None
                 fail_on_http_status_codes: null     # [499-599]
                 fail_on_console_exceptions: null    # false
@@ -171,6 +175,7 @@ sensiolabs_gotenberg:
                 wait_for_expression: null           # None
                 emulated_media_type: null           # 'print'
                 cookies: null                       # None
+                user_agent: null                    # None
                 extra_http_headers: null            # None
                 fail_on_http_status_codes: null     # [499-599]
                 fail_on_console_exceptions: null    # false
@@ -187,6 +192,7 @@ sensiolabs_gotenberg:
                 wait_for_expression: null           # None
                 emulated_media_type: null           # 'print'
                 cookies: null                       # None
+                user_agent: null                    # None
                 extra_http_headers: null            # None
                 fail_on_http_status_codes: null     # [499-599]
                 fail_on_console_exceptions: null    # false

diff --git a/docs/pdf/builders_api/HtmlPdfBuilder.md b/docs/pdf/builders_api/HtmlPdfBuilder.md
@@ -94,6 +94,9 @@ For instance: "window.status === 'ready'".
 * `emulatedMediaType(Sensiolabs\GotenbergBundle\Enumeration\EmulatedMediaType $mediaType)`:
 Forces Chromium to emulate, either "screen" or "print". (default "print").
 
+* `userAgent(string $userAgent)`:
+Override the default User-Agent HTTP header. (default None).
+
 * `extraHttpHeaders(array $headers)`:
 Sets extra HTTP headers that Chromium will send when loading the HTML
 document. (default None). (overrides any previous headers).

diff --git a/docs/pdf/builders_api/MarkdownPdfBuilder.md b/docs/pdf/builders_api/MarkdownPdfBuilder.md
@@ -97,6 +97,9 @@ For instance: "window.status === 'ready'".
 * `emulatedMediaType(Sensiolabs\GotenbergBundle\Enumeration\EmulatedMediaType $mediaType)`:
 Forces Chromium to emulate, either "screen" or "print". (default "print").
 
+* `userAgent(string $userAgent)`:
+Override the default User-Agent HTTP header. (default None).
+
 * `extraHttpHeaders(array $headers)`:
 Sets extra HTTP headers that Chromium will send when loading the HTML
 document. (default None). (overrides any previous headers).

diff --git a/docs/pdf/builders_api/UrlPdfBuilder.md b/docs/pdf/builders_api/UrlPdfBuilder.md
@@ -96,6 +96,9 @@ For instance: "window.status === 'ready'".
 * `emulatedMediaType(Sensiolabs\GotenbergBundle\Enumeration\EmulatedMediaType $mediaType)`:
 Forces Chromium to emulate, either "screen" or "print". (default "print").
 
+* `userAgent(string $userAgent)`:
+Override the default User-Agent HTTP header. (default None).
+
 * `extraHttpHeaders(array $headers)`:
 Sets extra HTTP headers that Chromium will send when loading the HTML
 document. (default None). (overrides any previous headers).

diff --git a/docs/pdf/customization.md b/docs/pdf/customization.md
@@ -39,6 +39,7 @@
 [cookies](#cookies)  
 [setCookie](#setCookie)  
 [addCookies](#addCookies)  
+[userAgent](#userAgent)  
 [extraHttpHeaders](#extraHttpHeaders)  
 [addExtraHttpHeaders](#addExtraHttpHeaders)  
 [failOnHttpStatusCodes](#failOnHttpStatusCodes)  
@@ -728,6 +729,31 @@ class YourController
 }
 ```
 
+### userAgent()
+
+default: `None`
+
+Override the default User-Agent HTTP header.
+
+```php
+namespace App\Controller;
+
+use Sensiolabs\GotenbergBundle\Enumeration\UserAgent;
+use Sensiolabs\GotenbergBundle\GotenbergScreenshotInterface;
+
+class YourController
+{
+    public function yourControllerMethod(GotenbergScreenshotInterface $gotenberg): Response
+    {
+        return $gotenberg
+            ->html()
+            ->userAgent(UserAgent::AndroidChrome) // You can pass any string. This class is just a helper.
+            ->generate()
+        ;
+    }
+}
+```
+
 ### extraHttpHeaders
 
 default: `None`
@@ -1015,4 +1041,3 @@ class YourController
 
 > [!TIP]
 > For more information go to [Gotenberg documentations](https://gotenberg.dev/docs/routes#pdfa-chromium).
-
diff --git a/docs/screenshot/builders_api/HtmlScreenshotBuilder.md b/docs/screenshot/builders_api/HtmlScreenshotBuilder.md
@@ -45,6 +45,9 @@ For instance: "window.status === 'ready'".
 * `emulatedMediaType(Sensiolabs\GotenbergBundle\Enumeration\EmulatedMediaType $mediaType)`:
 Forces Chromium to emulate, either "screen" or "print". (default "print").
 
+* `userAgent(string $userAgent)`:
+Override the default User-Agent HTTP header. (default None).
+
 * `extraHttpHeaders(array $headers)`:
 Sets extra HTTP headers that Chromium will send when loading the HTML
 document. (default None). (overrides any previous headers).

diff --git a/docs/screenshot/builders_api/MarkdownScreenshotBuilder.md b/docs/screenshot/builders_api/MarkdownScreenshotBuilder.md
@@ -48,6 +48,9 @@ For instance: "window.status === 'ready'".
 * `emulatedMediaType(Sensiolabs\GotenbergBundle\Enumeration\EmulatedMediaType $mediaType)`:
 Forces Chromium to emulate, either "screen" or "print". (default "print").
 
+* `userAgent(string $userAgent)`:
+Override the default User-Agent HTTP header. (default None).
+
 * `extraHttpHeaders(array $headers)`:
 Sets extra HTTP headers that Chromium will send when loading the HTML
 document. (default None). (overrides any previous headers).

diff --git a/docs/screenshot/builders_api/UrlScreenshotBuilder.md b/docs/screenshot/builders_api/UrlScreenshotBuilder.md
@@ -47,6 +47,9 @@ For instance: "window.status === 'ready'".
 * `emulatedMediaType(Sensiolabs\GotenbergBundle\Enumeration\EmulatedMediaType $mediaType)`:
 Forces Chromium to emulate, either "screen" or "print". (default "print").
 
+* `userAgent(string $userAgent)`:
+Override the default User-Agent HTTP header. (default None).
+
 * `extraHttpHeaders(array $headers)`:
 Sets extra HTTP headers that Chromium will send when loading the HTML
 document. (default None). (overrides any previous headers).

diff --git a/docs/screenshot/customization.md b/docs/screenshot/customization.md
@@ -21,6 +21,7 @@
 [cookies](#cookies)  
 [setCookie](#setCookie)  
 [addCookies](#addCookies)  
+[userAgent](#userAgent)  
 [extraHttpHeaders](#extraHttpHeaders)  
 [addExtraHttpHeaders](#addExtraHttpHeaders)  
 [failOnHttpStatusCodes](#failOnHttpStatusCodes)  
@@ -393,6 +394,30 @@ class YourController
 }
 ```
 
+### userAgent()
+
+default: `None`
+
+Override the default User-Agent HTTP header.
+
+```php
+namespace App\Controller;
+
+use Sensiolabs\GotenbergBundle\GotenbergScreenshotInterface;
+
+class YourController
+{
+    public function yourControllerMethod(GotenbergScreenshotInterface $gotenberg): Response
+    {
+        return $gotenberg
+            ->html()
+            ->userAgent(UserAgent::AndroidChrome) // You can pass any string. This class is just a helper.
+            ->generate()
+        ;
+    }
+}
+```
+
 ### extraHttpHeaders
 
 default: `None`

diff --git a/src/Builder/Pdf/AbstractChromiumPdfBuilder.php b/src/Builder/Pdf/AbstractChromiumPdfBuilder.php
@@ -9,6 +9,7 @@
 use Sensiolabs\GotenbergBundle\Enumeration\Part;
 use Sensiolabs\GotenbergBundle\Enumeration\PdfFormat;
 use Sensiolabs\GotenbergBundle\Enumeration\Unit;
+use Sensiolabs\GotenbergBundle\Enumeration\UserAgent;
 use Sensiolabs\GotenbergBundle\Exception\InvalidBuilderConfiguration;
 use Sensiolabs\GotenbergBundle\Exception\PdfPartRenderingException;
 use Sensiolabs\GotenbergBundle\Formatter\AssetBaseDirFormatter;
@@ -375,11 +376,25 @@ public function emulatedMediaType(EmulatedMediaType $mediaType): static
         return $this;
     }
 
+    /**
+     * Override the default User-Agent HTTP header. (default None).
+     *
+     * @param UserAgent::*|string $userAgent
+     *
+     * @see https://gotenberg.dev/docs/routes#custom-http-headers-chromium
+     */
+    public function userAgent(string $userAgent): static
+    {
+        $this->formFields['userAgent'] = $userAgent;
+
+        return $this;
+    }
+
     /**
      * Sets extra HTTP headers that Chromium will send when loading the HTML
      * document. (default None). (overrides any previous headers).
      *
-     * @see https://gotenberg.dev/docs/routes#custom-http-headers
+     * @see https://gotenberg.dev/docs/routes#custom-http-headers-chromium
      *
      * @param array<string, string> $headers
      */
@@ -565,6 +580,7 @@ protected function addConfiguration(string $configurationName, mixed $value): vo
             'wait_for_expression' => $this->waitForExpression($value),
             'emulated_media_type' => $this->emulatedMediaType(EmulatedMediaType::from($value)),
             'cookies' => $this->cookies($value),
+            'user_agent' => $this->userAgent($value),
             'extra_http_headers' => $this->extraHttpHeaders($value),
             'fail_on_http_status_codes' => $this->failOnHttpStatusCodes($value),
             'fail_on_console_exceptions' => $this->failOnConsoleExceptions($value),

diff --git a/src/Builder/Screenshot/AbstractChromiumScreenshotBuilder.php b/src/Builder/Screenshot/AbstractChromiumScreenshotBuilder.php
@@ -7,6 +7,7 @@
 use Sensiolabs\GotenbergBundle\Enumeration\EmulatedMediaType;
 use Sensiolabs\GotenbergBundle\Enumeration\Part;
 use Sensiolabs\GotenbergBundle\Enumeration\ScreenshotFormat;
+use Sensiolabs\GotenbergBundle\Enumeration\UserAgent;
 use Sensiolabs\GotenbergBundle\Exception\InvalidBuilderConfiguration;
 use Sensiolabs\GotenbergBundle\Exception\ScreenshotPartRenderingException;
 use Sensiolabs\GotenbergBundle\Formatter\AssetBaseDirFormatter;
@@ -211,11 +212,25 @@ public function emulatedMediaType(EmulatedMediaType $mediaType): static
         return $this;
     }
 
+    /**
+     * Override the default User-Agent HTTP header. (default None).
+     *
+     * @param UserAgent::*|string $userAgent
+     *
+     * @see https://gotenberg.dev/docs/routes#custom-http-headers-chromium
+     */
+    public function userAgent(string $userAgent): static
+    {
+        $this->formFields['userAgent'] = $userAgent;
+
+        return $this;
+    }
+
     /**
      * Sets extra HTTP headers that Chromium will send when loading the HTML
      * document. (default None). (overrides any previous headers).
      *
-     * @see https://gotenberg.dev/docs/routes#custom-http-headers
+     * @see https://gotenberg.dev/docs/routes#custom-http-headers-chromium
      *
      * @param array<string, string> $headers
      */
@@ -363,6 +378,7 @@ private function addConfiguration(string $configurationName, mixed $value): void
             'wait_for_expression' => $this->waitForExpression($value),
             'emulated_media_type' => $this->emulatedMediaType($value),
             'cookies' => $this->cookies($value),
+            'user_agent' => $this->userAgent($value),
             'extra_http_headers' => $this->extraHttpHeaders($value),
             'fail_on_http_status_codes' => $this->failOnHttpStatusCodes($value),
             'fail_on_console_exceptions' => $this->failOnConsoleExceptions($value),

diff --git a/src/DependencyInjection/Configuration.php b/src/DependencyInjection/Configuration.php
@@ -284,6 +284,16 @@ private function addChromiumPdfOptionsNode(ArrayNodeDefinition $parent): void
                         ->end()
                     ->end()
                 ->end()
+                ->scalarNode('user_agent')
+                    ->info('Override the default User-Agent HTTP header. - default None. https://gotenberg.dev/docs/routes#custom-http-headers-chromium')
+                    ->defaultNull()
+                    ->validate()
+                        ->ifTrue(static function ($option) {
+                            return !\is_string($option);
+                        })
+                        ->thenInvalid('Invalid value %s')
+                    ->end()
+                ->end()
                 ->arrayNode('extra_http_headers')
                     ->info('HTTP headers to send by Chromium while loading the HTML document - default None. https://gotenberg.dev/docs/routes#custom-http-headers')
                     ->defaultValue([])
@@ -415,8 +425,18 @@ private function addChromiumScreenshotOptionsNode(ArrayNodeDefinition $parent):
                         ->end()
                     ->end()
                 ->end()
+                ->scalarNode('user_agent')
+                    ->info('Override the default User-Agent HTTP header. - default None. https://gotenberg.dev/docs/routes#custom-http-headers-chromium')
+                    ->defaultNull()
+                    ->validate()
+                        ->ifTrue(static function ($option) {
+                            return !\is_string($option);
+                        })
+                        ->thenInvalid('Invalid value %s')
+                    ->end()
+                ->end()
                 ->arrayNode('extra_http_headers')
-                    ->info('HTTP headers to send by Chromium while loading the HTML document - default None. https://gotenberg.dev/docs/routes#custom-http-headers')
+                    ->info('HTTP headers to send by Chromium while loading the HTML document - default None. https://gotenberg.dev/docs/routes#custom-http-headers-chromium')
                     ->defaultValue([])
                     ->useAttributeAsKey('name')
                         ->arrayPrototype()