Merge branch 'wsclient-option' of https://github.com/junminstorage/express-graphql into wsclient-option

Author: junminstorage

.eslintrc.yml

@@ -491,7 +491,7 @@ overrides:
       '@typescript-eslint/no-throw-literal': error
       '@typescript-eslint/no-type-alias': off # TODO consider
       '@typescript-eslint/no-unnecessary-boolean-literal-compare': error
-      '@typescript-eslint/no-unnecessary-condition': off # TODO blocked by https://github.com/typescript-eslint/typescript-eslint/issues/2752
+      '@typescript-eslint/no-unnecessary-condition': error
       '@typescript-eslint/no-unnecessary-qualifier': error
       '@typescript-eslint/no-unnecessary-type-arguments': error
       '@typescript-eslint/no-unnecessary-type-assertion': error

README.md

@@ -131,20 +131,20 @@ The `graphqlHTTP` function accepts the following options:
 
   - **`defaultQuery`**: An optional GraphQL string to use when no query
     is provided and no stored query exists from a previous session.
-    If undefined is provided, GraphiQL will use its own default query.
+    If `undefined` is provided, GraphiQL will use its own default query.
 
-  - **`headerEditorEnabled`**: An optional boolean which enables the header editor when true.
-    Defaults to false.
+  - **`headerEditorEnabled`**: An optional boolean which enables the header editor when `true`.
+    Defaults to `false`.
 
   - **`subscriptionEndpoint`**: An optional GraphQL string contains the WebSocket server url for subscription.
 
   - **`websocketClient`**: An optional GraphQL string for websocket client used for subscription, `v0`: subscriptions-transport-ws, `v1`: graphql-ws. Defaults to `v0` if not provided
 
