Pass the context along to all the extension methods

CHANGELOG.md

@@ -4,6 +4,8 @@ All of the packages in the `apollo-server` repo are released with the same versi
 
 ### vNEXT
 
+- Core: Allow context to be passed to all GraphQLExtension methods. [PR #1547](https://github.com/apollographql/apollo-server/pull/1547)
+
 ### v2.0.7
 
 - Fix [#1581](https://github.com/apollographql/apollo-server/issues/1581) `apollo-server-micro` top level error response [#1619](https://github.com/apollographql/apollo-server/pull/1619)

packages/apollo-engine-reporting/src/extension.ts

@@ -57,7 +57,7 @@ export class EngineReportingExtension<TContext = any>
  request: Request;
  queryString?: string;
  parsedQuery?: DocumentNode;
- variables: Record<string, any>;
+ variables?: Record<string, any>;
  persistedQueryHit?: boolean;
  persistedQueryRegister?: boolean;
  }): EndHandler {
@@ -139,7 +139,7 @@ export class EngineReportingExtension<TContext = any>
  this.trace.details!.variablesJson![name] = '';
  } else {
  this.trace.details!.variablesJson![name] = JSON.stringify(
- o.variables[name],
+ o.variables![name],
  );
  }
  });

packages/apollo-server-core/src/__tests__/runQuery.test.ts

@@ -353,6 +353,28 @@ describe('runQuery', () => {
  });
  });
  });
+
+ it('runs willSendResponse with extensions context', async () => {
+ class CustomExtension implements GraphQLExtension<any> {
+ willSendResponse(o: any) {
+ expect(o).toHaveProperty('context.baz', 'always here');
+ return o;
+ }
+ }
+
+ const queryString = `{ testString }`;
+ const expected = { testString: 'it works' };
+ const extensions = [() => new CustomExtension()];
+ return runQuery({
+ schema,
+ queryString,
+ context: { baz: 'always here' },
+ extensions,
+ request: new MockReq(),
+ }).then(res => {
+ expect(res.data).toEqual(expected);
+ });
+ });
  });
 
  describe('async_hooks', () => {

packages/apollo-server-core/src/formatters.ts

@@ -1,7 +1,7 @@
 import { GraphQLExtension, GraphQLResponse } from 'graphql-extensions';
 import { formatApolloErrors } from 'apollo-server-errors';
 
-export class FormatErrorExtension extends GraphQLExtension {
+export class FormatErrorExtension<TContext = any> extends GraphQLExtension {
  private formatError: Function;
  private debug: boolean;
 
@@ -13,9 +13,11 @@ export class FormatErrorExtension extends GraphQLExtension {
 
  public willSendResponse(o: {
  graphqlResponse: GraphQLResponse;
- }): void | { graphqlResponse: GraphQLResponse } {
+ context: TContext;
+ }): void | { graphqlResponse: GraphQLResponse; context: TContext } {
  if (o.graphqlResponse.errors) {
  return {
+ ...o,
  graphqlResponse: {
  ...o.graphqlResponse,
  errors: formatApolloErrors(o.graphqlResponse.errors, {

packages/apollo-server-core/src/runQuery.ts

@@ -135,6 +135,7 @@ function doRunQuery(options: QueryOptions): Promise<GraphQLResponse> {
  variables: options.variables,
  persistedQueryHit: options.persistedQueryHit,
  persistedQueryRegister: options.persistedQueryRegister,
+ context,
  });
  return Promise.resolve()
  .then(
@@ -278,7 +279,10 @@ function doRunQuery(options: QueryOptions): Promise<GraphQLResponse> {
  throw err;
  })
  .then((graphqlResponse: GraphQLResponse) => {
- const response = extensionStack.willSendResponse({ graphqlResponse });
+ const response = extensionStack.willSendResponse({
+ graphqlResponse,
+ context,
+ });
  requestDidEnd();
  return response.graphqlResponse;
  });

packages/apollo-server-integration-testsuite/src/ApolloServer.ts

@@ -526,8 +526,11 @@ export function testApolloServer<AS extends ApolloServerBase>(
  return error;
  });
 
- class Extension extends GraphQLExtension {
- willSendResponse(o: { graphqlResponse: GraphQLResponse }) {
+ class Extension<TContext = any> extends GraphQLExtension {
+ willSendResponse(o: {
+ graphqlResponse: GraphQLResponse;
+ context: TContext;
+ }) {
  expect(o.graphqlResponse.errors.length).toEqual(1);
  // formatError should be called after extensions
  expect(formatError).not.toBeCalled();
@@ -609,8 +612,11 @@ export function testApolloServer<AS extends ApolloServerBase>(
  return error;
  });
 
- class Extension extends GraphQLExtension {
- willSendResponse(_o: { graphqlResponse: GraphQLResponse }) {
+ class Extension<TContext = any> extends GraphQLExtension {
+ willSendResponse(_o: {
+ graphqlResponse: GraphQLResponse;
+ context: TContext;
+ }) {
  // formatError should be called after extensions
  expect(formatError).not.toBeCalled();
  extension();

packages/graphql-extensions/src/index.ts

@@ -40,6 +40,7 @@ export class GraphQLExtension<TContext = any> {
  variables?: { [key: string]: any };
  persistedQueryHit?: boolean;
  persistedQueryRegister?: boolean;
+ context: TContext;
  }): EndHandler | void;
  public parsingDidStart?(o: { queryString: string }): EndHandler | void;
  public validationDidStart?(): EndHandler | void;
@@ -49,7 +50,8 @@ export class GraphQLExtension<TContext = any> {
 
  public willSendResponse?(o: {
  graphqlResponse: GraphQLResponse;
- }): void | { graphqlResponse: GraphQLResponse };
+ context: TContext;
+ }): void | { graphqlResponse: GraphQLResponse; context: TContext };
 
  public willResolveField?(
  source: any,
@@ -78,6 +80,7 @@ export class GraphQLExtensionStack<TContext = any> {
  variables?: { [key: string]: any };
  persistedQueryHit?: boolean;
  persistedQueryRegister?: boolean;
+ context: TContext;
  }): EndHandler {
  return this.handleDidStart(
  ext => ext.requestDidStart && ext.requestDidStart(o),
@@ -104,7 +107,8 @@ export class GraphQLExtensionStack<TContext = any> {
 
  public willSendResponse(o: {
  graphqlResponse: GraphQLResponse;
- }): { graphqlResponse: GraphQLResponse } {
+ context: TContext;
+ }): { graphqlResponse: GraphQLResponse; context: TContext } {
  let reference = o;
  // Reverse the array, since this is functions as an end handler
  [...this.extensions].reverse().forEach(extension => {