error handling improved

Author: Robin Buschmann

api/ApiAbstract.ts

@@ -150,14 +150,14 @@ export abstract class ApiAbstract extends WebSocket {
 
     return constructor.name.replace(PREFIX, '').toLocaleLowerCase();
   }
-  
+
   getPlugs(req: express.Request, res: express.Response, next: any): void {
-    
+
     throw new NotImplementedError();
   }
-  
+
   getChargingFacilities(req: express.Request, res: express.Response, next: any): void {
-    
+
     throw new NotImplementedError();
   }
 
@@ -172,6 +172,11 @@ export abstract class ApiAbstract extends WebSocket {
     next();
   }
 
+  processErrors(err: any, req: express.Request, res: express.Response, next: any) {
+
+    res.sendStatus(HttpStatus.InternalServerError);
+  }
+
   // Helper
   // ===============================
 

api/ApiV1.ts

@@ -11,7 +11,6 @@ import {ApiAbstract} from "./ApiAbstract";
 import {CronService} from "../services/CronService";
 import {EVSEService} from "../services/EVSEService";
 import {UserService} from "../services/UserService";
-import {ParametersMissingError} from "../errors/ParametersMissingError";
 import {BadRequestError} from "../errors/BadRequestError";
 import {config} from "../config";
 import {IApiRequest} from "../interfaces/IApiRequest";
@@ -22,6 +21,8 @@ import {UserChargingService} from "../services/UserChargingService";
 import {UtilityService} from "../services/UtilityService";
 import {PlugService} from "../services/PlugService";
 import {ChargingFacilityService} from "../services/ChargingFacilityService";
+import {db} from "../db";
+import {logger} from "../logger";
 const request = require('request');
 
 @Inject
