Update Graphql proxy.

Proxy passes data as is and sets the datatype as JSON.

Author: Muhammad Farag

src/Clients/Graphql.php

@@ -34,7 +34,7 @@ public function __construct(
      *
      * @param string|array   $data         Query to be posted to endpoint
      * @param array          $query        Parameters on a query to be added to the URL
-     * @param array         &$extraHeaders Any extra headers to send along with the request
+     * @param array          $extraHeaders Any extra headers to send along with the request
      * @param int|null       $tries        How many times to attempt the request
      *
      * @return HttpResponse
@@ -44,7 +44,7 @@ public function __construct(
     public function query(
         string | array $data,
         array $query = [],
-        array &$extraHeaders = [],
+        array $extraHeaders = [],
         ?int $tries = null
     ): HttpResponse {
         if (empty($data)) {
@@ -71,6 +71,40 @@ public function query(
         );
     }
 
+    /**
+     * Proxy string query to this client's domain.
+     *
+     * @param string   $data         Query to be posted to endpoint
+     * @param array    $extraHeaders Any extra headers to send along with the request
+     * @param int|null $tries        How many times to attempt the request
+     *
+     * @return \Shopify\Clients\HttpResponse
+     * @throws \Psr\Http\Client\ClientExceptionInterface
+     * @throws \Shopify\Exception\MissingArgumentException
+     * @throws \Shopify\Exception\UninitializedContextException
+     */
+    public function proxy(
+        string $data,
+        array $extraHeaders = [],
+        ?int $tries = null
+    ): HttpResponse {
+        if (empty($data)) {
+            throw new MissingArgumentException('Query missing');
+        }
+
+        list($accessTokenHeader, $accessToken) = $this->getAccessTokenHeader();
+        $extraHeaders[$accessTokenHeader] = $accessToken;
+
+        return $this->client->post(
+            path: $this->getApiPath(),
+            body: $data,
+            dataType: Http::DATA_TYPE_JSON,
+            headers: $extraHeaders,
+            tries: $tries,
+            query: [],
+        );
+    }
+
     /**
      * Fetches the URL path to be used for API requests.
      *

src/Utils.php

@@ -169,9 +169,11 @@ public static function decodeSessionToken(string $jwt): array
      * @param string $rawBody    The raw HTTP request payload
      *
      * @return HttpResponse
+     * @throws \Psr\Http\Client\ClientExceptionInterface
      * @throws \Shopify\Exception\CookieNotFoundException
      * @throws \Shopify\Exception\MissingArgumentException
      * @throws \Shopify\Exception\SessionNotFoundException
+     * @throws \Shopify\Exception\UninitializedContextException
      */
     public static function graphqlProxy(array $rawHeaders, array $cookies, string $rawBody): HttpResponse
     {
@@ -182,8 +184,6 @@ public static function graphqlProxy(array $rawHeaders, array $cookies, string $r
 
         $client = new Graphql($session->getShop(), $session->getAccessToken());
 
-        // If the body is not JSON, we forward it as a string
-        $parsedBody = json_decode($rawBody, true) ?: $rawBody;
-        return $client->query(data: $parsedBody);
+        return $client->proxy(data: $rawBody);
     }
 }

tests/Clients/GraphqlTest.php

@@ -190,4 +190,41 @@ public function testCanQueryWithExtraHeaders()
             new HttpResponseMatcher(decodedBody: json_decode($this->querySuccessResponse, true))
         );
     }
+
+    public function testProxyForwardsBodyAsJsonType()
+    {
+        $queryToProxy = <<<QUERY
+        {
+          "variables": {},
+          "query": "{\nshop {\n    name\n    __typename\n  }\n}"
+        }
+        QUERY;
+
+        $extraHeaders = ['Extra-Extra' => 'hear_all_about_it'];
+        $client = new Graphql($this->domain, 'token');
+
+        $this->mockTransportRequests(
+            [
+                new MockRequest(
+                    response: $this->buildMockHttpResponse(200, json_decode($this->querySuccessResponse, true)),
+                    url: "https://$this->domain/admin/api/" . Context::$API_VERSION . '/graphql.json',
+                    method: 'POST',
+                    userAgent: "Shopify Admin API Library for PHP v$this->version",
+                    headers: [
+                                  'Content-Type: application/json',
+                                  'Content-Length: ' . strlen($queryToProxy),
+                                  'Extra-Extra: hear_all_about_it',
+                                  'X-Shopify-Access-Token: token'
+                              ],
+                    body: $queryToProxy
+                )
+            ]
+        );
+
+        $response = $client->proxy(data: $queryToProxy, extraHeaders: $extraHeaders);
+        $this->assertThat(
+            $response,
+            new HttpResponseMatcher(decodedBody: json_decode($this->querySuccessResponse, true))
+        );
+    }
 }

tests/UtilsTest.php

@@ -275,7 +275,7 @@ public function testGraphqlProxyFetchesDataWithJWT()
                 url: "https://$this->domain/admin/api/" . Context::$API_VERSION . '/graphql.json',
                 method: 'POST',
                 headers: [
-                    'Content-Type: application/graphql',
+                    'Content-Type: application/json',
                     'Content-Length: ' . strlen($this->testGraphqlQuery),
                     'X-Shopify-Access-Token: token',
                 ],
@@ -312,7 +312,7 @@ public function testGraphqlProxyFetchesDataWithCookies()
                 url: "https://$this->domain/admin/api/" . Context::$API_VERSION . '/graphql.json',
                 method: 'POST',
                 headers: [
-                    'Content-Type: application/graphql',
+                    'Content-Type: application/json',
                     'Content-Length: ' . strlen($this->testGraphqlQuery),
                     'X-Shopify-Access-Token: token',
                 ],