graphql-http 1.21.0 → 1.22.0

package/lib/use/uWebSockets.d.ts

@@ -1,5 +1,6 @@
 import type { HttpRequest, HttpResponse } from 'uWebSockets.js';
 import { HandlerOptions as RawHandlerOptions, OperationContext } from '../handler';
+import { RequestParams } from '../common';
 /**
  * The context in the request for the handler.
  *
@@ -8,6 +9,60 @@ import { HandlerOptions as RawHandlerOptions, OperationContext } from '../handle
 export interface RequestContext {
     res: HttpResponse;
 }
+/**
+ * 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 declare function parseRequestParams(req: HttpRequest, res: HttpResponse, abortedRef: {
+    current: boolean;
+}): Promise<RequestParams | null>;
 /**
  * Handler options when using the http adapter.
  *

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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "graphql-http",
-  "version": "1.21.0",
+  "version": "1.22.0",
   "description": "Simple, pluggable, zero-dependency, GraphQL over HTTP spec compliant server, client and audit suite.",
   "keywords": [
     "graphql",
@@ -116,43 +116,43 @@
     "graphql": ">=0.11 <=16"
   },
   "devDependencies": {
-    "@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/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",
-    "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",
     "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",
-    "vitest": "^0.33.0"
+    "uWebSockets.js": "uNetworking/uWebSockets.js#v20.31.0",
+    "vitest": "^0.34.1"
   }
 }