graphql-http 1.20.0 → 1.22.0

package/lib/use/uWebSockets.js

@@ -1,7 +1,82 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.createHandler = void 0;
+exports.createHandler = exports.parseRequestParams = void 0;
 const handler_1 = require("../handler");
+/**
+ * The GraphQL over HTTP spec compliant request parser for an incoming GraphQL request.
+ *
+ * It is important to pass in the `abortedRef` so that the parser does not perform any
+ * operations on a disposed request (see example).
+ *
+ * If the HTTP request _is not_ a [well-formatted GraphQL over HTTP request](https://graphql.github.io/graphql-over-http/draft/#sec-Request), the function will respond
+ * on the `HttpResponse` argument and return `null`.
+ *
+ * If the HTTP request _is_ a [well-formatted GraphQL over HTTP request](https://graphql.github.io/graphql-over-http/draft/#sec-Request), but is invalid or malformed,
+ * the function will throw an error and it is up to the user to handle and respond as they see fit.
+ *
+ * ```js
+ * import uWS from 'uWebSockets.js'; // yarn add uWebSockets.js@uNetworking/uWebSockets.js#<version>
+ * import { parseRequestParams } from 'graphql-http/lib/use/uWebSockets';
+ *
+ * uWS
+ *   .App()
+ *   .any('/graphql', async (res, req) => {
+ *     const abortedRef = { current: false };
+ *     res.onAborted(() => (abortedRef.current = true));
+ *     try {
+ *       const maybeParams = await parseRequestParams(req, res, abortedRef);
+ *       if (!maybeParams) {
+ *         // not a well-formatted GraphQL over HTTP request,
+ *         // parser responded and there's nothing else to do
+ *         return;
+ *       }
+ *
+ *       // well-formatted GraphQL over HTTP request,
+ *       // with valid parameters
+ *       if (!abortedRef.current) {
+ *         res.writeStatus('200 OK');
+ *         res.end(JSON.stringify(maybeParams, null, '  '));
+ *       }
+ *     } catch (err) {
+ *       // well-formatted GraphQL over HTTP request,
+ *       // but with invalid parameters
+ *       if (!abortedRef.current) {
+ *         res.writeStatus('400 Bad Request');
+ *         res.end(err.message);
+ *       }
+ *     }
+ *   })
+ *   .listen(4000, () => {
+ *     console.log('Listening to port 4000');
+ *   });
+ * ```
+ *
+ * @category Server/uWebSockets
+ */
+async function parseRequestParams(req, res, abortedRef) {
+    const rawReq = toRequest(req, res, abortedRef);
+    const paramsOrRes = await (0, handler_1.parseRequestParams)(rawReq);
+    if (!('query' in paramsOrRes)) {
+        if (!abortedRef.current) {
+            const [body, init] = paramsOrRes;
+            res.cork(() => {
+                res.writeStatus(`${init.status} ${init.statusText}`);
+                for (const [key, val] of Object.entries(init.headers || {})) {
+                    res.writeHeader(key, val);
+                }
+                if (body) {
+                    res.end(body);
+                }
+                else {
+                    res.endWithoutBody();
+                }
+            });
+        }
+        return null;
+    }
+    return paramsOrRes;
+}
+exports.parseRequestParams = parseRequestParams;
 /**
  * Create a GraphQL over HTTP spec compliant request handler for
  * the Node environment [uWebSockets.js module](https://github.com/uNetworking/uWebSockets.js/).
@@ -24,36 +99,11 @@ const handler_1 = require("../handler");
 function createHandler(options) {
     const handle = (0, handler_1.createHandler)(options);
     return async function requestListener(res, req) {
-        let aborted = false;
-        res.onAborted(() => (aborted = true));
+        const abortedRef = { current: false };
+        res.onAborted(() => (abortedRef.current = true));
         try {
-            let url = req.getUrl();
-            const query = req.getQuery();
-            if (query) {
-                url += '?' + query;
-            }
-            const [body, init] = await handle({
-                url,
-                method: req.getMethod().toUpperCase(),
-                headers: { get: (key) => req.getHeader(key) },
-                body: () => new Promise((resolve) => {
-                    let body = '';
-                    if (aborted) {
-                        resolve(body);
-                    }
-                    else {
-                        res.onData((chunk, isLast) => {
-                            body += Buffer.from(chunk, 0, chunk.byteLength).toString();
-                            if (isLast) {
-                                resolve(body);
-                            }
-                        });
-                    }
-                }),
-                raw: req,
-                context: { res },
-            });
-            if (!aborted) {
+            const [body, init] = await handle(toRequest(req, res, abortedRef));
+            if (!abortedRef.current) {
                 res.cork(() => {
                     res.writeStatus(`${init.status} ${init.statusText}`);
                     for (const [key, val] of Object.entries(init.headers || {})) {
@@ -73,7 +123,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 (!aborted) {
+            if (!abortedRef.current) {
                 res.cork(() => {
                     res.writeStatus('500 Internal Server Error').endWithoutBody();
                 });
@@ -82,3 +132,31 @@ function createHandler(options) {
     };
 }
 exports.createHandler = createHandler;
+function toRequest(req, res, abortedRef) {
+    let url = req.getUrl();
+    const query = req.getQuery();
+    if (query) {
+        url += '?' + query;
+    }
+    return {
+        url,
+        method: req.getMethod().toUpperCase(),
+        headers: { get: (key) => req.getHeader(key) },
+        body: () => new Promise((resolve) => {
+            let body = '';
+            if (abortedRef.current) {
+                resolve(body);
+            }
+            else {
+                res.onData((chunk, isLast) => {
+                    body += Buffer.from(chunk, 0, chunk.byteLength).toString();
+                    if (isLast) {
+                        resolve(body);
+                    }
+                });
+            }
+        }),
+        raw: req,
+        context: { res },
+    };
+}

package/lib/use/uWebSockets.mjs

@@ -1,4 +1,78 @@
-import { createHandler as createRawHandler, } from '../handler.mjs';
+import { createHandler as createRawHandler, parseRequestParams as rawParseRequestParams, } from '../handler.mjs';
+/**
+ * The GraphQL over HTTP spec compliant request parser for an incoming GraphQL request.
+ *
+ * It is important to pass in the `abortedRef` so that the parser does not perform any
+ * operations on a disposed request (see example).
+ *
+ * If the HTTP request _is not_ a [well-formatted GraphQL over HTTP request](https://graphql.github.io/graphql-over-http/draft/#sec-Request), the function will respond
+ * on the `HttpResponse` argument and return `null`.
+ *
+ * If the HTTP request _is_ a [well-formatted GraphQL over HTTP request](https://graphql.github.io/graphql-over-http/draft/#sec-Request), but is invalid or malformed,
+ * the function will throw an error and it is up to the user to handle and respond as they see fit.
+ *
+ * ```js
+ * import uWS from 'uWebSockets.js'; // yarn add uWebSockets.js@uNetworking/uWebSockets.js#<version>
+ * import { parseRequestParams } from 'graphql-http/lib/use/uWebSockets';
+ *
+ * uWS
+ *   .App()
+ *   .any('/graphql', async (res, req) => {
+ *     const abortedRef = { current: false };
+ *     res.onAborted(() => (abortedRef.current = true));
+ *     try {
+ *       const maybeParams = await parseRequestParams(req, res, abortedRef);
+ *       if (!maybeParams) {
+ *         // not a well-formatted GraphQL over HTTP request,
+ *         // parser responded and there's nothing else to do
+ *         return;
+ *       }
+ *
+ *       // well-formatted GraphQL over HTTP request,
+ *       // with valid parameters
+ *       if (!abortedRef.current) {
+ *         res.writeStatus('200 OK');
+ *         res.end(JSON.stringify(maybeParams, null, '  '));
+ *       }
+ *     } catch (err) {
+ *       // well-formatted GraphQL over HTTP request,
+ *       // but with invalid parameters
+ *       if (!abortedRef.current) {
+ *         res.writeStatus('400 Bad Request');
+ *         res.end(err.message);
+ *       }
+ *     }
+ *   })
+ *   .listen(4000, () => {
+ *     console.log('Listening to port 4000');
+ *   });
+ * ```
+ *
+ * @category Server/uWebSockets
+ */
+export async function parseRequestParams(req, res, abortedRef) {
+    const rawReq = toRequest(req, res, abortedRef);
+    const paramsOrRes = await rawParseRequestParams(rawReq);
+    if (!('query' in paramsOrRes)) {
+        if (!abortedRef.current) {
+            const [body, init] = paramsOrRes;
+            res.cork(() => {
+                res.writeStatus(`${init.status} ${init.statusText}`);
+                for (const [key, val] of Object.entries(init.headers || {})) {
+                    res.writeHeader(key, val);
+                }
+                if (body) {
+                    res.end(body);
+                }
+                else {
+                    res.endWithoutBody();
+                }
+            });
+        }
+        return null;
+    }
+    return paramsOrRes;
+}
 /**
  * Create a GraphQL over HTTP spec compliant request handler for
  * the Node environment [uWebSockets.js module](https://github.com/uNetworking/uWebSockets.js/).
@@ -21,36 +95,11 @@ import { createHandler as createRawHandler, } from '../handler.mjs';
 export function createHandler(options) {
     const handle = createRawHandler(options);
     return async function requestListener(res, req) {
-        let aborted = false;
-        res.onAborted(() => (aborted = true));
+        const abortedRef = { current: false };
+        res.onAborted(() => (abortedRef.current = true));
         try {
-            let url = req.getUrl();
-            const query = req.getQuery();
-            if (query) {
-                url += '?' + query;
-            }
-            const [body, init] = await handle({
-                url,
-                method: req.getMethod().toUpperCase(),
-                headers: { get: (key) => req.getHeader(key) },
-                body: () => new Promise((resolve) => {
-                    let body = '';
-                    if (aborted) {
-                        resolve(body);
-                    }
-                    else {
-                        res.onData((chunk, isLast) => {
-                            body += Buffer.from(chunk, 0, chunk.byteLength).toString();
-                            if (isLast) {
-                                resolve(body);
-                            }
-                        });
-                    }
-                }),
-                raw: req,
-                context: { res },
-            });
-            if (!aborted) {
+            const [body, init] = await handle(toRequest(req, res, abortedRef));
+            if (!abortedRef.current) {
                 res.cork(() => {
                     res.writeStatus(`${init.status} ${init.statusText}`);
                     for (const [key, val] of Object.entries(init.headers || {})) {
@@ -70,7 +119,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 (!aborted) {
+            if (!abortedRef.current) {
                 res.cork(() => {
                     res.writeStatus('500 Internal Server Error').endWithoutBody();
                 });
@@ -78,3 +127,31 @@ export function createHandler(options) {
         }
     };
 }
+function toRequest(req, res, abortedRef) {
+    let url = req.getUrl();
+    const query = req.getQuery();
+    if (query) {
+        url += '?' + query;
+    }
+    return {
+        url,
+        method: req.getMethod().toUpperCase(),
+        headers: { get: (key) => req.getHeader(key) },
+        body: () => new Promise((resolve) => {
+            let body = '';
+            if (abortedRef.current) {
+                resolve(body);
+            }
+            else {
+                res.onData((chunk, isLast) => {
+                    body += Buffer.from(chunk, 0, chunk.byteLength).toString();
+                    if (isLast) {
+                        resolve(body);
+                    }
+                });
+            }
+        }),
+        raw: req,
+        context: { res },
+    };
+}

package/lib/utils.d.mts

@@ -4,18 +4,11 @@
  *
  */
 import type { ExecutionResult } from 'graphql';
