chore: add query mode header

aws · Nov 12, 2024 · 7453477 · 7453477
1 parent 9e4be60
commit 7453477
Show file tree

Hide file tree

Showing 3 changed files with 37 additions and 0 deletions.
diff --git a/.changes/nextrelease/query-mode-header.json b/.changes/nextrelease/query-mode-header.json
@@ -0,0 +1,7 @@
+[
+  {
+    "type": "enhancement",
+    "category": "",
+    "description": "Adds opt-in header for query-compatible services"
+  }
+]
diff --git a/src/AwsClient.php b/src/AwsClient.php
@@ -12,6 +12,7 @@
 use Aws\Exception\AwsException;
 use Aws\Signature\SignatureProvider;
 use GuzzleHttp\Psr7\Uri;
+use Psr\Http\Message\RequestInterface;
 
 /**
  * Default AWS client implementation
@@ -275,6 +276,7 @@ public function __construct(array $args)
 
         if (!is_null($this->api->getMetadata('awsQueryCompatible'))) {
             $this->addQueryCompatibleInputMiddleware($this->api);
+            $this->addQueryModeHeader();
         }
 
         if (isset($args['with_resolved'])) {
@@ -524,6 +526,20 @@ private function addQueryCompatibleInputMiddleware(Service $api)
             );
     }
 
+    private function addQueryModeHeader()
+    {
+        $list = $this->getHandlerList();
+        $list->appendBuild(
+            Middleware::mapRequest(function (RequestInterface $r) {
+                return $r->withHeader(
+                    'x-amzn-query-mode',
+                    true
+                );
+            }),
+            'x-amzn-query-mode-header'
+        );
+    }
+
     private function addInvocationId()
     {
         // Add invocation id to each request

diff --git a/tests/AwsClientTest.php b/tests/AwsClientTest.php
@@ -33,6 +33,7 @@
 class AwsClientTest extends TestCase
 {
     use UsesServiceTrait;
+    use TestServiceTrait;
 
     private function getApiProvider()
     {
@@ -982,4 +983,17 @@ public function testClientParameterOverridesDefaultAccountIdEndpointModeBuiltIns
 
         self::assertEquals($expectedAccountIdEndpointMode, $builtIns['AWS::Auth::AccountIdEndpointMode']);
     }
+
+    public function testQueryModeHeaderAdded()
+    {
+        $service = $this->generateTestService('json', ['awsQueryCompatible' => true]);
+        $client = $this->generateTestClient($service);
+        $list = $client->getHandlerList();
+        $list->setHandler(new MockHandler([new Result()]));
+        $list->appendSign(Middleware::tap(function($cmd, $req) {
+           $this->assertTrue($req->hasHeader('x-amzn-query-mode'));
+           $this->assertEquals(true, $req->getHeaderLine('x-amzn-query-mode'));
+        }));
+        $client->TestOperation();
+    }
 }