Add translations to errors

.env.example

@@ -36,7 +36,11 @@ SWAGGER_BASE_URL=localhost:3000
 ## Authentication
 JWT_SECRET=
 
-## New Relic
+## Translations
+TRANSLATION_API_URL=
+TRANSLATION_API_TOKEN=
+
+## Tracking
 NEW_RELIC_LICENSE_KEY=
 
 ## Optional

.gitignore

@@ -35,3 +35,6 @@ yarn-error.log
 
 # Database data
 data
+
+# Translations
+locales/

package.json

@@ -25,7 +25,7 @@
     "dotenv-safe": "~5.0.1",
     "express": "~4.16.2",
     "express-validation": "^1.0.2",
-    "http-status": "~1.0.1",
+    "http-status": "~1.1.0",
     "joi": "~13.2.0",
     "jsonade": "~1.1.0",
     "knex": "~0.14.6",
@@ -34,9 +34,9 @@
     "newrelic": "~4.1.0",
     "pg": "~7.4.1",
     "redis": "~2.8.0",
-    "tree-house": "~3.2.0",
+    "tree-house": "~3.3.0",
     "tree-house-authentication": "~2.0.5",
-    "tree-house-errors": "~1.0.3",
+    "tree-house-errors": "~1.1.1",
     "uuid": "~3.2.1",
     "winston": "~2.4.2"
   },
@@ -49,7 +49,7 @@
     "@types/helmet": "~0.0.37",
     "@types/http-status": "~0.2.30",
     "@types/jest": "~22.2.2",
-    "@types/joi": "~13.0.7",
+    "@types/joi": "~13.0.8",
     "@types/knex": "~0.14.12",
     "@types/lodash": "~4.14.108",
     "@types/mandrill-api": "~1.0.30",
@@ -58,7 +58,7 @@
     "@types/uuid": "~3.4.3",
     "@types/winston": "~2.3.9",
     "auditjs": "^2.4.3",
-    "coveralls": "^3.0.0",
+    "coveralls": "^3.0.1",
     "faker": "^4.1.0",
     "jest": "^22.4.3",
     "node-mocks-http": "^1.5.8",

src/app.ts

@@ -32,7 +32,7 @@ for (const x in appConfig.VERSIONS) {
 }
 
 // Error handling
-app.use((error, _req, res, _next) => responder.error(res, error));
+app.use((error, req, res, _next) => responder.error(req, res, error));
 app.all('*', (_req, res) => res.sendStatus(404));
 
 export { app };

src/config/errors.config.ts

@@ -1,7 +1,7 @@
-import { errors as defaults } from 'tree-house-errors';
+import { errors as defaults, ErrorType } from 'tree-house-errors';
 
 // tslint:disable:max-line-length
