Merge pull request #25 from trieb-work/allow-redis-client-settings

feat: add TLS/SSL support with Redis client configuration options

Author: tilman

README.md

@@ -132,6 +132,33 @@ A working example of above can be found in the `test/integration/next-app-custom
 | inMemoryCachingTime    | Time in milliseconds to cache Redis get results in memory. Set this to 0 to disable in-memory caching completely. | `10000`                                                                                                                                                       |
 | defaultStaleAge        | Default stale age in seconds for cached items                                                                     | `1209600` (14 days)                                                                                                                                           |
 | estimateExpireAge      | Function to calculate expire age (redis TTL value) from stale age                                                 | Production: `staleAge * 2`<br> Other: `staleAge * 1.2`                                                                                                        |
+| socketOptions          | Redis client socket options for TLS/SSL configuration (e.g., `{ tls: true, rejectUnauthorized: false }`)          | `undefined`                                                                                                                                                   |
+| clientOptions          | Additional Redis client options (e.g., username, password)                                                        | `undefined`                                                                                                                                                   |
+
+## TLS Configuration
+
+To connect to Redis using TLS/SSL (e.g., when using Redis over `rediss://` URLs), you can configure the socket options. Here's an example:
+
+```javascript
+const { RedisStringsHandler } = require('@trieb.work/nextjs-turbo-redis-cache');
+
+let cachedHandler;
+
+module.exports = class CustomizedCacheHandler {
+  constructor() {
+    if (!cachedHandler) {
+      cachedHandler = new RedisStringsHandler({
+        redisUrl: 'rediss://your-redis-host:6380', // Note the rediss:// protocol
+        socketOptions: {
+          tls: true,
+          rejectUnauthorized: false, // Only use this if you want to skip certificate validation
+        },
+      });
+    }
+  }
+  // ... rest of the handler implementation
+};
+```
 
 ## Consistency of Redis and this caching implementation
 

src/RedisStringsHandler.ts

@@ -1,4 +1,4 @@
-import { commandOptions, createClient } from 'redis';
+import { commandOptions, createClient, RedisClientOptions } from 'redis';
 import { SyncedMap } from './SyncedMap';
 import { DeduplicatedRequestHandler } from './DeduplicatedRequestHandler';
 import { debug } from './utils/debug';
@@ -60,6 +60,14 @@ export type CreateRedisStringsHandlerOptions = {
    * @default Production: staleAge * 2, Other: staleAge * 1.2
    */
   estimateExpireAge?: (staleAge: number) => number;
+  /** Additional Redis client socket options
+   * @example { tls: true, rejectUnauthorized: false }
+   */
+  socketOptions?: RedisClientOptions['socket'];
+  /** Additional Redis client options to be passed directly to createClient
+   * @example { username: 'user', password: 'pass' }
+   */
+  clientOptions?: Omit<RedisClientOptions, 'url' | 'database' | 'socket'>;
 };
 
 // Identifier prefix used by Next.js to mark automatically generated cache tags
@@ -113,6 +121,8 @@ export default class RedisStringsHandler {
     defaultStaleAge = 60 * 60 * 24 * 14,
     estimateExpireAge = (staleAge) =>
       process.env.VERCEL_ENV === 'production' ? staleAge * 2 : staleAge * 1.2,
+    socketOptions,
+    clientOptions,
   }: CreateRedisStringsHandlerOptions) {
     this.keyPrefix = keyPrefix;
     this.timeoutMs = timeoutMs;
@@ -122,9 +132,12 @@ export default class RedisStringsHandler {
     this.estimateExpireAge = estimateExpireAge;
 
     try {
+      // Create Redis client with properly typed configuration
       this.client = createClient({
-        ...(database !== 0 ? { database } : {}),
         url: redisUrl,
+        ...(database !== 0 ? { database } : {}),
+        ...(socketOptions ? { socket: socketOptions } : {}),
+        ...(clientOptions || {}),
       });
 
       this.client.on('error', (error) => {