Feat/support redis client (#7)

selimyanat · web-flow · commit 572cd4bce7a2 · 2025-03-18T17:08:56.000+01:00
Implement a Redis cache for URLs
diff --git a/api/.env-dev b/api/.env-dev
@@ -1,5 +1,9 @@
-CACHE_PERSISTENCE= memory
 MACHINE_ID=1
 PORT = 3000
 # Perhpas we should only use a domain name here instead of a full URL (with the port as it is error prone)
-SHORTENED_BASE_URL = http://localhost:3000
+SHORTENED_BASE_URL = http://localhost:3000
+# redis | memory
+CACHE_PERSISTENCE= memory
+REDIS_URL = redis://localhost:6379
+# 10 minutes
+REDIS_TTL = 600
diff --git a/api/package.json b/api/package.json
@@ -26,6 +26,7 @@
     "@nestjs/platform-express": "10.0.0",
     "class-transformer": "0.5.1",
     "class-validator": "0.14.1",
+    "redis": "4.7.0",
     "reflect-metadata": "0.2.0",
     "rxjs": "7.8.1"
   },
diff --git a/api/src/infrastructure/repository/in-memory-url.repository.ts b/api/src/infrastructure/repository/in-memory-url.repository.ts
@@ -1,5 +1,5 @@
 import { ShortenUrlRepository } from '../../shorten-url/shorten-url.repository';
