From 3f322c49e43b4837a47a4c010bf402f0b91e4b8f Mon Sep 17 00:00:00 2001 From: Gil Pedersen Date: Fri, 1 Dec 2023 15:14:34 +0100 Subject: [PATCH 01/45] Rework to be a regular class instance --- API.md | 6 -- lib/index.js | 161 ++++++++++++++++++++++++-------------------------- test/index.js | 136 ++++++++++++++++++------------------------ 3 files changed, 132 insertions(+), 171 deletions(-) diff --git a/API.md b/API.md index 022e361..9bff592 100755 --- a/API.md +++ b/API.md @@ -27,12 +27,6 @@ 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. - #### Helper Methods ##### `new Boom.Boom(message, [options])` diff --git a/lib/index.js b/lib/index.js index 709b754..b446322 100755 --- a/lib/index.js +++ b/lib/index.js @@ -68,25 +68,32 @@ const internals = { exports.Boom = class extends Error { + isBoom = true; + isServer; + data = null; + output; + constructor(messageOrError, options = {}) { + let cause; + if (messageOrError instanceof Error) { - return exports.boomify(Hoek.clone(messageOrError), options); + cause = messageOrError; + messageOrError = options.message; + options.message = null; + } + else if (typeof messageOrError !== 'string') { + messageOrError = options.message; + options.message = null; } - 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); - - Object.defineProperty(boom, 'typeof', { value: ctor }); + const { statusCode = 500, data, decorate, message, ctor = exports.Boom } = options; - if (options.decorate) { - Object.assign(boom, options.decorate); - } + super(messageOrError ?? internals.codes.get(statusCode) ?? 'Unknown', { cause }); + Error.captureStackTrace(this, ctor); // Filter the stack to our external API + this._apply(data, decorate, statusCode, message); - return boom; + Object.defineProperty(this, 'typeof', { value: ctor }); } static [Symbol.hasInstance](instance) { @@ -99,40 +106,79 @@ exports.Boom = class extends Error { return this.prototype.isPrototypeOf(instance); } -}; + reformat(debug = false) { -exports.isBoom = function (err, statusCode) { + this.output.payload.statusCode = this.output.statusCode; + this.output.payload.error = internals.codes.get(this.output.statusCode) ?? 'Unknown'; - return err instanceof Error && !!err.isBoom && (!statusCode || err.output.statusCode === statusCode); -}; + if (this.output.statusCode === 500 && debug !== true) { + this.output.payload.message = 'An internal server error occurred'; // Hide actual error from user + } + else { + this.output.payload.message = this.message; + if (this.cause?.message) { + this.output.payload.message = (this.message === this.output.payload.error) ? this.cause.message : this.message + ': ' + this.cause.message; + } + } + } + + _apply(data, decorate, statusCode, message) { + + if (data !== undefined) { + this.data = data; + } + if (decorate) { + Object.assign(this, decorate); + } -exports.boomify = function (err, options) { + if (statusCode) { + const numberCode = parseInt(statusCode, 10); + Hoek.assert(!isNaN(numberCode) && numberCode >= 400, 'statusCode must be a number (400+):', statusCode); - Hoek.assert(err instanceof Error, 'Cannot wrap non-Error object'); + this.isServer = numberCode >= 500; - options = options || {}; + this.output = { + statusCode: numberCode, + payload: {}, + headers: {} + }; - if (options.data !== undefined) { - err.data = options.data; - } + if (message) { + this.message = `${message}: ${this.message}`; + } - if (options.decorate) { - Object.assign(err, options.decorate); + this.reformat(); + } } +}; + + +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 boomify non-Error object'); if (!err.isBoom) { - return internals.initialize(err, options.statusCode ?? 500, options.message); + return new exports.Boom(err, options); } - if (options.override === false || // Defaults to true - !options.statusCode && !options.message) { + const { override, data, decorate, statusCode, message } = options; - return err; + if (override === false) { // Defaults to true + err._apply(data, decorate); + } + else { + err._apply(data, decorate, statusCode ?? err.output.statusCode, message); } - return internals.initialize(err, options.statusCode ?? err.output.statusCode, options.message); + return err; }; @@ -397,67 +443,12 @@ exports.badImplementation = function (message, data) { return err; }; - -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); - - err.isBoom = true; - err.isServer = numberCode >= 500; - - if (!err.hasOwnProperty('data')) { - err.data = null; - } - - err.output = { - statusCode: numberCode, - payload: {}, - headers: {} - }; - - Object.defineProperty(err, 'reformat', { value: internals.reformat, configurable: true }); - - if (!message && - !err.message) { - - err.reformat(); - message = err.output.payload.error; - } - - 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'); - - err.message = message + (err.message ? ': ' + err.message : ''); - err.output.payload.message = err.message; - } - - err.reformat(); - return err; -}; - - -internals.reformat = function (debug = false) { - - 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; - } -}; - - internals.serverError = function (messageOrError, data, statusCode, ctor) { if (data instanceof Error && !data.isBoom) { - return exports.boomify(data, { statusCode, message: messageOrError }); + return new exports.Boom(data, { statusCode, message: messageOrError, ctor }); } return new exports.Boom(messageOrError, { statusCode, data, ctor }); diff --git a/test/index.js b/test/index.js index 8c7c5a7..d3cb7e9 100755 --- a/test/index.js +++ b/test/index.js @@ -20,17 +20,8 @@ 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":{}}}'); - }); - - it('clones error object', () => { - - 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); + expect(Object.keys(err)).to.equal(['isBoom', 'isServer', 'data', 'output']); + expect(JSON.stringify(err)).to.equal('{"isBoom":true,"isServer":false,"data":null,"output":{"statusCode":400,"payload":{"statusCode":400,"error":"Bad Request","message":"oops"},"headers":{}}}'); }); it('decorates error', () => { @@ -43,22 +34,23 @@ describe('Boom', () => { it('handles missing message', () => { - const err = new Error(); - Boom.boomify(err); + const err = new Boom.Boom(new Error()); 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(new Error(), { statusCode: 999 }); - constructor(message) { + expect(Boom.isBoom(err)).to.be.true(); + expect(err.message).to.equal('Unknown'); + }); - super(message); - Boom.boomify(this); - } - }; + it('handles missing message (subclass)', () => { + + const Example = class extends Boom.Boom {}; const err = new Example(); expect(Boom.isBoom(err)).to.be.true(); @@ -69,10 +61,10 @@ describe('Boom', () => { expect(() => { new Boom.Boom('message', { statusCode: 'x' }); - }).to.throw('First argument must be a number (400+): x'); + }).to.throw('statusCode must be a number (400+): x'); }); - it('errors on incompatible message property (prototype)', () => { + it('handles readonly error message property', () => { const Err = class extends Error { @@ -82,18 +74,12 @@ describe('Boom', () => { } }; - const err = new Err(); - expect(() => Boom.boomify(err, { message: 'override' })).to.throw('The error is not compatible with boom'); - }); - - it('errors on incompatible message property (own)', () => { - - 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'); + const err = new Boom.Boom(new Err(), { message: 'override' }); + expect(Boom.isBoom(err)).to.be.true(); + expect(err.message).to.equal('override'); }); - 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 }, @@ -114,7 +100,7 @@ describe('Boom', () => { expect(() => { new Boom.Boom('', { statusCode: 1 / 0 }); - }).to.throw('First argument must be a number (400+): null'); + }).to.throw('statusCode must be a number (400+): null'); }); it('sets error code to unknown', () => { @@ -127,32 +113,29 @@ describe('Boom', () => { 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 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 {}; - 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); - }); + // Success - it('handles actual sub-class instances when called on sub-class', () => { + expect(new BadaBoom('oops')).to.be.instanceOf(BadaBoom); + expect(Object.create(BadaBoom.prototype)).to.be.instanceOf(BadaBoom); - const BadaBoom = class extends Boom.Boom { }; + // Fail - expect(Object.create(BadaBoom.prototype)).to.be.instanceOf(BadaBoom); + expect(new Boom.Boom('oops')).to.not.be.instanceOf(BadaBoom); + expect(Boom.badRequest('oops')).to.not.be.instanceOf(BadaBoom); }); }); @@ -160,7 +143,12 @@ describe('Boom', () => { it('identifies a boom object', () => { + // Success + expect(Boom.isBoom(new Boom.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(); @@ -182,24 +170,22 @@ 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 })); + expect(error).to.shallow.equal(Boom.boomify(error)); + expect(error).to.shallow.equal(Boom.boomify(error, { statusCode: 444 })); }); it('decorates error', () => { - const err = new Error('oops'); - Boom.boomify(err, { statusCode: 400, decorate: { x: 1 } }); + const error = new Error('oops'); + const err = Boom.boomify(error, { statusCode: 400, decorate: { x: 1 } }); expect(err.x).to.equal(1); }); 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 +198,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 +221,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,9 +275,9 @@ 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); }); }); @@ -325,21 +303,16 @@ describe('Boom', () => { it('does not sets null message', () => { const err = new Error('some error message'); - const boom = Boom.boomify(err, { statusCode: 400, message: 'modified error message' }); + const boom = new Boom.Boom(err, { statusCode: 400, message: 'modified error message' }); expect(boom.output.payload.message).to.equal('modified error message: some error message'); }); }); - describe('isBoom()', () => { - - it('returns true for Boom object', () => { - - expect(Boom.badRequest().isBoom).to.equal(true); - }); + describe('isBoom', () => { - it('returns false for Error object', () => { + it('is true for Boom object', () => { - expect((new Error()).isBoom).to.not.exist(); + expect(Boom.badRequest().isBoom).to.be.true(); }); }); @@ -834,8 +807,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(); } }); @@ -980,13 +956,13 @@ describe('Boom', () => { 'badImplementation' ].forEach((name) => { - it(`should allow \`Boom${name}(err)\` and preserve the error`, () => { + 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'); + expect(err.cause.name).to.equal('ValidationError'); + expect(err.cause.message).to.equal('An example mongoose validation error'); }); // exclude unauthorized @@ -1057,7 +1033,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(error, { statusCode: 500 }); err.reformat(false); expect(err.output).to.equal({ From 84b81e0e813a2c02b5f48b56c3a1b386f1cbfe20 Mon Sep 17 00:00:00 2001 From: Gil Pedersen Date: Mon, 4 Dec 2023 11:34:23 +0100 Subject: [PATCH 02/45] Tighten input types and make cause option explicit --- lib/index.js | 133 +++++++++++++++++++++++--------------------------- test/index.js | 49 +++++-------------- 2 files changed, 72 insertions(+), 110 deletions(-) diff --git a/lib/index.js b/lib/index.js index b446322..56af936 100755 --- a/lib/index.js +++ b/lib/index.js @@ -73,25 +73,14 @@ exports.Boom = class extends Error { data = null; output; - constructor(messageOrError, options = {}) { + constructor(message, options = {}) { - let cause; + const { statusCode = 500, data, decorate, ctor = exports.Boom } = options; - if (messageOrError instanceof Error) { - cause = messageOrError; - messageOrError = options.message; - options.message = null; - } - else if (typeof messageOrError !== 'string') { - messageOrError = options.message; - options.message = null; - } - - const { statusCode = 500, data, decorate, message, ctor = exports.Boom } = options; - - super(messageOrError ?? internals.codes.get(statusCode) ?? 'Unknown', { cause }); + super(message ?? internals.codes.get(statusCode) ?? 'Unknown', options); Error.captureStackTrace(this, ctor); // Filter the stack to our external API - this._apply(data, decorate, statusCode, message); + + this._apply(data, decorate, statusCode); Object.defineProperty(this, 'typeof', { value: ctor }); } @@ -165,12 +154,12 @@ exports.boomify = function (err, options = {}) { Hoek.assert(err instanceof Error, 'Cannot boomify non-Error object'); + const { override, data, decorate, statusCode, message } = options; + if (!err.isBoom) { - return new exports.Boom(err, options); + return new exports.Boom(message, { statusCode, cause: err, data, decorate }); } - const { override, data, decorate, statusCode, message } = options; - if (override === false) { // Defaults to true err._apply(data, decorate); } @@ -184,9 +173,9 @@ exports.boomify = function (err, options = {}) { // 4xx Client Errors -exports.badRequest = function (messageOrError, data) { +exports.badRequest = function (message, data) { - return new exports.Boom(messageOrError, { statusCode: 400, data, ctor: exports.badRequest }); + return new exports.Boom(message, { statusCode: 400, data, ctor: exports.badRequest }); }; @@ -251,27 +240,27 @@ exports.unauthorized = function (message, scheme, attributes) { // Or ( }; -exports.paymentRequired = function (messageOrError, data) { +exports.paymentRequired = function (message, data) { - return new exports.Boom(messageOrError, { statusCode: 402, data, ctor: exports.paymentRequired }); + return new exports.Boom(message, { statusCode: 402, data, ctor: exports.paymentRequired }); }; -exports.forbidden = function (messageOrError, data) { +exports.forbidden = function (message, data) { - return new exports.Boom(messageOrError, { statusCode: 403, data, ctor: exports.forbidden }); + return new exports.Boom(message, { statusCode: 403, data, ctor: exports.forbidden }); }; -exports.notFound = function (messageOrError, data) { +exports.notFound = function (message, data) { - return new exports.Boom(messageOrError, { statusCode: 404, data, ctor: exports.notFound }); + return new exports.Boom(message, { statusCode: 404, data, ctor: exports.notFound }); }; -exports.methodNotAllowed = function (messageOrError, data, allow) { +exports.methodNotAllowed = function (message, data, allow) { - const err = new exports.Boom(messageOrError, { statusCode: 405, data, ctor: exports.methodNotAllowed }); + const err = new exports.Boom(message, { statusCode: 405, data, ctor: exports.methodNotAllowed }); if (typeof allow === 'string') { allow = [allow]; @@ -285,122 +274,122 @@ exports.methodNotAllowed = function (messageOrError, data, allow) { }; -exports.notAcceptable = function (messageOrError, data) { +exports.notAcceptable = function (message, data) { - return new exports.Boom(messageOrError, { statusCode: 406, data, ctor: exports.notAcceptable }); + return new exports.Boom(message, { statusCode: 406, data, ctor: exports.notAcceptable }); }; -exports.proxyAuthRequired = function (messageOrError, data) { +exports.proxyAuthRequired = function (message, data) { - return new exports.Boom(messageOrError, { statusCode: 407, data, ctor: exports.proxyAuthRequired }); + return new exports.Boom(message, { statusCode: 407, data, ctor: exports.proxyAuthRequired }); }; -exports.clientTimeout = function (messageOrError, data) { +exports.clientTimeout = function (message, data) { - return new exports.Boom(messageOrError, { statusCode: 408, data, ctor: exports.clientTimeout }); + return new exports.Boom(message, { statusCode: 408, data, ctor: exports.clientTimeout }); }; -exports.conflict = function (messageOrError, data) { +exports.conflict = function (message, data) { - return new exports.Boom(messageOrError, { statusCode: 409, data, ctor: exports.conflict }); + return new exports.Boom(message, { statusCode: 409, data, ctor: exports.conflict }); }; -exports.resourceGone = function (messageOrError, data) { +exports.resourceGone = function (message, data) { - return new exports.Boom(messageOrError, { statusCode: 410, data, ctor: exports.resourceGone }); + return new exports.Boom(message, { statusCode: 410, data, ctor: exports.resourceGone }); }; -exports.lengthRequired = function (messageOrError, data) { +exports.lengthRequired = function (message, data) { - return new exports.Boom(messageOrError, { statusCode: 411, data, ctor: exports.lengthRequired }); + return new exports.Boom(message, { statusCode: 411, data, ctor: exports.lengthRequired }); }; -exports.preconditionFailed = function (messageOrError, data) { +exports.preconditionFailed = function (message, data) { - return new exports.Boom(messageOrError, { statusCode: 412, data, ctor: exports.preconditionFailed }); + return new exports.Boom(message, { statusCode: 412, data, ctor: exports.preconditionFailed }); }; -exports.entityTooLarge = function (messageOrError, data) { +exports.entityTooLarge = function (message, data) { - return new exports.Boom(messageOrError, { statusCode: 413, data, ctor: exports.entityTooLarge }); + return new exports.Boom(message, { statusCode: 413, data, ctor: exports.entityTooLarge }); }; -exports.uriTooLong = function (messageOrError, data) { +exports.uriTooLong = function (message, data) { - return new exports.Boom(messageOrError, { statusCode: 414, data, ctor: exports.uriTooLong }); + return new exports.Boom(message, { statusCode: 414, data, ctor: exports.uriTooLong }); }; -exports.unsupportedMediaType = function (messageOrError, data) { +exports.unsupportedMediaType = function (message, data) { - return new exports.Boom(messageOrError, { statusCode: 415, data, ctor: exports.unsupportedMediaType }); + return new exports.Boom(message, { statusCode: 415, data, ctor: exports.unsupportedMediaType }); }; -exports.rangeNotSatisfiable = function (messageOrError, data) { +exports.rangeNotSatisfiable = function (message, data) { - return new exports.Boom(messageOrError, { statusCode: 416, data, ctor: exports.rangeNotSatisfiable }); + return new exports.Boom(message, { statusCode: 416, data, ctor: exports.rangeNotSatisfiable }); }; -exports.expectationFailed = function (messageOrError, data) { +exports.expectationFailed = function (message, data) { - return new exports.Boom(messageOrError, { statusCode: 417, data, ctor: exports.expectationFailed }); + return new exports.Boom(message, { statusCode: 417, data, ctor: exports.expectationFailed }); }; -exports.teapot = function (messageOrError, data) { +exports.teapot = function (message, data) { - return new exports.Boom(messageOrError, { statusCode: 418, data, ctor: exports.teapot }); + return new exports.Boom(message, { statusCode: 418, data, ctor: exports.teapot }); }; -exports.badData = function (messageOrError, data) { +exports.badData = function (message, data) { - return new exports.Boom(messageOrError, { statusCode: 422, data, ctor: exports.badData }); + return new exports.Boom(message, { statusCode: 422, data, ctor: exports.badData }); }; -exports.locked = function (messageOrError, data) { +exports.locked = function (message, data) { - return new exports.Boom(messageOrError, { statusCode: 423, data, ctor: exports.locked }); + return new exports.Boom(message, { statusCode: 423, data, ctor: exports.locked }); }; -exports.failedDependency = function (messageOrError, data) { +exports.failedDependency = function (message, data) { - return new exports.Boom(messageOrError, { statusCode: 424, data, ctor: exports.failedDependency }); + return new exports.Boom(message, { statusCode: 424, data, ctor: exports.failedDependency }); }; -exports.tooEarly = function (messageOrError, data) { +exports.tooEarly = function (message, data) { - return new exports.Boom(messageOrError, { statusCode: 425, data, ctor: exports.tooEarly }); + return new exports.Boom(message, { statusCode: 425, data, ctor: exports.tooEarly }); }; -exports.preconditionRequired = function (messageOrError, data) { +exports.preconditionRequired = function (message, data) { - return new exports.Boom(messageOrError, { statusCode: 428, data, ctor: exports.preconditionRequired }); + return new exports.Boom(message, { statusCode: 428, data, ctor: exports.preconditionRequired }); }; -exports.tooManyRequests = function (messageOrError, data) { +exports.tooManyRequests = function (message, data) { - return new exports.Boom(messageOrError, { statusCode: 429, data, ctor: exports.tooManyRequests }); + return new exports.Boom(message, { statusCode: 429, data, ctor: exports.tooManyRequests }); }; -exports.illegal = function (messageOrError, data) { +exports.illegal = function (message, data) { - return new exports.Boom(messageOrError, { statusCode: 451, data, ctor: exports.illegal }); + return new exports.Boom(message, { statusCode: 451, data, ctor: exports.illegal }); }; @@ -443,13 +432,13 @@ exports.badImplementation = function (message, data) { return err; }; -internals.serverError = function (messageOrError, data, statusCode, ctor) { +internals.serverError = function (message, data, statusCode, ctor) { if (data instanceof Error && !data.isBoom) { - return new exports.Boom(data, { statusCode, message: messageOrError, ctor }); + return new exports.Boom(message, { statusCode, cause: data, ctor }); } - return new exports.Boom(messageOrError, { statusCode, data, ctor }); + return new exports.Boom(message, { statusCode, data, ctor }); }; diff --git a/test/index.js b/test/index.js index d3cb7e9..917ff08 100755 --- a/test/index.js +++ b/test/index.js @@ -34,7 +34,7 @@ describe('Boom', () => { it('handles missing message', () => { - const err = new Boom.Boom(new Error()); + const err = new Boom.Boom(); expect(Boom.isBoom(err)).to.be.true(); expect(err.message).to.equal('Internal Server Error'); @@ -42,7 +42,7 @@ describe('Boom', () => { it('handles missing message with unknown statusCode', () => { - const err = new Boom.Boom(new Error(), { statusCode: 999 }); + const err = new Boom.Boom(null, { statusCode: 999 }); expect(Boom.isBoom(err)).to.be.true(); expect(err.message).to.equal('Unknown'); @@ -64,21 +64,6 @@ describe('Boom', () => { }).to.throw('statusCode must be a number (400+): x'); }); - it('handles readonly error message property', () => { - - const Err = class extends Error { - - get message() { - - return 'x'; - } - }; - - const err = new Boom.Boom(new Err(), { message: 'override' }); - expect(Boom.isBoom(err)).to.be.true(); - expect(err.message).to.equal('override'); - }); - it('will cast a statusCode number-string to an integer', () => { const codes = [ @@ -283,7 +268,7 @@ describe('Boom', () => { 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'); @@ -300,11 +285,11 @@ 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 = new Boom.Boom(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'); }); }); @@ -956,26 +941,14 @@ describe('Boom', () => { 'badImplementation' ].forEach((name) => { - it(`should allow \`Boom.${name}(err)\` and preserve the error`, () => { + it(`uses stringified error as message`, () => { const error = new Error('An example mongoose validation error'); error.name = 'ValidationError'; const err = Boom[name](error); - expect(err.cause.name).to.equal('ValidationError'); - expect(err.cause.message).to.equal('An example mongoose validation error'); + expect(err.cause).to.not.exist(); + expect(err.message).to.equal(error.toString()); }); - - // exclude unauthorized - - if (name !== 'unauthorized') { - - it(`should allow \`Boom.${name}(err, data)\` and preserve the data`, () => { - - const error = new Error(); - const err = Boom[name](error, { foo: 'bar' }); - expect(err.data).to.equal({ foo: 'bar' }); - }); - } }); }); @@ -1033,7 +1006,7 @@ describe('Boom', () => { it('displays internal server error messages in debug mode', () => { const error = new Error('ka-boom'); - const err = new Boom.Boom(error, { statusCode: 500 }); + const err = new Boom.Boom(null, { statusCode: 500, cause: error }); err.reformat(false); expect(err.output).to.equal({ From 4609d8c22a6cffb2c562085491beb4f34bc30f36 Mon Sep 17 00:00:00 2001 From: Gil Pedersen Date: Mon, 4 Dec 2023 11:45:16 +0100 Subject: [PATCH 03/45] Remove decorate option --- lib/index.js | 18 +++++++----------- test/index.js | 15 --------------- 2 files changed, 7 insertions(+), 26 deletions(-) diff --git a/lib/index.js b/lib/index.js index 56af936..ccd9655 100755 --- a/lib/index.js +++ b/lib/index.js @@ -75,12 +75,12 @@ exports.Boom = class extends Error { constructor(message, options = {}) { - const { statusCode = 500, data, decorate, ctor = exports.Boom } = options; + const { statusCode = 500, data, ctor = exports.Boom } = options; super(message ?? internals.codes.get(statusCode) ?? 'Unknown', options); Error.captureStackTrace(this, ctor); // Filter the stack to our external API - this._apply(data, decorate, statusCode); + this._apply(data, statusCode); Object.defineProperty(this, 'typeof', { value: ctor }); } @@ -112,16 +112,12 @@ exports.Boom = class extends Error { } } - _apply(data, decorate, statusCode, message) { + _apply(data, statusCode, message) { if (data !== undefined) { this.data = data; } - if (decorate) { - Object.assign(this, decorate); - } - if (statusCode) { const numberCode = parseInt(statusCode, 10); Hoek.assert(!isNaN(numberCode) && numberCode >= 400, 'statusCode must be a number (400+):', statusCode); @@ -154,17 +150,17 @@ exports.boomify = function (err, options = {}) { Hoek.assert(err instanceof Error, 'Cannot boomify non-Error object'); - const { override, data, decorate, statusCode, message } = options; + const { override, data, statusCode, message } = options; if (!err.isBoom) { - return new exports.Boom(message, { statusCode, cause: err, data, decorate }); + return new exports.Boom(message, { statusCode, cause: err, data }); } if (override === false) { // Defaults to true - err._apply(data, decorate); + err._apply(data); } else { - err._apply(data, decorate, statusCode ?? err.output.statusCode, message); + err._apply(data, statusCode ?? err.output.statusCode, message); } return err; diff --git a/test/index.js b/test/index.js index 917ff08..ee5490c 100755 --- a/test/index.js +++ b/test/index.js @@ -24,14 +24,6 @@ describe('Boom', () => { expect(JSON.stringify(err)).to.equal('{"isBoom":true,"isServer":false,"data":null,"output":{"statusCode":400,"payload":{"statusCode":400,"error":"Bad Request","message":"oops"},"headers":{}}}'); }); - it('decorates error', () => { - - 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); - }); - it('handles missing message', () => { const err = new Boom.Boom(); @@ -159,13 +151,6 @@ describe('Boom', () => { expect(error).to.shallow.equal(Boom.boomify(error, { statusCode: 444 })); }); - it('decorates error', () => { - - const error = new Error('oops'); - const err = Boom.boomify(error, { statusCode: 400, decorate: { x: 1 } }); - expect(err.x).to.equal(1); - }); - it('returns an error with info when constructed using another error', () => { const error = new Error('ka-boom'); From 0dcd0aaf6e7d6689d0b44ff1ca4fd13e7eb418f5 Mon Sep 17 00:00:00 2001 From: Gil Pedersen Date: Mon, 4 Dec 2023 11:57:04 +0100 Subject: [PATCH 04/45] Allow to boomify non-Error errors --- lib/index.js | 9 ++++----- test/index.js | 9 +++++++++ 2 files changed, 13 insertions(+), 5 deletions(-) diff --git a/lib/index.js b/lib/index.js index ccd9655..0a8fcef 100755 --- a/lib/index.js +++ b/lib/index.js @@ -106,8 +106,9 @@ exports.Boom = class extends Error { } else { this.output.payload.message = this.message; - if (this.cause?.message) { - this.output.payload.message = (this.message === this.output.payload.error) ? this.cause.message : this.message + ': ' + this.cause.message; + if (this.cause) { + const message = this.cause.message ?? this.cause; + this.output.payload.message = (this.message === this.output.payload.error) ? message : this.message + ': ' + message; } } } @@ -148,11 +149,9 @@ exports.isBoom = function (err, statusCode) { exports.boomify = function (err, options = {}) { - Hoek.assert(err instanceof Error, 'Cannot boomify non-Error object'); - const { override, data, statusCode, message } = options; - if (!err.isBoom) { + if (!err?.isBoom) { return new exports.Boom(message, { statusCode, cause: err, data }); } diff --git a/test/index.js b/test/index.js index ee5490c..cafce8f 100755 --- a/test/index.js +++ b/test/index.js @@ -249,6 +249,15 @@ describe('Boom', () => { 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); + }); }); describe('create()', () => { From bd7ddd7088508b1d47a5f35130ab4d237d0dc5b8 Mon Sep 17 00:00:00 2001 From: Gil Pedersen Date: Mon, 4 Dec 2023 14:34:44 +0100 Subject: [PATCH 05/45] Make _apply internal --- lib/index.js | 38 +++++++++++++++++++------------------- 1 file changed, 19 insertions(+), 19 deletions(-) diff --git a/lib/index.js b/lib/index.js index 0a8fcef..d7779a9 100755 --- a/lib/index.js +++ b/lib/index.js @@ -80,7 +80,7 @@ exports.Boom = class extends Error { super(message ?? internals.codes.get(statusCode) ?? 'Unknown', options); Error.captureStackTrace(this, ctor); // Filter the stack to our external API - this._apply(data, statusCode); + this.#apply(data, statusCode); Object.defineProperty(this, 'typeof', { value: ctor }); } @@ -113,7 +113,7 @@ exports.Boom = class extends Error { } } - _apply(data, statusCode, message) { + #apply(data, statusCode, message) { if (data !== undefined) { this.data = data; @@ -138,31 +138,31 @@ exports.Boom = class extends Error { this.reformat(); } } -}; - -exports.isBoom = function (err, statusCode) { + static { + exports.isBoom = function (err, statusCode) { - return err instanceof Error && !!err.isBoom && (!statusCode || err.output.statusCode === statusCode); -}; + return err instanceof Error && !!err.isBoom && (!statusCode || err.output.statusCode === statusCode); + }; + exports.boomify = function (err, options = {}) { -exports.boomify = function (err, options = {}) { + const { override, data, statusCode, message } = options; - const { override, data, statusCode, message } = options; + if (!err?.isBoom) { + return new exports.Boom(message, { statusCode, cause: err, data }); + } - if (!err?.isBoom) { - return new exports.Boom(message, { statusCode, cause: err, data }); - } + if (override === false) { // Defaults to true + err.#apply(data); + } + else { + err.#apply(data, statusCode ?? err.output.statusCode, message); + } - if (override === false) { // Defaults to true - err._apply(data); - } - else { - err._apply(data, statusCode ?? err.output.statusCode, message); + return err; + }; } - - return err; }; From d685e22f9e37dd6cd8852320456e61052ee8f8c4 Mon Sep 17 00:00:00 2001 From: Gil Pedersen Date: Mon, 4 Dec 2023 14:51:39 +0100 Subject: [PATCH 06/45] Make isBoom a prototype property --- lib/index.js | 8 +++++--- test/index.js | 5 +++-- 2 files changed, 8 insertions(+), 5 deletions(-) diff --git a/lib/index.js b/lib/index.js index d7779a9..f85d999 100755 --- a/lib/index.js +++ b/lib/index.js @@ -66,9 +66,8 @@ const internals = { }; -exports.Boom = class extends Error { +exports.Boom = class Boom extends Error { - isBoom = true; isServer; data = null; output; @@ -140,6 +139,9 @@ exports.Boom = class extends Error { } static { + Object.defineProperty(this.prototype, 'name', { value: 'Boom', writable: true, configurable: true }); + Object.defineProperty(this.prototype, 'isBoom', { value: true, configurable: true }); + exports.isBoom = function (err, statusCode) { return err instanceof Error && !!err.isBoom && (!statusCode || err.output.statusCode === statusCode); @@ -430,7 +432,7 @@ exports.badImplementation = function (message, data) { internals.serverError = function (message, data, statusCode, ctor) { if (data instanceof Error && - !data.isBoom) { + !exports.isBoom(data)) { return new exports.Boom(message, { statusCode, cause: data, ctor }); } diff --git a/test/index.js b/test/index.js index cafce8f..b85bdd5 100755 --- a/test/index.js +++ b/test/index.js @@ -20,8 +20,9 @@ describe('Boom', () => { expect(err.output.payload.message).to.equal('oops'); expect(err.output.statusCode).to.equal(400); - expect(Object.keys(err)).to.equal(['isBoom', 'isServer', 'data', 'output']); - expect(JSON.stringify(err)).to.equal('{"isBoom":true,"isServer":false,"data":null,"output":{"statusCode":400,"payload":{"statusCode":400,"error":"Bad Request","message":"oops"},"headers":{}}}'); + expect(err.name).to.equal('Boom'); + expect(Object.keys(err)).to.equal(['isServer', 'data', 'output']); + expect(JSON.stringify(err)).to.equal('{"isServer":false,"data":null,"output":{"statusCode":400,"payload":{"statusCode":400,"error":"Bad Request","message":"oops"},"headers":{}}}'); }); it('handles missing message', () => { From de34590f95ebe381602da085edf9733822c53eb9 Mon Sep 17 00:00:00 2001 From: Gil Pedersen Date: Mon, 4 Dec 2023 14:53:17 +0100 Subject: [PATCH 07/45] Make isServer property computed --- lib/index.js | 8 +++++--- test/index.js | 4 ++-- 2 files changed, 7 insertions(+), 5 deletions(-) diff --git a/lib/index.js b/lib/index.js index f85d999..4f7ef44 100755 --- a/lib/index.js +++ b/lib/index.js @@ -68,10 +68,14 @@ const internals = { exports.Boom = class Boom extends Error { - isServer; data = null; output; + get isServer() { + + return this.output.statusCode >= 500; + } + constructor(message, options = {}) { const { statusCode = 500, data, ctor = exports.Boom } = options; @@ -122,8 +126,6 @@ exports.Boom = class Boom extends Error { const numberCode = parseInt(statusCode, 10); Hoek.assert(!isNaN(numberCode) && numberCode >= 400, 'statusCode must be a number (400+):', statusCode); - this.isServer = numberCode >= 500; - this.output = { statusCode: numberCode, payload: {}, diff --git a/test/index.js b/test/index.js index b85bdd5..82cd978 100755 --- a/test/index.js +++ b/test/index.js @@ -21,8 +21,8 @@ describe('Boom', () => { expect(err.output.statusCode).to.equal(400); expect(err.name).to.equal('Boom'); - expect(Object.keys(err)).to.equal(['isServer', 'data', 'output']); - expect(JSON.stringify(err)).to.equal('{"isServer":false,"data":null,"output":{"statusCode":400,"payload":{"statusCode":400,"error":"Bad Request","message":"oops"},"headers":{}}}'); + 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('handles missing message', () => { From d5fdc6fb6831f13bb11411e18e49c132a8100408 Mon Sep 17 00:00:00 2001 From: Gil Pedersen Date: Tue, 5 Dec 2023 08:03:35 +0100 Subject: [PATCH 08/45] Refactor output and payload to classes --- lib/index.js | 62 +++++++++++++++++++++++++++++++++++----------------- 1 file changed, 42 insertions(+), 20 deletions(-) diff --git a/lib/index.js b/lib/index.js index 4f7ef44..0cc1a54 100755 --- a/lib/index.js +++ b/lib/index.js @@ -101,19 +101,7 @@ exports.Boom = class Boom extends Error { reformat(debug = false) { - 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 { - this.output.payload.message = this.message; - if (this.cause) { - const message = this.cause.message ?? this.cause; - this.output.payload.message = (this.message === this.output.payload.error) ? message : this.message + ': ' + message; - } - } + this.output.payload = new internals.PayloadObject(this, this.output.statusCode, debug); } #apply(data, statusCode, message) { @@ -126,17 +114,12 @@ exports.Boom = class Boom extends Error { const numberCode = parseInt(statusCode, 10); Hoek.assert(!isNaN(numberCode) && numberCode >= 400, 'statusCode must be a number (400+):', statusCode); - this.output = { - statusCode: numberCode, - payload: {}, - headers: {} - }; - if (message) { this.message = `${message}: ${this.message}`; } - this.reformat(); + const payload = new internals.PayloadObject(this, numberCode, false); + this.output = new internals.BoomOutput(numberCode, payload); } } @@ -170,6 +153,45 @@ exports.Boom = class Boom extends Error { }; +internals.PayloadObject = class { + + statusCode; + error; + message; + + constructor(error, statusCode, debug) { + + this.statusCode = statusCode; + this.error = internals.codes.get(statusCode) ?? 'Unknown'; + + 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; + } + } + } +}; + + +internals.BoomOutput = class { + + statusCode; + payload; + headers = {}; + + constructor(statusCode, payload) { + + this.statusCode = statusCode; + this.payload = payload; + } +}; + + // 4xx Client Errors exports.badRequest = function (message, data) { From c8c2d850099f2289775d7a935e21a6392adc7ad1 Mon Sep 17 00:00:00 2001 From: Gil Pedersen Date: Tue, 5 Dec 2023 08:42:46 +0100 Subject: [PATCH 09/45] Remove unauthorized payload.attributes --- API.md | 19 +++++-------------- lib/index.js | 9 --------- test/index.js | 2 -- 3 files changed, 5 insertions(+), 25 deletions(-) diff --git a/API.md b/API.md index 9bff592..800309a 100755 --- a/API.md +++ b/API.md @@ -102,7 +102,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. @@ -135,10 +136,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\"" @@ -154,8 +152,7 @@ Generates the following response: ```json "payload": { "statusCode": 401, - "error": "Unauthorized", - "attributes": "VGhpcyBpcyBhIHRlc3QgdG9rZW4=" + "error": "Unauthorized" }, "headers": { "WWW-Authenticate": "Negotiate VGhpcyBpcyBhIHRlc3QgdG9rZW4=" @@ -172,13 +169,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\"" diff --git a/lib/index.js b/lib/index.js index 0cc1a54..ceba6a7 100755 --- a/lib/index.js +++ b/lib/index.js @@ -221,23 +221,15 @@ exports.unauthorized = function (message, scheme, attributes) { // Or ( let wwwAuthenticate = `${scheme}`; - if (attributes || - message) { - - err.output.payload.attributes = {}; - } - if (attributes) { if (typeof attributes === 'string') { wwwAuthenticate += ' ' + Hoek.escapeHeaderAttribute(attributes); - err.output.payload.attributes = attributes; } else { wwwAuthenticate += ' ' + Object.keys(attributes).map((name) => { const value = attributes[name] ?? ''; - err.output.payload.attributes[name] = value; return `${name}="${Hoek.escapeHeaderAttribute(value.toString())}"`; }) .join(', '); @@ -250,7 +242,6 @@ exports.unauthorized = function (message, scheme, attributes) { // Or ( } wwwAuthenticate += ` error="${Hoek.escapeHeaderAttribute(message)}"`; - err.output.payload.attributes.error = message; } else { err.isMissing = true; diff --git a/test/index.js b/test/index.js index 82cd978..b1c30db 100755 --- a/test/index.js +++ b/test/index.js @@ -357,7 +357,6 @@ 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 from string input instead of object', () => { @@ -365,7 +364,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', () => { From c2f4a3fab5cf357a7d6775c44db005653e32cc45 Mon Sep 17 00:00:00 2001 From: Gil Pedersen Date: Tue, 5 Dec 2023 09:22:56 +0100 Subject: [PATCH 10/45] Fix WWW-Authenticate header when empty attributes --- lib/index.js | 14 +++++++------- test/index.js | 7 +++++++ 2 files changed, 14 insertions(+), 7 deletions(-) diff --git a/lib/index.js b/lib/index.js index ceba6a7..4ffc5f4 100755 --- a/lib/index.js +++ b/lib/index.js @@ -219,14 +219,14 @@ exports.unauthorized = function (message, scheme, attributes) { // Or ( // function (message, scheme, attributes) - let wwwAuthenticate = `${scheme}`; + let stringified = ''; if (attributes) { if (typeof attributes === 'string') { - wwwAuthenticate += ' ' + Hoek.escapeHeaderAttribute(attributes); + stringified += Hoek.escapeHeaderAttribute(attributes); } else { - wwwAuthenticate += ' ' + Object.keys(attributes).map((name) => { + stringified += Object.keys(attributes).map((name) => { const value = attributes[name] ?? ''; @@ -237,17 +237,17 @@ exports.unauthorized = function (message, scheme, attributes) { // Or ( } if (message) { - if (attributes) { - wwwAuthenticate += ','; + if (stringified) { + stringified += ', '; } - wwwAuthenticate += ` error="${Hoek.escapeHeaderAttribute(message)}"`; + stringified += `error="${Hoek.escapeHeaderAttribute(message)}"`; } else { err.isMissing = true; } - err.output.headers['WWW-Authenticate'] = wwwAuthenticate; + err.output.headers['WWW-Authenticate'] = stringified ? `${scheme} ${stringified}` : `${scheme}`; return err; }; diff --git a/test/index.js b/test/index.js index b1c30db..a8b5a18 100755 --- a/test/index.js +++ b/test/index.js @@ -359,6 +359,13 @@ describe('Boom', () => { expect(err.output.headers['WWW-Authenticate']).to.equal('Test 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', () => { const err = Boom.unauthorized(null, 'Negotiate', 'VGhpcyBpcyBhIHRlc3QgdG9rZW4='); From 447ee21f6acde50da448bdb48e6b02f75e6511a5 Mon Sep 17 00:00:00 2001 From: Gil Pedersen Date: Tue, 5 Dec 2023 10:24:30 +0100 Subject: [PATCH 11/45] Refactor implementation to use helpers --- lib/index.js | 154 +++++++++++++++----------------------------------- test/index.js | 4 +- 2 files changed, 46 insertions(+), 112 deletions(-) diff --git a/lib/index.js b/lib/index.js index 4ffc5f4..8278a02 100755 --- a/lib/index.js +++ b/lib/index.js @@ -192,14 +192,27 @@ internals.BoomOutput = class { }; -// 4xx Client Errors +internals.statusError = function (statusCode, isServer) { + + const method = isServer ? + function (message, data) { -exports.badRequest = function (message, data) { + return internals.serverError(message, data, statusCode, method); + } : + function (message, data) { + + return new exports.Boom(message, { statusCode, data, ctor: method }); + }; - return new exports.Boom(message, { statusCode: 400, data, ctor: exports.badRequest }); + return method; }; +// 4xx Client Errors + +exports.badRequest = internals.statusError(400); + + exports.unauthorized = function (message, scheme, attributes) { // Or (message, wwwAuthenticate[]) const err = new exports.Boom(message, { statusCode: 401, ctor: exports.unauthorized }); @@ -252,22 +265,13 @@ exports.unauthorized = function (message, scheme, attributes) { // Or ( }; -exports.paymentRequired = function (message, data) { +exports.paymentRequired = internals.statusError(402); - return new exports.Boom(message, { statusCode: 402, data, ctor: exports.paymentRequired }); -}; - - -exports.forbidden = function (message, data) { - - return new exports.Boom(message, { statusCode: 403, data, ctor: exports.forbidden }); -}; +exports.forbidden = internals.statusError(403); -exports.notFound = function (message, data) { - return new exports.Boom(message, { statusCode: 404, data, ctor: exports.notFound }); -}; +exports.notFound = internals.statusError(404); exports.methodNotAllowed = function (message, data, allow) { @@ -286,123 +290,64 @@ exports.methodNotAllowed = function (message, data, allow) { }; -exports.notAcceptable = function (message, data) { - - return new exports.Boom(message, { statusCode: 406, data, ctor: exports.notAcceptable }); -}; - - -exports.proxyAuthRequired = function (message, data) { - - return new exports.Boom(message, { statusCode: 407, data, ctor: exports.proxyAuthRequired }); -}; - - -exports.clientTimeout = function (message, data) { - - return new exports.Boom(message, { statusCode: 408, data, ctor: exports.clientTimeout }); -}; - - -exports.conflict = function (message, data) { - - return new exports.Boom(message, { statusCode: 409, data, ctor: exports.conflict }); -}; - - -exports.resourceGone = function (message, data) { - - return new exports.Boom(message, { statusCode: 410, data, ctor: exports.resourceGone }); -}; - - -exports.lengthRequired = function (message, data) { +exports.notAcceptable = internals.statusError(406); - return new exports.Boom(message, { statusCode: 411, data, ctor: exports.lengthRequired }); -}; +exports.proxyAuthRequired = internals.statusError(407); -exports.preconditionFailed = function (message, data) { - return new exports.Boom(message, { statusCode: 412, data, ctor: exports.preconditionFailed }); -}; +exports.clientTimeout = internals.statusError(408); -exports.entityTooLarge = function (message, data) { +exports.conflict = internals.statusError(409); - return new exports.Boom(message, { statusCode: 413, data, ctor: exports.entityTooLarge }); -}; +exports.resourceGone = internals.statusError(410); -exports.uriTooLong = function (message, data) { - return new exports.Boom(message, { statusCode: 414, data, ctor: exports.uriTooLong }); -}; +exports.lengthRequired = internals.statusError(411); -exports.unsupportedMediaType = function (message, data) { +exports.preconditionFailed = internals.statusError(412); - return new exports.Boom(message, { statusCode: 415, data, ctor: exports.unsupportedMediaType }); -}; +exports.entityTooLarge = internals.statusError(413); -exports.rangeNotSatisfiable = function (message, data) { - return new exports.Boom(message, { statusCode: 416, data, ctor: exports.rangeNotSatisfiable }); -}; +exports.uriTooLong = internals.statusError(414); -exports.expectationFailed = function (message, data) { +exports.unsupportedMediaType = internals.statusError(415); - return new exports.Boom(message, { statusCode: 417, data, ctor: exports.expectationFailed }); -}; +exports.rangeNotSatisfiable = internals.statusError(416); -exports.teapot = function (message, data) { - return new exports.Boom(message, { statusCode: 418, data, ctor: exports.teapot }); -}; +exports.expectationFailed = internals.statusError(417); -exports.badData = function (message, data) { +exports.teapot = internals.statusError(418); - return new exports.Boom(message, { statusCode: 422, data, ctor: exports.badData }); -}; +exports.badData = internals.statusError(422); -exports.locked = function (message, data) { - return new exports.Boom(message, { statusCode: 423, data, ctor: exports.locked }); -}; +exports.locked = internals.statusError(423); -exports.failedDependency = function (message, data) { +exports.failedDependency = internals.statusError(424); - return new exports.Boom(message, { statusCode: 424, data, ctor: exports.failedDependency }); -}; -exports.tooEarly = function (message, data) { +exports.tooEarly = internals.statusError(425); - return new exports.Boom(message, { statusCode: 425, data, ctor: exports.tooEarly }); -}; +exports.preconditionRequired = internals.statusError(428); -exports.preconditionRequired = function (message, data) { - return new exports.Boom(message, { statusCode: 428, data, ctor: exports.preconditionRequired }); -}; +exports.tooManyRequests = internals.statusError(429); -exports.tooManyRequests = function (message, data) { - - return new exports.Boom(message, { statusCode: 429, data, ctor: exports.tooManyRequests }); -}; - - -exports.illegal = function (message, data) { - - return new exports.Boom(message, { statusCode: 451, data, ctor: exports.illegal }); -}; +exports.illegal = internals.statusError(451); // 5xx Server Errors @@ -413,28 +358,16 @@ exports.internal = function (message, data, statusCode = 500) { }; -exports.notImplemented = function (message, data) { +exports.notImplemented = internals.statusError(501, true); - return internals.serverError(message, data, 501, exports.notImplemented); -}; +exports.badGateway = internals.statusError(502, true); -exports.badGateway = function (message, data) { - return internals.serverError(message, data, 502, exports.badGateway); -}; +exports.serverUnavailable = internals.statusError(503, true); -exports.serverUnavailable = function (message, data) { - - return internals.serverError(message, data, 503, exports.serverUnavailable); -}; - - -exports.gatewayTimeout = function (message, data) { - - return internals.serverError(message, data, 504, exports.gatewayTimeout); -}; +exports.gatewayTimeout = internals.statusError(504, true); exports.badImplementation = function (message, data) { @@ -444,6 +377,7 @@ exports.badImplementation = function (message, data) { return err; }; + internals.serverError = function (message, data, statusCode, ctor) { if (data instanceof Error && diff --git a/test/index.js b/test/index.js index a8b5a18..fd2de4a 100755 --- a/test/index.js +++ b/test/index.js @@ -991,10 +991,10 @@ describe('Boom', () => { types.forEach((type) => { if (type === name) { - expect(error.typeof).to.equal(Boom[name]); + expect(error.typeof).to.shallow.equal(Boom[name]); } else { - expect(error.typeof).to.not.equal(Boom[type]); + expect(error.typeof).to.not.shallow.equal(Boom[type]); } }); }); From 28fc99a31b0ae8ac8cbe0bfee74f74592459ab67 Mon Sep 17 00:00:00 2001 From: Gil Pedersen Date: Tue, 5 Dec 2023 11:14:30 +0100 Subject: [PATCH 12/45] Add and use a Boom "headers" option --- lib/index.js | 40 +++++++++++++++++++--------------------- test/index.js | 8 ++++++++ 2 files changed, 27 insertions(+), 21 deletions(-) diff --git a/lib/index.js b/lib/index.js index 8278a02..4790e77 100755 --- a/lib/index.js +++ b/lib/index.js @@ -78,12 +78,12 @@ exports.Boom = class Boom extends Error { constructor(message, options = {}) { - const { statusCode = 500, data, ctor = exports.Boom } = options; + const { statusCode = 500, data, headers, ctor = exports.Boom } = options; super(message ?? internals.codes.get(statusCode) ?? 'Unknown', options); Error.captureStackTrace(this, ctor); // Filter the stack to our external API - this.#apply(data, statusCode); + this.#apply(data, statusCode, headers); Object.defineProperty(this, 'typeof', { value: ctor }); } @@ -104,7 +104,7 @@ exports.Boom = class Boom extends Error { this.output.payload = new internals.PayloadObject(this, this.output.statusCode, debug); } - #apply(data, statusCode, message) { + #apply(data, statusCode, headers, message) { if (data !== undefined) { this.data = data; @@ -119,7 +119,7 @@ exports.Boom = class Boom extends Error { } const payload = new internals.PayloadObject(this, numberCode, false); - this.output = new internals.BoomOutput(numberCode, payload); + this.output = new internals.BoomOutput(numberCode, payload, headers); } } @@ -144,7 +144,7 @@ exports.Boom = class Boom extends Error { err.#apply(data); } else { - err.#apply(data, statusCode ?? err.output.statusCode, message); + err.#apply(data, statusCode ?? err.output.statusCode, {}, message); } return err; @@ -182,12 +182,13 @@ internals.BoomOutput = class { statusCode; payload; - headers = {}; + headers; - constructor(statusCode, payload) { + constructor(statusCode, payload, headers) { this.statusCode = statusCode; this.payload = payload; + this.headers = headers ?? {}; } }; @@ -215,23 +216,22 @@ exports.badRequest = internals.statusError(400); exports.unauthorized = function (message, scheme, attributes) { // Or (message, wwwAuthenticate[]) - const err = new exports.Boom(message, { statusCode: 401, ctor: exports.unauthorized }); - // function (message) if (!scheme) { - return err; + return new exports.Boom(message, { statusCode: 401, ctor: exports.unauthorized }); } // function (message, wwwAuthenticate[]) if (typeof scheme !== 'string') { - err.output.headers['WWW-Authenticate'] = scheme.join(', '); - return err; + const headers = { 'WWW-Authenticate': scheme.join(', ') }; + return new exports.Boom(message, { statusCode: 401, headers, ctor: exports.unauthorized }); } // function (message, scheme, attributes) + const decorate = {}; let stringified = ''; if (attributes) { @@ -257,11 +257,11 @@ exports.unauthorized = function (message, scheme, attributes) { // Or ( stringified += `error="${Hoek.escapeHeaderAttribute(message)}"`; } else { - err.isMissing = true; + decorate.isMissing = true; } - err.output.headers['WWW-Authenticate'] = stringified ? `${scheme} ${stringified}` : `${scheme}`; - return err; + const headers = { 'WWW-Authenticate': stringified ? `${scheme} ${stringified}` : `${scheme}` }; + return Object.assign(new exports.Boom(message, { statusCode: 401, headers, ctor: exports.unauthorized }), decorate); }; @@ -276,17 +276,15 @@ exports.notFound = internals.statusError(404); exports.methodNotAllowed = function (message, data, allow) { - const err = new exports.Boom(message, { statusCode: 405, data, ctor: exports.methodNotAllowed }); - if (typeof allow === 'string') { allow = [allow]; } - if (Array.isArray(allow)) { - err.output.headers.Allow = allow.join(', '); - } + const headers = Array.isArray(allow) ? { + Allow: allow.join(', ') + } : null; - return err; + return new exports.Boom(message, { statusCode: 405, data, headers, ctor: exports.methodNotAllowed }); }; diff --git a/test/index.js b/test/index.js index fd2de4a..dba0027 100755 --- a/test/index.js +++ b/test/index.js @@ -49,6 +49,14 @@ describe('Boom', () => { expect(Boom.isBoom(err)).to.be.true(); }); + it('handles headers option', () => { + + 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' }); + }); + it('throws when statusCode is not a number', () => { expect(() => { From 204d54241fb1228a5b8501b0c71fbb0fcdad4336 Mon Sep 17 00:00:00 2001 From: Gil Pedersen Date: Tue, 5 Dec 2023 12:22:51 +0100 Subject: [PATCH 13/45] Use statusError for all helpers --- lib/index.js | 62 ++++++++++++++++++++++++++------------------------- test/index.js | 7 ++++++ 2 files changed, 39 insertions(+), 30 deletions(-) diff --git a/lib/index.js b/lib/index.js index 4790e77..8c67ea5 100755 --- a/lib/index.js +++ b/lib/index.js @@ -193,12 +193,13 @@ internals.BoomOutput = class { }; -internals.statusError = function (statusCode, isServer) { +internals.statusError = function (statusCode, massage) { - const method = isServer ? - function (message, data) { + const method = massage ? + function (...args) { - return internals.serverError(message, data, statusCode, method); + const [message, options, decorate] = massage(...args); + return Object.assign(new exports.Boom(message, { statusCode, ctor: method, ...options }), decorate); } : function (message, data) { @@ -214,19 +215,19 @@ internals.statusError = function (statusCode, isServer) { exports.badRequest = internals.statusError(400); -exports.unauthorized = function (message, scheme, attributes) { // Or (message, wwwAuthenticate[]) +exports.unauthorized = internals.statusError(401, (message, scheme, attributes) => { // Or (message, wwwAuthenticate[]) // function (message) if (!scheme) { - return new exports.Boom(message, { statusCode: 401, ctor: exports.unauthorized }); + return [message]; } // function (message, wwwAuthenticate[]) if (typeof scheme !== 'string') { const headers = { 'WWW-Authenticate': scheme.join(', ') }; - return new exports.Boom(message, { statusCode: 401, headers, ctor: exports.unauthorized }); + return [message, { headers }]; } // function (message, scheme, attributes) @@ -261,8 +262,8 @@ exports.unauthorized = function (message, scheme, attributes) { // Or ( } const headers = { 'WWW-Authenticate': stringified ? `${scheme} ${stringified}` : `${scheme}` }; - return Object.assign(new exports.Boom(message, { statusCode: 401, headers, ctor: exports.unauthorized }), decorate); -}; + return [message, { headers }, decorate]; +}); exports.paymentRequired = internals.statusError(402); @@ -274,7 +275,7 @@ exports.forbidden = internals.statusError(403); exports.notFound = internals.statusError(404); -exports.methodNotAllowed = function (message, data, allow) { +exports.methodNotAllowed = internals.statusError(405, (message, data, allow) => { if (typeof allow === 'string') { allow = [allow]; @@ -284,8 +285,8 @@ exports.methodNotAllowed = function (message, data, allow) { Allow: allow.join(', ') } : null; - return new exports.Boom(message, { statusCode: 405, data, headers, ctor: exports.methodNotAllowed }); -}; + return [message, { data, headers }]; +}); exports.notAcceptable = internals.statusError(406); @@ -350,39 +351,40 @@ exports.illegal = internals.statusError(451); // 5xx Server Errors -exports.internal = function (message, data, statusCode = 500) { +exports.internal = internals.statusError(500, (message, data, statusCode = 500) => { - return internals.serverError(message, data, statusCode, exports.internal); -}; + const res = internals.serverError(message, data); + if (statusCode !== 500) { + res[1].statusCode = statusCode; + } + return res; +}); -exports.notImplemented = internals.statusError(501, true); +exports.notImplemented = internals.statusError(501, internals.serverError); -exports.badGateway = internals.statusError(502, true); +exports.badGateway = internals.statusError(502, internals.serverError); -exports.serverUnavailable = internals.statusError(503, true); +exports.serverUnavailable = internals.statusError(503, internals.serverError); -exports.gatewayTimeout = internals.statusError(504, true); +exports.gatewayTimeout = internals.statusError(504, internals.serverError); -exports.badImplementation = function (message, data) { - const err = internals.serverError(message, data, 500, exports.badImplementation); - err.isDeveloperError = true; - return err; -}; +exports.badImplementation = internals.statusError(500, (message, data) => { + const res = internals.serverError(message, data); + res.push({ isDeveloperError: true }); + return res; +}); -internals.serverError = function (message, data, statusCode, ctor) { - if (data instanceof Error && - !exports.isBoom(data)) { +internals.serverError = function (message, data) { - return new exports.Boom(message, { statusCode, cause: data, ctor }); - } + const isDataNonBoomError = data instanceof Error && !exports.isBoom(data); - return new exports.Boom(message, { statusCode, data, ctor }); + return [message, isDataNonBoomError ? { cause: data } : { data }]; }; diff --git a/test/index.js b/test/index.js index dba0027..a3c5669 100755 --- a/test/index.js +++ b/test/index.js @@ -779,6 +779,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'); From 51862fa814a4df79da52f35ec4260bc987b3c7cc Mon Sep 17 00:00:00 2001 From: Gil Pedersen Date: Tue, 5 Dec 2023 12:30:33 +0100 Subject: [PATCH 14/45] Throw TypeError instead of Hoek assertion --- lib/index.js | 4 +++- test/index.js | 11 ++++++++--- 2 files changed, 11 insertions(+), 4 deletions(-) diff --git a/lib/index.js b/lib/index.js index 8c67ea5..00d4454 100755 --- a/lib/index.js +++ b/lib/index.js @@ -112,7 +112,9 @@ exports.Boom = class Boom extends Error { if (statusCode) { const numberCode = parseInt(statusCode, 10); - Hoek.assert(!isNaN(numberCode) && numberCode >= 400, 'statusCode must be a number (400+):', statusCode); + if (isNaN(numberCode) || numberCode < 400) { + throw new TypeError(`statusCode must be a number (400+): ${statusCode}`); + } if (message) { this.message = `${message}: ${this.message}`; diff --git a/test/index.js b/test/index.js index a3c5669..3d68284 100755 --- a/test/index.js +++ b/test/index.js @@ -57,12 +57,17 @@ describe('Boom', () => { expect(err.output.headers).to.equal({ custom: 'yes' }); }); - it('throws when statusCode is not a number', () => { + it('throws when statusCode is invalid', () => { expect(() => { new Boom.Boom('message', { statusCode: 'x' }); }).to.throw('statusCode must be a number (400+): x'); + + expect(() => { + + new Boom.Boom('message', { statusCode: '200' }); + }).to.throw('statusCode must be a number (400+): 200'); }); it('will cast a statusCode number-string to an integer', () => { @@ -81,12 +86,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('statusCode must be a number (400+): null'); + }).to.throw(TypeError, 'statusCode must be a number (400+): Infinity'); }); it('sets error code to unknown', () => { From 3f100162505d968ac5e1345a2b12a805e32b79d8 Mon Sep 17 00:00:00 2001 From: Gil Pedersen Date: Tue, 5 Dec 2023 12:32:48 +0100 Subject: [PATCH 15/45] Remove typeof property --- lib/index.js | 2 -- test/index.js | 49 ------------------------------------------------- 2 files changed, 51 deletions(-) diff --git a/lib/index.js b/lib/index.js index 00d4454..15897b2 100755 --- a/lib/index.js +++ b/lib/index.js @@ -84,8 +84,6 @@ exports.Boom = class Boom extends Error { Error.captureStackTrace(this, ctor); // Filter the stack to our external API this.#apply(data, statusCode, headers); - - Object.defineProperty(this, 'typeof', { value: ctor }); } static [Symbol.hasInstance](instance) { diff --git a/test/index.js b/test/index.js index 3d68284..34152a5 100755 --- a/test/index.js +++ b/test/index.js @@ -972,55 +972,6 @@ describe('Boom', () => { }); }); - 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}`, () => { - - const error = Boom[name](); - types.forEach((type) => { - - if (type === name) { - expect(error.typeof).to.shallow.equal(Boom[name]); - } - else { - expect(error.typeof).to.not.shallow.equal(Boom[type]); - } - }); - }); - }); - }); - describe('reformat()', () => { it('displays internal server error messages in debug mode', () => { From f4f016124400bed92cf14a70aa8ece69283b42bd Mon Sep 17 00:00:00 2001 From: Gil Pedersen Date: Wed, 6 Dec 2023 20:31:13 +0100 Subject: [PATCH 16/45] Fix legacy boom object support --- lib/index.js | 77 ++++++++++++++++++++++++++++----------------------- package.json | 5 ++-- test/index.js | 36 +++++++++++++++++++++++- 3 files changed, 80 insertions(+), 38 deletions(-) diff --git a/lib/index.js b/lib/index.js index 15897b2..5feef73 100755 --- a/lib/index.js +++ b/lib/index.js @@ -76,6 +76,8 @@ exports.Boom = class Boom extends Error { return this.output.statusCode >= 500; } + set isServer(value) {} // Allow for compatiblity with legacy boom + constructor(message, options = {}) { const { statusCode = 500, data, headers, ctor = exports.Boom } = options; @@ -83,7 +85,7 @@ exports.Boom = class Boom extends Error { super(message ?? internals.codes.get(statusCode) ?? 'Unknown', options); Error.captureStackTrace(this, ctor); // Filter the stack to our external API - this.#apply(data, statusCode, headers); + internals.apply(this, data, statusCode, headers); } static [Symbol.hasInstance](instance) { @@ -102,53 +104,58 @@ exports.Boom = class Boom extends Error { this.output.payload = new internals.PayloadObject(this, this.output.statusCode, debug); } - #apply(data, statusCode, headers, message) { + static { + Object.defineProperty(this.prototype, 'name', { value: 'Boom', writable: true, configurable: true }); + Object.defineProperty(this.prototype, 'isBoom', { value: true, writable: true, configurable: true }); + } +}; - if (data !== undefined) { - this.data = data; - } - if (statusCode) { - const numberCode = parseInt(statusCode, 10); - if (isNaN(numberCode) || numberCode < 400) { - throw new TypeError(`statusCode must be a number (400+): ${statusCode}`); - } +exports.isBoom = function (err, statusCode) { - if (message) { - this.message = `${message}: ${this.message}`; - } + return err instanceof Error && !!err.isBoom && (!statusCode || err.output.statusCode === statusCode); +}; - const payload = new internals.PayloadObject(this, numberCode, false); - this.output = new internals.BoomOutput(numberCode, payload, headers); - } + +exports.boomify = function (err, options = {}) { + + const { override, data, statusCode, message } = options; + + if (!err?.isBoom) { + return new exports.Boom(message, { statusCode, cause: err, data }); } - static { - Object.defineProperty(this.prototype, 'name', { value: 'Boom', writable: true, configurable: true }); - Object.defineProperty(this.prototype, 'isBoom', { value: true, configurable: true }); + if (override === false) { // Defaults to true + internals.apply(err, data); + } + else { + internals.apply(err, data, statusCode ?? err.output.statusCode, {}, message); + } - exports.isBoom = function (err, statusCode) { + err.isServer = err.output.statusCode >= 500; // Assign, in case it is a legacy boom object - return err instanceof Error && !!err.isBoom && (!statusCode || err.output.statusCode === statusCode); - }; + return err; +}; - exports.boomify = function (err, options = {}) { - const { override, data, statusCode, message } = options; +internals.apply = function (boom, data, statusCode, headers, message) { - if (!err?.isBoom) { - return new exports.Boom(message, { statusCode, cause: err, data }); - } + if (data !== undefined) { + boom.data = data; + } - if (override === false) { // Defaults to true - err.#apply(data); - } - else { - err.#apply(data, statusCode ?? err.output.statusCode, {}, message); - } + if (statusCode) { + const numberCode = parseInt(statusCode, 10); + if (isNaN(numberCode) || numberCode < 400) { + throw new TypeError(`statusCode must be a number (400+): ${statusCode}`); + } - return err; - }; + if (message) { + boom.message = `${message}: ${boom.message}`; + } + + const payload = new internals.PayloadObject(boom, numberCode, false); + boom.output = new internals.BoomOutput(numberCode, payload, headers); } }; diff --git a/package.json b/package.json index b1d938f..29277e0 100644 --- a/package.json +++ b/package.json @@ -25,10 +25,11 @@ "@hapi/eslint-plugin": "^7.0.0", "@hapi/lab": "^26.0.0", "@types/node": "^17.0.31", - "typescript": "~4.6.4" + "typescript": "~4.6.4", + "@hapi/boom10": "npm:@hapi/boom@^10.0.1" }, "scripts": { - "test": "lab -a @hapi/code -t 100 -L -Y", + "test": "lab -a @hapi/code -t 100 -L", "test-cov-html": "lab -a @hapi/code -t 100 -L -r html -o coverage.html" }, "license": "BSD-3-Clause" diff --git a/test/index.js b/test/index.js index 34152a5..ee4bc60 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'); @@ -107,6 +108,7 @@ describe('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); @@ -128,6 +130,12 @@ describe('Boom', () => { expect(new Boom.Boom('oops')).to.not.be.instanceOf(BadaBoom); expect(Boom.badRequest('oops')).to.not.be.instanceOf(BadaBoom); }); + + it('works from legacy boom', () => { + + expect(new Boom.Boom('oops')).to.be.instanceOf(Boom10.Boom); + expect(new Boom10.Boom('oops')).to.be.instanceOf(Boom10.Boom); + }); }); describe('isBoom()', () => { @@ -137,6 +145,7 @@ describe('Boom', () => { // Success expect(Boom.isBoom(new Boom.Boom('oops'))).to.be.true(); + expect(Boom.isBoom(new Boom10.Boom('oops'))).to.be.true(); // Fail @@ -148,11 +157,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(); }); }); @@ -272,6 +289,23 @@ describe('Boom', () => { expect(boom.output.payload.message).to.equal('Hello: 123'); expect(boom.output.statusCode).to.equal(400); }); + + 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.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.output.statusCode).to.equal(501); + }); }); describe('create()', () => { From ccc53dcc929b8a42ad4b994c70165a908c6e9890 Mon Sep 17 00:00:00 2001 From: Gil Pedersen Date: Thu, 7 Dec 2023 10:12:57 +0100 Subject: [PATCH 17/45] Add tests for "name" property --- test/index.js | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/test/index.js b/test/index.js index ee4bc60..e122020 100755 --- a/test/index.js +++ b/test/index.js @@ -26,6 +26,27 @@ describe('Boom', () => { expect(JSON.stringify(err)).to.equal('{"data":null,"output":{"statusCode":400,"payload":{"statusCode":400,"error":"Bad Request","message":"oops"},"headers":{}}}'); }); + it('instances has .name "Boom"', () => { + + class SubBoom extends Boom.Boom {} + + expect(new Boom.Boom().name).to.equal('Boom'); + expect(new SubBoom().name).to.equal('Boom'); + }); + + it('instances .name can be changed', () => { + + 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 Boom.Boom(); From e780c739fe79076b989388bfd84c3f73cd58951d Mon Sep 17 00:00:00 2001 From: Gil Pedersen Date: Thu, 7 Dec 2023 11:08:54 +0100 Subject: [PATCH 18/45] Explicit cause in super() call Co-authored-by: Matthieu Sieben --- lib/index.js | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/lib/index.js b/lib/index.js index 5feef73..22a4925 100755 --- a/lib/index.js +++ b/lib/index.js @@ -80,9 +80,9 @@ exports.Boom = class Boom extends Error { constructor(message, options = {}) { - const { statusCode = 500, data, headers, ctor = exports.Boom } = options; + const { statusCode = 500, data, headers, ctor = exports.Boom, cause } = options; - super(message ?? internals.codes.get(statusCode) ?? 'Unknown', options); + super(message ?? internals.codes.get(statusCode) ?? 'Unknown', { cause }); Error.captureStackTrace(this, ctor); // Filter the stack to our external API internals.apply(this, data, statusCode, headers); From aa1465a16f5ab82f2db270e6ce15381c48a71a27 Mon Sep 17 00:00:00 2001 From: Gil Pedersen Date: Thu, 7 Dec 2023 11:36:27 +0100 Subject: [PATCH 19/45] Assign .cause if not handled by super() call --- lib/index.js | 4 ++++ test/index.js | 21 +++++++++++++++++++++ 2 files changed, 25 insertions(+) diff --git a/lib/index.js b/lib/index.js index 22a4925..314f7c2 100755 --- a/lib/index.js +++ b/lib/index.js @@ -85,6 +85,10 @@ exports.Boom = class Boom extends Error { super(message ?? internals.codes.get(statusCode) ?? 'Unknown', { cause }); Error.captureStackTrace(this, ctor); // Filter the stack to our external API + if (cause !== undefined) { + this.cause ??= cause; // Explicitly assign cause to work with old runtimes + } + internals.apply(this, data, statusCode, headers); } diff --git a/test/index.js b/test/index.js index e122020..dd63d65 100755 --- a/test/index.js +++ b/test/index.js @@ -122,6 +122,27 @@ describe('Boom', () => { expect(err.output.payload.error).to.equal('Unknown'); }); + 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', () => { From 283f635ded8488ac650e542cd5e985cdc5dae06b Mon Sep 17 00:00:00 2001 From: Gil Pedersen Date: Thu, 7 Dec 2023 14:11:20 +0100 Subject: [PATCH 20/45] Fix and update typings --- lib/index.d.ts | 216 ++++++++++++++++++++++++------------------------- package.json | 8 +- test/index.ts | 171 +++++++++++++++++++-------------------- 3 files changed, 194 insertions(+), 201 deletions(-) diff --git a/lib/index.d.ts b/lib/index.d.ts index 34132bb..ff3a5df 100755 --- a/lib/index.d.ts +++ b/lib/index.d.ts @@ -6,22 +6,27 @@ export class Boom extends Error { /** * Creates a new Boom object using the provided message or Error */ - constructor(message?: string | Error, options?: Options); + constructor(message?: string, options?: Options); + + /** + * 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,17 +38,12 @@ 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; } @@ -53,40 +53,44 @@ export interface Options { * * @default 500 */ - statusCode?: number; + readonly statusCode?: number; /** * Additional error information */ - data?: Data; + readonly data?: Data; + + /** + * An object containing any HTTP headers where each key is a header name and value is the header content + */ + readonly headers?: { [header: string]: string | string[] | number }; /** * 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; +} + +export interface BoomifyOptions extends Options { /** * 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 +98,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; } @@ -117,17 +116,17 @@ export interface Output { /** * The HTTP status code */ - statusCode: number; + readonly statusCode: number; /** * An object containing any HTTP headers where each key is a header name and value is the header content */ - headers: { [header: string]: string | string[] | number | undefined }; + readonly headers: { [header: string]: string | string[] | number | undefined }; /** * The formatted object used as the response payload (stringified) */ - payload: Payload; + readonly payload: Payload; } @@ -143,14 +142,15 @@ 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(err: Boom, options?: BoomifyOptions): Boom; +export function boomify(err: unknown, options?: BoomifyOptions): Boom; // 4xx Errors @@ -158,22 +158,22 @@ export function boomify(err: Error, options?: Options & /** * 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 +185,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 +200,7 @@ export namespace unauthorized { /** * Indicate whether the 401 unauthorized error is due to missing credentials (vs. invalid) */ - isMissing: boolean; + isMissing: true; } } @@ -213,271 +213,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: 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 | 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 +485,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/package.json b/package.json index 29277e0..67d04ec 100644 --- a/package.json +++ b/package.json @@ -21,15 +21,15 @@ "@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", - "@hapi/boom10": "npm:@hapi/boom@^10.0.1" + "@types/node": "^18.19.3", + "typescript": "~5.3.3" }, "scripts": { - "test": "lab -a @hapi/code -t 100 -L", + "test": "lab -a @hapi/code -t 100 -L -Y", "test-cov-html": "lab -a @hapi/code -t 100 -L -r html -o coverage.html" }, "license": "BSD-3-Clause" diff --git a/test/index.ts b/test/index.ts index 046b37d..88fa5fb 100755 --- a/test/index.ts +++ b/test/index.ts @@ -14,8 +14,6 @@ class X { } }; -const decorate = new X(1); - // new Boom.Boom() @@ -23,7 +21,8 @@ expect.type(new Boom.Boom()); expect.type(new Boom.Boom()); expect.type(new Boom.Boom('error')); -expect.error(new Boom.Boom('error', { decorate })); // No support for decoration on constructor +expect.error(null); +expect.error(new Boom.Boom(new Error('error'))); class CustomError extends Boom.Boom {} @@ -32,11 +31,6 @@ expect.type(new CustomError('Some error')); const boom = new Boom.Boom('some error'); expect.type(boom.output); -boom.output.payload.custom_null = null; -boom.output.payload.custom_number = 42; -boom.output.payload.custom_string = 'foo'; -boom.output.payload.custom_boolean = true; -boom.output.payload.custom_object = { bar: 42 }; boom.output.headers['header1'] = 'foo'; boom.output.headers['header2'] = ['foo', 'bar']; boom.output.headers['header3'] = 42; @@ -51,14 +45,13 @@ const error = new Error('Unexpected input'); 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' }>())); 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); // isBoom @@ -82,40 +75,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 +118,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 +129,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 +140,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 +151,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 +162,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 +173,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 +184,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 +195,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 +206,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 +217,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 +228,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 +239,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 +250,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 +261,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 +272,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 +283,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 +294,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 +305,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 +316,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 +326,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 +336,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 +347,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 +358,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 +371,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 +382,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 +393,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 +404,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 +415,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 +426,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()); From 4a3502845b7a2c0d4fb5c51116a5c43fbbebafd1 Mon Sep 17 00:00:00 2001 From: Gil Pedersen Date: Thu, 7 Dec 2023 14:33:50 +0100 Subject: [PATCH 21/45] Clone incoming headers --- lib/index.js | 2 +- test/index.js | 11 +++++++++++ 2 files changed, 12 insertions(+), 1 deletion(-) diff --git a/lib/index.js b/lib/index.js index 314f7c2..3a853a7 100755 --- a/lib/index.js +++ b/lib/index.js @@ -199,7 +199,7 @@ internals.BoomOutput = class { this.statusCode = statusCode; this.payload = payload; - this.headers = headers ?? {}; + this.headers = headers ? Hoek.clone(headers, { prototype: false, symbols: false }) : {}; } }; diff --git a/test/index.js b/test/index.js index dd63d65..546f3a3 100755 --- a/test/index.js +++ b/test/index.js @@ -79,6 +79,17 @@ describe('Boom', () => { expect(err.output.headers).to.equal({ custom: 'yes' }); }); + 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('throws when statusCode is invalid', () => { expect(() => { From f8cb4d3d795fced575ed26af8cf9f7ab4ff7bb91 Mon Sep 17 00:00:00 2001 From: Gil Pedersen Date: Thu, 7 Dec 2023 14:54:19 +0100 Subject: [PATCH 22/45] Cleanup typings --- lib/index.d.ts | 12 ++++++------ test/index.ts | 5 +++++ 2 files changed, 11 insertions(+), 6 deletions(-) diff --git a/lib/index.d.ts b/lib/index.d.ts index ff3a5df..5608c08 100755 --- a/lib/index.d.ts +++ b/lib/index.d.ts @@ -63,7 +63,7 @@ export interface Options { /** * An object containing any HTTP headers where each key is a header name and value is the header content */ - readonly headers?: { [header: string]: string | string[] | number }; + readonly headers?: { [header: string]: string | readonly string[] | number }; /** * Constructor reference used to crop the exception call stack output @@ -116,17 +116,17 @@ export interface Output { /** * The HTTP status code */ - readonly statusCode: number; + statusCode: number; /** * An object containing any HTTP headers where each key is a header name and value is the header content */ - readonly headers: { [header: string]: string | string[] | number | undefined }; + headers: { [header: string]: string | string[] | number | undefined }; /** * The formatted object used as the response payload (stringified) */ - readonly payload: Payload; + payload: Payload & { [key: string]: unknown }; } @@ -213,7 +213,7 @@ export namespace unauthorized { * * @returns A 401 Unauthorized error */ -export function unauthorized(message: string | null | undefined, wwwAuthenticate: string[]): Boom; +export function unauthorized(message: string | null | undefined, wwwAuthenticate: readonly string[]): Boom; /** @@ -258,7 +258,7 @@ export function notFound(message?: string, data?: Data): Boom; * * @returns A 405 Method Not Allowed error */ -export function methodNotAllowed(message?: string, data?: Data, allow?: string | string[]): Boom; +export function methodNotAllowed(message?: string, data?: Data, allow?: string | readonly string[]): Boom; /** diff --git a/test/index.ts b/test/index.ts index 88fa5fb..82b69f0 100755 --- a/test/index.ts +++ b/test/index.ts @@ -31,6 +31,11 @@ expect.type(new CustomError('Some error')); const boom = new Boom.Boom('some error'); expect.type(boom.output); +boom.output.payload.custom_null = null; +boom.output.payload.custom_number = 42; +boom.output.payload.custom_string = 'foo'; +boom.output.payload.custom_boolean = true; +boom.output.payload.custom_object = { bar: 42 }; boom.output.headers['header1'] = 'foo'; boom.output.headers['header2'] = ['foo', 'bar']; boom.output.headers['header3'] = 42; From e2efda75da7e4a00440129488d8474962deff7fc Mon Sep 17 00:00:00 2001 From: Gil Pedersen Date: Mon, 11 Dec 2023 11:02:12 +0100 Subject: [PATCH 23/45] Narrow typings Co-authored-by: Matthieu Sieben --- lib/index.d.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/index.d.ts b/lib/index.d.ts index 5608c08..fa777b9 100755 --- a/lib/index.d.ts +++ b/lib/index.d.ts @@ -63,7 +63,7 @@ export interface Options { /** * An object containing any HTTP headers where each key is a header name and value is the header content */ - readonly headers?: { [header: string]: string | readonly string[] | number }; + readonly headers?: { readonly [header: string]: string | readonly string[] | number }; /** * Constructor reference used to crop the exception call stack output From 6d8f6400a12848aa74bf6be9328066252832e894 Mon Sep 17 00:00:00 2001 From: Gil Pedersen Date: Thu, 7 Dec 2023 17:18:53 +0100 Subject: [PATCH 24/45] Revert "Remove decorate option" This reverts commit 19e5e2a0ad42d6fcd97c87d3c62535f1f1cd8065. # Conflicts: # lib/index.js --- lib/index.js | 18 +++++++++++------- test/index.js | 15 +++++++++++++++ 2 files changed, 26 insertions(+), 7 deletions(-) diff --git a/lib/index.js b/lib/index.js index 3a853a7..c246734 100755 --- a/lib/index.js +++ b/lib/index.js @@ -80,7 +80,7 @@ exports.Boom = class Boom extends Error { constructor(message, options = {}) { - const { statusCode = 500, data, headers, ctor = exports.Boom, cause } = options; + const { statusCode = 500, data, headers, decorate, ctor = exports.Boom, cause } = options; super(message ?? internals.codes.get(statusCode) ?? 'Unknown', { cause }); Error.captureStackTrace(this, ctor); // Filter the stack to our external API @@ -89,7 +89,7 @@ exports.Boom = class Boom extends Error { this.cause ??= cause; // Explicitly assign cause to work with old runtimes } - internals.apply(this, data, statusCode, headers); + internals.apply(this, data, decorate, statusCode, headers); } static [Symbol.hasInstance](instance) { @@ -123,17 +123,17 @@ exports.isBoom = function (err, statusCode) { exports.boomify = function (err, options = {}) { - const { override, data, statusCode, message } = options; + const { override, data, decorate, statusCode, message } = options; if (!err?.isBoom) { - return new exports.Boom(message, { statusCode, cause: err, data }); + return new exports.Boom(message, { statusCode, cause: err, data, decorate }); } if (override === false) { // Defaults to true - internals.apply(err, data); + internals.apply(err, data, decorate); } else { - internals.apply(err, data, statusCode ?? err.output.statusCode, {}, message); + internals.apply(err, data, decorate, statusCode ?? err.output.statusCode, {}, message); } err.isServer = err.output.statusCode >= 500; // Assign, in case it is a legacy boom object @@ -142,7 +142,11 @@ exports.boomify = function (err, options = {}) { }; -internals.apply = function (boom, data, statusCode, headers, message) { +internals.apply = function (boom, data, decorate, statusCode, headers, message) { + + if (decorate) { + Object.assign(boom, decorate); + } if (data !== undefined) { boom.data = data; diff --git a/test/index.js b/test/index.js index 546f3a3..1adb817 100755 --- a/test/index.js +++ b/test/index.js @@ -47,6 +47,14 @@ describe('Boom', () => { expect(new SubBoom().name).to.equal('BadaBoom'); }); + it('decorates error', () => { + + 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); + }); + it('handles missing message', () => { const err = new Boom.Boom(); @@ -235,6 +243,13 @@ describe('Boom', () => { expect(error).to.shallow.equal(Boom.boomify(error, { statusCode: 444 })); }); + it('decorates error', () => { + + const error = new Error('oops'); + const err = Boom.boomify(error, { statusCode: 400, decorate: { x: 1 } }); + expect(err.x).to.equal(1); + }); + it('returns an error with info when constructed using another error', () => { const error = new Error('ka-boom'); From c69e872b184de691bf158ae7a167bf9eb045352d Mon Sep 17 00:00:00 2001 From: Gil Pedersen Date: Thu, 7 Dec 2023 17:22:43 +0100 Subject: [PATCH 25/45] Use decorate option internally --- lib/index.js | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/lib/index.js b/lib/index.js index c246734..44afb7b 100755 --- a/lib/index.js +++ b/lib/index.js @@ -213,8 +213,8 @@ internals.statusError = function (statusCode, massage) { const method = massage ? function (...args) { - const [message, options, decorate] = massage(...args); - return Object.assign(new exports.Boom(message, { statusCode, ctor: method, ...options }), decorate); + const [message, options] = massage(...args); + return new exports.Boom(message, { statusCode, ctor: method, ...options }); } : function (message, data) { @@ -277,7 +277,7 @@ exports.unauthorized = internals.statusError(401, (message, scheme, attributes) } const headers = { 'WWW-Authenticate': stringified ? `${scheme} ${stringified}` : `${scheme}` }; - return [message, { headers }, decorate]; + return [message, { headers, decorate }]; }); @@ -392,7 +392,7 @@ exports.gatewayTimeout = internals.statusError(504, internals.serverError); exports.badImplementation = internals.statusError(500, (message, data) => { const res = internals.serverError(message, data); - res.push({ isDeveloperError: true }); + res[1].decorate = { isDeveloperError: true }; return res; }); From f5e93afb64fffc49ec067a2818b2a56aa211f1ff Mon Sep 17 00:00:00 2001 From: Gil Pedersen Date: Thu, 24 Oct 2024 14:03:51 +0200 Subject: [PATCH 26/45] Allow usage on runtimes with no Error.captureStackTrace() --- lib/index.js | 4 +++- test/index.js | 42 ++++++++++++++++++++++++++++++------------ 2 files changed, 33 insertions(+), 13 deletions(-) diff --git a/lib/index.js b/lib/index.js index 44afb7b..aedd94b 100755 --- a/lib/index.js +++ b/lib/index.js @@ -83,7 +83,9 @@ exports.Boom = class Boom extends Error { const { statusCode = 500, data, headers, decorate, ctor = exports.Boom, cause } = options; super(message ?? internals.codes.get(statusCode) ?? 'Unknown', { cause }); - Error.captureStackTrace(this, ctor); // Filter the stack to our external API + if (typeof Error.captureStackTrace === 'function') { // Only use when available + Error.captureStackTrace(this, ctor); // Filter the stack to our external API + } if (cause !== undefined) { this.cause ??= cause; // Explicitly assign cause to work with old runtimes diff --git a/test/index.js b/test/index.js index 1adb817..d9e9415 100755 --- a/test/index.js +++ b/test/index.js @@ -1013,22 +1013,40 @@ describe('Boom', () => { describe('stack trace', () => { + const helpers = ['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' + ]; + it('should omit lib', () => { - ['badRequest', 'unauthorized', 'forbidden', 'notFound', 'methodNotAllowed', - 'notAcceptable', 'proxyAuthRequired', 'clientTimeout', 'conflict', - 'resourceGone', 'lengthRequired', 'preconditionFailed', 'entityTooLarge', - 'uriTooLong', 'unsupportedMediaType', 'rangeNotSatisfiable', 'expectationFailed', - 'badData', 'preconditionRequired', 'tooManyRequests', + for (const helper of helpers) { + const err = Boom[helper](); + expect(err.stack).to.not.match(/\/lib\/index\.js/); + } + }); - // 500s - 'internal', 'notImplemented', 'badGateway', 'serverUnavailable', - 'gatewayTimeout', 'badImplementation' - ].forEach((name) => { + it('should not crash when Error.captureStackTrace is missing', (flags) => { - const err = Boom[name](); - expect(err.stack).to.not.match(/\/lib\/index\.js/); - }); + const captureStackTrace = Error.captureStackTrace; + + for (const helper of helpers) { + try { + Error.captureStackTrace = undefined; + var err = Boom[helper](); + } + finally { + Error.captureStackTrace = captureStackTrace; + } + + expect(err.stack).to.match(/\/lib\/index\.js/); + } }); }); From 96d92c7989bb407a986a5f8e4bb76a079bf10e74 Mon Sep 17 00:00:00 2001 From: Gil Pedersen Date: Thu, 24 Oct 2024 14:39:37 +0200 Subject: [PATCH 27/45] Update docs --- API.md | 21 ++++++++++----------- 1 file changed, 10 insertions(+), 11 deletions(-) diff --git a/API.md b/API.md index 800309a..beb2fdf 100755 --- a/API.md +++ b/API.md @@ -31,34 +31,33 @@ Rebuilds `error.output` using the other object properties where: ##### `new Boom.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` 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. + - `statusCode` - the HTTP status code. Defaults to `500`. + - `cause` - The error that caused the boom error. - `data` - additional error information (assigned to `error.data`). - `decorate` - an option with extra properties to set on the error object. - `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. ##### `boomify(err, [options])` -Decorates an error with the `Boom` properties where: +This works as [`new Boom.Boom()`](#new-boomboommessage-options), except when the `err` argument is a boom error. +In that case, it will apply the options to the existing error, instead of wrapping it in a new boom error. +Decorates a boom object with the `Boom` properties where: - `err` - the `Error` object to decorate. - `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). +- it returns the boomified error ```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])` From f0e0f6c1823c4aa4db461a8efd8f10a1b96ae331 Mon Sep 17 00:00:00 2001 From: Gil Pedersen Date: Thu, 24 Oct 2024 14:40:01 +0200 Subject: [PATCH 28/45] Restore decorate option to typings --- lib/index.d.ts | 10 ++++++++-- test/index.ts | 11 ++++++++--- 2 files changed, 16 insertions(+), 5 deletions(-) diff --git a/lib/index.d.ts b/lib/index.d.ts index fa777b9..f8f26db 100755 --- a/lib/index.d.ts +++ b/lib/index.d.ts @@ -60,6 +60,11 @@ export interface Options { */ readonly data?: Data; + /** + * An object with extra properties to set on the error object + */ + readonly decorate?: { [key: string]: any }; + /** * An object containing any HTTP headers where each key is a header name and value is the header content */ @@ -149,10 +154,11 @@ export function isBoom(obj: unknown, statusCode?: number): obj is Boom; * * @returns A boom object */ -export function boomify(err: Boom, options?: BoomifyOptions): Boom; +export function boomify(err: Boom, options?: BoomifyOptions & { decorate: Decoration }): Boom & Decoration; +export function boomify(err: unknown, options?: BoomifyOptions & { decorate: Decoration }): Boom & Decoration; +export function boomify(err: Boom, options?: BoomifyOptions): Boom; export function boomify(err: unknown, options?: BoomifyOptions): Boom; - // 4xx Errors /** diff --git a/test/index.ts b/test/index.ts index 82b69f0..387e0d9 100755 --- a/test/index.ts +++ b/test/index.ts @@ -15,14 +15,17 @@ class X { }; +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', { decorate })); -expect.error(null); -expect.error(new Boom.Boom(new Error('error'))); +expect.error(new Boom.Boom(null)); +expect.error(new Boom.Boom(new Error('error'))); class CustomError extends Boom.Boom {} @@ -50,6 +53,7 @@ const error = new Error('Unexpected input'); 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' }>())); @@ -57,7 +61,8 @@ expect.error(Boom.boomify(error, { statusCode: '400' })); 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: true })); +expect.error(Boom.boomify(error, { decorate }).y); // isBoom From 56795ff5be4e72084c23a8f343c20ae2110ec2a9 Mon Sep 17 00:00:00 2001 From: Gil Pedersen Date: Thu, 7 Dec 2023 17:13:17 +0100 Subject: [PATCH 29/45] Make reformat() apply to initial payload --- lib/index.js | 9 ++++----- test/index.js | 40 ++++++++++++++++++++++++++++++++++++++++ 2 files changed, 44 insertions(+), 5 deletions(-) diff --git a/lib/index.js b/lib/index.js index aedd94b..aa7baa4 100755 --- a/lib/index.js +++ b/lib/index.js @@ -164,8 +164,8 @@ internals.apply = function (boom, data, decorate, statusCode, headers, message) boom.message = `${message}: ${boom.message}`; } - const payload = new internals.PayloadObject(boom, numberCode, false); - boom.output = new internals.BoomOutput(numberCode, payload, headers); + boom.output = new internals.BoomOutput(numberCode, headers); + boom.reformat(); } }; @@ -198,13 +198,12 @@ internals.PayloadObject = class { internals.BoomOutput = class { statusCode; - payload; + payload = {}; headers; - constructor(statusCode, payload, headers) { + constructor(statusCode, headers) { this.statusCode = statusCode; - this.payload = payload; this.headers = headers ? Hoek.clone(headers, { prototype: false, symbols: false }) : {}; } }; diff --git a/test/index.js b/test/index.js index d9e9415..74e314c 100755 --- a/test/index.js +++ b/test/index.js @@ -1126,5 +1126,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'); + }); }); }); From 4135963275d3017e1e86ec5b1a13ece14a602db2 Mon Sep 17 00:00:00 2001 From: Gil Pedersen Date: Thu, 24 Oct 2024 14:47:54 +0200 Subject: [PATCH 30/45] Update typescript --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index 67d04ec..099707c 100644 --- a/package.json +++ b/package.json @@ -26,7 +26,7 @@ "@hapi/eslint-plugin": "^7.0.0", "@hapi/lab": "^26.0.0", "@types/node": "^18.19.3", - "typescript": "~5.3.3" + "typescript": "~5.6.3" }, "scripts": { "test": "lab -a @hapi/code -t 100 -L -Y", From 26fc313491a0ccae270c66e95b49403c366c1bd3 Mon Sep 17 00:00:00 2001 From: Gil Pedersen Date: Thu, 24 Oct 2024 14:51:04 +0200 Subject: [PATCH 31/45] Fix tests on windows filesystem --- test/index.js | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/test/index.js b/test/index.js index 74e314c..d74f6e3 100755 --- a/test/index.js +++ b/test/index.js @@ -1028,7 +1028,7 @@ describe('Boom', () => { for (const helper of helpers) { const err = Boom[helper](); - expect(err.stack).to.not.match(/\/lib\/index\.js/); + expect(err.stack).to.not.match(/(\/|\\)lib(\/|\\)index\.js/); } }); @@ -1045,7 +1045,7 @@ describe('Boom', () => { Error.captureStackTrace = captureStackTrace; } - expect(err.stack).to.match(/\/lib\/index\.js/); + expect(err.stack).to.match(/(\/|\\)lib(\/|\\)index\.js/); } }); }); From 6816b3d0319ae47abbac51bfe122260da7c0c3bb Mon Sep 17 00:00:00 2001 From: Gil Pedersen Date: Sat, 26 Oct 2024 12:39:59 +0200 Subject: [PATCH 32/45] Don't set cause when not in the options --- lib/index.d.ts | 2 +- lib/index.js | 9 +++++---- test/index.js | 11 +++++++++++ 3 files changed, 17 insertions(+), 5 deletions(-) diff --git a/lib/index.d.ts b/lib/index.d.ts index f8f26db..18fe68c 100755 --- a/lib/index.d.ts +++ b/lib/index.d.ts @@ -78,7 +78,7 @@ export interface Options { /** * An underlying cause for the Boom error */ - readonly cause?: Error | unknown; + readonly cause?: Error | unknown | undefined; } diff --git a/lib/index.js b/lib/index.js index aa7baa4..d71429c 100755 --- a/lib/index.js +++ b/lib/index.js @@ -80,15 +80,16 @@ exports.Boom = class Boom extends Error { constructor(message, options = {}) { - const { statusCode = 500, data, headers, decorate, ctor = exports.Boom, cause } = options; + const { statusCode = 500, data, headers, decorate, ctor = exports.Boom } = options; + const causeOption = 'cause' in options ? { cause: options.cause } : undefined; - super(message ?? internals.codes.get(statusCode) ?? 'Unknown', { cause }); + 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 (cause !== undefined) { - this.cause ??= cause; // Explicitly assign cause to work with old runtimes + if (causeOption) { + this.cause ??= causeOption.cause; // Explicitly assign cause to work with old runtimes } internals.apply(this, data, decorate, statusCode, headers); diff --git a/test/index.js b/test/index.js index d74f6e3..35cb321 100755 --- a/test/index.js +++ b/test/index.js @@ -141,6 +141,17 @@ 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); From 1e0c4643a43c6d78cad169bd3b8e00010a903e12 Mon Sep 17 00:00:00 2001 From: Gil Pedersen Date: Sat, 26 Oct 2024 13:16:09 +0200 Subject: [PATCH 33/45] Allow isServer to be written to --- lib/index.js | 15 ++++++++++++--- test/index.js | 18 ++++++++++++++++++ 2 files changed, 30 insertions(+), 3 deletions(-) diff --git a/lib/index.js b/lib/index.js index d71429c..9d0f4ce 100755 --- a/lib/index.js +++ b/lib/index.js @@ -76,7 +76,14 @@ exports.Boom = class Boom extends Error { return this.output.statusCode >= 500; } - set isServer(value) {} // Allow for compatiblity with legacy boom + set isServer(value) { // Allow for compatiblity with legacy boom + + Object.defineProperty(this, 'isServer', { + value, + writable: true, + configurable: true + }); + } constructor(message, options = {}) { @@ -128,7 +135,7 @@ exports.boomify = function (err, options = {}) { const { override, data, decorate, statusCode, message } = options; - if (!err?.isBoom) { + if (!err?.isBoom === true) { return new exports.Boom(message, { statusCode, cause: err, data, decorate }); } @@ -139,7 +146,9 @@ exports.boomify = function (err, options = {}) { internals.apply(err, data, decorate, statusCode ?? err.output.statusCode, {}, message); } - err.isServer = err.output.statusCode >= 500; // Assign, in case it is a legacy boom object + if (err.hasOwnProperty('isServer')) { + err.isServer = err.output.statusCode >= 500; // Assign, in case it is a legacy boom object + } return err; }; diff --git a/test/index.js b/test/index.js index 35cb321..36e988a 100755 --- a/test/index.js +++ b/test/index.js @@ -369,6 +369,22 @@ describe('Boom', () => { 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' }); @@ -376,6 +392,7 @@ describe('Boom', () => { 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' }); @@ -383,6 +400,7 @@ describe('Boom', () => { 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); }); }); From 90843713ec8a379380e5d00feed351d289a99397 Mon Sep 17 00:00:00 2001 From: Gil Pedersen Date: Sat, 26 Oct 2024 13:31:33 +0200 Subject: [PATCH 34/45] Fix boomify option typings --- lib/index.d.ts | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/lib/index.d.ts b/lib/index.d.ts index 18fe68c..1947522 100755 --- a/lib/index.d.ts +++ b/lib/index.d.ts @@ -46,8 +46,7 @@ export class Boom extends Error { reformat(debug?: boolean): void; } - -export interface Options { +export interface BaseOptions { /** * The HTTP status code * @@ -64,7 +63,10 @@ export interface Options { * An object with extra properties to set on the error object */ readonly decorate?: { [key: string]: any }; +} + +export interface Options extends BaseOptions { /** * An object containing any HTTP headers where each key is a header name and value is the header content */ @@ -82,7 +84,7 @@ export interface Options { } -export interface BoomifyOptions extends Options { +export interface BoomifyOptions extends BaseOptions { /** * Error message string * From d8637d69836f1483c705821a63ac3dd4530c6538 Mon Sep 17 00:00:00 2001 From: Gil Pedersen Date: Sat, 26 Oct 2024 14:25:40 +0200 Subject: [PATCH 35/45] Improve boomify typings --- lib/index.d.ts | 7 +++---- test/index.ts | 5 +++++ 2 files changed, 8 insertions(+), 4 deletions(-) diff --git a/lib/index.d.ts b/lib/index.d.ts index 1947522..3ed9367 100755 --- a/lib/index.d.ts +++ b/lib/index.d.ts @@ -156,10 +156,9 @@ export function isBoom(obj: unknown, statusCode?: number): obj is Boom; * * @returns A boom object */ -export function boomify(err: Boom, options?: BoomifyOptions & { decorate: Decoration }): Boom & Decoration; -export function boomify(err: unknown, options?: BoomifyOptions & { decorate: Decoration }): Boom & Decoration; -export function boomify(err: Boom, options?: BoomifyOptions): Boom; -export function boomify(err: unknown, options?: BoomifyOptions): Boom; +export function boomify(err: Terr, options: BoomifyOptions & { decorate: Decoration, data: Data }): (Terr extends Boom ? Terr : Boom) & Omit; +export function boomify(err: Terr, options: BoomifyOptions & { decorate: Decoration }): (Terr extends Boom ? Terr : Boom) & Decoration; +export function boomify(err: Terr, options?: BoomifyOptions): Terr extends Boom ? Terr : Boom; // 4xx Errors diff --git a/test/index.ts b/test/index.ts index 387e0d9..b4cbd48 100755 --- a/test/index.ts +++ b/test/index.ts @@ -50,12 +50,17 @@ expect.type(boom.output.headers); // boomify() const error = new Error('Unexpected input'); +class BadaBoom extends Boom.Boom {} 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' }>())); +expect.type(Boom.boomify(error, { decorate: { data: 1 } }).data); +expect.type(Boom.boomify(error, { decorate: { data: 1 }, data: 'bla' }).data); +expect.type(Boom.boomify(error, { data: 'bla' }).data); +expect.type(Boom.boomify(new BadaBoom(), { statusCode: 400 })); expect.error(Boom.boomify(error, { statusCode: '400' })); expect.error(Boom.boomify(error, { statusCode: 400, message: true })); From ec14f455ff73f22684693c3ca41290ce7ffc034f Mon Sep 17 00:00:00 2001 From: Gil Pedersen Date: Sat, 26 Oct 2024 17:02:11 +0200 Subject: [PATCH 36/45] Document headers option --- API.md | 1 + 1 file changed, 1 insertion(+) diff --git a/API.md b/API.md index beb2fdf..4c732b7 100755 --- a/API.md +++ b/API.md @@ -38,6 +38,7 @@ Creates a new `Boom` object, where: - `cause` - The error that caused the boom error. - `data` - additional error information (assigned to `error.data`). - `decorate` - an option with extra properties to set on the error object. + - `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. ##### `boomify(err, [options])` From 7899720d3a99315ab162a1f64bd72f964741e57a Mon Sep 17 00:00:00 2001 From: Gil Pedersen Date: Wed, 30 Oct 2024 20:38:46 +0100 Subject: [PATCH 37/45] Require data option when Data generic is not unknown --- lib/index.d.ts | 11 +++++++++-- test/index.ts | 11 +++++++---- 2 files changed, 16 insertions(+), 6 deletions(-) diff --git a/lib/index.d.ts b/lib/index.d.ts index 3ed9367..d8872e1 100755 --- a/lib/index.d.ts +++ b/lib/index.d.ts @@ -1,12 +1,19 @@ +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, options?: Options); + constructor(...args: Data extends NotUnknown ? Boom.WithDataArgs : Boom.CtorArgs); /** * Underlying cause for the Boom error diff --git a/test/index.ts b/test/index.ts index b4cbd48..9e126fa 100755 --- a/test/index.ts +++ b/test/index.ts @@ -19,13 +19,16 @@ 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', { decorate })); +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(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 {} @@ -56,7 +59,7 @@ 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' }>())); +expect.type>(Boom.boomify(new Boom.Boom<{ foo: 'bar' }>('error', { data: { foo: 'bar' }}))); expect.type(Boom.boomify(error, { decorate: { data: 1 } }).data); expect.type(Boom.boomify(error, { decorate: { data: 1 }, data: 'bla' }).data); expect.type(Boom.boomify(error, { data: 'bla' }).data); From 71ced427404a4753d7f8071515f2ebb98d37aa2e Mon Sep 17 00:00:00 2001 From: Gil Pedersen Date: Wed, 30 Oct 2024 20:44:34 +0100 Subject: [PATCH 38/45] Remove decorate option --- API.md | 7 ++----- lib/index.d.ts | 7 ------- lib/index.js | 26 +++++++++++--------------- test/index.js | 15 --------------- test/index.ts | 19 +------------------ 5 files changed, 14 insertions(+), 60 deletions(-) diff --git a/API.md b/API.md index 4c732b7..ccb9edf 100755 --- a/API.md +++ b/API.md @@ -37,20 +37,17 @@ Creates a new `Boom` object, where: - `statusCode` - the HTTP status code. Defaults to `500`. - `cause` - The error that caused the boom error. - `data` - additional error information (assigned to `error.data`). - - `decorate` - an option with extra properties to set on the error object. - `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. ##### `boomify(err, [options])` This works as [`new Boom.Boom()`](#new-boomboommessage-options), except when the `err` argument is a boom error. -In that case, it will apply the options to the existing error, instead of wrapping it in a new boom error. -Decorates a boom object with the `Boom` properties where: -- `err` - the `Error` object to decorate. +In that case, it will apply the options to the existing error, instead of wrapping it in a new boom error, where: +- `err` - the object to boomify. - `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. - - `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). diff --git a/lib/index.d.ts b/lib/index.d.ts index d8872e1..6efa7fb 100755 --- a/lib/index.d.ts +++ b/lib/index.d.ts @@ -65,11 +65,6 @@ export interface BaseOptions { * Additional error information */ readonly data?: Data; - - /** - * An object with extra properties to set on the error object - */ - readonly decorate?: { [key: string]: any }; } @@ -163,8 +158,6 @@ export function isBoom(obj: unknown, statusCode?: number): obj is Boom; * * @returns A boom object */ -export function boomify(err: Terr, options: BoomifyOptions & { decorate: Decoration, data: Data }): (Terr extends Boom ? Terr : Boom) & Omit; -export function boomify(err: Terr, options: BoomifyOptions & { decorate: Decoration }): (Terr extends Boom ? Terr : Boom) & Decoration; export function boomify(err: Terr, options?: BoomifyOptions): Terr extends Boom ? Terr : Boom; // 4xx Errors diff --git a/lib/index.js b/lib/index.js index 9d0f4ce..af04dd1 100755 --- a/lib/index.js +++ b/lib/index.js @@ -87,7 +87,7 @@ exports.Boom = class Boom extends Error { constructor(message, options = {}) { - const { statusCode = 500, data, headers, decorate, ctor = exports.Boom } = options; + 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); @@ -99,7 +99,7 @@ exports.Boom = class Boom extends Error { this.cause ??= causeOption.cause; // Explicitly assign cause to work with old runtimes } - internals.apply(this, data, decorate, statusCode, headers); + internals.apply(this, data, statusCode, headers); } static [Symbol.hasInstance](instance) { @@ -133,17 +133,17 @@ exports.isBoom = function (err, statusCode) { exports.boomify = function (err, options = {}) { - const { override, data, decorate, statusCode, message } = options; + const { override, data, statusCode, message } = options; if (!err?.isBoom === true) { - return new exports.Boom(message, { statusCode, cause: err, data, decorate }); + return new exports.Boom(message, { statusCode, cause: err, data }); } if (override === false) { // Defaults to true - internals.apply(err, data, decorate); + internals.apply(err, data); } else { - internals.apply(err, data, decorate, statusCode ?? err.output.statusCode, {}, message); + internals.apply(err, data, statusCode ?? err.output.statusCode, {}, message); } if (err.hasOwnProperty('isServer')) { @@ -154,11 +154,7 @@ exports.boomify = function (err, options = {}) { }; -internals.apply = function (boom, data, decorate, statusCode, headers, message) { - - if (decorate) { - Object.assign(boom, decorate); - } +internals.apply = function (boom, data, statusCode, headers, message) { if (data !== undefined) { boom.data = data; @@ -224,8 +220,8 @@ internals.statusError = function (statusCode, massage) { const method = massage ? function (...args) { - const [message, options] = massage(...args); - return new exports.Boom(message, { statusCode, ctor: method, ...options }); + const [message, options, decorate] = massage(...args); + return Object.assign(new exports.Boom(message, { statusCode, ctor: method, ...options }), decorate); } : function (message, data) { @@ -288,7 +284,7 @@ exports.unauthorized = internals.statusError(401, (message, scheme, attributes) } const headers = { 'WWW-Authenticate': stringified ? `${scheme} ${stringified}` : `${scheme}` }; - return [message, { headers, decorate }]; + return [message, { headers }, decorate]; }); @@ -403,7 +399,7 @@ exports.gatewayTimeout = internals.statusError(504, internals.serverError); exports.badImplementation = internals.statusError(500, (message, data) => { const res = internals.serverError(message, data); - res[1].decorate = { isDeveloperError: true }; + res.push({ isDeveloperError: true }); return res; }); diff --git a/test/index.js b/test/index.js index 36e988a..369fb91 100755 --- a/test/index.js +++ b/test/index.js @@ -47,14 +47,6 @@ describe('Boom', () => { expect(new SubBoom().name).to.equal('BadaBoom'); }); - it('decorates error', () => { - - 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); - }); - it('handles missing message', () => { const err = new Boom.Boom(); @@ -254,13 +246,6 @@ describe('Boom', () => { expect(error).to.shallow.equal(Boom.boomify(error, { statusCode: 444 })); }); - it('decorates error', () => { - - const error = new Error('oops'); - const err = Boom.boomify(error, { statusCode: 400, decorate: { x: 1 } }); - expect(err.x).to.equal(1); - }); - it('returns an error with info when constructed using another error', () => { const error = new Error('ka-boom'); diff --git a/test/index.ts b/test/index.ts index 9e126fa..e045c2c 100755 --- a/test/index.ts +++ b/test/index.ts @@ -4,19 +4,6 @@ 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()); @@ -57,11 +44,8 @@ class BadaBoom extends Boom.Boom {} 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, { decorate: { data: 1 } }).data); -expect.type(Boom.boomify(error, { decorate: { data: 1 }, data: 'bla' }).data); expect.type(Boom.boomify(error, { data: 'bla' }).data); expect.type(Boom.boomify(new BadaBoom(), { statusCode: 400 })); @@ -69,8 +53,7 @@ expect.error(Boom.boomify(error, { statusCode: '400' })); 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: true })); -expect.error(Boom.boomify(error, { decorate }).y); +expect.error(Boom.boomify(error, { decorate: { x: 'y' } })); // isBoom From 9109bdb1b5d2e7820eb1386830261c9b99b7b50a Mon Sep 17 00:00:00 2001 From: Gil Pedersen Date: Thu, 31 Oct 2024 11:34:21 +0100 Subject: [PATCH 39/45] Improve boomify data type support --- lib/index.d.ts | 7 +++++-- test/index.ts | 17 ++++++++++++++--- 2 files changed, 19 insertions(+), 5 deletions(-) diff --git a/lib/index.d.ts b/lib/index.d.ts index 6efa7fb..d02d491 100755 --- a/lib/index.d.ts +++ b/lib/index.d.ts @@ -86,7 +86,7 @@ export interface Options extends BaseOptions { } -export interface BoomifyOptions extends BaseOptions { +export interface BoomifyOptions extends BaseOptions { /** * Error message string * @@ -158,7 +158,10 @@ export function isBoom(obj: unknown, statusCode?: number): obj is Boom; * * @returns A boom object */ -export function boomify(err: Terr, options?: BoomifyOptions): Terr extends Boom ? Terr : Boom; +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 diff --git a/test/index.ts b/test/index.ts index e045c2c..fdeac2c 100755 --- a/test/index.ts +++ b/test/index.ts @@ -40,20 +40,31 @@ expect.type(boom.output.headers); // boomify() const error = new Error('Unexpected input'); -class BadaBoom extends Boom.Boom {} +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')); expect.type>(Boom.boomify(new Boom.Boom<{ foo: 'bar' }>('error', { data: { foo: 'bar' }}))); -expect.type(Boom.boomify(error, { data: 'bla' }).data); +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, { statusCode: 400, message: true })); expect.error(Boom.boomify(error, { statusCode: 400, override: 'false' })); -expect.error(Boom.boomify()); 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 From e4ba24dfd6bdb5343fd1dc6c05941ca0e57f361d Mon Sep 17 00:00:00 2001 From: Gil Pedersen Date: Thu, 31 Oct 2024 11:35:17 +0100 Subject: [PATCH 40/45] Improve docs --- API.md | 65 ++++++++++++++++++++++++++++++++++------------------------ 1 file changed, 38 insertions(+), 27 deletions(-) diff --git a/API.md b/API.md index ccb9edf..ab6953b 100755 --- a/API.md +++ b/API.md @@ -1,57 +1,64 @@ **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. +- `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, where: +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`. - `cause` - The error that caused the boom error. - - `data` - additional error information (assigned to `error.data`). + - `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. +#### Helper Methods + ##### `boomify(err, [options])` -This works as [`new Boom.Boom()`](#new-boomboommessage-options), except when the `err` argument is a boom error. -In that case, it will apply the options to the existing error, instead of wrapping it in a new boom error, where: -- `err` - the object to boomify. +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. - `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). -- it returns the boomified error + 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 const error = new Error('Unexpected input'); @@ -60,7 +67,7 @@ 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. @@ -68,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])` @@ -660,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'); @@ -680,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'); @@ -700,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'); @@ -720,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'); @@ -740,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(); @@ -759,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. From e114fbd4c0b557960b607bc304eceb3848fad721 Mon Sep 17 00:00:00 2001 From: Gil Pedersen Date: Thu, 31 Oct 2024 11:53:38 +0100 Subject: [PATCH 41/45] Fix notImplemented and more setting Error cause --- lib/index.js | 19 ++++++++++--------- test/index.js | 32 ++++++++++++++++++++++++++++++++ 2 files changed, 42 insertions(+), 9 deletions(-) diff --git a/lib/index.js b/lib/index.js index af04dd1..83fa569 100755 --- a/lib/index.js +++ b/lib/index.js @@ -373,11 +373,20 @@ exports.illegal = internals.statusError(451); // 5xx Server Errors +internals.serverError = function (message, data) { + + const isDataNonBoomError = data instanceof Error && !exports.isBoom(data); + + return [message, isDataNonBoomError ? { cause: data } : { data }]; +}; + + exports.internal = internals.statusError(500, (message, data, statusCode = 500) => { const res = internals.serverError(message, data); if (statusCode !== 500) { - res[1].statusCode = statusCode; + const [, options] = res; + options.statusCode = statusCode; } return res; @@ -402,11 +411,3 @@ exports.badImplementation = internals.statusError(500, (message, data) => { res.push({ isDeveloperError: true }); return res; }); - - -internals.serverError = function (message, data) { - - const isDataNonBoomError = data instanceof Error && !exports.isBoom(data); - - return [message, isDataNonBoomError ? { cause: data } : { data }]; -}; diff --git a/test/index.js b/test/index.js index 369fb91..809f311 100755 --- a/test/index.js +++ b/test/index.js @@ -920,6 +920,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 = {}; @@ -949,6 +957,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()', () => { @@ -970,6 +986,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()', () => { @@ -983,6 +1007,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()', () => { From b2102b1d4618fb06c5688f3f6700b9d46787aa6f Mon Sep 17 00:00:00 2001 From: Gil Pedersen Date: Thu, 31 Oct 2024 11:54:02 +0100 Subject: [PATCH 42/45] Cleanup --- API.md | 2 +- lib/index.js | 10 ++++---- test/index.js | 70 ++++++++++++++++++--------------------------------- 3 files changed, 31 insertions(+), 51 deletions(-) diff --git a/API.md b/API.md index ab6953b..b0c0917 100755 --- a/API.md +++ b/API.md @@ -38,7 +38,7 @@ 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`. - - `cause` - The error that caused the boom error. + - `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. diff --git a/lib/index.js b/lib/index.js index 83fa569..9bd1f94 100755 --- a/lib/index.js +++ b/lib/index.js @@ -119,8 +119,10 @@ exports.Boom = class Boom extends Error { } static { - Object.defineProperty(this.prototype, 'name', { value: 'Boom', writable: true, configurable: true }); - Object.defineProperty(this.prototype, 'isBoom', { value: true, writable: true, configurable: true }); + Object.defineProperties(this.prototype, { + name: { value: 'Boom', writable: true, configurable: true }, + isBoom: { value: true, writable: true, configurable: true } + }); } }; @@ -407,7 +409,5 @@ exports.gatewayTimeout = internals.statusError(504, internals.serverError); exports.badImplementation = internals.statusError(500, (message, data) => { - const res = internals.serverError(message, data); - res.push({ isDeveloperError: true }); - return res; + return [...internals.serverError(message, data), { isDeveloperError: true }]; }); diff --git a/test/index.js b/test/index.js index 809f311..832af91 100755 --- a/test/index.js +++ b/test/index.js @@ -425,6 +425,17 @@ describe('Boom', () => { }); }); + const utilities = ['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' + ]; + describe('badRequest()', () => { it('returns a 400 error statusCode', () => { @@ -1055,25 +1066,22 @@ describe('Boom', () => { } }); }); - }); - describe('stack trace', () => { + it('uses data with Error as cause', () => { - const helpers = ['badRequest', 'unauthorized', 'forbidden', 'notFound', 'methodNotAllowed', - 'notAcceptable', 'proxyAuthRequired', 'clientTimeout', 'conflict', - 'resourceGone', 'lengthRequired', 'preconditionFailed', 'entityTooLarge', - 'uriTooLong', 'unsupportedMediaType', 'rangeNotSatisfiable', 'expectationFailed', - 'badData', 'preconditionRequired', 'tooManyRequests', + 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); + }); + }); - // 500s - 'internal', 'notImplemented', 'badGateway', 'serverUnavailable', - 'gatewayTimeout', 'badImplementation' - ]; + describe('stack trace', () => { it('should omit lib', () => { - for (const helper of helpers) { - const err = Boom[helper](); + for (const name of utilities) { + const err = Boom[name](); expect(err.stack).to.not.match(/(\/|\\)lib(\/|\\)index\.js/); } }); @@ -1082,10 +1090,10 @@ describe('Boom', () => { const captureStackTrace = Error.captureStackTrace; - for (const helper of helpers) { + for (const name of utilities) { try { Error.captureStackTrace = undefined; - var err = Boom[helper](); + var err = Boom[name](); } finally { Error.captureStackTrace = captureStackTrace; @@ -1098,35 +1106,7 @@ describe('Boom', () => { 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) => { - + for (const name of utilities) { it(`uses stringified error as message`, () => { const error = new Error('An example mongoose validation error'); @@ -1135,7 +1115,7 @@ describe('Boom', () => { expect(err.cause).to.not.exist(); expect(err.message).to.equal(error.toString()); }); - }); + } }); describe('reformat()', () => { From 46c282c9ef58281e6ba7a30971f0fe1c9e33bafc Mon Sep 17 00:00:00 2001 From: Gil Pedersen Date: Fri, 1 Nov 2024 10:29:58 +0100 Subject: [PATCH 43/45] Ignore all non-object headers option --- lib/index.js | 2 +- test/index.js | 8 ++++++++ 2 files changed, 9 insertions(+), 1 deletion(-) diff --git a/lib/index.js b/lib/index.js index 9bd1f94..9fa9d4b 100755 --- a/lib/index.js +++ b/lib/index.js @@ -212,7 +212,7 @@ internals.BoomOutput = class { constructor(statusCode, headers) { this.statusCode = statusCode; - this.headers = headers ? Hoek.clone(headers, { prototype: false, symbols: false }) : {}; + this.headers = typeof headers === 'object' ? Hoek.clone(headers, { prototype: false, symbols: false }) : {}; } }; diff --git a/test/index.js b/test/index.js index 832af91..b1db734 100755 --- a/test/index.js +++ b/test/index.js @@ -90,6 +90,14 @@ describe('Boom', () => { expect(headers).to.equal({ custom: ['yes'] }); }); + it('ignores non-object headers option', () => { + + const err = new Boom.Boom('fail', { statusCode: 400, headers: true }); + expect(err.output.payload.message).to.equal('fail'); + expect(err.output.statusCode).to.equal(400); + expect(err.output.headers).to.equal({}); + }); + it('throws when statusCode is invalid', () => { expect(() => { From 03302834b91c01adeaf1928689053bad8d90a130 Mon Sep 17 00:00:00 2001 From: Gil Pedersen Date: Mon, 4 Nov 2024 12:38:47 +0100 Subject: [PATCH 44/45] Shallow copy headers and throw when bad --- lib/index.d.ts | 2 +- lib/index.js | 18 ++++++++++++++++-- test/index.js | 15 ++++++++++----- 3 files changed, 27 insertions(+), 8 deletions(-) diff --git a/lib/index.d.ts b/lib/index.d.ts index d02d491..404529c 100755 --- a/lib/index.d.ts +++ b/lib/index.d.ts @@ -72,7 +72,7 @@ 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 }; + readonly headers?: { readonly [header: string]: string | readonly string[] | number } | undefined; /** * Constructor reference used to crop the exception call stack output diff --git a/lib/index.js b/lib/index.js index 9fa9d4b..6d125ee 100755 --- a/lib/index.js +++ b/lib/index.js @@ -168,6 +168,12 @@ internals.apply = function (boom, data, statusCode, headers, message) { throw new TypeError(`statusCode must be a number (400+): ${statusCode}`); } + if (headers !== undefined && + (headers === null || typeof headers !== 'object')) { + + throw new TypeError('headers must be an object'); + } + if (message) { boom.message = `${message}: ${boom.message}`; } @@ -212,7 +218,15 @@ internals.BoomOutput = class { constructor(statusCode, headers) { this.statusCode = statusCode; - this.headers = typeof headers === 'object' ? Hoek.clone(headers, { prototype: false, symbols: false }) : {}; + + const copy = Object.assign(Object.create(null), headers); + for (const [key, value] of Object.entries(copy)) { + if (Array.isArray(value)) { + copy[key] = value.slice(); + } + } + + this.headers = copy; } }; @@ -307,7 +321,7 @@ exports.methodNotAllowed = internals.statusError(405, (message, data, allow) => const headers = Array.isArray(allow) ? { Allow: allow.join(', ') - } : null; + } : undefined; return [message, { data, headers }]; }); diff --git a/test/index.js b/test/index.js index b1db734..8c34257 100755 --- a/test/index.js +++ b/test/index.js @@ -90,12 +90,17 @@ describe('Boom', () => { expect(headers).to.equal({ custom: ['yes'] }); }); - it('ignores non-object headers option', () => { + it('throws TypeError on non-object headers option', () => { - const err = new Boom.Boom('fail', { statusCode: 400, headers: true }); - expect(err.output.payload.message).to.equal('fail'); - expect(err.output.statusCode).to.equal(400); - expect(err.output.headers).to.equal({}); + expect(() => { + + new Boom.Boom('fail', { statusCode: 400, headers: true }); + }).to.throw(TypeError); + + expect(() => { + + new Boom.Boom('fail', { statusCode: 400, headers: null }); + }).to.throw(TypeError); }); it('throws when statusCode is invalid', () => { From 90a9361a97dd6989499c97a85328484852192b75 Mon Sep 17 00:00:00 2001 From: Gil Pedersen Date: Mon, 4 Nov 2024 12:39:37 +0100 Subject: [PATCH 45/45] Directly require escapeHeaderAttribute --- lib/index.js | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/lib/index.js b/lib/index.js index 6d125ee..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 = { @@ -275,14 +275,14 @@ exports.unauthorized = internals.statusError(401, (message, scheme, attributes) if (attributes) { if (typeof attributes === 'string') { - stringified += Hoek.escapeHeaderAttribute(attributes); + stringified += EscapeHeaderAttribute(attributes); } else { stringified += Object.keys(attributes).map((name) => { const value = attributes[name] ?? ''; - return `${name}="${Hoek.escapeHeaderAttribute(value.toString())}"`; + return `${name}="${EscapeHeaderAttribute(value.toString())}"`; }) .join(', '); } @@ -293,7 +293,7 @@ exports.unauthorized = internals.statusError(401, (message, scheme, attributes) stringified += ', '; } - stringified += `error="${Hoek.escapeHeaderAttribute(message)}"`; + stringified += `error="${EscapeHeaderAttribute(message)}"`; } else { decorate.isMissing = true;