feat: enhance NestJS Redis example with configuration and delete functionality

Author: iamnivekx

examples/nest-redis-example/package.json

@@ -22,6 +22,7 @@
   "dependencies": {
     "@nestjs-labs/nestjs-redis": "workspace:^",
     "@nestjs/common": "11.0.1",
+    "@nestjs/config": "^4.0.2",
     "@nestjs/core": "11.0.1",
     "@nestjs/platform-express": "^11.0.1",
     "redis": "^5.6.0",

examples/nest-redis-example/src/app.controller.ts

@@ -1,4 +1,4 @@
-import { Body, Controller, Get, Post, Query } from '@nestjs/common';
+import { Body, Controller, Delete, Get, Post, Query } from '@nestjs/common';
 import { AppService } from './app.service';
 
 @Controller()
@@ -25,4 +25,9 @@ export class AppController {
   async getKey(@Query('key') key: string) {
     return await this.appService.getKey(key);
   }
+
+  @Delete('delete-key')
+  async deleteKey(@Body('key') key: string) {
+    return await this.appService.deleteKey(key);
+  }
 }

examples/nest-redis-example/src/app.module.ts

@@ -1,14 +1,32 @@
 import { Module } from '@nestjs/common';
+import { ConfigModule, ConfigService } from '@nestjs/config';
 import { RedisModule } from '@nestjs-labs/nestjs-redis';
 
 import { AppController } from './app.controller';
 import { AppService } from './app.service';
 
 @Module({
   imports: [
-    RedisModule.forRoot({
-      readonly: false,
-      url: 'redis://localhost:6379',
+    ConfigModule.forRoot(),
+
+    // use root
+    // RedisModule.forRoot({
+    //   readonly: false,
+    //   url: 'redis://localhost:6379',
+    // }),
+
+    // use factory
+    RedisModule.forRootAsync({
+      imports: [ConfigModule],
+      useFactory: (configService: ConfigService) => {
+        const url: string = configService.get('REDIS_URL')!;
+        console.log(url);
+        return {
+          url,
+          isGlobal: true,
+        };
+      },
+      inject: [ConfigService],
     }),
   ],
   controllers: [AppController],

packages/node-redis/lib/redis.module.ts

@@ -2,7 +2,7 @@ import { Module, DynamicModule } from '@nestjs/common';
 
 import { RedisModuleOptions, RedisModuleAsyncOptions } from './interfaces';
 import { ConfigurableModuleClass } from './redis.module-definition';
-import { createRedisClient } from './redis.providers';
+import { createRedisClient, createAsyncProviders } from './redis.providers';
 import { RedisService } from './redis.service';
 
 @Module({})
@@ -22,7 +22,14 @@ export class RedisModule extends ConfigurableModuleClass {
     return {
       global: options?.isGlobal,
       ...moduleDefinition,
-      providers: [...(moduleDefinition.providers ?? []), createRedisClient(), RedisService],
+      providers: [
+        ...(moduleDefinition.providers ?? []),
+        ...createAsyncProviders(options),
+        createRedisClient(),
+        RedisService,
+        ...(options.extraProviders ?? [])
+      ],
+      imports: [...(moduleDefinition.imports ?? []), ...(options.extraImports ?? [])],
       exports: [RedisService]
     };
   }

packages/node-redis/lib/redis.providers.ts

@@ -1,8 +1,10 @@
-import { Provider } from '@nestjs/common';
+import { Provider, Type } from '@nestjs/common';
 import { createClient, RedisClientType } from 'redis';
 import { REDIS_CLIENT } from './redis.constants';
 import { RedisOptions } from './interfaces';
 import { MODULE_OPTIONS_TOKEN } from './redis.module-definition';
+import { RedisModuleAsyncOptions, RedisModuleOptions } from './interfaces';
+import { RedisOptionsFactory } from './interfaces/redis-factory.interface';
 
 export const createRedisClient = (): Provider => ({
   provide: REDIS_CLIENT,
@@ -13,3 +15,43 @@ export const createRedisClient = (): Provider => ({
   },
   inject: [MODULE_OPTIONS_TOKEN]
 });
+
+export const createAsyncProviders = (options: RedisModuleAsyncOptions): Provider[] => {
+  if (options.useClass) {
+    return [
+      {
+        provide: options.useClass,
+        useClass: options.useClass
+      },
+      createAsyncOptionsProvider(options)
+    ];
+  }
+
+  if (options.useExisting || options.useFactory) return [createAsyncOptionsProvider(options)];
+
+  return [];
+};
+
+export const createAsyncOptionsProvider = (options: RedisModuleAsyncOptions): Provider => {
+  if (options.useFactory) {
+    return {
+      provide: MODULE_OPTIONS_TOKEN,
+      useFactory: options.useFactory,
+      inject: options.inject || []
+    };
+  }
+
+  const inject: Type<RedisOptionsFactory<RedisModuleOptions>>[] = [];
+  if (options.useClass) {
+    inject.push(options.useClass);
+  } else if (options.useExisting) {
+    inject.push(options.useExisting);
+  }
+
+  return {
+    provide: MODULE_OPTIONS_TOKEN,
+    useFactory: async (optionsFactory: RedisOptionsFactory<RedisModuleOptions>) =>
+      optionsFactory.createRedisOptions(),
+    inject,
+  };
+};

packages/node-redis/lib/redis.service.ts

@@ -20,6 +20,9 @@ export class RedisService<
     return this.client;
   }
 
+  /**
+   * Quit the redis client instance.
+   */
   async onApplicationShutdown(): Promise<void> {
     await this.client.quit();
   }

packages/node-redis/package.json

@@ -1,13 +1,14 @@
 {
   "name": "@nestjs-labs/nestjs-redis",
-  "version": "1.0.0",
+  "version": "11.0.0",
   "description": "Redis(node-redis) module for Nest framework (node.js).",
-  "author": "LiaoLiao <yxiaosong002@gmail.com>",
+  "author": "Nestjs-labs <h499871809@gmail.com>",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "type": "commonjs",
   "files": [
-    "dist"
+    "dist",
+    "README.md"
   ],
   "license": "MIT",
   "keywords": [

packages/node-redis/tsconfig.json

@@ -1,6 +1,7 @@
 {
   "extends": "../tsconfig.base.json",
   "compilerOptions": {
+    "forceConsistentCasingInFileNames": true,
     "outDir": "dist",
     "paths": {
       "@/*": ["./lib/*"]