@hg-ts/redis 0.5.17 → 0.5.18

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hg-ts/redis",
-  "version": "0.5.17",
+  "version": "0.5.18",
   "main": "dist/index.js",
   "type": "module",
   "exports": {
@@ -16,11 +16,11 @@
     "lint:ts:fix": "lint-ts --fix"
   },
   "devDependencies": {
-    "@hg-ts-config/typescript": "0.5.17",
-    "@hg-ts/config-loader": "0.5.17",
-    "@hg-ts/linter": "0.5.17",
-    "@hg-ts/types": "0.5.17",
-    "@hg-ts/validation": "0.5.17",
+    "@hg-ts-config/typescript": "0.5.18",
+    "@hg-ts/config-loader": "0.5.18",
+    "@hg-ts/linter": "0.5.18",
+    "@hg-ts/types": "0.5.18",
+    "@hg-ts/validation": "0.5.18",
     "@nestjs/common": "11.1.0",
     "@types/node": "22.19.1",
     "eslint": "9.18.0",
@@ -31,8 +31,8 @@
     "typescript": "5.7.3"
   },
   "peerDependencies": {
-    "@hg-ts/config-loader": "0.5.17",
-    "@hg-ts/validation": "0.5.17",
+    "@hg-ts/config-loader": "0.5.18",
+    "@hg-ts/validation": "0.5.18",
     "@nestjs/common": "*",
     "reflect-metadata": "*",
     "rxjs": "*",

package/src/index.ts

@@ -0,0 +1,2 @@
+export * from './redis.module.js';
+export * from './redis.client.js';

package/src/redis.client.ts

@@ -0,0 +1,30 @@
+import {
+	Injectable,
+	OnModuleDestroy,
+	OnModuleInit,
+} from '@nestjs/common';
+
+import { Redis } from 'ioredis';
+
+import { RedisConfig } from './redis.config.js';
+
+@Injectable()
+export class RedisClient extends Redis implements OnModuleInit, OnModuleDestroy {
+	public constructor(config: RedisConfig) {
+		super({
+			host: config.host,
+			port: config.port,
+			db: config.database,
+			enableReadyCheck: true,
+			lazyConnect: true,
+		});
+	}
+
+	public async onModuleInit(): Promise<void> {
+		await this.connect();
+	}
+
+	public async onModuleDestroy(): Promise<void> {
+		await this.quit();
+	}
+}

package/src/redis.config.ts

@@ -0,0 +1,9 @@
+import zod from '@hg-ts/validation';
+
+export const REDIS_CONFIG_SCHEMA = zod.object({
+	host: zod.string().enforceEnv('REDIS_HOST'),
+	database: zod.number().int().min(0),
+	port: zod.number().positive().int(),
+});
+
+export class RedisConfig extends REDIS_CONFIG_SCHEMA.toClass() {}

package/src/redis.module.ts

@@ -0,0 +1,25 @@
+import { ConfigLoader } from '@hg-ts/config-loader';
+
+import {
+	Global,
+	Module,
+} from '@nestjs/common';
+
+import { RedisClient } from './redis.client.js';
+import { RedisConfig } from './redis.config.js';
+
+@Global()
+@Module({
+	providers: [
+		{
+			provide: RedisConfig,
+			async useFactory(configLoader: ConfigLoader): Promise<RedisConfig> {
+				return configLoader.load(RedisConfig, 'redis');
+			},
+			inject: [ConfigLoader],
+		},
+		RedisClient,
+	],
+	exports: [RedisClient, RedisConfig],
+})
+export class RedisModule {}

package/src/test-container/index.ts

@@ -0,0 +1 @@
+export * from './redis-testcontainer.module.js';

package/src/test-container/redis-testcontainer.module.ts

@@ -0,0 +1,12 @@
+import {
+	Global,
+	Module,
+} from '@nestjs/common';
+
+import { RedisModule } from '../redis.module.js';
+
+import { RedisTestContainerService } from './redis-testcontainer.service.js';
+
+@Global()
+@Module({ imports: [RedisModule], providers: [RedisTestContainerService] })
+export class RedisTestContainerModule {}

package/src/test-container/redis-testcontainer.service.ts

@@ -0,0 +1,62 @@
+import {
+	Inject,
+	OnModuleDestroy,
+	OnModuleInit,
+} from '@nestjs/common';
+
+import {
+	RedisContainer,
+	StartedRedisContainer,
+} from '@testcontainers/redis';
+
+import { RedisClient } from '../redis.client.js';
+import { RedisConfig } from '../redis.config.js';
+
+export class RedisTestContainerService implements OnModuleInit, OnModuleDestroy {
+	@Inject()
+	private readonly config: RedisConfig;
+
+	private container: StartedRedisContainer;
+
+	private initPromise: Nullable<Promise<void>> = null;
+
+	public constructor() {
+		this.enrichClient();
+	}
+
+	public async onModuleInit(): Promise<void> {
+		if (!this.initPromise) {
+			this.initPromise = this.startContainer();
+		}
+
+		return this.initPromise;
+	}
+
+	public async onModuleDestroy(): Promise<void> {
+		await this.stopContainer();
+	}
+
+	private async startContainer(): Promise<void> {
+		const container = new RedisContainer('redis')
+			.withReuse()
+			.withExposedPorts({ container: 6379, host: this.config.port });
+
+		this.container = await container.start();
+	}
+
+	private async stopContainer(): Promise<void> {
+		await this.container.stop();
+	}
+
+	private enrichClient(): void {
+		// eslint-disable-next-line @typescript/unbound-method
+		const originalInitHook = RedisClient.prototype.onModuleInit;
+		// eslint-disable-next-line @typescript/no-this-alias
+		const self = this;
+
+		RedisClient.prototype.onModuleInit = async function(this: OnModuleInit): Promise<void> {
+			await self.onModuleInit();
+			return originalInitHook.call(this);
+		};
+	}
+}