Merge branch 'main' into role-based-authorization-spa

Author: LimZiJia

.env.sample

@@ -8,11 +8,10 @@ QUESTION_DB_USERNAME=user
 QUESTION_DB_PASSWORD=password
 
 # User Service
-USER_SERVICE_CLOUD_URI=mongodb+srv://admin:<db_password>@cluster0.uo0vu.mongodb.net/?retryWrites=true&w=majority&appName=Cluster0
-USER_SERVICE_LOCAL_URI=mongodb://127.0.0.1:27017/peerprepUserServiceDB
-
-# Will use cloud MongoDB Atlas database
-ENV=PROD
+USER_DB_CLOUD_URI=<FILL-THIS-IN>
+USER_DB_LOCAL_URI=mongodb://user-db:27017/user
+USER_DB_USERNAME=user
+USER_DB_PASSWORD=password
 
 # Secret for creating JWT signature
 JWT_SECRET=you-can-replace-this-with-your-own-secret

.github/workflows/tests.yml

@@ -23,7 +23,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        service: [frontend, services/question]
+        service: [frontend, services/question, services/user]
     steps:
       - uses: actions/checkout@v4
       - name: Use Node.js

compose.dev.yml

@@ -6,6 +6,8 @@ services:
 
   question:
     command: npm run dev
+    ports:
+      - 8081:8081
     volumes:
       - /app/node_modules
       - ./services/question:/app
@@ -16,6 +18,12 @@ services:
 
   user:
     command: npm run dev
+    ports:
+      - 8082:8082
     volumes:
       - /app/node_modules
-      - ./services/user:/app
+      - ./services/user:/app
+  
+  user-db:
+    ports:
+      - 27018:27017

compose.yml

@@ -9,20 +9,29 @@ services:
       - 4200:4200
     restart: always
 
+  gateway:
+    container_name: gateway
+    image: nginx:1.27
+    ports:
+      - 8080:8080
+    volumes:
+      - ./nginx/default.conf:/etc/nginx/conf.d/default.conf
+    networks:
+      - gateway-network
+  
   question:
     container_name: question
     image: question
     build:
       context: services/question
       dockerfile: Dockerfile
-    ports:
-      - 8081:8081
     environment:
       DB_CLOUD_URI: ${QUESTION_DB_CLOUD_URI}
       DB_LOCAL_URI: ${QUESTION_DB_LOCAL_URI}
       DB_USERNAME: ${QUESTION_DB_USERNAME}
       DB_PASSWORD: ${QUESTION_DB_PASSWORD}
     networks:
+      - gateway-network
       - question-db-network
     restart: always
 
@@ -46,18 +55,38 @@ services:
     build:
       context: services/user
       dockerfile: Dockerfile
-    ports:
-      - 8082:8082
     environment:
-      USER_SERVICE_CLOUD_URI: ${USER_SERVICE_CLOUD_URI}
-      USER_SERVICE_LOCAL_URI: ${USER_SERVICE_LOCAL_URI}
-      ENV: ${ENV}
+      DB_CLOUD_URI: ${USER_DB_CLOUD_URI}
+      DB_LOCAL_URI: ${USER_DB_LOCAL_URI}
+      DB_USERNAME: ${USER_DB_USERNAME}
+      DB_PASSWORD: ${USER_DB_PASSWORD}
       JWT_SECRET: ${JWT_SECRET}
+    networks:
+      - gateway-network
+      - user-db-network
+    restart: always
+  
+  user-db:
+    container_name: user-db
+    image: mongo:7.0.14
+    environment:
+      MONGO_INITDB_ROOT_USERNAME: ${USER_DB_USERNAME}
+      MONGO_INITDB_ROOT_PASSWORD: ${USER_DB_PASSWORD}
+    volumes:
+      - user-db:/data/db
+    networks:
+      - user-db-network
+    command: --quiet
     restart: always
 
 volumes:
   question-db:
+  user-db:
 
 networks:
+  gateway-network:
+    driver: bridge
   question-db-network:
     driver: bridge
+  user-db-network:
+    driver: bridge

frontend/src/_interceptors/error.interceptor.ts

@@ -0,0 +1,18 @@
+import { Injectable } from '@angular/core';
+import { HttpRequest, HttpHandler, HttpEvent, HttpInterceptor } from '@angular/common/http';
+import { Observable, throwError } from 'rxjs';
+import { catchError } from 'rxjs/operators';
+
+@Injectable()
+export class ErrorInterceptor implements HttpInterceptor {
+    intercept(request: HttpRequest<unknown>, next: HttpHandler): Observable<HttpEvent<unknown>> {
+        return next.handle(request).pipe(
+            catchError(err => {
+                console.error(err);
+
+                const errorMessage = err.error.message;
+                return throwError(() => new Error(errorMessage, { cause: err }));
+            }),
+        );
+    }
+}

frontend/src/_interceptors/jwt.interceptor.spec.ts