-- **`rootValue`**: A value to pass as the `rootValue` to the `graphql()`
-  function from [`GraphQL.js/src/execute.js`](https://github.com/graphql/graphql-js/blob/master/src/execution/execute.js#L119).
+- **`rootValue`**: A value to pass as the `rootValue` to the `execute()`
+  function from [`GraphQL.js/src/execute.js`](https://github.com/graphql/graphql-js/blob/main/src/execution/execute.js#L129).
 
-- **`context`**: A value to pass as the `context` to the `graphql()`
-  function from [`GraphQL.js/src/execute.js`](https://github.com/graphql/graphql-js/blob/master/src/execution/execute.js#L120). If `context` is not provided, the
+- **`context`**: A value to pass as the `contextValue` to the `execute()`
+  function from [`GraphQL.js/src/execute.js`](https://github.com/graphql/graphql-js/blob/main/src/execution/execute.js#L130). If `context` is not provided, the
   `request` object is passed as the context.
 
 - **`pretty`**: If `true`, any JSON response will be pretty-printed.
@@ -156,7 +156,7 @@ The `graphqlHTTP` function accepts the following options:
   of resources consumed. This may be an async function. The function is
   given one object as an argument: `{ document, variables, operationName, result, context }`.
 
-- **`validationRules`**: Optional additional validation rules queries must
+- **`validationRules`**: Optional additional validation rules that queries must
   satisfy in addition to those defined by the GraphQL spec.
 
 - **`customValidateFn`**: An optional function which will be used to validate
@@ -175,10 +175,6 @@ The `graphqlHTTP` function accepts the following options:
 - **`formatError`**: is deprecated and replaced by `customFormatErrorFn`. It will be
   removed in version 1.0.0.
 
-- **`handleRuntimeQueryErrorFn`**: An optional function which can be used to change the status code
-  or headers of the response in case of a runtime query error. By default, the status code is set to
-  `500`.
-
 In addition to an object defining each option, options can also be provided as
 a function (or async function) which returns this options object. This function
 is provided the arguments `(request, response, graphQLParams)` and is called
@@ -213,7 +209,7 @@ the parameters:
   named operations.
 
 - **`raw`**: If the `graphiql` option is enabled and the `raw` parameter is
-  provided raw JSON will always be returned instead of GraphiQL even when
+  provided, raw JSON will always be returned instead of GraphiQL even when
   loaded from a browser.
 
 GraphQL will first look for each parameter in the query string of a URL:
@@ -222,23 +218,23 @@ GraphQL will first look for each parameter in the query string of a URL:
 /graphql?query=query+getUser($id:ID){user(id:$id){name}}&variables={"id":"4"}
 ```
 
-If not found in the query-string, it will look in the POST request body.
+If not found in the query string, it will look in the POST request body.
 
 If a previous middleware has already parsed the POST body, the `request.body`
 value will be used. Use [`multer`][] or a similar middleware to add support
 for `multipart/form-data` content, which may be useful for GraphQL mutations
 involving uploading files. See an [example using multer](https://github.com/graphql/express-graphql/blob/304b24b993c8f16fffff8d23b0fa4088e690874b/src/__tests__/http-test.js#L674-L741).
 
-If the POST body has not yet been parsed, express-graphql will interpret it
+If the POST body has not yet been parsed, `express-graphql` will interpret it
 depending on the provided _Content-Type_ header.
 
 - **`application/json`**: the POST body will be parsed as a JSON
   object of parameters.
 
-- **`application/x-www-form-urlencoded`**: this POST body will be
+- **`application/x-www-form-urlencoded`**: the POST body will be
   parsed as a url-encoded string of key-value pairs.
 
-- **`application/graphql`**: The POST body will be parsed as GraphQL
+- **`application/graphql`**: the POST body will be parsed as GraphQL
   query string, which provides the `query` parameter.
 
 ## Combining with Other Express Middleware
@@ -302,8 +298,6 @@ const { graphqlHTTP } = require('express-graphql');
 
 const app = express();
 
-app.use(session({ secret: 'keyboard cat', cookie: { maxAge: 60000 } }));
-
 const extensions = ({
   document,
   variables,
@@ -334,7 +328,7 @@ for example:
 
 ```js
 {
-  "data": { ... }
+  "data": { ... },
   "extensions": {
     "runTime": 135
   }
@@ -345,7 +339,7 @@ for example:
 
 GraphQL's [validation phase](https://graphql.github.io/graphql-spec/#sec-Validation) checks the query to ensure that it can be successfully executed against the schema. The `validationRules` option allows for additional rules to be run during this phase. Rules are applied to each node in an AST representing the query using the Visitor pattern.
 
-A validation rule is a function which returns a visitor for one or more node Types. Below is an example of a validation preventing the specific field name `metadata` from being queried. For more examples see the [`specifiedRules`](https://github.com/graphql/graphql-js/tree/master/src/validation/rules) in the [graphql-js](https://github.com/graphql/graphql-js) package.
+A validation rule is a function which returns a visitor for one or more node Types. Below is an example of a validation preventing the specific field name `metadata` from being queried. For more examples, see the [`specifiedRules`](https://github.com/graphql/graphql-js/tree/main/src/validation/rules) in the [graphql-js](https://github.com/graphql/graphql-js) package.
 
 ```js
 import { GraphQLError } from 'graphql';
@@ -375,14 +369,14 @@ application any more secure. Nevertheless, disabling introspection is possible b
 package.
 
 ```js
-import { specifiedRules, NoSchemaIntrospectionCustomRule } from 'graphql';
+import { NoSchemaIntrospectionCustomRule } from 'graphql';
 
 app.use(
   '/graphql',
   graphqlHTTP((request) => {
     return {
       schema: MyGraphQLSchema,
-      validationRules: [...specifiedRules, NoSchemaIntrospectionCustomRule],
+      validationRules: [NoSchemaIntrospectionCustomRule],
     };
   }),
 );
@@ -430,7 +424,17 @@ Each release of `express-graphql` will be accompanied by an experimental release
 Community feedback on this experimental release is much appreciated and can be provided on the [PR for the defer-stream branch](https://github.com/graphql/express-graphql/pull/726) or the [GraphQL.js issue for feedback](https://github.com/graphql/graphql-js/issues/2848).
 
 [`graphql.js`]: https://github.com/graphql/graphql-js
-[`formaterror`]: https://github.com/graphql/graphql-js/blob/master/src/error/formatError.js
+[`formaterror`]: https://github.com/graphql/graphql-js/blob/main/src/error/formatError.js
 [graphiql]: https://github.com/graphql/graphiql
 [`multer`]: https://github.com/expressjs/multer
 [`express-session`]: https://github.com/expressjs/session
+
+# Contributing to this repo
+
+This repository is managed by EasyCLA. Project participants must sign the free [GraphQL Specification Membership agreement](https://preview-spec-membership.graphql.org) before making a contribution. You only need to do this one time, and it can be signed by [individual contributors](http://individual-spec-membership.graphql.org/) or their [employers](http://corporate-spec-membership.graphql.org/).
+
+To initiate the signature process please open a PR against this repo. The EasyCLA bot will block the merge if we still need a membership agreement from you.
+
+You can find [detailed information here](https://github.com/graphql/graphql-wg/tree/main/membership). If you have issues, please email [operations@graphql.org](mailto:operations@graphql.org).
+
+If your company benefits from GraphQL and you would like to provide essential financial support for the systems and people that power our community, please also consider membership in the [GraphQL Foundation](https://foundation.graphql.org/join).

integrationTests/integration-test.js

@@ -17,7 +17,7 @@ function exec(command, options = {}) {
 
 describe('Integration Tests', () => {
   const tmpDir = path.join(os.tmpdir(), 'express-graphql-integrationTmp');
-  fs.rmdirSync(tmpDir, { recursive: true });
+  fs.rmdirSync(tmpDir, { recursive: true, force: true });
   fs.mkdirSync(tmpDir);
 
   const distDir = path.resolve('./npmDist');

src/__tests__/usage-test.ts

@@ -2,12 +2,7 @@ import express from 'express';
 import request from 'supertest';
 import { expect } from 'chai';
 import { describe, it } from 'mocha';
-import {
-  GraphQLNonNull,
-  GraphQLObjectType,
-  GraphQLSchema,
-  GraphQLString,
-} from 'graphql';
+import { GraphQLSchema } from 'graphql';
 
 import { graphqlHTTP } from '../index';
 
@@ -101,40 +96,6 @@ describe('Useful errors when incorrectly used', () => {
     });
   });
 
-  it('uses the custom runtime query error handling function', async () => {
-    const schema = new GraphQLSchema({
-      query: new GraphQLObjectType({
-        name: 'QueryRoot',
-        fields: {
-          test: {
-            type: new GraphQLNonNull(GraphQLString),
-            resolve() {
-              throw new Error('Throws!');
-            },
-          },
-        },
-      }),
-    });
-
-    const app = express();
-
-    app.use(
-      '/graphql',
-      graphqlHTTP({
-        handleRuntimeQueryErrorFn(_, response) {
-          response.setHeader('customRuntimeQueryError', "I'm a teapot");
-          response.statusCode = 418;
-        },
-        schema,
-      }),
-    );
-
-    const response = await request(app).get('/graphql?query={test}');
-
-    expect(response.status).to.equal(418);
-    expect(response.get('customRuntimeQueryError')).to.equal("I'm a teapot");
-  });
-
   it('validates schema before executing request', async () => {
     // @ts-expect-error
     const schema = new GraphQLSchema({ directives: [null] });

src/index.ts

@@ -115,15 +115,6 @@ export interface OptionsData {
    */
   formatError?: (error: GraphQLError) => GraphQLFormattedError;
 
-  /**
-   * Use this to modify the response when a runtime query error occurs. By
-   * default the statusCode will be set to 500.
-   */
-  handleRuntimeQueryErrorFn?: (
-    result: ExecutionResult,
-    response: Response,
-  ) => void;
-
   /**
    * An optional function for adding additional metadata to the GraphQL response
    * as a key-value object. The result will be added to "extensions" field in
@@ -196,7 +187,7 @@ type Middleware = (request: Request, response: Response) => Promise<void>;
  * configure behavior, and returns an express middleware.
  */
 export function graphqlHTTP(options: Options): Middleware {
-  devAssert(options != null, 'GraphQL middleware requires options.');
+  devAssertIsNonNullable(options, 'GraphQL middleware requires options.');
 
   return async function graphqlMiddleware(
     request: Request,
@@ -209,7 +200,6 @@ export function graphqlHTTP(options: Options): Middleware {
     let formatErrorFn = formatError;
     let pretty = false;
     let result: ExecutionResult;
-    let optionsData: OptionsData | undefined;
 
     try {
       // Parse the Request to get GraphQL request parameters.
@@ -218,7 +208,7 @@ export function graphqlHTTP(options: Options): Middleware {
       } catch (error: unknown) {
         // When we failed to parse the GraphQL parameters, we still need to get
         // the options object, so make an options call to resolve just that.
-        optionsData = await resolveOptions();
+        const optionsData = await resolveOptions();
         pretty = optionsData.pretty ?? false;
         formatErrorFn =
           optionsData.customFormatErrorFn ??
@@ -228,7 +218,7 @@ export function graphqlHTTP(options: Options): Middleware {
       }
 
       // Then, resolve the Options to get OptionsData.
-      optionsData = await resolveOptions(params);
+      const optionsData: OptionsData = await resolveOptions(params);
 
       // Collect information from the options data object.
       const schema = optionsData.schema;
@@ -249,9 +239,8 @@ export function graphqlHTTP(options: Options): Middleware {
         optionsData.formatError ??
         formatErrorFn;
 
-      // Assert that schema is required.
-      devAssert(
-        schema != null,
+      devAssertIsObject(
+        schema,
         'GraphQL middleware options must contain a schema.',
       );
 
@@ -398,22 +387,13 @@ export function graphqlHTTP(options: Options): Middleware {
       }
     }
 
-    if (result.errors != null || result.data == null) {
-      const handleRuntimeQueryErrorFn =
-        optionsData?.handleRuntimeQueryErrorFn ??
-        ((_result, _response) => {
-          // If no data was included in the result, that indicates a runtime query
-          // error, indicate as such with a generic status code.
-          // Note: Information about the error itself will still be contained in
-          // the resulting JSON payload.
-          // https://graphql.github.io/graphql-spec/#sec-Data
-
-          if (_response.statusCode === 200 && _result.data == null) {
-            _response.statusCode = 500;
-          }
-        });
-
-      handleRuntimeQueryErrorFn(result, response);
+    // If no data was included in the result, that indicates a runtime query
+    // error, indicate as such with a generic status code.
+    // Note: Information about the error itself will still be contained in
+    // the resulting JSON payload.
+    // https://graphql.github.io/graphql-spec/#sec-Data
+    if (response.statusCode === 200 && result.data == null) {
+      response.statusCode = 500;
     }
 
     // Format any encountered errors.
@@ -451,8 +431,8 @@ export function graphqlHTTP(options: Options): Middleware {
           : options,
       );
 
-      devAssert(
-        optionsResult != null && typeof optionsResult === 'object',
+      devAssertIsObject(
+        optionsResult,
         'GraphQL middleware option function must return an options object or a promise which will be resolved to an options object.',
       );
 
@@ -552,9 +532,17 @@ function sendResponse(response: Response, type: string, data: string): void {
   response.end(chunk);
 }
 
-function devAssert(condition: unknown, message: string): asserts condition {
+function devAssertIsObject(value: unknown, message: string): void {
+  devAssert(value != null && typeof value === 'object', message);
+}
+
+function devAssertIsNonNullable(value: unknown, message: string): void {
+  devAssert(value != null, message);
+}
+
+function devAssert(condition: unknown, message: string): void {
   const booleanCondition = Boolean(condition);
   if (!booleanCondition) {
-    throw new Error(message);
+    throw new TypeError(message);
   }
 }