Fix history build (CS3219-AY2425S1#83)

* Fix history build Fix history building in wrong directory * Fix compose.dev.yml * Rename history entrypoint * Make history endpoint gateway-accessible The current endpoint is not accessible on production * Fix tests * Fix test typing Make use of Project References to ensure tests has relevant types * Remove root package-lock
KhoonSun47 · Nov 7, 2024 · 517f526 · 517f526
1 parent 65f37ff
commit 517f526
Show file tree

Hide file tree

Showing 10 changed files with 45 additions and 23 deletions.
diff --git a/compose.dev.yml b/compose.dev.yml
@@ -47,10 +47,6 @@ services:
     volumes:
       - /app/node_modules
       - ./services/collaboration:/app
-
-  collaboration-db:
-    ports:
-      - 27020:27017
 
   collaboration-db:
     ports:

diff --git a/package-lock.json b/package-lock.json
diff --git a/services/history/README.md b/services/history/README.md
@@ -27,7 +27,7 @@ docker compose down -v
 
 - This endpoint retrieves the history of a user.
 - **HTTP Method**: `GET`
-- **Endpoint**: http://localhost:8086/api/history
+- **Endpoint**: http://localhost:8086/api/history/history
 - **Headers**
   - `Authorization: Bearer <JWT_ACCESS_TOKEN>` (Required)
   - The endpoint requires the user to include a JWT (JSON Web Token) in the HTTP Request Header for authentication and authorization. This token is generated during the authentication process (i.e., login) and contains information about the user's identity. The server verifies this token to ensure that the client is authorized to access the data.

diff --git a/services/history/package.json b/services/history/package.json
@@ -1,13 +1,13 @@
 {
   "name": "history",
   "version": "0.0.0",
-  "main": "index.js",
+  "main": "server.js",
   "scripts": {
-    "build": "npx tsc",
-    "start": "npm run build && node ./dist/index.js",
-    "dev": "nodemon --files ./src/index.ts",
-    "lint": "npx eslint .",
-    "lint:fix": "npx eslint . --fix",
+    "build": "npx tsc --build src/tsconfig.json",
+    "start": "npm run build && node ./dist/server.js",
+    "dev": "nodemon --files ./src/server.ts",
+    "lint": "npx eslint src tests",
+    "lint:fix": "npx eslint src tests --fix",
     "test": "mocha --require ts-node/register tests/**/*.spec.ts --exit"
   },
   "author": "",

diff --git a/services/history/src/app.ts b/services/history/src/app.ts
@@ -25,6 +25,6 @@ app.use(
 
 // Routes
 app.use('/', router);
-app.use('/api/history', verifyAccessToken, historyRouter);
+app.use('/api/history/history', verifyAccessToken, historyRouter);
 
 export default app;
diff --git a/services/history/src/index.ts → services/history/src/server.ts b/services/history/src/index.ts → services/history/src/server.ts
diff --git a/services/history/src/tsconfig.json b/services/history/src/tsconfig.json
@@ -0,0 +1,14 @@
+/* Visit https://aka.ms/tsconfig to read more about this file */
+{
+  "compilerOptions": {
+    "target": "es2016",
+    "module": "CommonJS",
+    "outDir": "../dist",
+    "composite": true,
+    "strict": true,
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "forceConsistentCasingInFileNames": true,    
+  },
+  "include": ["**/*.ts"]
+}
diff --git a/services/history/tests/controllers/historyController.spec.ts b/services/history/tests/controllers/historyController.spec.ts
@@ -33,7 +33,7 @@ describe('History Controller', function () {
 
         it('Should return history with token', done => {
             chai.request(app)
-                .get(`/api/history`)
+                .get(`/api/history/history`)
                 .set('Authorization', `Bearer ${user1Token}`)
                 .end((err, res) => {
                     expect(res).to.have.status(200);
@@ -45,7 +45,7 @@ describe('History Controller', function () {
 
         it('Should return empty history for different token', done => {
             chai.request(app)
-                .get(`/api/history`)
+                .get(`/api/history/history`)
                 .set('Authorization', `Bearer ${user3Token}`)
                 .end((err, res) => {
                     expect(res).to.have.status(200);
@@ -57,7 +57,7 @@ describe('History Controller', function () {
 
         it('Should return 401 without accessToken', done => {
             chai.request(app)
-                .get(`/api/history`)
+                .get(`/api/history/history`)
                 .end((err, res) => {
                     expect(res).to.have.status(401);
                     expect(res.body).to.have.property('message');

diff --git a/services/history/tests/tsconfig.json b/services/history/tests/tsconfig.json
@@ -0,0 +1,15 @@
+{
+  "compilerOptions": {
+    "target": "es2016",
+    "module": "CommonJS",
+    "composite": true,
+    "strict": true,
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "forceConsistentCasingInFileNames": true,    
+  },
+  "references": [
+    { "path": "../src" }
+  ],
+  "include": ["**/*.ts"]
+}
diff --git a/services/history/tsconfig.json b/services/history/tsconfig.json
@@ -3,14 +3,17 @@
   "compilerOptions": {
     "target": "es2016",
     "module": "CommonJS",
+    "rootDir": "./src",
     "outDir": "./dist",
-    "types": ["mocha"],
     "strict": true,
     "esModuleInterop": true,
     "skipLibCheck": true,
     "forceConsistentCasingInFileNames": true,    
   },
-  "include": ["src/**/*.ts", "tests/**/*.ts"],
+  "references": [
+    { "path": "./src" },
+    { "path": "./tests" }
+  ],
   "exclude": ["node_modules"],
   "ts-node": {
     "files": true