feat(examples): add redis integrations

Author: CSenshi

docker-compose.yml

@@ -3,3 +3,16 @@ services:
     image: redis:8-alpine
     ports:
       - '6379:6379'
+
+  redis-cluster:
+    image: redis/redis-stack:latest
+    command: |
+      sh -c '
+        redis-server --port 6380 --cluster-enabled yes --cluster-config-file nodes.conf --cluster-node-timeout 5000 --appendonly yes --loadmodule /opt/redis-stack/lib/redisearch.so --loadmodule /opt/redis-stack/lib/rejson.so --protected-mode no --bind 0.0.0.0 &
+        sleep 5
+        redis-cli -p 6380 cluster meet 127.0.0.1 6380 || true
+        redis-cli -p 6380 cluster addslots $(seq 0 16383 | tr "\n" " ") || true
+        wait
+      '
+    ports:
+      - '6380:6380'

examples/full/package.json

@@ -6,7 +6,9 @@
     "targets": {
       "build": {
         "executor": "nx:run-commands",
-        "outputs": ["{projectRoot}/dist"],
+        "outputs": [
+          "{projectRoot}/dist"
+        ],
         "options": {
           "command": "webpack-cli build",
           "args": [
@@ -78,5 +80,8 @@
       }
     }
   },
-  "dependencies": {}
+  "dependencies": {
+    "@nestjs-redis/kit": "*",
+    "redis": "^5.0.0"
+  }
 }

examples/full/src/app/app.controller.ts

@@ -1,12 +1,19 @@
-import { Controller, Get } from '@nestjs/common';
+import { Controller, Get, UseGuards } from '@nestjs/common';
+import { ThrottlerGuard } from '@nestjs/throttler';
 import { AppService } from './app.service';
 
 @Controller()
 export class AppController {
   constructor(private readonly appService: AppService) {}
 
-  @Get()
+  @Get('date')
   getData() {
-    return this.appService.getData();
+    return this.appService.getValue('test-date');
+  }
+
+  @Get('date/set')
+  @UseGuards(ThrottlerGuard)
+  async setData() {
+    return this.appService.setValue('test-date', new Date().toISOString());
   }
 }

examples/full/src/app/app.module.ts

@@ -1,10 +1,54 @@
+// app.module.ts
 import { Module } from '@nestjs/common';
+import { TerminusModule } from '@nestjs/terminus';
+import { ThrottlerModule, seconds } from '@nestjs/throttler';
+import {
+  RedisHealthIndicator,
+  RedisModule,
+  RedisThrottlerStorage,
+  RedisToken,
+  RedlockModule,
+} from '@nestjs-redis/kit';
+import type { RedisClientType } from 'redis';
 import { AppController } from './app.controller';
 import { AppService } from './app.service';
+import { HealthController } from './health.controller';
 
 @Module({
-  imports: [],
-  controllers: [AppController],
-  providers: [AppService],
+  imports: [
+    // Client
+    RedisModule.forRoot({
+      isGlobal: true,
+      options: { url: 'redis://localhost:6379' },
+    }),
+    RedisModule.forRoot({
+      isGlobal: true,
+      options: { url: 'redis://localhost:6380' },
+      connectionName: 'cluster',
+    }),
+
+    // Locking
+    RedlockModule.forRootAsync({
+      inject: [RedisToken()],
+      useFactory: (redis: RedisClientType) => ({
+        clients: [redis],
+        redlockConfig: { retryDelayMs: 100, retryCount: 2 },
+      }),
+    }),
+
+    // Throttling
+    ThrottlerModule.forRootAsync({
+      inject: [RedisToken()],
+      useFactory: (redis: RedisClientType) => ({
+        throttlers: [{ limit: 5111, ttl: seconds(60) }],
+        storage: new RedisThrottlerStorage(redis),
+      }),
+    }),
+
+    // Health checks
+    TerminusModule,
+  ],
+  controllers: [AppController, HealthController],
+  providers: [RedisHealthIndicator, AppService],
 })
 export class AppModule {}

examples/full/src/app/app.service.ts

@@ -1,8 +1,19 @@
+// app.service.ts
 import { Injectable } from '@nestjs/common';
+import { InjectRedis, Redlock } from '@nestjs-redis/kit';
+import type { RedisClientType } from 'redis';
 
 @Injectable()
 export class AppService {
-  getData(): { message: string } {
-    return { message: 'Hello API' };
+  constructor(@InjectRedis() private readonly redis: RedisClientType) {}
+
+  @Redlock(['locks:test'], 100)
+  async setValue(key: string, value: string) {
+    await new Promise((resolve) => setTimeout(resolve, 2000));
+    await this.redis.set(key, value);
+  }
+
+  async getValue(key: string) {
+    return this.redis.get(key);
   }
 }

examples/full/src/app/health.controller.ts

@@ -0,0 +1,30 @@
+import { Controller, Get } from '@nestjs/common';
+import { HealthCheck, HealthCheckService } from '@nestjs/terminus';
+import { InjectRedis, RedisHealthIndicator } from '@nestjs-redis/kit';
+import type { RedisClientType, RedisClusterType } from 'redis';
+
+@Controller('health')
+export class HealthController {
+  constructor(
+    private readonly health: HealthCheckService,
+    private readonly redis: RedisHealthIndicator,
+    @InjectRedis() private readonly redisClient: RedisClientType,
+    @InjectRedis('cluster')
+    private readonly redisClusterClient: RedisClusterType,
+  ) {}
+
+  @Get()
+  @HealthCheck()
+  check() {
+    return this.health.check([
+      () =>
+        this.redis.isHealthy('redis-client', {
+          client: this.redisClient,
+        }),
+      () =>
+        this.redis.isHealthy('redis-cluster', {
+          client: this.redisClusterClient,
+        }),
+    ]);
+  }
+}

examples/full/tsconfig.app.json

@@ -10,5 +10,10 @@
     "target": "es2021"
   },
   "include": ["src/**/*.ts"],
-  "exclude": ["eslint.config.js", "eslint.config.cjs", "eslint.config.mjs"]
+  "exclude": ["eslint.config.js", "eslint.config.cjs", "eslint.config.mjs"],
+  "references": [
+    {
+      "path": "../../packages/kit/tsconfig.lib.json"
+    }
+  ]
 }

examples/full/tsconfig.json

@@ -3,6 +3,9 @@
   "files": [],
   "include": [],
   "references": [
+    {
+      "path": "../../packages/kit"
+    },
     {
       "path": "./tsconfig.app.json"
     }