Shared HTTP client with retries (#5097)

graphql-hive · Jun 27, 2024 · b8998e7 · b8998e7
1 parent bc2db5d
commit b8998e7
Show file tree

Hide file tree

Showing 15 changed files with 207 additions and 131 deletions.
diff --git a/.changeset/good-hairs-deliver.md b/.changeset/good-hairs-deliver.md
@@ -0,0 +1,6 @@
+---
+'@graphql-hive/apollo': patch
+'@graphql-hive/yoga': patch
+---
+
+Use built-in retry of http client of the core package
diff --git a/.changeset/selfish-shoes-pump.md b/.changeset/selfish-shoes-pump.md
@@ -0,0 +1,5 @@
+---
+'@graphql-hive/cli': patch
+---
+
+Retry up to 3 times a GET request in the artifact:fetch command
diff --git a/.changeset/tidy-worms-add.md b/.changeset/tidy-worms-add.md
@@ -0,0 +1,5 @@
+---
+'@graphql-hive/core': minor
+---
+
+Add retry mechanism to the http client
diff --git a/packages/libraries/apollo/src/index.ts b/packages/libraries/apollo/src/index.ts
@@ -29,7 +29,7 @@ export function createSupergraphSDLFetcher(options: SupergraphSDLFetcherOptions)
     ? options.endpoint
     : joinUrl(options.endpoint, 'supergraph');
 
-  return function supergraphSDLFetcher() {
+  return function supergraphSDLFetcher(): Promise<{ id: string; supergraphSdl: string }> {
     const headers: {
       [key: string]: string;
     } = {
@@ -41,49 +41,42 @@ export function createSupergraphSDLFetcher(options: SupergraphSDLFetcherOptions)
       headers['If-None-Match'] = cacheETag;
     }
 
-    let retryCount = 0;
-
-    const retry = (status: number) => {
-      if (retryCount >= 10 || status < 499) {
-        return Promise.reject(new Error(`Failed to fetch [${status}]`));
-      }
-
-      retryCount = retryCount + 1;
-
-      return fetchWithRetry();
-    };
-
-    const fetchWithRetry = (): Promise<{ id: string; supergraphSdl: string }> => {
-      return http
-        .get(endpoint, {
-          headers,
-        })
-        .then(async response => {
-          if (response.ok) {
-            const supergraphSdl = await response.text();
-            const result = {
-              id: await createHash('SHA-256').update(supergraphSdl).digest('base64'),
-              supergraphSdl,
-            };
-
-            const etag = response.headers.get('etag');
-            if (etag) {
-              cached = result;
-              cacheETag = etag;
-            }
+    return http
+      .get(endpoint, {
+        headers,
+        retry: {
+          retryWhen: response => response.status >= 500,
+          okWhen: response => response.status === 304,
+          retries: 10,
+          maxTimeout: 200,
+          minTimeout: 1,
+        },
+      })
+      .then(async response => {
+        if (response.ok) {
+          const supergraphSdl = await response.text();
+          const result = {
+            id: await createHash('SHA-256').update(supergraphSdl).digest('base64'),
+            supergraphSdl,
+          };
 
-            return result;
+          const etag = response.headers.get('etag');
+          if (etag) {
+            cached = result;
+            cacheETag = etag;
           }
 
-          if (response.status === 304 && cached !== null) {
-            return cached;
-          }
+          return result;
+        }
 
-          return retry(response.status);
-        });
-    };
+        if (response.status === 304 && cached !== null) {
+          return cached;
+        }
 
-    return fetchWithRetry();
+        throw new Error(
+          `Failed to GET ${endpoint}, received: ${response.status} ${response.statusText ?? 'Internal Server Error'}`,
+        );
+      });
   };
 }
 

diff --git a/packages/libraries/apollo/tests/apollo.spec.ts b/packages/libraries/apollo/tests/apollo.spec.ts
@@ -11,6 +11,7 @@ import { ApolloServer } from '@apollo/server';
 import { expressMiddleware } from '@apollo/server/express4';
 import { ApolloServerPluginDrainHttpServer } from '@apollo/server/plugin/drainHttpServer';
 import { startStandaloneServer } from '@apollo/server/standalone';
+import { http } from '@graphql-hive/core';
 import { makeExecutableSchema } from '@graphql-tools/schema';
 import { createHive, createSupergraphSDLFetcher, useHive } from '../src';
 import { version } from '../src/version';
@@ -139,21 +140,23 @@ test('should capture client name and version headers', async () => {
 
   await startStandaloneServer(apollo);
 
-  await fetch('http://localhost:4000/graphql', {
-    method: 'POST',
-    body: JSON.stringify({
+  await http.post(
+    'http://localhost:4000/graphql',
+    JSON.stringify({
       query: /* GraphQL */ `
         {
           hello
         }
       `,
     }),
-    headers: {
-      'content-type': 'application/json',
-      'x-graphql-client-name': 'vitest',
-      'x-graphql-client-version': '1.0.0',
+    {
+      headers: {
+        'content-type': 'application/json',
+        'x-graphql-client-name': 'vitest',
+        'x-graphql-client-version': '1.0.0',
+      },
     },
-  });
+  );
 
   await waitFor(50);
   await apollo.stop();
@@ -295,7 +298,9 @@ describe('supergraph SDL fetcher', async () => {
     try {
       await fetcher();
     } catch (err) {
-      expect(err).toMatchInlineSnapshot(`[Error: Failed to fetch [500]]`);
+      expect(err).toMatchInlineSnapshot(
+        `[Error: Failed to fetch http://localhost/supergraph, received: 500 Internal Server Error]`,
+      );
     }
   });
 });
@@ -667,17 +672,19 @@ describe('built-in HTTP usage reporting', async () => {
       });
 
       (async () => {
-        const response = await fetch(url, {
-          method: 'POST',
-          headers: {
-            'Content-Type': 'application/json',
-            'x-graphql-client-version': '4.2.0',
-            'x-graphql-client-name': 'apollo-client',
-          },
-          body: JSON.stringify({
+        const response = await http.post(
+          url,
+          JSON.stringify({
             query: '{hi}',
           }),
-        });
+          {
+            headers: {
+              'Content-Type': 'application/json',
+              'x-graphql-client-version': '4.2.0',
+              'x-graphql-client-name': 'apollo-client',
+            },
+          },
+        );
 
         expect(response.status).toBe(200);
         expect(await response.json()).toEqual({

diff --git a/packages/libraries/cli/package.json b/packages/libraries/cli/package.json
@@ -57,7 +57,6 @@
     "@oclif/core": "^3.26.6",
     "@oclif/plugin-help": "6.0.22",
     "@oclif/plugin-update": "4.2.13",
-    "@whatwg-node/fetch": "0.9.18",
     "colors": "1.4.0",
     "env-ci": "7.3.0",
     "graphql": "^16.8.1",

diff --git a/packages/libraries/cli/src/base-command.ts b/packages/libraries/cli/src/base-command.ts
@@ -1,9 +1,9 @@
 import colors from 'colors';
 import { print, type GraphQLError } from 'graphql';
 import type { ExecutionResult } from 'graphql';
+import { http } from '@graphql-hive/core';
 import type { TypedDocumentNode } from '@graphql-typed-document-node/core';
 import { Command, Errors, Config as OclifConfig } from '@oclif/core';
-import { fetch } from '@whatwg-node/fetch';
 import { Config, GetConfigurationValueType, ValidConfigurationKeys } from './helpers/config';
 
 type OmitNever<T> = { [K in keyof T as T[K] extends never ? never : K]: T[K] };
@@ -166,14 +166,16 @@ export default abstract class extends Command {
         operation: TypedDocumentNode<TResult, TVariables>,
         ...[variables]: TVariables extends Record<string, never> ? [] : [TVariables]
       ): Promise<TResult> {
-        const response = await fetch(endpoint, {
-          headers: requestHeaders,
-          method: 'POST',
-          body: JSON.stringify({
+        const response = await http.post(
+          endpoint,
+          JSON.stringify({
             query: typeof operation === 'string' ? operation : print(operation),
             variables,
           }),
-        });
+          {
+            headers: requestHeaders,
+          },
+        );
 
         if (!response.ok) {
           throw new Error(`Invalid status code for HTTP call: ${response.status}`);

diff --git a/packages/libraries/cli/src/commands/artifact/fetch.ts b/packages/libraries/cli/src/commands/artifact/fetch.ts
@@ -1,5 +1,5 @@
+import { http, URL } from '@graphql-hive/core';
 import { Flags } from '@oclif/core';
-import { fetch, URL } from '@whatwg-node/fetch';
 import Command from '../../base-command';
 
 export default class ArtifactsFetch extends Command {
@@ -40,11 +40,17 @@ export default class ArtifactsFetch extends Command {
 
     const url = new URL(`${cdnEndpoint}/${artifactType}`);
 
-    const response = await fetch(url.toString(), {
+    const response = await http.get(url.toString(), {
       headers: {
         'x-hive-cdn-key': token,
         'User-Agent': `hive-cli/${this.config.version}`,
       },
+      retry: {
+        retries: 3,
+        retryWhen(response) {
+          return response.status >= 500;
+        },
+      },
     });
 
     if (response.status >= 300) {

diff --git a/packages/libraries/core/package.json b/packages/libraries/core/package.json
@@ -54,6 +54,7 @@
   "devDependencies": {
     "@apollo/federation": "0.38.1",
     "@apollo/subgraph": "2.8.1",
+    "@types/async-retry": "1.4.8",
     "@types/lodash.sortby": "4.7.9",
     "graphql": "16.9.0",
     "nock": "14.0.0-beta.7",

diff --git a/packages/libraries/core/src/client/gateways.ts b/packages/libraries/core/src/client/gateways.ts
@@ -33,45 +33,38 @@ function createFetcher(options: SchemaFetcherOptions & ServicesFetcherOptions) {
       headers['If-None-Match'] = cacheETag;
     }
 
-    let retryCount = 0;
-
-    const retry = (status: number) => {
-      if (retryCount >= 10 || status < 499) {
-        return Promise.reject(new Error(`Failed to fetch [${status}]`));
-      }
-
-      retryCount = retryCount + 1;
-
-      return fetchWithRetry();
-    };
-
-    const fetchWithRetry = (): Promise<readonly Schema[] | Schema> => {
-      return http
-        .get(endpoint, {
-          headers,
-        })
-        .then(async response => {
-          if (response.ok) {
-            const result = await response.json();
-
-            const etag = response.headers.get('etag');
-            if (etag) {
-              cached = result;
-              cacheETag = etag;
-            }
-
-            return result;
+    return http
+      .get(endpoint, {
+        headers,
+        retry: {
+          retryWhen: response => response.status >= 500,
+          okWhen: response => response.status === 304,
+          retries: 10,
+          maxTimeout: 200,
+          minTimeout: 1,
+        },
+      })
+      .then(async response => {
+        if (response.ok) {
+          const result = await response.json();
+
+          const etag = response.headers.get('etag');
+          if (etag) {
+            cached = result;
+            cacheETag = etag;
           }
 
-          if (response.status === 304 && cached !== null) {
-            return cached;
-          }
+          return result;
+        }
 
-          return retry(response.status);
-        });
-    };
+        if (response.status === 304 && cached !== null) {
+          return cached;
+        }
 
-    return fetchWithRetry();
+        throw new Error(
+          `Failed to GET ${endpoint}, received: ${response.status} ${response.statusText ?? 'Internal Server Error'}`,
+        );
+      });
   };
 }