-import { GraphQLError } from 'graphql';
 /** @private */
 export declare function extendedTypeof(val: unknown): 'string' | 'number' | 'bigint' | 'boolean' | 'symbol' | 'undefined' | 'object' | 'function' | 'array' | 'null';
 /** @private */
 export declare function isObject(val: unknown): val is Record<PropertyKey, any>;
 /** @private */
-export declare function areGraphQLErrors(obj: unknown): obj is readonly GraphQLError[];
-/** @private */
-export declare function isGraphQLError(obj: unknown): obj is GraphQLError;
-/** @private */
 export declare function isExecutionResult(val: unknown): val is ExecutionResult;
 /** @private */
 export declare function isAsyncIterable<T = unknown>(val: unknown): val is AsyncIterable<T>;
-/** @private */
-export declare function jsonErrorReplacer(_key: string, val: any): any;

package/lib/utils.d.ts

@@ -4,18 +4,11 @@
  *
  */
 import type { ExecutionResult } from 'graphql';
-import { GraphQLError } from 'graphql';
 /** @private */
 export declare function extendedTypeof(val: unknown): 'string' | 'number' | 'bigint' | 'boolean' | 'symbol' | 'undefined' | 'object' | 'function' | 'array' | 'null';
 /** @private */
 export declare function isObject(val: unknown): val is Record<PropertyKey, any>;
 /** @private */
