Improve healthcheck performance

Author: pingwindyktator

src/controller/app/app.controller.ts

@@ -1,11 +1,12 @@
-import { Controller, Get, Logger } from '@nestjs/common';
+import { Controller, Get, Inject, Logger } from '@nestjs/common';
 import {
   HealthCheckService,
   HttpHealthIndicator,
   HealthCheck,
   TypeOrmHealthIndicator,
   HealthIndicator,
   HealthIndicatorResult,
+  HealthCheckResult,
 } from '@nestjs/terminus';
 import { ApiExcludeEndpoint } from '@nestjs/swagger';
 import { PostgresService } from 'src/db/postgres.service';
@@ -16,15 +17,17 @@ import { ConfigService } from '@nestjs/config';
 import { AllocatorReportGeneratorJobService } from 'src/jobs/allocator-report-generator-job/allocator-report-generator-job.service';
 import { IpniAdvertisementFetcherJobService } from 'src/jobs/ipni-advertisement-fetcher-job/ipni-advertisement-fetcher-job.service';
 import { LocationService } from 'src/service/location/location.service';
-import { CacheTTL } from '@nestjs/cache-manager';
+import { Cache, CACHE_MANAGER, CacheTTL } from '@nestjs/cache-manager';
 import { GitHubTriggersHandlerService } from 'src/service/github-triggers-handler-service/github-triggers-handler.service';
+import { Cacheable } from 'src/utils/cacheable';
 
 @Controller()
 export class AppController extends HealthIndicator {
   private readonly logger = new Logger(AppController.name);
   private readonly appStartTime = new Date();
 
   constructor(
+    @Inject(CACHE_MANAGER) private readonly cacheManager: Cache,
     private readonly healthCheckService: HealthCheckService,
     private readonly httpHealthIndicator: HttpHealthIndicator,
     private readonly typeOrmHealthIndicator: TypeOrmHealthIndicator,
@@ -50,57 +53,57 @@ export class AppController extends HealthIndicator {
   @Get('/debug')
   @CacheTTL(1) // disable cache
   @ApiExcludeEndpoint()
-  async getDebug() {
+  public async getDebug() {
     return 'debug';
   }
 
-  private async _getHealth(): Promise<HealthIndicatorResult> {
+  @Get('health')
+  @HealthCheck()
+  @CacheTTL(1) // disable cache
+  public async getHealth(): Promise<HealthCheckResult> {
+    return this._getHealth();
+  }
+
+  private async _getHealthMetadata(): Promise<HealthIndicatorResult> {
     return this.getStatus('app', true, {
       appStartTime: this.appStartTime,
     });
   }
 
-  @Get('health')
-  @HealthCheck()
-  @CacheTTL(1000 * 10) // 10 seconds
-  public async getHealth() {
-    this.logger.debug('Running healthcheck');
+  // cache http ping checks for better performance
+  @Cacheable({ ttl: 1000 * 60 * 10 }) // 10 minutes
+  private async _httpPingCheck(
+    name: string,
+    url: string,
+  ): Promise<HealthIndicatorResult> {
+    return this.httpHealthIndicator.pingCheck(name, url);
+  }
+
+  // dedicated cache for ipinfo.io because of token limits
+  @Cacheable({ ttl: 1000 * 60 * 60 }) // 1 hour
+  private async _httpPingCheckIpInfo(): Promise<HealthIndicatorResult> {
+    return await this.httpHealthIndicator.pingCheck(
+      'ipinfo.io',
+      `https://ipinfo.io/8.8.8.8?token=${this.configService.get<string>('IP_INFO_TOKEN')}`,
+    );
+  }
 
+  @Cacheable({ ttl: 1000 * 10 }) // 10 seconds
+  private async _getHealth(): Promise<HealthCheckResult> {
+    // prettier-ignore
     return this.healthCheckService.check([
-      () => this._getHealth(),
-      () => this.locationService.getHealth(),
-      () =>
-        this.httpHealthIndicator.pingCheck(
-          'cid.contact',
-          'https://cid.contact/health',
-        ),
-      () =>
-        this.httpHealthIndicator.pingCheck(
-          'glif-api',
-          `${this.configService.get<string>('GLIF_API_BASE_URL')}/v1`,
-        ),
-      () =>
-        this.httpHealthIndicator.pingCheck(
-          'allocator-tech-api',
-          `${this.configService.get<string>('ALLOCATOR_TECH_BASE_URL')}/health`,
-        ),
-      () =>
-        this.httpHealthIndicator.pingCheck(
-          'api.datacapstats.io',
-          'https://api.datacapstats.io/api/health',
-        ),
-      () =>
-        this.httpHealthIndicator.pingCheck(
-          'stats.filspark.com',
-          'https://stats.filspark.com',
-        ),
-      () =>
-        this.typeOrmHealthIndicator.pingCheck('database', {
+      () => this._getHealthMetadata(),
+      () => this._httpPingCheckIpInfo(),
+      () => this._httpPingCheck('cid.contact', 'https://cid.contact/health'),
+      () => this._httpPingCheck('glif-api', `${this.configService.get<string>('GLIF_API_BASE_URL')}/v1`),
+      () => this._httpPingCheck('allocator-tech-api', `${this.configService.get<string>('ALLOCATOR_TECH_BASE_URL')}/health`),
+      () => this._httpPingCheck('api.datacapstats.io', 'https://api.datacapstats.io/api/health'),
+      () => this._httpPingCheck('stats.filspark.com', 'https://stats.filspark.com'),
+      () => this.typeOrmHealthIndicator.pingCheck('database', {
           connection: this.postgresService.pool,
           timeout: 2000,
         }),
-      () =>
-        this.typeOrmHealthIndicator.pingCheck('database-dmob', {
+      () => this.typeOrmHealthIndicator.pingCheck('database-dmob', {
           connection: this.postgresDmobService.pool,
           timeout: 2000,
         }),

src/service/location/location.service.ts

@@ -6,7 +6,6 @@ import { HttpService } from '@nestjs/axios';
 import { firstValueFrom } from 'rxjs';
 import { Address, IPResponse } from './types.location';
 import { CACHE_MANAGER, Cache } from '@nestjs/cache-manager';
-import { HealthIndicatorResult, HttpHealthIndicator } from '@nestjs/terminus';
 import { Cacheable } from 'src/utils/cacheable';
 
 @Injectable()
@@ -16,19 +15,9 @@ export class LocationService {
   constructor(
     private configService: ConfigService,
     private readonly httpService: HttpService,
-    private httpHealthIndicator: HttpHealthIndicator,
     @Inject(CACHE_MANAGER) private readonly cacheManager: Cache,
   ) {}
 
-  // dedicated, heavily cached healthcheck needed because of ipinfo.io token limits
-  @Cacheable({ ttl: 1000 * 60 * 60 }) // 1 hour
-  public async getHealth(): Promise<HealthIndicatorResult> {
-    return await this.httpHealthIndicator.pingCheck(
-      'ipinfo.io',
-      `https://ipinfo.io/8.8.8.8?token=${this.configService.get<string>('IP_INFO_TOKEN')}`,
-    );
-  }
-
   public async getLocation(multiAddrs?: string[]): Promise<IPResponse | null> {
     if (!multiAddrs) return null;