Add Redis handlers to @neshca/cache-handler (caching-tools#137)

Author: better-salmon

.changeset/olive-zoos-itch.md

@@ -0,0 +1,5 @@
+---
+'@neshca/json-replacer-reviver': minor
+---
+
+Use `exports` instead of `main` and `module` in `package.json`

.changeset/proud-eagles-film.md

@@ -0,0 +1,9 @@
+---
+'@neshca/cache-handler': minor
+---
+
+Use `exports` instead of `main` and `module` in `package.json`
+
+New `handlers` API:
+
+-   Add `redis-stack` and `redis-strings` handlers;

.changeset/silent-humans-change.md

@@ -0,0 +1,5 @@
+---
+'cache-handler-docs': minor
+---
+
+Add docs for new `handlers` API

apps/cache-testing/cache-handler-redis-stack.js

@@ -1,18 +1,12 @@
 const { IncrementalCache } = require('@neshca/cache-handler');
+const { createHandler } = require('@neshca/cache-handler/redis-stack');
 const { createClient } = require('redis');
 
 if (!process.env.REDIS_URL) {
     console.warn('Make sure that REDIS_URL is added to the .env.local file and loaded properly.');
 }
 
-/** @type {import('@neshca/cache-handler').TagsManifest} */
-let localTagsManifest = {
-    version: 1,
-    items: {},
-};
-
 const PREFIX = 'JSON:';
-const TAGS_MANIFEST_KEY = `${PREFIX}sharedTagsManifest`;
 const CONNECT_TIMEOUT_MS = 5 * 50 * 1000;
 
 function createRedisClient(url) {
@@ -31,73 +25,27 @@ function createRedisClient(url) {
     return client;
 }
 
-async function connectAndSetManifest(client) {
+async function connect(client) {
     try {
         await client.connect();
     } catch (error) {
         console.error('Redis connection error:', error.message);
     }
-
-    try {
-        await client.json.set(TAGS_MANIFEST_KEY, '.', localTagsManifest, { NX: true });
-    } catch (error) {
-        console.error('Redis set tagsManifest error:', error.message);
-    }
 }
 
 if (process.env.SERVER_STARTED) {
     const client = createRedisClient(process.env.REDIS_URL);
 
-    connectAndSetManifest(client).then(() => {
+    connect(client).then(() => {
         console.log('Redis connected');
     });
 
-    IncrementalCache.onCreation(() => {
-        return {
-            cache: {
-                async get(key) {
-                    try {
-                        const value = (await client.json.get(PREFIX + key)) ?? null;
-
-                        if (value && value.kind === 'ROUTE' && value.body.type === 'Buffer') {
-                            value.body = Buffer.from(value.body);
-                        }
-
-                        return value;
-                    } catch (error) {
-                        return null;
-                    }
-                },
-                async set(key, value) {
-                    try {
-                        await client.json.set(PREFIX + key, '.', value);
-                    } catch (error) {
-                        // ignore because value will be written to disk
-                    }
-                },
-                async getTagsManifest() {
-                    try {
-                        const sharedTagsManifest = (await client.json.get(TAGS_MANIFEST_KEY)) ?? null;
-
-                        if (sharedTagsManifest) {
-                            localTagsManifest = sharedTagsManifest;
-                        }
-
-                        return sharedTagsManifest;
-                    } catch (error) {
-                        return localTagsManifest;
-                    }
-                },
-                async revalidateTag(tag, revalidatedAt) {
-                    try {
-                        await client.json.set(TAGS_MANIFEST_KEY, `.items.${tag}`, { revalidatedAt });
-                    } catch (error) {
-                        localTagsManifest.items[tag] = { revalidatedAt };
-                    }
-                },
-            },
-        };
-    });
+    IncrementalCache.onCreation(
+        createHandler({
+            client,
+            keyPrefix: PREFIX,
+        }),
+    );
 }
 
 module.exports = IncrementalCache;

apps/cache-testing/cache-handler-redis-strings.js

@@ -0,0 +1,51 @@
+const { IncrementalCache } = require('@neshca/cache-handler');
+const { createHandler } = require('@neshca/cache-handler/redis-strings');
+const { createClient } = require('redis');
+
+if (!process.env.REDIS_URL) {
+    console.warn('Make sure that REDIS_URL is added to the .env.local file and loaded properly.');
+}
+
+const PREFIX = 'string:';
+const CONNECT_TIMEOUT_MS = 5 * 50 * 1000;
+
+function createRedisClient(url) {
+    const client = createClient({
+        url,
+        name: `cache-handler:${PREFIX}${process.env.PORT ?? process.pid}`,
+        socket: {
+            connectTimeout: CONNECT_TIMEOUT_MS,
+        },
+    });
+
+    client.on('error', (error) => {
+        console.error('Redis error:', error.message);
+    });
+
+    return client;
+}
+
+async function connect(client) {
+    try {
+        await client.connect();
+    } catch (error) {
+        console.error('Redis connection error:', error.message);
+    }
+}
+
+if (process.env.SERVER_STARTED) {
+    const client = createRedisClient(process.env.REDIS_URL);
+
+    connect(client).then(() => {
+        console.log('Redis connected');
+    });
+
+    IncrementalCache.onCreation(
+        createHandler({
+            client,
+            keyPrefix: PREFIX,
+        }),
+    );
+}
+
+module.exports = IncrementalCache;

apps/cache-testing/cache-handler-redis.js

@@ -13,6 +13,9 @@ function wait(delay: number): Promise<void> {
 
 const args = process.argv.slice(2).reduce<Record<string, string>>((acc, arg) => {
     const [key, value] = arg.split('=');
+
+    if (!key || !value) throw new Error(`Invalid argument: ${arg}`);
+
     acc[key] = value;
     return acc;
 }, {});

apps/cache-testing/src/utils/run-app-instances.ts

@@ -7,11 +7,16 @@ const nextraConfig = {
 
 const withNextra = require('nextra')(nextraConfig);
 
+const basePath = process.env.NODE_ENV === 'development' ? undefined : '/next-shared-cache';
+
 /** @type {import('next').NextConfig} */
 const nextConfig = {
     output: 'export',
-    basePath: '/next-shared-cache',
+    basePath,
     images: { unoptimized: true },
+    env: {
+        NEXT_PUBLIC_BASE_URL: basePath ?? '',
+    },
 };
 
 module.exports = withNextra(nextConfig);

docs/cache-handler-docs/next.config.js

@@ -15,7 +15,9 @@
         "title": "Examples"
     },
     "redis-stack": "",
-    "redis": "",
+    "redis-strings": "",
+    "redis-stack-custom": "",
+    "redis-strings-custom": "",
     "-- More": {
         "type": "separator",
         "title": "More"