diff --git a/API.md b/API.md index 022e361..b0c0917 100755 --- a/API.md +++ b/API.md @@ -1,75 +1,73 @@ **boom** provides a set of utilities for returning HTTP errors. Each utility returns a `Boom` error response object which includes the following properties: -- `isBoom` - if `true`, indicates this is a `Boom` object instance. Note that this boolean should - only be used if the error is an instance of `Error`. If it is not certain, use `Boom.isBoom()` - instead. -- `isServer` - convenience bool indicating status code >= 500. - `message` - the error message. -- `typeof` - the constructor used to create the error (e.g. `Boom.badRequest`). - `output` - the formatted response. Can be directly manipulated after object construction to return a custom error response. Allowed root keys: - `statusCode` - the HTTP status code (typically 4xx or 5xx). - `headers` - an object containing any HTTP headers where each key is a header name and value is the header content. - - `payload` - the formatted object used as the response payload (stringified). Can be directly manipulated but any - changes will be lost - if `reformat()` is called. Any content allowed and by default includes the following content: + - `payload` - the formatted object used as the response payload. + Can be directly manipulated but any changes will be lost if `reformat()` is called. + Any content allowed and by default includes the following content: - `statusCode` - the HTTP status code, derived from `error.output.statusCode`. - `error` - the HTTP status message (e.g. 'Bad Request', 'Internal Server Error') derived from `statusCode`. - `message` - the error message derived from `error.message`. -- inherited `Error` properties. +- `stack` - string with stack trace from where error was created. +- optional `cause` - the error cause, as set by constructor. -The `Boom` object also supports the following method: +The object has additional properties from the `Boom` prototype: +- `name` - string with error name. Set to `'Boom'`. +- `isBoom` - set to `true`, indicating this is a `Boom` object instance. Note that this boolean should + only be tested if the error is an instance of `Error`. If it is not certain, use [`Boom.isBoom()`](#isboomerr-statuscode) instead. +- `isServer` - convenience boolean indicating status code >= 500. + +The object also supports the following method: #### `reformat(debug)` Rebuilds `error.output` using the other object properties where: -- `debug` - a Boolean that, when `true`, causes Internal Server Error messages to be left in tact. Defaults to `false`, meaning that Internal Server Error messages are redacted. - -Note that `Boom` object will return `true` when used with `instanceof Boom`, but do not use the -`Boom` prototype (they are either plain `Error` or the error prototype passed in). This means -`Boom` objects should only be tested using `instanceof Boom` or `Boom.isBoom()` but not by looking -at the prototype or contructor information. This limitation is to avoid manipulating the prototype -chain which is very slow. +- `debug` - a Boolean that, when `true`, causes Internal Server Error messages to be left intact. + Defaults to `false`, meaning that Internal Server Error messages are redacted. -#### Helper Methods +#### Base Constructor -##### `new Boom.Boom(message, [options])` +##### `new Boom([message], [options])` -Creates a new `Boom` object using the provided `message` and then calling -[`boomify()`](#boomifyerr-options) to decorate the error with the `Boom` properties, where: -- `message` - the error message. If `message` is an error, it is the same as calling - [`boomify()`](#boomifyerr-options) directly. +Creates a new `Boom` sub-classed `Error` object, where: +- `message` - the error message. - `options` - and optional object where: - - `statusCode` - the HTTP status code. Defaults to `500` if no status code is already set. - - `data` - additional error information (assigned to `error.data`). - - `decorate` - an option with extra properties to set on the error object. + - `statusCode` - the HTTP status code. Defaults to `500`. + - `cause` - the error that caused the boom error. + - `data` - additional error information, assigned to `this.data`. + - `headers` - an object containing any HTTP headers where each key is a header name and value is the header content. - `ctor` - constructor reference used to crop the exception call stack output. - - if `message` is an error object, also supports the other [`boomify()`](#boomifyerr-options) - options. + +#### Helper Methods ##### `boomify(err, [options])` -Decorates an error with the `Boom` properties where: -- `err` - the `Error` object to decorate. +Creates a `Boom` object similar to [`new Boom()`](#new-boommessage-options), except it +applies the `options` to the existing error when it is a `Boom` object, where: +- `err` - the object to boomify, set as `cause` when `err` is not a `Boom` object. - `options` - optional object with the following optional settings: - `statusCode` - the HTTP status code. Defaults to `500` if no status code is already set and `err` is not a `Boom` object. - `message` - error message string. If the error already has a message, the provided `message` is added as a prefix. - Defaults to no message. - - `decorate` - an option with extra properties to set on the error object. - `override` - if `false`, the `err` provided is a `Boom` object, and a `statusCode` or `message` are provided, the values are ignored. Defaults to `true` (apply the provided `statusCode` and `message` options to the error - regardless of its type, `Error` or `Boom` object). + regardless of its type). +- it returns a `Boom` object with the boomified error + +Note that [`new Boom()`](#new-boommessage-options) should generally be preferred in cases where the error can come from awaited logic, or has been passed around. ```js -var error = new Error('Unexpected input'); -Boom.boomify(error, { statusCode: 400 }); +const error = new Error('Unexpected input'); +const boomified = Boom.boomify(error, { statusCode: 400 }); ``` ##### `isBoom(err, [statusCode])` -Identifies whether an error is a `Boom` object. Same as calling `instanceof Boom.Boom`. +Identifies whether an error is a `Boom` object. Same as calling `err instanceof Boom.Boom`. - `err` - Error object. - `statusCode` - optional status code. @@ -77,6 +75,7 @@ Identifies whether an error is a `Boom` object. Same as calling `instanceof Boom Boom.isBoom(Boom.badRequest()); // true Boom.isBoom(Boom.badRequest(), 400); // true ``` + #### HTTP 4xx Errors ##### `Boom.badRequest([message], [data])` @@ -108,7 +107,8 @@ Returns a 401 Unauthorized error where: - an array of string values. These values will be separated by ', ' and set to the 'WWW-Authenticate' header. - `attributes` - an object of values to use while setting the 'WWW-Authenticate' header. This value is only used when `scheme` is a string, otherwise it is ignored. Every key/value pair will be included in the - 'WWW-Authenticate' in the format of 'key="value"' as well as in the response payload under the `attributes` key. Alternatively value can be a string which is use to set the value of the scheme, for example setting the token value for negotiate header. If string is used message parameter must be null. + 'WWW-Authenticate' in the format of 'key="value"'. Alternatively value can be a string which is used to set the + value of the scheme, for example setting the token value for negotiate header. If string is used message parameter must be null. `null` and `undefined` will be replaced with an empty string. If `attributes` is set, `message` will be used as the 'error' segment of the 'WWW-Authenticate' header. If `message` is unset, the 'error' segment of the header will not be present and `isMissing` will be true on the error object. @@ -141,10 +141,7 @@ Generates the following response: "payload": { "statusCode": 401, "error": "Unauthorized", - "message": "invalid password", - "attributes": { - "error": "invalid password" - } + "message": "invalid password" }, "headers": { "WWW-Authenticate": "sample error=\"invalid password\"" @@ -160,8 +157,7 @@ Generates the following response: ```json "payload": { "statusCode": 401, - "error": "Unauthorized", - "attributes": "VGhpcyBpcyBhIHRlc3QgdG9rZW4=" + "error": "Unauthorized" }, "headers": { "WWW-Authenticate": "Negotiate VGhpcyBpcyBhIHRlc3QgdG9rZW4=" @@ -178,13 +174,7 @@ Generates the following response: "payload": { "statusCode": 401, "error": "Unauthorized", - "message": "invalid password", - "attributes": { - "error": "invalid password", - "ttl": 0, - "cache": "", - "foo": "bar" - } + "message": "invalid password" }, "headers": { "WWW-Authenticate": "sample ttl=\"0\", cache=\"\", foo=\"bar\", error=\"invalid password\"" @@ -678,7 +668,7 @@ All 500 errors hide your message from the end user. Returns a 500 Internal Server Error error where: - `message` - optional message. -- `data` - optional additional error data. +- `data` - optional additional error data. Used as `cause` when when an `Error`. ```js Boom.badImplementation('terrible implementation'); @@ -698,7 +688,7 @@ Generates the following response payload: Returns a 501 Not Implemented error where: - `message` - optional message. -- `data` - optional additional error data. +- `data` - optional additional error data. Used as `cause` when when an `Error`. ```js Boom.notImplemented('method not implemented'); @@ -718,7 +708,7 @@ Generates the following response payload: Returns a 502 Bad Gateway error where: - `message` - optional message. -- `data` - optional additional error data. +- `data` - optional additional error data. Used as `cause` when when an `Error`. ```js Boom.badGateway('that is a bad gateway'); @@ -738,7 +728,7 @@ Generates the following response payload: Returns a 503 Service Unavailable error where: - `message` - optional message. -- `data` - optional additional error data. +- `data` - optional additional error data. Used as `cause` when when an `Error`. ```js Boom.serverUnavailable('unavailable'); @@ -758,7 +748,7 @@ Generates the following response payload: Returns a 504 Gateway Time-out error where: - `message` - optional message. -- `data` - optional additional error data. +- `data` - optional additional error data. Used as `cause` when when an `Error`. ```js Boom.gatewayTimeout(); @@ -777,4 +767,7 @@ Generates the following response payload: **Q** How do I include extra information in my responses? `output.payload` is missing `data`, what gives? -**A** There is a reason the values passed back in the response payloads are pretty locked down. It's mostly for security and to not leak any important information back to the client. This means you will need to put in a little more effort to include extra information about your custom error. Check out the ["Error transformation"](https://github.com/hapijs/hapi/blob/master/API.md#error-transformation) section in the hapi documentation. +**A** There is a reason the values passed back in the response payloads are pretty locked down. +It's mostly for security and to not leak any important information back to the client. +This means you will need to put in a little more effort to include extra information about your custom error. +Check out the ["Error transformation"](https://github.com/hapijs/hapi/blob/master/API.md#error-transformation) section in the hapi documentation. diff --git a/lib/index.d.ts b/lib/index.d.ts index 34132bb..404529c 100755 --- a/lib/index.d.ts +++ b/lib/index.d.ts @@ -1,27 +1,39 @@ +type NotUnknown = string | number | boolean | bigint | symbol | null | object; + +declare namespace Boom { + type CtorArgs = [message?: string, options?: Options]; + type WithDataArgs = [message: string, options: Options & { data: Data }]; +} + /** * An Error object used to return an HTTP response error (4xx, 5xx) */ -export class Boom extends Error { +export class Boom extends Error { /** * Creates a new Boom object using the provided message or Error */ - constructor(message?: string | Error, options?: Options); + constructor(...args: Data extends NotUnknown ? Boom.WithDataArgs : Boom.CtorArgs); + + /** + * Underlying cause for the Boom error + */ + cause?: unknown; /** * Custom error data with additional information specific to the error type */ - data?: Data; + data: Data; /** - * isBoom - if true, indicates this is a Boom object instance. + * isBoom - true, indicates this is a Boom object instance. */ - isBoom: boolean; + readonly isBoom: boolean; /** * Convenience boolean indicating status code >= 500 */ - isServer: boolean; + readonly isServer: boolean; /** * The error message @@ -33,60 +45,61 @@ export class Boom extends Error { */ output: Output; - /** - * The constructor used to create the error - */ - typeof: Function; - /** * Specifies if an error object is a valid boom object * * @param debug - A boolean that, when true, does not hide the original 500 error message. Defaults to false. */ - reformat(debug?: boolean): string; + reformat(debug?: boolean): void; } - -export interface Options { +export interface BaseOptions { /** * The HTTP status code * * @default 500 */ - statusCode?: number; + readonly statusCode?: number; /** * Additional error information */ - data?: Data; + readonly data?: Data; +} + + +export interface Options extends BaseOptions { + /** + * An object containing any HTTP headers where each key is a header name and value is the header content + */ + readonly headers?: { readonly [header: string]: string | readonly string[] | number } | undefined; /** * Constructor reference used to crop the exception call stack output */ - ctor?: Function; + readonly ctor?: Function; + /** + * An underlying cause for the Boom error + */ + readonly cause?: Error | unknown | undefined; +} + + +export interface BoomifyOptions extends BaseOptions { /** * Error message string * * @default none */ - message?: string; + readonly message?: string; /** * If false, the err provided is a Boom object, and a statusCode or message are provided, the values are ignored * * @default true */ - override?: boolean; -} - - -export interface Decorate { - - /** - * An option with extra properties to set on the error object - */ - decorate?: Decoration; + readonly override?: boolean; } @@ -94,22 +107,17 @@ export interface Payload { /** * The HTTP status code derived from error.output.statusCode */ - statusCode: number; + readonly statusCode: number; /** * The HTTP status message derived from statusCode */ - error: string; + readonly error: string; /** * The error message derived from error.message */ - message: string; - - /** - * Custom properties - */ - [key: string]: unknown; + readonly message: string; } @@ -127,7 +135,7 @@ export interface Output { /** * The formatted object used as the response payload (stringified) */ - payload: Payload; + payload: Payload & { [key: string]: unknown }; } @@ -143,37 +151,39 @@ export function isBoom(obj: unknown, statusCode?: number): obj is Boom; /** -* Specifies if an error object is a valid boom object +* Applies options to an existing boom object, or creates a new boom object with the error as `cause` * -* @param err - The error object to decorate +* @param err - The target object * @param options - Options object * -* @returns A decorated boom object +* @returns A boom object */ -export function boomify(err: Error, options?: Options & Decorate): Boom & Decoration; - +export function boomify & Pick, 'data'>, Terr extends Omit = Boom, Data = unknown>(err: Terr, options: BoomifyOptions & { data: Tres extends Boom ? Data : Data }): Tres; +export function boomify, Terr = any, Data = unknown>(err: Terr, options: BoomifyOptions & { data: Tres extends Boom ? Data : Data }): Tres; +export function boomify = Tres>(err: Terr, options?: BoomifyOptions): Tres; +export function boomify, Terr = any>(err: Terr, options?: BoomifyOptions): Tres; // 4xx Errors /** * Returns a 400 Bad Request error * -* @param messageOrError - Optional message or Error +* @param message - Optional message * @param data - Optional additional error data * * @returns A 400 bad request error */ -export function badRequest(messageOrError?: string | Error, data?: Data): Boom; +export function badRequest(message?: string, data?: Data): Boom; /** * Returns a 401 Unauthorized error * -* @param messageOrError - Optional message or Error +* @param message - Optional message * * @returns A 401 Unauthorized error */ -export function unauthorized(messageOrError?: string | Error | null): Boom; +export function unauthorized(message?: string): Boom; /** @@ -185,8 +195,8 @@ export function unauthorized(messageOrError?: string | Error | null): Boom * * @returns A 401 Unauthorized error */ -export function unauthorized(message: '' | null, scheme: string, attributes?: string | unauthorized.Attributes): Boom & unauthorized.MissingAuth; -export function unauthorized(message: string | null, scheme: string, attributes?: string | unauthorized.Attributes): Boom; +export function unauthorized(message: '' | null | undefined, scheme: string, attributes?: string | unauthorized.Attributes): Boom & unauthorized.MissingAuth; +export function unauthorized(message: string, scheme: string, attributes?: string | unauthorized.Attributes): Boom; export namespace unauthorized { @@ -200,7 +210,7 @@ export namespace unauthorized { /** * Indicate whether the 401 unauthorized error is due to missing credentials (vs. invalid) */ - isMissing: boolean; + isMissing: true; } } @@ -213,271 +223,271 @@ export namespace unauthorized { * * @returns A 401 Unauthorized error */ -export function unauthorized(message: string | null, wwwAuthenticate: string[]): Boom; +export function unauthorized(message: string | null | undefined, wwwAuthenticate: readonly string[]): Boom; /** * Returns a 402 Payment Required error * -* @param messageOrError - Optional message or Error +* @param message - Optional message * @param data - Optional additional error data * * @returns A 402 Payment Required error */ -export function paymentRequired(messageOrError?: string | Error, data?: Data): Boom; +export function paymentRequired(message?: string, data?: Data): Boom; /** * Returns a 403 Forbidden error * -* @param messageOrError - Optional message or Error +* @param message - Optional message * @param data - Optional additional error data * * @returns A 403 Forbidden error */ -export function forbidden(messageOrError?: string | Error, data?: Data): Boom; +export function forbidden(message?: string, data?: Data): Boom; /** * Returns a 404 Not Found error * -* @param messageOrError - Optional message or Error +* @param message - Optional message * @param data - Optional additional error data * * @returns A 404 Not Found error */ -export function notFound(messageOrError?: string | Error, data?: Data): Boom; +export function notFound(message?: string, data?: Data): Boom; /** * Returns a 405 Method Not Allowed error * -* @param messageOrError - Optional message or Error +* @param message - Optional message * @param data - Optional additional error data * @param allow - Optional string or array of strings which is used to set the 'Allow' header * * @returns A 405 Method Not Allowed error */ -export function methodNotAllowed(messageOrError?: string | Error, data?: Data, allow?: string | string[]): Boom; +export function methodNotAllowed(message?: string, data?: Data, allow?: string | readonly string[]): Boom; /** * Returns a 406 Not Acceptable error * -* @param messageOrError - Optional message or Error +* @param message - Optional message * @param data - Optional additional error data * * @returns A 406 Not Acceptable error */ -export function notAcceptable(messageOrError?: string | Error, data?: Data): Boom; +export function notAcceptable(message?: string, data?: Data): Boom; /** * Returns a 407 Proxy Authentication error * -* @param messageOrError - Optional message or Error +* @param message - Optional message * @param data - Optional additional error data * * @returns A 407 Proxy Authentication error */ -export function proxyAuthRequired(messageOrError?: string | Error, data?: Data): Boom; +export function proxyAuthRequired(message?: string, data?: Data): Boom; /** * Returns a 408 Request Time-out error * -* @param messageOrError - Optional message or Error +* @param message - Optional message * @param data - Optional additional error data * * @returns A 408 Request Time-out error */ -export function clientTimeout(messageOrError?: string | Error, data?: Data): Boom; +export function clientTimeout(message?: string, data?: Data): Boom; /** * Returns a 409 Conflict error * -* @param messageOrError - Optional message or Error +* @param message - Optional message * @param data - Optional additional error data * * @returns A 409 Conflict error */ -export function conflict(messageOrError?: string | Error, data?: Data): Boom; +export function conflict(message?: string, data?: Data): Boom; /** * Returns a 410 Gone error * -* @param messageOrError - Optional message or Error +* @param message - Optional message * @param data - Optional additional error data * * @returns A 410 gone error */ -export function resourceGone(messageOrError?: string | Error, data?: Data): Boom; +export function resourceGone(message?: string, data?: Data): Boom; /** * Returns a 411 Length Required error * -* @param messageOrError - Optional message or Error +* @param message - Optional message * @param data - Optional additional error data * * @returns A 411 Length Required error */ -export function lengthRequired(messageOrError?: string | Error, data?: Data): Boom; +export function lengthRequired(message?: string, data?: Data): Boom; /** * Returns a 412 Precondition Failed error * -* @param messageOrError - Optional message or Error +* @param message - Optional message * @param data - Optional additional error data * * @returns A 412 Precondition Failed error */ -export function preconditionFailed(messageOrError?: string | Error, data?: Data): Boom; +export function preconditionFailed(message?: string, data?: Data): Boom; /** * Returns a 413 Request Entity Too Large error * -* @param messageOrError - Optional message or Error +* @param message - Optional message * @param data - Optional additional error data * * @returns A 413 Request Entity Too Large error */ -export function entityTooLarge(messageOrError?: string | Error, data?: Data): Boom; +export function entityTooLarge(message?: string, data?: Data): Boom; /** * Returns a 414 Request-URI Too Large error * -* @param messageOrError - Optional message or Error +* @param message - Optional message * @param data - Optional additional error data * * @returns A 414 Request-URI Too Large error */ -export function uriTooLong(messageOrError?: string | Error, data?: Data): Boom; +export function uriTooLong(message?: string, data?: Data): Boom; /** * Returns a 415 Unsupported Media Type error * -* @param messageOrError - Optional message or Error +* @param message - Optional message * @param data - Optional additional error data * * @returns A 415 Unsupported Media Type error */ -export function unsupportedMediaType(messageOrError?: string | Error, data?: Data): Boom; +export function unsupportedMediaType(message?: string, data?: Data): Boom; /** * Returns a 416 Request Range Not Satisfiable error * -* @param messageOrError - Optional message or Error +* @param message - Optional message * @param data - Optional additional error data * * @returns A 416 Request Range Not Satisfiable error */ -export function rangeNotSatisfiable(messageOrError?: string | Error, data?: Data): Boom; +export function rangeNotSatisfiable(message?: string, data?: Data): Boom; /** * Returns a 417 Expectation Failed error * -* @param messageOrError - Optional message or Error +* @param message - Optional message * @param data - Optional additional error data * * @returns A 417 Expectation Failed error */ -export function expectationFailed(messageOrError?: string | Error, data?: Data): Boom; +export function expectationFailed(message?: string, data?: Data): Boom; /** * Returns a 418 I'm a Teapot error * -* @param messageOrError - Optional message or Error +* @param message - Optional message * @param data - Optional additional error data * * @returns A 418 I'm a Teapot error */ -export function teapot(messageOrError?: string | Error, data?: Data): Boom; +export function teapot(message?: string, data?: Data): Boom; /** * Returns a 422 Unprocessable Entity error * -* @param messageOrError - Optional message or Error +* @param message - Optional message * @param data - Optional additional error data * * @returns A 422 Unprocessable Entity error */ -export function badData(messageOrError?: string | Error, data?: Data): Boom; +export function badData(message?: string, data?: Data): Boom; /** * Returns a 423 Locked error * -* @param messageOrError - Optional message or Error +* @param message - Optional message * @param data - Optional additional error data * * @returns A 423 Locked error */ -export function locked(messageOrError?: string | Error, data?: Data): Boom; +export function locked(message?: string, data?: Data): Boom; /** * Returns a 424 Failed Dependency error * -* @param messageOrError - Optional message or Error +* @param message - Optional message * @param data - Optional additional error data * * @returns A 424 Failed Dependency error */ -export function failedDependency(messageOrError?: string | Error, data?: Data): Boom; +export function failedDependency(message?: string, data?: Data): Boom; /** * Returns a 425 Too Early error * -* @param messageOrError - Optional message or Error +* @param message - Optional message * @param data - Optional additional error data * * @returns A 425 Too Early error */ -export function tooEarly(messageOrError?: string | Error, data?: Data): Boom; +export function tooEarly(message?: string, data?: Data): Boom; /** * Returns a 428 Precondition Required error * -* @param messageOrError - Optional message or Error +* @param message - Optional message * @param data - Optional additional error data * * @returns A 428 Precondition Required error */ -export function preconditionRequired(messageOrError?: string | Error, data?: Data): Boom; +export function preconditionRequired(message?: string, data?: Data): Boom; /** * Returns a 429 Too Many Requests error * -* @param messageOrError - Optional message or Error +* @param message - Optional message * @param data - Optional additional error data * * @returns A 429 Too Many Requests error */ -export function tooManyRequests(messageOrError?: string | Error, data?: Data): Boom; +export function tooManyRequests(message?: string, data?: Data): Boom; /** * Returns a 451 Unavailable For Legal Reasons error * -* @param messageOrError - Optional message or Error +* @param message - Optional message * @param data - Optional additional error data * * @returns A 451 Unavailable for Legal Reasons error */ -export function illegal(messageOrError?: string | Error, data?: Data): Boom; +export function illegal(message?: string, data?: Data): Boom; // 5xx Errors @@ -485,65 +495,65 @@ export function illegal(messageOrError?: string | Error, data?: Data): Boo /** * Returns a internal error (defaults to 500) * -* @param messageOrError - Optional message or Error +* @param message - Optional message * @param data - Optional additional error data * @param statusCode - Optional status code override. Defaults to 500. * * @returns A 500 Internal Server error */ -export function internal(messageOrError?: string | Error, data?: Data, statusCode?: number): Boom; +export function internal(message?: string, data?: Data | Error, statusCode?: number): Boom; /** * Returns a 500 Internal Server Error error * -* @param messageOrError - Optional message or Error +* @param message - Optional message * @param data - Optional additional error data * * @returns A 500 Internal Server error */ -export function badImplementation(messageOrError?: string | Error, data?: Data): Boom; +export function badImplementation(message?: string, data?: Data | Error): Boom; /** * Returns a 501 Not Implemented error * -* @param messageOrError - Optional message or Error +* @param message - Optional message * @param data - Optional additional error data * * @returns A 501 Not Implemented error */ -export function notImplemented(messageOrError?: string | Error, data?: Data): Boom; +export function notImplemented(message?: string, data?: Data | Error): Boom; /** * Returns a 502 Bad Gateway error * -* @param messageOrError - Optional message or Error +* @param message - Optional message * @param data - Optional additional error data * * @returns A 502 Bad Gateway error */ -export function badGateway(messageOrError?: string | Error, data?: Data): Boom; +export function badGateway(message?: string, data?: Data | Error): Boom; /** * Returns a 503 Service Unavailable error * -* @param messageOrError - Optional message or Error +* @param message - Optional message * @param data - Optional additional error data * * @returns A 503 Service Unavailable error */ -export function serverUnavailable(messageOrError?: string | Error, data?: Data): Boom; +export function serverUnavailable(message?: string, data?: Data | Error): Boom; /** * Returns a 504 Gateway Time-out error * -* @param messageOrError - Optional message or Error +* @param message - Optional message * @param data - Optional additional error data * * @returns A 504 Gateway Time-out error */ -export function gatewayTimeout(messageOrError?: string | Error, data?: Data): Boom; +export function gatewayTimeout(message?: string, data?: Data | Error): Boom; diff --git a/lib/index.js b/lib/index.js index 709b754..39627c1 100755 --- a/lib/index.js +++ b/lib/index.js @@ -1,6 +1,6 @@ 'use strict'; -const Hoek = require('@hapi/hoek'); +const EscapeHeaderAttribute = require('@hapi/hoek/escapeHeaderAttribute'); const internals = { @@ -66,27 +66,40 @@ const internals = { }; -exports.Boom = class extends Error { +exports.Boom = class Boom extends Error { - constructor(messageOrError, options = {}) { + data = null; + output; - if (messageOrError instanceof Error) { - return exports.boomify(Hoek.clone(messageOrError), options); - } + get isServer() { + + return this.output.statusCode >= 500; + } - const { statusCode = 500, data = null, ctor = exports.Boom } = options; - const error = new Error(messageOrError ? messageOrError : undefined); // Avoids settings null message - Error.captureStackTrace(error, ctor); // Filter the stack to our external API - error.data = data; - const boom = internals.initialize(error, statusCode); + set isServer(value) { // Allow for compatiblity with legacy boom + + Object.defineProperty(this, 'isServer', { + value, + writable: true, + configurable: true + }); + } - Object.defineProperty(boom, 'typeof', { value: ctor }); + constructor(message, options = {}) { - if (options.decorate) { - Object.assign(boom, options.decorate); + const { statusCode = 500, data, headers, ctor = exports.Boom } = options; + const causeOption = 'cause' in options ? { cause: options.cause } : undefined; + + super(message ?? internals.codes.get(statusCode) ?? 'Unknown', causeOption); + if (typeof Error.captureStackTrace === 'function') { // Only use when available + Error.captureStackTrace(this, ctor); // Filter the stack to our external API + } + + if (causeOption) { + this.cause ??= causeOption.cause; // Explicitly assign cause to work with old runtimes } - return boom; + internals.apply(this, data, statusCode, headers); } static [Symbol.hasInstance](instance) { @@ -99,366 +112,316 @@ exports.Boom = class extends Error { return this.prototype.isPrototypeOf(instance); } -}; - - -exports.isBoom = function (err, statusCode) { - - return err instanceof Error && !!err.isBoom && (!statusCode || err.output.statusCode === statusCode); -}; - - -exports.boomify = function (err, options) { - - Hoek.assert(err instanceof Error, 'Cannot wrap non-Error object'); - - options = options || {}; - - if (options.data !== undefined) { - err.data = options.data; - } - if (options.decorate) { - Object.assign(err, options.decorate); - } + reformat(debug = false) { - if (!err.isBoom) { - return internals.initialize(err, options.statusCode ?? 500, options.message); + this.output.payload = new internals.PayloadObject(this, this.output.statusCode, debug); } - if (options.override === false || // Defaults to true - !options.statusCode && !options.message) { - - return err; + static { + Object.defineProperties(this.prototype, { + name: { value: 'Boom', writable: true, configurable: true }, + isBoom: { value: true, writable: true, configurable: true } + }); } - - return internals.initialize(err, options.statusCode ?? err.output.statusCode, options.message); }; -// 4xx Client Errors - -exports.badRequest = function (messageOrError, data) { +exports.isBoom = function (err, statusCode) { - return new exports.Boom(messageOrError, { statusCode: 400, data, ctor: exports.badRequest }); + return err instanceof Error && !!err.isBoom && (!statusCode || err.output.statusCode === statusCode); }; -exports.unauthorized = function (message, scheme, attributes) { // Or (message, wwwAuthenticate[]) +exports.boomify = function (err, options = {}) { - const err = new exports.Boom(message, { statusCode: 401, ctor: exports.unauthorized }); - - // function (message) + const { override, data, statusCode, message } = options; - if (!scheme) { - return err; + if (!err?.isBoom === true) { + return new exports.Boom(message, { statusCode, cause: err, data }); } - // function (message, wwwAuthenticate[]) + if (override === false) { // Defaults to true + internals.apply(err, data); + } + else { + internals.apply(err, data, statusCode ?? err.output.statusCode, {}, message); + } - if (typeof scheme !== 'string') { - err.output.headers['WWW-Authenticate'] = scheme.join(', '); - return err; + if (err.hasOwnProperty('isServer')) { + err.isServer = err.output.statusCode >= 500; // Assign, in case it is a legacy boom object } - // function (message, scheme, attributes) + return err; +}; - let wwwAuthenticate = `${scheme}`; - if (attributes || - message) { +internals.apply = function (boom, data, statusCode, headers, message) { - err.output.payload.attributes = {}; + if (data !== undefined) { + boom.data = data; } - if (attributes) { - if (typeof attributes === 'string') { - wwwAuthenticate += ' ' + Hoek.escapeHeaderAttribute(attributes); - err.output.payload.attributes = attributes; + if (statusCode) { + const numberCode = parseInt(statusCode, 10); + if (isNaN(numberCode) || numberCode < 400) { + throw new TypeError(`statusCode must be a number (400+): ${statusCode}`); } - else { - wwwAuthenticate += ' ' + Object.keys(attributes).map((name) => { - const value = attributes[name] ?? ''; + if (headers !== undefined && + (headers === null || typeof headers !== 'object')) { - err.output.payload.attributes[name] = value; - return `${name}="${Hoek.escapeHeaderAttribute(value.toString())}"`; - }) - .join(', '); + throw new TypeError('headers must be an object'); } - } - if (message) { - if (attributes) { - wwwAuthenticate += ','; + if (message) { + boom.message = `${message}: ${boom.message}`; } - wwwAuthenticate += ` error="${Hoek.escapeHeaderAttribute(message)}"`; - err.output.payload.attributes.error = message; + boom.output = new internals.BoomOutput(numberCode, headers); + boom.reformat(); } - else { - err.isMissing = true; - } - - err.output.headers['WWW-Authenticate'] = wwwAuthenticate; - return err; }; -exports.paymentRequired = function (messageOrError, data) { +internals.PayloadObject = class { - return new exports.Boom(messageOrError, { statusCode: 402, data, ctor: exports.paymentRequired }); -}; + statusCode; + error; + message; + constructor(error, statusCode, debug) { -exports.forbidden = function (messageOrError, data) { + this.statusCode = statusCode; + this.error = internals.codes.get(statusCode) ?? 'Unknown'; - return new exports.Boom(messageOrError, { statusCode: 403, data, ctor: exports.forbidden }); + if (statusCode === 500 && debug !== true) { + this.message = 'An internal server error occurred'; // Hide actual error from user + } + else { + this.message = error.message; + if (error.cause) { + const message = error.cause.message ?? error.cause; + this.message = (error.message === this.error) ? message : error.message + ': ' + message; + } + } + } }; -exports.notFound = function (messageOrError, data) { - - return new exports.Boom(messageOrError, { statusCode: 404, data, ctor: exports.notFound }); -}; +internals.BoomOutput = class { + statusCode; + payload = {}; + headers; -exports.methodNotAllowed = function (messageOrError, data, allow) { + constructor(statusCode, headers) { - const err = new exports.Boom(messageOrError, { statusCode: 405, data, ctor: exports.methodNotAllowed }); + this.statusCode = statusCode; - if (typeof allow === 'string') { - allow = [allow]; - } + const copy = Object.assign(Object.create(null), headers); + for (const [key, value] of Object.entries(copy)) { + if (Array.isArray(value)) { + copy[key] = value.slice(); + } + } - if (Array.isArray(allow)) { - err.output.headers.Allow = allow.join(', '); + this.headers = copy; } - - return err; }; -exports.notAcceptable = function (messageOrError, data) { +internals.statusError = function (statusCode, massage) { - return new exports.Boom(messageOrError, { statusCode: 406, data, ctor: exports.notAcceptable }); -}; + const method = massage ? + function (...args) { + const [message, options, decorate] = massage(...args); + return Object.assign(new exports.Boom(message, { statusCode, ctor: method, ...options }), decorate); + } : + function (message, data) { -exports.proxyAuthRequired = function (messageOrError, data) { + return new exports.Boom(message, { statusCode, data, ctor: method }); + }; - return new exports.Boom(messageOrError, { statusCode: 407, data, ctor: exports.proxyAuthRequired }); + return method; }; -exports.clientTimeout = function (messageOrError, data) { - - return new exports.Boom(messageOrError, { statusCode: 408, data, ctor: exports.clientTimeout }); -}; - - -exports.conflict = function (messageOrError, data) { - - return new exports.Boom(messageOrError, { statusCode: 409, data, ctor: exports.conflict }); -}; - +// 4xx Client Errors -exports.resourceGone = function (messageOrError, data) { +exports.badRequest = internals.statusError(400); - return new exports.Boom(messageOrError, { statusCode: 410, data, ctor: exports.resourceGone }); -}; +exports.unauthorized = internals.statusError(401, (message, scheme, attributes) => { // Or (message, wwwAuthenticate[]) -exports.lengthRequired = function (messageOrError, data) { + // function (message) - return new exports.Boom(messageOrError, { statusCode: 411, data, ctor: exports.lengthRequired }); -}; + if (!scheme) { + return [message]; + } + // function (message, wwwAuthenticate[]) -exports.preconditionFailed = function (messageOrError, data) { + if (typeof scheme !== 'string') { + const headers = { 'WWW-Authenticate': scheme.join(', ') }; + return [message, { headers }]; + } - return new exports.Boom(messageOrError, { statusCode: 412, data, ctor: exports.preconditionFailed }); -}; + // function (message, scheme, attributes) + const decorate = {}; + let stringified = ''; -exports.entityTooLarge = function (messageOrError, data) { + if (attributes) { + if (typeof attributes === 'string') { + stringified += EscapeHeaderAttribute(attributes); + } + else { + stringified += Object.keys(attributes).map((name) => { - return new exports.Boom(messageOrError, { statusCode: 413, data, ctor: exports.entityTooLarge }); -}; + const value = attributes[name] ?? ''; + return `${name}="${EscapeHeaderAttribute(value.toString())}"`; + }) + .join(', '); + } + } -exports.uriTooLong = function (messageOrError, data) { + if (message) { + if (stringified) { + stringified += ', '; + } - return new exports.Boom(messageOrError, { statusCode: 414, data, ctor: exports.uriTooLong }); -}; + stringified += `error="${EscapeHeaderAttribute(message)}"`; + } + else { + decorate.isMissing = true; + } + const headers = { 'WWW-Authenticate': stringified ? `${scheme} ${stringified}` : `${scheme}` }; + return [message, { headers }, decorate]; +}); -exports.unsupportedMediaType = function (messageOrError, data) { - return new exports.Boom(messageOrError, { statusCode: 415, data, ctor: exports.unsupportedMediaType }); -}; +exports.paymentRequired = internals.statusError(402); -exports.rangeNotSatisfiable = function (messageOrError, data) { +exports.forbidden = internals.statusError(403); - return new exports.Boom(messageOrError, { statusCode: 416, data, ctor: exports.rangeNotSatisfiable }); -}; +exports.notFound = internals.statusError(404); -exports.expectationFailed = function (messageOrError, data) { - return new exports.Boom(messageOrError, { statusCode: 417, data, ctor: exports.expectationFailed }); -}; +exports.methodNotAllowed = internals.statusError(405, (message, data, allow) => { + if (typeof allow === 'string') { + allow = [allow]; + } -exports.teapot = function (messageOrError, data) { + const headers = Array.isArray(allow) ? { + Allow: allow.join(', ') + } : undefined; - return new exports.Boom(messageOrError, { statusCode: 418, data, ctor: exports.teapot }); -}; + return [message, { data, headers }]; +}); -exports.badData = function (messageOrError, data) { +exports.notAcceptable = internals.statusError(406); - return new exports.Boom(messageOrError, { statusCode: 422, data, ctor: exports.badData }); -}; +exports.proxyAuthRequired = internals.statusError(407); -exports.locked = function (messageOrError, data) { - return new exports.Boom(messageOrError, { statusCode: 423, data, ctor: exports.locked }); -}; +exports.clientTimeout = internals.statusError(408); -exports.failedDependency = function (messageOrError, data) { +exports.conflict = internals.statusError(409); - return new exports.Boom(messageOrError, { statusCode: 424, data, ctor: exports.failedDependency }); -}; -exports.tooEarly = function (messageOrError, data) { +exports.resourceGone = internals.statusError(410); - return new exports.Boom(messageOrError, { statusCode: 425, data, ctor: exports.tooEarly }); -}; +exports.lengthRequired = internals.statusError(411); -exports.preconditionRequired = function (messageOrError, data) { - return new exports.Boom(messageOrError, { statusCode: 428, data, ctor: exports.preconditionRequired }); -}; +exports.preconditionFailed = internals.statusError(412); -exports.tooManyRequests = function (messageOrError, data) { +exports.entityTooLarge = internals.statusError(413); - return new exports.Boom(messageOrError, { statusCode: 429, data, ctor: exports.tooManyRequests }); -}; +exports.uriTooLong = internals.statusError(414); -exports.illegal = function (messageOrError, data) { - return new exports.Boom(messageOrError, { statusCode: 451, data, ctor: exports.illegal }); -}; +exports.unsupportedMediaType = internals.statusError(415); -// 5xx Server Errors +exports.rangeNotSatisfiable = internals.statusError(416); -exports.internal = function (message, data, statusCode = 500) { - return internals.serverError(message, data, statusCode, exports.internal); -}; +exports.expectationFailed = internals.statusError(417); -exports.notImplemented = function (message, data) { +exports.teapot = internals.statusError(418); - return internals.serverError(message, data, 501, exports.notImplemented); -}; +exports.badData = internals.statusError(422); -exports.badGateway = function (message, data) { - return internals.serverError(message, data, 502, exports.badGateway); -}; +exports.locked = internals.statusError(423); -exports.serverUnavailable = function (message, data) { +exports.failedDependency = internals.statusError(424); - return internals.serverError(message, data, 503, exports.serverUnavailable); -}; +exports.tooEarly = internals.statusError(425); -exports.gatewayTimeout = function (message, data) { - return internals.serverError(message, data, 504, exports.gatewayTimeout); -}; +exports.preconditionRequired = internals.statusError(428); -exports.badImplementation = function (message, data) { +exports.tooManyRequests = internals.statusError(429); - const err = internals.serverError(message, data, 500, exports.badImplementation); - err.isDeveloperError = true; - return err; -}; +exports.illegal = internals.statusError(451); -internals.initialize = function (err, statusCode, message) { - const numberCode = parseInt(statusCode, 10); - Hoek.assert(!isNaN(numberCode) && numberCode >= 400, 'First argument must be a number (400+):', statusCode); +// 5xx Server Errors - err.isBoom = true; - err.isServer = numberCode >= 500; +internals.serverError = function (message, data) { - if (!err.hasOwnProperty('data')) { - err.data = null; - } + const isDataNonBoomError = data instanceof Error && !exports.isBoom(data); - err.output = { - statusCode: numberCode, - payload: {}, - headers: {} - }; + return [message, isDataNonBoomError ? { cause: data } : { data }]; +}; - Object.defineProperty(err, 'reformat', { value: internals.reformat, configurable: true }); - if (!message && - !err.message) { +exports.internal = internals.statusError(500, (message, data, statusCode = 500) => { - err.reformat(); - message = err.output.payload.error; + const res = internals.serverError(message, data); + if (statusCode !== 500) { + const [, options] = res; + options.statusCode = statusCode; } - if (message) { - const props = Object.getOwnPropertyDescriptor(err, 'message') || Object.getOwnPropertyDescriptor(Object.getPrototypeOf(err), 'message'); - Hoek.assert(!props || props.configurable && !props.get, 'The error is not compatible with boom'); + return res; +}); - err.message = message + (err.message ? ': ' + err.message : ''); - err.output.payload.message = err.message; - } - err.reformat(); - return err; -}; +exports.notImplemented = internals.statusError(501, internals.serverError); -internals.reformat = function (debug = false) { +exports.badGateway = internals.statusError(502, internals.serverError); - this.output.payload.statusCode = this.output.statusCode; - this.output.payload.error = internals.codes.get(this.output.statusCode) || 'Unknown'; - if (this.output.statusCode === 500 && debug !== true) { - this.output.payload.message = 'An internal server error occurred'; // Hide actual error from user - } - else if (this.message) { - this.output.payload.message = this.message; - } -}; +exports.serverUnavailable = internals.statusError(503, internals.serverError); -internals.serverError = function (messageOrError, data, statusCode, ctor) { +exports.gatewayTimeout = internals.statusError(504, internals.serverError); - if (data instanceof Error && - !data.isBoom) { - return exports.boomify(data, { statusCode, message: messageOrError }); - } +exports.badImplementation = internals.statusError(500, (message, data) => { - return new exports.Boom(messageOrError, { statusCode, data, ctor }); -}; + return [...internals.serverError(message, data), { isDeveloperError: true }]; +}); diff --git a/package.json b/package.json index b1d938f..099707c 100644 --- a/package.json +++ b/package.json @@ -21,11 +21,12 @@ "@hapi/hoek": "^11.0.2" }, "devDependencies": { + "@hapi/boom10": "npm:@hapi/boom@^10.0.1", "@hapi/code": "9.x.x", "@hapi/eslint-plugin": "^7.0.0", "@hapi/lab": "^26.0.0", - "@types/node": "^17.0.31", - "typescript": "~4.6.4" + "@types/node": "^18.19.3", + "typescript": "~5.6.3" }, "scripts": { "test": "lab -a @hapi/code -t 100 -L -Y", diff --git a/test/index.js b/test/index.js index 8c7c5a7..8c34257 100755 --- a/test/index.js +++ b/test/index.js @@ -1,6 +1,7 @@ 'use strict'; const Boom = require('..'); +const Boom10 = require('@hapi/boom10'); const Code = require('@hapi/code'); const Lab = require('@hapi/lab'); @@ -20,80 +21,102 @@ describe('Boom', () => { expect(err.output.payload.message).to.equal('oops'); expect(err.output.statusCode).to.equal(400); - expect(Object.keys(err)).to.equal(['data', 'isBoom', 'isServer', 'output']); - expect(JSON.stringify(err)).to.equal('{"data":null,"isBoom":true,"isServer":false,"output":{"statusCode":400,"payload":{"statusCode":400,"error":"Bad Request","message":"oops"},"headers":{}}}'); + expect(err.name).to.equal('Boom'); + expect(Object.keys(err)).to.equal(['data', 'output']); + expect(JSON.stringify(err)).to.equal('{"data":null,"output":{"statusCode":400,"payload":{"statusCode":400,"error":"Bad Request","message":"oops"},"headers":{}}}'); }); - it('clones error object', () => { + it('instances has .name "Boom"', () => { - const oops = new Error('oops'); - const err = new Boom.Boom(oops, { statusCode: 400 }); - expect(err).to.not.shallow.equal(oops); - expect(err.output.payload.message).to.equal('oops'); - expect(err.output.statusCode).to.equal(400); + class SubBoom extends Boom.Boom {} + + expect(new Boom.Boom().name).to.equal('Boom'); + expect(new SubBoom().name).to.equal('Boom'); }); - it('decorates error', () => { + it('instances .name can be changed', () => { - const err = new Boom.Boom('oops', { statusCode: 400, decorate: { x: 1 } }); - expect(err.output.payload.message).to.equal('oops'); - expect(err.output.statusCode).to.equal(400); - expect(err.x).to.equal(1); + class SubBoom extends Boom.Boom { + name = 'BadaBoom'; + } + + const err = new Boom.Boom(); + err.name = 'MyBoom'; + + expect(err.name).to.equal('MyBoom'); + expect(new SubBoom().name).to.equal('BadaBoom'); }); it('handles missing message', () => { - const err = new Error(); - Boom.boomify(err); + const err = new Boom.Boom(); expect(Boom.isBoom(err)).to.be.true(); + expect(err.message).to.equal('Internal Server Error'); }); - it('handles missing message (class)', () => { + it('handles missing message with unknown statusCode', () => { - const Example = class extends Error { + const err = new Boom.Boom(null, { statusCode: 999 }); + + expect(Boom.isBoom(err)).to.be.true(); + expect(err.message).to.equal('Unknown'); + }); - constructor(message) { + it('handles missing message (subclass)', () => { - super(message); - Boom.boomify(this); - } - }; + const Example = class extends Boom.Boom {}; const err = new Example(); expect(Boom.isBoom(err)).to.be.true(); }); - it('throws when statusCode is not a number', () => { + it('handles headers option', () => { - expect(() => { + const err = new Boom.Boom('fail', { statusCode: 400, headers: { custom: 'yes' } }); + expect(err.output.payload.message).to.equal('fail'); + expect(err.output.statusCode).to.equal(400); + expect(err.output.headers).to.equal({ custom: 'yes' }); + }); - new Boom.Boom('message', { statusCode: 'x' }); - }).to.throw('First argument must be a number (400+): x'); + it('clones headers object', () => { + + const headers = { custom: ['yes'] }; + const err = new Boom.Boom('fail', { statusCode: 400, headers }); + err.output.headers.custom.push('more'); + err.output.headers.extra = 'added'; + + expect(err.output.headers).to.equal({ custom: ['yes', 'more'], extra: 'added' }); + expect(headers).to.equal({ custom: ['yes'] }); }); - it('errors on incompatible message property (prototype)', () => { + it('throws TypeError on non-object headers option', () => { - const Err = class extends Error { + expect(() => { - get message() { + new Boom.Boom('fail', { statusCode: 400, headers: true }); + }).to.throw(TypeError); - return 'x'; - } - }; + expect(() => { - const err = new Err(); - expect(() => Boom.boomify(err, { message: 'override' })).to.throw('The error is not compatible with boom'); + new Boom.Boom('fail', { statusCode: 400, headers: null }); + }).to.throw(TypeError); }); - it('errors on incompatible message property (own)', () => { + it('throws when statusCode is invalid', () => { + + expect(() => { + + new Boom.Boom('message', { statusCode: 'x' }); + }).to.throw('statusCode must be a number (400+): x'); + + expect(() => { - const err = new Error(); - Object.defineProperty(err, 'message', { get: function () { } }); - expect(() => Boom.boomify(err, { message: 'override' })).to.throw('The error is not compatible with boom'); + new Boom.Boom('message', { statusCode: '200' }); + }).to.throw('statusCode must be a number (400+): 200'); }); - it('will cast a number-string to an integer', () => { + it('will cast a statusCode number-string to an integer', () => { const codes = [ { input: '404', result: 404 }, @@ -109,12 +132,12 @@ describe('Boom', () => { } }); - it('throws when statusCode is not finite', () => { + it('throws TypeError when statusCode is not finite', () => { expect(() => { new Boom.Boom('', { statusCode: 1 / 0 }); - }).to.throw('First argument must be a number (400+): null'); + }).to.throw(TypeError, 'statusCode must be a number (400+): Infinity'); }); it('sets error code to unknown', () => { @@ -123,36 +146,72 @@ describe('Boom', () => { expect(err.output.payload.error).to.equal('Unknown'); }); + it('only sets cause when part of options', () => { + + const err1 = new Boom.Boom('fail', { cause: undefined }); + expect(err1).to.include('cause'); + expect(err1.cause).to.equal(undefined); + + const err2 = new Boom.Boom('fail', {}); + expect(err2).to.not.include('cause'); + expect(err2.cause).to.equal(undefined); + }); + + it('assigns a .cause property if Error does not support it', (flags) => { + + const proto = Object.getPrototypeOf(Boom.Boom); + Object.setPrototypeOf(Boom.Boom, class extends Error { + + constructor(message, _options) { + + super(message); + } + }); + + flags.onCleanup = () => { + + Object.setPrototypeOf(Boom.Boom, proto); + }; + + const err = new Boom.Boom('fail', { cause: 0 }); + expect(err.cause).to.exist(); + expect(err.cause).to.equal(0); + }); + describe('instanceof', () => { it('identifies a boom object', () => { - const BadaBoom = class extends Boom.Boom { }; + const BadaBoom = class extends Boom.Boom {}; expect(new Boom.Boom('oops')).to.be.instanceOf(Boom.Boom); + expect(new Boom10.Boom('oops')).to.be.instanceOf(Boom.Boom); expect(new BadaBoom('oops')).to.be.instanceOf(Boom.Boom); expect(Boom.badRequest('oops')).to.be.instanceOf(Boom.Boom); expect(new Error('oops')).to.not.be.instanceOf(Boom.Boom); - expect(Boom.boomify(new Error('oops'))).to.be.instanceOf(Boom.Boom); expect({ isBoom: true }).to.not.be.instanceOf(Boom.Boom); expect(null).to.not.be.instanceOf(Boom.Boom); }); - it('returns false when called on sub-class', () => { + it('can be called on a sub-class', () => { const BadaBoom = class extends Boom.Boom {}; + // Success + + expect(new BadaBoom('oops')).to.be.instanceOf(BadaBoom); + expect(Object.create(BadaBoom.prototype)).to.be.instanceOf(BadaBoom); + + // Fail + expect(new Boom.Boom('oops')).to.not.be.instanceOf(BadaBoom); - expect(new BadaBoom('oops')).to.not.be.instanceOf(BadaBoom); expect(Boom.badRequest('oops')).to.not.be.instanceOf(BadaBoom); - expect(Boom.boomify(new Error('oops'))).to.not.be.instanceOf(BadaBoom); }); - it('handles actual sub-class instances when called on sub-class', () => { - - const BadaBoom = class extends Boom.Boom { }; + it('works from legacy boom', () => { - expect(Object.create(BadaBoom.prototype)).to.be.instanceOf(BadaBoom); + expect(new Boom.Boom('oops')).to.be.instanceOf(Boom10.Boom); + expect(new Boom10.Boom('oops')).to.be.instanceOf(Boom10.Boom); }); }); @@ -160,7 +219,13 @@ describe('Boom', () => { it('identifies a boom object', () => { + // Success + expect(Boom.isBoom(new Boom.Boom('oops'))).to.be.true(); + expect(Boom.isBoom(new Boom10.Boom('oops'))).to.be.true(); + + // Fail + expect(Boom.isBoom(new Error('oops'))).to.be.false(); expect(Boom.isBoom({ isBoom: true })).to.be.false(); expect(Boom.isBoom(null)).to.be.false(); @@ -169,11 +234,19 @@ describe('Boom', () => { it('returns true for valid boom object and valid status code', () => { expect(Boom.isBoom(Boom.notFound(),404)).to.be.true(); + expect(Boom.isBoom(Boom10.notFound(), 404)).to.be.true(); }); it('returns false for valid boom object and wrong status code', () => { - expect(Boom.isBoom(Boom.notFound(),503)).to.be.false(); + expect(Boom.isBoom(Boom.notFound(), 503)).to.be.false(); + expect(Boom.isBoom(Boom10.notFound(), 503)).to.be.false(); + }); + + it('works from legacy boom', () => { + + expect(Boom10.isBoom(new Boom.Boom('oops'))).to.be.true(); + expect(Boom10.isBoom(new Boom10.Boom('oops'))).to.be.true(); }); }); @@ -182,24 +255,15 @@ describe('Boom', () => { it('returns the same object when already boom', () => { const error = Boom.badRequest(); - expect(error).to.equal(Boom.boomify(error)); - expect(error).to.equal(Boom.boomify(error, { statusCode: 444 })); - }); - - it('decorates error', () => { - - const err = new Error('oops'); - Boom.boomify(err, { statusCode: 400, decorate: { x: 1 } }); - expect(err.x).to.equal(1); + expect(error).to.shallow.equal(Boom.boomify(error)); + expect(error).to.shallow.equal(Boom.boomify(error, { statusCode: 444 })); }); it('returns an error with info when constructed using another error', () => { const error = new Error('ka-boom'); - error.xyz = 123; const err = Boom.boomify(error); - expect(err.xyz).to.equal(123); - expect(err.message).to.equal('ka-boom'); + expect(err.cause).to.shallow.equal(error); expect(err.output).to.equal({ statusCode: 500, payload: { @@ -212,14 +276,6 @@ describe('Boom', () => { expect(err.data).to.equal(null); }); - it('does not override data when constructed using another error', () => { - - const error = new Error('ka-boom'); - error.data = { useful: 'data' }; - const err = Boom.boomify(error); - expect(err.data).to.equal(error.data); - }); - it('sets new message when none exists', () => { const error = new Error(); @@ -243,9 +299,9 @@ describe('Boom', () => { const error = new Error('Missing data'); const boom = Boom.boomify(error); - expect(boom).to.shallow.equal(error); - expect(error.output.payload.message).to.equal('An internal server error occurred'); - expect(error.output.statusCode).to.equal(500); + expect(boom.cause).to.shallow.equal(error); + expect(boom.output.payload.message).to.equal('An internal server error occurred'); + expect(boom.output.statusCode).to.equal(500); }); it('overrides message and statusCode', () => { @@ -297,15 +353,59 @@ describe('Boom', () => { const error = new Error('Missing data'); const boom = Boom.boomify(error, { message: 'Override message', statusCode: 599, override: false }); - expect(boom).to.shallow.equal(error); - expect(error.output.payload.message).to.equal('Override message: Missing data'); - expect(error.output.statusCode).to.equal(599); + expect(boom.cause).to.shallow.equal(error); + expect(boom.output.payload.message).to.equal('Override message: Missing data'); + expect(boom.output.statusCode).to.equal(599); + }); + + it('handles non-Error errors', () => { + + const boom = Boom.boomify(123, { message: 'Hello', statusCode: 400 }); + + expect(boom.cause).to.equal(123); + expect(boom.output.payload.message).to.equal('Hello: 123'); + expect(boom.output.statusCode).to.equal(400); + }); + + it('only sets isServer when it is an own property', () => { + + const boom = Boom.boomify(new Boom.Boom()); + expect(boom.isServer).to.be.true(); + expect(boom.hasOwnProperty('isServer')).to.be.false(); + + const Boom2 = class extends Boom.Boom { + + isServer = undefined; + }; + + const boom2 = Boom.boomify(new Boom2()); + expect(boom2.isServer).to.be.true(); + expect(boom2.hasOwnProperty('isServer')).to.be.true(); + }); + + it('works with legacy boom', () => { + + const boom = Boom.boomify(new Boom10.Boom(null, { statusCode: 404 }), { statusCode: 501, message: 'Override' }); + + expect(boom.cause).to.be.undefined(); + expect(boom.message).to.equal('Override: Not Found'); + expect(boom.isServer).to.be.true(); + expect(boom.hasOwnProperty('isServer')).to.be.true(); + expect(boom.output.statusCode).to.equal(501); + + const boom10 = Boom10.boomify(new Boom.Boom(null, { statusCode: 404 }), { statusCode: 501, message: 'Override' }); + + expect(boom10.cause).to.be.undefined(); + expect(boom10.message).to.equal('Override: Not Found'); + expect(boom10.isServer).to.be.true(); + expect(boom10.hasOwnProperty('isServer')).to.be.true(); + expect(boom10.output.statusCode).to.equal(501); }); }); describe('create()', () => { - it('does not sets null message', () => { + it('does not set null message', () => { const error = Boom.unauthorized(null); expect(error.output.payload.message).to.equal('Unauthorized'); @@ -322,26 +422,32 @@ describe('Boom', () => { describe('initialize()', () => { - it('does not sets null message', () => { + it('does not set null message', () => { - const err = new Error('some error message'); - const boom = Boom.boomify(err, { statusCode: 400, message: 'modified error message' }); - expect(boom.output.payload.message).to.equal('modified error message: some error message'); + const err = new Error('some error'); + const boom = new Boom.Boom('prepended error message', { statusCode: 400, cause: err }); + expect(boom.output.payload.message).to.equal('prepended error message: some error'); }); }); - describe('isBoom()', () => { + describe('isBoom', () => { - it('returns true for Boom object', () => { + it('is true for Boom object', () => { - expect(Boom.badRequest().isBoom).to.equal(true); + expect(Boom.badRequest().isBoom).to.be.true(); }); + }); - it('returns false for Error object', () => { + const utilities = ['badRequest', 'unauthorized', 'forbidden', 'notFound', 'methodNotAllowed', + 'notAcceptable', 'proxyAuthRequired', 'clientTimeout', 'conflict', + 'resourceGone', 'lengthRequired', 'preconditionFailed', 'entityTooLarge', + 'uriTooLong', 'unsupportedMediaType', 'rangeNotSatisfiable', 'expectationFailed', + 'badData', 'preconditionRequired', 'tooManyRequests', - expect((new Error()).isBoom).to.not.exist(); - }); - }); + // 500s + 'internal', 'notImplemented', 'badGateway', 'serverUnavailable', + 'gatewayTimeout', 'badImplementation' + ]; describe('badRequest()', () => { @@ -404,7 +510,13 @@ describe('Boom', () => { const err = Boom.unauthorized('boom', 'Test', { a: 1, b: 'something', c: null, d: 0 }); expect(err.output.statusCode).to.equal(401); expect(err.output.headers['WWW-Authenticate']).to.equal('Test a="1", b="something", c="", d="0", error="boom"'); - expect(err.output.payload.attributes).to.equal({ a: 1, b: 'something', c: '', d: 0, error: 'boom' }); + }); + + it('returns a WWW-Authenticate header when passed a scheme and empty attributes', () => { + + const err = Boom.unauthorized('boom', 'Test', {}); + expect(err.output.statusCode).to.equal(401); + expect(err.output.headers['WWW-Authenticate']).to.equal('Test error="boom"'); }); it('returns a WWW-Authenticate header from string input instead of object', () => { @@ -412,7 +524,6 @@ describe('Boom', () => { const err = Boom.unauthorized(null, 'Negotiate', 'VGhpcyBpcyBhIHRlc3QgdG9rZW4='); expect(err.output.statusCode).to.equal(401); expect(err.output.headers['WWW-Authenticate']).to.equal('Negotiate VGhpcyBpcyBhIHRlc3QgdG9rZW4='); - expect(err.output.payload.attributes).to.equal('VGhpcyBpcyBhIHRlc3QgdG9rZW4='); }); it('returns a WWW-Authenticate header when passed attributes, missing error', () => { @@ -813,6 +924,13 @@ describe('Boom', () => { expect(Boom.internal().output.statusCode).to.equal(500); }); + it('handles a custom error statusCode', () => { + + const err = Boom.internal(null, null, 507); + expect(err.output.statusCode).to.equal(507); + expect(err.message).to.equal('Insufficient Storage'); + }); + it('sets the message with the passed in message', () => { const err = Boom.internal('my message'); @@ -826,6 +944,14 @@ describe('Boom', () => { expect(Boom.internal('my message', { my: 'data' }).data.my).to.equal('data'); }); + it('uses data with Error as cause', () => { + + const insideErr = new Error('inside'); + const err = Boom.internal('my message', insideErr); + expect(err.data).to.not.exist(); + expect(err.cause).to.shallow.equal(insideErr); + }); + it('returns an error with composite message', () => { const x = {}; @@ -834,8 +960,11 @@ describe('Boom', () => { x.foo(); } catch (err) { - const boom = Boom.internal('Someting bad', err); - expect(boom.message).to.equal('Someting bad: x.foo is not a function'); + const boom = Boom.internal('Something bad', err); + boom.reformat(true); + expect(boom.message).to.equal('Something bad'); + expect(boom.cause).to.be.an.error(TypeError, 'x.foo is not a function'); + expect(boom.output.payload.message).to.equal('Something bad: x.foo is not a function'); expect(boom.isServer).to.be.true(); } }); @@ -852,6 +981,14 @@ describe('Boom', () => { expect(Boom.notImplemented('my message').message).to.equal('my message'); }); + + it('uses data with Error as cause', () => { + + const insideErr = new Error('inside'); + const err = Boom.notImplemented('my message', insideErr); + expect(err.data).to.not.exist(); + expect(err.cause).to.shallow.equal(insideErr); + }); }); describe('badGateway()', () => { @@ -873,6 +1010,14 @@ describe('Boom', () => { expect(boom.output.statusCode).to.equal(502); expect(boom.data).to.equal(upstream); }); + + it('uses data with Error as cause', () => { + + const insideErr = new Error('inside'); + const err = Boom.badGateway('my message', insideErr); + expect(err.data).to.not.exist(); + expect(err.cause).to.shallow.equal(insideErr); + }); }); describe('gatewayTimeout()', () => { @@ -886,6 +1031,14 @@ describe('Boom', () => { expect(Boom.gatewayTimeout('my message').message).to.equal('my message'); }); + + it('uses data with Error as cause', () => { + + const insideErr = new Error('inside'); + const err = Boom.gatewayTimeout('my message', insideErr); + expect(err.data).to.not.exist(); + expect(err.cause).to.shallow.equal(insideErr); + }); }); describe('badImplementation()', () => { @@ -926,130 +1079,56 @@ describe('Boom', () => { } }); }); + + it('uses data with Error as cause', () => { + + const insideErr = new Error('inside'); + const err = Boom.badImplementation('my message', insideErr); + expect(err.data).to.not.exist(); + expect(err.cause).to.shallow.equal(insideErr); + }); }); describe('stack trace', () => { it('should omit lib', () => { - ['badRequest', 'unauthorized', 'forbidden', 'notFound', 'methodNotAllowed', - 'notAcceptable', 'proxyAuthRequired', 'clientTimeout', 'conflict', - 'resourceGone', 'lengthRequired', 'preconditionFailed', 'entityTooLarge', - 'uriTooLong', 'unsupportedMediaType', 'rangeNotSatisfiable', 'expectationFailed', - 'badData', 'preconditionRequired', 'tooManyRequests', - - // 500s - 'internal', 'notImplemented', 'badGateway', 'serverUnavailable', - 'gatewayTimeout', 'badImplementation' - ].forEach((name) => { - + for (const name of utilities) { const err = Boom[name](); - expect(err.stack).to.not.match(/\/lib\/index\.js/); - }); + expect(err.stack).to.not.match(/(\/|\\)lib(\/|\\)index\.js/); + } }); - }); - - describe('method with error object instead of message', () => { - - [ - 'badRequest', - 'unauthorized', - 'forbidden', - 'notFound', - 'methodNotAllowed', - 'notAcceptable', - 'proxyAuthRequired', - 'clientTimeout', - 'conflict', - 'resourceGone', - 'lengthRequired', - 'preconditionFailed', - 'entityTooLarge', - 'uriTooLong', - 'unsupportedMediaType', - 'rangeNotSatisfiable', - 'expectationFailed', - 'badData', - 'preconditionRequired', - 'tooManyRequests', - 'internal', - 'notImplemented', - 'badGateway', - 'serverUnavailable', - 'gatewayTimeout', - 'badImplementation' - ].forEach((name) => { - - it(`should allow \`Boom${name}(err)\` and preserve the error`, () => { - - const error = new Error('An example mongoose validation error'); - error.name = 'ValidationError'; - const err = Boom[name](error); - expect(err.name).to.equal('ValidationError'); - expect(err.message).to.equal('An example mongoose validation error'); - }); - // exclude unauthorized + it('should not crash when Error.captureStackTrace is missing', (flags) => { - if (name !== 'unauthorized') { + const captureStackTrace = Error.captureStackTrace; - it(`should allow \`Boom.${name}(err, data)\` and preserve the data`, () => { + for (const name of utilities) { + try { + Error.captureStackTrace = undefined; + var err = Boom[name](); + } + finally { + Error.captureStackTrace = captureStackTrace; + } - const error = new Error(); - const err = Boom[name](error, { foo: 'bar' }); - expect(err.data).to.equal({ foo: 'bar' }); - }); + expect(err.stack).to.match(/(\/|\\)lib(\/|\\)index\.js/); } }); }); - describe('error.typeof', () => { - - const types = [ - 'badRequest', - 'unauthorized', - 'forbidden', - 'notFound', - 'methodNotAllowed', - 'notAcceptable', - 'proxyAuthRequired', - 'clientTimeout', - 'conflict', - 'resourceGone', - 'lengthRequired', - 'preconditionFailed', - 'entityTooLarge', - 'uriTooLong', - 'unsupportedMediaType', - 'rangeNotSatisfiable', - 'expectationFailed', - 'badData', - 'preconditionRequired', - 'tooManyRequests', - 'internal', - 'notImplemented', - 'badGateway', - 'serverUnavailable', - 'gatewayTimeout', - 'badImplementation' - ]; - - types.forEach((name) => { - - it(`matches typeof Boom.${name}`, () => { + describe('method with error object instead of message', () => { - const error = Boom[name](); - types.forEach((type) => { + for (const name of utilities) { + it(`uses stringified error as message`, () => { - if (type === name) { - expect(error.typeof).to.equal(Boom[name]); - } - else { - expect(error.typeof).to.not.equal(Boom[type]); - } - }); + const error = new Error('An example mongoose validation error'); + error.name = 'ValidationError'; + const err = Boom[name](error); + expect(err.cause).to.not.exist(); + expect(err.message).to.equal(error.toString()); }); - }); + } }); describe('reformat()', () => { @@ -1057,7 +1136,7 @@ describe('Boom', () => { it('displays internal server error messages in debug mode', () => { const error = new Error('ka-boom'); - const err = Boom.boomify(error, { statusCode: 500 }); + const err = new Boom.Boom(null, { statusCode: 500, cause: error }); err.reformat(false); expect(err.output).to.equal({ @@ -1086,5 +1165,45 @@ describe('Boom', () => { Object.defineProperty(new Boom.Boom('oops'), 'reformat', { value: true }); }); + + it('can be implemented by subclasses to apply custom formatting', () => { + + class MyBoom extends Boom.Boom { + + reformat(...args) { + + super.reformat(...args); + + this.output.payload.custom = true; + } + } + + const err = new MyBoom('boom', { statusCode: 400 }); + expect(err.output.statusCode).to.equal(400); + expect(err.output.payload.message).to.equal('boom'); + expect(err.output.payload.custom).to.be.true(); + + err.output.statusCode = 500; + err.reformat(); + expect(err.output.statusCode).to.equal(500); + expect(err.output.payload.message).to.equal('An internal server error occurred'); + expect(err.output.payload.custom).to.be.true(); + }); + + it('prototype can be changed to always debug', (flags) => { + + const proto = Boom.Boom.prototype.reformat; + flags.onCleanup = () => { + + Boom.Boom.prototype.reformat = proto; + }; + + Boom.Boom.prototype.reformat = function () { + + return proto.call(this, true); + }; + + expect(Boom.internal('DEBUG').output.payload.message).to.equal('DEBUG'); + }); }); }); diff --git a/test/index.ts b/test/index.ts index 046b37d..fdeac2c 100755 --- a/test/index.ts +++ b/test/index.ts @@ -4,26 +4,18 @@ import * as Lab from '@hapi/lab'; const { expect } = Lab.types; -class X { - - x: number; - - constructor(value: number) { - - this.x = value; - } -}; - -const decorate = new X(1); - - // new Boom.Boom() -expect.type(new Boom.Boom()); expect.type(new Boom.Boom()); -expect.type(new Boom.Boom('error')); +expect.type>(new Boom.Boom('error')); +expect.type>(new Boom.Boom('error', { data: true })); +expect.type>(new Boom.Boom('error')); +expect.type>(new Boom.Boom('error', { data: true })); -expect.error(new Boom.Boom('error', { decorate })); // No support for decoration on constructor +expect.error(new Boom.Boom(null)); +expect.error(new Boom.Boom(new Error('error'))); +expect.error(new Boom.Boom('error')); +expect.error(new Boom.Boom('error', { data: true })); class CustomError extends Boom.Boom {} @@ -48,18 +40,31 @@ expect.type(boom.output.headers); // boomify() const error = new Error('Unexpected input'); +class BadaBoom extends Boom.Boom { + constructor() { super('boom', { data: 1 }) } +} +expect.type(Boom.boomify(error)); expect.type(Boom.boomify(error, { statusCode: 400 })); expect.type(Boom.boomify(error, { statusCode: 400, message: 'Unexpected Input', override: false })); -expect.type(Boom.boomify(error, { decorate }).x); +expect.type(Boom.boomify('error')); +expect.type>(Boom.boomify(new Boom.Boom<{ foo: 'bar' }>('error', { data: { foo: 'bar' }}))); +expect.type>(Boom.boomify(error, { data: 'bla' })); +expect.type>(Boom.boomify>(error, { data: 'bla' })); +expect.type(Boom.boomify(new BadaBoom(), { statusCode: 400 })); +expect.type>(Boom.boomify(new BadaBoom(), { statusCode: 400 })); +expect.type(Boom.boomify(new BadaBoom(), { data: 'bla' }).data); + +expect.type>(Boom.boomify(new Boom.Boom('error', { data: 'ok' }))); +expect.type>(Boom.boomify(new Boom.Boom('error', { data: 'ok' }), { data: 1 })); +expect.type>(Boom.boomify>(new Boom.Boom('error', { data: 'ok' }), { data: 1 })); +expect.error(Boom.boomify()); expect.error(Boom.boomify(error, { statusCode: '400' })); -expect.error(Boom.boomify('error')); expect.error(Boom.boomify(error, { statusCode: 400, message: true })); expect.error(Boom.boomify(error, { statusCode: 400, override: 'false' })); -expect.error(Boom.boomify()); -expect.error(Boom.boomify(error, { decorate }).y); - +expect.error(Boom.boomify(error, { decorate: { x: 'y' } })); +//expect.error(Boom.boomify>(new Boom.Boom('error', { data: 'ok' }))); // Cannot work without partial type inference (https://github.com/microsoft/TypeScript/issues/26242) // isBoom @@ -82,40 +87,40 @@ expect.error(Boom.isBoom()); // badRequest() -expect.type(Boom.badRequest('invalid query', 'some data')); -expect.type(Boom.badRequest('invalid query', { foo: 'bar' })); +expect.type>(Boom.badRequest('invalid query', 'some data')); +expect.type>(Boom.badRequest('invalid query', { foo: 'bar' })); expect.type(Boom.badRequest('invalid query')); expect.type(Boom.badRequest()); expect.error(Boom.badRequest(400)); expect.error(Boom.badRequest({ foo: 'bar' })); +expect.error(Boom.badRequest(new Error())); // unauthorized() -expect.type(Boom.unauthorized('invalid password')); -expect.type(Boom.unauthorized('invalid password', 'simple')); -expect.type(Boom.unauthorized(null, 'Negotiate', 'VGhpcyBpcyBhIHRlc3QgdG9rZW4=')); -expect.type(Boom.unauthorized('invalid password', 'sample', { ttl: 0, cache: null, foo: 'bar' })); -expect.type(Boom.unauthorized('invalid password', 'sample', { ttl: 0, cache: null, foo: 'bar' } as Boom.unauthorized.Attributes)); -expect.type(Boom.unauthorized()); -expect.type(Boom.unauthorized('basic', ['a', 'b', 'c'])); -expect.type(Boom.unauthorized('', 'basic')); -expect.type(Boom.unauthorized(null, 'basic')); -expect.type(Boom.unauthorized('', 'basic').isMissing); -expect.type(Boom.unauthorized(null, 'basic').isMissing); - -expect.error(Boom.unauthorized(401)) -expect.error(Boom.unauthorized('invalid password', 500)) -expect.error(Boom.unauthorized('invalid password', 'sample', 500)) +expect.type>(Boom.unauthorized('invalid password')); +expect.type>(Boom.unauthorized('invalid password', 'simple')); +expect.type>(Boom.unauthorized(null, 'Negotiate', 'VGhpcyBpcyBhIHRlc3QgdG9rZW4=')); +expect.type>(Boom.unauthorized('invalid password', 'sample', { ttl: 0, cache: null, foo: 'bar' })); +expect.type>(Boom.unauthorized('invalid password', 'sample', { ttl: 0, cache: null, foo: 'bar' } as Boom.unauthorized.Attributes)); +expect.type>(Boom.unauthorized()); +expect.type>(Boom.unauthorized('basic', ['a', 'b', 'c'])); +expect.type & Boom.unauthorized.MissingAuth>(Boom.unauthorized('', 'basic')); +expect.type & Boom.unauthorized.MissingAuth>(Boom.unauthorized(null, 'basic')); +expect.type(Boom.unauthorized('', 'basic').isMissing); +expect.type(Boom.unauthorized(null, 'basic').isMissing); + +expect.error(Boom.unauthorized(401)); +expect.error(Boom.unauthorized('invalid password', 500)); +expect.error(Boom.unauthorized('invalid password', 'sample', 500)); expect.error(Boom.unauthorized('basic', ['a', 'b', 'c'], 'test')); expect.error(Boom.unauthorized('message', 'basic').isMissing); - // paymentRequired() -expect.type(Boom.paymentRequired('bandwidth used', 'some data')); -expect.type(Boom.paymentRequired('bandwidth used', { foo: 'bar' })); +expect.type>(Boom.paymentRequired('bandwidth used', 'some data')); +expect.type>(Boom.paymentRequired('bandwidth used', { foo: 'bar' })); expect.type(Boom.paymentRequired('bandwidth used')); expect.type(Boom.paymentRequired()); @@ -125,8 +130,8 @@ expect.error(Boom.paymentRequired({ foo: 'bar' })); // forbidden() -expect.type(Boom.forbidden('try again some time', 'some data')); -expect.type(Boom.forbidden('try again some time', { foo: 'bar' })); +expect.type>(Boom.forbidden('try again some time', 'some data')); +expect.type>(Boom.forbidden('try again some time', { foo: 'bar' })); expect.type(Boom.forbidden('try again some time')); expect.type(Boom.forbidden()); @@ -136,8 +141,8 @@ expect.error(Boom.forbidden({ foo: 'bar' })); // notFound() -expect.type(Boom.notFound('missing', 'some data')); -expect.type(Boom.notFound('missing', { foo: 'bar' })); +expect.type>(Boom.notFound('missing', 'some data')); +expect.type>(Boom.notFound('missing', { foo: 'bar' })); expect.type(Boom.notFound('missing')); expect.type(Boom.notFound()); @@ -147,8 +152,8 @@ expect.error(Boom.notFound({ foo: 'bar' })); // methodNotAllowed() -expect.type(Boom.methodNotAllowed('this method is not allowed', 'some data')); -expect.type(Boom.methodNotAllowed('this method is not allowed', { foo: 'bar' })); +expect.type>(Boom.methodNotAllowed('this method is not allowed', 'some data')); +expect.type>(Boom.methodNotAllowed('this method is not allowed', { foo: 'bar' })); expect.type(Boom.methodNotAllowed('this method is not allowed')); expect.type(Boom.methodNotAllowed()); @@ -158,8 +163,8 @@ expect.error(Boom.methodNotAllowed({ foo: 'bar' })); // notAcceptable() -expect.type(Boom.notAcceptable('unacceptable', 'some data')); -expect.type(Boom.notAcceptable('unacceptable', { foo: 'bar' })); +expect.type>(Boom.notAcceptable('unacceptable', 'some data')); +expect.type>(Boom.notAcceptable('unacceptable', { foo: 'bar' })); expect.type(Boom.notAcceptable('unacceptable')); expect.type(Boom.notAcceptable()); @@ -169,8 +174,8 @@ expect.error(Boom.notAcceptable({ foo: 'bar' })); // proxyAuthRequired() -expect.type(Boom.proxyAuthRequired('auth missing', 'some data')); -expect.type(Boom.proxyAuthRequired('auth missing', { foo: 'bar' })); +expect.type>(Boom.proxyAuthRequired('auth missing', 'some data')); +expect.type>(Boom.proxyAuthRequired('auth missing', { foo: 'bar' })); expect.type(Boom.proxyAuthRequired('auth missing')); expect.type(Boom.proxyAuthRequired()); @@ -180,8 +185,8 @@ expect.error(Boom.proxyAuthRequired({ foo: 'bar' })); // clientTimeout() -expect.type(Boom.clientTimeout('timed out', 'some data')); -expect.type(Boom.clientTimeout('timed out', { foo: 'bar' })); +expect.type>(Boom.clientTimeout('timed out', 'some data')); +expect.type>(Boom.clientTimeout('timed out', { foo: 'bar' })); expect.type(Boom.clientTimeout('timed out')); expect.type(Boom.clientTimeout()); @@ -191,8 +196,8 @@ expect.error(Boom.clientTimeout({ foo: 'bar' })); // conflict() -expect.type(Boom.conflict('there was a conflict', 'some data')); -expect.type(Boom.conflict('there was a conflict', { foo: 'bar' })); +expect.type>(Boom.conflict('there was a conflict', 'some data')); +expect.type>(Boom.conflict('there was a conflict', { foo: 'bar' })); expect.type(Boom.conflict('there was a conflict')); expect.type(Boom.conflict()); @@ -202,8 +207,8 @@ expect.error(Boom.conflict({ foo: 'bar' })); // resourceGone() -expect.type(Boom.resourceGone('it is gone', 'some data')); -expect.type(Boom.resourceGone('it is gone', { foo: 'bar' })); +expect.type>(Boom.resourceGone('it is gone', 'some data')); +expect.type>(Boom.resourceGone('it is gone', { foo: 'bar' })); expect.type(Boom.resourceGone('it is gone')); expect.type(Boom.resourceGone()); @@ -213,8 +218,8 @@ expect.error(Boom.resourceGone({ foo: 'bar' })); // lengthRequired() -expect.type(Boom.lengthRequired('length needed', 'some data')); -expect.type(Boom.lengthRequired('length needed', { foo: 'bar' })); +expect.type>(Boom.lengthRequired('length needed', 'some data')); +expect.type>(Boom.lengthRequired('length needed', { foo: 'bar' })); expect.type(Boom.lengthRequired('length needed')); expect.type(Boom.lengthRequired()); @@ -224,8 +229,8 @@ expect.error(Boom.lengthRequired({ foo: 'bar' })); // preconditionFailed() -expect.type(Boom.preconditionFailed('failed', 'some data')); -expect.type(Boom.preconditionFailed('failed', { foo: 'bar' })); +expect.type>(Boom.preconditionFailed('failed', 'some data')); +expect.type>(Boom.preconditionFailed('failed', { foo: 'bar' })); expect.type(Boom.preconditionFailed('failed')); expect.type(Boom.preconditionFailed()); @@ -235,8 +240,8 @@ expect.error(Boom.preconditionFailed({ foo: 'bar' })); // entityTooLarge() -expect.type(Boom.entityTooLarge('too big', 'some data')); -expect.type(Boom.entityTooLarge('too big', { foo: 'bar' })); +expect.type>(Boom.entityTooLarge('too big', 'some data')); +expect.type>(Boom.entityTooLarge('too big', { foo: 'bar' })); expect.type(Boom.entityTooLarge('too big')); expect.type(Boom.entityTooLarge()); @@ -246,8 +251,8 @@ expect.error(Boom.entityTooLarge({ foo: 'bar' })); // uriTooLong() -expect.type(Boom.uriTooLong('uri is too long', 'some data')); -expect.type(Boom.uriTooLong('uri is too long', { foo: 'bar' })); +expect.type>(Boom.uriTooLong('uri is too long', 'some data')); +expect.type>(Boom.uriTooLong('uri is too long', { foo: 'bar' })); expect.type(Boom.uriTooLong('uri is too long')); expect.type(Boom.uriTooLong()); @@ -257,8 +262,8 @@ expect.error(Boom.uriTooLong({ foo: 'bar' })); // unsupportedMediaType() -expect.type(Boom.unsupportedMediaType('that media is not supported', 'some data')); -expect.type(Boom.unsupportedMediaType('that media is not supported', { foo: 'bar' })); +expect.type>(Boom.unsupportedMediaType('that media is not supported', 'some data')); +expect.type>(Boom.unsupportedMediaType('that media is not supported', { foo: 'bar' })); expect.type(Boom.unsupportedMediaType('that media is not supported')); expect.type(Boom.unsupportedMediaType()); @@ -268,8 +273,8 @@ expect.error(Boom.unsupportedMediaType({ foo: 'bar' })); // rangeNotSatisfiable() -expect.type(Boom.rangeNotSatisfiable('range not satisfiable', 'some data')); -expect.type(Boom.rangeNotSatisfiable('range not satisfiable', { foo: 'bar' })); +expect.type>(Boom.rangeNotSatisfiable('range not satisfiable', 'some data')); +expect.type>(Boom.rangeNotSatisfiable('range not satisfiable', { foo: 'bar' })); expect.type(Boom.rangeNotSatisfiable('range not satisfiable')); expect.type(Boom.rangeNotSatisfiable()); @@ -279,8 +284,8 @@ expect.error(Boom.rangeNotSatisfiable({ foo: 'bar' })); // expectationFailed() -expect.type(Boom.expectationFailed('expected this to work', 'some data')); -expect.type(Boom.expectationFailed('expected this to work', { foo: 'bar' })); +expect.type>(Boom.expectationFailed('expected this to work', 'some data')); +expect.type>(Boom.expectationFailed('expected this to work', { foo: 'bar' })); expect.type(Boom.expectationFailed('expected this to work')); expect.type(Boom.expectationFailed()); @@ -290,8 +295,8 @@ expect.error(Boom.expectationFailed({ foo: 'bar' })); // teapot() -expect.type(Boom.teapot('sorry, no coffee...', 'some data')); -expect.type(Boom.teapot('sorry, no coffee...', { foo: 'bar' })); +expect.type>(Boom.teapot('sorry, no coffee...', 'some data')); +expect.type>(Boom.teapot('sorry, no coffee...', { foo: 'bar' })); expect.type(Boom.teapot('sorry, no coffee...')); expect.type(Boom.teapot()); @@ -301,8 +306,8 @@ expect.error(Boom.teapot({ foo: 'bar' })); // badData() -expect.type(Boom.badData('your data is bad and you should feel bad', 'some data')); -expect.type(Boom.badData('your data is bad and you should feel bad', { foo: 'bar' })); +expect.type>(Boom.badData('your data is bad and you should feel bad', 'some data')); +expect.type>(Boom.badData('your data is bad and you should feel bad', { foo: 'bar' })); expect.type(Boom.badData('your data is bad and you should feel bad')); expect.type(Boom.badData()); @@ -312,8 +317,8 @@ expect.error(Boom.badData({ foo: 'bar' })); // locked() -expect.type(Boom.locked('this resource has been locked', 'some data')); -expect.type(Boom.locked('this resource has been locked', { foo: 'bar' })); +expect.type>(Boom.locked('this resource has been locked', 'some data')); +expect.type>(Boom.locked('this resource has been locked', { foo: 'bar' })); expect.type(Boom.locked('this resource has been locked')); expect.type(Boom.locked()); @@ -323,8 +328,8 @@ expect.error(Boom.locked({ foo: 'bar' })); // failedDependency() -expect.type(Boom.failedDependency('an external resource failed', 'some data')); -expect.type(Boom.failedDependency('an external resource failed', { foo: 'bar' })); +expect.type>(Boom.failedDependency('an external resource failed', 'some data')); +expect.type>(Boom.failedDependency('an external resource failed', { foo: 'bar' })); expect.type(Boom.failedDependency('an external resource failed')); expect.type(Boom.failedDependency()); @@ -333,8 +338,8 @@ expect.error(Boom.failedDependency({ foo: 'bar' })); // tooEarly() -expect.type(Boom.tooEarly('won\'t process your request', 'some data')); -expect.type(Boom.tooEarly('won\'t process your request', { foo: 'bar' })); +expect.type>(Boom.tooEarly('won\'t process your request', 'some data')); +expect.type>(Boom.tooEarly('won\'t process your request', { foo: 'bar' })); expect.type(Boom.tooEarly('won\'t process your request')); expect.type(Boom.tooEarly()); @@ -343,8 +348,8 @@ expect.error(Boom.tooEarly({ foo: 'bar' })); // preconditionRequired() -expect.type(Boom.preconditionRequired('you must supple an If-Match header', 'some data')); -expect.type(Boom.preconditionRequired('you must supple an If-Match header', { foo: 'bar' })); +expect.type>(Boom.preconditionRequired('you must supple an If-Match header', 'some data')); +expect.type>(Boom.preconditionRequired('you must supple an If-Match header', { foo: 'bar' })); expect.type(Boom.preconditionRequired('you must supple an If-Match header')); expect.type(Boom.preconditionRequired()); @@ -354,8 +359,8 @@ expect.error(Boom.preconditionRequired({ foo: 'bar' })); // tooManyRequests() -expect.type(Boom.tooManyRequests('you have exceeded your request limit', 'some data')); -expect.type(Boom.tooManyRequests('you have exceeded your request limit', { foo: 'bar' })); +expect.type>(Boom.tooManyRequests('you have exceeded your request limit', 'some data')); +expect.type>(Boom.tooManyRequests('you have exceeded your request limit', { foo: 'bar' })); expect.type(Boom.tooManyRequests('you have exceeded your request limit')); expect.type(Boom.tooManyRequests()); @@ -365,8 +370,8 @@ expect.error(Boom.tooManyRequests({ foo: 'bar' })); // illegal() -expect.type(Boom.illegal('you are not permitted to view this resource for legal reasons', 'some data')); -expect.type(Boom.illegal('you are not permitted to view this resource for legal reasons', { foo: 'bar' })); +expect.type>(Boom.illegal('you are not permitted to view this resource for legal reasons', 'some data')); +expect.type>(Boom.illegal('you are not permitted to view this resource for legal reasons', { foo: 'bar' })); expect.type(Boom.illegal('you are not permitted to view this resource for legal reasons')); expect.type(Boom.illegal()); @@ -378,8 +383,8 @@ expect.error(Boom.illegal({ foo: 'bar' })); // internal() -expect.type(Boom.internal('terrible implementation', 'some data', 599)); -expect.type(Boom.internal('terrible implementation', { foo: 'bar' })); +expect.type>(Boom.internal('terrible implementation', 'some data', 599)); +expect.type>(Boom.internal('terrible implementation', { foo: 'bar' })); expect.type(Boom.internal('terrible implementation')); expect.type(Boom.internal()); @@ -389,8 +394,8 @@ expect.error(Boom.internal({ foo: 'bar' })); // badImplementation() -expect.type(Boom.badImplementation('terrible implementation', 'some data')); -expect.type(Boom.badImplementation('terrible implementation', { foo: 'bar' })); +expect.type>(Boom.badImplementation('terrible implementation', 'some data')); +expect.type>(Boom.badImplementation('terrible implementation', { foo: 'bar' })); expect.type(Boom.badImplementation('terrible implementation')); expect.type(Boom.badImplementation()); @@ -400,8 +405,8 @@ expect.error(Boom.badImplementation({ foo: 'bar' })); // notImplemented() -expect.type(Boom.notImplemented('method not implemented', 'some data')); -expect.type(Boom.notImplemented('method not implemented', { foo: 'bar' })); +expect.type>(Boom.notImplemented('method not implemented', 'some data')); +expect.type>(Boom.notImplemented('method not implemented', { foo: 'bar' })); expect.type(Boom.notImplemented('method not implemented')); expect.type(Boom.notImplemented()); @@ -411,8 +416,8 @@ expect.error(Boom.notImplemented({ foo: 'bar' })); // badGateway() -expect.type(Boom.badGateway('this is a bad gateway', 'some data')); -expect.type(Boom.badGateway('this is a bad gateway', { foo: 'bar' })); +expect.type>(Boom.badGateway('this is a bad gateway', 'some data')); +expect.type>(Boom.badGateway('this is a bad gateway', { foo: 'bar' })); expect.type(Boom.badGateway('this is a bad gateway')); expect.type(Boom.badGateway()); @@ -422,8 +427,8 @@ expect.error(Boom.badGateway({ foo: 'bar' })); // serverUnavailable() -expect.type(Boom.serverUnavailable('unavailable', 'some data')); -expect.type(Boom.serverUnavailable('unavailable', { foo: 'bar' })); +expect.type>(Boom.serverUnavailable('unavailable', 'some data')); +expect.type>(Boom.serverUnavailable('unavailable', { foo: 'bar' })); expect.type(Boom.serverUnavailable('unavailable')); expect.type(Boom.serverUnavailable()); @@ -433,8 +438,8 @@ expect.error(Boom.serverUnavailable({ foo: 'bar' })); // gatewayTimeout() -expect.type(Boom.gatewayTimeout('gateway timeout', 'some data')); -expect.type(Boom.gatewayTimeout('gateway timeout', { foo: 'bar' })); +expect.type>(Boom.gatewayTimeout('gateway timeout', 'some data')); +expect.type>(Boom.gatewayTimeout('gateway timeout', { foo: 'bar' })); expect.type(Boom.gatewayTimeout('gateway timeout')); expect.type(Boom.gatewayTimeout());