src/errors/ApiError.js
/*
* BSD 3-Clause License
*
* Copyright (c) 2020, Mapcreator
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* Redistributions of source code must retain the above copyright notice, this
* list of conditions and the following disclaimer.
*
* Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* Neither the name of the copyright holder nor the names of its
* contributors may be used to endorse or promote products derived from
* this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
* CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
/**
* Errors generated by the API
*/
export default class ApiError extends Error {
/**
* Get the request options
* @type {Object}
*/
options;
/**
* Get the response
* @type {Response}
*/
response;
/**
* Get the request
* @type {Request}
*/
request;
/**
* Error type
* @type {String}
*/
type;
/**
* Http error code
* @type {Number}
*/
status;
/**
* Get the parsed stacktrace from the error
* @returns {Array<{line: Number, file: String, code: String}>} - Stacktrace
*/
trace;
/**
* @param {Object} params
* @param {Object} params.options - Request options
* @param {Object} params.data - Response data
* @param {Request} params.request - Request
* @param {Response} params.response - Response
*/
constructor ({ options, request, response, data }) {
const { type, message, trace } = data.error;
super(message);
this.options = options;
this.response = response;
this.request = request;
this.type = type;
this.trace = [];
// Only available when the api is in debug mode
if (typeof trace === 'string') {
this._trace = ApiError._parseTrace(trace);
}
}
/**
* Returns if the error contained a stacktrace that has been parsed
* This should only be true if the API is in debug mode.
* @returns {boolean} - If the Error contains a stacktrace
*/
get hasTrace () {
return this.trace.length > 0;
}
/**
* Display-able string
* @returns {string} - Displayable error string
*/
toString () {
return `[${this.status}] ${this.type}: ${this.message}`;
}
static _parseTrace (input) {
// https://regex101.com/r/64cAbt/1
const regex = /^#(\d+)\s(?:(.*?)\((\d+)\)|(.*?)):\s(.*?)$/gm;
const output = [];
let match;
// eslint-disable-next-line no-cond-assign
while ((match = regex.exec(input)) !== null) {
// This is necessary to avoid infinite loops with zero-width matches
if (match.index === regex.lastIndex) {
regex.lastIndex++;
}
output.push({
line: match[3],
file: match[2] || match[4],
code: match[5],
});
}
return output;
}
}