Merge pull request #1330 from 5n00p4eg/error-handler

Fix error handler in graphql client

Author: paulomarg

.changeset/pretty-geese-look.md

@@ -0,0 +1,7 @@
+---
+"@shopify/shopify-api": patch
+"@shopify/admin-api-client": patch
+"@shopify/graphql-client": patch
+---
+
+Fix type error in graphql error handler

packages/shopify-api/lib/auth/oauth/oauth.ts

@@ -203,7 +203,7 @@ export function callback(config: ConfigInterface): OAuthCallback {
     );
 
     if (!postResponse.ok) {
-      throwFailedRequest(await postResponse.json(), postResponse, false);
+      throwFailedRequest(await postResponse.json(), false, postResponse);
     }
 
     const session: Session = createSession({

packages/shopify-api/lib/auth/oauth/token-exchange.ts

@@ -60,7 +60,7 @@ export function tokenExchange(config: ConfigInterface): TokenExchange {
     );
 
     if (!postResponse.ok) {
-      throwFailedRequest(await postResponse.json(), postResponse, false);
+      throwFailedRequest(await postResponse.json(), false, postResponse);
     }
 
     return {

packages/shopify-api/lib/clients/admin/__tests__/admin_graphql_client.test.ts

@@ -1,15 +1,18 @@
+import {FetchError} from 'node-fetch';
+
 import * as ShopifyErrors from '../../../error';
 import {
   ApiVersion,
   LATEST_API_VERSION,
   LogSeverity,
   ShopifyHeader,
 } from '../../../types';
-import {queueMockResponse} from '../../../__tests__/test-helper';
+import {queueError, queueMockResponse} from '../../../__tests__/test-helper';
 import {testConfig} from '../../../__tests__/test-config';
 import {Session} from '../../../session/session';
 import {JwtPayload} from '../../../session/types';
 import {DataType, shopifyApi} from '../../..';
+import {HttpRequestError} from '../../../error';
 
 const domain = 'test-shop.myshopify.io';
 const QUERY = `
@@ -259,6 +262,34 @@ describe('GraphQL client', () => {
     }).toMatchMadeHttpRequest();
   });
 
+  it('throws error if no response is available', async () => {
+    const shopify = shopifyApi(testConfig());
+
+    const client = new shopify.clients.Graphql({session});
+    const query = `query getProducts {
+      products {
+        edges {
+          node {
+            id
+          }
+        }
+      }
+    }`;
+
+    queueError(
+      new FetchError(
+        `uri requested responds with an invalid redirect URL: http://test.com`,
+        'invalid-redirect',
+      ),
+    );
+
+    const request = async () => {
+      await client.request(query);
+    };
+
+    await expect(request).rejects.toThrow(HttpRequestError);
+  });
+
   it('allows overriding the API version', async () => {
     const shopify = shopifyApi(testConfig());
 

packages/shopify-api/lib/clients/admin/graphql/client.ts

@@ -122,8 +122,9 @@ export class GraphqlClient {
     });
 
     if (response.errors) {
-      const fetchResponse = response.errors.response!;
-      throwFailedRequest(response, fetchResponse, (options?.retries ?? 0) > 0);
+      const fetchResponse = response.errors.response;
+
+      throwFailedRequest(response, (options?.retries ?? 0) > 0, fetchResponse);
     }
 
     return response;

packages/shopify-api/lib/clients/admin/rest/client.ts

@@ -172,7 +172,7 @@ export class RestClient {
     );
 
     if (!response.ok) {
-      throwFailedRequest(body, response, (params.tries ?? 1) > 1);
+      throwFailedRequest(body, (params.tries ?? 1) > 1, response);
     }
 
     const requestReturn: RestRequestReturn<T> = {

packages/shopify-api/lib/clients/common.ts

@@ -58,9 +58,18 @@ export function clientLoggerFactory(config: ConfigInterface) {
 
 export function throwFailedRequest(
   body: any,
-  response: Response,
   atMaxRetries: boolean,
+  response?: Response,
 ): never {
+  if (typeof response === 'undefined') {
+    throw new ShopifyErrors.HttpRequestError(
+      'Http request error, no response available',
+      {
+        body,
+      },
+    );
+  }
+
   const responseHeaders = canonicalizeHeaders(
     Object.fromEntries(response.headers.entries() ?? []),
   );

packages/shopify-api/lib/clients/storefront/__tests__/storefront_client.test.ts

@@ -1,4 +1,6 @@
-import {queueMockResponse} from '../../../__tests__/test-helper';
+import {FetchError} from 'node-fetch';
+
+import {queueError, queueMockResponse} from '../../../__tests__/test-helper';
 import {testConfig} from '../../../__tests__/test-config';
 import {
   ApiVersion,
@@ -8,7 +10,7 @@ import {
 } from '../../../types';
 import {Session} from '../../../session/session';
 import {JwtPayload} from '../../../session/types';
-import {MissingRequiredArgument} from '../../../error';
+import {HttpRequestError, MissingRequiredArgument} from '../../../error';
 import {shopifyApi} from '../../../index';
 
 const domain = 'test-shop.myshopify.io';
@@ -170,4 +172,26 @@ describe('Storefront GraphQL client', () => {
       ),
     );
   });
+
+  it('throws error if no response is available', async () => {
+    const shopify = shopifyApi(testConfig());
+
+    const client = new shopify.clients.Storefront({
+      session,
+      apiVersion: '2020-01' as any as ApiVersion,
+    });
+
+    queueError(
+      new FetchError(
+        `uri requested responds with an invalid redirect URL: http://test.com`,
+        'invalid-redirect',
+      ),
+    );
+
+    const request = async () => {
+      await client.request(QUERY);
+    };
+
+    await expect(request).rejects.toThrow(HttpRequestError);
+  });
 });

packages/shopify-api/lib/clients/storefront/client.ts

@@ -137,8 +137,9 @@ export class StorefrontClient {
     });
 
     if (response.errors) {
-      const fetchResponse = response.errors.response!;
-      throwFailedRequest(response, fetchResponse, (options?.retries ?? 0) > 0);
+      const fetchResponse = response.errors.response;
+
+      throwFailedRequest(response, (options?.retries ?? 0) > 0, fetchResponse);
     }
 
     return response;