Add pluggable executor to request pipeline

apollographql · Mar 7, 2019 · 185dd45 · 185dd45
1 parent 3a3c67d
commit 185dd45
Show file tree

Hide file tree

Showing 5 changed files with 37 additions and 14 deletions.
diff --git a/packages/apollo-server-core/src/graphqlOptions.ts b/packages/apollo-server-core/src/graphqlOptions.ts
@@ -12,6 +12,7 @@ import { KeyValueCache, InMemoryLRUCache } from 'apollo-server-caching';
 import { DataSource } from 'apollo-datasource';
 import { ApolloServerPlugin } from 'apollo-server-plugin-base';
 import { GraphQLParseOptions } from 'graphql-tools';
+import { GraphQLExecutor } from '../dist/requestPipelineAPI';
 
 /*
  * GraphQLServerOptions
@@ -37,6 +38,7 @@ export interface GraphQLServerOptions<
   rootValue?: ((parsedQuery: DocumentNode) => TRootValue) | TRootValue;
   context?: TContext | (() => never);
   validationRules?: Array<(context: ValidationContext) => any>;
+  executor?: GraphQLExecutor;
   formatResponse?: Function;
   fieldResolver?: GraphQLFieldResolver<any, TContext>;
   debug?: boolean;

diff --git a/packages/apollo-server-core/src/requestPipeline.ts b/packages/apollo-server-core/src/requestPipeline.ts
@@ -5,7 +5,6 @@ import {
   DocumentNode,
   getOperationAST,
   ExecutionArgs,
-  ExecutionResult,
   GraphQLError,
   GraphQLFormattedError,
 } from 'graphql';
@@ -36,6 +35,7 @@ import {
   GraphQLRequestContext,
   InvalidGraphQLRequestError,
   ValidationRule,
+  GraphQLExecutor,
 } from '../dist/requestPipelineAPI';
 import {
   ApolloServerPlugin,
@@ -67,6 +67,7 @@ export interface GraphQLRequestPipelineConfig<TContext> {
 
   rootValue?: ((document: DocumentNode) => any) | any;
   validationRules?: ValidationRule[];
+  executor?: GraphQLExecutor;
   fieldResolver?: GraphQLFieldResolver<any, TContext>;
 
   dataSources?: () => DataSources<TContext>;
@@ -284,11 +285,10 @@ export async function processGraphQLRequest<TContext>(
     let response: GraphQLResponse;
 
     try {
-      response = (await execute(
-        requestContext.document,
-        request.operationName,
-        request.variables,
-      )) as GraphQLResponse;
+      response = await execute(requestContext as WithRequired<
+        typeof requestContext,
+        'document' | 'operation' | 'operationName'
+      >);
       executionDidEnd();
     } catch (executionError) {
       executionDidEnd(executionError);
@@ -342,10 +342,13 @@ export async function processGraphQLRequest<TContext>(
   }
 
   async function execute(
-    document: DocumentNode,
-    operationName: GraphQLRequest['operationName'],
-    variables: GraphQLRequest['variables'],
-  ): Promise<ExecutionResult> {
+    requestContext: WithRequired<
+      GraphQLRequestContext<TContext>,
+      'document' | 'operationName' | 'operation'
+    >,
+  ): Promise<GraphQLResponse> {
+    const { request, document } = requestContext;
+
     const executionArgs: ExecutionArgs = {
       schema: config.schema,
       document,
@@ -354,8 +357,8 @@ export async function processGraphQLRequest<TContext>(
           ? config.rootValue(document)
           : config.rootValue,
       contextValue: requestContext.context,
-      variableValues: variables,
-      operationName,
+      variableValues: request.variables,
+      operationName: request.operationName,
       fieldResolver: config.fieldResolver,
     };
 
@@ -364,7 +367,11 @@ export async function processGraphQLRequest<TContext>(
     });
 
     try {
-      return await graphql.execute(executionArgs);
+      if (config.executor) {
+        return await config.executor(requestContext);
+      } else {
+        return (await graphql.execute(executionArgs)) as GraphQLResponse;
+      }
     } finally {
       executionDidEnd();
     }

diff --git a/packages/apollo-server-core/src/requestPipelineAPI.ts b/packages/apollo-server-core/src/requestPipelineAPI.ts
@@ -2,7 +2,12 @@
 // circular dependency issues from the `apollo-server-plugin-base` package
 // depending on the types in it.
 
-import { Request, Response } from 'apollo-server-env';
+import {
+  Request,
+  Response,
+  ValueOrPromise,
+  WithRequired,
+} from 'apollo-server-env';
 import {
   GraphQLSchema,
   ValidationContext,
@@ -63,3 +68,10 @@ export interface GraphQLRequestContext<TContext = Record<string, any>> {
 export type ValidationRule = (context: ValidationContext) => ASTVisitor;
 
 export class InvalidGraphQLRequestError extends Error {}
+
+export type GraphQLExecutor<TContext = Record<string, any>> = (
+  requestContext: WithRequired<
+    GraphQLRequestContext<TContext>,
+    'document' | 'operationName' | 'operation'
+  >,
+) => ValueOrPromise<GraphQLResponse>;
diff --git a/packages/apollo-server-core/src/runHttpQuery.ts b/packages/apollo-server-core/src/runHttpQuery.ts
@@ -147,6 +147,7 @@ export async function runHttpQuery(
     rootValue: options.rootValue,
     context: options.context || {},
     validationRules: options.validationRules,
+    executor: options.executor,
     fieldResolver: options.fieldResolver,
 
     // FIXME: Use proper option types to ensure this

diff --git a/packages/apollo-server-core/src/types.ts b/packages/apollo-server-core/src/types.ts
@@ -55,6 +55,7 @@ type BaseConfig = Pick<
   | 'debug'
   | 'rootValue'
   | 'validationRules'
+  | 'executor'
   | 'formatResponse'
   | 'fieldResolver'
   | 'tracing'