feat(redis): make lazyConnect optional in cache-redis plugin (#5963)

* feat(redis): make lazyConnect optional in cache-redis plugin * test: add tests to constructor * chore: add changeset * Update thin-pears-beam.md --------- Co-authored-by: Arda TANRIKULU <[email protected]>
ardatan · Sep 14, 2023 · 625e5d7 · 625e5d7
1 parent b895cb2
commit 625e5d7
Show file tree

Hide file tree

Showing 7 changed files with 46 additions and 6 deletions.
diff --git a/.changeset/thin-pears-beam.md b/.changeset/thin-pears-beam.md
@@ -0,0 +1,6 @@
+---
+'@graphql-mesh/cache-redis': patch
+'@graphql-mesh/types': patch
+---
+
+Add lazyConnect to cache-redis
diff --git a/packages/cache/redis/src/index.ts b/packages/cache/redis/src/index.ts
@@ -18,17 +18,19 @@ export default class RedisCache<V = string> implements KeyValueCache<V> {
   private client: Redis;
 
   constructor(options: YamlConfig.Cache['redis'] & { pubsub: MeshPubSub; logger: Logger }) {
+    const lazyConnect = options.lazyConnect !== false;
+
     if (options.url) {
       const redisUrl = new URL(interpolateStrWithEnv(options.url));
 
-      redisUrl.searchParams.set('lazyConnect', 'true');
-      redisUrl.searchParams.set('enableAutoPipelining', 'true');
-      redisUrl.searchParams.set('enableOfflineQueue', 'true');
-
       if (!['redis:', 'rediss:'].includes(redisUrl.protocol)) {
         throw new Error('Redis URL must use either redis:// or rediss://');
       }
 
+      redisUrl.searchParams.set('lazyConnect', lazyConnect.toString());
+      redisUrl.searchParams.set('enableAutoPipelining', 'true');
+      redisUrl.searchParams.set('enableOfflineQueue', 'true');
+
       options.logger.debug(`Connecting to Redis at ${redisUrl.toString()}`);
       this.client = new Redis(redisUrl?.toString());
     } else {
@@ -41,7 +43,7 @@ export default class RedisCache<V = string> implements KeyValueCache<V> {
           host: parsedHost,
           port: parseInt(parsedPort),
           password: parsedPassword,
-          lazyConnect: true,
+          lazyConnect,
           enableAutoPipelining: true,
           enableOfflineQueue: true,
         });

diff --git a/packages/cache/redis/test/cache.spec.ts b/packages/cache/redis/test/cache.spec.ts
@@ -25,6 +25,14 @@ describe('redis', () => {
       );
     });
 
+    it('passes configuration to redis client with default options, url and lazyConnect case', async () => {
+      new RedisCache({ url: 'redis://password@localhost:6379', lazyConnect: false, pubsub, logger });
+
+      expect(Redis).toHaveBeenCalledWith(
+        'redis://password@localhost:6379?lazyConnect=false&enableAutoPipelining=true&enableOfflineQueue=true',
+      );
+    });
+
     it('passes configuration to redis client with default options, host, port & password case', async () => {
       new RedisCache({ port: '6379', password: 'testpassword', host: 'localhost', pubsub, logger });
 
@@ -38,6 +46,19 @@ describe('redis', () => {
       });
     });
 
+    it('passes configuration to redis client with default options, host, port, password & lazyConnect case', async () => {
+      new RedisCache({ port: '6379', password: 'testpassword', host: 'localhost', lazyConnect: false, pubsub, logger });
+
+      expect(Redis).toHaveBeenCalledWith({
+        enableAutoPipelining: true,
+        enableOfflineQueue: true,
+        host: 'localhost',
+        lazyConnect: false,
+        password: 'testpassword',
+        port: 6379,
+      });
+    });
+
     it('prefers url over specific properties if both given', () => {
       new RedisCache({
         url: 'redis://localhost:6379',

diff --git a/packages/cache/redis/yaml-config.graphql b/packages/cache/redis/yaml-config.graphql
@@ -7,4 +7,10 @@ type RedisConfig @md {
   port: String
   password: String
   url: String
+  """
+  Flag to indicate lazyConnect value for Redis client.
+
+  @default: true
+  """
+  lazyConnect: Boolean
 }
diff --git a/packages/types/src/config-schema.json b/packages/types/src/config-schema.json
@@ -89,6 +89,9 @@
         },
         "url": {
           "type": "string"
+        },
+        "lazyConnect": {
+          "type": "boolean"
         }
       }
     },

diff --git a/packages/types/src/config.ts b/packages/types/src/config.ts
@@ -1712,6 +1712,7 @@ export interface RedisConfig {
   port?: string;
   password?: string;
   url?: string;
+  lazyConnect?: boolean;
 }
 export interface PubSubConfig {
   name: string;

diff --git a/website/src/generated-markdown/RedisConfig.generated.md b/website/src/generated-markdown/RedisConfig.generated.md
@@ -2,4 +2,5 @@
 * `host` (type: `String`)
 * `port` (type: `String`)
 * `password` (type: `String`)
-* `url` (type: `String`)
+* `url` (type: `String`)
+* `lazyConnect` (type: `Boolean`)