Merge pull request #5 from davidsilva/feature/refine-workflow

Feature/refine workflow

Author: davidsilva

.devcontainer/devcontainer.json

@@ -4,6 +4,7 @@
   "name": "Node.js & TypeScript",
   // Or use a Dockerfile or Docker Compose file. More info: https://containers.dev/guide/dockerfile
   "image": "mcr.microsoft.com/devcontainers/typescript-node:1-22-bookworm",
+  // Features to add to the dev container. More info: https://containers.dev/features.
   "features": {
     "ghcr.io/devcontainers-extra/features/angular-cli:2": {},
     "ghcr.io/hspaans/devcontainer-features/sshpass:1": {},
@@ -13,17 +14,21 @@
     "ghcr.io/devcontainers/features/aws-cli:1": {},
     "ghcr.io/robbert229/devcontainer-features/postgresql-client:1": {}
   },
+  // Specify a network that the app's Docker containers and services can share.
+  // This allows the containers to communicate with each other using their service names,
+  // which is useful for setting up a consistent development environment where services
+  // like databases, APIs, and front-end applications can interact seamlessly.
   "runArgs": ["--init", "--privileged", "--network=interview-prep_devnetwork"],
   "remoteUser": "root",
   "mounts": [
+    // Allow authenticating with GitHub using the same SSH agent
     "source=${localEnv:HOME}/.ssh,target=/root/.ssh,type=bind,consistency=cached",
+    // Allow devcontainer to communicate with the host's Docker daemon
     "source=/var/run/docker.sock,target=/var/run/docker.sock,type=bind",
+    // Allow devcontainer to use the host's AWS credentials and configuration
     "source=${localEnv:HOME}/.aws,target=/root/.aws,type=bind,consistency=cached"
   ]
 
-  // Features to add to the dev container. More info: https://containers.dev/features.
-  // "features": {},
-
   // Use 'forwardPorts' to make a list of ports inside the container available locally.
   // "forwardPorts": [],
 

.env.example

@@ -1,8 +1,2 @@
-FLYWAY_USER=your_db_user
-FLYWAY_PASSWORD=your_db_password
-FLYWAY_DB=your_db_name
-# Using port 5433 because 5432 is already in use by the local PostgreSQL server
-# localhost because an SSH tunnel is used to connect to the RDS instance
-FLYWAY_URL=jdbc:postgresql://localhost:5433/your_db_name
 PORT=3000
 DATABASE_URL=postgres://your_db_user:your_db_password@localhost:5432/your_db_name

.gitignore

@@ -63,7 +63,4 @@ Thumbs.db
 
 !.env.example
 
-# Flyway
-flyway.conf
-
 notes.md

README.md

@@ -1,8 +1,40 @@
 # InterviewPrep
 
