Feature/trn 28/improve network errors

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@oat-sa/tao-core-sdk",
-  "version": "1.7.0",
+  "version": "1.8.0",
   "displayName": "TAO Core SDK",
   "description": "Core libraries of TAO",
   "homepage": "https://github.com/oat-sa/tao-core-sdk-fe#readme",

src/core/error/ApiError.js

@@ -0,0 +1,49 @@
+/**
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation; under version 2
+ * of the License (non-upgradable).
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+ *
+ * Copyright (c) 2020 (original work) Open Assessment Technologies SA ;
+ */
+
+import errorTypes from 'core/error/types';
+
+/**
+ * Errors sent by HTTP API / backend
+ */
+//eslint-disable-next-line
+export default class ApiError extends Error {
+
+    /**
+     * Instantiate an error
+     * @param {string} message - the error message
+     * @param {number} errorCode - the API error code
+     * @param {Object} response - the full response object
+     * @param {boolean} [recoverable=true] - can the user recover after having such error ?
+     * @param {...} params - additional error parameters (line, etc.)
+     */
+    constructor(message, errorCode, response, recoverable = true, ...params) {
+        super(message, ...params);
+
+        if (Error.captureStackTrace) {
+            Error.captureStackTrace(this, ApiError);
+        }
+
+        this.name = 'ApiError';
+        this.message = message;
+        this.errorCode = errorCode;
+        this.response = response;
+        this.recoverable = !!recoverable;
+        this.type = errorTypes.api;
+    }
+}

src/core/error/AuthError.js

@@ -0,0 +1,45 @@
+/**
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation; under version 2
+ * of the License (non-upgradable).
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+ *
+ * Copyright (c) 2020 (original work) Open Assessment Technologies SA ;
+ */
+
+import errorTypes from 'core/error/types';
+
+/**
+ * Error due to client side authentication mechanisms
+ */
+//eslint-disable-next-line
+export default class AuthError extends Error {
+
+    /**
+     * Instantiate an error
+     * @param {string} message - the error message
+     * @param {Boolean} [recoverable=true] - can the user recover after having such error ?
+     * @param {...} params - additional error parameters (line, etc.)
+     */
+    constructor(message, recoverable = true, ...params) {
+        super(message, ...params);
+
+        if (Error.captureStackTrace) {
+            Error.captureStackTrace(this, AuthError);
+        }
+
+        this.name = 'AuthError';
+        this.message = message;
+        this.recoverable = !!recoverable;
+        this.type = errorTypes.auth;
+    }
+}

src/core/error/NetworkError.js

@@ -0,0 +1,49 @@
+/**
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation; under version 2
+ * of the License (non-upgradable).
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+ *
+ * Copyright (c) 2020 (original work) Open Assessment Technologies SA ;
+ */
+
+import errorTypes from 'core/error/types';
+
+/**
+ * Network errors
+ */
+//eslint-disable-next-line
+export default class NetworkError extends Error {
+
+    /**
+     * Instantiate an error
+     * @param {string} message - the error message
+     * @param {number} [errorCode] - the HTTP status if any
+     * @param {Object} [response] - the full response object if any
+     * @param {boolean} [recoverable=true] - can the user recover after having such error ?
+     * @param {...} params - additional error parameters (line, etc.)
+     */
+    constructor(message, errorCode, response, recoverable = true, ...params) {
+        super(message, ...params);
+
+        if (Error.captureStackTrace) {
+            Error.captureStackTrace(this, NetworkError);
+        }
+
+        this.name = 'NetworkError';
+        this.message = message;
+        this.errorCode = errorCode;
+        this.response = response;
+        this.recoverable = !!recoverable;
+        this.type = errorTypes.network;
+    }
+}

src/core/error/RenderingError.js

@@ -0,0 +1,45 @@
+/**
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation; under version 2
+ * of the License (non-upgradable).
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+ *
+ * Copyright (c) 2020 (original work) Open Assessment Technologies SA ;
+ */
+
+import errorTypes from 'core/error/types';
+
+/**
+ * Error in rendering
+ */
+//eslint-disable-next-line
+export default class RenderingError extends Error {
+
+    /**
+     * Instantiate an error
+     * @param {string} message - the error message
+     * @param {Boolean} [recoverable=true] - can the user recover after having such error ?
+     * @param {...} params - additional error parameters (line, etc.)
+     */
+    constructor(message, recoverable = true, ...params) {
+        super(message, ...params);
+
+        if (Error.captureStackTrace) {
+            Error.captureStackTrace(this, RenderingError);
+        }
+
+        this.name = 'RenderingError';
+        this.message = message;
+        this.recoverable = !!recoverable;
+        this.type = errorTypes.rendering;
+    }
+}

src/core/error/TimeoutError.js

@@ -0,0 +1,47 @@
+/**
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation; under version 2
+ * of the License (non-upgradable).
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+ *
+ * Copyright (c) 2020 (original work) Open Assessment Technologies SA ;
+ */
+
+import errorTypes from 'core/error/types';
+
+/**
+ * Error when an action times out
+ */
+//eslint-disable-next-line
+export default class TimeoutError extends Error {
+
+    /**
+     * Instantiate an error
+     * @param {string} message - the error message
+     * @param {number} timeout - the timeout value
+     * @param {boolean} [recoverable=true] - can the user recover after having such error ?
+     * @param {...} params - additional error parameters (line, etc.)
+     */
+    constructor(message, timeout, recoverable = true, ...params) {
+        super(message, ...params);
+
+        if (Error.captureStackTrace) {
+            Error.captureStackTrace(this, TimeoutError);
+        }
+
+        this.name = 'TimeoutError';
+        this.message = message;
+        this.timeout = timeout;
+        this.recoverable = !!recoverable;
+        this.type = errorTypes.timeout;
+    }
+}

src/core/error/UserError.js

@@ -0,0 +1,45 @@
+/**
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation; under version 2
+ * of the License (non-upgradable).
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+ *
+ * Copyright (c) 2020 (original work) Open Assessment Technologies SA ;
+ */
+
+import errorTypes from 'core/error/types';
+
+/**
+ * Error due to wrong user input
+ */
+//eslint-disable-next-line
+export default class UserError extends Error {
+
+    /**
+     * Instantiate an error
+     * @param {string} message - the error message
+     * @param {boolean} [recoverable=true] - can the user recover after having such error ?
+     * @param {...} params - additional error parameters (line, etc.)
+     */
+    constructor(message, recoverable = true, ...params) {
+        super(message, ...params);
+
+        if (Error.captureStackTrace) {
+            Error.captureStackTrace(this, UserError);
+        }
+
+        this.name = 'UserError';
+        this.message = message;
+        this.recoverable = !!recoverable;
+        this.type = errorTypes.user;
+    }
+}

src/core/error/types.js

@@ -0,0 +1,37 @@
+/**
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation; under version 2
+ * of the License (non-upgradable).
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+ *
+ * Copyright (c) 2020 (original work) Open Assessment Technologies SA ;
+ */
+
+export default Object.freeze({
+    // the server API is not successful: 500, 412, 403, etc.
+    api: 'api',
+
+    // any network error: CORS, offline, etc.
+    network: 'network',
+
+    // timeout error: an action cannot be performed in the given time
+    timeout: 'timeout',
+
+    // authentication: internal error about authentication (token pool issue, etc.)
+    auth: 'auth',
+
+    // errors due to user's input: wrong data range, etc.
+    user: 'user',
+
+    // rendering error: an interface, a component fails to render
+    rendering: 'rendering'
+});