graphql-http 1.4.0 → 1.6.1

package/README.md

@@ -68,11 +68,12 @@ const server = http.createServer(async (req, res) => {
       url: req.url,
       method: req.method,
       headers: req.headers,
-      body: await new Promise((resolve) => {
-        let body = '';
-        req.on('data', (chunk) => (body += chunk));
-        req.on('end', () => resolve(body));
-      }),
+      body: () =>
+        new Promise((resolve) => {
+          let body = '';
+          req.on('data', (chunk) => (body += chunk));
+          req.on('end', () => resolve(body));
+        }),
       raw: req,
     });
     res.writeHead(init.status, init.statusText, init.headers).end(body);
@@ -119,11 +120,12 @@ const server = http2.createSecureServer(
         url: req.url,
         method: req.method,
         headers: req.headers,
-        body: await new Promise((resolve) => {
-          let body = '';
-          req.on('data', (chunk) => (body += chunk));
-          req.on('end', () => resolve(body));
-        }),
+        body: () =>
+          new Promise((resolve) => {
+            let body = '';
+            req.on('data', (chunk) => (body += chunk));
+            req.on('end', () => resolve(body));
+          }),
         raw: req,
       });
       res.writeHead(init.status, init.statusText, init.headers).end(body);
@@ -155,11 +157,12 @@ app.use('/graphql', async (req, res) => {
       url: req.url,
       method: req.method,
       headers: req.headers,
-      body: await new Promise((resolve) => {
-        let body = '';
-        req.on('data', (chunk) => (body += chunk));
-        req.on('end', () => resolve(body));
-      }),
+      body: () =>
+        new Promise((resolve) => {
+          let body = '';
+          req.on('data', (chunk) => (body += chunk));
+          req.on('end', () => resolve(body));
+        }),
       raw: req,
     });
     res.writeHead(init.status, init.statusText, init.headers).end(body);
@@ -227,7 +230,7 @@ await serve(
       url: req.url,
       method: req.method,
       headers,
-      body: await req.text(),
+      body: () => req.text(),
       raw: req,
     });
     return new Response(body, init);
@@ -686,11 +689,12 @@ const server = http.createServer(async (req, res) => {
       url: req.url,
       method: req.method,
       headers: req.headers,
-      body: await new Promise((resolve) => {
-        let body = '';
-        req.on('data', (chunk) => (body += chunk));
-        req.on('end', () => resolve(body));
-      }),
+      body: () =>
+        new Promise((resolve) => {
+          let body = '';
+          req.on('data', (chunk) => (body += chunk));
+          req.on('end', () => resolve(body));
+        }),
       raw: req,
     });
     res.writeHead(init.status, init.statusText, init.headers).end(body);
@@ -705,10 +709,40 @@ console.log('Listening to port 4000');
 
 </details>
 
