feat: add redis health indicator

Author: juandav

lib/index.ts

@@ -2,3 +2,4 @@ export * from './redis.module';
 export * from './redis.decorators';
 export * from './redis.interfaces';
 export * from './redis.utils';
+export * from './redis.health';

lib/redis.health.ts

@@ -0,0 +1,19 @@
+import { Injectable } from '@nestjs/common';
+import { HealthIndicator, HealthIndicatorResult, HealthCheckError } from '@nestjs/terminus';
+import Redis from 'ioredis';
+
+@Injectable()
+export class RedisHealthIndicator extends HealthIndicator {
+  constructor(private readonly redis: Redis) {
+    super();
+  }
+
+  async isHealthy(key: string): Promise<HealthIndicatorResult> {
+    try {
+      await this.redis.ping();
+      return this.getStatus(key, true);
+    } catch (error) {
+      throw new HealthCheckError('Redis check failed', this.getStatus(key, false, { message: error.message }));
+    }
+  }
+}

lib/redis.module.spec.ts

@@ -9,11 +9,11 @@ describe('RedisModule', () => {
   it('Instance Redis', async () => {
     const module: TestingModule = await Test.createTestingModule({
       imports: [RedisModule.forRoot({
-       config: {
-        host: '127.0.0.1',
-        port: 6379,
-        password: '123456',
-       }
+        config: {
+          host: '127.0.0.1',
+          port: 6379,
+          password: '123456',
+        }
       })],
     }).compile();
 
@@ -32,7 +32,7 @@ describe('RedisModule', () => {
           name: '1',
           host: '127.0.0.1',
           port: 6379,
-          password: '123456',  
+          password: '123456',
         }
       })],
     }).compile();
@@ -78,4 +78,4 @@ describe('RedisModule', () => {
 
     await app.close();
   });
-});
+});

package.json

@@ -29,9 +29,13 @@
     "@nestjs/core": ">=6.7.0",
     "ioredis": ">=5.0.0"
   },
+  "optionalDependencies": {
+    "@nestjs/terminus": "10.2.0"
+  },
   "devDependencies": {
     "@nestjs/common": "10.3.0",
     "@nestjs/core": "10.3.0",
+    "@nestjs/terminus": "10.2.0",
     "@nestjs/testing": "10.3.0",
     "@types/jest": "29.5.11",
     "@typescript-eslint/eslint-plugin": "6.15.0",