feat(browser-service): add HTTP module and routes, including health c…

…hecks and error handling

apps/browser-service/.env.local

@@ -1,4 +1,5 @@
 GRPC_PORT=50051
+HTTP_PORT=5001
 NODE_ENV=development
 SERVICE_NAME=browser-service
 

apps/browser-service/k8s/helm-chart/templates/deployment.yaml

@@ -37,6 +37,9 @@ spec:
             - name: grpc
               containerPort: {{ .Values.service.port }}
               protocol: TCP
+            - name: http
+              containerPort: 5001
+              protocol: TCP
           envFrom:
             {{- toYaml .Values.envFrom | nindent 12 }}
           # livenessProbe:

apps/browser-service/k8s/helm-chart/templates/grpc-route.yaml

@@ -1,4 +1,4 @@
-apiVersion: gateway.networking.k8s.io/v1alpha2
+apiVersion: gateway.networking.k8s.io/v1
 kind: GRPCRoute
 metadata:
   name: browser-service
@@ -17,6 +17,12 @@ spec:
         - method:
             service: diut.BrowserService
             method: PrintMultiplePage
+        - method:
+            service: diut.BrowserService
+            method: TestTimeout
+        - method:
+            service: diut.BrowserService
+            method: TestError
 ---
 apiVersion: gateway.envoyproxy.io/v1alpha1
 kind: BackendTrafficPolicy

apps/browser-service/k8s/helm-chart/templates/http-route.yaml

@@ -0,0 +1,22 @@
+apiVersion: gateway.networking.k8s.io/v1
+kind: HTTPRoute
+metadata:
+  name: browser-service
+  namespace: infra
+spec:
+  parentRefs:
+    - kind: Gateway
+      name: gateway-external
+      namespace: envoy-gateway-system
+      sectionName: http
+  rules:
+    - timeouts:
+        request: "60s"
+        backendRequest: "60s"
+      matches:
+        - path:
+            type: PathPrefix
+            value: /api
+      backendRefs:
+        - name: browser-service
+          port: 5001

apps/browser-service/k8s/helm-chart/templates/service.yaml

@@ -11,5 +11,9 @@ spec:
       targetPort: grpc
       protocol: TCP
       name: grpc
+    - port: 5001
+      targetPort: http
+      protocol: TCP
+      name: http
   selector:
     {{- include "this.selectorLabels" . | nindent 4 }}

apps/browser-service/package.json

@@ -28,6 +28,7 @@
     "@nestjs/config": "^3.2.0",
     "@nestjs/core": "^10.3.3",
     "@nestjs/microservices": "^10.3.3",
+    "@nestjs/terminus": "^10.2.3",
     "@opentelemetry/api": "^1.9.0",
     "@opentelemetry/auto-instrumentations-node": "^0.48.0",
     "@opentelemetry/core": "1.25.1",

apps/browser-service/src/app.module.ts

@@ -1,7 +1,7 @@
 import { Module } from '@nestjs/common'
-import { GrpcModule } from './controller'
+import { GrpcModule, HttpModule } from './controller'
 
 @Module({
-  imports: [GrpcModule],
+  imports: [GrpcModule, HttpModule],
 })
 export class AppModule {}

apps/browser-service/src/config/app.ts