+<details id="audit-jest">
+<summary><a href="#audit-jest">🔗</a> Audit for servers usage in <a href="https://jestjs.io">Jest</a> environment</summary>
+
+```js
+import { fetch } from '@whatwg-node/fetch';
+import { serverAudits } from 'graphql-http';
+
+for (const audit of serverAudits({
+  url: 'http://localhost:4000/graphql',
+  fetchFn: fetch,
+})) {
+  test(audit.name, async () => {
+    const result = await audit.fn();
+    if (result.status === 'error') {
+      throw result.reason;
+    }
+    if (result.status === 'warn') {
+      console.warn(result.reason); // or throw if you want full compliance (warnings are not requirements)
+    }
+    // result.status === 'ok'
+  });
+}
+```
+
+</details>
+
 ## [Documentation](docs/)
 
 Check the [docs folder](docs/) out for [TypeDoc](https://typedoc.org) generated documentation.
 
+## [Audits](implementations/)
+
+Inspect audits of other implementations in the [implementations folder](implementations/). Adding your implementation is very welcome!
+
 ## [Want to help?](CONTRIBUTING.md)
 
 File a bug, contribute with code, or improve documentation? Read up on our guidelines for [contributing](CONTRIBUTING.md) and drive development with `yarn test --watch` away!

package/lib/audits/common.d.mts

@@ -0,0 +1,58 @@
+/**
+ *
+ * audit/common
+ *
+ */
+/**
+ * Audit requirement levels as per [RFC2119](https://www.rfc-editor.org/rfc/rfc2119).
+ *
+ * @category Audits
+ */
+export declare type AuditRequirement = 'MUST' | 'SHOULD' | 'MAY';
+/**
+ * Audit name starting with the audit requirement level.
+ *
+ * @category Audits
+ */
+export declare type AuditName = `${AuditRequirement} ${string}`;
+/**
+ * Actual audit test returning an result.
+ *
+ * The test function will throw only if the error is fatal.
+ *
+ * @category Audits
+ */
+export interface Audit {
+    name: AuditName;
+    fn: () => Promise<AuditResult>;
+}
+/**
+ * Indicates that the audit was successful.
+ *
+ * @category Audits
+ */
+export interface AuditOk {
+    name: AuditName;
+    status: 'ok';
+}
+/**
+ * Indicates that the audit failed.
+ *
+ * If the status is `warn`, the audit is not a requirement but rather a recommendation.
+ *
+ * On the other hand, if the status is `error`, the audit is a requirement and the source
+ * is therefore not compliant.
+ *
+ * @category Audits
+ */
+export interface AuditFail {
+    name: AuditName;
+    status: 'warn' | 'error';
+    reason: string;
+}
+/**
+ * Result of the performed audit. See `AuditOk` and `AuditFail` for more information.
+ *
+ * @category Audits
+ */
+export declare type AuditResult = AuditOk | AuditFail;

package/lib/audits/common.d.ts

@@ -0,0 +1,58 @@
+/**
+ *
+ * audit/common
+ *
+ */
+/**
+ * Audit requirement levels as per [RFC2119](https://www.rfc-editor.org/rfc/rfc2119).
+ *
+ * @category Audits
+ */
+export declare type AuditRequirement = 'MUST' | 'SHOULD' | 'MAY';
+/**
+ * Audit name starting with the audit requirement level.
+ *
+ * @category Audits
+ */
+export declare type AuditName = `${AuditRequirement} ${string}`;
+/**
+ * Actual audit test returning an result.
+ *
+ * The test function will throw only if the error is fatal.
+ *
+ * @category Audits
+ */
+export interface Audit {
+    name: AuditName;
+    fn: () => Promise<AuditResult>;
+}
+/**
+ * Indicates that the audit was successful.
+ *
+ * @category Audits
+ */
+export interface AuditOk {
+    name: AuditName;
+    status: 'ok';
+}
+/**
+ * Indicates that the audit failed.
+ *
+ * If the status is `warn`, the audit is not a requirement but rather a recommendation.
+ *
+ * On the other hand, if the status is `error`, the audit is a requirement and the source
+ * is therefore not compliant.
+ *
+ * @category Audits
+ */
+export interface AuditFail {
+    name: AuditName;
+    status: 'warn' | 'error';
+    reason: string;
+}
+/**
+ * Result of the performed audit. See `AuditOk` and `AuditFail` for more information.
+ *
+ * @category Audits
+ */
+export declare type AuditResult = AuditOk | AuditFail;

package/lib/audits/common.js

@@ -0,0 +1,7 @@
+"use strict";
+/**
+ *
+ * audit/common
+ *
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/audits/common.mjs

@@ -0,0 +1,6 @@
+/**
+ *
+ * audit/common
+ *
+ */
+export {};

package/lib/audits/index.d.mts

@@ -0,0 +1,2 @@
+export * from './common';
+export * from './server';

package/lib/audits/index.d.ts

@@ -0,0 +1,2 @@
+export * from './common';
+export * from './server';

package/lib/audits/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./common"), exports);
+__exportStar(require("./server"), exports);

package/lib/audits/index.mjs

@@ -0,0 +1,2 @@
+export * from './common.mjs';
+export * from './server.mjs';

package/lib/audits/server.d.mts

@@ -0,0 +1,39 @@
+/**
+ *
+ * audit/server
+ *
+ */
+import { Audit, AuditResult } from './common';
+/**
+ * Options for server audits required to check GraphQL over HTTP spec conformance.
+ *
+ * @category Audits
+ */
+export interface ServerAuditOptions {
+    /**
+     * The URL of the GraphQL server for the audit.
+     */
+    url: string;
+    /**
+     * The Fetch function to use.
+     *
+     * For NodeJS environments consider using [`@whatwg-node/fetch`](https://github.com/ardatan/whatwg-node/tree/master/packages/fetch).
+     *
+     * @default global.fetch
+     */
+    fetchFn?: unknown;
+}
+/**
+ * List of server audits required to check GraphQL over HTTP spec conformance.
+ *
+ * @category Audits
+ */
+export declare function serverAudits(opts: ServerAuditOptions): Audit[];
+/**
+ * Performs the full list of server audits required for GraphQL over HTTP spec conformance.
+ *
+ * Please consult the `AuditResult` for more information.
+ *
+ * @category Audits
+ */
+export declare function auditServer(opts: ServerAuditOptions): Promise<AuditResult[]>;

package/lib/audits/server.d.ts

@@ -0,0 +1,39 @@
+/**
+ *
+ * audit/server
+ *
+ */
+import { Audit, AuditResult } from './common';
+/**
+ * Options for server audits required to check GraphQL over HTTP spec conformance.
+ *
+ * @category Audits
+ */
+export interface ServerAuditOptions {
+    /**
+     * The URL of the GraphQL server for the audit.
+     */
+    url: string;
+    /**
+     * The Fetch function to use.
+     *
+     * For NodeJS environments consider using [`@whatwg-node/fetch`](https://github.com/ardatan/whatwg-node/tree/master/packages/fetch).
+     *
+     * @default global.fetch
+     */
+    fetchFn?: unknown;
+}
+/**
+ * List of server audits required to check GraphQL over HTTP spec conformance.
+ *
+ * @category Audits
+ */
+export declare function serverAudits(opts: ServerAuditOptions): Audit[];
+/**
+ * Performs the full list of server audits required for GraphQL over HTTP spec conformance.
+ *
+ * Please consult the `AuditResult` for more information.
+ *
+ * @category Audits
+ */
+export declare function auditServer(opts: ServerAuditOptions): Promise<AuditResult[]>;