-export declare function areGraphQLErrors(obj: unknown): obj is readonly GraphQLError[];
-/** @private */
-export declare function isGraphQLError(obj: unknown): obj is GraphQLError;
-/** @private */
 export declare function isExecutionResult(val: unknown): val is ExecutionResult;
 /** @private */
 export declare function isAsyncIterable<T = unknown>(val: unknown): val is AsyncIterable<T>;
-/** @private */
-export declare function jsonErrorReplacer(_key: string, val: any): any;

package/lib/utils.js

@@ -5,8 +5,7 @@
  *
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.jsonErrorReplacer = exports.isAsyncIterable = exports.isExecutionResult = exports.isGraphQLError = exports.areGraphQLErrors = exports.isObject = exports.extendedTypeof = void 0;
-const graphql_1 = require("graphql");
+exports.isAsyncIterable = exports.isExecutionResult = exports.isObject = exports.extendedTypeof = void 0;
 /** @private */
 function extendedTypeof(val) {
     if (val === null) {
@@ -24,19 +23,6 @@ function isObject(val) {
 }
 exports.isObject = isObject;
 /** @private */
-function areGraphQLErrors(obj) {
-    return (Array.isArray(obj) &&
-        obj.length > 0 &&
-        // if one item in the array is a GraphQLError, we're good
-        obj.some(isGraphQLError));
-}
-exports.areGraphQLErrors = areGraphQLErrors;
-/** @private */
-function isGraphQLError(obj) {
-    return obj instanceof graphql_1.GraphQLError;
-}
-exports.isGraphQLError = isGraphQLError;
-/** @private */
 function isExecutionResult(val) {
     return (isObject(val) &&
         ('data' in val || ('data' in val && val.data == null && 'errors' in val)));
@@ -47,19 +33,3 @@ function isAsyncIterable(val) {
     return typeof Object(val)[Symbol.asyncIterator] === 'function';
 }
 exports.isAsyncIterable = isAsyncIterable;
-/** @private */
-function jsonErrorReplacer(_key, 
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
-val) {
-    if (val instanceof Error &&
-        // GraphQL errors implement their own stringer
-        !isGraphQLError(val)) {
-        return {
-            // name: val.name, name is included in message
-            message: val.message,
-            // stack: val.stack, can leak sensitive details
-        };
-    }
-    return val;
-}
-exports.jsonErrorReplacer = jsonErrorReplacer;

package/lib/utils.mjs

@@ -3,7 +3,6 @@
  * utils
  *
  */
-import { GraphQLError } from 'graphql';
 /** @private */
 export function extendedTypeof(val) {
     if (val === null) {
@@ -19,17 +18,6 @@ export function isObject(val) {
     return typeof val === 'object' && val !== null;
 }
 /** @private */
-export function areGraphQLErrors(obj) {
-    return (Array.isArray(obj) &&
-        obj.length > 0 &&
-        // if one item in the array is a GraphQLError, we're good
-        obj.some(isGraphQLError));
-}
-/** @private */
-export function isGraphQLError(obj) {
-    return obj instanceof GraphQLError;
-}
-/** @private */
 export function isExecutionResult(val) {
     return (isObject(val) &&
         ('data' in val || ('data' in val && val.data == null && 'errors' in val)));
@@ -38,18 +26,3 @@ export function isExecutionResult(val) {
 export function isAsyncIterable(val) {
     return typeof Object(val)[Symbol.asyncIterator] === 'function';
 }
-/** @private */
-export function jsonErrorReplacer(_key, 
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
-val) {
-    if (val instanceof Error &&
-        // GraphQL errors implement their own stringer
-        !isGraphQLError(val)) {
-        return {
-            // name: val.name, name is included in message
-            message: val.message,
-            // stack: val.stack, can leak sensitive details
-        };
-    }
-    return val;
-}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "graphql-http",
-  "version": "1.20.0",
+  "version": "1.22.0",
   "description": "Simple, pluggable, zero-dependency, GraphQL over HTTP spec compliant server, client and audit suite.",
   "keywords": [
     "graphql",
@@ -65,6 +65,11 @@
       "require": "./lib/use/fastify.js",
       "import": "./lib/use/fastify.mjs"
     },
+    "./lib/use/@netlify/functions": {
+      "types": "./lib/use/@netlify/functions.d.ts",
+      "require": "./lib/use/@netlify/functions.js",
+      "import": "./lib/use/@netlify/functions.mjs"
+    },
     "./lib/use/koa": {
       "types": "./lib/use/koa.d.ts",
       "require": "./lib/use/koa.js",
@@ -96,7 +101,7 @@
     "check:lint": "eslint 'src'",
     "check:spell": "cspell --gitignore **/*.md",
     "check:type": "tsc --noEmit",
-    "test": "NODE_OPTIONS=--experimental-vm-modules NODE_NO_WARNINGS=1 jest",
+    "test": "vitest",
     "build:esm": "tsc -b tsconfig.esm.json && tsx scripts/esm-post-process.ts",
     "build:cjs": "tsc -b tsconfig.cjs.json",
     "build:umd": "rollup --configPlugin typescript --config rollup.config.ts",
@@ -111,52 +116,43 @@
     "graphql": ">=0.11 <=16"
   },
   "devDependencies": {
-    "@babel/core": "^7.22.8",
-    "@babel/plugin-proposal-class-properties": "^7.18.6",
-    "@babel/plugin-proposal-nullish-coalescing-operator": "^7.18.6",
-    "@babel/plugin-proposal-object-rest-spread": "^7.20.7",
-    "@babel/plugin-proposal-optional-chaining": "^7.21.0",
-    "@babel/preset-env": "^7.22.7",
-    "@babel/preset-typescript": "^7.22.5",
-    "@cspell/cspell-types": "^6.31.1",
+    "@cspell/cspell-types": "^7.0.0",
+    "@netlify/functions": "^1.6.0",
     "@rollup/plugin-terser": "^0.4.3",
     "@rollup/plugin-typescript": "^11.1.2",
     "@semantic-release/changelog": "^6.0.3",
     "@semantic-release/git": "^10.0.1",
-    "@types/eslint": "^8.44.0",
+    "@types/eslint": "^8.44.2",
     "@types/express": "^4.17.17",
     "@types/glob": "^8.1.0",
     "@types/html-validator": "^5.0.3",
-    "@types/jest": "^29.5.2",
-    "@types/k6": "^0.45.0",
-    "@types/koa": "^2.13.6",
+    "@types/k6": "^0.46.0",
+    "@types/koa": "^2.13.8",
     "@types/koa-mount": "^4.0.2",
-    "@typescript-eslint/eslint-plugin": "^5.61.0",
-    "@typescript-eslint/parser": "^5.61.0",
-    "@whatwg-node/fetch": "^0.9.7",
-    "babel-jest": "^29.6.1",
-    "cspell": "^6.31.1",
-    "eslint": "^8.44.0",
-    "eslint-config-prettier": "^8.8.0",
+    "@typescript-eslint/eslint-plugin": "^6.4.0",
+    "@typescript-eslint/parser": "^6.4.0",
+    "@whatwg-node/fetch": "^0.9.9",
+    "cspell": "^7.0.0",
+    "eslint": "^8.47.0",
+    "eslint-config-prettier": "^9.0.0",
     "express": "^4.18.2",
-    "fastify": "^4.19.2",
-    "glob": "^10.3.2",
-    "graphql": "^16.7.1",
+    "fastify": "^4.21.0",
+    "glob": "^10.3.3",
+    "graphql": "^16.8.0",
     "html-validator": "^6.0.1",
-    "jest": "^29.6.1",
-    "jest-jasmine2": "^29.6.1",
     "koa": "^2.14.2",
     "koa-mount": "^4.0.0",
-    "node-fetch": "^3.3.1",
-    "prettier": "^2.8.8",
-    "rollup": "^3.26.2",
+    "node-fetch": "^3.3.2",
+    "prettier": "^3.0.1",
+    "rollup": "^3.28.0",
     "rollup-plugin-gzip": "^3.1.0",
     "semantic-release": "^21.0.7",
-    "tslib": "^2.6.0",
+    "tslib": "^2.6.1",
     "tsx": "^3.12.7",
     "typedoc": "^0.24.8",
-    "typedoc-plugin-markdown": "^3.15.3",
+    "typedoc-plugin-markdown": "^3.15.4",
     "typescript": "^5.1.6",
-    "uWebSockets.js": "uNetworking/uWebSockets.js#v20.30.0"
+    "uWebSockets.js": "uNetworking/uWebSockets.js#v20.31.0",
+    "vitest": "^0.34.1"
   }
 }

package/umd/graphql-http-audits.js

@@ -1,6 +1,6 @@
 (function (global, factory) {
-    typeof exports === 'object' && typeof module !== 'undefined' ? factory(exports, require('graphql')) :
-    typeof define === 'function' && define.amd ? define(['exports', 'graphql'], factory) :
+    typeof exports === 'object' && typeof module !== 'undefined' ? factory(exports) :
+    typeof define === 'function' && define.amd ? define(['exports'], factory) :
     (global = typeof globalThis !== 'undefined' ? globalThis : global || self, factory(global.graphqlHttpAudits = {}));
 })(this, (function (exports) { 'use strict';