@@ -98,13 +99,7 @@ export class ApiV1 extends ApiAbstract {
     const data = req.body;
 
     Promise.resolve()
-      .then(() => {
-
-        if (!data.languageCode) {
-
-          throw new ParametersMissingError(['languageCode']);
-        }
-      })
+      .then(() => this.checkRequiredParameters(data, ['languageCode']))
       .then(() => this.userService.registerOrAuthenticate(
         data.languageCode, data.providerId, data.evcoId, data.password))
       .then((user) => res.json(user))
@@ -376,6 +371,46 @@ export class ApiV1 extends ApiAbstract {
       .catch(next)
   }
 
+  processErrors(err: any, req: express.Request, res: express.Response, next: any): any {
+
+    // log errors
+    // ------------------
+    logger.error(err);
+
+    // http response
+    // ------------------
+
+    // Security header for content sniffing
+    res.setHeader('X-Content-Type-Options', 'nosniff');
+
+    err = err || {message: 'unknown'};
+    const status = err.statusCode || HttpStatus.InternalServerError;
+    const secureToShow = err.secureToShow;
+
+    delete err.secureToShow;
+    delete err.statusCode;
+
+      if (secureToShow) {
+
+        res
+          .status(status)
+          .json(err)
+        ;
+      } else {
+
+        if (config.environment === 'development') {
+
+          res
+            .status(status)
+            .send(err && err.toString ? err.toString() : '')
+          ;
+        } else {
+
+          res.sendStatus(status);
+        }
+      }
+  }
+
 // WebSocket namespaces
 // ===============================
 

app.ts

@@ -10,17 +10,17 @@ import path = require('path');
 
 import {IApiRequest} from "./interfaces/IApiRequest";
 import {config} from "./config";
+import {logger} from "./logger";
 import {ApiAbstract} from "./api/ApiAbstract";
 import apis from "./api/api";
-import {logger} from "./logger";
-import {Injector} from 'di-ts';
-import {DataImporter} from "./services/DataImporter";
-import {SoapService} from "./services/SoapService";
 
 const nodeadmin = require('nodeadmin');
-const errorHandler = require('errorhandler');
 const app = express();
 
+// GENERAL CONFIGURATIONS
+// ----------------------------------------------
+app.disable('x-powered-by');
+
 
 // EXPRESS ENVIRONMENT VARIABLES
 // ----------------------------------------------
@@ -46,12 +46,7 @@ app.use(methodOverride('X-HTTP-Method-Override'));
 // middleware for api documentation
 app.use(express.static(path.join(__dirname, 'documentation')));
 
-// middleware showing errors as http response (errors will only shon in dev mode)
-if ('development' === app.get('env')) {
-  app.use(errorHandler())
-}
-
-// admin tool, accessible through "NodeAdmin/"
+// admin tool, accessible via "NodeAdmin/"
 app.use(nodeadmin(app));
 
 
@@ -121,27 +116,13 @@ app.get('/:apiVersion/charging-locations', (req: IApiRequest, res, next) => req.
 app.get('/:apiVersion/charging-locations/:id', (req: IApiRequest, res, next) => req.api.getChargingLocation(req, res, next));
 app.get('/:apiVersion/charging-locations/:id/evses', (req: IApiRequest, res, next) => req.api.getChargingLocationEVSEs(req, res, next));
 
+// error handler
+app.use((err, req: IApiRequest, res, next) => req.api.processErrors(err, req, res, next));
+
 
 // SERVER CREATION AND EXECUTION
 // ----------------------------------------------
 http.createServer(app).listen(
   app.get('port'),
   () => logger.info('Server listening on port ' + app.get('port'))
 );
-
-
-// SOME PREPARATION FOR DEVELOPMENT
-// ----------------------------------------------
-
-if ('development' === app.get('env')) {
-
-  if (config.dev.importMockData) {
-
-    const injector = new Injector();
-    const dataImporter = injector.get(DataImporter);
-
-    dataImporter.execute(require('./evseDataMock.json'))
-      .then(() => logger.info('(DEV) mock data successfully imported'))
-      .catch(err => logger.error('(DEV) mock data could not have been imported', err));
-  }
-}

config.ts

@@ -21,7 +21,7 @@ export var config = {
   },
   soap: {
     initialize: getEnvVariable('SOAP_INIT') === 'true',
-    timeout: 1000 * 60 * 5,
+    timeout: 1000 * 60 * 15, // 15min
     providerId: 'DE*ICE',
     geoFormat: 'Google',
     authorizeEvseId: 'DE*APP*E000123',

errors/BadRequestError.ts

@@ -1,9 +1,12 @@
-export class BadRequestError extends Error {
+import {BaseError} from "./BaseError";
+
+export class BadRequestError extends BaseError {
 
   statusCode = HttpStatus.BadRequest;
 
   constructor(public message: string){
-    super();
+    
+    super(true);
   }
 
 }

errors/BaseError.ts

@@ -0,0 +1,10 @@
+export class BaseError extends Error {
+
+  constructor(
+    // indicates if this error can be passed to the client
+    public secureToShow: boolean
+  ) {
+    super();
+  }
+
+}

errors/HubjectError.ts

@@ -0,0 +1,11 @@
+import {BaseError} from "./BaseError";
+
+export class HubjectError extends BaseError {
+
+  constructor(public hubjectErrorCode: string,
+              public message: string,
+              public statusCode: HttpStatus) {
+
+    super(true);
+  }
+}

errors/InvalidDataError.ts

@@ -1,9 +1,12 @@
-export class InvalidDataError extends Error {
+import {BaseError} from "./BaseError";
+
+export class InvalidDataError extends BaseError {
 
   statusCode = HttpStatus.BadRequest;
 
   constructor(public message: string){
-    super();
+    
+    super(true);
   }
 
 }

errors/NotAuthorizedError.ts

@@ -1,8 +1,11 @@
-export class NotAuthorizedError extends Error {
-  
+import {BaseError} from "./BaseError";
+
+export class NotAuthorizedError extends BaseError {
+
   statusCode = HttpStatus.Unauthorized;
 
   constructor(public message: string) {
-    super(message);
+
+    super(true);
   }
 }

errors/NotImplementedError.ts

@@ -1,7 +1,12 @@
+import {BaseError} from "./BaseError";
 
-export class NotImplementedError extends Error {
+export class NotImplementedError extends BaseError {
 
   statusCode = HttpStatus.NotFound;
   message: string  = 'This resource is not implemented on this version';
 
+  constructor() {
+    
+    super(true);
+  }
 }