minimonolith 0.18.1 → 0.19.0

package/.env.example

@@ -1,4 +1,4 @@
 MM_API_DB_DIALECT=sqlite
 MM_API_DB_STORAGE=:memory:
-MM_API_PROD_ENV=false
-MM_API_LOCAL_ENV=true
+MM_API_PROD_ENV=FALSE
+MM_API_DEV_ENV=TRUE

package/README.md

@@ -114,6 +114,29 @@ export default ({ MODELS }) => ({
 })
 ```
 
+## App Environments
+
+There are 4 possible environments: DEV=TRUE & PROD=FALSE, DEV=TRUE & PROD=TRUE, DEV=FALSE & PROD=TRUE, DEV=FALSE & PROD=TRUE
+1. DEV=TRUE & PROD=FALSE: This is the standard DEV environment
+2. DEV=FALSE & PROD=FALSE: This is the standard QA environment
+3. DEV=FALSE & PROD=TRUE: This is the stnadard PROD environment
+4. DEV=TRUE & PROD=TRUE: This allows to test the behavior of PROD within the "new concept" of DEV environment
+
+To better understand their relevance:
+1. The "new concept" DEV environments (DEV=TRUE) aim to make the api crash if an "important" error happens
+  1. Its current only difference is it makes it crash on error at service registration phase
+2. The "new concept" QA environments (PROD=FALSE) aim at logging data about the system which on production environments would be forbiden personal information
+  1. This is relevant because replication of QA activities (even security QA activities) depend heavily on this
+
+The current App environment is determined on the values of MM_API_DEV ENV [TRUE/FALSE] and MM_API_PROD_ENV [TRUE/FALSE]:
+
+```makefile
+# .env standard dev environment
+MM_API_DEV_ENV=TRUE
+MM_API_PROD_ENV=FALSE
+[...]
+```
+
 ## Database Authentication
 
 To set up authentication for the database, you need to provide the necessary environment variables in a `.env` file. Depending on the database dialect the required variables will differ.
@@ -121,27 +144,32 @@ To set up authentication for the database, you need to provide the necessary env
 For MySQL:
 
 ```makefile
+MM_API_DEV_ENV=TRUE
+MM_API_PROD_ENV=FALSE
 MM_API_DB_DIALECT=mysql
 MM_API_DB_HOST=<your_database_endpoint>
 MM_API_DB_PORT=<your_database_port>
 MM_API_DB_DATABASE=<your_database_name>
 MM_API_DB_USERNAME=<your_database_username>
 MM_API_DB_PASSWORD=<your_database_password>
-MM_API_LOCAL_ENV=true
-MM_API_PROD_ENV=false
 ```
 
 For SQLite:
 
 ```makefile
+MM_API_DEV_ENV=TRUE
+MM_API_PROD_ENV=FALSE
 MM_API_DB_DIALECT=sqlite
 MM_API_DB_STORAGE=:memory: # For in-memory SQLite database
 # Or
 MM_API_DB_STORAGE=path/to/your/sqlite/file.db # For file-based SQLite database
 MM_API_DB_DATABASE=<your_database_name>
-MM_API_LOCAL_ENV=true
-MM_API_PROD_ENV=false
 ```
 
-Make sure to replace the placeholders with your actual database credentials. The `MM_API_LOCAL_ENV` variable is used to allow Sequelize to alter table structure automatically when working locally, while the `MM_API_PROD_ENV` variable controls logging of secret credentials for debugging purposes in non-production environments.
-
+Make sure to replace the placeholders with your actual database credentials.
+- `MM_API_DEV_ENV=TRUE` allows Sequelize to alter table structure automatically when working locally
+- `MM_API_PROD_ENV=FALSE` allows logging of DB credentials for debugging purposes in non-production environments
+  - We consider high quality logging important for app performance and evolution
+  - However we recommend automatic DB credentials updates (daily) High quality logging does not mean
+    giving away your infraestructure to hackers
+  - At the risk of stating the obvious do not store personal information at the QA database

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "minimonolith",
   "type": "module",
-  "version": "0.18.1",
+  "version": "0.19.0",
   "main": "index.js",
   "license": "MIT",
   "scripts": {

package/src/crasher/crasher.js

@@ -1 +1 @@
-export default ERROR => { if (process.env.MM_API_LOCAL_ENV) throw ERROR; };
+export default ERROR => { if (process.env.MM_API_DEV_ENV==='TRUE') throw ERROR; };

package/src/database/databaseService.js

@@ -35,7 +35,7 @@ const registerDatabaseService = async API => {
     const SEQUELIZE_OPTIONS = { dialect: MM_API_DB_DIALECT, host: MM_API_DB_HOST,
       port: MM_API_DB_PORT, storage: MM_API_DB_STORAGE, logging: false };
 
-    logger.dev({ ROUTE_CODE, MM_API_DB_VARS: { MM_API_DB_DIALECT,
+    logger.qa({ ROUTE_CODE, MM_API_DB_VARS: { MM_API_DB_DIALECT,
       MM_API_DB_USER, MM_API_DB_PASS, MM_API_DB_HOST, MM_API_DB_PORT, MM_API_DB_DB, MM_API_DB_STORAGE }});
     API.ORM = new Sequelize(MM_API_DB_DB, MM_API_DB_USER, MM_API_DB_PASS, SEQUELIZE_OPTIONS);
     establishConnection(API.ORM);

package/src/logger/logger.js

@@ -1,5 +1,5 @@
 export default {
   error: (...ERROR) => { console.error(...ERROR) },
   log: (...MESSAGE) => { console.log(...MESSAGE) },
-  dev: (...MESSAGE) => { if (!process.env.MM_API_PROD_ENV) console.log(...MESSAGE) }
+  qa: (...MESSAGE) => { if (process.env.MM_API_PROD_ENV!=='TRUE') console.log(...MESSAGE) }
 };

package/src/model/loadModels.js

@@ -24,7 +24,7 @@ const loadAndSyncModels = async API => {
   });
 
   logger.log({ ROUTE_CODE, SYNCING_ORM: 'WAITING_FOR_ORM_SYNCING' });
-  await API.ORM.sync({ alter: process.env.MM_API_LOCAL_ENV ? true : false });
+  await API.ORM.sync({ alter: process.env.MM_API_DEV_ENV==='TRUE' ? true : false });
   logger.log({ ROUTE_CODE, SYNCING_ORM: 'DONE_ORM_SYNCING' });
 
   return MODELS;