-This project was generated with [Angular CLI](https://github.com/angular/angular-cli) version 18.2.4.
+This project grew out of wanting to prepare for an interview for a job that would have focused on Angular. As I had been using React exclusively for several months, I needed to refresh my Angular skills. Then I began to add more things to make up for my focus on AWS Amplify. The result is in some ways the opposite of what I have in my previous videos:
+
+* Angular instead of React/NextJS
+* Angular Material instead of AWS Amplify's UI library. (I do, however, use Tailwind CSS in both.)
+* Postgres instead of DynamoDB (Sql vs NoSQL)
+* REST (using a NodeJS/Express backend) vs GraphQL (using Amplify and AppSync)
+* This project has nothing in regard to authentication (yet), while the Amplify project implemented authentication right at the beginning.
+
+Also, in the Amplify project I haven't yet implemented any automated testing but in this project I have unit and integration tests. I set up a GitHub Workflow with GitHub Actions to run the tests when there is a push to or a pull request on specified branches.
+
+This project is Dockerized, and I developed it in a devcontainer. 
+
+You'll see some Terraform files in the project but I'll get to that in the next video.
+
+## Devcontainer
+
+I'm using the [Node.js & TypeScript (typescript-node)](https://github.com/devcontainers/templates/tree/main/src/typescript-node) devcontainer. The features I added are
+
+* [sshpass](https://github.com/hspaans/devcontainer-features/tree/master/src/sshpass): installs the GitHub CLI
+* [Angular CLI](https://github.com/devcontainers-extra/features/tree/main/src/angular-cli)
+* [docker-outside-of-docker](https://github.com/devcontainers/features/tree/main/src/docker-outside-of-docker): "Re-use the host docker socket, adding the Docker CLI to a container. Feature invokes a script to enable using a forwarded Docker socket within a container to run Docker commands."
+* [Prettier](https://github.com/devcontainers-community/npm-features/tree/main/src/prettier)
+* [AWS CLI](https://github.com/devcontainers/features/tree/main/src/aws-cli)
+* [Terraform](https://github.com/devcontainers/features/tree/main/src/terraform)
+* [PostgreSQL Client](https://github.com/robbert229/devcontainer-features/blob/main/src/postgresql-client/README.md)
+
+In devcontainer.json you'll see that I'm specifying a network. That's so the devcontainer and the Docker services can communicate with one another. For instance, from a shell within the devcontainer I can connect to the service running the Postgres test database.
+
+I also have some mounts so that
+
+* git can authenticate with GitHub using the SSH agent on my laptop (the host machine)
+* devcontainer can communicate with the host's Docker daemon
+* the AWS credentials and configuration are available within the devcontainer.
+
 
-## Development
 
 ### Frontend
 
@@ -50,22 +82,18 @@ To get more help on the Angular CLI use `ng help` or go check out the [Angular C
   `ssh -f -i <PATH TO KEY-PAIR PEM> -L 5433:interviewprepdbinstance.c92egeoumrf1.us-east-1.rds.amazonaws.com:5432 ec2-user@107.22.66.121 -N`
 - To keep SSH tunnel alive: `ssh -f -i <PATH TO KEY-PAIR PEM> -L 5433:interviewprepdbinstance.c92egeoumrf1.us-east-1.rds.amazonaws.com:5432 ec2-user@107.22.66.121 -N -o ServerAliveInterval=60 -o ServerAliveCountMax=3`
 
-## Flyway and Migrations
+## Migrations
 
 DB credentials and URLs are in `.env.local` and `.env.development`. Set the environment to be used: `export NODE_ENV=local` or `export NODE_ENV=production`.
 
-The migrations are run (if necessary) after the db container comes up.
-
 Maybe obsolete:
 
-You need an SSH tunnel to be able to run the Flyway migrations on the db in AWS. Check for a tunnel by using `ps aux | grep ssh`. It will look something like
+You need an SSH tunnel to be able to run the migrations on the db in AWS. Check for a tunnel by using `ps aux | grep ssh`. It will look something like
 
 ```
 davidsilva       69319   0.0  0.0 410379280   1904   ??  Ss   12:34PM   0:00.01 ssh -f -i /Users/davidsilva/Downloads/OnyxKeyPair.pem -L 5433:interviewprepdbinstance.c92egeoumrf1.us-east-1.rds.amazonaws.com:5432 ec2-user@107.22.66.121 -N
 ```
 
-To run migrations, run `./run-flyway.sh`.
-
 # SSH into Bastion Host
 
 The security group only allows SSH connections from my VPN IP address.
@@ -201,3 +229,14 @@ Could run in the background or in separate shell to have HTML reports loaded (an
 
 Everything except the tests will run because frontend is dependent upon backend, which is dependent upon db.
 `docker-compose --env-file .env.local up --build frontend`
+
+# Database
+
+With `interview-prep-db-1` up and running, you can access the db via psql using...
+
+`docker exec -it interview-prep-db-1 psql -U interviewprep_admin -d interviewprepdbinstance`
+
+## Run Migrations
+
+`docker-compose --env-file .env.local up migrate`
+

backend/src/knexFile.ts

@@ -1,15 +1,37 @@
 import { Knex } from 'knex';
 import dotenv from 'dotenv';
+import path from 'path';
+
+let envFile: string;
+
+switch (process.env['NODE_ENV']) {
+  case 'production':
+    envFile = '../.env.production';
+    break;
+  case 'development':
+    envFile = '../.env.development';
+    break;
+  case 'test':
+    envFile = '../.env.test';
+    break;
+  default:
+    envFile = '../.env.local';
+}
 
-const envFile =
-  process.env['NODE_ENV'] === 'production'
-    ? '../.env.production'
-    : process.env['NODE_ENV'] === 'test'
-    ? '../.env.test'
-    : '../.env.local';
 dotenv.config({ path: envFile });
 
 const config: { [key: string]: Knex.Config } = {
+  local: {
+    client: 'pg',
+    connection: process.env['DATABASE_URL'],
+    migrations: {
+      directory: path.join(__dirname, '../migrations'),
+    },
+    seeds: {
+      directory: path.join(__dirname, '../seeds'),
+    },
+    debug: true,
+  },
   development: {
     client: 'pg',
     connection: process.env['DATABASE_URL'],
@@ -24,10 +46,10 @@ const config: { [key: string]: Knex.Config } = {
     client: 'pg',
     connection: process.env['DATABASE_URL'],
     migrations: {
-      directory: './migrations',
+      directory: path.join(__dirname, '../migrations'),
     },
     seeds: {
-      directory: './seeds',
+      directory: path.join(__dirname, '../seeds'),
     },
   },
   production: {

docker-compose.yml

@@ -13,6 +13,8 @@ services:
     command: npm run start
     depends_on:
       - backend
+    networks:
+      - devnetwork
 
   backend:
     build:
@@ -26,6 +28,8 @@ services:
     command: npm run dev
     depends_on:
       - db
+    networks:
+      - devnetwork
 
   db:
     image: postgres:latest
@@ -53,13 +57,19 @@ services:
     networks:
       - devnetwork
 
-  flyway:
-    image: flyway/flyway:latest
-    command: -url=jdbc:postgresql://db:5432/interviewprepdbinstance -user=${POSTGRES_USER} -password=${POSTGRES_PASSWORD} migrate
+  migrate:
+    image: node:20
+    working_dir: /app/backend
     volumes:
-      - ./migrations:/flyway/migrations
+      - /Users/davidsilva/Dev/interview-prep:/app
+    environment:
+      - NODE_ENV=${NODE_ENV}
+      - DATABASE_URL=${DATABASE_URL}
+    command: sh -c "npm install && npx knex migrate:latest --knexfile=./src/knexFile.ts --env $NODE_ENV"
     depends_on:
       - db
+    networks:
+      - devnetwork
 
   frontend-tests:
     build: