#2790 - Update API Access Logs

devops/openshift/api-deploy.yml

@@ -219,7 +219,7 @@ objects:
                 failureThreshold: 3
                 successThreshold: 1
                 httpGet:
-                  path: /api/
+                  path: /health/
                   port: "${{PORT}}"
                 initialDelaySeconds: 40
                 periodSeconds: 30
@@ -228,7 +228,7 @@ objects:
                 failureThreshold: 3
                 successThreshold: 1
                 httpGet:
-                  path: /api/
+                  path: /health/
                   port: "${{PORT}}"
                   scheme: HTTP
                 initialDelaySeconds: 10

sources/packages/backend/apps/api/src/app.module.ts

@@ -1,5 +1,4 @@
-import { Module } from "@nestjs/common";
-import { AppController } from "./app.controller";
+import { MiddlewareConsumer, Module, NestModule } from "@nestjs/common";
 import { AppService } from "./app.service";
 import { RouterModule } from "@nestjs/core";
 import {
@@ -13,6 +12,7 @@ import {
   AuditController,
   ConfigController,
   DynamicFormController,
+  HealthController,
 } from "./route-controllers";
 import { AuthModule } from "./auth/auth.module";
 import { AppAESTModule } from "./app.aest.module";
@@ -31,6 +31,7 @@ import { DatabaseModule } from "@sims/sims-db";
 import { NotificationsModule } from "@sims/services/notifications";
 import { QueueModule } from "@sims/services/queue";
 import { AppExternalModule } from "./app.external.module";
+import { AccessLoggerMiddleware } from "./middlewares";
 
 @Module({
   imports: [
@@ -72,7 +73,7 @@ import { AppExternalModule } from "./app.external.module";
     ]),
   ],
   controllers: [
-    AppController,
+    HealthController,
     ConfigController,
     DynamicFormController,
     AuditController,
@@ -86,4 +87,8 @@ import { AppExternalModule } from "./app.external.module";
     ProgramYearService,
   ],
 })
-export class AppModule {}
+export class AppModule implements NestModule {
+  configure(consumer: MiddlewareConsumer) {
+    consumer.apply(AccessLoggerMiddleware).exclude("health").forRoutes("*");
+  }
+}

sources/packages/backend/apps/api/src/main.ts

@@ -8,7 +8,6 @@ import { AppAllExceptionsFilter } from "./app.exception.filter";
 import { exit } from "process";
 import { setGlobalPipes } from "./utilities/auth-utils";
 import { DocumentBuilder, SwaggerModule } from "@nestjs/swagger";
-import { Request, Response } from "express";
 import { KeycloakConfig } from "@sims/auth/config";
 import helmet from "helmet";
 import { SystemUsersService } from "@sims/services";
@@ -29,7 +28,7 @@ async function bootstrap() {
   await systemUsersService.loadSystemUser();
 
   // Setting global prefix
-  app.setGlobalPrefix("api");
+  app.setGlobalPrefix("api", { exclude: ["health"] });
 
   // Using helmet.
   app.use(helmet());
@@ -58,16 +57,6 @@ async function bootstrap() {
     origin: allowAnyOrigin,
   });
 
-  // Log every request.
-  app.use((req: Request, _res: Response, next: () => void) => {
-    logger.log(
-      `Request - ${req.method} ${req.path} From ${
-        req.headers.origin ?? "unknown"
-      } | ${req.headers["user-agent"] ?? "unknown"}`,
-    );
-    next();
-  });
-
   // pipes
   setGlobalPipes(app);
 

sources/packages/backend/apps/api/src/middlewares/access-logger.middleware.ts

@@ -0,0 +1,45 @@
+import { Injectable, LoggerService, NestMiddleware } from "@nestjs/common";
+import { JwtService } from "@nestjs/jwt";
+import { InjectLogger } from "@sims/utilities/logger";
+import { IUserToken } from "../auth";
+import { getClientIPFromRequest } from "../utilities";
+import { Request, Response, NextFunction } from "express";
+
+@Injectable()
+export class AccessLoggerMiddleware implements NestMiddleware {
+  constructor(private readonly jwtService: JwtService) {}
+  /**
+   * Logs access information of every request.
+   * @param request http request.
+   * @param _response http response.
+   * @param next next function.
+   */
+  use(request: Request, _response: Response, next: NextFunction) {
+    const { headers, originalUrl, method } = request;
+    const clientIP = getClientIPFromRequest(request);
+    const user = this.getUserFromBearerToken(request.headers.authorization);
+    const userGUID = user ? user.userName : "User GUID not found";
+    const userAgent = headers["user-agent"] ?? "User agent not found";
+    const userAccessLog = `Request - ${method} ${originalUrl} From ${clientIP} | User GUID: ${userGUID} | User Agent: ${userAgent}`;
+    this.logger.log(userAccessLog);
+    next();
+  }
+
+  /**
+   * Get decoded user information from bearer token.
+   * @param bearerToken token to be decoded.
+   * @returns decoded user information.
+   */
+  private getUserFromBearerToken(bearerToken: string): IUserToken | null {
+    if (!bearerToken) {
+      return null;
+    }
+    const user = this.jwtService.decode<IUserToken>(
+      bearerToken.replace("Bearer ", ""),
+    );
+    return user;
+  }
+
+  @InjectLogger()
+  logger: LoggerService;
+}

