Merge branch 'feat/example-app'

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/eslint.config.mjs

@@ -0,0 +1,3 @@
+import baseConfig from '../../eslint.config.mjs';
+
+export default [...baseConfig];

examples/full/package.json

@@ -0,0 +1,87 @@
+{
+  "name": "@examples/full",
+  "version": "0.0.1",
+  "private": true,
+  "nx": {
+    "targets": {
+      "build": {
+        "executor": "nx:run-commands",
+        "outputs": [
+          "{projectRoot}/dist"
+        ],
+        "options": {
+          "command": "webpack-cli build",
+          "args": [
+            "--node-env=production"
+          ],
+          "cwd": "examples/full"
+        },
+        "configurations": {
+          "development": {
+            "args": [
+              "--node-env=development"
+            ]
+          }
+        }
+      },
+      "prune-lockfile": {
+        "dependsOn": [
+          "build"
+        ],
+        "cache": true,
+        "executor": "@nx/js:prune-lockfile",
+        "outputs": [
+          "{workspaceRoot}/examples/full/dist/package.json",
+          "{workspaceRoot}/examples/full/dist/pnpm-lock.yaml"
+        ],
+        "options": {
+          "buildTarget": "build"
+        }
+      },
+      "copy-workspace-modules": {
+        "dependsOn": [
+          "build"
+        ],
+        "cache": true,
+        "outputs": [
+          "{workspaceRoot}/examples/full/dist/workspace_modules"
+        ],
+        "executor": "@nx/js:copy-workspace-modules",
+        "options": {
+          "buildTarget": "build"
+        }
+      },
+      "prune": {
+        "dependsOn": [
+          "prune-lockfile",
+          "copy-workspace-modules"
+        ],
+        "executor": "nx:noop"
+      },
+      "serve": {
+        "continuous": true,
+        "executor": "@nx/js:node",
+        "defaultConfiguration": "development",
+        "dependsOn": [
+          "build"
+        ],
+        "options": {
+          "buildTarget": "@examples/full:build",
+          "runBuildTargetDependencies": false
+        },
+        "configurations": {
+          "development": {
+            "buildTarget": "@examples/full:build:development"
+          },
+          "production": {
+            "buildTarget": "@examples/full:build:production"
+          }
+        }
+      }
+    }
+  },
+  "dependencies": {
+    "@nestjs-redis/kit": "*",
+    "redis": "^5.0.0"
+  }
+}

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

@@ -0,0 +1,19 @@
+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('date')
+  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

@@ -0,0 +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: [
+    // 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

@@ -0,0 +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 {
+  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/src/assets/.gitkeep

@@ -0,0 +1,20 @@
+/**
+ * This is not a production server yet!
+ * This is only a minimal backend to get started.
+ */
+import { Logger } from '@nestjs/common';
+import { NestFactory } from '@nestjs/core';
+import { AppModule } from './app/app.module';
+
+async function bootstrap() {
+  const app = await NestFactory.create(AppModule);
+  const globalPrefix = 'api';
+  app.setGlobalPrefix(globalPrefix);
+  const port = process.env.PORT || 3000;
+  await app.listen(port);
+  Logger.log(
+    `🚀 Application is running on: http://localhost:${port}/${globalPrefix}`,
+  );
+}
+
+bootstrap();

examples/full/src/main.ts

@@ -0,0 +1,19 @@
+{
+  "extends": "../../tsconfig.base.json",
+  "compilerOptions": {
+    "outDir": "dist",
+    "types": ["node"],
+    "rootDir": "src",
+    "tsBuildInfoFile": "dist/tsconfig.app.tsbuildinfo",
+    "experimentalDecorators": true,
+    "emitDecoratorMetadata": true,
+    "target": "es2021"
+  },
+  "include": ["src/**/*.ts"],
+  "exclude": ["eslint.config.js", "eslint.config.cjs", "eslint.config.mjs"],
+  "references": [
+    {
+      "path": "../../packages/kit/tsconfig.lib.json"
+    }
+  ]
+}