GET request deduplication, pass 'context' as 3rd param in JSON Schema…

… handler and expose HTTP details via extensions (#4356) * GET request deduplication and pass 'context' as 3rd param in JSON Schema handler * Improvements * Go * Go * chore(dependencies): updated changesets for modified dependencies * go go go * Cleanup * chore(dependencies): updated changesets for modified dependencies * Add more tests * chore(dependencies): updated changesets for modified dependencies * Go * chore(dependencies): updated changesets for modified dependencies Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
ardatan · Aug 24, 2022 · b5c59ff · b5c59ff · vercel · Aug 24, 2022
1 parent 0b96c33
commit b5c59ff
Show file tree

Hide file tree

Showing 35 changed files with 590 additions and 101 deletions.
diff --git a/.changeset/@graphql-mesh_config-4356-dependencies.md b/.changeset/@graphql-mesh_config-4356-dependencies.md
@@ -0,0 +1,8 @@
+---
+"@graphql-mesh/config": patch
+---
+
+dependencies updates: 
+
+- Removed dependency [`@whatwg-node/fetch@^0.3.0` ↗︎](https://www.npmjs.com/package/@whatwg-node/fetch/v/null) (from `dependencies`)
+- Removed dependency [`[email protected]` ↗︎](https://www.npmjs.com/package/fetchache/v/0.1.2) (from `dependencies`)
diff --git a/.changeset/@graphql-mesh_runtime-4356-dependencies.md b/.changeset/@graphql-mesh_runtime-4356-dependencies.md
@@ -0,0 +1,7 @@
+---
+"@graphql-mesh/runtime": patch
+---
+
+dependencies updates: 
+
+- Added dependency [`@graphql-mesh/[email protected]` ↗︎](https://www.npmjs.com/package/@graphql-mesh/cross-helpers/v/0.2.2) (to `dependencies`)
diff --git a/.changeset/@graphql-mesh_utils-4356-dependencies.md b/.changeset/@graphql-mesh_utils-4356-dependencies.md
@@ -0,0 +1,8 @@
+---
+"@graphql-mesh/utils": patch
+---
+
+dependencies updates: 
+
+- Added dependency [`[email protected]` ↗︎](https://www.npmjs.com/package/fetchache/v/0.1.2) (to `dependencies`)
+- Added dependency [`@whatwg-node/[email protected]` ↗︎](https://www.npmjs.com/package/@whatwg-node/fetch/v/0.3.2) (to `dependencies`)
diff --git a/.changeset/odd-cheetahs-heal.md b/.changeset/odd-cheetahs-heal.md
@@ -0,0 +1,24 @@
+---
+"@graphql-mesh/config": minor
+"@graphql-mesh/graphql": minor
+"@graphql-mesh/json-schema": minor
+"@graphql-mesh/neo4j": minor
+"@graphql-mesh/odata": minor
+"@graphql-mesh/openapi": minor
+"@graphql-mesh/raml": minor
+"@graphql-mesh/soap": minor
+"@graphql-mesh/thrift": minor
+"@omnigraph/json-schema": minor
+"@graphql-mesh/utils": minor
+---
+
+## Improvements on outgoing HTTP calls
+
+- Now Mesh's default fetch implementation deduplicates the same GET JSON requests in the same execution context
+ - You should pass `Accept: application/json` to make this work.
+- JSON Schema, new OpenAPI and RAML handlers now take GraphQL context as 3rd parameter. If you use `customFetch`, you can use that value to access Mesh internals such as the incoming `Request` object.
+
+## HTTP Details in extensions for tracking HTTP calls
+
+You can add `includeHttpDetailsInExtensions: true` to your configuration file to get more information about HTTP calls done by Mesh during the execution in `extensions` field of the response.
+
diff --git a/packages/config/package.json b/packages/config/package.json
@@ -40,8 +40,6 @@
     "@graphql-tools/load": "7.7.4",
     "@graphql-tools/code-file-loader": "7.3.3",
     "@graphql-tools/graphql-file-loader": "7.5.2",
-    "@whatwg-node/fetch": "^0.3.0",
-    "fetchache": "0.1.2",
     "param-case": "3.0.4",
     "@envelop/core": "2.5.0",
     "tslib": "^2.4.0",

diff --git a/packages/config/src/process.ts b/packages/config/src/process.ts
@@ -73,6 +73,7 @@ export type ProcessedConfig = {
   store: MeshStore;
   code: string;
   additionalEnvelopPlugins: EnvelopPlugins;
+  includeHttpDetailsInExtensions: boolean;
 };
 
 function getDefaultMeshStore(dir: string, importFn: ImportFn, artifactsDir: string) {
@@ -608,6 +609,7 @@ export async function processConfig(
     logger,
     store: rootStore,
     additionalEnvelopPlugins,
+    includeHttpDetailsInExtensions: config.includeHttpDetailsInExtensions,
     code: [...new Set([...importCodes, ...codes])].join('\n'),
   };
 }
diff --git a/packages/config/src/utils.ts b/packages/config/src/utils.ts
@@ -4,11 +4,9 @@ import { printSchemaWithDirectives, Source } from '@graphql-tools/utils';
 import { paramCase } from 'param-case';
 import { loadDocuments, loadTypedefs } from '@graphql-tools/load';
 import { GraphQLFileLoader } from '@graphql-tools/graphql-file-loader';
-import { PubSub, DefaultLogger, parseWithCache } from '@graphql-mesh/utils';
+import { PubSub, DefaultLogger, parseWithCache, createDefaultMeshFetch, MeshFetch } from '@graphql-mesh/utils';
 import { CodeFileLoader } from '@graphql-tools/code-file-loader';
 import { MeshStore } from '@graphql-mesh/store';
-import { fetch, Request, Response } from '@whatwg-node/fetch';
-import { fetchFactory } from 'fetchache';
 
 type ResolvedPackage<T> = {
   moduleName: string;
@@ -98,26 +96,20 @@ export async function resolveCustomFetch({
   additionalPackagePrefixes: string[];
   cache: KeyValueCache;
 }): Promise<{
-  fetchFn: ReturnType<typeof fetchFactory>;
+  fetchFn: MeshFetch;
   importCode: string;
   code: string;
 }> {
   let importCode = '';
   if (!fetchConfig) {
-    importCode += `import { fetchFactory } from 'fetchache';\n`;
-    importCode += `import { fetch, Request, Response } from '@whatwg-node/fetch';\n`;
+    importCode += `import { createDefaultMeshFetch } from '@graphql-mesh/utils';\n`;
     return {
-      fetchFn: fetchFactory({
-        cache,
-        fetch,
-        Request,
-        Response,
-      }),
+      fetchFn: createDefaultMeshFetch(cache),
       importCode,
-      code: `const fetchFn = fetchFactory({ cache, fetch, Request, Response });`,
+      code: `const fetchFn = createDefaultMeshFetch(cache);`,
     };
   }
-  const { moduleName, resolved: fetchFn } = await getPackage<ReturnType<typeof fetchFactory>>({
+  const { moduleName, resolved: fetchFn } = await getPackage<MeshFetch>({
     name: fetchConfig,
     type: 'fetch',
     importFn,

diff --git a/packages/config/yaml-config.graphql b/packages/config/yaml-config.graphql
@@ -43,6 +43,10 @@ type Query {
   """
   customFetch: Any
   """
+  Include HTTP details to the extensions
+  """
+  includeHttpDetailsInExtensions: Boolean
+  """
   Allow connections to an SSL endpoint without certificates
   """
   skipSSLValidation: Boolean

diff --git a/packages/handlers/graphql/src/index.ts b/packages/handlers/graphql/src/index.ts
@@ -10,16 +10,18 @@ import {
   buildClientSchema,
   ExecutionResult,
   SelectionNode,
+  GraphQLResolveInfo,
 } from 'graphql';
 import { introspectSchema } from '@graphql-tools/wrap';
-import { loadFromModuleExportExpression, readFileOrUrl } from '@graphql-mesh/utils';
+import { loadFromModuleExportExpression, MeshFetch, readFileOrUrl } from '@graphql-mesh/utils';
 import {
   ExecutionRequest,
   isDocumentNode,
   memoize1,
   getOperationASTFromRequest,
   parseSelectionSet,
   isAsyncIterable,
+  Executor,
 } from '@graphql-tools/utils';
 import { PredefinedProxyOptions, StoreProxy } from '@graphql-mesh/store';
 import lodashGet from 'lodash.get';
@@ -40,22 +42,25 @@ const getResolverData = memoize1(function getResolverData(params: ExecutionReque
 });
 
 export default class GraphQLHandler implements MeshHandler {
+  private name: string;
   private config: YamlConfig.Handler['graphql'];
   private baseDir: string;
   private nonExecutableSchema: StoreProxy<GraphQLSchema>;
   private importFn: ImportFn;
-  private fetchFn: typeof fetch;
+  private fetchFn: MeshFetch;
   private logger: Logger;
   private urlLoader = new UrlLoader();
 
   constructor({
+    name,
     config,
     baseDir,
     fetchFn,
     store,
     importFn,
     logger,
   }: GetMeshSourceOptions<YamlConfig.Handler['graphql']>) {
+    this.name = name;
     this.config = config;
     this.baseDir = baseDir;
     this.fetchFn = fetchFn;
@@ -70,6 +75,15 @@ export default class GraphQLHandler implements MeshHandler {
     return parseInterpolationStrings(this.interpolationStringSet);
   }
 
+  private wrapExecutorToPassSourceName(executor: Executor) {
+    const sourceName = this.name;
+    return function executorWithSourceName(executionRequest: ExecutionRequest) {
+      executionRequest.info = executionRequest.info || ({} as GraphQLResolveInfo);
+      (executionRequest.info as any).sourceName = sourceName;
+      return executor(executionRequest);
+    };
+  }
+
   async getExecutorForHTTPSourceConfig(
     httpSourceConfig: YamlConfig.GraphQLHandlerHTTPConfiguration
   ): Promise<MeshSource['executor']> {
@@ -309,7 +323,7 @@ export default class GraphQLHandler implements MeshHandler {
 
         return {
           schema,
-          executor: highestValueExecutor,
+          executor: this.wrapExecutorToPassSourceName(highestValueExecutor),
           // Batching doesn't make sense with fallback strategy
           batch: false,
           contextVariables,
@@ -364,7 +378,7 @@ export default class GraphQLHandler implements MeshHandler {
 
       return {
         schema: schemaResult.value,
-        executor: executorResult.value,
+        executor: this.wrapExecutorToPassSourceName(executorResult.value),
         batch: this.config.batch != null ? this.config.batch : true,
         contextVariables,
       };

diff --git a/packages/handlers/json-schema/src/index.ts b/packages/handlers/json-schema/src/index.ts
@@ -1,7 +1,7 @@
 import { PredefinedProxyOptions, StoreProxy } from '@graphql-mesh/store';
 import { GetMeshSourceOptions, ImportFn, Logger, MeshHandler, MeshPubSub, YamlConfig } from '@graphql-mesh/types';
 import { JSONSchemaLoaderBundle, createBundle, getGraphQLSchemaFromBundle } from '@omnigraph/json-schema';
-import { loadFromModuleExportExpression, readFileOrUrl } from '@graphql-mesh/utils';
+import { loadFromModuleExportExpression, MeshFetch, readFileOrUrl } from '@graphql-mesh/utils';
 import { getInterpolatedHeadersFactory } from '@graphql-mesh/string-interpolation';
 import { process } from '@graphql-mesh/cross-helpers';
 
@@ -11,7 +11,7 @@ export default class JsonSchemaHandler implements MeshHandler {
   private bundleStoreProxy: StoreProxy<JSONSchemaLoaderBundle>;
   private baseDir: string;
   private logger: Logger;
-  private fetchFn: typeof fetch;
+  private fetchFn: MeshFetch;
   private importFn: ImportFn;
   private pubsub: MeshPubSub;
 

diff --git a/packages/handlers/neo4j/src/index.ts b/packages/handlers/neo4j/src/index.ts
@@ -3,7 +3,7 @@ import { Neo4jGraphQL } from '@neo4j/graphql';
 import neo4j, { Driver } from 'neo4j-driver';
 import { YamlConfig, MeshHandler, GetMeshSourceOptions, MeshPubSub, Logger, ImportFn } from '@graphql-mesh/types';
 import { PredefinedProxyOptions, StoreProxy } from '@graphql-mesh/store';
-import { readFileOrUrl } from '@graphql-mesh/utils';
+import { MeshFetch, readFileOrUrl } from '@graphql-mesh/utils';
 import { process } from '@graphql-mesh/cross-helpers';
 
 function getEventEmitterFromPubSub(pubsub: MeshPubSub): any {
@@ -36,7 +36,7 @@ export default class Neo4JHandler implements MeshHandler {
   private pubsub: MeshPubSub;
   private typeDefs: StoreProxy<string>;
   private logger: Logger;
-  fetchFn: typeof fetch;
+  fetchFn: MeshFetch;
   importFn: ImportFn;
 
   constructor({

diff --git a/packages/handlers/odata/src/index.ts b/packages/handlers/odata/src/index.ts
@@ -1,5 +1,5 @@
 import { YamlConfig, MeshHandler, GetMeshSourceOptions, MeshSource, Logger, ImportFn } from '@graphql-mesh/types';
-import { readFileOrUrl } from '@graphql-mesh/utils';
+import { MeshFetch, readFileOrUrl } from '@graphql-mesh/utils';
 import {
   getInterpolatedHeadersFactory,
   parseInterpolationStrings,
@@ -115,7 +115,7 @@ const queryOptionsFields = {
 export default class ODataHandler implements MeshHandler {
   private name: string;
   private config: YamlConfig.ODataHandler;
-  private fetchFn: typeof fetch;
+  private fetchFn: MeshFetch;
   private logger: Logger;
   private importFn: ImportFn;
   private baseDir: string;
@@ -555,8 +555,18 @@ export default class ODataHandler implements MeshHandler {
           return handleBatchJsonResults(batchResponseJson, requests);
         }),
       none: () =>
+        // We should refactor here
         new DataLoader(
-          (requests: Request[]): Promise<Response[]> => Promise.all(requests.map(request => this.fetchFn(request)))
+          (requests: Request[]): Promise<Response[]> =>
+            Promise.all(
+              requests.map(async request =>
+                this.fetchFn(request.url, {
+                  method: request.method,
+                  body: request.body && (await request.text()),
+                  headers: request.headers,
+                })
+              )
+            )
         ),
     };
 

diff --git a/packages/handlers/odata/test/custom-fetch.ts b/packages/handlers/odata/test/custom-fetch.ts
@@ -4,13 +4,17 @@ export const MockRequest = function (url: string, config: RequestInit) {
   return {
     url,
     ...config,
-    text: async () => config.body,
+    text: async () => config.body.toString('utf-8'),
+    json: async () => JSON.parse(config.body.toString('utf-8')),
+    clone() {
+      return this;
+    },
   } as Request;
 } as any as typeof Request;
-export const MockResponse = function (body: string) {
+export const MockResponse = function (body: any) {
   return {
-    text: async () => body,
-    json: async () => JSON.parse(body),
+    text: async () => body.toString('utf-8'),
+    json: async () => JSON.parse(body.toString('utf-8')),
   } as Response;
 } as any as typeof Response;