Merge pull request docmost#64 from docmost/feat/health

Add health check

apps/server/package.json

@@ -44,6 +44,7 @@
     "@nestjs/passport": "^10.0.3",
     "@nestjs/platform-fastify": "^10.3.9",
     "@nestjs/platform-socket.io": "^10.3.9",
+    "@nestjs/terminus": "^10.2.3",
     "@nestjs/websockets": "^10.3.9",
     "@react-email/components": "0.0.19",
     "@react-email/render": "^0.0.15",

apps/server/src/app.module.ts

@@ -11,6 +11,7 @@ import { MailModule } from './integrations/mail/mail.module';
 import { QueueModule } from './integrations/queue/queue.module';
 import { StaticModule } from './integrations/static/static.module';
 import { EventEmitterModule } from '@nestjs/event-emitter';
+import { HealthModule } from './integrations/health/health.module';
 
 @Module({
   imports: [
@@ -21,6 +22,7 @@ import { EventEmitterModule } from '@nestjs/event-emitter';
     WsModule,
     QueueModule,
     StaticModule,
+    HealthModule,
     StorageModule.forRootAsync({
       imports: [EnvironmentModule],
     }),

apps/server/src/common/interceptors/http-response.interceptor.ts

@@ -16,7 +16,15 @@ export class TransformHttpResponseInterceptor<T>
   intercept(
     context: ExecutionContext,
     next: CallHandler<T>,
-  ): Observable<Response<T>> {
+  ): Observable<Response<T> | any> {
+    const request = context.switchToHttp().getRequest();
+    const path = request.url;
+
+    // Skip interceptor for the /api/health path
+    if (path === '/api/health') {
+      return next.handle();
+    }
+
     return next.handle().pipe(
       map((data) => {
         const status = context.switchToHttp().getResponse().statusCode;

apps/server/src/core/core.module.ts

@@ -34,7 +34,10 @@ export class CoreModule implements NestModule {
   configure(consumer: MiddlewareConsumer) {
     consumer
       .apply(DomainMiddleware)
-      .exclude({ path: 'auth/setup', method: RequestMethod.POST })
+      .exclude(
+        { path: 'auth/setup', method: RequestMethod.POST },
+        { path: 'health', method: RequestMethod.GET },
+      )
       .forRoutes('*');
   }
 }

apps/server/src/database/database.module.ts

@@ -36,6 +36,8 @@ types.setTypeParser(types.builtins.INT8, (val) => Number(val));
         dialect: new PostgresDialect({
           pool: new Pool({
             connectionString: environmentService.getDatabaseURL(),
+          }).on('error', (err) => {
+            console.error('Database error:', err.message);
           }),
         }),
         plugins: [new CamelCasePlugin()],
@@ -102,7 +104,7 @@ export class DatabaseModule implements OnModuleDestroy, OnApplicationBootstrap {
   }
 
   async establishConnection() {
-    const retryAttempts = 10;
+    const retryAttempts = 15;
     const retryDelay = 3000;
 
     this.logger.log('Establishing database connection');

apps/server/src/integrations/health/health.controller.ts

@@ -0,0 +1,22 @@
+import { Controller, Get } from '@nestjs/common';
+import { HealthCheck, HealthCheckService } from '@nestjs/terminus';
+import { PostgresHealthIndicator } from './postgres.health';
+import { RedisHealthIndicator } from './redis.health';
+
+@Controller('health')
+export class HealthController {
+  constructor(
+    private health: HealthCheckService,
+    private postgres: PostgresHealthIndicator,
+    private redis: RedisHealthIndicator,
+  ) {}
+
+  @Get()
+  @HealthCheck()
+  async check() {
+    return this.health.check([
+      () => this.postgres.pingCheck('database'),
+      () => this.redis.pingCheck('redis'),
+    ]);
+  }
+}

apps/server/src/integrations/health/health.module.ts

@@ -0,0 +1,13 @@
+import { Global, Module } from '@nestjs/common';
+import { HealthController } from './health.controller';
+import { TerminusModule } from '@nestjs/terminus';
+import { PostgresHealthIndicator } from './postgres.health';
+import { RedisHealthIndicator } from './redis.health';
+
+@Global()
+@Module({
+  controllers: [HealthController],
+  providers: [PostgresHealthIndicator, RedisHealthIndicator],
+  imports: [TerminusModule],
+})
+export class HealthModule {}

apps/server/src/integrations/health/postgres.health.ts

@@ -0,0 +1,31 @@
+import { InjectKysely } from 'nestjs-kysely';
+import {
+  HealthCheckError,
+  HealthIndicator,
+  HealthIndicatorResult,
+} from '@nestjs/terminus';
+import { Injectable, Logger } from '@nestjs/common';
+import { sql } from 'kysely';
+import { KyselyDB } from '@docmost/db/types/kysely.types';
+
+@Injectable()
+export class PostgresHealthIndicator extends HealthIndicator {
+  private readonly logger = new Logger(PostgresHealthIndicator.name);
+
+  constructor(@InjectKysely() private readonly db: KyselyDB) {
+    super();
+  }
+
+  async pingCheck(key: string): Promise<HealthIndicatorResult> {
+    try {
+      await sql`SELECT 1=1`.execute(this.db);
+      return this.getStatus(key, true);
+    } catch (e) {
+      this.logger.error(JSON.stringify(e));
+      throw new HealthCheckError(
+        `${key} is not available`,
+        this.getStatus(key, false),
+      );
+    }
+  }
+}

apps/server/src/integrations/health/redis.health.ts

@@ -0,0 +1,34 @@
+import {
+  HealthCheckError,
+  HealthIndicator,
+  HealthIndicatorResult,
+} from '@nestjs/terminus';
+import { Injectable, Logger } from '@nestjs/common';
+import { EnvironmentService } from '../environment/environment.service';
+import { Redis } from 'ioredis';
+
+@Injectable()
+export class RedisHealthIndicator extends HealthIndicator {
+  private readonly logger = new Logger(RedisHealthIndicator.name);
+
+  constructor(private environmentService: EnvironmentService) {
+    super();
+  }
+
+  async pingCheck(key: string): Promise<HealthIndicatorResult> {
+    try {
+      const redis = new Redis(this.environmentService.getRedisUrl(), {
+        maxRetriesPerRequest: 15,
+      });
+
+      await redis.ping();
+      return this.getStatus(key, true);
+    } catch (e) {
+      this.logger.error(e);
+      throw new HealthCheckError(
+        `${key} is not available`,
+        this.getStatus(key, false),
+      );
+    }
+  }
+}

apps/server/src/main.ts

@@ -40,7 +40,8 @@ async function bootstrap() {
     .addHook('preHandler', function (req, reply, done) {
       if (
         req.originalUrl.startsWith('/api') &&
-        !req.originalUrl.startsWith('/api/auth/setup')
+        !req.originalUrl.startsWith('/api/auth/setup') &&
+        !req.originalUrl.startsWith('/api/health')
       ) {
         if (!req.raw?.['workspaceId']) {
           throw new NotFoundException('Workspace not found');

package.json

@@ -12,7 +12,8 @@
     "client:dev": "nx run client:dev",
     "server:dev": "nx run server:start:dev",
     "server:start": "nx run server:start:prod",
-    "email:dev": "nx run @docmost/transactional:dev"
+    "email:dev": "nx run @docmost/transactional:dev",
+    "dev": "pnpm concurrently -n \"frontend,backend\" -c \"cyan,green\" \"pnpm run client:dev\" \"pnpm run server:dev\""
   },
   "dependencies": {
     "@docmost/editor-ext": "workspace:*",
@@ -66,6 +67,7 @@
     "@nx/js": "19.3.2",
     "@types/uuid": "^10.0.0",
     "nx": "19.3.2",
+    "concurrently": "^8.2.2",
     "tsx": "^4.15.7"
   },
   "workspaces": {