Merge pull request #188 from open-runtimes/feat-best-cookie-support

Feat: Best set-cookie suport implementation

Author: Meldiron

app/controllers.php

@@ -261,6 +261,16 @@ function (
                 $log
             );
 
+            // Backwards compatibility for headers
+            $responseFormat = $request->getHeader('x-executor-response-format', '0.10.0'); // Last version without support for array value for headers
+            if (version_compare($responseFormat, '0.11.0', '<')) {
+                foreach ($execution['headers'] as $key => $value) {
+                    if (\is_array($value)) {
+                        $execution['headers'][$key] = $value[\array_key_last($value)] ?? '';
+                    }
+                }
+            }
+
             $acceptTypes = \explode(', ', $request->getHeader('accept', 'multipart/form-data'));
             $isJson = false;
 

src/Executor/Runner/Docker.php

@@ -978,7 +978,11 @@ public function createExecution(
                 }
 
                 if (\array_key_exists($key, $responseHeaders)) {
-                    $responseHeaders[$key] .= ', ' . $value;
+                    if (is_array($responseHeaders[$key])) {
+                        $responseHeaders[$key][] = $value;
+                    } else {
+                        $responseHeaders[$key] = [$responseHeaders[$key], $value];
+                    }
                 } else {
                     $responseHeaders[$key] = $value;
                 }
@@ -1030,6 +1034,9 @@ public function createExecution(
 
             // Extract logs and errors from file based on fileId in header
             $fileId = $responseHeaders['x-open-runtimes-log-id'] ?? '';
+            if (\is_array($fileId)) {
+                $fileId = $fileId[0] ?? '';
+            }
             $logs = '';
             $errors = '';
             if (!empty($fileId)) {

tests/Client.php

@@ -18,6 +18,7 @@ class Client
     public const METHOD_TRACE = 'TRACE';
 
     protected bool $selfSigned = false;
+    protected string $version = '0.11.0';
     protected string $endpoint = '';
 
     /**
@@ -61,6 +62,9 @@ public function addHeader(string $key, string $value): self
     public function call(string $method, string $path = '', array $headers = [], array $params = [], bool $decode = true, callable $callback = null): array
     {
         $headers            = array_merge($this->headers, $headers);
+        if (!\array_key_exists('x-executor-response-format', $headers)) {
+            $headers['x-executor-response-format'] = $this->version;
+        }
 
         $ch                 = curl_init($this->endpoint . $path . (($method == self::METHOD_GET && !empty($params)) ? '?' . http_build_query($params) : ''));
 

tests/ExecutorTest.php

@@ -382,7 +382,7 @@ public function testExecute(): void
         $response = $this->client->call(Client::METHOD_POST, '/runtimes/test-exec/executions');
         $this->assertEquals(200, $response['headers']['status-code']);
         $this->assertEquals(200, $response['body']['statusCode']);
-        $this->assertEquals('cookie1=value1; Path=/; HttpOnly; Secure; SameSite=Lax, cookie2=value2; Path=/; HttpOnly; Secure; SameSite=Lax', \json_decode($response['body']['headers'], true)['set-cookie']);
+        $this->assertEquals('aValue', \json_decode($response['body']['headers'], true)['x-key']);
 
         /** Execute on cold-started runtime */
         $response = $this->client->call(Client::METHOD_POST, '/runtimes/test-exec/executions', [], [
@@ -570,7 +570,10 @@ public function testSSRLogs(): void
         $this->assertEquals(200, $response['headers']['status-code']);
         $this->assertEquals(200, $response['body']['statusCode']);
         $this->assertStringContainsString('<p>OK</p>', $response['body']['body']);
-        $this->assertEquals('astroCookie1=astroValue1; Max-Age=1800; HttpOnly, astroCookie2=astroValue2; Max-Age=1800; HttpOnly', \json_decode($response['body']['headers'], true)['set-cookie']);
+
+        $setCookieList = \json_decode($response['body']['headers'], true)['set-cookie'];
+        $this->assertEquals('astroCookie1=astroValue1; Max-Age=1800; HttpOnly', $setCookieList[0]);
+        $this->assertEquals('astroCookie2=astroValue2; Max-Age=1800; HttpOnly', $setCookieList[1]);
 
         $this->assertNotEmpty($response['body']['logs']);
         $this->assertStringContainsString('Open runtimes log', $response['body']['logs']);
@@ -579,9 +582,17 @@ public function testSSRLogs(): void
         $this->assertNotEmpty($response['body']['errors']);
         $this->assertStringContainsString('Open runtimes error', $response['body']['errors']);
 
+        $response = $this->client->call(Client::METHOD_POST, '/runtimes/test-ssr-exec/executions', [
+            'x-executor-response-format' => '0.10.0' // Last version to report string header values only
+        ], $params);
+        $this->assertEquals(200, $response['headers']['status-code']);
+        $this->assertEquals(200, $response['body']['statusCode']);
+        $this->assertEquals('astroCookie2=astroValue2; Max-Age=1800; HttpOnly', \json_decode($response['body']['headers'], true)['set-cookie']);
+
         /** Delete runtime */
         $response = $this->client->call(Client::METHOD_DELETE, '/runtimes/test-ssr-exec', [], []);
         $this->assertEquals(200, $response['headers']['status-code']);
+        $this->assertEquals('astroCookie1=astroValue1; Max-Age=1800; HttpOnly', $setCookieList[0]);
     }
 
     public function testRestartPolicy(): void

tests/resources/functions/php/index.php

@@ -22,6 +22,6 @@
         'url' => $context->req->url,
         'todo' => $todo
     ], 200, [
-        'Set-Cookie' => 'cookie1=value1; Path=/; HttpOnly; Secure; SameSite=Lax, cookie2=value2; Path=/; HttpOnly; Secure; SameSite=Lax'
+        'x-key' => 'aValue'
     ]);
 };