graphql-http 1.11.0 → 1.12.0

package/lib/audits/utils.js

@@ -19,7 +19,7 @@ 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 });
-exports.assertBodyAsExecutionResult = exports.assert = exports.audit = void 0;
+exports.ressert = exports.AuditError = exports.audit = void 0;
 __exportStar(require("../utils"), exports);
 /**
  * Wrap and prepare an audit for testing.
@@ -37,10 +37,10 @@ function audit(name, fn) {
                     status: 'ok',
                 };
             }
-            catch (errOrReason) {
-                if (typeof errOrReason !== 'string') {
-                    // anything thrown that is not an assertion string is considered fatal
-                    throw errOrReason;
+            catch (err) {
+                if (!(err instanceof AuditError)) {
+                    // anything thrown that is not an assertion error is considered fatal
+                    throw err;
                 }
                 return {
                     name,
@@ -49,7 +49,8 @@ function audit(name, fn) {
                             'error'
                         : // everything else is optional and considered a warning
                             'warn',
-                    reason: errOrReason,
+                    reason: err.reason,
+                    response: err.response,
                 };
             }
         },
@@ -57,71 +58,98 @@ function audit(name, fn) {
 }
 exports.audit = audit;
 /**
- * Will throw a string if the assertion fails.
+ * Error thrown when an assertion test fails.
  *
- * All fatal problems will throw an instance of Error.
+ * @private
+ */
+class AuditError {
+    constructor(response, reason) {
+        this.response = response;
+        this.reason = reason;
+    }
+}
+exports.AuditError = AuditError;
+/**
+ * Will throw an AuditError if the assertion on Response fails.
+ *
+ * All fatal problems will throw an instance of an Error.
+ *
+ * The name "ressert" is a wordplay combining "response" and "assert".
  *
  * @private
  */
