feat(chromium): set cookies

gotenberg · Apr 11, 2024 · 7c6726e · 7c6726e
1 parent 9a103a7
commit 7c6726e
Show file tree

Hide file tree

Showing 5 changed files with 138 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -550,6 +550,22 @@ $request = Gotenberg::chromium($apiUrl)
     ->url('https://my.url');
 ```
 
+#### Cookies
+
+You may add ccookies to store in the Chromium cookie jar:
+
+```php
+use Gotenberg\Gotenberg;
+
+$request = Gotenberg::chromium($apiUrl)
+    ->pdf()
+    ->cookies([
+        new ChromiumCookie(name: 'yummy_cookie', value: 'choco', domain: 'theyummycookie.com'),
+        new ChromiumCookie(name: 'vanilla_cookie', value: 'vanilla', domain: 'theyummycookie.com', path: '/', secure: true, httpOnly: true, sameSite: 'Lax'),
+    ])
+    ->url('https://my.url');
+```
+
 #### Extra HTTP headers
 
 You may add HTTP headers that Chromium will send when loading the HTML document:

diff --git a/src/Modules/ChromiumCookie.php b/src/Modules/ChromiumCookie.php
@@ -0,0 +1,19 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Gotenberg\Modules;
+
+class ChromiumCookie
+{
+    public function __construct(
+        public readonly string $name,
+        public readonly string $value,
+        public readonly string $domain,
+        public readonly string|null $path = null,
+        public readonly bool|null $secure = null,
+        public readonly bool|null $httpOnly = null,
+        public readonly string|null $sameSite = null,
+    ) {
+    }
+}
diff --git a/src/Modules/ChromiumMultipartFormDataModule.php b/src/Modules/ChromiumMultipartFormDataModule.php
@@ -69,6 +69,25 @@ public function emulateScreenMediaType(): self
         return $this;
     }
 
+    /**
+     * Cookies to store in the Chromium cookie jar.
+     *
+     * @param ChromiumCookie[] $cookies
+     *
+     * @throws NativeFunctionErrored
+     */
+    public function cookies(array $cookies): self
+    {
+        $json = json_encode($cookies);
+        if ($json === false) {
+            throw NativeFunctionErrored::createFromLastPhpError();
+        }
+
+        $this->formValue('cookies', $json);
+
+        return $this;
+    }
+
     /**
      * Sets extra HTTP headers that Chromium will send when loading the HTML
      * document.

diff --git a/tests/Modules/ChromiumPdfTest.php b/tests/Modules/ChromiumPdfTest.php
@@ -4,12 +4,14 @@
 
 use Gotenberg\Exceptions\NativeFunctionErrored;
 use Gotenberg\Gotenberg;
+use Gotenberg\Modules\ChromiumCookie;
 use Gotenberg\Modules\ChromiumPdf;
 use Gotenberg\Stream;
 
 it(
     'creates a valid request for the "/forms/chromium/convert/url" endpoint',
     /**
+     * @param ChromiumCookie[] $cookies
      * @param array<string,string> $extraHttpHeaders
      * @param int[] $failOnHttpStatusCodes
      * @param array<string,string|bool|float|int|array<string>> $metadata
@@ -35,6 +37,7 @@ function (
         string|null $waitDelay = null,
         string|null $waitForExpression = null,
         string|null $emulatedMediaType = null,
+        array $cookies = [],
         array $extraHttpHeaders = [],
         array $failOnHttpStatusCodes = [],
         bool $failOnConsoleExceptions = false,
@@ -65,6 +68,7 @@ function (
             $waitDelay,
             $waitForExpression,
             $emulatedMediaType,
+            $cookies,
             $extraHttpHeaders,
             $failOnHttpStatusCodes,
             $failOnConsoleExceptions,
@@ -101,6 +105,7 @@ function (
             $waitDelay,
             $waitForExpression,
             $emulatedMediaType,
+            $cookies,
             $extraHttpHeaders,
             $failOnHttpStatusCodes,
             $failOnConsoleExceptions,
@@ -134,6 +139,10 @@ function (
         '1s',
         "window.status === 'ready'",
         'print',
+        [
+            new ChromiumCookie('yummy_cookie', 'choco', 'theyummycookie.com'),
+            new ChromiumCookie('vanilla_cookie', 'vanilla', 'theyummycookie.com', '/', true, true, 'Lax'),
+        ],
         [
             'My-Http-Header' => 'HTTP Header content',
             'My-Second-Http-Header' => 'Second HTTP Header content',
@@ -153,6 +162,7 @@ function (
 it(
     'creates a valid request for the "/forms/chromium/convert/html" endpoint',
     /**
+     * @param ChromiumCookie[] $cookies
      * @param array<string,string> $extraHttpHeaders
      * @param int[] $failOnHttpStatusCodes
      * @param array<string,string|bool|float|int|array<string>> $metadata
@@ -178,6 +188,7 @@ function (
         string|null $waitDelay = null,
         string|null $waitForExpression = null,
         string|null $emulatedMediaType = null,
+        array $cookies = [],
         array $extraHttpHeaders = [],
         array $failOnHttpStatusCodes = [],
         bool $failOnConsoleExceptions = false,
@@ -208,6 +219,7 @@ function (
             $waitDelay,
             $waitForExpression,
             $emulatedMediaType,
+            $cookies,
             $extraHttpHeaders,
             $failOnHttpStatusCodes,
             $failOnConsoleExceptions,
@@ -246,6 +258,7 @@ function (
             $waitDelay,
             $waitForExpression,
             $emulatedMediaType,
+            $cookies,
             $extraHttpHeaders,
             $failOnHttpStatusCodes,
             $failOnConsoleExceptions,
@@ -278,6 +291,10 @@ function (
         '1s',
         "window.status === 'ready'",
         'screen',
+        [
+            new ChromiumCookie('yummy_cookie', 'choco', 'theyummycookie.com'),
+            new ChromiumCookie('vanilla_cookie', 'vanilla', 'theyummycookie.com', '/', true, true, 'Lax'),
+        ],
         [
             'My-Http-Header' => 'Http Header content',
             'My-Second-Http-Header' => 'Second Http Header content',
@@ -297,6 +314,7 @@ function (
 it(
     'creates a valid request for the "/forms/chromium/convert/markdown" endpoint',
     /**
+     * @param ChromiumCookie[] $cookies
      * @param array<string,string> $extraHttpHeaders
      * @param int[] $failOnHttpStatusCodes
      * @param Stream[] $markdowns
@@ -324,6 +342,7 @@ function (
         string|null $waitDelay = null,
         string|null $waitForExpression = null,
         string|null $emulatedMediaType = null,
+        array $cookies = [],
         array $extraHttpHeaders = [],
         array $failOnHttpStatusCodes = [],
         bool $failOnConsoleExceptions = false,
@@ -354,6 +373,7 @@ function (
             $waitDelay,
             $waitForExpression,
             $emulatedMediaType,
+            $cookies,
             $extraHttpHeaders,
             $failOnHttpStatusCodes,
             $failOnConsoleExceptions,
@@ -397,6 +417,7 @@ function (
             $waitDelay,
             $waitForExpression,
             $emulatedMediaType,
+            $cookies,
             $extraHttpHeaders,
             $failOnHttpStatusCodes,
             $failOnConsoleExceptions,
@@ -438,6 +459,10 @@ function (
         '1s',
         "window.status === 'ready'",
         'screen',
+        [
+            new ChromiumCookie('yummy_cookie', 'choco', 'theyummycookie.com'),
+            new ChromiumCookie('vanilla_cookie', 'vanilla', 'theyummycookie.com', '/', true, true, 'Lax'),
+        ],
         [
             'My-Http-Header' => 'Http Header content',
             'My-Second-Http-Header' => 'Second Http Header content',
@@ -455,6 +480,7 @@ function (
 ]);
 
 /**
+ * @param ChromiumCookie[]                                  $cookies
  * @param array<string,string>                              $extraHttpHeaders
  * @param int[]                                             $failOnHttpStatusCodes
  * @param array<string,string|bool|float|int|array<string>> $metadata
@@ -480,6 +506,7 @@ function hydrateChromiumPdfFormData(
     string|null $waitDelay = null,
     string|null $waitForExpression = null,
     string|null $emulatedMediaType = null,
+    array $cookies = [],
     array $extraHttpHeaders = [],
     array $failOnHttpStatusCodes = [],
     bool $failOnConsoleExceptions = false,
@@ -549,6 +576,10 @@ function hydrateChromiumPdfFormData(
         $chromium->emulateScreenMediaType();
     }
 
+    if (count($cookies) > 0) {
+        $chromium->cookies($cookies);
+    }
+
     if (count($extraHttpHeaders) > 0) {
         $chromium->extraHttpHeaders($extraHttpHeaders);
     }
@@ -585,6 +616,7 @@ function hydrateChromiumPdfFormData(
 }
 
 /**
+ * @param ChromiumCookie[]                                  $cookies
  * @param array<string,string>                              $extraHttpHeaders
  * @param int[]                                             $failOnHttpStatusCodes
  * @param array<string,string|bool|float|int|array<string>> $metadata
@@ -610,6 +642,7 @@ function expectChromiumPdfOptions(
     string|null $waitDelay,
     string|null $waitForExpression,
     string|null $emulatedMediaType,
+    array $cookies,
     array $extraHttpHeaders,
     array $failOnHttpStatusCodes,
     bool $failOnConsoleExceptions,
@@ -656,6 +689,15 @@ function expectChromiumPdfOptions(
     expect($body)->unless($waitForExpression === null, fn ($body) => $body->toContainFormValue('waitForExpression', $waitForExpression));
     expect($body)->unless($emulatedMediaType === null, fn ($body) => $body->toContainFormValue('emulatedMediaType', $emulatedMediaType));
 
+    if (count($cookies) > 0) {
+        $json = json_encode($cookies);
+        if ($json === false) {
+            throw NativeFunctionErrored::createFromLastPhpError();
+        }
+
+        expect($body)->toContainFormValue('cookies', $json);
+    }
+
     if (count($extraHttpHeaders) > 0) {
         $json = json_encode($extraHttpHeaders);
         if ($json === false) {