Add support for extra_headers option in Upload and Admin API

PixelCook · zgould-cloudinary · web-flow · commit 9d49d8094bde · 2023-05-23T16:25:30.000+03:00
---------

Co-authored-by: zgould-cloudinary &lt;102525245+zgould-cloudinary@users.noreply.github.com&gt;
diff --git a/src/Api/BaseApiClient.php b/src/Api/BaseApiClient.php
@@ -318,6 +318,10 @@ protected static function finalizeEndPoint($endPoint)
     protected function callAsync($method, $endPoint, $options)
     {
         $endPoint = self::finalizeEndPoint($endPoint);
+        $options['headers'] = ArrayUtils::mergeNonEmpty(
+            ArrayUtils::get($options, 'headers', []),
+            ArrayUtils::get($options, 'extra_headers', [])
+        );
         $this->getLogger()->debug("Making async $method request", ['method' => $method, 'endPoint' => $endPoint]);
 
         return $this
diff --git a/tests/Helpers/MockApiClientTrait.php b/tests/Helpers/MockApiClientTrait.php
@@ -98,4 +98,8 @@ static function ($options, $item) {
             }
         );
     }
+    public function getLastRequestHeaders()
+    {
+        return $this->mockHandler->getLastRequest()->getHeaders();
+    }
 }
diff --git a/tests/Unit/Upload/UploadApiTest.php b/tests/Unit/Upload/UploadApiTest.php
@@ -132,4 +132,57 @@ public function testUploadFolderDecoupling()
 
         self::assertSubset($options, $lastOptions);
     }
+
+    /**
+     * @dataProvider headersDataProvider
+     */
+    public function testHeadersExtraHeaders($input, $expectedOutput)
+    {
+        $mockUploadApi = new MockUploadApi();
+            $mockUploadApi->upload(self::TEST_BASE64_IMAGE, $input);
+            $mockOutput = $mockUploadApi->getApiClient()->getLastRequestHeaders();
+        self::assertSubset($expectedOutput, $mockOutput);
+    }
+
+    public function headersDataProvider()
+    {
+        return [
+            [
+                [
+                    'headers' => ['Content-Type' => 'application/json', 'Accept' => 'application/json'],
+                    'extra_headers' => ['test1' => 'Bearer abc123', 'test2' => 'MyApp/1.0']
+                ],
+                ['Content-Type' => ['application/json'], 'Accept' => ['application/json'],
+                    'test1' => ['Bearer abc123'], 'test2' => ['MyApp/1.0']]
+            ],
+            [
+                [
+                    'headers' => ['X-Request-ID' => '12345'],
+                    'extra_headers' => ['Accept-Encoding' => 'gzip']
+                ],
+                ['X-Request-ID' => ['12345'], 'Accept-Encoding' => ['gzip']]
+            ],
+            [
+                [
+                    'headers' => ['Content-Language' => 'en-US'],
+                    'extra_headers' => []
+                ],
+                ['Content-Language' => ['en-US']]
+            ],
+            [
+                [
+                    'headers' => [],
+                    'extra_headers' => ['X-Debug' => ['true']]
+                ],
+                ['X-Debug' => ['true']]
+            ],
+            [
+                [
+                    'headers' => [],
+                    'extra_headers' => []
+                ],
+                []
+            ]
+        ];
+    }
 }

Original file line number	Diff line number	Diff line change
`@@ -98,4 +98,8 @@ static function ($options, $item) {`
`98`	`98`	`}`
`99`	`99`	`);`
`100`	`100`	`}`
	`101`	`+ public function getLastRequestHeaders()`
	`102`	`+ {`
	`103`	`+ return $this->mockHandler->getLastRequest()->getHeaders();`
	`104`	`+ }`
`101`	`105`	`}`