Added error hanling logic #44

.eslintrc

@@ -4,6 +4,9 @@
     "airbnb",
     "plugin:jsx-a11y/recommended"
   ],
+  "globals": {
+    "Kit": true
+  },
   "env": {
     "node": true,
     "browser": true,

README.md

@@ -2,6 +2,14 @@
 
 This starter kit is designed to help you start project as soon as possible. It contain all necessary things to develop and maintain a project.
 
+## Before start
+
+You need to read these docs: 
+
+1. [Error handling](/docs/error.md)
+
+Remove all code which we use for showing template opportunities. We left indicator for every place which need to remove `// REMOVE_PROD`
+
 ## Getting started
 
 In this project we used [ESLint](https://eslint.org/docs/user-guide/integrations#editors) and [Stylelint](https://stylelint.io/user-guide/complementary-tools/#editor-plugins), so at the beginning check your code editor plugins or settings to support these linters.

client/components/common/Navigation.jsx

@@ -15,6 +15,9 @@ const Navigation = () => (
         <li role="menuitem">
           <NavLink to="/form-components">Form components</NavLink>
         </li>
+        <li role="menuitem">
+          <NavLink to="/example-components">Example page</NavLink>
+        </li>
       </ul>
     </div>
   </nav>

client/pages/Example.jsx

@@ -0,0 +1,30 @@
+import React, { Component } from 'react';
+
+import { Button } from 'Form';
+
+class ExampleComponents extends Component {
+  state = {
+    error: '',
+  }
+
+  showError = () => {
+    fetch('/api/test/error')
+      .then(response => response.json())
+      .then(data => this.setState({ error: JSON.stringify(data) }));
+  }
+
+  render() {
+    const { error } = this.state;
+
+    return (
+      <div className="container">
+        <Button className="red" onClick={this.showError}>Show Error Message</Button>
+        <p>
+          {`Error: ${error}`}
+        </p>
+      </div>
+    );
+  }
+}
+
+export default ExampleComponents;

client/routing/Routes.jsx

@@ -5,6 +5,7 @@ import MainLayout from 'Layout/Main';
 
 import Index from 'Pages/Index';
 import FormComponents from 'Pages/FormComponents';
+import ExampleComponents from 'Pages/Example';
 import NoMatch from 'Pages/NoMatch';
 
 const Routes = () => (
@@ -13,6 +14,7 @@ const Routes = () => (
       <Switch>
         <Route path="/" component={Index} exact />
         <Route path="/form-components" component={FormComponents} />
+        <Route path="/example-components" component={ExampleComponents} />
         <Route component={NoMatch} />
       </Switch>
     </MainLayout>

docs/error.md

@@ -0,0 +1,127 @@
+# Error handling
+
+This is a document how we most work with **Error** on current project.
+
+For correct works with **Error** in project please read [this article](https://expressjs.com/en/guide/error-handling.html) and use `Kit.CustomError` as `Error` object
+
+Example of handling:
+
+```js
+router.get('/error', (req, res, next) => {
+  try {
+    // ...some code
+  } catch(e) {
+    next(new Kit.CustomError('UNAUTHORIZED_ACCESS', 401));
+  }
+});
+```
+
+## Error structure
+
+This structure you must send to client when error is happened and you can get this structure from `Kit.CustomError` by `.get()` method
+
+```js
+{
+  "errors": [
+    {
+      "parameter": "start_time",
+      "details": "invalid date",
+      "code": "INVALID_PARAMETER",
+      "value": "",
+      "message": "Expected time, got \"\" for start_time",
+      "userMessage": "Expected time, got \"\" for start_time"
+    }
+  ],
+  "request": {
+    "params": {
+      "account_id": "hkk5"
+    }
+  },
+  "metadata": {}
+}
+```
+
+## Error codes & what they mean
+
+<table>
+  <thead>
+    <tr>
+      <th>HTTP Code</th>
+      <th>Error Code</th>
+    </tr>
+  </thead>
+  <tbody>
+    <tr>
+      <td>403</td>
+      <td>ACCOUNT_NOT_FOUND</td>
+    </tr>
+    <tr>
+      <td>403</td>
+      <td>ACTION_NOT_ALLOWED</td>
+    </tr>
+    <tr>
+      <td>400</td>
+      <td>EXCLUSIVE_PARAMETERS</td>
+    </tr>
+    <tr>
+      <td>400</td>
+      <td>FEATURE_NOT_AVAILABLE</td>
+    </tr>
+    <tr>
+      <td>400</td>
+      <td>ILLEGAL_CHARACTERS</td>
+    </tr>
+    <tr>
+      <td>500</td>
+      <td>INTERNAL_ERROR</td>
+    </tr>
+    <tr>
+      <td>400</td>
+      <td>INVALID_PARAMETER</td>
+    </tr>
+    <tr>
+      <td>400</td>
+      <td>INVALID_USER</td>
+    </tr>
+    <tr>
+      <td>400</td>
+      <td>INVALID_USER_ID</td>
+    </tr>
+    <tr>
+      <td>400</td>
+      <td>MISSING_PARAMETERS</td>
+    </tr>
+    <tr>
+      <td>404</td>
+      <td>NOT_FOUND</td>
+    </tr>
+    <tr>
+      <td>400</td>
+      <td>REQUEST_TOO_COMPLEX</td>
+    </tr>
+    <tr>
+      <td>404</td>
+      <td>ROUTE_NOT_FOUND</td>
+    </tr>
+    <tr>
+      <td>503</td>
+      <td>SERVICE_UNAVAILABLE</td>
+    </tr>
+    <tr>
+      <td>503</td>
+      <td>OVER_CAPACITY</td>
+    </tr>
+    <tr>
+      <td>429</td>
+      <td>TOO_MANY_REQUESTS</td>
+    </tr>
+    <tr>
+      <td>401</td>
+      <td>UNAUTHORIZED_ACCESS</td>
+    </tr>
+    <tr>
+      <td>403</td>
+      <td>USER_NOT_FOUND</td>
+    </tr>
+  </tbody>
+</table>

server/config/error.js

@@ -0,0 +1,97 @@
+module.exports = {
+  ACCOUNT_NOT_FOUND: {
+    message: 'Account not found',
+    userMessage: 'Account not found',
+    code: 403,
+  },
+  ACTION_NOT_ALLOWED: {
+    message: 'Action not allowed',
+    userMessage: 'Action not allowed',
+    code: 403,
+  },
+  EXCLUSIVE_PARAMETERS: {
+    message: 'Exclusive parameters',
+    userMessage: 'Exclusive parameters',
+    code: 400,
+  },
+  FEATURE_NOT_AVAILABLE: {
+    message: 'Feature not available',
+    userMessage: 'Feature not available',
+    code: 400,
+  },
+  ILLEGAL_CHARACTERS: {
+    message: 'Illegal characters',
+    userMessage: 'Illegal characters',
+    code: 400,
+  },
+  INTERNAL_ERROR: {
+    message: 'Server error',
+    userMessage: 'Server error',
+    code: 500,
+  },
+  INVALID_PARAMETER: {
+    message: 'Invalid parameter',
+    userMessage: 'Invalid parameter',
+    code: 400,
+  },
+  INVALID_USER: {
+    message: 'Invalid user',
+    userMessage: 'Invalid user',
+    code: 400,
+  },
+  INVALID_USER_ID: {
+    message: 'Invalid user ID',
+    userMessage: 'Invalid user ID',
+    code: 400,
+  },
+  MISSING_PARAMETERS: {
+    message: 'Missing parameters',
+    userMessage: 'Missing parameters',
+    code: 400,
+  },
+  NOT_FOUND: {
+    message: 'Not Found',
+    userMessage: 'Not Found',
+    code: 404,
+  },
+  REQUEST_TOO_COMPLEX: {
+    message: 'Request too complex',
+    userMessage: 'Request too complex',
+    code: 400,
+  },
+  ROUTE_NOT_FOUND: {
+    message: 'Route not found',
+    userMessage: 'Route not found',
+    code: 404,
+  },
+  SERVICE_UNAVAILABLE: {
+    message: 'Service unavailable',
+    userMessage: 'Service unavailable',
+    code: 503,
+  },
+  OVER_CAPACITY: {
+    message: 'Over capacity',
+    userMessage: 'Over capacity',
+    code: 503,
+  },
+  TOO_MANY_REQUESTS: {
+    message: 'Too many request',
+    userMessage: 'Too many request',
+    code: 429,
+  },
+  UNAUTHORIZED_ACCESS: {
+    message: 'Unathorized access',
+    userMessage: 'Unathorized access',
+    code: 401,
+  },
+  USER_NOT_FOUND: {
+    message: 'User not found',
+    userMessage: 'User not found',
+    code: 403,
+  },
+  FORBIDDEN: {
+    message: 'Forbidden',
+    userMessage: 'Forbidden',
+    code: 403,
+  },
+};

server/index.js

@@ -9,9 +9,14 @@ const methodOverride = require('method-override');
 const swaggerUIDist = require('swagger-ui-dist');
 
 const routes = require('./routes/index.route');
+const CustomError = require('./utils/error');
+const errorHandler = require('./middlewares/error');
 
 require('dotenv-safe').config();
 
+global.Kit = {};
+Kit.CustomError = CustomError;
+
 const app = express();
 app.db = require('./models');
 
@@ -35,6 +40,8 @@ if (!isProduction) {
 
 app.get('/*', (req, res) => res.sendFile(path.join(__dirname, `../${isProduction ? 'dist' : 'client'}/index.html`)));
 
+app.use(errorHandler);
+
 const port = process.env.APP_PORT || 3001;
 const host = process.env.APP_HOST || 'localhost';
 

server/middlewares/error.js

@@ -0,0 +1,19 @@
+function errorHandling(err, req, res, next) {
+  if (res.headersSent) {
+    return next(err);
+  }
+
+  res.status(err.code);
+  return res.json(err.get());
+}
+
+// process.on('unhandledRejection', (err) => {
+//   console.error(err);
+// });
+
+// process.on('uncaughtException', (err) => {
+//   console.error(err);
+//   process.exit(1);
+// });
+
+module.exports = errorHandling;

server/routes/index.route.js

@@ -2,6 +2,8 @@ const express = require('express');
 
 const authRoutes = require('./auth.route');
 const userRoutes = require('./user.route');
+// REMOVE_PROD: in real app you need remove this variable
+const testRoutes = require('./test.route');
 
 const router = express.Router();
 
@@ -11,4 +13,8 @@ router.use('/auth', authRoutes);
 // mount user routes at /user
 router.use('/user', userRoutes);
 
+// REMOVE_PROD: in real app you need remove this route
+router.use('/test', testRoutes);
+
+
 module.exports = router;

server/routes/test.route.js

@@ -0,0 +1,9 @@
+const express = require('express');
+
+const router = express.Router();
+
+router.get('/error', (req, res, next) => {
+  next(new Kit.CustomError('UNAUTHORIZED_ACCESS', 401));
+});
+
+module.exports = router;