Apollo Server 2: Remove formatParams

docs/source/api/apollo-server.md

@@ -61,7 +61,7 @@ new ApolloServer({
 
   Add tracing or cacheControl meta data to the GraphQL response
 
-* `formatError`, `formatResponse`, `formatParams`: <`Function`>
+* `formatError`, `formatResponse`: <`Function`>
 
   Functions to format the errors and response returned from the server, as well as the parameters to graphql execution(`runQuery`)
 

docs/source/features/metrics.md

@@ -40,16 +40,12 @@ Apollo Server provides two ways to log a server: per input, response, and errors
 
 ### High Level Logging
 
-To log the inputs, response, and request, Apollo Server provides three methods: `formatParams`, `formatError`, and `formatResponse`. This example uses `console.log` to record the information, servers can use other more sophisticated tools.
+To log the inputs, response, and request, Apollo Server provides three methods: `formatError` and `formatResponse`. This example uses `console.log` to record the information, servers can use other more sophisticated tools.
 
 ```js
 const server = new ApolloServer({
   typeDefs,
   resolvers,
-  formatParams: params => {
-    console.log(params);
-    return params;
-  },
   formatError: error => {
     console.log(error);
     return error;

docs/source/migration-two-dot.md

@@ -243,10 +243,6 @@ new ApolloServer({
 });
 ```
 
-For most other functions that might have required access to the middleware arguments, such as `formatParams`, `formatError`, and `formatResponse`, it is possible to create a `graphql-extension`.
-
-For more complicated use cases, the `ApolloServer` class can be extended to override the `createGraphQLServerOptions` function to create parameters based on the same argument that's passed to the context.
-
 <h2 id="log-function">Replacing `logFunction`</h2>
 
 Apollo Server 2 removes the `logFunction` in favor of using `graphql-extensions`, which provides a more structured and flexible way of instrumenting Apollo Server. The explanation of how to do this more granular logging, can be found in the [metrics section](./features/metrics.html)

docs/source/setup.md

@@ -100,9 +100,6 @@ The above are the only options you need most of the time. Here are some others t
 ```js
 // options object
 const GraphQLOptions = {
-  // a function applied to the parameters of every invocation of runQuery
-  formatParams?: Function,
-
   // * - (optional) validationRules: extra validation rules applied to requests
   validationRules?: Array<ValidationRule>,
 

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

@@ -15,7 +15,6 @@ import { KeyValueCache } from 'apollo-server-caching';
  * - (optional) formatError: Formatting function applied to all errors before response is sent
  * - (optional) rootValue: rootValue passed to GraphQL execution
  * - (optional) context: the context passed to GraphQL execution
- * - (optional) formatParams: a function applied to the parameters of every invocation of runQuery
  * - (optional) validationRules: extra validation rules applied to requests
  * - (optional) formatResponse: a function applied to each graphQL execution result
  * - (optional) fieldResolver: a custom default field resolver
@@ -32,7 +31,6 @@ export interface GraphQLServerOptions<
   formatError?: Function;
   rootValue?: any;
   context?: TContext;
-  formatParams?: Function;
   validationRules?: Array<(context: ValidationContext) => any>;
   formatResponse?: Function;
   fieldResolver?: GraphQLFieldResolver<any, TContext>;

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

@@ -258,8 +258,11 @@ export async function runHttpQuery(
         }
       }
 
-      // We ensure that there is a queryString or parsedQuery after formatParams
-      if (queryString && typeof queryString !== 'string') {
+      if (!queryString) {
+        throw new HttpQueryError(400, 'Must provide query string.');
+      }
+
+      if (typeof queryString !== 'string') {
         // Check for a common error first.
         if (queryString && (queryString as any).kind === 'Document') {
           throw new HttpQueryError(
@@ -406,15 +409,6 @@ export async function runHttpQuery(
         persistedQueryRegister,
       };
 
-      if (optionsObject.formatParams) {
-        params = optionsObject.formatParams(params);
-      }
-
-      if (!params.queryString && !params.parsedQuery) {
-        // Note that we've already thrown a different error if it looks like APQ.
-        throw new HttpQueryError(400, 'Must provide query string.');
-      }
-
       return runQuery(params);
     } catch (e) {
       // Populate any HttpQueryError to our handler which should

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

@@ -37,7 +37,6 @@ export interface Config
       | 'formatError'
       | 'debug'
       | 'rootValue'
-      | 'formatParams'
       | 'validationRules'
       | 'formatResponse'
       | 'fieldResolver'