-export const errors = Object.assign({}, defaults, {
+export const errors = <Error>Object.assign({}, defaults, {
   USER_INACTIVE:      { code: 'USER_INACTIVE', message: 'Activate user account before login' },
   USER_DUPLICATE:     { code: 'USER_DUPLICATE', message: 'A user with this email already exists' },
   USER_NOT_FOUND:     { code: 'USER_NOT_FOUND', message: 'User not found' },
@@ -11,3 +11,7 @@ export const errors = Object.assign({}, defaults, {
   CODE_DUPLICATE:     { code: 'CODE_DUPLICATE', message: 'A code with this code already exists' },
 });
   // tslint:enable:max-line-length
+
+export interface Error {
+  [key: string]: ErrorType;
+}

src/config/roles.config.ts

@@ -2,19 +2,19 @@ export const roles = <Roles>{
   USER: {
     code: 'USER',
     name: 'user',
-    description: '', // i18n ?
+    description: 'roles:user', // i18n key
     level: 0,
   },
   ADMIN: {
     code: 'ADMIN',
     name: 'admin',
-    description: '', // i18n?
+    description: 'roles:admin', // i18n key
     level: 10,
   },
   SUPERUSER: {
     code: 'SUPER_USER',
     name: 'superuser',
-    description: '', // i18n?
+    description: 'roles:superuser', // i18n key
     level: 999,
   },
 };

src/constants.ts

@@ -1,5 +1,7 @@
 import { Filters } from './models/filters.model';
 
+export const errorTranslations = `${process.cwd()}/locales`;
+
 export const envs = {
   TEST: 'test',
   DEVELOP: 'development',

src/lib/responder.ts

@@ -1,8 +1,8 @@
 import * as httpStatus from 'http-status';
 import { Response } from 'express';
-import { parseErrors } from 'tree-house-errors';
+import { parseErrors, I18nOptions } from 'tree-house-errors';
 import { ErrorSerializer } from 'jsonade';
-import { envs } from '../constants';
+import { envs, errorTranslations } from '../constants';
 import { logger } from '../lib/logger';
 
 /**
@@ -18,9 +18,14 @@ export const responder: { success: Function, error: Function } = {
     logger.debug('Response: ', serializer.serialize(payload, { totalCount }));
     return res.status(status).json(serializer.serialize(payload, { totalCount }));
   },
-  error: (res: Response, errors: any) => {
+  error: (req: Request, res: Response, errors: any) => {
     logger.debug('Error:', errors);
-    const parsedError = parseErrors(errors);
+
+    const i18nOptions: I18nOptions = {
+      language: req.headers ? (req.headers['accept-language'] || 'en') : 'en',
+      path: errorTranslations,
+    };
+    const parsedError = parseErrors(errors, i18nOptions);
 
     if (process.env.NODE_ENV === envs.PRODUCTION) Object.assign(parsedError, { meta: undefined }); // Do not send stacktrace in production
     const serializerError = ErrorSerializer.serialize([parsedError]);

src/repositories/user.repository.ts

@@ -43,7 +43,7 @@ export async function update(userId: string, values: UserUpdate | PartialUserUpd
  */
 export async function updatePassword(userId: string, password: string): Promise<User> {
   const hashedPw = await getHashedPassword(password, settings.saltCount);
-  return update(userId, { password: hashedPw, resetPwToken: null });
+  return update(userId, { password: hashedPw, resetPwToken: null, registrationCompleted: true });
 }
 
 

src/server.ts

@@ -2,12 +2,15 @@ import './config/load-env'; // Load our environment variables
 import 'newrelic';
 
 import * as treehouse from 'tree-house';
+import { importTranslations } from 'tree-house-errors';
 import { logger } from './lib/logger';
 import { app } from './app';
+import { errorTranslations } from './constants';
 
 treehouse.startServer(app, {
   title: 'Silverback',
   port: parseInt(process.env.PORT || '3000', 10),
+  pre: () => importTranslations(process.env.TRANSLATION_API_URL, process.env.TRANSLATION_API_TOKEN, { destination: errorTranslations }),
 });
 
 process.on('unhandledRejection', (e) => {

tests/integration/auth.route.test.ts

@@ -27,7 +27,6 @@ describe('/auth', () => {
   });
 
   describe('POST /login', () => {
-    // TODO: Test if brute force protection gets reset after successful attempt!
     it('Should succesfully login a user with correct credentials', async () => {
       const { body, status } = await request(app)
         .post(`${prefix}/auth/login`)
@@ -270,6 +269,9 @@ describe('/auth', () => {
       expect(status).toEqual(httpStatus.OK);
       expect(body).toEqual({});
 
+      const updatedUser = await findById(newUser.id);
+      expect(updatedUser.registrationCompleted).toEqual(true);
+
       // Try to login with changed password
       const { body: body2, status: status2 } = await request(app)
         .post(`${prefix}/auth/login`)

tests/integration/user.route.test.ts

@@ -159,6 +159,7 @@ describe('/users', () => {
     it('Should throw an error when user has no admin rights', async () => {
       const { body, status } = await request(app)
         .get(`${prefix}/users`)
+        .set('Accept-Language', 'nl')
         .set('Authorization', `Bearer ${userToken}`);
 
       expect(status).toEqual(httpStatus.UNAUTHORIZED);

tests/lib/responder.test.ts

@@ -63,10 +63,11 @@ describe('lib/responder', () => {
 
   describe('error', () => {
     it('Should return error with matching properties and status code', () => {
+      const req = httpMocks.createRequest();
       const res = httpMocks.createResponse();
       const error = new BadRequestError(errors.INVALID_INPUT);
 
-      responder.error(res, error);
+      responder.error(req, res, error);
       expect(res.statusCode).toEqual(httpStatus.BAD_REQUEST);
       expect(res._isJSON()).toEqual(true);
       expect(JSON.parse(res._getData())).toEqual({
@@ -86,10 +87,11 @@ describe('lib/responder', () => {
     it('Should return error without stacktrace in production', () => {
       process.env.NODE_ENV = envs.PRODUCTION;
 
+      const req = httpMocks.createRequest();
       const res = httpMocks.createResponse();
       const error = new BadRequestError(errors.INVALID_INPUT, { stack: 'MYSTACK' });
 
-      responder.error(res, error);
+      responder.error(req, res, error);
       expect(res.statusCode).toEqual(httpStatus.BAD_REQUEST);
       expect(res._isJSON()).toEqual(true);
       expect(JSON.parse(res._getData())).toEqual({

tests/middleware/bruteforce.middleware.test.ts

@@ -18,9 +18,9 @@ describe('bruteforce middleware', () => {
     await clearMemoryStore();
   });
 
-  it('Should start blocking requests with the same ip and username after number of retries', async () => {
+  fit('Should start blocking requests with the same ip and username after number of retries', async () => {
     app.use('/test', setUserBruteForce, (_req, res) => res.status(httpStatus.OK).send('Welcome'));
-    app.use((error, _req, res, _next) => responder.error(res, error));
+    app.use((error, req, res, _next) => responder.error(req, res, error));
 
     const numberOfCalls = userBruteConfig.freeRetries + 1;
 

tests/test.config.ts

@@ -1,4 +1,5 @@
-import { envs } from '../src/constants';
+import { envs, errorTranslations } from '../src/constants';
+import { existsSync, mkdirSync } from 'fs';
 
 export const environment = {
   NODE_ENV: envs.TEST,
@@ -23,5 +24,10 @@ Object.keys(environment).forEach((key) => {
 // Must be after env variables
 import { logger } from '../src/lib/logger';
 
+// Locales folder
+if (!existsSync(errorTranslations)) {
+  mkdirSync(errorTranslations);
+}
+
 // Overwrite error console.logs
 logger.error = jest.fn((error) => { });