Ensure codebase is production-ready (#68)

* Frontend: Refactor config to env

Make use of angular environments to ensure it serves the correct URLs on
production.

* Ensure production consistent URLs

AWS load balancers are unable to trim off path (/api/server). Let's update the services themselves to contain these path prefixes.

* User: Add logging

* User: Modify health check route

* Standardise server.ts across services

* Reorder compose.yml

Author: samuelim01

compose.yml

@@ -24,6 +24,21 @@ services:
     networks:
       - gateway-network
     restart: always
+  
+  broker:
+    container_name: broker
+    hostname: broker
+    image: rabbitmq:4.0.2
+    user: rabbitmq
+    networks:
+      - gateway-network
+    healthcheck:
+      test: rabbitmq-diagnostics check_port_connectivity
+      interval: 30s
+      timeout: 30s
+      retries: 10
+      start_period: 30s
+    restart: always
 
   question:
     container_name: question
@@ -123,21 +138,6 @@ services:
       - match-db-network
     restart: always
 
-  broker:
-    container_name: broker
-    hostname: broker
-    image: rabbitmq:4.0.2
-    user: rabbitmq
-    networks:
-      - gateway-network
-    healthcheck:
-      test: rabbitmq-diagnostics check_port_connectivity
-      interval: 30s
-      timeout: 30s
-      retries: 10
-      start_period: 30s
-    restart: always
-
   collaboration:
     container_name: collaboration
     image: collaboration

frontend/angular.json

@@ -51,7 +51,13 @@
             "development": {
               "optimization": false,
               "extractLicenses": false,
-              "sourceMap": true
+              "sourceMap": true,
+              "fileReplacements": [
+                {
+                  "replace": "src/environments/environment.ts",
+                  "with": "src/environments/environment.development.ts"
+                }
+              ]
             }
           },
           "defaultConfiguration": "production"

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

@@ -3,7 +3,7 @@ import { HttpTestingController, provideHttpClientTesting } from '@angular/common
 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';
+import { environment } from '../environments/environment.development';
 
 describe('JwtInterceptor', () => {
     let httpMock: HttpTestingController;
@@ -34,9 +34,9 @@ describe('JwtInterceptor', () => {
     });
 
     it('should add an Authorization header', () => {
-        httpClient.get(`${API_CONFIG.baseUrl}/user/test`).subscribe();
+        httpClient.get(`${environment.apiUrl}/user/test`).subscribe();
 
-        const httpRequest = httpMock.expectOne(`${API_CONFIG.baseUrl}/user/test`);
+        const httpRequest = httpMock.expectOne(`${environment.apiUrl}/user/test`);
 
         expect(httpRequest.request.headers.has('Authorization')).toBeTruthy();
         expect(httpRequest.request.headers.get('Authorization')).toBe('Bearer fake-jwt-token');
@@ -47,9 +47,9 @@ describe('JwtInterceptor', () => {
             userValue: {},
         });
 
-        httpClient.get(`${API_CONFIG.baseUrl}/user/test`).subscribe();
+        httpClient.get(`${environment.apiUrl}/user/test`).subscribe();
 
-        const httpRequest = httpMock.expectOne(`${API_CONFIG.baseUrl}/user/test`);
+        const httpRequest = httpMock.expectOne(`${environment.apiUrl}/user/test`);
 
         expect(httpRequest.request.headers.has('Authorization')).toBeFalsy();
     });

frontend/src/_services/api.service.ts

@@ -1,4 +1,4 @@
-import { API_CONFIG } from '../app/api.config';
+import { environment } from '../environments/environment';
 
 /**
  * Abstract class that serves as a base for API services.
@@ -16,6 +16,6 @@ export abstract class ApiService {
      * the specified apiPath.
      */
     get apiUrl(): string {
-        return API_CONFIG.baseUrl + this.apiPath;
+        return environment.apiUrl + this.apiPath;
     }
 }

frontend/src/_services/question.service.ts

@@ -14,7 +14,7 @@ import { ApiService } from './api.service';
     providedIn: 'root',
 })
 export class QuestionService extends ApiService {
-    protected apiPath = 'question/questions';
+    protected apiPath = 'question';
 
     private httpOptions = {
         headers: new HttpHeaders({

frontend/src/app/api.config.ts

@@ -15,7 +15,6 @@ import { yCollab } from 'y-codemirror.next';
 import * as prettier from 'prettier';
 import * as prettierPluginEstree from 'prettier/plugins/estree';
 import { usercolors } from './user-colors';
-import { WEBSOCKET_CONFIG } from '../../api.config';
 import { AuthenticationService } from '../../../_services/authentication.service';
 import { RoomService } from '../room.service';
 // The 'prettier-plugin-java' package does not provide TypeScript declaration files.
@@ -28,6 +27,7 @@ import { SubmitDialogComponent } from '../submit-dialog/submit-dialog.component'
 import { ForfeitDialogComponent } from '../forfeit-dialog/forfeit-dialog.component';
 import { Router } from '@angular/router';
 import { awarenessData } from '../collab.model';
+import { environment } from '../../../environments/environment';
 
 enum WebSocketCode {
     AUTH_FAILED = 4000,
@@ -98,7 +98,7 @@ export class EditorComponent implements AfterViewInit, OnInit, OnDestroy {
 
     initConnection() {
         this.ydoc = new Y.Doc();
-        const websocketUrl = WEBSOCKET_CONFIG.baseUrl + 'collaboration/';
+        const websocketUrl = environment.wsUrl + 'collaboration/';
         this.wsProvider = new WebsocketProvider(websocketUrl, this.roomId, this.ydoc, {
             params: {
                 accessToken: this.authService.userValue?.accessToken || '',

frontend/src/app/collaboration/editor/editor.component.ts

@@ -0,0 +1,4 @@
+export const environment = {
+    apiUrl: 'http://localhost:8080/api/',
+    wsUrl: 'ws://localhost:8080/api/',
+};

frontend/src/environments/environment.development.ts

@@ -0,0 +1,4 @@
+export const environment = {
+    apiUrl: 'https://app.peerprep.org/api/',
+    wsUrl: 'wss://app.peerprep.org/api/',
+};

frontend/src/environments/environment.ts

@@ -18,23 +18,23 @@ server {
     listen 8080;
     server_name localhost;
 
-    location /api/question/ {
-        proxy_pass http://question-api/;
+    location /api/question {
+        proxy_pass http://question-api;
         proxy_set_header Host $host;
     }
 
-    location /api/user/ {
-        proxy_pass http://user-api/;
+    location /api/user {
+        proxy_pass http://user-api;
         proxy_set_header Host $host;
     }
 
-    location /api/match/ {
-        proxy_pass http://match-api/;
+    location /api/match {
+        proxy_pass http://match-api;
         proxy_set_header Host $host;
     }
 
-    location /api/collaboration/ {
-        proxy_pass http://collaboration-api/;
+    location /api/collaboration {
+        proxy_pass http://collaboration-api;
         proxy_set_header Host $host;
         proxy_http_version 1.1;
         proxy_set_header Upgrade $http_upgrade;