@trieb.work/nextjs-turbo-redis-cache 1.2.1 → 1.3.0

package/src/SyncedMap.ts

@@ -1,5 +1,6 @@
 // SyncedMap.ts
 import { Client, getTimeoutRedisCommandOptions } from './RedisStringsHandler';
+import { debugVerbose, debug } from './utils/debug';
 
 type CustomizedSync = {
   withoutRedisHashmap?: boolean;
@@ -169,18 +170,60 @@ export class SyncedMap<V> {
       }
     };
 
-    const keyEventHandler = async (_channel: string, message: string) => {
-      const key = message;
+    const keyEventHandler = async (key: string, message: string) => {
+      debug(
+        'yellow',
+        'SyncedMap.keyEventHandler() called with message',
+        this.redisKey,
+        message,
+        key,
+      );
+      // const key = message;
       if (key.startsWith(this.keyPrefix)) {
         const keyInMap = key.substring(this.keyPrefix.length);
         if (this.filterKeys(keyInMap)) {
+          debugVerbose(
+            'SyncedMap.keyEventHandler() key matches filter and will be deleted',
+            this.redisKey,
+            message,
+            key,
+          );
           await this.delete(keyInMap, true);
         }
+      } else {
+        debugVerbose(
+          'SyncedMap.keyEventHandler() key does not have prefix',
+          this.redisKey,
+          message,
+          key,
+        );
       }
     };
 
     try {
-      await this.subscriberClient.connect();
+      await this.subscriberClient.connect().catch(async () => {
+        await this.subscriberClient.connect();
+      });
+
+      // Check if keyspace event configuration is set correctly
+      const keyspaceEventConfig = (
+        await this.subscriberClient.configGet('notify-keyspace-events')
+      )?.['notify-keyspace-events'];
+      if (!keyspaceEventConfig.includes('E')) {
+        throw new Error(
+          "Keyspace event configuration has to include 'E' for Keyevent events, published with __keyevent@<db>__ prefix. We recommend to set it to 'Exe' like so `redis-cli -h localhost config set notify-keyspace-events Exe`",
+        );
+      }
+      if (
+        !keyspaceEventConfig.includes('A') &&
+        !(
+          keyspaceEventConfig.includes('x') && keyspaceEventConfig.includes('e')
+        )
+      ) {
+        throw new Error(
+          "Keyspace event configuration has to include 'A' or 'x' and 'e' for expired and evicted events. We recommend to set it to 'Exe' like so `redis-cli -h localhost config set notify-keyspace-events Exe`",
+        );
+      }
 
       await Promise.all([
         // We use a custom channel for insert/delete For the following reason:
@@ -188,7 +231,7 @@ export class SyncedMap<V> {
         // could get thousands of messages for one revalidateTag (For example revalidateTag("algolia") would send an enormous amount of network packages)
         // Also we can send the value in the message for insert
         this.subscriberClient.subscribe(this.syncChannel, syncHandler),
-        // Subscribe to Redis keyspace notifications for evicted and expired keys
+        // Subscribe to Redis keyevent notifications for evicted and expired keys
         this.subscriberClient.subscribe(
           `__keyevent@${this.database}__:evicted`,
           keyEventHandler,
@@ -224,10 +267,20 @@ export class SyncedMap<V> {
   }
 
   public get(key: string): V | undefined {
+    debugVerbose(
+      'SyncedMap.get() called with key',
+      key,
+      JSON.stringify(this.map.get(key))?.substring(0, 100),
+    );
     return this.map.get(key);
   }
 
   public async set(key: string, value: V): Promise<void> {
+    debugVerbose(
+      'SyncedMap.set() called with key',
+      key,
+      JSON.stringify(value)?.substring(0, 100),
+    );
     this.map.set(key, value);
     const operations = [];
 
@@ -258,10 +311,20 @@ export class SyncedMap<V> {
     await Promise.all(operations);
   }
 
+  // /api/revalidated-fetch
+  // true
+
   public async delete(
     keys: string[] | string,
     withoutSyncMessage = false,
   ): Promise<void> {
+    debugVerbose(
+      'SyncedMap.delete() called with keys',
+      this.redisKey,
+      keys,
+      withoutSyncMessage,
+    );
+
     const keysArray = Array.isArray(keys) ? keys : [keys];
     const operations = [];
 
@@ -285,7 +348,14 @@ export class SyncedMap<V> {
         this.client.publish(this.syncChannel, JSON.stringify(deletionMessage)),
       );
     }
+
     await Promise.all(operations);
+    debugVerbose(
+      'SyncedMap.delete() finished operations',
+      this.redisKey,
+      keys,
+      operations.length,
+    );
   }
 
   public has(key: string): boolean {

package/src/index.ts

@@ -1,2 +1,4 @@
-import CachedHandler from "./CachedHandler";
-export default CachedHandler;
+import CachedHandler from './CachedHandler';
+export default CachedHandler;
+import RedisStringsHandler from './RedisStringsHandler';
+export { RedisStringsHandler };

package/src/utils/debug.ts

@@ -0,0 +1,30 @@
+export function debug(
+  color:
+    | 'red'
+    | 'blue'
+    | 'green'
+    | 'yellow'
+    | 'cyan'
+    | 'white'
+    | 'none' = 'none',
+  ...args: unknown[]
+): void {
+  const colorCode = {
+    red: '\x1b[31m',
+    blue: '\x1b[34m',
+    green: '\x1b[32m',
+    yellow: '\x1b[33m',
+    cyan: '\x1b[36m',
+    white: '\x1b[37m',
+    none: '',
+  };
+  if (process.env.DEBUG_CACHE_HANDLER) {
+    console.log(colorCode[color], 'DEBUG CACHE HANDLER: ', ...args);
+  }
+}
+
+export function debugVerbose(color: string, ...args: unknown[]) {
+  if (process.env.DEBUG_CACHE_HANDLER_VERBOSE_VERBOSE) {
+    console.log('\x1b[35m', 'DEBUG SYNCED MAP: ', ...args);
+  }
+}

package/src/utils/json.ts

@@ -0,0 +1,26 @@
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+export function bufferReviver(_: string, value: any): any {
+  if (value && typeof value === 'object' && typeof value.$binary === 'string') {
+    return Buffer.from(value.$binary, 'base64');
+  }
+  return value;
+}
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+export function bufferReplacer(_: string, value: any): any {
+  if (Buffer.isBuffer(value)) {
+    return {
+      $binary: value.toString('base64'),
+    };
+  }
+  if (
+    value &&
+    typeof value === 'object' &&
+    value?.type === 'Buffer' &&
+    Array.isArray(value.data)
+  ) {
+    return {
+      $binary: Buffer.from(value.data).toString('base64'),
+    };
+  }
+  return value;
+}

package/test/integration/next-app/README.md

@@ -0,0 +1,36 @@
+This is a [Next.js](https://nextjs.org) project bootstrapped with [`create-next-app`](https://nextjs.org/docs/app/api-reference/cli/create-next-app).
+
+## Getting Started
+
+First, run the development server:
+
+```bash
+npm run dev
+# or
+yarn dev
+# or
+pnpm dev
+# or
+bun dev
+```
+
+Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
+
+You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file.
+
+This project uses [`next/font`](https://nextjs.org/docs/app/building-your-application/optimizing/fonts) to automatically optimize and load [Geist](https://vercel.com/font), a new font family for Vercel.
+
+## Learn More
+
+To learn more about Next.js, take a look at the following resources:
+
+- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
+- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
+
+You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js) - your feedback and contributions are welcome!
+
+## Deploy on Vercel
+
+The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.
+
+Check out our [Next.js deployment documentation](https://nextjs.org/docs/app/building-your-application/deploying) for more details.

package/test/integration/next-app/eslint.config.mjs

@@ -0,0 +1,16 @@
+import { dirname } from "path";
+import { fileURLToPath } from "url";
+import { FlatCompat } from "@eslint/eslintrc";
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = dirname(__filename);
+
+const compat = new FlatCompat({
+  baseDirectory: __dirname,
+});
+
+const eslintConfig = [
+  ...compat.extends("next/core-web-vitals", "next/typescript"),
+];
+
+export default eslintConfig;

package/test/integration/next-app/next.config.js

@@ -0,0 +1,6 @@
+/** @type {import('next').NextConfig} */
+const nextConfig = {
+  cacheHandler: require.resolve('@trieb.work/nextjs-turbo-redis-cache'),
+};
+
+module.exports = nextConfig;