Kegan Dougal
5ed4e9f535
Previously, non-JSON responses would be missing the `httpStatus` property, which was different to how `request()` used to work. Ensure we always send this property, even for non-JSON responses.
84 lines
2.9 KiB
TypeScript
84 lines
2.9 KiB
TypeScript
/*
|
|
Copyright 2022 The Matrix.org Foundation C.I.C.
|
|
|
|
Licensed under the Apache License, Version 2.0 (the "License");
|
|
you may not use this file except in compliance with the License.
|
|
You may obtain a copy of the License at
|
|
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
Unless required by applicable law or agreed to in writing, software
|
|
distributed under the License is distributed on an "AS IS" BASIS,
|
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
See the License for the specific language governing permissions and
|
|
limitations under the License.
|
|
*/
|
|
|
|
import { IUsageLimit } from "../@types/partials";
|
|
|
|
interface IErrorJson extends Partial<IUsageLimit> {
|
|
[key: string]: any; // extensible
|
|
errcode?: string;
|
|
error?: string;
|
|
}
|
|
|
|
/**
|
|
* Construct a generic HTTP error. This is a JavaScript Error with additional information
|
|
* specific to HTTP responses.
|
|
* @constructor
|
|
* @param {string} msg The error message to include.
|
|
* @param {number} httpStatus The HTTP response status code.
|
|
*/
|
|
export class HTTPError extends Error {
|
|
constructor(msg: string, public readonly httpStatus?: number) {
|
|
super(msg);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Construct a Matrix error. This is a JavaScript Error with additional
|
|
* information specific to the standard Matrix error response.
|
|
* @constructor
|
|
* @param {Object} errorJson The Matrix error JSON returned from the homeserver.
|
|
* @prop {string} errcode The Matrix 'errcode' value, e.g. "M_FORBIDDEN".
|
|
* @prop {string} name Same as MatrixError.errcode but with a default unknown string.
|
|
* @prop {string} message The Matrix 'error' value, e.g. "Missing token."
|
|
* @prop {Object} data The raw Matrix error JSON used to construct this object.
|
|
* @prop {number} httpStatus The numeric HTTP status code given
|
|
*/
|
|
export class MatrixError extends HTTPError {
|
|
public readonly errcode?: string;
|
|
public readonly data: IErrorJson;
|
|
|
|
constructor(errorJson: IErrorJson = {}, public readonly httpStatus?: number, public url?: string) {
|
|
let message = errorJson.error || "Unknown message";
|
|
if (httpStatus) {
|
|
message = `[${httpStatus}] ${message}`;
|
|
}
|
|
if (url) {
|
|
message = `${message} (${url})`;
|
|
}
|
|
super(`MatrixError: ${message}`, httpStatus);
|
|
this.errcode = errorJson.errcode;
|
|
this.name = errorJson.errcode || "Unknown error code";
|
|
this.data = errorJson;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Construct a ConnectionError. This is a JavaScript Error indicating
|
|
* that a request failed because of some error with the connection, either
|
|
* CORS was not correctly configured on the server, the server didn't response,
|
|
* the request timed out, or the internet connection on the client side went down.
|
|
* @constructor
|
|
*/
|
|
export class ConnectionError extends Error {
|
|
constructor(message: string, cause?: Error) {
|
|
super(message + (cause ? `: ${cause.message}` : ""));
|
|
}
|
|
|
|
get name() {
|
|
return "ConnectionError";
|
|
}
|
|
}
|