:fire: complete reorg of backend

backend/config/dev.js

@@ -1,4 +1,4 @@
-const config = {
+module.exports = {
     /** Server info */
     host: 'localhost',
     port: 3001,
@@ -14,5 +14,3 @@ const config = {
     corsSupported: false
 }
 
-export { config }
-

backend/package.json

@@ -11,17 +11,16 @@
   "license": "UNLICENSED",
   "dependencies": {
     "@hapi/hapi": "^20.1.3",
+    "@hapi/inert": "^6.0.3",
+    "@hapi/vision": "^6.0.1",
     "@hapipal/schwifty": "^6.0.0",
-    "hapi-sequelizejs": "^4.4.0",
-    "hapi-swaggered": "^3.0.2",
-    "hapi-swaggered-ui": "^3.1.0",
-    "joi": "^13.7.0",
+    "hapi-swagger": "^14.1.3",
+    "joi": "^17.4.0",
     "knex": "^0.21.19",
     "mysql": "^2.18.1",
     "objection": "^2.2.15"
   },
   "devDependencies": {
     "nodemon": "^2.0.7"
-  },
-  "type": "module"
+  }
 }

backend/src/docs.js

@@ -1,29 +0,0 @@
-import hapiSwaggered from 'hapi-swaggered'
-import hapiSwaggeredUI from 'hapi-swaggered-ui'
-
-// ?: hapi-swaggered deps
-import vision from 'vision'
-import inert from 'inert'
-
-const swaggered = {
-    plugin: hapiSwaggered,
-    options: {},
-    info: {
-        title: 'EXAMPLE',
-        descrioption: 'just a test',
-        version: '1.0.0'
-    }
-}
-
-const swaggeredUI = {
-    plugin: hapiSwaggeredUI,
-    options: {
-        path: '/docs',
-        swaggerOptions: {
-            validatorUrl: null
-        },
-    }
-}
-const docs = [ vision, inert, swaggered, swaggeredUI ]
-
-export { docs }

backend/src/handlers/index.js

@@ -1,18 +0,0 @@
-/** 
- * Your default handlers
- * NOT to be confused with per
- * plugin HTTP handlers
- */
-const handlers = {
-    default: {
-        get: (request, h) => {
-            return { 
-                ok: true, 
-                handler: 'default',
-                data: {}
-            }
-        }
-    }
-}
-
-export { handlers }

backend/src/index.js

