Updated README with info about schema validation.

Author: neonexus

README.md

@@ -8,6 +8,7 @@ This is an opinionated base [Sails v1](https://sailsjs.com) application, using W
 + Setup for Webpack auto-reload dev server.
 + Setup so Sails will serve Webpack-built bundles as separate apps (so, a marketing site, and an admin site can live side-by-side).
 + Includes [react-bootstrap](https://www.npmjs.com/package/react-bootstrap) to make using Bootstrap styles / features with React easier.
++ Schema validation and enforcement for `PRODUCTION`. This repo is setup for `MySQL`. If you plan to use a different datastore, you will want to modify [`config/bootstrap.js`](config/bootstrap.js) (not to be confused with the CSS framework, this config file is what Sails runs just before finally "lifting". See [Sails documentation](https://sailsjs.com/config/bootstrap) about the `config/bootstrap.js` file.)
 
 ## How to Use
 This repo is not installable via `npm`. It should be forked to help kick-start projects.
@@ -43,14 +44,29 @@ The webpack configuration can be found in the `config/webpack` folder. The major
 ## Building with React
 React source files live in the `assets/src` folder. It is structured in such a way, where the `index.jsx` is really only used for local development (to help Webpack serve up the correct "app"). Then, there are the individual "apps", [main](assets/src/main.jsx) and [admin](assets/src/admin.jsx). These files are used as Webpack "[entry points](https://webpack.js.org/concepts/entry-points/)", to create 2 separate application bundles.
 
-In a remote environment, Sails will look at the first subdirectory requested, and use that to determine which `index.html` file it needs to actually return. So, in this case, the "main" application will get built in `.tmp/public/main`, where the CSS is `.tmp/public/main/bundle.css`, the JavaScript is `.tmp/public/main/bundle.js`, and the HTML is `.tmp/public/main/index.html`. To view the main application, one would just go to `http://mydomain/` which gets redirected to `/main` (because need to know what application we are using), and now Sails will serve the `main` application. Where as, if one were to go to `http://mydomain/admin`, Sails would now serve the `admin` application bundle.
+In a remote environment, Sails will look at the first subdirectory requested, and use that to determine which `index.html` file it needs to actually return. So, in this case, the "main" application will get built in `.tmp/public/main`, where the CSS is `.tmp/public/main/bundle.css`, the JavaScript is `.tmp/public/main/bundle.js`, and the HTML is `.tmp/public/main/index.html`. To view the main application, one would just go to `http://mydomain/` which gets redirected to `/main` (because we need to know what application we are using, we need a subdirectory), and now Sails will serve the `main` application. Whereas, if one were to go to `http://mydomain/admin`, Sails would now serve the `admin` application bundle (aka `.tmp/public/admin/index.html`).
 
-### Links
+## Schema Validation and Enforcement
+Inside [`config/bootstrap.js`](config/bootstrap.js) is a bit of logic (**HEAVILY ROOTED IN NATIVE `MySQL` QUERIES**), which validates column types in the `PRODUCTION` database (aka `sails.config.models.migrate === 'safe'`), then will validate foreign key indexes. If there are too many columns, or there is a missing index, or incorrect column type, the logic will `console.error` any issues, then `process.exit(1)` (kill) the Sails server. The idea here, is that if anything is out of alignment, Sails will fail to lift, which will mean failure to deploy on AWS.
+
+### If you do not want schema validation
+... then replace the contents of `config/bootstrap.js` with the following:
+
+```javascript
+module.exports.bootstrap = function(next) {
+    // You must call the callback function, or Sails will fail to lift!
+    next();
+};
+```
+
+### Useful Links
 
 + [Sails Framework Documentation](https://sailsjs.com/get-started)
 + [Sails Deployment Tips](https://sailsjs.com/documentation/concepts/deployment)
 + [Sails Community Support Options](https://sailsjs.com/support)
 + [Sails Professional / Enterprise Options](https://sailsjs.com/enterprise)
++ [`react-bootstrap` Documentation](https://react-bootstrap.netlify.app/)
++ [Webpack Documentation](https://webpack.js.org/)
 
 
 ### Version info

api/helpers/get-error-messages.js

@@ -20,20 +20,20 @@ module.exports = {
             if (err.invalidAttributes && err.Errors) {
                 err = _.merge({}, err.invalidAttributes, err.Errors);
 
-                sails.helpers.objForEach(err, function(error){
-                    error.forEach(function(errMessage){
+                _.forEach(err, (error) => {
+                    error.forEach((errMessage) => {
                         errors.push(errMessage.message);
                     });
                 });
             } else if (err.invalidAttributes) {
-                sails.helpers.objForEach(err.invalidAttributes, function(error){
-                    error.forEach(function(errMessage){
+                _.forEach(err.invalidAttributes, (error) => {
+                    error.forEach((errMessage) => {
                         errors.push(errMessage.message);
                     });
                 });
             } else if (err.Errors) {
-                sails.helpers.objForEach(err.Errors, function(error){
-                    error.forEach(function(errMessage){
+                _.forEach(err.Errors, (error) => {
+                    error.forEach((errMessage) => {
                         errors.push(errMessage.message);
                     });
                 });

api/helpers/obj-for-each.js

@@ -9,17 +9,15 @@
  * https://sailsjs.com/config/bootstrap
  */
 
-// Use this for headers: http://patorjk.com/software/taag/#p=display&c=c&f=ANSI%20Shadow&t=ZeroHour
-// Use this for subheaders: http://patorjk.com/software/taag/#p=display&c=c&f=Calvin%20S&t=ZeroHour
-
-const fs = require('fs');
+// Use this for headers: http://patorjk.com/software/taag/#p=display&c=c&f=ANSI%20Shadow&t=Sails
+// Use this for subheaders: http://patorjk.com/software/taag/#p=display&c=c&f=Calvin%20S&t=Woot
 
 module.exports.bootstrap = function(next) {
     // Check if we need to validate our schema
-    if (sails.config.models.migrate === 'safe') { // aka PROD
+    if (sails.config.models.migrate === 'safe') { // aka PRODUCTION
         let waitingToFinish = 0;
 
-        sails.helpers.objForEach(sails.models, (model, modelName) => {
+        _.forEach(sails.models, (model, modelName) => {
             if (model.tableName !== 'archive') {
                 waitingToFinish++;
 
@@ -262,28 +260,39 @@ module.exports.bootstrap = function(next) {
             }, 20);
         })();
 
-        // something is taking WAY too long... assume the worst
+        // something is taking WAY too long... assume the worst... BAIL!
         setTimeout(() => {
             if (waitingToFinish > 0) {
                 console.error('The database schema does not appear to match the model definitions.');
                 process.exit(1);
             }
         }, 5000);
     } else {
+        /***
+         *    ┌┐┌┌─┐┌┬┐  ┌─┐┬─┐┌─┐┌┬┐┬ ┬┌─┐┌┬┐┬┌─┐┌┐┌
+         *    ││││ │ │   ├─┘├┬┘│ │ │││ ││   │ ││ ││││
+         *    ┘└┘└─┘ ┴   ┴  ┴└─└─┘─┴┘└─┘└─┘ ┴ ┴└─┘┘└┘
+         */
+
         // no safety requirement for database modifications, bypass safeties
         return next();
     }
 
     function validateIndexes() {
         let waitingToFinish = 0;
 
-        sails.helpers.objForEach(sails.models, (model, modelName) => {
+        _.forEach(sails.models, (model, modelName) => {
             if (model.tableName !== 'archive' && model.associations && model.associations.length) {
                 model.associations.map((association) => {
                     waitingToFinish++;
 
-                    // check this isn't a collection
+                    // make sure this isn't a collection
                     if (!association.collection) {
+                        /***
+                         *    ┌─┐┌─┐┌┬┐  ┌─┐┌─┐┬─┐┌─┐┬┌─┐┌┐┌  ┬┌─┌─┐┬ ┬┌─┐
+                         *    │ ┬├┤  │   ├┤ │ │├┬┘├┤ ││ ┬│││  ├┴┐├┤ └┬┘└─┐
+                         *    └─┘└─┘ ┴   └  └─┘┴└─└─┘┴└─┘┘└┘  ┴ ┴└─┘ ┴ └─┘
+                         */
                         sails.sendNativeQuery(
                             'SELECT * FROM `information_schema`.`KEY_COLUMN_USAGE` WHERE `TABLE_NAME` = \'' + model.tableName
                             + '\' AND `COLUMN_NAME` = \'' + association.alias
@@ -293,17 +302,34 @@ module.exports.bootstrap = function(next) {
                                 if (err) {
                                     console.error(err);
 
-                                    return console.error('I can\'t seem to read the required relationship data. HALTING!');
+                                    console.error('I can\'t seem to read the required relationship data. HALTING!');
+
+                                    return process.exit(1);
                                 }
 
                                 if (!foundKeys.rows[0] || !foundKeys.rows[0]['REFERENCED_COLUMN_NAME'] || foundKeys.rows[0]['REFERENCED_COLUMN_NAME'] !== sails.models[association.model].primaryKey) {
+                                    /***
+                                     *    ┌┐┌┌─┐  ┬─┐┌─┐┬  ┌─┐┌┬┐┬┌─┐┌┐┌┌─┐┬ ┬┬┌─┐  ┌─┐┌─┐┬ ┬┌┐┌┌┬┐
+                                     *    ││││ │  ├┬┘├┤ │  ├─┤ │ ││ ││││└─┐├─┤│├─┘  ├┤ │ ││ ││││ ││
+                                     *    ┘└┘└─┘  ┴└─└─┘┴─┘┴ ┴ ┴ ┴└─┘┘└┘└─┘┴ ┴┴┴    └  └─┘└─┘┘└┘─┴┘
+                                     */
                                     console.error('Column "' + association.alias + '" for "' + modelName + '" does not have a relationship setup');
                                 } else {
+                                    /***
+                                     *    ┬─┐┌─┐┬  ┌─┐┌┬┐┬┌─┐┌┐┌┌─┐┬ ┬┬┌─┐  ┌─┐┌─┐┬ ┬┌┐┌┌┬┐
+                                     *    ├┬┘├┤ │  ├─┤ │ ││ ││││└─┐├─┤│├─┘  ├┤ │ ││ ││││ ││
+                                     *    ┴└─└─┘┴─┘┴ ┴ ┴ ┴└─┘┘└┘└─┘┴ ┴┴┴    └  └─┘└─┘┘└┘─┴┘
+                                     */
                                     waitingToFinish--;
                                 }
                             }
                         );
                     } else {
+                        /***
+                         *    ┬ ┬┌─┐┌─┐  ┌─┐┌─┐┬  ┬  ┌─┐┌─┐┌┬┐┬┌─┐┌┐┌
+                         *    │││├─┤└─┐  │  │ ││  │  ├┤ │   │ ││ ││││
+                         *    └┴┘┴ ┴└─┘  └─┘└─┘┴─┘┴─┘└─┘└─┘ ┴ ┴└─┘┘└┘
+                         */
                         waitingToFinish--;
                     }
                 });
@@ -322,7 +348,7 @@ module.exports.bootstrap = function(next) {
 
         setTimeout(() => {
             if (waitingToFinish > 0) {
-                console.error('The database schema is missing indexes.');
+                console.error('The database schema is missing foreign key indexes.');
                 process.exit(1);
             }
         }, 3000);