Merge pull request #28 from trieb-work/feat-skip-keyspace-check

feat: option for disable keyspace config check for cloud envs

Author: tilman

README.md

@@ -48,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:

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([