-import { Injectable } from '@nestjs/common';
+import { Injectable, Logger } from '@nestjs/common';
 
 @Injectable()
 export class InMemoryUrlRepository implements ShortenUrlRepository {
diff --git a/api/src/infrastructure/repository/redis-url.repository.ts b/api/src/infrastructure/repository/redis-url.repository.ts
@@ -1,17 +1,50 @@
 import { ShortenUrlRepository } from '../../shorten-url/shorten-url.repository';
-import { Injectable } from '@nestjs/common';
+import {
+  Injectable,
+  Logger,
+  OnModuleDestroy,
+  OnModuleInit,
+} from '@nestjs/common';
+import { createClient, RedisClientType } from 'redis';
+import { ConfigService } from '@nestjs/config';
 
 @Injectable()
-export class RedisUrlRepository implements ShortenUrlRepository {
-  private urls: Map<string, string> = new Map();
+export class RedisUrlRepository
+  implements ShortenUrlRepository, OnModuleInit, OnModuleDestroy
+{
+  private readonly DEFAULT_TTL = 100;
 
-  create(url: string, shortenedUrl: string): Promise<void> {
-    this.urls.set(url, shortenedUrl);
-    return Promise.resolve(undefined);
+  private redisClient: RedisClientType;
+
+  private redisTTL: number;
+
+  constructor(private readonly configService: ConfigService) {
+    const redisUrl = this.configService.get<string>('REDIS_URL');
+    this.redisClient = createClient({ url: redisUrl });
+    this.redisClient.on('error', (err) =>
+      Logger.error('Redis Client Error', err),
+    );
+    this.redisTTL = this.configService.get<number>(
+      'REDIS_TTL',
+      this.DEFAULT_TTL,
+    );
+  }
+
+  async create(url: string, shortenedUrl: string): Promise<void> {
+    await this.redisClient.set(url, shortenedUrl, { EX: this.redisTTL });
+  }
+
+  async findURL(url: string): Promise<string | null> {
+    return await this.redisClient.get(url);
+  }
+
+  async onModuleInit() {
+    await this.redisClient.connect();
+    Logger.debug('✅ Connected to Redis');
   }
 
-  findURL(url: string): Promise<string | null> {
-    const shortenedUrl = this.urls.get(url);
-    return Promise.resolve(shortenedUrl);
+  async onModuleDestroy() {
+    await this.redisClient.quit();
+    Logger.debug('🛑 Redis connection closed');
   }
 }
diff --git a/api/src/infrastructure/repository/repository.provider.ts b/api/src/infrastructure/repository/repository.provider.ts
@@ -2,6 +2,7 @@ import { ConfigService } from '@nestjs/config';
 import { Provider } from '@nestjs/common';
 import { InMemoryUrlRepository } from './in-memory-url.repository';
 import { ShortenUrlRepository } from '../../shorten-url/shorten-url.repository';
+import { RedisUrlRepository } from './redis-url.repository';
 
 /**
  * Factory provider to select the appropriate repository implementation based on configuration.
@@ -17,7 +18,7 @@ export const RepositoryProvider: Provider = {
     );
 
     if (persistenceType === 'redis') {
-      throw new Error('Redis persistence is not yet implemented');
+      return new RedisUrlRepository(configService);
     }
 
     return new InMemoryUrlRepository();
diff --git a/api/src/shorten-url/shorten-url.controller.ts b/api/src/shorten-url/shorten-url.controller.ts
@@ -11,9 +11,8 @@ export class ShortenUrlController {
     @Body() request: CreateShortenUrlDto,
   ): Promise<{ shortenedUrl: string }> {
     Logger.log(`Received url ${request.url} to shorten`);
-    const shortenedUrl = await this.shortenUrlUsecase.createTinyURL(
-      request.url,
-    );
+    // TODO perhaps it is worth converting the URL from string to URL object
+    const shortenedUrl = await this.shortenUrlUsecase.shortenUrl(request.url);
     return { shortenedUrl };
   }
 }
diff --git a/api/src/shorten-url/shorten-url.usecase.ts b/api/src/shorten-url/shorten-url.usecase.ts
@@ -26,7 +26,7 @@ export class ShortenUrlUsecase {
       this.configService.get<string>('SHORTENED_BASE_URL');
   }
 
-  async createTinyURL(originalURL: string): Promise<string> {
+  async shortenUrl(originalURL: string): Promise<string> {
     const existingShortenedUrl = await this.shortenUrlRepository.findURL(
       originalURL,
     );
diff --git a/api/yarn.lock b/api/yarn.lock
@@ -798,6 +798,40 @@
   resolved "https://registry.yarnpkg.com/@pkgr/core/-/core-0.1.1.tgz#1ec17e2edbec25c8306d424ecfbf13c7de1aaa31"
   integrity sha512-cq8o4cWH0ibXh9VGi5P20Tu9XF/0fFXl9EUinr9QfTM7a7p0oTA4iJRCQWppXR1Pg8dSM0UCItCkPwsk9qWWYA==
 
+"@redis/bloom@1.2.0":
+  version "1.2.0"
+  resolved "https://registry.yarnpkg.com/@redis/bloom/-/bloom-1.2.0.tgz#d3fd6d3c0af3ef92f26767b56414a370c7b63b71"
+  integrity sha512-HG2DFjYKbpNmVXsa0keLHp/3leGJz1mjh09f2RLGGLQZzSHpkmZWuwJbAvo3QcRY8p80m5+ZdXZdYOSBLlp7Cg==
+
+"@redis/client@1.6.0":
+  version "1.6.0"
+  resolved "https://registry.yarnpkg.com/@redis/client/-/client-1.6.0.tgz#dcf4ae1319763db6fdddd6de7f0af68a352c30ea"
+  integrity sha512-aR0uffYI700OEEH4gYnitAnv3vzVGXCFvYfdpu/CJKvk4pHfLPEy/JSZyrpQ+15WhXe1yJRXLtfQ84s4mEXnPg==
+  dependencies:
+    cluster-key-slot "1.1.2"
+    generic-pool "3.9.0"
+    yallist "4.0.0"
+
+"@redis/graph@1.1.1":
+  version "1.1.1"
+  resolved "https://registry.yarnpkg.com/@redis/graph/-/graph-1.1.1.tgz#8c10df2df7f7d02741866751764031a957a170ea"
+  integrity sha512-FEMTcTHZozZciLRl6GiiIB4zGm5z5F3F6a6FZCyrfxdKOhFlGkiAqlexWMBzCi4DcRoyiOsuLfW+cjlGWyExOw==
+
+"@redis/json@1.0.7":
+  version "1.0.7"
+  resolved "https://registry.yarnpkg.com/@redis/json/-/json-1.0.7.tgz#016257fcd933c4cbcb9c49cde8a0961375c6893b"
+  integrity sha512-6UyXfjVaTBTJtKNG4/9Z8PSpKE6XgSyEb8iwaqDcy+uKrd/DGYHTWkUdnQDyzm727V7p21WUMhsqz5oy65kPcQ==
+
+"@redis/search@1.2.0":
+  version "1.2.0"
+  resolved "https://registry.yarnpkg.com/@redis/search/-/search-1.2.0.tgz#50976fd3f31168f585666f7922dde111c74567b8"
+  integrity sha512-tYoDBbtqOVigEDMAcTGsRlMycIIjwMCgD8eR2t0NANeQmgK/lvxNAvYyb6bZDD4frHRhIHkJu2TBRvB0ERkOmw==
+
+"@redis/time-series@1.1.0":
+  version "1.1.0"
+  resolved "https://registry.yarnpkg.com/@redis/time-series/-/time-series-1.1.0.tgz#cba454c05ec201bd5547aaf55286d44682ac8eb5"
+  integrity sha512-c1Q99M5ljsIuc4YdaCwfUEXsofakb9c8+Zse2qxTadu8TalLXuAESzLvFAvNVbkmSlvlzIQOLpBCmWI9wTOt+g==
+
 "@sinclair/typebox@^0.27.8":
   version "0.27.8"
   resolved "https://registry.yarnpkg.com/@sinclair/typebox/-/typebox-0.27.8.tgz#6667fac16c436b5434a387a34dedb013198f6e6e"
@@ -1797,6 +1831,11 @@ clone@^1.0.2:
   resolved "https://registry.yarnpkg.com/clone/-/clone-1.0.4.tgz#da309cc263df15994c688ca902179ca3c7cd7c7e"
   integrity sha512-JQHZ2QMW6l3aH/j6xCqQThY/9OH4D/9ls34cgkUBiEeocRTU04tHfKPBsUK1PqZCUQM7GiA0IIXJSuXHI64Kbg==
 
+cluster-key-slot@1.1.2:
+  version "1.1.2"
+  resolved "https://registry.yarnpkg.com/cluster-key-slot/-/cluster-key-slot-1.1.2.tgz#88ddaa46906e303b5de30d3153b7d9fe0a0c19ac"
+  integrity sha512-RMr0FhtfXemyinomL4hrWcYJxmX6deFdCxpJzhDttxgO1+bcCnkk+9drydLVDmAMG7NE6aN/fl4F7ucU/90gAA==
+
 co@^4.6.0:
   version "4.6.0"
   resolved "https://registry.yarnpkg.com/co/-/co-4.6.0.tgz#6ea6bdf3d853ae54ccb8e47bfa0bf3f9031fb184"
@@ -2607,6 +2646,11 @@ functional-red-black-tree@^1.0.1:
   resolved "https://registry.yarnpkg.com/functional-red-black-tree/-/functional-red-black-tree-1.0.1.tgz#1b0ab3bd553b2a0d6399d29c0e3ea0b252078327"
   integrity sha512-dsKNQNdj6xA3T+QlADDA7mOSlX0qiMINjn0cgr+eGHGsbSHzTabcIogz2+p/iqP1Xs6EP/sS2SbqH+brGTbq0g==
 
+generic-pool@3.9.0:
+  version "3.9.0"
+  resolved "https://registry.yarnpkg.com/generic-pool/-/generic-pool-3.9.0.tgz#36f4a678e963f4fdb8707eab050823abc4e8f5e4"
+  integrity sha512-hymDOu5B53XvN4QT9dBmZxPX4CWhBPPLguTZ9MMFeFa/Kg0xWVfylOVNlJji/E7yTZWFd/q9GO5TxDLq156D7g==
+
 gensync@^1.0.0-beta.2:
   version "1.0.0-beta.2"
   resolved "https://registry.yarnpkg.com/gensync/-/gensync-1.0.0-beta.2.tgz#32a6ee76c3d7f52d46b2b1ae5d93fea8580a25e0"
@@ -4120,6 +4164,18 @@ readdirp@~3.6.0:
   dependencies:
     picomatch "^2.2.1"
 
+redis@4.7.0:
+  version "4.7.0"
+  resolved "https://registry.yarnpkg.com/redis/-/redis-4.7.0.tgz#b401787514d25dd0cfc22406d767937ba3be55d6"
+  integrity sha512-zvmkHEAdGMn+hMRXuMBtu4Vo5P6rHQjLoHftu+lBqq8ZTA3RCVC/WzD790bkKKiNFp7d5/9PcSD19fJyyRvOdQ==
+  dependencies:
+    "@redis/bloom" "1.2.0"
+    "@redis/client" "1.6.0"
+    "@redis/graph" "1.1.1"
+    "@redis/json" "1.0.7"
+    "@redis/search" "1.2.0"
+    "@redis/time-series" "1.1.0"
+
 reflect-metadata@0.2.0:
   version "0.2.0"
   resolved "https://registry.yarnpkg.com/reflect-metadata/-/reflect-metadata-0.2.0.tgz#e40299bf27422fe672b905468f34152a96efcaf7"
@@ -4985,6 +5041,11 @@ y18n@^5.0.5:
   resolved "https://registry.yarnpkg.com/y18n/-/y18n-5.0.8.tgz#7f4934d0f7ca8c56f95314939ddcd2dd91ce1d55"
   integrity sha512-0pfFzegeDWJHJIAmTLRP2DwHjdF5s7jo9tuztdQxAhINCdvS+3nGINqPd00AphqJR/0LhANUS6/+7SCb98YOfA==
 
+yallist@4.0.0:
+  version "4.0.0"
+  resolved "https://registry.yarnpkg.com/yallist/-/yallist-4.0.0.tgz#9bb92790d9c0effec63be73519e11a35019a3a72"
+  integrity sha512-3wdGidZyq5PB084XLES5TpOSRA3wjXAlIWMhum2kRcv/41Sn2emQ0dycQW4uZXLejwKvg6EsvbdlVL+FYEct7A==
+
 yallist@^3.0.2:
   version "3.1.1"
   resolved "https://registry.yarnpkg.com/yallist/-/yallist-3.1.1.tgz#dbb7daf9bfd8bac9ab45ebf602b8cbad0d5d08fd"
diff --git a/docker-compose.yml b/docker-compose.yml
@@ -0,0 +1,32 @@
+version: '3.8'
+
+services:
+  redis:
+    image: redis:7.2.7
+    container_name: redis
+    restart: always
+    ports:
+      - "6379:6379"
+    command: redis-server --save "" --appendonly no --maxmemory 100mb --maxmemory-policy allkeys-lru  # ✅ Disable disk persistence
+    volumes:
+      - redis_data:/data  # ✅ Ensures no persistence to disk
+    environment:
+      - ALLOW_EMPTY_PASSWORD=yes
+
+  redisinsight:
+    image: redis/redisinsight:2.66
+    container_name: redisinsight
+    restart: always
+    ports:
+      - "5540:5540"
+    depends_on:
+      - redis
+    environment:
+      - REDIS_URI=redis://redis:6379  # ✅ Connect RedisInsight to Redis automatically
+
+volumes:
+  redis_data:
+    driver: local
+    driver_opts:
+      type: tmpfs  # ✅ Store Redis data in memory only
+      device: tmpfs

Original file line number	Diff line number	Diff line change
`@@ -11,9 +11,8 @@ export class ShortenUrlController {`
`11`	`11`	`@Body() request: CreateShortenUrlDto,`
`12`	`12`	`): Promise<{ shortenedUrl: string }> {`
`13`	`13`	Logger.log(`Received url ${request.url} to shorten`);
`14`		`- const shortenedUrl = await this.shortenUrlUsecase.createTinyURL(`
`15`		`- request.url,`
`16`		`- );`
	`14`	`+ // TODO perhaps it is worth converting the URL from string to URL object`
	`15`	`+ const shortenedUrl = await this.shortenUrlUsecase.shortenUrl(request.url);`
`17`	`16`	`return { shortenedUrl };`
`18`	`17`	`}`
`19`	`18`	`}`
Original file line number	Diff line number	Diff line change
`@@ -26,7 +26,7 @@ export class ShortenUrlUsecase {`
`26`	`26`	`this.configService.get<string>('SHORTENED_BASE_URL');`
`27`	`27`	`}`
`28`	`28`
`29`		`- async createTinyURL(originalURL: string): Promise<string> {`
	`29`	`+ async shortenUrl(originalURL: string): Promise<string> {`
`30`	`30`	`const existingShortenedUrl = await this.shortenUrlRepository.findURL(`
`31`	`31`	`originalURL,`
`32`	`32`	`);`