feat: add request and trace id to http requests and responses

Author: carlalexander

phpstan-baseline.neon

@@ -37,10 +37,10 @@ parameters:
 			path: src/Lambda/Response/Http/AbstractErrorHttpResponse.php
 
 		-
-			message: '#^Call to function is_string\(\) with string will always evaluate to true\.$#'
-			identifier: function.alreadyNarrowedType
+			message: '#^Method Ymir\\Runtime\\Lambda\\Response\\Http\\HttpResponse\:\:withHeader\(\) has parameter \$value with no type specified\.$#'
+			identifier: missingType.parameter
 			count: 1
-			path: src/Lambda/Response/Http/StaticFileResponse.php
+			path: src/Lambda/Response/Http/HttpResponse.php
 
 		-
 			message: '#^Method Ymir\\Runtime\\Logger\:\:__construct\(\) has parameter \$level with no type specified\.$#'

src/FastCgi/FastCgiRequest.php

@@ -50,23 +50,32 @@ public function __construct(string $content = '', array $parameters = [])
     public static function createFromInvocationEvent(HttpRequestEvent $event, string $scriptFilename): self
     {
         $content = $event->getBody();
+        $context = $event->getContext();
         $documentRoot = getcwd() ?: '';
         $headers = $event->getHeaders();
         $method = strtoupper($event->getMethod());
         $path = $event->getPath();
         $pathInfo = '';
         $port = $headers['x-forwarded-port'][0] ?? 80;
         $queryString = $event->getQueryString();
+        $requestId = $context->getRequestId();
         $scriptName = str_replace($documentRoot, '', $scriptFilename);
         $self = $scriptName.$path;
+        $traceId = $context->getTraceId();
 
         // Parse path information using same regex for nginx with "fastcgi_split_path_info"
         if (1 === preg_match('%^(.+\.php)(/.+)$%i', $path, $matches)) {
             $pathInfo = $matches[2];
             $self = $matches[0];
         }
 
+        $headers['x-request-id'] = $headers['x-request-id'] ?? [$requestId];
+        $headers['x-trace-id'] = $headers['x-trace-id'] ?? [$traceId];
+        $headers['x-amzn-request-id'] = $headers['x-amzn-request-id'] ?? [$requestId];
+        $headers['x-amzn-trace-id'] = $headers['x-amzn-trace-id'] ?? [$traceId];
+
         $parameters = [
+            'AWS_REQUEST_ID' => $requestId,
             'DOCUMENT_ROOT' => $documentRoot,
             'GATEWAY_INTERFACE' => 'FastCGI/1.0',
             'PATH_INFO' => $pathInfo,
@@ -84,6 +93,7 @@ public static function createFromInvocationEvent(HttpRequestEvent $event, string
             'SERVER_PORT' => $port,
             'SERVER_PROTOCOL' => $event->getProtocol(),
             'SERVER_SOFTWARE' => 'ymir',
+            '_X_AMZN_TRACE_ID' => $traceId,
         ];
 
         $parameters['REQUEST_URI'] = empty($queryString) ? $path : $path.'?'.$queryString;

src/Lambda/Response/Http/HttpResponse.php

@@ -96,6 +96,7 @@ public function getResponseData(): array
 
         // Compress the response body if we hit the 6MB Lambda payload limit and the response supports it.
         if ($this->shouldCompressResponse($body, $headers)) {
+            // Would be better if we could fallback if gzencode returns false. Right now, this would return a blank page
             $body = (string) gzencode($body, 9);
             $headers['Content-Encoding'] = ['gzip'];
             $headers['Content-Length'] = [strlen($body)];
@@ -129,6 +130,16 @@ public function isCompressible(): bool
         return $this->compressible;
     }
 
+    /**
+     * Return an instance with the given value replacing the given header.
+     */
+    public function withHeader(string $name, $value): self
+    {
+        $this->headers[$name] = (array) $value;
+
+        return $this;
+    }
+
     /**
      * Get the HTTP response headers properly formatted for a Lambda response.
      */

src/RuntimeApiClient.php

@@ -18,6 +18,7 @@
 use Ymir\Runtime\Lambda\InvocationEvent\InvocationEventFactory;
 use Ymir\Runtime\Lambda\InvocationEvent\InvocationEventInterface;
 use Ymir\Runtime\Lambda\Response\Http\ForbiddenHttpResponse;
+use Ymir\Runtime\Lambda\Response\Http\HttpResponse;
 use Ymir\Runtime\Lambda\Response\ResponseInterface;
 
 /**
@@ -104,12 +105,23 @@ public function sendInitializationError(\Throwable $error): void
      */
     public function sendResponse(InvocationEventInterface $event, ResponseInterface $response): void
     {
+        $requestId = $event->getContext()->getRequestId();
+
+        if ($response instanceof HttpResponse) {
+            $response
+                ->withHeader('X-Request-ID', $requestId)
+                ->withHeader('X-Amzn-RequestId', $requestId);
+        }
+
         $data = $response->getResponseData();
 
         // Lambda has a 6MB response payload limit. Send an error if we hit this limit instead of getting an
         // error from the API gateway.
         if (!empty($data['body']) && mb_strlen((string) $data['body']) >= 6000000) {
-            $data = (new ForbiddenHttpResponse('Response Too Large'))->getResponseData();
+            $data = (new ForbiddenHttpResponse('Response Too Large'))
+                ->withHeader('X-Request-ID', $requestId)
+                ->withHeader('X-Amzn-RequestId', $requestId)
+                ->getResponseData();
         }
 
         $this->sendData($data, sprintf('invocation/%s/response', $event->getContext()->getRequestId()));