@@ -1,101 +1,51 @@
-import Hapi from '@hapi/hapi'
-import Schwifty from '@hapipal/schwifty'
-
-import { config } from '../config/dev.js'
-
-import { routes } from './routes/index.js'
-import { plugins } from './plugins/index.js'
-import { docs } from './docs.js'
-
-import Joi from 'joi'
-
-const server = Hapi.server({
-    port: config.port,
-    host: config.host,
-    routes: {
-        cors: config.corsSupported
-    }
-})
-
-const dbConnection = {
-    host : config.host,
-    user : 'root',
-    password : 'root',
-    database : config.db
-}
-
-const init = async () => {
-    try {
-        routes.forEach(route => server.route(route))
-
-        for(const plugin of plugins) {
-            await server.register(plugin, {
-                routes: { prefix: `/${config.apiBase}` }
-            })
+const Hapi = require('@hapi/hapi');
+const Inert = require('@hapi/inert');
+const Vision = require('@hapi/vision');
+const Schwifty = require('@hapipal/schwifty');
+const HapiSwagger = require('hapi-swagger');
+
+const config = require('../config/dev');
+
+const AppPlugin = require('./plugins');
+
+(async () => {
+    const server = Hapi.server({
+        port: config.port,
+        host: config.host,
+        routes: {
+            cors: config.corsSupported
         }
-
-        await server.register(docs)
-
-        /** Register the database connection */
-        console.log(`\n[SIIMEE API] Database: ${config.db} | Attempting to connect on port ${config.dbPort}...`)
-        await server.register({
-            plugin: Schwifty,
+    })
+
+    await server.register([ 
+        AppPlugin,
+        // Documentaion deps
+        Inert,
+        Vision,
+        {
+            plugin: HapiSwagger,
             options: {
-                knex: { client: config.dbDialect, connection: dbConnection }
+                info: { title: 'Test API Documentation' }
             }
-        })
-        console.log(`[SIIMEE API] Database: ${config.db} | Connection has been established on port ${config.dbPort}!`)
-
-
-
-
-
-        server.registerModel(
-            class Dog extends Schwifty.Model {
-                static tableName = 'Dog'
-                static joiSchema = Joi.object({
-                    id: Joi.number(),
-                    name: Joi.string()
-                })
+        },
+        // DB and model connectors
+        {
+            plugin: Schwifty,
+            options: {
+                knex: {
+                    client: config.dbDialect,
+                    useNullAsDefault: true,
+                    connection: {
+                        host : config.host,
+                        user : 'root',
+                        password : 'root',
+                        database : config.db
+                    }
+                }
             }
-        )
-
-
-        /** Lift Off! */
-        await server.initialize()
-        
-        const knex = server.knex()
-        // console.log(knex)
-        await knex.schema.createTable('Dog', (table) => {
-            table.increments('id').primary()
-            table.string('name')
-        })
-    
-        // ... then add some records ...
-    
-        const { Dog } = server.models()
-    
-        await Promise.all([
-            Dog.query().insert({ name: 'Guinness' }),
-            Dog.query().insert({ name: 'Sully' }),
-            Dog.query().insert({ name: 'Ren' })
-        ])
-
-        await server.start()
-        console.log('\n[SIIMEE API] Server running on %s', server.info.uri)
-    }
-
-    catch(err) {
-        console.error(err)
-    }
-
-};
-
-process.on('unhandledRejection', (err) => {
-    console.log(err)
-    process.exit(1)
-})
-
-init()
+        }
+    ])
 
-export default server
+    await server.start()
+    console.log(`Ready to go! See ${server.info.uri}`)
+})();

backend/src/plugins/index.js

@@ -1,6 +1,16 @@
-import { profilePlugin } from './profile/index.js'
-import { testPlugin } from './test.js'
+const config = require('../../config/dev');
 
-const plugins = [ testPlugin, profilePlugin ]
+const UserPlugin = require('./user');
+const TestPlugin = require('./test');
 
-export { plugins }
+const pluginOptions = {
+    routes: { prefix: `/${config.apiBase}` }
+}
+
+module.exports = {
+    name: 'my-app-plugin',
+    register: async (server, options) => {
+        await server.register(TestPlugin, pluginOptions)
+        await server.register(UserPlugin, pluginOptions)
+    }
+}

backend/src/plugins/profile/handlers.js

@@ -1,19 +0,0 @@
-// https://github.com/connor11528/task-app-backend/blob/master/src/api/index.js
-
-const handlers = {
-    get: (request, h) => {
-        try {
-            return { 
-                ok: true,
-                handler: 'profile',
-                data: { name: request.params.name },
-            }
-        }
-
-        catch (err) {
-            //   Boom.badImplementation(err);
-        }
-    }
-}
-
-export { handlers }

backend/src/plugins/profile/index.js

@@ -1,44 +0,0 @@
-import { responses } from './responses.js'
-
-/**
- * Swagger Descriptions
- * Keys should match HTTP methods
- * GET, PATCH, PUT, DELETE
- * @param {string} description: Describe the endpoint
- * @param {string} notes: What to expect as a return
- */
-const descriptions = {
-    'GET': {
-        description: 'Profile endpoint returns junk',
-        notes: 'There\'s a lot we don\'nt know about yet'
-    }
-}
-
-/** Profile plugin ready for export */
-const profilePlugin = {
-    name: 'profile-plugin',
-    version: '1.0.0',
-
-    /**
-     * Register each HTTP response type
-     * Adds Swagger descriptions, response validations,
-     * and path validations all in one
-     * @param {object} responses - configs for all responses
-     */
-    register: async (server, options) => { 
-        Object.values(responses).forEach(res => {
-            
-            /** 
-             * Copy our response config and
-             * sprinkle endpoint docs
-             */
-            res.options = { 
-                ...descriptions[res.method],
-                ...res.options
-            }
-            server.route(res)
-        })
-    }
-}
-
-export { profilePlugin }

backend/src/plugins/profile/responses.js

@@ -1,22 +0,0 @@
-import { validators } from './validators.js'
-import { handlers } from './handlers.js'
-
-const responses = {
-    get: {
-        method: 'GET',
-        path: '/profile/{name}',
-        handler: handlers.get,
-        options: { 
-            tags: ['api'],
-            validate: {
-                params: validators.params
-            },
-            response: {
-                schema: validators.resSchema,
-                failAction: 'log'
-            }
-        }
-    }
-}
-
-export { responses }

backend/src/plugins/profile/validators.js

@@ -1,15 +0,0 @@
-import Joi from 'joi'
-
-const validators = {
-    params: Joi.object({
-        name: Joi.string().min(3).max(11)
-    })
-}
-
-validators.resSchema = Joi.object({
-    ok: Joi.bool(),
-    handler: Joi.string(),
-    data: validators.params
-})
-
-export { validators }

backend/src/plugins/test.js

@@ -1,15 +1,19 @@
-import { handlers } from '../handlers/index.js'
-
-const testPlugin = {
-    name: 'test-plugin',
+module.exports = {
+    name: 'myPlugin',
     version: '1.0.0',
     register: async (server, options) => {
+        // Create a route for example
         server.route({
             method: 'GET',
             path: '/test',
-            handler: handlers.default.get
+            handler: async function (request, h) {
+                return { test: 'hello, world' }
+            },
+            options: {
+                description: 'Test',
+                notes: 'This is a test route',
+                tags: ['api'],
+            }
         })
     }
-}
-
-export { testPlugin }
+}

backend/src/plugins/user.js

@@ -0,0 +1,90 @@
+const Schwifty = require('@hapipal/schwifty');
+const Joi = require('joi');
+
+const pluginConfig = {
+    name: 'my-user-plugin',
+    version: '1.0.0',
+    tableName: 'users',
+    handlerType: 'user',
+    docs: {
+        get: {
+            description: 'Get user',
+            notes: 'Returns a user item by the id passed in the path'
+        }
+    }
+}
+
+class User extends Schwifty.Model {
+    static get tableName() { return pluginConfig.tableName }
+    static get joiSchema() {
+        return Joi.object({
+            id: Joi.number().required(),
+            name: Joi.string().required()
+        })
+    }
+}
+
+const handlers = {
+    get: async request => {
+        try {
+            /** Get the data for your endpoint */
+            const { User } = request.models()
+            const all = await User.query()
+
+            return { 
+                ok: true,
+                handler: pluginConfig.handlerType,
+                data: { name: request.params.name, all },
+            }
+        }
+        catch(err) {
+            return { 
+                ok: false,
+                handler: pluginConfig.handlerType,
+                data: { error: err },
+            }
+        }
+    }
+}
+
+/** Validator functions by request method */
+const validators = {
+    get: {
+        params: Joi.object({
+            name: Joi.string().min(3).max(11),
+            all: Joi.array()
+        })
+    }
+}
+
+/** Plugin options by request method */
+const options = {
+    get: {
+        ...pluginConfig.docs.get,
+        tags: ['api'],
+        validate: validators.get,
+        response: {
+            schema: Joi.object({
+                ok: Joi.bool(),
+                handler: Joi.string(),
+                data: validators.get.params
+            }),
+            failAction: 'log'
+        }
+    }
+}
+
+module.exports = {
+    name: pluginConfig.name,
+    version: pluginConfig.version,
+    register: async server => {
+        await server.register(Schwifty)  
+        await server.registerModel(User)
+        await server.route({
+            method: 'get',
+            path: '/users/{name}',
+            handler: handlers.get,
+            options: options.get
+        })
+    }
+}

backend/src/routes/index.js

@@ -1,11 +0,0 @@
-import { handlers } from '../handlers/index.js'
-
-const routes = [
-    {
-        method: 'GET',
-        path: '/',
-        handler: handlers.default.get
-    },
-]
-
-export { routes }