Feature/dotenv flow (#23)

* Add dotenv-flow package

* Add local env files rule to gitignore

* Add example env file

* Update readme with new env setup instructions

* Implement review suggestions

- Refactor env variables usages
- Refactor .env files structure, in order to follow the recommendations of dotenv-flow's documentation
- Fix Docker configs to handle this change
- Fix TravisCI configs to handle this change
- Made shell scripts safer 🍝
- Update README.md with the new information
- Accidentally started work on #24
- Everything was tested and analised thoroughly

Author: xRuiAlves

.env

@@ -0,0 +1,16 @@
+# Specifies the host for the mongodb database
+DB_HOST=localhost
+# Specifies the port for the mongodb database
+DB_PORT=27017
+# Specifies the username with which to connect to the database
+DB_USER=
+# Specified the password with which to connect to the database
+DB_PASS=
+# Specifies the name of the database to connect to
+DB_NAME=nijobs
+
+# Session secret - OVERRIDE IN PRODUCTION
+SESSION_SECRET=O Rui foi membro do IEEE.
+
+# Specifies the port in which the app will be exposed
+PORT=8000

.gitignore

@@ -1,5 +1,8 @@
+# Env related
+# Ignoring the local configuration files. However .env.ENVIRONMENT (and .env) SHOULD be version controlled! See dotenv-flow's docs for details: https://www.npmjs.com/package/dotenv-flow
+.env*.local
+
 # Extras
-.env
 .vscode
 
 # Created by https://www.gitignore.io/api/node,macos,linux,windows

.travis.yml

@@ -10,7 +10,7 @@ services:
 
 env:
   global:
-    - HOST_PORT=3000
+    # The hostname is set to mongo because of the docker configuration (using networks to access the DB)
     - DB_HOSTNAME=mongo
   matrix:
     # Any separate test environment variables go here, one per line each creating a different test environment
@@ -19,4 +19,4 @@ script:
   - docker-compose up --exit-code-from test test
 
 cache:
-  npm: true
+  npm: true

Dockerfile

@@ -2,24 +2,21 @@
 # Use node 8-LTS
 FROM node:8
 
-RUN mkdir -p /usr/src/nijobs-be
-WORKDIR /usr/src/nijobs-be
+WORKDIR /usr/src/app
 
 # Install app dependencies
-# A wildcard is used to ensure both package.json AND package-lock.json are copied
-# where available (npm@5+)
-COPY package*.json ./
+COPY package.json package-lock.json ./
 
-# Install Node Packages (only production if not in dev mode)
+# Install Node Packages
 RUN npm install
 
 # Copying app source
-COPY ./src ./src
-
-# Copying .env file because it is necessary for the app to run
-COPY .env ./
+COPY src/ src/
 
 # Copying test suite
-COPY ./test ./test
+COPY test/ test/
+
+# Copying .env files
+COPY .env* ./
 
-CMD ["npm", "start"]
+CMD ["npm", "start"]

Dockerfile-prod

@@ -2,21 +2,18 @@
 # Use node 8-LTS
 FROM node:8
 
-RUN mkdir -p /usr/src/nijobs-be
-WORKDIR /usr/src/nijobs-be
+WORKDIR /usr/src/app
 
 # Install app dependencies
-# A wildcard is used to ensure both package.json AND package-lock.json are copied
-# where available (npm@5+)
-COPY package*.json ./
+COPY package.json package-lock.json ./
 
 # Install Node Packages (only production)
-RUN npm install --only=production
+RUN npm install --production
 
 # Copying app source
-COPY ./src ./src
+COPY src/ src/
 
-# Copying .env file because it is necessary for the app to run
-COPY .env ./
+# Copying .env files
+COPY .env* ./
 
-CMD ["npm", "run", "prod"]
+CMD ["npm", "run", "prod"]

Dockerfile-test

@@ -2,24 +2,24 @@
 # Use node 8-LTS
 FROM node:8
 
-RUN mkdir -p /usr/src/nijobs-be
-WORKDIR /usr/src/nijobs-be
+WORKDIR /usr/src/app
 
 # Install app dependencies
-# A wildcard is used to ensure both package.json AND package-lock.json are copied
-# where available (npm@5+)
-COPY package*.json ./
+COPY package.json package-lock.json ./
 
-# Install Node Packages (only production if not in dev mode)
+# Install Node Packages
 RUN npm install
 
 # Copying app source
-COPY ./src ./src
+COPY src/ src/
 
 # Copying test suite
-COPY ./test ./test
+COPY test/ test/
 
 # Copying linting configuration (for running the linter)
 COPY .eslintrc.json .
 
-CMD ["npm", "test"]
+# Copying .env files
+COPY .env* ./
+
+CMD ["npm", "test"]

README.md

@@ -28,26 +28,38 @@ Next, follow [these](https://docs.docker.com/install/linux/linux-postinstall/) s
 
 ### Installing Docker Compose
 
-The best approach to install `docker-compose` is to follow the offical guide [here](https://docs.docker.com/compose/install/#install-compose). 
+The best approach to install `docker-compose` is to follow the offical guide [here](https://docs.docker.com/compose/install/#install-compose).
+
+### Env files setup
+
+To start developing, copy `.env` to `.env.local` (by running `cp .env .env.local`).
+
+`.env.local` (the file you just created) is your local configuration file, in which you should override the default configurations provided by `.env`.
+
+Then, you can override the variable's values, according to their explanation in `.env`.
+
 
 ## Usage
 
+After [setting up your env files](#env-files-setup), you can run the project:
+
 ### Development Environment
-To start developing, you must create a file `.env` with environment variables, which are explained in more detail [below](#env-file-specification).
 
-After creating the `.env` file, you must build a dev server.
+You can start developing by building a local server:
 
 ```bash
 docker-compose build web-dev
 ```
+
 If you have already built the images/containers before you can simply run:
+
 ```bash
 docker-compose up web-dev
 ```
 
 > A `dev.sh` file is available in the project's root folder to run these commands on linux environments (simply run `./dev.sh [--build]`)
 
-This will create a development server with hot reloading which will listen on `http://localhost:<HOST_PORT>`.
+This will create a development server with hot reloading which will listen on `http://localhost:<PORT>`.
 
 ### Testing Environment
 
@@ -65,7 +77,7 @@ docker-compose up test mongo --exit-code-from test
 
 ### Production Environment
 
-The production environment is created by doing:
+The production environment can be created by doing:
 
 ```bash
 docker-compose build web-prod
@@ -79,15 +91,24 @@ docker-compose up web-prod
 
 This environment doesn't have hot reloading or dev extensions and is made to be used in the deployment server running this aplication.
 
-### Env File Specification
+### Manual Configuration (Recommended for flexibility)
+
+> In order to install and manage versions for `nodejs`, the usage of a version manager such as [`asdf`](https://asdf-vm.com/) (very recommended) or [`nvm`](https://github.com/nvm-sh/nvm) (still decent, but limited to `node`).
+
+If you already have a `node` installation you can simply use the `npm` commands specified in `package.json` directly.
+
+So, you can run:
+
+- `npm start` to run the application in development mode, with hot reloading
+- `npm test` to run the test suites
+- `npm run prod` to serve the development version of the project
+- Other `npm run` scripts configured in `package.json` (such as linting, for example)
 
-- `HOST_PORT`= The port that the server will expose (http://localhost:<HOST_PORT>)
-- `MONGO_URI`= [Optional] Specify a URI for an external mongo database
-- `DB_HOSTNAME`=  The hostname of the DB, in the case of not wanting to specify the full URI (defaults to `localhost`) - Useful for setting up docker containers, for example (the current docker configuration already considers this)
+This approach might be the least straightforward to set up but is the most flexible as you can freely and directly interact with the runtime of the application.
 
 ## Project Details
 
-This project uses [`Node.js`](https://nodejs.org/en/) with [`Express.js`](https://expressjs.com/) for the API routing and request-response logic. The DBMS used is [`MongoDB`](https://www.mongodb.com/), along with [`Mongoose`](https://mongoosejs.com/) for the communication to it in Node.
+This project uses [`Node.js`](https://nodejs.org/en/) with [`Express.js`](https://expressjs.com/) for the API routing and request-response logic. The DBMS used is [`MongoDB`](https://www.mongodb.com/), along with [`Mongoose`](https://mongoosejs.com/) for integrating it with Node.
 
 Testing is done using [`Mocha`](https://mochajs.org/) and [`Chai`](https://www.chaijs.com/).
 

dev.sh

@@ -1,3 +1,3 @@
 #!/usr/bin/env sh
 
-docker-compose up $1 web-dev
+docker-compose up "$1" web-dev

docker-compose.yml

@@ -4,46 +4,36 @@ services:
     build: 
       context: .
       dockerfile: Dockerfile-prod
-    volumes:
-      - ./src:/usr/src/nijobs-be/src
-    ports:
-      - ${HOST_PORT}:3000
     environment:
-      - PORT=3000
-      - NODE_ENV=prod
-      - DB_HOSTNAME=mongo
+      - DB_HOST=mongo
+    ports:
+      - "${PORT}:${PORT}"
     depends_on:
       - mongo
   web-dev:
     build:
       context: .
       dockerfile: Dockerfile
+    ports:
+      - "${PORT}:${PORT}"
     environment:
-      - PORT=3001
-      - NODE_ENV=dev
-      - DB_HOSTNAME=mongo
+      - DB_HOST=mongo
     volumes:
       - ./src:/usr/src/nijobs-be/src
-    ports:
-      - "${HOST_PORT}:3001"
     depends_on:
       - mongo
   test:
     build:
       context: .
       dockerfile: Dockerfile-test
     environment:
-      - PORT=3002
-      - NODE_ENV=test
-      - DB_HOSTNAME=mongo
+      - DB_HOST=mongo
     volumes:
       - ./src:/usr/src/nijobs-be/src
       - ./test:/usr/src/nijobs-be/test
-    ports:
-      - "${HOST_PORT}:3002"
     depends_on:
       - mongo
   mongo:
     image: mongo
     ports:
-      - "27017:27017"
+      - "27017:27017"

package-lock.json

@@ -34,7 +34,7 @@
   "dependencies": {
     "bcrypt-nodejs": "0.0.3",
     "body-parser": "^1.18.3",
-    "dotenv": "^6.2.0",
+    "dotenv-flow": "^3.0.0",
     "express": "^4.16.4",
     "express-session": "^1.15.6",
     "passport": "^0.4.0",

package.json

@@ -1,3 +1,3 @@
 #!/usr/bin/env sh
 
-docker-compose up $1 web-prod
+docker-compose up "$1" web-prod

prod.sh

@@ -1,19 +1,32 @@
 const mongoose = require("mongoose");
 
-// Default mongo port
-const DB_PORT = 27017;
-const DB_HOST = process.env.DB_HOSTNAME || "localhost";
+// Getting configs from env variables (.env files)
+const {
+    DB_HOST,
+    DB_PORT,
+    DB_USER,
+    DB_PASS,
+    DB_NAME,
+} = process.env;
 
-const MONGO_URI = process.env.MONGO_URI || `mongodb://${DB_HOST}:${DB_PORT}`;
+if (!DB_HOST || !DB_PORT) {
+    console.error("'DB_HOST' and 'DB_PORT' must be specified in the env file! See README.md for details.");
+    process.exit(125);
+}
 
-const DB_NAME = (process.env.NODE_ENV === "test" ? "test-db" : "nijobs-db");
+if (!DB_NAME) {
+    console.error("'DB_NAME' must be specified in the env file! See README.md for details.");
+    process.exit(126);
+}
 
 const options = {
     useNewUrlParser: true,
-    dbName: process.env.MONGO_URI ? undefined : DB_NAME,
+    dbName: DB_NAME,
+    user: DB_USER,
+    pass: DB_PASS,
     useCreateIndex: true,
 };
 
-const db_connection_promise = mongoose.connect(MONGO_URI, options);
+const db_connection_promise = mongoose.connect(`mongodb://${DB_HOST}:${DB_PORT}`, options);
 
-module.exports = db_connection_promise;
+module.exports = db_connection_promise;