Merge branch 'api-health-route' of fyindr/siimee into dev

backend/knexfile.js

@@ -1,4 +1,5 @@
-require('dotenv').config()
+require('dotenv').config({path: './server/.env'})
+// require('dotenv').config()
 
 const local = {
     host: process.env.DB_HOST,

backend/lib/index.js

@@ -3,6 +3,7 @@ const MembershipPlugin = require('./plugins/membership')
 const SurveyPlugin = require('./plugins/survey')
 const ProfilePlugin = require('./plugins/profile')
 const NotificationPlugin = require('./plugins/notification')
+const HealthPlugin = require('./plugins/health')
 
 /**
  * A Hapi server instance
@@ -45,5 +46,9 @@ exports.plugin = {
         await server.register(NotificationPlugin, {
             routes: { prefix: '/notification' },
         })
+
+        await server.register(HealthPlugin, {
+            routes: { prefix: '/health' },
+        })
     },
 }

backend/lib/plugins/health.js

@@ -0,0 +1,9 @@
+const HealthRoute = require('../routes/health/get')
+
+module.exports = {
+    name: 'health-plugin',
+    version: '1.0.0',
+    register: async (server, options) => {
+        await server.route(HealthRoute)
+    },
+}

backend/lib/plugins/user.js

@@ -14,6 +14,7 @@ const UserSignupRoute = require('../routes/user/signup')
 
 const UserService = require('../services/user')
 const DisplayService = require('../services/display')
+const HealthService = require('../services/health')
 
 module.exports = {
     name: 'user-plugin',
@@ -38,6 +39,7 @@ module.exports = {
         await server.register(Schmervice)
         server.registerService(UserService)
         server.registerService(DisplayService)
+        server.registerService(HealthService)
 
         await server.route(UserCurrentRoute)
         await server.route(UserLoginRoute)

backend/lib/routes/health/get.js

@@ -0,0 +1,69 @@
+'use strict'
+
+const apiSchema = require('../../schemas/api')
+const errorSchema = require('../../schemas/errors')
+const healthSchema = require('../../schemas/health')
+
+const pluginConfig = {
+    handlerType: 'health',
+    docs: {
+        description: 'Get server stats',
+        notes: 'Returns stats on server status'
+    }
+}
+
+const validators = {}
+
+const responseSchemas = {
+    health: healthSchema.stats,
+    error: errorSchema.single
+}
+
+module.exports = {
+    method: 'GET',
+    path: '/',
+    options:{
+        ...pluginConfig.docs,
+        tags: ['api'],
+        auth: false,
+        cors: true,
+        handler: async function (request, h) {
+            const { healthService } = request.server.services()
+            const stats = await healthService.getStats()
+            try {
+                return h.response(({
+                    ok:true,
+                    handler: pluginConfig.handlerType,
+                    data: stats
+                })).code(200)
+            } catch (err) {
+                return h
+                    .response({
+                        ok: false,
+                        handler: pluginConfig.handlerType,
+                        data: {error: `${err}`}
+                    })
+                    .code(409)
+            }
+        },
+        validate: {
+            ...validators,
+            failAction: 'log'
+        },
+
+        response: {
+            status: {
+                200: apiSchema.single
+                    .append({
+                        data: responseSchemas.health,
+                    })
+                    .label('api_single_res'),
+                409: apiSchema.single
+                    .append({
+                        data: responseSchemas.error,
+                    })
+                    .label('error_single_res'),
+            },
+        },
+    },
+}

backend/lib/schemas/health.js

@@ -0,0 +1,10 @@
+'use strict'
+
+const Joi = require('Joi')
+
+const stats = Joi.object({
+    date: Joi.string().required(),
+    users: Joi.number().required(),
+}).label('stats')
+
+module.exports = { stats }

backend/lib/services/health.js

@@ -0,0 +1,18 @@
+const Schmervice = require('@hapipal/schmervice')
+
+module.exports = class HealthService extends Schmervice.Service {
+    constructor(...args){
+        super(...args)
+    }
+
+    /**
+     * Returns date and number of users
+     * @returns {object}
+     */
+    async getStats(){
+        const { User } = this.server.models()
+        const users = await User.query()
+        const date = new Date()
+        return { date: date.toString(), users: users.length }
+    }
+}

backend/server/manifest.js

@@ -1,12 +1,10 @@
-const Dotenv = require('dotenv')
+const Dotenv = require('dotenv').config({path: './server/.env'})
 const Confidence = require('@hapipal/confidence')
 const Inert = require('@hapi/inert')
 const Vision = require('@hapi/vision')
 const Schwifty = require('@hapipal/schwifty')
 const HapiSwagger = require('hapi-swagger')
 
-/** Pull .env into process.env */
-Dotenv.config({ path: `${__dirname}/../.env` })
 
 /** Glue manifest as a confidence store */
 module.exports = new Confidence.Store({