Merge pull request #1084 from Shopify/ml-graphql-client-error-response

[GraphQL Client] Add raw response object to ResponseError
Shopify · Dec 4, 2023 · 1c4f8de · 1c4f8de
2 parents d75efce + 2b9e06f
commit 1c4f8de
Show file tree

Hide file tree

Showing 7 changed files with 19 additions and 0 deletions.
diff --git a/.changeset/purple-bears-end.md b/.changeset/purple-bears-end.md
@@ -0,0 +1,7 @@
+---
+"@shopify/storefront-api-client": minor
+"@shopify/admin-api-client": minor
+"@shopify/graphql-client": minor
+---
+
+Add the raw network response object to `ResponseErrors`
diff --git a/packages/admin-api-client/README.md b/packages/admin-api-client/README.md
@@ -99,6 +99,7 @@ const {data, errors, extensions} = await client.request(operation, {
 | networkStatusCode?       | `number`        | HTTP response status code                                                             |
 | message?      | `string`       | The provided error message                                                       |
 | graphQLErrors? | `any[]` | The GraphQL API errors returned by the server |
+| response? | `Response` | The raw response object from the network fetch call |
 
 ### Client `request()` response examples
 

diff --git a/packages/graphql-client/README.md b/packages/graphql-client/README.md
@@ -68,6 +68,7 @@ const client = createGraphQLClient({
 | networkStatusCode?       | `number`        | HTTP response status code                                                             |
 | message?      | `string`       | The provided error message                                                       |
 | graphQLErrors? | `any[]` | The GraphQL API errors returned by the server |
+| response? | `Response` | The raw response object from the network fetch call |
 
 
 ## Usage examples

diff --git a/packages/graphql-client/src/graphql-client/graphql-client.ts b/packages/graphql-client/src/graphql-client/graphql-client.ts
@@ -68,6 +68,7 @@ async function processJSONResponse<TData = any>(
               ? GQL_API_ERROR
               : `${CLIENT}: An unknown error has occurred. The API did not return a data object or any errors in its response.`,
             ...(errors ? { graphQLErrors: errors } : {}),
+            response,
           },
         }
       : {}),
@@ -191,6 +192,7 @@ function generateRequest(
           errors: {
             networkStatusCode: status,
             message: statusText,
+            response,
           },
         };
       }
@@ -200,6 +202,7 @@ function generateRequest(
           errors: {
             networkStatusCode: status,
             message: `${UNEXPECTED_CONTENT_TYPE_ERROR} ${contentType}`,
+            response,
           },
         };
       }

diff --git a/packages/graphql-client/src/graphql-client/tests/graphql-client.test.ts b/packages/graphql-client/src/graphql-client/tests/graphql-client.test.ts
@@ -806,6 +806,7 @@ describe("GraphQL Client", () => {
             expect(response).toHaveProperty("errors", {
               networkStatusCode: responseConfig.status,
               message: responseConfig.statusText,
+              response: mockedSuccessResponse,
             });
           });
 
@@ -840,6 +841,7 @@ describe("GraphQL Client", () => {
             expect(response).toHaveProperty("errors", {
               networkStatusCode: responseConfig.status,
               message: `GraphQL Client: Response returned unexpected Content-Type: ${contentType}`,
+              response: mockedSuccessResponse,
             });
           });
 
@@ -865,6 +867,7 @@ describe("GraphQL Client", () => {
               message:
                 "GraphQL Client: An error occurred while fetching from the API. Review 'graphQLErrors' for details.",
               graphQLErrors: gqlError,
+              response: mockedSuccessResponse,
             });
           });
 
@@ -887,6 +890,7 @@ describe("GraphQL Client", () => {
               networkStatusCode: mockedSuccessResponse.status,
               message:
                 "GraphQL Client: An unknown error has occurred. The API did not return a data object or any errors in its response.",
+              response: mockedSuccessResponse,
             });
           });
 
@@ -915,6 +919,7 @@ describe("GraphQL Client", () => {
               message:
                 "GraphQL Client: An error occurred while fetching from the API. Review 'graphQLErrors' for details.",
               graphQLErrors: gqlError,
+              response: mockedSuccessResponse,
             });
           });
         });

diff --git a/packages/graphql-client/src/graphql-client/types.ts b/packages/graphql-client/src/graphql-client/types.ts
@@ -19,6 +19,7 @@ export interface ResponseErrors {
   networkStatusCode?: number;
   message?: string;
   graphQLErrors?: any[];
+  response?: Response;
 }
 
 export interface GQLExtensions {

diff --git a/packages/storefront-api-client/README.md b/packages/storefront-api-client/README.md
@@ -98,6 +98,7 @@ const client = createStorefrontApiClient({
 | networkStatusCode?       | `number`        | HTTP response status code                                                             |
 | message?      | `string`       | The provided error message                                                       |
 | graphQLErrors? | `any[]` | The GraphQL API errors returned by the server |
+| response? | `Response` | The raw response object from the network fetch call |
 
 ### Client `request()` response examples