Merge branch 'main' into allow-redis-client-settings

Author: tilman

CHANGELOG.md

@@ -1,3 +1,10 @@
+## [1.5.1](https://github.com/trieb-work/nextjs-turbo-redis-cache/compare/v1.5.0...v1.5.1) (2025-05-23)
+
+
+### Bug Fixes
+
+* Update package.json ([63e6ffd](https://github.com/trieb-work/nextjs-turbo-redis-cache/commit/63e6ffdc21032cfb1c5ecb507276fd832ee8252a))
+
 # [1.5.0](https://github.com/trieb-work/nextjs-turbo-redis-cache/compare/v1.4.0...v1.5.0) (2025-05-16)
 
 

README.md

@@ -3,7 +3,7 @@
 [![npm version](https://img.shields.io/npm/v/@trieb.work/nextjs-turbo-redis-cache.svg)](https://www.npmjs.com/package/@trieb.work/nextjs-turbo-redis-cache)
 ![Turbo redis cache image](https://github.com/user-attachments/assets/98e0dfd9-f38a-42ad-a355-9843740cc2d6)
 
-The ultimate Redis caching solution for Next.js. Built for production-ready, large-scale projects, it delivers unparalleled performance and efficiency with features tailored for high-traffic applications. This package has been created after extensibly testing the @neshca package and finding several major issues with it.
+The ultimate Redis caching solution for Next.js 15 and the app router. Built for production-ready, large-scale projects, it delivers unparalleled performance and efficiency with features tailored for high-traffic applications. This package has been created after extensibly testing the @neshca package and finding several major issues with it.
 
 Key Features:
 
@@ -13,6 +13,8 @@ Key Features:
 - _Efficient Tag Management_: in-memory tags map for lightning-fast revalidate operations with minimal Redis overhead.
 - _Intelligent Key-Space Notifications_: Automatic update of in-memory tags map for expired or evicted keys.
 
+This library offers you an easy and high performant caching solution for docker, Kubernetes or Google Cloud Run deployments of Next.js.
+
 ## Compatibility
 
 This package is compatible with Next.js 15.0.3 and above while using App Router. It is not compatible with Next.js 14.x. or 15-canary or if you are using Pages Router.
@@ -46,6 +48,8 @@ REDISHOST and REDISPORT environment variables are required.
 VERCEL_URL, VERCEL_ENV are optional. VERCEL_URL is used to create a key prefix for the redis keys. VERCEL_ENV is used to determine the database to use. Only VERCEL_ENV=production will show up in DB 0 (redis default db). All other values of VERCEL_ENV will use DB 1, use `redis-cli -n 1` to connect to different DB 1. This is another protection feature to avoid that different environments (e.g. staging and production) will overwrite each other.
 Furthermore there exists the DEBUG_CACHE_HANDLER environment variable to enable debug logging of the caching handler once it is set to true.
 
+There exists also the SKIP_KEYSPACE_CONFIG_CHECK environment variable to skip the check for the keyspace configuration. This is useful if you are using redis in a cloud environment that forbids access to config commands. If you set SKIP_KEYSPACE_CONFIG_CHECK=true the check will be skipped and the keyspace configuration will be assumed to be correct (e.g. notify-keyspace-events Exe).
+
 ### Option A: minimum implementation with default options
 
 extend `next.config.js` with:
@@ -117,7 +121,7 @@ A working example of above can be found in the `test/integration/next-app-custom
 
 | Option                 | Description                                                                                                       | Default Value                                                                                                                                                 |
 | ---------------------- | ----------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| redis_url              | Redis connection url                                                                                              | `process.env.REDIS_URL? process.env.REDIS_URL : process.env.REDISHOST ? redis://${process.env.REDISHOST}:${process.env.REDISPORT} : 'redis://localhost:6379'` |
+| redisUrl               | Redis connection url                                                                                              | `process.env.REDIS_URL? process.env.REDIS_URL : process.env.REDISHOST ? redis://${process.env.REDISHOST}:${process.env.REDISPORT} : 'redis://localhost:6379'` |
 | database               | Redis database number to use. Uses DB 0 for production, DB 1 otherwise                                            | `process.env.VERCEL_ENV === 'production' ? 0 : 1`                                                                                                             |
 | keyPrefix              | Prefix added to all Redis keys                                                                                    | `process.env.VERCEL_URL    \|\| 'UNDEFINED_URL_'`                                                                                                             |
 | sharedTagsKey          | Key used to store shared tags hash map in Redis                                                                   | `'__sharedTags__'`                                                                                                                                            |
@@ -197,28 +201,26 @@ By accepting and tolerating this eventual consistency, the performance of the ca
 
 ## Testing
 
-Run `pnpm run-dev-server` to start the nextjs integration test project.
-
-To run all tests you can use the following command in a second terminal:
+To run all tests you can use the following command:
 
 ```bash
-pnpm test
+pnpm build && pnpm test
 ```
 
 ### Unit tests
 
 To run unit tests you can use the following command:
 
 ```bash
-pnpm test:unit
+pnpm build && pnpm test:unit
 ```
 
 ### Integration tests
 
 To run integration tests you can use the following command:
 
 ```bash
-pnpm test:integration
+pnpm build && pnpm test:integration
 ```
 
 The integration tests will start a Next.js server and test the caching handler. You can modify testing behavior by setting the following environment variables:

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@trieb.work/nextjs-turbo-redis-cache",
-  "version": "1.5.0",
+  "version": "1.5.1",
   "repository": {
     "type": "git",
     "url": "https://github.com/trieb-work/nextjs-turbo-redis-cache.git"
@@ -51,7 +51,7 @@
   ],
   "author": "Designed for speed, scalability, and optimized performance, nextjs-turbo-redis-cache is your go-to solution for Next.js caching in demanding production environments.",
   "license": "ISC",
-  "description": "",
+  "description": "Next.js redis cache handler",
   "publishConfig": {
     "access": "public"
   },

src/RedisStringsHandler.ts

@@ -14,12 +14,12 @@ export type CacheEntry = {
 };
 
 export type CreateRedisStringsHandlerOptions = {
-  /** Redis redis_url to use.
+  /** Redis redisUrl to use.
    * @default process.env.REDIS_URL? process.env.REDIS_URL : process.env.REDISHOST
           ? `redis://${process.env.REDISHOST}:${process.env.REDISPORT}`
           : 'redis://localhost:6379'
    */
-  redis_url?: string;
+  redisUrl?: string;
   /** Redis database number to use. Uses DB 0 for production, DB 1 otherwise
    * @default process.env.VERCEL_ENV === 'production' ? 0 : 1
    */
@@ -105,7 +105,7 @@ export default class RedisStringsHandler {
   private estimateExpireAge: (staleAge: number) => number;
 
   constructor({
-    redis_url = process.env.REDIS_URL
+    redisUrl = process.env.REDIS_URL
       ? process.env.REDIS_URL
       : process.env.REDISHOST
         ? `redis://${process.env.REDISHOST}:${process.env.REDISPORT}`
@@ -134,8 +134,8 @@ export default class RedisStringsHandler {
     try {
       // Create Redis client with properly typed configuration
       this.client = createClient({
+        url: redisUrl,
         ...(database !== 0 ? { database } : {}),
-        url: redis_url,
         ...(socketOptions ? { socket: socketOptions } : {}),
         ...(clientOptions || {}),
       });

src/SyncedMap.ts

@@ -206,23 +206,28 @@ export class SyncedMap<V> {
       });
 
       // 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')
-        )
+        (process.env.SKIP_KEYSPACE_CONFIG_CHECK || '').toUpperCase() !== 'TRUE'
       ) {
-        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`",
-        );
+        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([