Cleanup

Author: AyronK

README.md

@@ -121,22 +121,34 @@ const redisHandler = await createRedisHandler({
 });
 ```
 
----
-
-### `redis-cluster-strings`
-
-Same as `redis-strings` but for a Redis cluster using `createCluster`.
+#### Redis Cluster
 
 ```js
-import createRedisClusterHandler from "@fortedigital/nextjs-cache-handler/redis-cluster-strings";
+import { createCluster } from "@redis/client";
+import createRedisHandler from "@fortedigital/nextjs-cache-handler/redis-strings";
+import { withProxy } from "@fortedigital/nextjs-cache-handler/cluster/withProxy";
 
-const redisHandler = await createRedisClusterHandler({
-  client: createCluster({
+const { hostname: redisHostName } = new URL(process.env.REDIS_URL);
+redis = withProxy(
+  createCluster({
     rootNodes: [{ url: process.env.REDIS_URL }],
-  }),
-  keyPrefix: "myApp:",
-  sharedTagsKey: "myTags",
-  sharedTagsTtlKey: "myTagTtls",
+
+    // optional if you use TLS and need to resolve shards' ip to proper hostname
+    nodeAddressMap(address) {
+      const [_, port] = address.split(":");
+
+      return {
+        host: redisHostName,
+        port: Number(port),
+      };
+    },
+  })
+);
+
+// after using withProx you can use redis cluster instance as parameter for createRedisHandler
+const redisCacheHandler = createRedisHandler({
+  client: redis,
+  keyPrefix: CACHE_PREFIX,
 });
 ```
 

packages/nextjs-cache-handler/package-lock.json

@@ -18,7 +18,7 @@
     "next",
     "redis"
   ],
-  "version": "2.1.0-canary3",
+  "version": "2.1.0-canary4",
   "type": "module",
   "license": "MIT",
   "description": "Next.js cache handlers",
@@ -61,9 +61,6 @@
       "local-lru": [
         "dist/handlers/local-lru.d.ts"
       ],
-      "redis-cluster-strings": [
-        "dist/handlers/redis-cluster-strings.d.ts"
-      ],
       "cluster/withProxy": [
         "dist/helpers/redisClusterProxy.d.ts"
       ],

packages/nextjs-cache-handler/package.json

@@ -33,7 +33,7 @@ export default function createHandler({
   keyExpirationStrategy = "EXPIREAT",
   revalidateTagQuerySize = 10_000,
 }: CreateRedisStringsHandlerOptions<
-  RedisClientType | RedisClusterWithAbortSignal<RedisClusterType>
+  RedisClientType | RedisClusterWithAbortSignal
 >): Handler {
   function assertClientIsReady(): void {
     if (!client.isReady) {

packages/nextjs-cache-handler/src/handlers/redis-cluster-strings.ts

@@ -1,15 +1,15 @@
 import type { RedisClusterType } from "@redis/client";
 import { withAbortSignal } from "./withAbortSignal";
 
-export type RedisClusterWithAbortSignal<T extends RedisClusterType> = T & {
-  withAbortSignal(signal: AbortSignal): T;
+export type RedisClusterWithAbortSignal = RedisClusterType & {
+  withAbortSignal(signal: AbortSignal): RedisClusterType;
   isReady: boolean;
 };
 
 export function withProxy<T extends RedisClusterType>(
-  cluster: T,
+  cluster: RedisClusterType,
   defaultSignal?: AbortSignal,
-): RedisClusterWithAbortSignal<T> {
+): RedisClusterWithAbortSignal {
   let signal: AbortSignal | undefined = defaultSignal;
 
   const handler: ProxyHandler<T> = {
@@ -34,5 +34,5 @@ export function withProxy<T extends RedisClusterType>(
     },
   };
 
-  return new Proxy(cluster, handler) as RedisClusterWithAbortSignal<T>;
+  return new Proxy(cluster, handler) as RedisClusterWithAbortSignal;
 }