Merge pull request #116 from neonexus/master (v5.0.0)

Fixed the Ngrok script to use Sails' internal configuration loader. Updated deps. Made interactive things.

Author: neonexus

.idea/dictionaries/neonexus.xml

@@ -8,6 +8,4 @@ services: mysql
 before_install:
     - mysql -e 'CREATE DATABASE IF NOT EXISTS testing;'
     - mysql -e "ALTER USER 'root'@'localhost' IDENTIFIED BY 'mypass'"
-after_success: npm run codecov
-deploy:
-    skip_cleanup: true
+script: npm run codecov

.idea/runConfigurations/Start_Frontend.xml

@@ -1,5 +1,20 @@
 # Changelog
 
+## [v5.0.0](https://github.com/neonexus/sails-react-bootstrap-webpack/compare/v4.3.1...v5.0.0) (2023-12-05)
+### Features
+
+* Made [`app.js`](app.js) executable, so now you can run `./app.js` directly.
+* Rewrote how the Ngrok script reads Sails' config files (now uses Sails' internal config loader).
+* Fixed Travis / Codecov integration (so now it's not running the test suite twice).
+* Created the `enforceForeignKeys` config option, to make testing PRODUCTION locally easier.
+* Changed the configuration for PRODUCTION's `DATA_ENCRYPTION_KEY`. Will now throw an error on boot if not supplied.
+* Made [`bootstrap.js`](config/bootstrap.js) enforce use of either `app.js` or `ngrok.js` through detection of `NOT_FROM_SAILS_LIFT` environment variable.
+* Created a new configuration file ([`config/ngrok.js`](config/ngrok.js)) for [ngrok.js](ngrok.js).
+* Fixed relative links in README.
+* Created the [`setup.js`](setup.js) script for easy interactive configuration.
+* Made `npm run create:admin` interactive.
+* Updated dependencies.
+
 ## [v4.3.1](https://github.com/neonexus/sails-react-bootstrap-webpack/compare/v4.3.0...v4.3.1) (2023-11-05)
 ### Features
 

.travis.yml

@@ -4,10 +4,10 @@ MAINTAINER NeoNexus DeMortis
 RUN mkdir /var/www && mkdir /var/www/myapp
 WORKDIR /var/www/myapp
 
-# If you change the exposed port, you need to also change the environment variable PORT below to the same port, or nothing will work
+# If you change the exposed port, you need to also change the environment variable PORT below to the same port, or nothing will work.
 EXPOSE 1337
 # REMEMBER! NEVER STORE SECRETS, DEK's, PASSWORDS, OR ANYTHING OF A SENSITIVE NATURE IN SOURCE CONTROL (INCLUDING THIS FILE)! USE ENVIRONMENT VARIABLES!
-ENV PORT=1337 DB_HOSTNAME=dockerdb DB_USERNAME=dockeruser DB_PASSWORD=dockerpass DB_NAME=docker DB_PORT=3306 DB_SSL=true DATA_ENCRYPTION_KEY=1234abcd4321asdf0987lkjh SESSION_SECRET=0987poiuqwer1234zxcvmnbv
+ENV PORT=1337 DB_HOSTNAME=dockerdb DB_USERNAME=dockeruser DB_PASSWORD=dockerpass DB_NAME=docker DB_PORT=3306 DB_SSL=true DATA_ENCRYPTION_KEY=null SESSION_SECRET=null
 
 # This keeps builds more efficient, because we can use Docker cache more effectively.
 COPY package.json package.json

CHANGELOG.md

@@ -7,7 +7,7 @@ const moment = require('moment-timezone');
  * @function sails.helpers.generateToken
  * @param {String} [extra='Evil will always triumph, because good is dumb. -Lord Helmet'] - A bit of random, extra bits to change up the hash.
  *
- * @returns {String} A SHA256 hash of a cryptographically-secure, randomly generated string of characters.
+ * @returns {String} A SHA512 hash of a cryptographically-secure, randomly generated string of characters.
  */
 module.exports = {
     friendlyName: 'Generate Token',

Dockerfile

@@ -37,7 +37,7 @@ module.exports = {
             isPassPhrase = false;
 
         if (inputs.password.length < 7) {
-            errors.push('Password must be at least 7 characters');
+            errors.push('Password must be at least 7 characters.');
         }
 
         if (inputs.password.length > 70) {
@@ -52,37 +52,37 @@ module.exports = {
 
         if (inputs.user) {
             if (inputs.user.email && inputs.password.indexOf(inputs.user.email) >= 0) {
-                errors.push('Password can not contain your email address');
+                errors.push('Password can not contain your email address.');
             }
 
             if (inputs.user.firstName && inputs.password.indexOf(inputs.user.firstName) >= 0) {
-                errors.push('Password can not contain your first name');
+                errors.push('Password can not contain your first name.');
             }
 
             if (inputs.user.lastName && inputs.password.indexOf(inputs.user.lastName) >= 0) {
-                errors.push('Password can not contain your last name');
+                errors.push('Password can not contain your last name.');
             }
         }
 
         if (/(.)\1{2,}/.test(inputs.password)) {
-            errors.push('Password can not contain 3 or more repeated characters');
+            errors.push('Password can not contain 3 or more repeated characters.');
         }
 
         if (!isPassPhrase) {
             if (!/(?=[a-z])/.test(inputs.password)) {
-                errors.push('Password must have at least 1 lowercase character');
+                errors.push('Password must have at least 1 lowercase character.');
             }
 
             if (!/(?=[A-Z])/.test(inputs.password)) {
-                errors.push('Password must have at least 1 uppercase character');
+                errors.push('Password must have at least 1 uppercase character.');
             }
 
             if (!/(?=[0-9])/.test(inputs.password)) {
-                errors.push('Password must have at least 1 digit');
+                errors.push('Password must have at least 1 digit.');
             }
 
             if (!/(?=[^a-zA-Z0-9])/.test(inputs.password)) {
-                errors.push('Password must have at least 1 special character');
+                errors.push('Password must have at least 1 special character.');
             }
         }
 
@@ -120,7 +120,7 @@ module.exports = {
                     }
 
                     /* istanbul ignore next */
-                    return exits.success(['Unknown internal error']);
+                    return exits.success(['Unknown internal error when talking with PwnedPasswords.com.']);
                 });
             } else {
                 return exits.success(true);

README.md

@@ -1,8 +1,11 @@
+#!/usr/bin/env node
+
 /**
  * app.js
  *
  * Use `app.js` to run your app without `sails lift`.
  * To start the server, run: `node app.js`.
+ * Or directly: `./app.js`.
  *
  * This is handy in situations where the sails CLI is not relevant or useful,
  * such as when you deploy to a server, or a PaaS like Heroku.
@@ -38,22 +41,26 @@ try {
     console.error('Encountered an error when attempting to require(\'sails\'):');
     console.error(err.stack);
     console.error('--');
-    console.error('To run an app using `node app.js`, you need to have Sails installed');
-    console.error('locally (`./node_modules/sails`).  To do that, just make sure you\'re');
-    console.error('in the same directory as your app and run `npm install`.');
-    console.error();
-    console.error('If Sails is installed globally (i.e. `npm install -g sails`) you can');
-    console.error('also run this app with `sails lift`.  Running with `sails lift` will');
-    console.error('not run this file (`app.js`), but it will do exactly the same thing.');
-    console.error('(It even uses your app directory\'s local Sails install, if possible.)');
-    return;
+    console.error('Did you run `npm install`?');
 }//-•
 
+// Small safety trigger, to help prevent use of `sails lift`, as that circumvents our custom error handlers / configuration overrides.
+process.env.NOT_FROM_SAILS_LIFT = 'true'; // Can't use booleans with environment variables... That's just silly!
 
 // Start server
 sails.lift(rc('sails'), (err, server) => {
     if (err) {
-        return console.error(err);
+        switch (err.code) {
+            case 'E_INVALID_DATA_ENCRYPTION_KEYS':
+                return console.error(
+                    '\nSails is complaining about bad DEK\'s (Data Encryption Keys).'
+                    + '\nThis is likely caused by running as PRODUCTION without a DATA_ENCRYPTION_KEY environment variable set.'
+                    + '\n\nThe DEK ID that is being reported as invalid:   ' + err.dekId
+                    + '\n\nTo generate a new DEK:    npm run generate:dek\n'
+                );
+            default:
+                return console.error(err);
+        }
     }
 
     console.log('');

api/helpers/generate-token.js

@@ -1,13 +1,9 @@
 $bootstrap-icons-font-dir: "~bootstrap-icons/font/fonts";
 @import "~bootstrap-icons/font/bootstrap-icons";
 
-body {
-    transition: all ease .5s;
-}
-
 // fixes a flashing issue when changing themes
 .nav-item .nav-link.active, table {
-    transition: all ease .5s;
+    //transition: all ease .5s;
 }
 
 // .prevent-validation class

api/helpers/is-password-valid.js

@@ -7,22 +7,28 @@
  * For more info, see: https://www.npmjs.com/package/sails-hook-autoreload
  */
 
-module.exports.autoreload = {
-    active: true,
+module.exports = {
+    autoreload: {
+        active: true,
 
-    dirs: [
-        'api/controllers',
-        'api/helpers',
-        'api/hooks',
-        'api/models',
-        'api/policies',
-        'api/responses',
-        'config'
-    ],
+        dirs: [
+            'api/controllers',
+            'api/helpers',
+            'api/hooks',
+            'api/models',
+            'api/policies',
+            'api/responses',
+            'config'
+        ],
 
-    ignored: [
-        '**.md'
-    ],
+        ignored: [
+            '**.md'
+        ],
 
-    overrideMigrateSetting: false
+        overrideMigrateSetting: false
+    },
+
+    models: {
+        archiveModelIdentity: false
+    }
 };