sources/packages/backend/apps/api/src/middlewares/index.ts

@@ -0,0 +1 @@
+export * from "./access-logger.middleware";

sources/packages/backend/apps/api/src/route-controllers/audit/audit.controller.ts

@@ -10,6 +10,7 @@ import BaseController from "../BaseController";
 import { AuditService } from "../../services";
 import { Request } from "express";
 import { AuditAPIInDTO } from "./models/audit.dto";
+import { getClientIPFromRequest } from "../../utilities";
 
 @AllowAuthorizedParty(
   AuthorizedParties.institution,
@@ -37,9 +38,7 @@ export class AuditController extends BaseController {
     @UserToken() userToken: IUserToken,
     @Req() request: Request,
   ): void {
-    const clientIP =
-      (request.headers["x-forwarded-for"] as string) ||
-      request.socket.remoteAddress;
+    const clientIP = getClientIPFromRequest(request);
     this.auditService.audit(
       clientIP,
       userToken.userName,

sources/packages/backend/apps/api/src/app.controller.spec.ts → sources/packages/backend/apps/api/src/route-controllers/health-check/health.controller.spec.ts

@@ -1,28 +1,26 @@
 import { Test, TestingModule } from "@nestjs/testing";
-import { AppController } from "./app.controller";
-import { AppService } from "./app.service";
+import { HealthController } from "./health.controller";
 import { DatabaseModule } from "@sims/sims-db";
 
 // TODO: must mock DB dependencies.
-describe.skip("AppController", () => {
-  let appController: AppController;
+describe.skip("HealthController", () => {
+  let healthController: HealthController;
 
   beforeEach(async () => {
     const app: TestingModule = await Test.createTestingModule({
       imports: [DatabaseModule],
-      controllers: [AppController],
-      providers: [AppService],
+      controllers: [HealthController],
     }).compile();
 
-    appController = app.get<AppController>(AppController);
+    healthController = app.get<HealthController>(HealthController);
   });
 
   describe("root", () => {
     it("should return Hello world string with db connection status and version", () => {
       const expected = `Hello World! The database dataSource is true and version: ${
         process.env.VERSION ?? "-1"
       }`;
-      expect(appController.getHello()).toBe(expected);
+      expect(healthController.getHello()).toBe(expected);
     });
   });
 });

sources/packages/backend/apps/api/src/route-controllers/health-check/health.controller.ts

@@ -0,0 +1,32 @@
+import { Controller, Get } from "@nestjs/common";
+import { Public } from "../../auth/decorators";
+import { DataSource } from "typeorm";
+
+@Controller("health")
+export class HealthController {
+  constructor(private readonly dataSource: DataSource) {}
+
+  /**
+   * Returns a health check status.
+   * @returns health check status.
+   */
+  @Get()
+  @Public()
+  getHello(): string {
+    return this.getHeathCheckStatus();
+  }
+
+  /**
+   * Get health check status.
+   * @returns health check status.
+   */
+  private getHeathCheckStatus(): string {
+    try {
+      return `Hello World! The database dataSource is ${
+        this.dataSource.isInitialized
+      } and version: ${process.env.VERSION ?? "-1"}`;
+    } catch (error: unknown) {
+      return `Hello world! Fail with error: ${error}`;
+    }
+  }
+}

sources/packages/backend/apps/api/src/route-controllers/index.ts

@@ -86,3 +86,4 @@ export * from "./student/student.external.controller";
 export * from "./cas-invoice-batch/cas-invoice-batch.aest.controller";
 export * from "./models/primary.identifier.dto";
 export * from "./models/common.dto";
+export * from "./health-check/health.controller";

sources/packages/backend/apps/api/src/utilities/http-utils.ts

@@ -0,0 +1,18 @@
+import { Request } from "express";
+
+/**
+ * Header name for the client IP address.
+ */
+const CLIENT_IP_HEADER_NAME = "x-forwarded-for";
+
+/**
+ * Gets the client IP address from the http request.
+ * @param request http request.
+ * @returns client IP address.
+ */
+export function getClientIPFromRequest(request: Request): string {
+  return (
+    (request.headers[CLIENT_IP_HEADER_NAME] as string) ??
+    request.socket.remoteAddress
+  );
+}

sources/packages/backend/apps/api/src/utilities/index.ts

@@ -11,3 +11,4 @@ export * from "./datatable-database-mapping-utils";
 export * from "./datatable-config";
 export * from "./pagination-utils";
 export * from "./address-utils";
+export * from "./http-utils";