:recycle: even more restructuring based on real-world example project

.gitignore

@@ -2,4 +2,5 @@ node_modules
 .DS_Store
 dist
 dist-ssr
-*.local
+*.local
+**/.env

backend/config/dev.js

@@ -1,16 +0,0 @@
-module.exports = {
-    /** Server info */
-    host: 'localhost',
-    port: 3001,
-
-    db: 'test',
-    dbPort: 3306,
-    dbDialect: 'mysql', // even for mariadb
-
-    /** URL preceding endpoints */
-    apiBase: 'api',
-
-    /** Uncomment for cross-origin */
-    corsSupported: false
-}
-

backend/lib/models/user.js

@@ -0,0 +1,12 @@
+const Schwifty = require('@hapipal/schwifty');
+const Joi = require('joi');
+
+module.exports = class User extends Schwifty.Model {
+    static get tableName() { return 'users' }
+    static get joiSchema() {
+        return Joi.object({
+            id: Joi.number().required(),
+            name: Joi.string().required()
+        })
+    }
+}

backend/src/plugins/index.js → backend/lib/plugins/index.js

@@ -1,10 +1,9 @@
-const config = require('../../config/dev');
 
 const UserPlugin = require('./user');
 const TestPlugin = require('./test');
 
 const pluginOptions = {
-    routes: { prefix: `/${config.apiBase}` }
+    routes: { prefix: `/api` }
 }
 
 module.exports = {

backend/lib/plugins/user.js

@@ -0,0 +1,14 @@
+const Schwifty = require('@hapipal/schwifty');
+
+const UserModel = require('../models/user');
+const UserCurrentRoute = require('../routes/user/current');
+
+module.exports = {
+    name: 'my-user-plugin',
+    version: '1.0.0',
+    register: async server => {
+        await server.register(Schwifty)
+        await server.registerModel(UserModel)
+        await server.route(UserCurrentRoute)
+    }
+}

backend/src/plugins/user.js → backend/lib/routes/user/current.js

@@ -1,10 +1,8 @@
-const Schwifty = require('@hapipal/schwifty');
+'use strict';
+
 const Joi = require('joi');
 
 const pluginConfig = {
-    name: 'my-user-plugin',
-    version: '1.0.0',
-    tableName: 'users',
     handlerType: 'user',
     docs: {
         get: {
@@ -14,52 +12,42 @@ const pluginConfig = {
     }
 }
 
-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()
+
+/** Validator functions by request method */
+const validators = {
+    get: {
+        params: Joi.object({
+            name: Joi.string().min(3).max(11),
+            all: Joi.array()
         })
     }
 }
 
-const handlers = {
-    get: async request => {
+module.exports = {
+    method: 'get',
+    path: '/user/{name}',
+    // auth: 'jwt',
+    handler: async request => {
         try {
             /** Get the data for your endpoint */
             const { User } = request.models()
             const all = await User.query()
 
-            return { 
+            return {
                 ok: true,
                 handler: pluginConfig.handlerType,
                 data: { name: request.params.name, all },
             }
         }
         catch(err) {
-            return { 
+            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: {
+    },
+    options: {
         ...pluginConfig.docs.get,
         tags: ['api'],
         validate: validators.get,
@@ -72,19 +60,5 @@ const options = {
             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/package-lock.json

@@ -9,11 +9,14 @@
       "version": "1.0.0",
       "license": "UNLICENSED",
       "dependencies": {
+        "@hapi/glue": "^8.0.0",
         "@hapi/hapi": "^20.1.3",
         "@hapi/inert": "^6.0.3",
         "@hapi/vision": "^6.0.1",
+        "@hapipal/confidence": "^6.0.1",
         "@hapipal/schwifty": "^6.0.0",
         "dotenv": "^10.0.0",
+        "exiting": "^6.0.1",
         "hapi-swagger": "^14.1.3",
         "joi": "^17.4.0",
         "knex": "^0.21.19",
@@ -57,6 +60,18 @@
         "@hapi/hoek": "9.x.x"
       }
     },
+    "node_modules/@hapi/bossy": {
+      "version": "5.1.0",
+      "resolved": "https://registry.npmjs.org/@hapi/bossy/-/bossy-5.1.0.tgz",
+      "integrity": "sha512-sVZC6GucPaG2Pugldj476ZtGevkFCOoJSf4Ay9HJXxAOjyyBhb0AnxtxYdrf1tvTBV2hAMytV3RASQXudB3rnQ==",
+      "dependencies": {
+        "@hapi/boom": "9.x.x",
+        "@hapi/bounce": "2.x.x",
+        "@hapi/bourne": "2.x.x",
+        "@hapi/hoek": "9.x.x",
+        "@hapi/validate": "1.x.x"
+      }
+    },
     "node_modules/@hapi/bounce": {
       "version": "2.0.0",
       "resolved": "https://registry.npmjs.org/@hapi/bounce/-/bounce-2.0.0.tgz",
@@ -124,6 +139,16 @@
       "resolved": "https://registry.npmjs.org/@hapi/file/-/file-2.0.0.tgz",
       "integrity": "sha512-WSrlgpvEqgPWkI18kkGELEZfXr0bYLtr16iIN4Krh9sRnzBZN6nnWxHFxtsnP684wueEySBbXPDg/WfA9xJdBQ=="
     },
+    "node_modules/@hapi/glue": {
+      "version": "8.0.0",
+      "resolved": "https://registry.npmjs.org/@hapi/glue/-/glue-8.0.0.tgz",
+      "integrity": "sha512-dqAQ401MTDpTUnPUtUZ/RIJOE+ROTjhq1YgPeuAVMYpoYlh55PNNJq6YBDBlye5VcF9uYtL1h3VnRMZz2NSlXw==",
+      "dependencies": {
+        "@hapi/hapi": "20.x.x",
+        "@hapi/hoek": "9.x.x",
+        "@hapi/validate": "1.x.x"
+      }
+    },
     "node_modules/@hapi/hapi": {
       "version": "20.1.3",
       "resolved": "https://registry.npmjs.org/@hapi/hapi/-/hapi-20.1.3.tgz",
@@ -335,6 +360,20 @@
         "@hapi/hoek": "9.x.x"
       }
     },
+    "node_modules/@hapipal/confidence": {
+      "version": "6.0.1",
+      "resolved": "https://registry.npmjs.org/@hapipal/confidence/-/confidence-6.0.1.tgz",
+      "integrity": "sha512-bhJriclaN5W8TJG950Al/lSaej2hi6byQNUmk0JUvuB7mys7oLGUZlbEz3k73s6hF7sKChfYofvjcFr2GLQAYQ==",
+      "dependencies": {
+        "@hapi/bossy": ">=5.1.0 <6",
+        "@hapi/bourne": "2.x.x",
+        "@hapi/hoek": "9.x.x",
+        "joi": "17.x.x"
+      },
+      "bin": {
+        "confidence": "bin/confidence"
+      }
+    },
     "node_modules/@hapipal/schwifty": {
       "version": "6.0.0",
       "resolved": "https://registry.npmjs.org/@hapipal/schwifty/-/schwifty-6.0.0.tgz",
@@ -1184,6 +1223,21 @@
         "node": ">=4"
       }
     },
+    "node_modules/exiting": {
+      "version": "6.0.1",
+      "resolved": "https://registry.npmjs.org/exiting/-/exiting-6.0.1.tgz",
+      "integrity": "sha512-0kUQkyWTMJUZ2wKkxjducVojsL5vtDxw26q9sd07SwyWZswbHOrWN9Bs2jk9uXffatsGp2QP5tmQUYXiPi1Z2A==",
+      "dependencies": {
+        "@hapi/bounce": "^2.0.0",
+        "@hapi/hoek": "^9.0.2"
+      },
+      "engines": {
+        "node": ">=12.13.0"
+      },
+      "peerDependencies": {
+        "@hapi/hapi": ">=17.9.0"
+      }
+    },
     "node_modules/expand-brackets": {
       "version": "2.1.4",
       "resolved": "https://registry.npmjs.org/expand-brackets/-/expand-brackets-2.1.4.tgz",
@@ -3979,6 +4033,18 @@
         "@hapi/hoek": "9.x.x"
       }
     },
+    "@hapi/bossy": {
+      "version": "5.1.0",
+      "resolved": "https://registry.npmjs.org/@hapi/bossy/-/bossy-5.1.0.tgz",
+      "integrity": "sha512-sVZC6GucPaG2Pugldj476ZtGevkFCOoJSf4Ay9HJXxAOjyyBhb0AnxtxYdrf1tvTBV2hAMytV3RASQXudB3rnQ==",
+      "requires": {
+        "@hapi/boom": "9.x.x",
+        "@hapi/bounce": "2.x.x",
+        "@hapi/bourne": "2.x.x",
+        "@hapi/hoek": "9.x.x",
+        "@hapi/validate": "1.x.x"
+      }
+    },
     "@hapi/bounce": {
       "version": "2.0.0",
       "resolved": "https://registry.npmjs.org/@hapi/bounce/-/bounce-2.0.0.tgz",
@@ -4043,6 +4109,16 @@
       "resolved": "https://registry.npmjs.org/@hapi/file/-/file-2.0.0.tgz",
       "integrity": "sha512-WSrlgpvEqgPWkI18kkGELEZfXr0bYLtr16iIN4Krh9sRnzBZN6nnWxHFxtsnP684wueEySBbXPDg/WfA9xJdBQ=="
     },
+    "@hapi/glue": {
+      "version": "8.0.0",
+      "resolved": "https://registry.npmjs.org/@hapi/glue/-/glue-8.0.0.tgz",
+      "integrity": "sha512-dqAQ401MTDpTUnPUtUZ/RIJOE+ROTjhq1YgPeuAVMYpoYlh55PNNJq6YBDBlye5VcF9uYtL1h3VnRMZz2NSlXw==",
+      "requires": {
+        "@hapi/hapi": "20.x.x",
+        "@hapi/hoek": "9.x.x",
+        "@hapi/validate": "1.x.x"
+      }
+    },
     "@hapi/hapi": {
       "version": "20.1.3",
       "resolved": "https://registry.npmjs.org/@hapi/hapi/-/hapi-20.1.3.tgz",
@@ -4245,6 +4321,17 @@
         "@hapi/hoek": "9.x.x"
       }
     },
+    "@hapipal/confidence": {
+      "version": "6.0.1",
+      "resolved": "https://registry.npmjs.org/@hapipal/confidence/-/confidence-6.0.1.tgz",
+      "integrity": "sha512-bhJriclaN5W8TJG950Al/lSaej2hi6byQNUmk0JUvuB7mys7oLGUZlbEz3k73s6hF7sKChfYofvjcFr2GLQAYQ==",
+      "requires": {
+        "@hapi/bossy": ">=5.1.0 <6",
+        "@hapi/bourne": "2.x.x",
+        "@hapi/hoek": "9.x.x",
+        "joi": "17.x.x"
+      }
+    },
     "@hapipal/schwifty": {
       "version": "6.0.0",
       "resolved": "https://registry.npmjs.org/@hapipal/schwifty/-/schwifty-6.0.0.tgz",
@@ -4890,6 +4977,15 @@
       "resolved": "https://registry.npmjs.org/esprima/-/esprima-4.0.1.tgz",
       "integrity": "sha512-eGuFFw7Upda+g4p+QHvnW0RyTX/SVeJBDM/gCtMARO0cLuT2HcEKnTPvhjV6aGeqrCB/sbNop0Kszm0jsaWU4A=="
     },
+    "exiting": {
+      "version": "6.0.1",
+      "resolved": "https://registry.npmjs.org/exiting/-/exiting-6.0.1.tgz",
+      "integrity": "sha512-0kUQkyWTMJUZ2wKkxjducVojsL5vtDxw26q9sd07SwyWZswbHOrWN9Bs2jk9uXffatsGp2QP5tmQUYXiPi1Z2A==",
+      "requires": {
+        "@hapi/bounce": "^2.0.0",
+        "@hapi/hoek": "^9.0.2"
+      }
+    },
     "expand-brackets": {
       "version": "2.1.4",
       "resolved": "https://registry.npmjs.org/expand-brackets/-/expand-brackets-2.1.4.tgz",

backend/package.json

@@ -4,18 +4,21 @@
   "description": "",
   "main": "index.js",
   "scripts": {
-    "start": "nodemon src/index.js",
+    "start": "nodemon server",
     "migrate": "knex migrate:latest",
     "test": "echo \"Error: no test specified\" && exit 1"
   },
   "author": "TOJ",
   "license": "UNLICENSED",
   "dependencies": {
+    "@hapi/glue": "^8.0.0",
     "@hapi/hapi": "^20.1.3",
     "@hapi/inert": "^6.0.3",
     "@hapi/vision": "^6.0.1",
+    "@hapipal/confidence": "^6.0.1",
     "@hapipal/schwifty": "^6.0.0",
     "dotenv": "^10.0.0",
+    "exiting": "^6.0.1",
     "hapi-swagger": "^14.1.3",
     "joi": "^17.4.0",
     "knex": "^0.21.19",

backend/server/.env.sample

@@ -0,0 +1,7 @@
+# Rename me to .env then fill me with runtime configuration and credentials
+# Just don't try to check me into your repo :)
+# Confused? See https://github.com/motdotla/dotenv
+#
+# e.g.
+# PORT=4000
+APP_SECRET=mysecret

backend/server/index.js

@@ -0,0 +1,26 @@
+const Glue = require('@hapi/glue');
+const Exiting = require('exiting');
+const Manifest = require('./manifest');
+
+exports.deployment = async ({ start } = {}) => {
+    const manifest = Manifest.get('/', process.env)
+    const server = await Glue.compose(manifest, { relativeTo: __dirname })
+
+    if (start) {
+        await Exiting.createManager(server).start()
+        server.log(['start'], `Server started at ${server.info.uri}`);
+        return server
+    }
+
+    await server.initialize()
+
+    return server
+}
+
+if (require.main === module) {
+    exports.deployment({ start: true })
+
+    process.on('unhandledRejection', (err) => {
+        throw err
+    })
+}

backend/server/manifest.js

@@ -0,0 +1,72 @@
+const Dotenv = require('dotenv');
+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');
+const AppPlugin = require('../lib/plugins');
+// Pull .env into process.env
+Dotenv.config({ path: `${__dirname}/.env` });
+
+// Glue manifest as a confidence store
+module.exports = new Confidence.Store({
+    server: {
+        host: 'localhost',
+        port: {
+            $filter: 'NODE_ENV',
+            $default: {
+                $param: 'PORT',
+                $coerce: 'number',
+                $default: 3001
+            },
+            test: { $value: undefined }         // Let the server find an open port
+        },
+        debug: {
+            $filter: 'NODE_ENV',
+            $default: {
+                log: ['error', 'start'],
+                request: ['error']
+            },
+            production: {
+                request: ['implementation']
+            }
+        }
+    },
+    register: {
+        plugins: [
+            AppPlugin,
+            // Documentaion deps
+            Inert,
+            Vision,
+            {
+                plugin: HapiSwagger,
+                options: {
+                    info: { title: 'Test API Documentation' }
+                }
+            },
+            {
+                plugin: Schwifty,
+                options: {
+                    $filter: 'NODE_ENV',
+                    $default: {},
+                    $base: {
+                        migrateOnStart: true,
+                        knex: {
+                            client: 'mysql',
+                            useNullAsDefault: true,
+                            connection: {
+                                host : 'localhost',
+                                user : 'root',
+                                password : 'root',
+                                database : 'test'
+                            }
+                        }
+                    },
+                    production: {
+                        migrateOnStart: false
+                    }
+                }
+            }
+        ]
+    }
+});

backend/src/index.js

@@ -1,51 +0,0 @@
-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([ 
-        AppPlugin,
-        // Documentaion deps
-        Inert,
-        Vision,
-        {
-            plugin: HapiSwagger,
-            options: {
-                info: { title: 'Test API Documentation' }
-            }
-        },
-        // DB and model connectors
-        {
-            plugin: Schwifty,
-            options: {
-                knex: {
-                    client: config.dbDialect,
-                    useNullAsDefault: true,
-                    connection: {
-                        host : config.host,
-                        user : 'root',
-                        password : 'root',
-                        database : config.db
-                    }
-                }
-            }
-        }
-    ])
-
-    await server.start()
-    console.log(`Ready to go! See ${server.info.uri}`)
-})();