Merge pull request #14 from davidsilva/chore/readme-and-clean-up

Chore/readme and clean up

Author: davidsilva

.github/workflows/ci.yml

@@ -70,11 +70,23 @@ jobs:
         working-directory: ./backend
         run: npm install
 
-      - name: Run backend tests
+      # Run integration tests separately to avoid db conflicts
+      - name: Run backend integration tests for users
         working-directory: ./backend
         env:
           DATABASE_URL: postgres://postgres:postgres@localhost:5432/testdb
-        run: npm test
+        run: npm test -- src/__tests__/integration/users.integration.test.ts
+
+      - name: Run backend integration tests for products
+        working-directory: ./backend
+        env:
+          DATABASE_URL: postgres://postgres:postgres@localhost:5432/testdb
+        run: npm test -- src/__tests__/integration/products.integration.test.ts
+
+      # Unit tests can be run together
+      - name: Run backend unit tests
+        working-directory: ./backend
+        run: npm test -- src/__tests__/unit
 
       - name: Install dependencies for frontend
         working-directory: ./frontend

README.md

@@ -1,7 +1,7 @@
 # Stage 1: Build the Node.js application
 FROM node:20 AS build
 
-WORKDIR /app
+WORKDIR /app/backend
 
 COPY package.json ./
 
@@ -14,15 +14,18 @@ RUN npm run build
 # Stage 2: Prepare to serve the application
 FROM node:20-alpine
 
-WORKDIR /app
+WORKDIR /app/backend
 
-COPY --from=build /app/dist /app/dist
-COPY --from=build /app/package.json /app/package.json
-
-# Exclude devDependencies
-RUN npm install --only=production
+COPY --from=build /app/backend/dist /app/backend/dist
+COPY --from=build /app/backend/package.json /app/backend/package.json
+COPY --from=build /app/backend/src /app/backend/src
+COPY --from=build /app/backend/jest.config.ts /app/backend/jest.config.ts
+COPY --from=build /app/backend/tsconfig.json /app/backend/tsconfig.json
+COPY --from=build /app/backend/migrations /app/backend/migrations
+COPY --from=build /app/backend/seeds /app/backend/seeds
+RUN npm install
 
-ENV DEBUG=* NPM_CONFIG_LOGLEVEL=verbose
+# ENV DEBUG=* NPM_CONFIG_LOGLEVEL=error
 
 EXPOSE 3000
 

backend/Dockerfile

@@ -0,0 +1,16 @@
+import type { Knex } from "knex";
+
+
+export async function up(knex: Knex): Promise<void> {
+    return knex.schema.table('users', (table) => {
+        table.string('street_address').nullable();
+    });
+}
+
+
+export async function down(knex: Knex): Promise<void> {
+    return knex.schema.table('users', (table) => {
+        table.dropColumn('street_address');
+    });
+}
+

backend/migrations/20250116185004_add_street_to_users.ts

@@ -0,0 +1,15 @@
+import type { Knex } from "knex";
+
+
+export async function up(knex: Knex): Promise<void> {
+    return knex.schema.table('products', (table) => {
+        table.integer('quantity').notNullable().defaultTo(0);
+    });
+}
+
+
+export async function down(knex: Knex): Promise<void> {
+    return knex.schema.table('products', (table) => {
+        table.dropColumn('quantity');
+    });
+}

backend/migrations/20250117004156_add_quantity_to_products.ts