-function assert(name, actual) {
+function ressert(res) {
     return {
-        toBe: (expected) => {
-            if (actual !== expected) {
-                throw `${name} ${actual} is not ${expected}`;
-            }
-        },
-        toBeBetween: (min, max) => {
-            if (!(min <= actual && actual <= max)) {
-                throw `${name} ${actual} is not between ${min} and ${max}`;
-            }
-        },
-        toContain: (expected) => {
-            // @ts-expect-error types will match, otherwise never
-            // eslint-disable-next-line @typescript-eslint/no-explicit-any
-            if (!actual.includes(expected)) {
-                throw `${name} ${JSON.stringify(actual)} does not contain ${JSON.stringify(expected)}`;
-            }
-        },
-        notToContain: (expected) => {
-            // @ts-expect-error types will match, otherwise never
-            // eslint-disable-next-line @typescript-eslint/no-explicit-any
-            if (actual.includes(expected)) {
-                throw `${name} ${JSON.stringify(actual)} contains ${JSON.stringify(expected)}`;
-            }
+        status: {
+            toBe(code) {
+                if (res.status !== code) {
+                    throw new AuditError(res, `Response status code is not ${code}`);
+                }
+            },
+            toBeBetween: (min, max) => {
+                if (!(min <= res.status && res.status <= max)) {
+                    throw new AuditError(res, `Response status is not between ${min} and ${max}`);
+                }
+            },
         },
-        toHaveProperty: (
-        // eslint-disable-next-line @typescript-eslint/no-explicit-any
-        prop) => {
-            // @ts-expect-error types will match, otherwise never
-            if (!(prop in actual)) {
-                throw `${name} ${JSON.stringify(actual)} does not have a property '${String(prop)}'`;
-            }
+        header(key) {
+            return {
+                toContain(part) {
+                    var _a;
+                    if (!((_a = res.headers.get(key)) === null || _a === void 0 ? void 0 : _a.includes(part))) {
+                        throw new AuditError(res, `Response header ${key} does not contain ${part}`);
+                    }
+                },
+                notToContain(part) {
+                    var _a;
+                    if ((_a = res.headers.get(key)) === null || _a === void 0 ? void 0 : _a.includes(part)) {
+                        throw new AuditError(res, `Response header ${key} contains ${part}`);
+                    }
+                },
+            };
         },
-        notToHaveProperty: (
-        // eslint-disable-next-line @typescript-eslint/no-explicit-any
-        prop) => {
-            // @ts-expect-error types will match, otherwise never
-            if (prop in actual) {
-                throw `${name} ${JSON.stringify(actual)} does have a property '${String(prop)}'`;
-            }
+        bodyAsExecutionResult: {
+            data: {
+                async toBe(val) {
+                    const body = await assertBodyAsExecutionResult(res);
+                    if (body.data !== val) {
+                        throw new AuditError(res, `Response body execution result data is not "${val}"`);
+                    }
+                },
+            },
+            async toHaveProperty(key) {
+                const body = await assertBodyAsExecutionResult(res);
+                if (!(key in body)) {
+                    throw new AuditError(res, `Response body execution result does not have a property "${key}"`);
+                }
+            },
+            async notToHaveProperty(key) {
+                const body = await assertBodyAsExecutionResult(res);
+                if (key in body) {
+                    throw new AuditError(res, `Response body execution result has a property "${key}"`);
+                }
+            },
         },
     };
 }
-exports.assert = assert;
-/**
- * Parses the string as JSON and safely reports parsing issues for audits.
- *
- * Assumes the parsed JSON will be an `ExecutionResult`.
- *
- * @private
- * */
+exports.ressert = ressert;
+/** @private */
 async function assertBodyAsExecutionResult(res) {
-    const str = await res.text();
+    let decoded;
+    try {
+        const decoder = new TextDecoder('utf-8');
+        const buff = await res.arrayBuffer();
+        decoded = decoder.decode(buff);
+    }
+    catch (err) {
+        throw new AuditError(res, 'Response body is not UTF-8 encoded');
+    }
+    let body;
     try {
-        return JSON.parse(str);
+        body = JSON.parse(decoded);
     }
     catch (err) {
-        throw `Response body is not valid JSON. Got ${JSON.stringify(str)}`;
+        throw new AuditError(res, 'Response body is not valid JSON');
     }
+    return body;
 }
-exports.assertBodyAsExecutionResult = assertBodyAsExecutionResult;

package/lib/audits/utils.mjs

@@ -20,10 +20,10 @@ export function audit(name, fn) {
                     status: 'ok',
                 };
             }
-            catch (errOrReason) {
-                if (typeof errOrReason !== 'string') {
-                    // anything thrown that is not an assertion string is considered fatal
-                    throw errOrReason;
+            catch (err) {
+                if (!(err instanceof AuditError)) {
+                    // anything thrown that is not an assertion error is considered fatal
+                    throw err;
                 }
                 return {
                     name,
@@ -32,76 +32,104 @@ export function audit(name, fn) {
                             'error'
                         : // everything else is optional and considered a warning
                             'warn',
-                    reason: errOrReason,
+                    reason: err.reason,
+                    response: err.response,
                 };
             }
         },
     };
 }
 /**
- * Will throw a string if the assertion fails.
+ * Error thrown when an assertion test fails.
  *
- * All fatal problems will throw an instance of Error.
+ * @private
+ */
+export class AuditError {
+    constructor(response, reason) {
+        this.response = response;
+        this.reason = reason;
+    }
+}
+/**
+ * Will throw an AuditError if the assertion on Response fails.
+ *
+ * All fatal problems will throw an instance of an Error.
+ *
+ * The name "ressert" is a wordplay combining "response" and "assert".
  *
  * @private
  */
-export function assert(name, actual) {
+export function ressert(res) {
     return {
-        toBe: (expected) => {
-            if (actual !== expected) {
-                throw `${name} ${actual} is not ${expected}`;
-            }
-        },
-        toBeBetween: (min, max) => {
-            if (!(min <= actual && actual <= max)) {
-                throw `${name} ${actual} is not between ${min} and ${max}`;
-            }
-        },
-        toContain: (expected) => {
-            // @ts-expect-error types will match, otherwise never
-            // eslint-disable-next-line @typescript-eslint/no-explicit-any
-            if (!actual.includes(expected)) {
-                throw `${name} ${JSON.stringify(actual)} does not contain ${JSON.stringify(expected)}`;
-            }
-        },
-        notToContain: (expected) => {
-            // @ts-expect-error types will match, otherwise never
-            // eslint-disable-next-line @typescript-eslint/no-explicit-any
-            if (actual.includes(expected)) {
-                throw `${name} ${JSON.stringify(actual)} contains ${JSON.stringify(expected)}`;
-            }
+        status: {
+            toBe(code) {
+                if (res.status !== code) {
+                    throw new AuditError(res, `Response status code is not ${code}`);
+                }
+            },
+            toBeBetween: (min, max) => {
+                if (!(min <= res.status && res.status <= max)) {
+                    throw new AuditError(res, `Response status is not between ${min} and ${max}`);
+                }
+            },
         },
-        toHaveProperty: (
-        // eslint-disable-next-line @typescript-eslint/no-explicit-any
-        prop) => {
-            // @ts-expect-error types will match, otherwise never
-            if (!(prop in actual)) {
-                throw `${name} ${JSON.stringify(actual)} does not have a property '${String(prop)}'`;
-            }
+        header(key) {
+            return {
+                toContain(part) {
+                    var _a;
+                    if (!((_a = res.headers.get(key)) === null || _a === void 0 ? void 0 : _a.includes(part))) {
+                        throw new AuditError(res, `Response header ${key} does not contain ${part}`);
+                    }
+                },
+                notToContain(part) {
+                    var _a;
+                    if ((_a = res.headers.get(key)) === null || _a === void 0 ? void 0 : _a.includes(part)) {
+                        throw new AuditError(res, `Response header ${key} contains ${part}`);
+                    }
+                },
+            };
         },
-        notToHaveProperty: (
-        // eslint-disable-next-line @typescript-eslint/no-explicit-any
-        prop) => {
-            // @ts-expect-error types will match, otherwise never
-            if (prop in actual) {
-                throw `${name} ${JSON.stringify(actual)} does have a property '${String(prop)}'`;
-            }
+        bodyAsExecutionResult: {
+            data: {
+                async toBe(val) {
+                    const body = await assertBodyAsExecutionResult(res);
+                    if (body.data !== val) {
+                        throw new AuditError(res, `Response body execution result data is not "${val}"`);
+                    }
+                },
+            },
+            async toHaveProperty(key) {
+                const body = await assertBodyAsExecutionResult(res);
+                if (!(key in body)) {
+                    throw new AuditError(res, `Response body execution result does not have a property "${key}"`);
+                }
+            },
+            async notToHaveProperty(key) {
+                const body = await assertBodyAsExecutionResult(res);
+                if (key in body) {
+                    throw new AuditError(res, `Response body execution result has a property "${key}"`);
+                }
+            },
         },
     };
 }
-/**
- * Parses the string as JSON and safely reports parsing issues for audits.
- *
- * Assumes the parsed JSON will be an `ExecutionResult`.
- *
- * @private
- * */
-export async function assertBodyAsExecutionResult(res) {
-    const str = await res.text();
+/** @private */
+async function assertBodyAsExecutionResult(res) {
+    let decoded;
+    try {
+        const decoder = new TextDecoder('utf-8');
+        const buff = await res.arrayBuffer();
+        decoded = decoder.decode(buff);
+    }
+    catch (err) {
+        throw new AuditError(res, 'Response body is not UTF-8 encoded');
+    }
+    let body;
     try {
-        return JSON.parse(str);
+        body = JSON.parse(decoded);
     }
     catch (err) {
-        throw `Response body is not valid JSON. Got ${JSON.stringify(str)}`;
+        throw new AuditError(res, 'Response body is not valid JSON');
     }
+    return body;
 }

package/lib/handler.js

@@ -326,41 +326,40 @@ exports.getAcceptableMediaType = getAcceptableMediaType;
  * @category Server
  */
 function makeResponse(resultOrErrors, acceptedMediaType) {
-    if ((0, utils_1.isExecutionResult)(resultOrErrors)) {
+    const errors = (0, utils_1.isGraphQLError)(resultOrErrors)
+        ? [resultOrErrors]
+        : (0, utils_1.areGraphQLErrors)(resultOrErrors)
+            ? resultOrErrors
+            : null;
+    if (errors) {
         return [
-            JSON.stringify(resultOrErrors),
-            {
-                status: 200,
-                statusText: 'OK',
-                headers: {
+            JSON.stringify({ errors }),
+            Object.assign(Object.assign({}, (acceptedMediaType === 'application/json'
+                ? {
+                    status: 200,
+                    statusText: 'OK',
+                }
+                : {
+                    status: 400,
+                    statusText: 'Bad Request',
+                })), { headers: {
                     'content-type': acceptedMediaType === 'application/json'
                         ? 'application/json; charset=utf-8'
                         : 'application/graphql-response+json; charset=utf-8',
-                },
-            },
+                } }),
         ];
     }
     return [
-        JSON.stringify({
-            errors: Array.isArray(resultOrErrors)
-                ? (0, utils_1.isObject)(resultOrErrors)
-                    ? resultOrErrors
-                    : new graphql_1.GraphQLError(String(resultOrErrors))
-                : [resultOrErrors],
-        }),
-        Object.assign(Object.assign({}, (acceptedMediaType === 'application/json'
-            ? {
-                status: 200,
-                statusText: 'OK',
-            }
-            : {
-                status: 400,
-                statusText: 'Bad Request',
-            })), { headers: {
+        JSON.stringify(resultOrErrors),
+        {
+            status: 200,
+            statusText: 'OK',
+            headers: {
                 'content-type': acceptedMediaType === 'application/json'
                     ? 'application/json; charset=utf-8'
                     : 'application/graphql-response+json; charset=utf-8',
-            } }),
+            },
+        },
     ];
 }
 exports.makeResponse = makeResponse;

package/lib/handler.mjs

@@ -4,7 +4,7 @@
  *
  */
 import { validate as graphqlValidate, execute as graphqlExecute, parse as graphqlParse, getOperationAST as graphqlGetOperationAST, GraphQLError, } from 'graphql';
-import { areGraphQLErrors, isAsyncIterable, isExecutionResult, isObject, } from './utils.mjs';
+import { areGraphQLErrors, isAsyncIterable, isExecutionResult, isGraphQLError, isObject, } from './utils.mjs';
 /**
  * Checks whether the passed value is the `graphql-http` server agnostic response.
  *
@@ -320,41 +320,40 @@ export function getAcceptableMediaType(acceptHeader) {
  * @category Server
  */
 export function makeResponse(resultOrErrors, acceptedMediaType) {
-    if (isExecutionResult(resultOrErrors)) {
+    const errors = isGraphQLError(resultOrErrors)
+        ? [resultOrErrors]
+        : areGraphQLErrors(resultOrErrors)
+            ? resultOrErrors
+            : null;
+    if (errors) {
         return [
-            JSON.stringify(resultOrErrors),
-            {
-                status: 200,
-                statusText: 'OK',
-                headers: {
+            JSON.stringify({ errors }),
+            Object.assign(Object.assign({}, (acceptedMediaType === 'application/json'
+                ? {
+                    status: 200,
+                    statusText: 'OK',
+                }
+                : {
+                    status: 400,
+                    statusText: 'Bad Request',
+                })), { headers: {
                     'content-type': acceptedMediaType === 'application/json'
                         ? 'application/json; charset=utf-8'
                         : 'application/graphql-response+json; charset=utf-8',
-                },
-            },
+                } }),
         ];
     }
     return [
-        JSON.stringify({
-            errors: Array.isArray(resultOrErrors)
-                ? isObject(resultOrErrors)
-                    ? resultOrErrors
-                    : new GraphQLError(String(resultOrErrors))
-                : [resultOrErrors],
-        }),
-        Object.assign(Object.assign({}, (acceptedMediaType === 'application/json'
-            ? {
-                status: 200,
-                statusText: 'OK',
-            }
-            : {
-                status: 400,
-                statusText: 'Bad Request',
-            })), { headers: {
+        JSON.stringify(resultOrErrors),
+        {
+            status: 200,
+            statusText: 'OK',
+            headers: {
                 'content-type': acceptedMediaType === 'application/json'
                     ? 'application/json; charset=utf-8'
                     : 'application/graphql-response+json; charset=utf-8',
-            } }),
+            },
+        },
     ];
 }
 function getHeader(req, key) {

package/lib/utils.d.mts

@@ -3,7 +3,8 @@
  * utils
  *
  */
-import type { ExecutionResult, GraphQLError } from 'graphql';
+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 */
@@ -11,6 +12,8 @@ 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>;

package/lib/utils.d.ts

@@ -3,7 +3,8 @@
  * utils
  *
  */
-import type { ExecutionResult, GraphQLError } from 'graphql';
+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 */
@@ -11,6 +12,8 @@ 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>;

package/lib/utils.js

@@ -5,7 +5,8 @@
  *
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isAsyncIterable = exports.isExecutionResult = exports.areGraphQLErrors = exports.isObject = exports.extendedTypeof = void 0;
+exports.isAsyncIterable = exports.isExecutionResult = exports.isGraphQLError = exports.areGraphQLErrors = exports.isObject = exports.extendedTypeof = void 0;
+const graphql_1 = require("graphql");
 /** @private */
 function extendedTypeof(val) {
     if (val === null) {
@@ -25,13 +26,17 @@ exports.isObject = isObject;
 /** @private */
 function areGraphQLErrors(obj) {
     return (Array.isArray(obj) &&
-        // must be at least one error
         obj.length > 0 &&
-        // error has at least a message
-        obj.every((ob) => 'message' in ob));
+        // 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)));

package/lib/utils.mjs

@@ -3,6 +3,7 @@
  * utils
  *
  */
+import { GraphQLError } from 'graphql';
 /** @private */
 export function extendedTypeof(val) {
     if (val === null) {
@@ -20,10 +21,13 @@ export function isObject(val) {
 /** @private */
 export function areGraphQLErrors(obj) {
     return (Array.isArray(obj) &&
-        // must be at least one error
         obj.length > 0 &&
-        // error has at least a message
-        obj.every((ob) => 'message' in ob));
+        // 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) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "graphql-http",
-  "version": "1.11.0",
+  "version": "1.12.0",
   "description": "Simple, pluggable, zero-dependency, GraphQL over HTTP Protocol compliant server and client",
   "keywords": [
     "graphql",
@@ -95,42 +95,42 @@
     "graphql": ">=0.11 <=16"
   },
   "devDependencies": {
-    "@babel/core": "^7.20.7",
+    "@babel/core": "^7.20.12",
     "@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.20.7",
     "@babel/preset-env": "^7.20.2",
     "@babel/preset-typescript": "^7.18.6",
-    "@rollup/plugin-terser": "^0.2.1",
-    "@rollup/plugin-typescript": "^10.0.1",
+    "@rollup/plugin-terser": "^0.3.0",
+    "@rollup/plugin-typescript": "^11.0.0",
     "@semantic-release/changelog": "^6.0.2",
     "@semantic-release/git": "^10.0.1",
     "@types/eslint": "^8.4.10",
     "@types/express": "^4.17.15",
-    "@types/glob": "^8.0.0",
-    "@types/jest": "^29.2.4",
+    "@types/glob": "^8.0.1",
+    "@types/jest": "^29.2.6",
     "@types/koa": "^2.13.5",
     "@types/koa-mount": "^4.0.2",
-    "@typescript-eslint/eslint-plugin": "^5.47.0",
-    "@typescript-eslint/parser": "^5.47.0",
-    "@whatwg-node/fetch": "^0.5.3",
+    "@typescript-eslint/eslint-plugin": "^5.48.2",
+    "@typescript-eslint/parser": "^5.48.2",
+    "@whatwg-node/fetch": "^0.6.2",
     "babel-jest": "^29.3.1",
-    "eslint": "^8.30.0",
-    "eslint-config-prettier": "^8.5.0",
+    "eslint": "^8.32.0",
+    "eslint-config-prettier": "^8.6.0",
     "express": "^4.18.2",
-    "fastify": "^4.10.2",
+    "fastify": "^4.11.0",
     "graphql": "^16.6.0",
     "jest": "^29.3.1",
     "jest-jasmine2": "^29.3.1",
     "koa": "^2.14.1",
     "koa-mount": "^4.0.0",
     "node-fetch": "^3.3.0",
-    "prettier": "^2.8.1",
-    "rollup": "^3.8.1",
-    "semantic-release": "^19.0.5",
+    "prettier": "^2.8.3",
+    "rollup": "^3.10.0",
+    "semantic-release": "^20.0.2",
     "tslib": "^2.4.1",
-    "typedoc": "^0.23.23",
+    "typedoc": "^0.23.24",
     "typedoc-plugin-markdown": "^3.14.0",
     "typescript": "^4.9.4"
   },