@@ -0,0 +1,64 @@
+import { TestBed } from '@angular/core/testing';
+import { HttpTestingController, provideHttpClientTesting } from '@angular/common/http/testing';
+import { HTTP_INTERCEPTORS, HttpClient } from '@angular/common/http';
+import { JwtInterceptor } from './jwt.interceptor';
+import { AuthenticationService } from '../_services/authentication.service';
+import { API_CONFIG } from '../app/api.config';
+
+describe('JwtInterceptor', () => {
+    let httpMock: HttpTestingController;
+    let httpClient: HttpClient;
+    let mockAuthService: jasmine.SpyObj<AuthenticationService>;
+
+    beforeEach(() => {
+        mockAuthService = jasmine.createSpyObj('AuthenticationService', ['userValue'], {
+            userValue: { accessToken: 'fake-jwt-token' },
+        });
+
+        TestBed.configureTestingModule({
+            imports: [HttpClient],
+            providers: [
+                { provide: HTTP_INTERCEPTORS, useClass: JwtInterceptor, multi: true },
+                { provide: AuthenticationService, useValue: mockAuthService },
+                provideHttpClientTesting(),
+            ],
+        });
+
+        httpMock = TestBed.inject(HttpTestingController);
+        httpClient = TestBed.inject(HttpClient);
+    });
+
+    afterEach(() => {
+        // Check if all Http requests were handled
+        httpMock.verify();
+    });
+
+    it('should add an Authorization header', () => {
+        httpClient.get(`${API_CONFIG.baseUrl}/user/test`).subscribe();
+
+        const httpRequest = httpMock.expectOne(`${API_CONFIG.baseUrl}/user/test`);
+
+        expect(httpRequest.request.headers.has('Authorization')).toBeTruthy();
+        expect(httpRequest.request.headers.get('Authorization')).toBe('Bearer fake-jwt-token');
+    });
+
+    it('should not add an Authorization header if the user is not logged in', () => {
+        mockAuthService = jasmine.createSpyObj('AuthenticationService', ['userValue'], {
+            userValue: {},
+        });
+
+        httpClient.get(`${API_CONFIG.baseUrl}/user/test`).subscribe();
+
+        const httpRequest = httpMock.expectOne(`${API_CONFIG.baseUrl}/user/test`);
+
+        expect(httpRequest.request.headers.has('Authorization')).toBeFalsy();
+    });
+
+    it('should not add an Authorization header for non-API URLs', () => {
+        httpClient.get('https://example.com/test').subscribe();
+
+        const httpRequest = httpMock.expectOne('https://example.com/test');
+
+        expect(httpRequest.request.headers.has('Authorization')).toBeFalsy();
+    });
+});

frontend/src/_interceptors/jwt.interceptor.ts

@@ -0,0 +1,21 @@
+import { Injectable } from '@angular/core';
+import { HttpRequest, HttpHandler, HttpEvent, HttpInterceptor } from '@angular/common/http';
+import { Observable } from 'rxjs';
+import { AuthenticationService } from '../_services/authentication.service';
+
+@Injectable()
+export class JwtInterceptor implements HttpInterceptor {
+    constructor(private authenticationService: AuthenticationService) {}
+
+    intercept(request: HttpRequest<unknown>, next: HttpHandler): Observable<HttpEvent<unknown>> {
+        // add auth header with jwt if user is logged in and request is to the api url
+        const currentUser = this.authenticationService.userValue;
+        if (currentUser) {
+            const accessToken = currentUser.accessToken;
+            request = request.clone({
+                headers: request.headers.set('Authorization', `Bearer ${accessToken}`),
+            });
+        }
+        return next.handle(request);
+    }
+}

frontend/src/_models/user.model.ts

@@ -1,8 +1,8 @@
-export class User {
-    id?: string;
-    username?: string;
-    email?: string;
-    isAdmin?: boolean;
-    createdAt?: string;
-    accessToken?: string;
+export interface User {
+    id: string;
+    username: string;
+    email: string;
+    isAdmin: boolean;
+    createdAt: string;
+    accessToken: string;
 }

frontend/src/_models/user.service.model.ts

@@ -0,0 +1,11 @@
+import { User } from './user.model';
+
+export interface BaseResponse {
+    status: string;
+    message: string;
+}
+
+export interface UServRes extends BaseResponse {
+    message: string;
+    data: User;
+}

frontend/src/_services/api.service.ts

@@ -0,0 +1,21 @@
+import { API_CONFIG } from '../app/api.config';
+
+/**
+ * Abstract class that serves as a base for API services.
+ */
+export abstract class ApiService {
+    /**
+     * The path for the specific resource, e.g. 'user', 'question', etc.
+     * This property must be implemented by subclasses to specify the
+     * endpoint path for the API resource they represent.
+     */
+    protected abstract apiPath: string;
+
+    /**
+     * Returns the full URL for the API endpoint based on
+     * the specified apiPath.
+     */
+    get apiUrl(): string {
+        return API_CONFIG.baseUrl + this.apiPath;
+    }
+}