Source: client/errors.js

  1. /*
  2.  * Copyright 2023, TeamDev. All rights reserved.
  3.  *
  4.  * Licensed under the Apache License, Version 2.0 (the "License");
  5.  * you may not use this file except in compliance with the License.
  6.  * You may obtain a copy of the License at
  7.  *
  8.  * http://www.apache.org/licenses/LICENSE-2.0
  9.  *
  10.  * Redistribution and use in source and/or binary forms, with or without
  11.  * modification, must retain the above copyright notice and the following
  12.  * disclaimer.
  13.  *
  14.  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  15.  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  16.  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  17.  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  18.  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  19.  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  20.  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  21.  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  22.  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  23.  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  24.  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  25.  */
  27. "use strict";
  29. import {Error as SpineBaseError} from '../proto/spine/base/error_pb';
  30. import {ValidationError} from '../proto/spine/validate/validation_error_pb';
  31. import {isProtobufMessage} from './typed-message';
  33. /**
  34.  * The base error type of Spine Web. This error type is only used directly when a
  35.  * more appropriate category is not defined for the offending error.
  36.  *
  37.  * @extends Error
  38. */
  39. export class SpineError extends Error {
  41.   /**
  42.    * @param {!string} message the human-readable error message
  43.    * @param {*=} cause        the reason why this error occurred
  44.    */
  45.   constructor(message, cause) {
  46.     super(message);
  47.     this.name = this.constructor.name;
  48.     this._cause = cause;
  49.   }
  51.   /**
  52.    * @return {*|undefined} The cause of this error, if available.
  53.    */
  54.   getCause() {
  55.     return this._cause;
  56.   }
  57. }
  59. /**
  60.  * An error which occurs when sending off a request to Spine server endpoint fails due to the
  61.  * connection problems.
  62.  *
  63.  * Can be caused by an incorrect server address, lack of network connectivity or
  64.  * if the response is not received from the server.
  65.  *
  66.  * @extends SpineError
  67.  */
  68. export class ConnectionError extends SpineError {
  70.   /**
  71.    * @param {!Error} error the error caught from {@code fetch} invocation
  72.    */
  73.   constructor(error) {
  74.     super(error.message, error);
  75.   }
  76. }
  78. /**
  79.  * An error which occurs when sending off a request to Spine server endpoint results
  80.  * with a response with `5xx` status code.
  81.  *
  82.  * @extends SpineError
  83.  */
  84. export class ServerError extends SpineError {
  86.   /**
  87.    * @param {!Response} response the server response caused this error
  88.    */
  89.   constructor(response) {
  90.     super(response.statusText, response);
  91.   }
  92. }
  94. /**
  95.  * An error which occurs when sending off a request to Spine server endpoint results
  96.  * with a response with `4xx` status code.
  97.  *
  98.  * @extends SpineError
  99.  */
  100. export class ClientError extends SpineError {
  102.   /**
  103.    * @param {!string} message the human-readable error message
  104.    * @param {*=} cause        the reason why this error occurred
  105.    */
  106.   constructor(message, cause) {
  107.     super(message, cause);
  108.   }
  109. }
  111. /**
  112.  * An error which occurs when sending off a command to Spine server endpoint.
  113.  *
  114.  * @extends SpineError
  115.  */
  116. export class CommandHandlingError extends SpineError {
  118.   /**
  119.    * @param {!string} message the human-readable error message
  120.    * @param {!Error|SpineError|SpineBaseError} error the reason why this error occurred
  121.    */
  122.   constructor(message, error) {
  123.     super(message, error);
  124.   }
  126.   /**
  127.    * Returns `true` if the command wasn't accepted by the server; returns `false`
  128.    * if this is not guaranteed.
  129.    *
  130.    * A command is assumed neglected if this error is caused by the `ClientError`
  131.    * or the `SpineBaseError`.
  132.    *
  133.    * @return {boolean}
  134.    */
  135.   assuresCommandNeglected() {
  136.     const cause = this.getCause();
  137.     return cause instanceof ClientError
  138.         || isProtobufMessage(cause) && cause.constructor.typeUrl() === SpineBaseError.typeUrl();
  139.   }
  140. }
  142. /**
  143.  * An error which occurs when sending off a command to Spine server endpoint results
  144.  * with a response indicating that a command message was rejected further processing
  145.  * because of a validation error.
  146.  *
  147.  * @extends CommandHandlingError
  148.  */
  149. export class CommandValidationError extends CommandHandlingError {
  151.   /**
  152.    * @param {!string} message the human-readable error message
  153.    * @param {!SpineBaseError} error the command validation error
  154.    */
  155.   constructor(message, error) {
  156.     super(message, error);
  157.   }
  159.   /**
  160.    * @return {ValidationError} command validation error
  161.    */
  162.   validationError() {
  163.     return this.getCause().getValidationError();
  164.   }
  165. }