graphql-http 1.17.1 → 1.19.0

package/lib/handler.mjs

@@ -4,7 +4,7 @@
  *
  */
 import { validate as graphqlValidate, specifiedRules, execute as graphqlExecute, parse as graphqlParse, getOperationAST as graphqlGetOperationAST, GraphQLError, } from 'graphql';
-import { areGraphQLErrors, isAsyncIterable, isExecutionResult, isGraphQLError, isObject, } from './utils.mjs';
+import { areGraphQLErrors, isAsyncIterable, isExecutionResult, isGraphQLError, isObject, jsonErrorReplacer, } from './utils.mjs';
 /**
  * Checks whether the passed value is the `graphql-http` server agnostic response.
  *
@@ -72,7 +72,7 @@ export function isResponse(val) {
  * @category Server
  */
 export function createHandler(options) {
-    const { schema, context, validate = graphqlValidate, validationRules = [], execute = graphqlExecute, parse = graphqlParse, getOperationAST = graphqlGetOperationAST, rootValue, onSubscribe, onOperation, } = options;
+    const { schema, context, validate = graphqlValidate, validationRules = [], execute = graphqlExecute, parse = graphqlParse, getOperationAST = graphqlGetOperationAST, rootValue, onSubscribe, onOperation, formatError = (err) => err, } = options;
     return async function handler(req) {
         var _a, _b;
         const method = req.method;
@@ -173,6 +173,10 @@ export function createHandler(options) {
                     Array.isArray(partParams.variables))) {
                 throw new Error('Invalid variables');
             }
+            if (partParams.operationName != null &&
+                typeof partParams.operationName !== 'string') {
+                throw new Error('Invalid operationName');
+            }
             if (partParams.extensions != null &&
                 (typeof partParams.extensions !== 'object' ||
                     Array.isArray(partParams.extensions))) {
@@ -182,7 +186,7 @@ export function createHandler(options) {
             params = partParams;
         }
         catch (err) {
-            return makeResponse(new GraphQLError(err.message), acceptedMediaType);
+            return makeResponse(err, acceptedMediaType, formatError);
         }
         let args;
         const maybeResErrsOrArgs = await (onSubscribe === null || onSubscribe === void 0 ? void 0 : onSubscribe(req, params));
@@ -190,7 +194,7 @@ export function createHandler(options) {
             return maybeResErrsOrArgs;
         else if (isExecutionResult(maybeResErrsOrArgs) ||
             areGraphQLErrors(maybeResErrsOrArgs))
-            return makeResponse(maybeResErrsOrArgs, acceptedMediaType);
+            return makeResponse(maybeResErrsOrArgs, acceptedMediaType, formatError);
         else if (maybeResErrsOrArgs)
             args = maybeResErrsOrArgs;
         else {
@@ -202,7 +206,7 @@ export function createHandler(options) {
                 document = parse(query);
             }
             catch (err) {
-                return makeResponse(err, acceptedMediaType);
+                return makeResponse(err, acceptedMediaType, formatError);
             }
             const resOrContext = typeof context === 'function' ? await context(req, params) : context;
             if (isResponse(resOrContext))
@@ -231,7 +235,7 @@ export function createHandler(options) {
             }
             const validationErrs = validate(args.schema, args.document, rules);
             if (validationErrs.length) {
-                return makeResponse(validationErrs, acceptedMediaType);
+                return makeResponse(validationErrs, acceptedMediaType, formatError);
             }
         }
         let operation;
@@ -242,10 +246,10 @@ export function createHandler(options) {
             operation = ast.operation;
         }
         catch (_d) {
-            return makeResponse(new GraphQLError('Unable to detect operation AST'), acceptedMediaType);
+            return makeResponse(new GraphQLError('Unable to detect operation AST'), acceptedMediaType, formatError);
         }
         if (operation === 'subscription') {
-            return makeResponse(new GraphQLError('Subscriptions are not supported'), acceptedMediaType);
+            return makeResponse(new GraphQLError('Subscriptions are not supported'), acceptedMediaType, formatError);
         }
         // mutations cannot happen over GETs
         // https://graphql.github.io/graphql-over-http/draft/#sel-CALFJRPAAELBAAxwP
@@ -279,9 +283,9 @@ export function createHandler(options) {
         else if (maybeResponseOrResult)
             result = maybeResponseOrResult;
         if (isAsyncIterable(result)) {
-            return makeResponse(new GraphQLError('Subscriptions are not supported'), acceptedMediaType);
+            return makeResponse(new GraphQLError('Subscriptions are not supported'), acceptedMediaType, formatError);
         }
-        return makeResponse(result, acceptedMediaType);
+        return makeResponse(result, acceptedMediaType, formatError);
     };
 }
 /**
@@ -321,12 +325,29 @@ export function getAcceptableMediaType(acceptHeader) {
  *
  * If the first argument is an `ExecutionResult`, the operation will be treated as "successful".
  *
- * If the first argument is _any_ object without the `data` field, it will be treated as an error (as per the spec)
- * and the response will be constructed with the help of `acceptedMediaType` complying with the GraphQL over HTTP spec.
+ * If the first argument is (an array of) `GraphQLError`, or an `ExecutionResult` without the `data` field, it will be treated
+ * the response will be constructed with the help of `acceptedMediaType` complying with the GraphQL over HTTP spec.
+ *
+ * If the first argument is an `Error`, the operation will be treated as a bad request responding with `400: Bad Request` and the
+ * error will be present in the `ExecutionResult` style.
  *
  * @category Server
  */
-export function makeResponse(resultOrErrors, acceptedMediaType) {
+export function makeResponse(resultOrErrors, acceptedMediaType, formatError) {
+    if (resultOrErrors instanceof Error &&
+        // because GraphQLError extends the Error class
+        !isGraphQLError(resultOrErrors)) {
+        return [
+            JSON.stringify({ errors: [formatError(resultOrErrors)] }, jsonErrorReplacer),
+            {
+                status: 400,
+                statusText: 'Bad Request',
+                headers: {
+                    'content-type': 'application/json; charset=utf-8',
+                },
+            },
+        ];
+    }
     const errors = isGraphQLError(resultOrErrors)
         ? [resultOrErrors]
         : areGraphQLErrors(resultOrErrors)
@@ -334,7 +355,7 @@ export function makeResponse(resultOrErrors, acceptedMediaType) {
             : null;
     if (errors) {
         return [
-            JSON.stringify({ errors }),
+            JSON.stringify({ errors: errors.map(formatError) }, jsonErrorReplacer),
             Object.assign(Object.assign({}, (acceptedMediaType === 'application/json'
                 ? {
                     status: 200,
@@ -351,7 +372,8 @@ export function makeResponse(resultOrErrors, acceptedMediaType) {
         ];
     }
     return [
-        JSON.stringify(resultOrErrors),
+        JSON.stringify('errors' in resultOrErrors && resultOrErrors.errors
+            ? Object.assign(Object.assign({}, resultOrErrors), { errors: resultOrErrors.errors.map(formatError) }) : resultOrErrors, jsonErrorReplacer),
         {
             status: 200,
             statusText: 'OK',

package/lib/use/express.js

@@ -21,7 +21,6 @@ const handler_1 = require("../handler");
  * @category Server/express
  */
 function createHandler(options) {
-    const isProd = process.env.NODE_ENV === 'production';
     const handle = (0, handler_1.createHandler)(options);
     return async function requestListener(req, res) {
         try {
@@ -50,23 +49,7 @@ function createHandler(options) {
             // If you wish to handle them differently, consider implementing your own request handler.
             console.error('Internal error occurred during request handling. ' +
                 'Please check your implementation.', err);
-            if (isProd) {
-                res.writeHead(500).end();
-            }
-            else {
-                res
-                    .writeHead(500, { 'content-type': 'application/json; charset=utf-8' })
-                    .end(JSON.stringify({
-                    errors: [
-                        err instanceof Error
-                            ? {
-                                message: err.message,
-                                stack: err.stack,
-                            }
-                            : err,
-                    ],
-                }));
-            }
+            res.writeHead(500).end();
         }
     };
 }

package/lib/use/express.mjs

@@ -18,7 +18,6 @@ import { createHandler as createRawHandler, } from '../handler.mjs';
  * @category Server/express
  */
 export function createHandler(options) {
-    const isProd = process.env.NODE_ENV === 'production';
     const handle = createRawHandler(options);
     return async function requestListener(req, res) {
         try {
@@ -47,23 +46,7 @@ export function createHandler(options) {
             // If you wish to handle them differently, consider implementing your own request handler.
             console.error('Internal error occurred during request handling. ' +
                 'Please check your implementation.', err);
-            if (isProd) {
-                res.writeHead(500).end();
-            }
-            else {
-                res
-                    .writeHead(500, { 'content-type': 'application/json; charset=utf-8' })
-                    .end(JSON.stringify({
-                    errors: [
-                        err instanceof Error
-                            ? {
-                                message: err.message,
-                                stack: err.stack,
-                            }
-                            : err,
-                    ],
-                }));
-            }
+            res.writeHead(500).end();
         }
     };
 }

package/lib/use/fastify.js

@@ -21,7 +21,6 @@ const handler_1 = require("../handler");
  * @category Server/fastify
  */
 function createHandler(options) {
-    const isProd = process.env.NODE_ENV === 'production';
     const handle = (0, handler_1.createHandler)(options);
     return async function requestListener(req, reply) {
         try {
@@ -45,24 +44,7 @@ function createHandler(options) {
             // If you wish to handle them differently, consider implementing your own request handler.
             console.error('Internal error occurred during request handling. ' +
                 'Please check your implementation.', err);
-            if (isProd) {
-                reply.status(500).send();
-            }
-            else {
-                reply
-                    .status(500)
-                    .header('content-type', 'application/json; charset=utf-8')
-                    .send({
-                    errors: [
-                        err instanceof Error
-                            ? {
-                                message: err.message,
-                                stack: err.stack,
-                            }
-                            : err,
-                    ],
-                });
-            }
+            reply.status(500).send();
         }
     };
 }

package/lib/use/fastify.mjs

@@ -18,7 +18,6 @@ import { createHandler as createRawHandler, } from '../handler.mjs';
  * @category Server/fastify
  */
 export function createHandler(options) {
-    const isProd = process.env.NODE_ENV === 'production';
     const handle = createRawHandler(options);
     return async function requestListener(req, reply) {
         try {
@@ -42,24 +41,7 @@ export function createHandler(options) {
             // If you wish to handle them differently, consider implementing your own request handler.
             console.error('Internal error occurred during request handling. ' +
                 'Please check your implementation.', err);
-            if (isProd) {
-                reply.status(500).send();
-            }
-            else {
-                reply
-                    .status(500)
-                    .header('content-type', 'application/json; charset=utf-8')
-                    .send({
-                    errors: [
-                        err instanceof Error
-                            ? {
-                                message: err.message,
-                                stack: err.stack,
-                            }
-                            : err,
-                    ],
-                });
-            }
+            reply.status(500).send();
         }
     };
 }

package/lib/use/fetch.d.mts

@@ -26,7 +26,7 @@ export type HandlerOptions<Context extends OperationContext = undefined> = RawHa
  * import http from 'http';
  * import { createServerAdapter } from '@whatwg-node/server'; // yarn add @whatwg-node/server
  * import { createHandler } from 'graphql-http/lib/use/fetch';
- * import { schema } from './my-graphql-step/index.mjs';
+ * import { schema } from './my-graphql-schema/index.mjs';
  *
  * // Use this adapter in _any_ environment.
  * const adapter = createServerAdapter({

package/lib/use/fetch.d.ts

@@ -26,7 +26,7 @@ export type HandlerOptions<Context extends OperationContext = undefined> = RawHa
  * import http from 'http';
  * import { createServerAdapter } from '@whatwg-node/server'; // yarn add @whatwg-node/server
  * import { createHandler } from 'graphql-http/lib/use/fetch';
- * import { schema } from './my-graphql-step';
+ * import { schema } from './my-graphql-schema';
  *
  * // Use this adapter in _any_ environment.
  * const adapter = createServerAdapter({

package/lib/use/fetch.js

@@ -13,7 +13,7 @@ const handler_1 = require("../handler");
  * import http from 'http';
  * import { createServerAdapter } from '@whatwg-node/server'; // yarn add @whatwg-node/server
  * import { createHandler } from 'graphql-http/lib/use/fetch';
- * import { schema } from './my-graphql-step';
+ * import { schema } from './my-graphql-schema';
  *
  * // Use this adapter in _any_ environment.
  * const adapter = createServerAdapter({
@@ -31,7 +31,6 @@ const handler_1 = require("../handler");
  * @category Server/fetch
  */
 function createHandler(options, reqCtx = {}) {
-    const isProd = process.env.NODE_ENV === 'production';
     const api = {
         Response: reqCtx.Response || Response,
         TextEncoder: reqCtx.TextEncoder || TextEncoder,
@@ -55,26 +54,7 @@ function createHandler(options, reqCtx = {}) {
             // If you wish to handle them differently, consider implementing your own request handler.
             console.error('Internal error occurred during request handling. ' +
                 'Please check your implementation.', err);
-            if (isProd) {
-                return new api.Response(null, { status: 500 });
-            }
-            else {
-                return new api.Response(JSON.stringify({
-                    errors: [
-                        err instanceof Error
-                            ? {
-                                message: err.message,
-                                stack: err.stack,
-                            }
-                            : err,
-                    ],
-                }), {
-                    status: 500,
-                    headers: {
-                        'content-type': 'application/json; charset=utf-8',
-                    },
-                });
-            }
+            return new api.Response(null, { status: 500 });
         }
     };
 }

package/lib/use/fetch.mjs

@@ -10,7 +10,7 @@ import { createHandler as createRawHandler, } from '../handler.mjs';
  * import http from 'http';
  * import { createServerAdapter } from '@whatwg-node/server'; // yarn add @whatwg-node/server
  * import { createHandler } from 'graphql-http/lib/use/fetch';
- * import { schema } from './my-graphql-step/index.mjs';
+ * import { schema } from './my-graphql-schema/index.mjs';
  *
  * // Use this adapter in _any_ environment.
  * const adapter = createServerAdapter({
@@ -28,7 +28,6 @@ import { createHandler as createRawHandler, } from '../handler.mjs';
  * @category Server/fetch
  */
 export function createHandler(options, reqCtx = {}) {
-    const isProd = process.env.NODE_ENV === 'production';
     const api = {
         Response: reqCtx.Response || Response,
         TextEncoder: reqCtx.TextEncoder || TextEncoder,
@@ -52,26 +51,7 @@ export function createHandler(options, reqCtx = {}) {
             // If you wish to handle them differently, consider implementing your own request handler.
             console.error('Internal error occurred during request handling. ' +
                 'Please check your implementation.', err);
-            if (isProd) {
-                return new api.Response(null, { status: 500 });
-            }
-            else {
-                return new api.Response(JSON.stringify({
-                    errors: [
-                        err instanceof Error
-                            ? {
-                                message: err.message,
-                                stack: err.stack,
-                            }
-                            : err,
-                    ],
-                }), {
-                    status: 500,
-                    headers: {
-                        'content-type': 'application/json; charset=utf-8',
-                    },
-                });
-            }
+            return new api.Response(null, { status: 500 });
         }
     };
 }

package/lib/use/http.d.mts

@@ -22,7 +22,7 @@ export type HandlerOptions<Context extends OperationContext = undefined> = RawHa
  * ```js
  * import http from 'http';
  * import { createHandler } from 'graphql-http/lib/use/http';
- * import { schema } from './my-graphql-step/index.mjs';
+ * import { schema } from './my-graphql-schema/index.mjs';
  *
  * const server = http.createServer(createHandler({ schema }));
  *

package/lib/use/http.d.ts

@@ -22,7 +22,7 @@ export type HandlerOptions<Context extends OperationContext = undefined> = RawHa
  * ```js
  * import http from 'http';
  * import { createHandler } from 'graphql-http/lib/use/http';
- * import { schema } from './my-graphql-step';
+ * import { schema } from './my-graphql-schema';
  *
  * const server = http.createServer(createHandler({ schema }));
  *

package/lib/use/http.js

@@ -9,7 +9,7 @@ const handler_1 = require("../handler");
  * ```js
  * import http from 'http';
  * import { createHandler } from 'graphql-http/lib/use/http';
- * import { schema } from './my-graphql-step';
+ * import { schema } from './my-graphql-schema';
  *
  * const server = http.createServer(createHandler({ schema }));
  *
@@ -20,7 +20,6 @@ const handler_1 = require("../handler");
  * @category Server/http
  */
 function createHandler(options) {
-    const isProd = process.env.NODE_ENV === 'production';
     const handle = (0, handler_1.createHandler)(options);
     return async function requestListener(req, res) {
         try {
@@ -49,23 +48,7 @@ function createHandler(options) {
             // If you wish to handle them differently, consider implementing your own request handler.
             console.error('Internal error occurred during request handling. ' +
                 'Please check your implementation.', err);
-            if (isProd) {
-                res.writeHead(500).end();
-            }
-            else {
-                res
-                    .writeHead(500, { 'content-type': 'application/json; charset=utf-8' })
-                    .end(JSON.stringify({
-                    errors: [
-                        err instanceof Error
-                            ? {
-                                message: err.message,
-                                stack: err.stack,
-                            }
-                            : err,
-                    ],
-                }));
-            }
+            res.writeHead(500).end();
         }
     };
 }

package/lib/use/http.mjs

@@ -6,7 +6,7 @@ import { createHandler as createRawHandler, } from '../handler.mjs';
  * ```js
  * import http from 'http';
  * import { createHandler } from 'graphql-http/lib/use/http';
- * import { schema } from './my-graphql-step/index.mjs';
+ * import { schema } from './my-graphql-schema/index.mjs';
  *
  * const server = http.createServer(createHandler({ schema }));
  *
@@ -17,7 +17,6 @@ import { createHandler as createRawHandler, } from '../handler.mjs';
  * @category Server/http
  */
 export function createHandler(options) {
-    const isProd = process.env.NODE_ENV === 'production';
     const handle = createRawHandler(options);
     return async function requestListener(req, res) {
         try {
@@ -46,23 +45,7 @@ export function createHandler(options) {
             // If you wish to handle them differently, consider implementing your own request handler.
             console.error('Internal error occurred during request handling. ' +
                 'Please check your implementation.', err);
-            if (isProd) {
-                res.writeHead(500).end();
-            }
-            else {
-                res
-                    .writeHead(500, { 'content-type': 'application/json; charset=utf-8' })
-                    .end(JSON.stringify({
-                    errors: [
-                        err instanceof Error
-                            ? {
-                                message: err.message,
-                                stack: err.stack,
-                            }
-                            : err,
-                    ],
-                }));
-            }
+            res.writeHead(500).end();
         }
     };
 }

package/lib/use/http2.d.mts

@@ -28,7 +28,7 @@ export type HandlerOptions<Context extends OperationContext = undefined> = RawHa
  * import fs from 'fs';
  * import http2 from 'http2';
  * import { createHandler } from 'graphql-http/lib/use/http2';
- * import { schema } from './my-graphql-step/index.mjs';
+ * import { schema } from './my-graphql-schema/index.mjs';
  *
  * const server = http2.createSecureServer(
  *   {

package/lib/use/http2.d.ts

@@ -28,7 +28,7 @@ export type HandlerOptions<Context extends OperationContext = undefined> = RawHa
  * import fs from 'fs';
  * import http2 from 'http2';
  * import { createHandler } from 'graphql-http/lib/use/http2';
- * import { schema } from './my-graphql-step';
+ * import { schema } from './my-graphql-schema';
  *
  * const server = http2.createSecureServer(
  *   {

package/lib/use/http2.js

@@ -15,7 +15,7 @@ const handler_1 = require("../handler");
  * import fs from 'fs';
  * import http2 from 'http2';
  * import { createHandler } from 'graphql-http/lib/use/http2';
- * import { schema } from './my-graphql-step';
+ * import { schema } from './my-graphql-schema';
  *
  * const server = http2.createSecureServer(
  *   {
@@ -32,7 +32,6 @@ const handler_1 = require("../handler");
  * @category Server/http2
  */
 function createHandler(options) {
-    const isProd = process.env.NODE_ENV === 'production';
     const handle = (0, handler_1.createHandler)(options);
     return async function requestListener(req, res) {
         try {
@@ -67,23 +66,7 @@ function createHandler(options) {
             // If you wish to handle them differently, consider implementing your own request handler.
             console.error('Internal error occurred during request handling. ' +
                 'Please check your implementation.', err);
-            if (isProd) {
-                res.writeHead(500).end();
-            }
-            else {
-                res
-                    .writeHead(500, { 'content-type': 'application/json; charset=utf-8' })
-                    .end(JSON.stringify({
-                    errors: [
-                        err instanceof Error
-                            ? {
-                                message: err.message,
-                                stack: err.stack,
-                            }
-                            : err,
-                    ],
-                }));
-            }
+            res.writeHead(500).end();
         }
     };
 }

package/lib/use/http2.mjs

@@ -12,7 +12,7 @@ import { createHandler as createRawHandler, } from '../handler.mjs';
  * import fs from 'fs';
  * import http2 from 'http2';
  * import { createHandler } from 'graphql-http/lib/use/http2';
- * import { schema } from './my-graphql-step/index.mjs';
+ * import { schema } from './my-graphql-schema/index.mjs';
  *
  * const server = http2.createSecureServer(
  *   {
@@ -29,7 +29,6 @@ import { createHandler as createRawHandler, } from '../handler.mjs';
  * @category Server/http2
  */
 export function createHandler(options) {
-    const isProd = process.env.NODE_ENV === 'production';
     const handle = createRawHandler(options);
     return async function requestListener(req, res) {
         try {
@@ -64,23 +63,7 @@ export function createHandler(options) {
             // If you wish to handle them differently, consider implementing your own request handler.
             console.error('Internal error occurred during request handling. ' +
                 'Please check your implementation.', err);
-            if (isProd) {
-                res.writeHead(500).end();
-            }
-            else {
-                res
-                    .writeHead(500, { 'content-type': 'application/json; charset=utf-8' })
-                    .end(JSON.stringify({
-                    errors: [
-                        err instanceof Error
-                            ? {
-                                message: err.message,
-                                stack: err.stack,
-                            }
-                            : err,
-                    ],
-                }));
-            }
+            res.writeHead(500).end();
         }
     };
 }

package/lib/use/koa.js

@@ -22,7 +22,6 @@ const handler_1 = require("../handler");
  * @category Server/koa
  */
 function createHandler(options) {
-    const isProd = process.env.NODE_ENV === 'production';
     const handle = (0, handler_1.createHandler)(options);
     return async function requestListener(ctx) {
         try {
@@ -59,19 +58,6 @@ function createHandler(options) {
             console.error('Internal error occurred during request handling. ' +
                 'Please check your implementation.', err);
             ctx.response.status = 500;
-            if (!isProd) {
-                ctx.response.set('content-type', 'application/json; charset=utf-8');
-                ctx.body = {
-                    errors: [
-                        err instanceof Error
-                            ? {
-                                message: err.message,
-                                stack: err.stack,
-                            }
-                            : err,
-                    ],
-                };
-            }
         }
     };
 }

package/lib/use/koa.mjs

@@ -19,7 +19,6 @@ import { createHandler as createRawHandler, } from '../handler.mjs';
  * @category Server/koa
  */
 export function createHandler(options) {
-    const isProd = process.env.NODE_ENV === 'production';
     const handle = createRawHandler(options);
     return async function requestListener(ctx) {
         try {
@@ -56,19 +55,6 @@ export function createHandler(options) {
             console.error('Internal error occurred during request handling. ' +
                 'Please check your implementation.', err);
             ctx.response.status = 500;
-            if (!isProd) {
-                ctx.response.set('content-type', 'application/json; charset=utf-8');
-                ctx.body = {
-                    errors: [
-                        err instanceof Error
-                            ? {
-                                message: err.message,
-                                stack: err.stack,
-                            }
-                            : err,
-                    ],
-                };
-            }
         }
     };
 }

package/lib/use/node.d.mts

@@ -16,7 +16,7 @@ export type HandlerOptions<Context extends OperationContext = undefined> = HttpH
  * ```js
  * import http from 'http';
  * import { createHandler } from 'graphql-http/lib/use/node';
- * import { schema } from './my-graphql-step/index.mjs';
+ * import { schema } from './my-graphql-schema/index.mjs';
  *
  * const server = http.createServer(createHandler({ schema }));
  *