chore: merge pull request #4 from AEGEE/add-healthcheck-endpoint

Add /healthcheck endpoint
AEGEE · Aug 11, 2019 · c7c7574 · c7c7574
2 parents e8dac78 + 82595c1
commit c7c7574
Show file tree

Hide file tree

Showing 17 changed files with 1,736 additions and 1,345 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,113 +1,34 @@
-# [0.5.0](https://github.com/AEGEE/oms-discounts/compare/0.4.2...0.5.0) (2019-05-18)
+## 0.5.1 (2019-08-11)
 
 
 ### Bug Fixes
 
 * **categories:** fixed categories endpoints ([08320a0](https://github.com/AEGEE/oms-discounts/commit/08320a0))
-
-
-### Features
-
-* **discounts:** added categories. Fixes MEMB-529 ([67d7380](https://github.com/AEGEE/oms-discounts/commit/67d7380))
-* **test:** testing categories CRUD ([53af8e7](https://github.com/AEGEE/oms-discounts/commit/53af8e7))
-
-
-
-## [0.4.2](https://github.com/AEGEE/oms-discounts/compare/0.4.1...0.4.2) (2019-05-03)
-
-
-### Bug Fixes
-
 * **codes:** fix claimed date ([a060bdf](https://github.com/AEGEE/oms-discounts/commit/a060bdf))
-
-
-
-## [0.4.1](https://github.com/AEGEE/oms-discounts/compare/0.4.0...0.4.1) (2019-05-03)
-
-
-### Bug Fixes
-
 * **codes:** fix mailer template breaking ([589f490](https://github.com/AEGEE/oms-discounts/commit/589f490))
-
-
-
-# [0.4.0](https://github.com/AEGEE/oms-discounts/compare/0.3.3...0.4.0) (2019-05-03)
-
-
-### Features
-
-* **codes:** mailing code to a member on claiming. Fixed MEMB-528 ([147ad23](https://github.com/AEGEE/oms-discounts/commit/147ad23))
-* **test:** tests refactor ([3e665ef](https://github.com/AEGEE/oms-discounts/commit/3e665ef))
-
-
-
-## [0.3.3](https://github.com/AEGEE/oms-discounts/compare/0.3.2...0.3.3) (2019-04-29)
-
-
-### Bug Fixes
-
-* **integration:** quota_period now can be only day, month or year ([67ee4bb](https://github.com/AEGEE/oms-discounts/commit/67ee4bb))
-
-
-
-## [0.3.2](https://github.com/AEGEE/oms-discounts/compare/0.3.1...0.3.2) (2019-04-29)
-
-
-### Bug Fixes
-
 * **deps:** downgraded Sequelize to 4.x to avoid camelCase ([a7f898b](https://github.com/AEGEE/oms-discounts/commit/a7f898b))
-* **integration:** integration code is unique now ([d2a795c](https://github.com/AEGEE/oms-discounts/commit/d2a795c))
-
-
-
-## [0.3.1](https://github.com/AEGEE/oms-discounts/compare/0.3.0...0.3.1) (2019-04-28)
-
-
-### Features
-
-* **integration:** add single integration displaying ([bb73032](https://github.com/AEGEE/oms-discounts/commit/bb73032))
-
-
-
-# [0.3.0](https://github.com/AEGEE/oms-discounts/compare/0.2.0...0.3.0) (2019-04-28)
-
-
-### Bug Fixes
-
 * **general:** added Codecov package ([fad3cfe](https://github.com/AEGEE/oms-discounts/commit/fad3cfe))
+* **general:** updated Bugsnag key ([e2d8ccc](https://github.com/AEGEE/oms-discounts/commit/e2d8ccc))
+* **integration:** integration code is unique now ([d2a795c](https://github.com/AEGEE/oms-discounts/commit/d2a795c))
+* **integration:** quota_period now can be only day, month or year ([67ee4bb](https://github.com/AEGEE/oms-discounts/commit/67ee4bb))
+* **other:** added /healthcheck endpoint. Fixes MEMB-582 ([396a646](https://github.com/AEGEE/oms-discounts/commit/396a646))
 
 
 ### Features
 
 * **code:** add code model ([a7dd4e2](https://github.com/AEGEE/oms-discounts/commit/a7dd4e2))
 * **code:** added code middlewares ([508a460](https://github.com/AEGEE/oms-discounts/commit/508a460))
+* **codes:** mailing code to a member on claiming. Fixed MEMB-528 ([147ad23](https://github.com/AEGEE/oms-discounts/commit/147ad23))
+* **discounts:** added categories. Fixes MEMB-529 ([67d7380](https://github.com/AEGEE/oms-discounts/commit/67d7380))
+* **general:** discounts + eslint ([31a75f5](https://github.com/AEGEE/oms-discounts/commit/31a75f5))
+* **general:** integrations management (not tested yet) ([4e168a2](https://github.com/AEGEE/oms-discounts/commit/4e168a2))
+* **integration:** add single integration displaying ([bb73032](https://github.com/AEGEE/oms-discounts/commit/bb73032))
+* **test:** add basic test infrastructure ([80a6a3f](https://github.com/AEGEE/oms-discounts/commit/80a6a3f))
 * **test:** added tests for everything ([a1e77d5](https://github.com/AEGEE/oms-discounts/commit/a1e77d5))
+* **test:** testing categories CRUD ([53af8e7](https://github.com/AEGEE/oms-discounts/commit/53af8e7))
 * **test:** testing codes claiming and displaying ([bb3b649](https://github.com/AEGEE/oms-discounts/commit/bb3b649))
-
-
-
-# [0.2.0](https://github.com/AEGEE/oms-discounts/compare/v0.1.0...0.2.0) (2019-04-28)
-
-
-### Features
-
-* **test:** add basic test infrastructure ([80a6a3f](https://github.com/AEGEE/oms-discounts/commit/80a6a3f))
+* **test:** tests refactor ([3e665ef](https://github.com/AEGEE/oms-discounts/commit/3e665ef))
 * **test:** travis integration ([5acac0a](https://github.com/AEGEE/oms-discounts/commit/5acac0a))
 
 
 
-# [0.1.0](https://github.com/AEGEE/oms-discounts/compare/e2d8ccc...v0.1.0) (2019-04-27)
-
-
-### Bug Fixes
-
-* **general:** updated Bugsnag key ([e2d8ccc](https://github.com/AEGEE/oms-discounts/commit/e2d8ccc))
-
-
-### Features
-
-* **general:** discounts + eslint ([31a75f5](https://github.com/AEGEE/oms-discounts/commit/31a75f5))
-* **general:** integrations management (not tested yet) ([4e168a2](https://github.com/AEGEE/oms-discounts/commit/4e168a2))
-
-
-
diff --git a/lib/helpers.js b/lib/helpers.js
@@ -34,7 +34,7 @@ MyAEGEE discounts team.`;
 
 // A helper to determine if user has permission.
 function hasPermission(permissionsList, combinedPermission) {
- return permissionsList.some(permission => permission.combined.endsWith(combinedPermission));
+ return permissionsList.some((permission) => permission.combined.endsWith(combinedPermission));
 }
 
 exports.getPermissions = (user, corePermissions) => {

diff --git a/lib/integrations.js b/lib/integrations.js
@@ -91,7 +91,7 @@ exports.addCodesToIntegration = async (req, res) => {
  return errors.makeBadRequestError(res, 'No codes are provided.');
  }
 
- const arrayToCreate = req.body.map(code => ({
+ const arrayToCreate = req.body.map((code) => ({
  integration_id: req.integration.id,
  value: code
  }));

diff --git a/lib/logger.js b/lib/logger.js
@@ -13,7 +13,7 @@ const logger = winston.createLogger({
  winston.format.timestamp(),
  winston.format.align(),
  winston.format.splat(),
- winston.format.printf(info => `${info.timestamp} [${info.level}]: ${info.message}`),
+ winston.format.printf((info) => `${info.timestamp} [${info.level}]: ${info.message}`),
  )
  })
  ]

diff --git a/lib/middlewares.js b/lib/middlewares.js
@@ -3,6 +3,7 @@ const errors = require('./errors');
 const helpers = require('./helpers');
 const logger = require('./logger');
 const bugsnag = require('./bugsnag');
+const packageInfo = require('../package');
 
 exports.authenticateUser = async (req, res, next) => {
  const token = req.header('x-auth-token');
@@ -42,6 +43,18 @@ exports.authenticateUser = async (req, res, next) => {
  return next();
 };
 
+/* istanbul ignore next */
+exports.healthcheck = (req, res) => {
+ return res.json({
+ success: true,
+ data: {
+ name: packageInfo.name,
+ description: packageInfo.description,
+ version: packageInfo.version
+ }
+ });
+};
+
 /* eslint-disable no-unused-vars */
 exports.notFound = (req, res, next) => errors.makeNotFoundError(res, 'No such API endpoint: ' + req.method + ' ' + req.originalUrl);
 

diff --git a/lib/sequelize.js b/lib/sequelize.js
@@ -11,13 +11,13 @@ for (const field of requiredFields) {
  }
 }
 
-Sequelize.postgres.DECIMAL.parse = value => parseFloat(value);
+Sequelize.postgres.DECIMAL.parse = (value) => parseFloat(value);
 
 const getSequelize = () => new Sequelize(config.postgres.database, config.postgres.username, config.postgres.password, {
  host: config.postgres.host,
  port: config.postgres.port,
  dialect: 'postgres',
- logging: sql => logger.debug(sql),
+ logging: (sql) => logger.debug(sql),
  operatorsAliases: false
 });
 

diff --git a/lib/server.js b/lib/server.js
@@ -26,6 +26,7 @@ process.on('unhandledRejection', (err) => {
  }
 });
 
+GeneralRouter.get('/healthcheck', middlewares.healthcheck);
 GeneralRouter.use(middlewares.authenticateUser);
 
 // integrations and codes
@@ -60,7 +61,7 @@ async function startServer() {
  return res();
  });
  /* istanbul ignore next */
- localApp.on('error', err => rej(new Error('Error starting server: ' + err.stack)));
+ localApp.on('error', (err) => rej(new Error('Error starting server: ' + err.stack)));
  });
 }
 

diff --git a/migrations/20190427100249-create-integration.js b/migrations/20190427100249-create-integration.js
@@ -35,5 +35,5 @@ module.exports = {
  type: Sequelize.DATE
  }
  }),
- down: queryInterface => queryInterface.dropTable('integrations')
+ down: (queryInterface) => queryInterface.dropTable('integrations')
 };
diff --git a/migrations/20190428134103-create-code.js b/migrations/20190428134103-create-code.js
@@ -30,5 +30,5 @@ module.exports = {
  type: Sequelize.DATE
  }
  }),
- down: queryInterface => queryInterface.dropTable('codes')
+ down: (queryInterface) => queryInterface.dropTable('codes')
 };
diff --git a/migrations/20190518200032-create-category.js b/migrations/20190518200032-create-category.js
@@ -23,5 +23,5 @@ module.exports = {
  type: Sequelize.DATE
  }
  }),
- down: queryInterface => queryInterface.dropTable('categories')
+ down: (queryInterface) => queryInterface.dropTable('categories')
 };
diff --git a/models/Category.js b/models/Category.js
@@ -33,6 +33,11 @@ const Category = sequelize.define('category', {
  }
  },
  }
-}, { underscored: true, tableName: 'categories' });
+}, {
+ underscored: true,
+ tableName: 'categories',
+ createdAt: 'created_at',
+ updatedAt: 'updated_at'
+});
 
 module.exports = Category;
diff --git a/models/Code.js b/models/Code.js
@@ -20,6 +20,11 @@ const Code = sequelize.define('code', {
  claimed_by: {
  type: Sequelize.INTEGER
  }
-}, { underscored: true, tableName: 'codes' });
+}, {
+ underscored: true,
+ tableName: 'codes',
+ createdAt: 'created_at',
+ updatedAt: 'updated_at'
+});
 
 module.exports = Code;
diff --git a/models/Integration.js b/models/Integration.js
@@ -46,6 +46,11 @@ const Integration = sequelize.define('integration', {
  description: {
  type: Sequelize.TEXT
  }
-}, { underscored: true, tableName: 'integrations' });
+}, {
+ underscored: true,
+ tableName: 'integrations',
+ createdAt: 'created_at',
+ updatedAt: 'updated_at'
+});
 
 module.exports = Integration;
diff --git a/models/index.js b/models/index.js
@@ -2,8 +2,8 @@ const Integration = require('./Integration');
 const Code = require('./Code');
 const Category = require('./Category');
 
-Integration.hasMany(Code);
-Code.belongsTo(Integration);
+Integration.hasMany(Code, { foreignKey: 'integration_id' });
+Code.belongsTo(Integration, { foreignKey: 'integration_id' });
 
 module.exports = {
  Integration,