leasehold-http-api/fittings/lisk_error_handler.js

HTTP API module for Leasehold sidechain

/*
 * Copyright © 2019 Lisk Foundation
 *
 * See the LICENSE file at the top-level directory of this distribution
 * for licensing information.
 *
 * Unless otherwise agreed in a custom licensing agreement with the Lisk Foundation,
 * no part of this software, including this file, may be copied, modified,
 * propagated, or distributed except according to the terms contained in the
 * LICENSE file.
 *
 * Removal or modification of this copyright notice is prohibited.
 */

'use strict';

const util = require('util');
const debug = require('debug')('swagger:lisk:error_handler');

/**
 * Description of the function.
 *
 * @func create_error_handler
 * @memberof api.fittings
 * @requires debug
 * @requires util
 * @param {Object} fittingDef
 * @param {Object} bagpipes
 * @returns {function} {@link api.fittings.lisk_error_handler}
 * @todo Add description for the function and the params
 */
module.exports = function create(fittingDef) {
	debug('config: %j', fittingDef);

	/**
	 * Description of the function.
	 *
	 * @func lisk_error_handler
	 * @memberof api.fittings
	 * @param {Object} context
	 * @param {function} cb
	 * @todo Add description for the function and the params
	 */
	return function lisk_error_handler(context, next) {
		if (!util.isError(context.error)) {
			return next();
		}

		let err = context.error;

		if (!context.statusCode || context.statusCode < 400) {
			if (
				context.response &&
				context.response.statusCode &&
				context.response.statusCode >= 400
			) {
				context.statusCode = context.response.statusCode;
			} else if (err.statusCode && err.statusCode >= 400) {
				context.statusCode = err.statusCode;
				delete err.statusCode;
			} else {
				context.statusCode = 500;
			}
		}

		debug('exec: %s', context.error.message);
		debug('status: %s', context.statusCode);
		debug('stack: %s', context.error.stack);

		if (context.statusCode === 500) {
			if (!fittingDef.handle500Errors) {
				return next(err);
			}

			err = {
				message: 'An unexpected error occurred while handling this request',
			};
		}

		context.headers['Content-Type'] = 'application/json';
		Object.defineProperty(err, 'message', { enumerable: true }); // Include message property in response
		delete context.error;
		return next(null, JSON.stringify(err));
	};
};