@@ -8,6 +8,10 @@ export class AppConfig {
   @IsNumber()
   GRPC_PORT: number
 
+  @Expose()
+  @IsNumber()
+  HTTP_PORT: number
+
   @Expose()
   @MinLength(3)
   @IsString()

apps/browser-service/src/controller/grpc/controller.ts

@@ -4,11 +4,14 @@ import {
   PrintPageReply,
   PrintPageRequest,
 } from '@diut/services'
+import { Controller } from '@nestjs/common'
 import { Observable, concatMap } from 'rxjs'
 import { BrowserPrintMultipleUseCase } from 'src/app/browser/use-case/print-multiple'
+import { setTimeout } from 'timers/promises'
 import { PrintPageRequestDto } from './dto/print-page.request-dto'
 import { validateDto } from './shared'
 
+@Controller()
 @BrowserServiceControllerMethods()
 export class BrowserServiceController implements IBrowserServiceController {
   constructor(
@@ -29,4 +32,12 @@ export class BrowserServiceController implements IBrowserServiceController {
 
     return { mergedPdf }
   }
+
+  async testTimeout(): Promise<void> {
+    return setTimeout(120_000)
+  }
+
+  async testError(): Promise<void> {
+    throw new Error('test error')
+  }
 }

apps/browser-service/src/controller/http/health/controller.ts

@@ -0,0 +1,39 @@
+import { InjectPuppeteerService, PuppeteerService } from '@diut/nestjs-infra'
+import { Controller, Get, UseFilters } from '@nestjs/common'
+import {
+  HealthCheck,
+  HealthCheckResult,
+  HealthCheckService,
+} from '@nestjs/terminus'
+import { setTimeout } from 'timers/promises'
+import { AllExceptionsFilter } from '../shared/exception-filter'
+
+@Controller('health')
+@UseFilters(AllExceptionsFilter)
+export class HealthController {
+  constructor(
+    private readonly health: HealthCheckService,
+    @InjectPuppeteerService()
+    private readonly puppeteerClient: PuppeteerService,
+  ) {}
+
+  @Get('liveness')
+  @HealthCheck()
+  async liveness() {
+    const result: HealthCheckResult = await this.health.check([
+      () => this.puppeteerClient.healthcheck(),
+    ])
+
+    return result
+  }
+
+  @Get('error')
+  async error() {
+    throw new Error('Error')
+  }
+
+  @Get('timeout')
+  async timeout() {
+    return setTimeout(120_000)
+  }
+}

apps/browser-service/src/controller/http/health/index.ts

@@ -0,0 +1 @@
+export * from './module'

apps/browser-service/src/controller/http/health/module.ts

@@ -0,0 +1,8 @@
+import { ModuleMetadata } from '@nestjs/common'
+import { TerminusModule } from '@nestjs/terminus'
+import { HealthController } from './controller'
+
+export const healthModuleMetadata: ModuleMetadata = {
+  imports: [TerminusModule],
+  controllers: [HealthController],
+}

apps/browser-service/src/controller/http/index.ts

@@ -0,0 +1 @@
+export * from './module'

apps/browser-service/src/controller/http/module.ts

@@ -0,0 +1,7 @@
+import { concatModuleMetadata } from '@diut/nestjs-infra'
+import { Module } from '@nestjs/common'
+import { healthModuleMetadata } from './health'
+import { commonModuleMetadata } from './shared'
+
+@Module(concatModuleMetadata([...commonModuleMetadata, healthModuleMetadata]))
+export class HttpModule {}

apps/browser-service/src/controller/http/shared/exception-filter.ts

@@ -0,0 +1,38 @@
+import {
+  ArgumentsHost,
+  Catch,
+  ExceptionFilter,
+  HttpException,
+  HttpStatus,
+  Logger,
+} from '@nestjs/common'
+import { HttpAdapterHost } from '@nestjs/core'
+
+@Catch()
+export class AllExceptionsFilter implements ExceptionFilter {
+  private logger = new Logger(this.constructor.name)
+
+  constructor(private readonly httpAdapterHost: HttpAdapterHost) {}
+
+  catch(exception: unknown, host: ArgumentsHost) {
+    const { httpAdapter } = this.httpAdapterHost
+    const ctx = host.switchToHttp()
+
+    const httpStatus =
+      exception instanceof HttpException
+        ? exception.getStatus()
+        : HttpStatus.INTERNAL_SERVER_ERROR
+    const message = String(exception)
+
+    this.logger.error({
+      message,
+      httpStatus,
+    })
+
+    const responseBody = {
+      message,
+    }
+
+    httpAdapter.reply(ctx.getResponse(), responseBody, httpStatus)
+  }
+}

apps/browser-service/src/controller/http/shared/index.ts

@@ -0,0 +1 @@
+export * from './module'

apps/browser-service/src/controller/http/shared/module.ts

@@ -0,0 +1,10 @@
+import { ModuleMetadata } from '@nestjs/common'
+import { appMetadata } from 'src/app'
+import { configMetadata } from 'src/config'
+import { infraMetadata } from 'src/infra'
+
+export const commonModuleMetadata: ModuleMetadata[] = [
+  configMetadata,
+  infraMetadata,
+  appMetadata,
+]

apps/browser-service/src/controller/index.ts

@@ -1 +1,2 @@
 export * from './grpc'
+export * from './http'

apps/browser-service/src/main.ts

@@ -1,37 +1,48 @@
 import './otel'
 //
 import {
-  GrpcListenBootstrap,
+  HttpListenBootstrap,
   LifecycleBootstrap,
   PinoBootstrapFactory,
+  PrefixBootstrap,
   bootstrapApp,
 } from '@diut/nestjs-infra'
 import {
   DIUT_PACKAGE_NAME,
   DiutGrpcService,
   resolveProtoPath,
 } from '@diut/services'
-import { INestMicroservice } from '@nestjs/common'
+import { INestApplication } from '@nestjs/common'
 import { NestFactory } from '@nestjs/core'
 import { MicroserviceOptions, Transport } from '@nestjs/microservices'
 import * as dotenv from 'dotenv'
 import { AppModule } from './app.module'
 
 dotenv.config()
 
-bootstrapApp<INestMicroservice>(
-  (AppModule, options) =>
-    NestFactory.createMicroservice<MicroserviceOptions>(AppModule, {
-      ...options,
-      transport: Transport.GRPC,
-      options: {
-        url: `0.0.0.0:${process.env.GRPC_PORT}`,
-        package: DIUT_PACKAGE_NAME,
-        protoPath: resolveProtoPath(DiutGrpcService.Browser, __dirname),
-        maxReceiveMessageLength: 20_000_000,
-      },
-    }),
+bootstrapApp<INestApplication>(
+  (AppModule, options) => NestFactory.create(AppModule, options),
   AppModule,
   { serviceName: process.env.SERVICE_NAME, nodeEnv: process.env.NODE_ENV },
-  [PinoBootstrapFactory(), LifecycleBootstrap, GrpcListenBootstrap],
+  [
+    PinoBootstrapFactory(),
+    LifecycleBootstrap,
+    {
+      async afterInit(ctx) {
+        ctx.app.connectMicroservice<MicroserviceOptions>({
+          transport: Transport.GRPC,
+          options: {
+            url: `0.0.0.0:${process.env.GRPC_PORT}`,
+            package: DIUT_PACKAGE_NAME,
+            protoPath: resolveProtoPath(DiutGrpcService.Browser, __dirname),
+            maxReceiveMessageLength: 20_000_000,
+          },
+        })
+
+        await ctx.app.startAllMicroservices()
+      },
+    },
+    PrefixBootstrap,
+    HttpListenBootstrap(process.env.HTTP_PORT),
+  ],
 )

apps/hcdc-access-service/k8s/helm-chart/templates/http-route.yaml

@@ -9,17 +9,16 @@ spec:
       name: gateway-external
       namespace: envoy-gateway-system
       sectionName: http
+  hostnames:
+    - lab.hcdc.vn
   rules:
     - timeouts:
         request: "60s"
         backendRequest: "60s"
-      hostnames:
-        - lab.hcdc.vn
-      rules:
-        - matches:
-            - path:
-                type: PathMatchPrefix
-                value: /api
-          backendRefs:
-            - name: hcdc-access-service
-              port: 5000
+      matches:
+        - path:
+            type: PathMatchPrefix
+            value: /api
+      backendRefs:
+        - name: hcdc-access-service
+          port: 5000

libs/nestjs-infra/src/controller/http/bootstrap/http-listen.bootstrap.ts

@@ -26,7 +26,8 @@ export const HttpListenBootstrap: (
         try {
           await ctx.app.listen(port)
           break
-        } catch {
+        } catch (e) {
+          console.warn(e)
           await setTimeout(1000)
         }
       }