@@ -1,6 +1,6 @@
 {
   "name": "interview-prep-backend",
-  "version": "0.0.0",
+  "version": "0.1.0",
   "main": "dist/server.js",
   "scripts": {
     "start": "node dist/server.js",

backend/package-lock.json

@@ -2,15 +2,12 @@ import request from 'supertest';
 import app from '../../app';
 import knex from 'knex';
 import knexConfig from '../../knexFile';
-import dotenv from 'dotenv';
 import {
   Product,
   ProductStatus,
 } from '@onyxdevtutorials/interview-prep-shared';
 import retry from "retry";
 
-dotenv.config({ path: '../../../.env.test' });
-
 const db = knex(knexConfig['test_products']);
 
 const productsPath = '/api/v0/products';

backend/package.json

@@ -2,11 +2,11 @@ import request from 'supertest';
 import app from '../../app';
 import knex from 'knex';
 import knexConfig from '../../knexFile';
-import dotenv from 'dotenv';
+// import dotenv from 'dotenv';
 import { User, UserStatus } from '@onyxdevtutorials/interview-prep-shared';
 import retry from "retry";
 
-dotenv.config({ path: '../../../.env.test' });
+// dotenv.config({ path: '../../../.env.test' });
 
 const db = knex(knexConfig['test_users']);
 

backend/src/__tests__/integration/products.integration.test.ts

@@ -1,5 +1,5 @@
 import request from 'supertest';
-import app from '../app';
+import app from '../../app';
 import http from 'http';
 
 describe('Server', () => {

backend/src/__tests__/integration/users.integration.test.ts

@@ -3,28 +3,27 @@ import bodyParser from 'body-parser';
 import cors from 'cors';
 import usersRouter from './routes/users';
 import productsRouter from './routes/products';
+import healthRouter from './routes/health';
 import { errorHandler } from './middleware/errorHandler';
 import { logger } from './middleware/logger';
 import knex from 'knex';
 import knexConfig from './knexFile';
-import dotenv from 'dotenv';
 import { Request, Response, NextFunction } from 'express-serve-static-core';
 
-const envFile =
-  process.env['NODE_ENV'] === 'production'
-    ? '../.env.production'
-    : process.env['NODE_ENV'] === 'test'
-    ? '../.env.test'
-    : '../.env.local';
-
-dotenv.config({ path: envFile });
-
 const app = express();
 app.use(bodyParser.json());
 
+let corsOrigin: string;
+
+if (process.env['NODE_ENV'] === 'local') {
+  corsOrigin = 'http://localhost:4200';
+} else {
+  corsOrigin = 'http://dev.interviewprep.onyxdevtutorials.com';
+}
+
 const corsOptions = {
-  origin: process.env['CORS_ORIGIN'] || 'http://dev.interviewprep.onyxdevtutorials.com',
-  methods: 'GET,HEAD,PUT,PATCH,POST,DELETE',
+  origin: corsOrigin,
+  methods: 'GET,HEAD,PUT,PATCH,POST,DELETE,OPTIONS',
   credentials: true,
   optionsSuccessStatus: 200,
 };
@@ -57,6 +56,8 @@ app.use(
   productsRouter
 );
 
+app.use('/health', healthRouter);
+
 app.get('/', (req, res) => {
   res.send('Hello, world!');
 });

backend/src/__tests__/server.test.ts renamed to backend/src/__tests__/unit/server.test.ts

@@ -0,0 +1,9 @@
+import { Router } from 'express';
+
+const healthRouter = Router();
+
+healthRouter.get('/', (req, res) => {
+  res.status(200).send('OK');
+});
+
+export default healthRouter;

backend/src/app.ts

@@ -33,10 +33,10 @@ services:
       - NODE_ENV=test
       - DATABASE_URL=${DATABASE_URL}
     image: interview-prep-backend-tests:latest
-    working_dir: /app
+    working_dir: /app/backend
     depends_on:
       - db-test
-    command: sh -c "npx jest --clearCache && npm run test -- --watch=false --verbose"
+    command: sh -c "npx jest --clearCache && npx jest --watch=false --config ./jest.config.ts"
     # command: tail -f /dev/null
     networks:
       - devnetwork

backend/src/routes/health.ts

@@ -28,13 +28,14 @@ services:
 
   backend:
     build:
-      context: .
-      dockerfile: backend/Dockerfile
+      context: ./backend
+      dockerfile: Dockerfile
     image: interview-prep-backend:latest
     ports:
       - "3000:3000"
     environment:
       - DATABASE_URL=${DATABASE_URL}
+      - NODE_ENV=${NODE_ENV}
     volumes:
       # The following works but shouldn't be necessary:
       # - /Users/davidsilva/Dev/interview-prep/backend:/app/backend
@@ -63,8 +64,8 @@ services:
 
   migrate:
     build:
-      context: .
-      dockerfile: backend/Dockerfile
+      context: ./backend
+      dockerfile: Dockerfile
     working_dir: /app/backend
     environment:
       - NODE_ENV=${NODE_ENV}

docker-compose.migrate.yml

@@ -7,13 +7,11 @@ server {
         try_files $uri $uri/ /index.html;
     }
 
-    # location /api/v0/ {
-    #     proxy_pass http://api.dev.interviewprep.onyxdevtutorials.com:3000/;
-    #     proxy_set_header Host $host;
-    #     proxy_set_header X-Real-IP $remote_addr;
-    #     proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
-    #     proxy_set_header X-Forwarded-Proto $scheme;
-    # }
+    location /health {
+        access_log off;
+        return 200 'OK';
+        add_header Content-Type text/plain;
+    }
 
     error_page 500 502 503 504 /50x.html;
     location = /50x.html {

docker-compose.test.yml

@@ -1,6 +1,6 @@
 {
   "name": "interview-prep",
-  "version": "0.0.0",
+  "version": "0.1.0",
   "scripts": {
     "ng": "ng",
     "start": "ng serve --host 0.0.0.0 --port 4200 --configuration local",

docker-compose.yml

@@ -0,0 +1,5 @@
+{
+    "name": "interview-prep",
+    "version": "0.1.0",
+    "private": true
+}

frontend/nginx.conf

@@ -47,31 +47,22 @@ module "rds" {
   environment = var.environment
 }
 
-module "service_discovery" {
-  source      = "../../modules/service_discovery"
-  environment = var.environment
-  vpc_id      = module.vpc.vpc_id
-}
-
 module "ecs" {
   source                    = "../../modules/ecs"
+  project_name              = var.project_name
   environment               = var.environment
   region                    = var.region
   frontend_image = "interview-prep-frontend"
   frontend_repository_url = module.ecr.frontend_repository_url
   backend_image = "interview-prep-backend"
   backend_repository_url = module.ecr.backend_repository_url
   database_url = module.rds.db_instance_endpoint
-  public_subnet_ids         = [module.subnets.public_subnet_a_id, module.subnets.public_subnet_b_id]
   private_subnet_ids = [module.subnets.private_subnet_a_id, module.subnets.private_subnet_b_id]
   frontend_sg_id            = module.security_groups.frontend_sg_id
   backend_sg_id             = module.security_groups.backend_sg_id
   alb_sg_id                 = module.security_groups.alb_sg_id
-  bastion_sg_id             = module.security_groups.bastion_sg_id
   ecs_task_execution_role   = module.iam.ecs_task_execution_role_arn
   ecs_task_role_arn = module.iam.ecs_task_role_arn
-  service_discovery_namespace_id = module.service_discovery.namespace_id
-  backend_service_arn = module.service_discovery.backend_service_arn
   db_username = var.db_username
   db_password = var.db_password
   frontend_target_group_arn = module.load_balancer.frontend_target_group_arn
@@ -118,7 +109,7 @@ module "lambda_migrate" {
   function_name = "${var.environment}-interview-prep-migrate"
   handler = "index.handler"
   runtime = "nodejs20.x"
-  timeout = 60
+  timeout = 300
   memory_size = 128
   lambda_package = var.lambda_package_migrate
   lambda_subnet_ids = [module.subnets.private_subnet_a_id, module.subnets.private_subnet_b_id]
@@ -160,7 +151,8 @@ module "load_balancer" {
   security_groups = [module.security_groups.alb_sg_id]
   public_subnet_ids = [module.subnets.public_subnet_a_id, module.subnets.public_subnet_b_id]
   vpc_id = module.vpc.vpc_id
-  health_check_path = "/"
+  frontend_health_check_path = "/health"
+  backend_health_check_path = "/health"
 }
 
 module "dns" {
@@ -181,4 +173,5 @@ module "api_gateway" {
   lb_dns_name = module.load_balancer.lb_dns_name
   region = var.region
   certificate_arn = var.certificate_arn
+  cors_origin = "http://dev.interviewprep.onyxdevtutorials.com"
 }

frontend/package-lock.json

@@ -1,5 +1,3 @@
-# environments/development/outputs.tf
-
 output "vpc_id" {
   description = "The ID of the VPC"
   value       = module.vpc.vpc_id
@@ -95,11 +93,6 @@ output "alb_sg_id" {
     value = module.security_groups.alb_sg_id
 }
 
-output "backend_service_arn" {
-    description = "The ARN of the backend service in service discovery"
-    value = module.ecs.backend_service_arn
-}
-
 output "db_instance_endpoint" {
     description = "The endpoint of the RDS instance"
     value = module.rds.db_instance_endpoint