strapi-cache 1.8.1 → 1.8.2-rc.1

package/README.md

@@ -17,7 +17,7 @@ Boost your API performance with automatic in-memory or Redis caching for REST an
 - ♻️ **LRU (Least Recently Used) caching strategy**
 - 🔧 Simple integration with Strapi config
 - 📦 Lightweight with zero overhead
-- 🗄️ **Supports in-memory and Redis caching**
+- 🗄️ **Supports in-memory, Redis and Valkey caching**
 
 ---
 
@@ -52,9 +52,9 @@ In your Strapi project, navigate to `config/plugins.js` and add the following co
     cacheableRoutes: ['/api/products', '/api/categories'], // Caches routes which start with these paths (if empty array, all '/api' routes are cached)
     // cacheableEntities: ['products', 'categories'], // (Optional) Specify which entities to cache. When set, only these entities will be cached (ignores cacheableRoutes). If not set (undefined), cacheableRoutes logic is used
     excludeRoutes: ['/api/products/private'], // (NEW) Exclude routes which start with these paths from being cached (takes precedence over cacheableRoutes). **Note:** `excludeRoutes` takes precedence over `cacheableRoutes`.
-    provider: 'memory', // Cache provider ('memory' or 'redis')
-    redisConfig: env('REDIS_URL', 'redis://localhost:6379'), // Redis config takes either a string or an object see https://github.com/redis/ioredis for references to what object is available, the object or string is passed directly to ioredis client (if using Redis)
-    redisClusterNodes: [], // If provided any cluster node (this list is not empty), initialize ioredis redis cluster client. Each object must have keys 'host' and 'port'. See https://github.com/redis/ioredis for references
+    provider: 'memory', // Cache provider ('memory', 'redis' or 'valkey')
+    redisConfig: env('REDIS_URL', 'redis://localhost:6379'), // Redis/Valkey config: string or object. See https://github.com/redis/ioredis (Redis) or https://github.com/valkey-io/iovalkey (Valkey)
+    redisClusterNodes: [], // If provided any cluster node (this list is not empty), initialize cluster client. Each object must have keys 'host' and 'port'
     redisClusterOptions: {}, // Options for ioredis redis cluster client. redisOptions key is taken from redisConfig parameter above if not set here. See https://github.com/redis/ioredis for references
     cacheHeaders: true, // Plugin also stores response headers in the cache (set to false if you don't want to cache headers)
     cacheHeadersDenyList: ['access-control-allow-origin', 'content-encoding'], // Headers to exclude from the cache (must be lowercase, if empty array, no headers are excluded, cacheHeaders must be true)
@@ -83,8 +83,8 @@ All of these routes are protected by the policies `admin::isAuthenticatedAdmin`
 
 ## 🗂️ How It Works
 
-- **Storage**: The plugin keeps cached data in memory or Redis, depending on the configuration.
-- **Packages**: Uses [lru-cache](https://github.com/isaacs/node-lru-cache) for in-memory cache. Uses [ioredis](https://github.com/redis/ioredis) for Redis caching.
+- **Storage**: The plugin keeps cached data in memory, Redis or Valkey, depending on the configuration.
+- **Packages**: Uses [lru-cache](https://github.com/isaacs/node-lru-cache) for in-memory cache. Uses [ioredis](https://github.com/redis/ioredis) for Redis and [iovalkey](https://github.com/valkey-io/iovalkey) for Valkey caching.
 - **Automatic Invalidation**: Cache is cleared automatically when content is updated, deleted, or created. (GraphQL cache clears on any content update.)
 - **`no-cache` Header Support**: Respects the `no-cache` header, letting you skip the cache by setting `Cache-Control: no-cache` in your request.
 - **Default Cached Requests**: By default, caches all GET requests to `/api` (or whatever prefix you defined) and POST requests to `/graphql`. You can customize which routes or entities to cache using `cacheableRoutes` or `cacheableEntities` config options.

package/dist/server/index.js

@@ -5,6 +5,7 @@ const zlib = require("zlib");
 const rawBody = require("raw-body");
 const lruCache = require("lru-cache");
 const ioredis = require("ioredis");
+const iovalkey = require("iovalkey");
 const _interopDefault = (e) => e && e.__esModule ? e : { default: e };
 const Stream__default = /* @__PURE__ */ _interopDefault(Stream);
 const rawBody__default = /* @__PURE__ */ _interopDefault(rawBody);
@@ -567,16 +568,18 @@ const config = {
     if (typeof config2.provider !== "string") {
       throw new Error(`Invalid config: provider must be a string`);
     }
-    if (config2.provider !== "memory" && config2.provider !== "redis") {
-      throw new Error(`Invalid config: provider must be 'memory' or 'redis'`);
+    if (config2.provider !== "memory" && config2.provider !== "redis" && config2.provider !== "valkey") {
+      throw new Error(`Invalid config: provider must be 'memory', 'redis' or 'valkey'`);
     }
-    if (config2.provider === "redis") {
+    if (config2.provider === "redis" || config2.provider === "valkey") {
       if (!config2.redisConfig) {
-        throw new Error(`Invalid config: redisConfig must be set when using redis provider`);
+        throw new Error(
+          `Invalid config: redisConfig must be set when using redis or valkey provider`
+        );
       }
       if (typeof config2.redisConfig !== "string" && typeof config2.redisConfig !== "object") {
         throw new Error(
-          `Invalid config: redisConfig must be a string or object when using redis provider`
+          `Invalid config: redisConfig must be a string or object when using redis or valkey provider`
         );
       }
       if (!Array.isArray(config2.redisClusterNodes) || config2.redisClusterNodes.some((item) => !("host" in item && "port" in item))) {
@@ -840,23 +843,41 @@ class RedisCacheProvider {
       return;
     }
     try {
+      const provider = this.strapi.plugin("strapi-cache").config("provider") || "redis";
       const redisConfig = this.strapi.plugin("strapi-cache").config("redisConfig") || "redis://localhost:6379";
       const redisClusterNodes = this.strapi.plugin("strapi-cache").config("redisClusterNodes");
       this.cacheGetTimeoutInMs = Number(
         this.strapi.plugin("strapi-cache").config("cacheGetTimeoutInMs")
       );
       this.keyPrefix = this.strapi.plugin("strapi-cache").config("redisConfig")?.["keyPrefix"] ?? "";
-      if (redisClusterNodes.length) {
-        const redisClusterOptions = this.strapi.plugin("strapi-cache").config("redisClusterOptions");
-        if (!redisClusterOptions["redisOptions"]) {
-          redisClusterOptions.redisOptions = redisConfig;
+      if (provider === "valkey") {
+        if (redisClusterNodes.length) {
+          const redisClusterOptions = this.strapi.plugin("strapi-cache").config("redisClusterOptions") ?? {};
+          const clusterOptions = { ...redisClusterOptions };
+          if (!clusterOptions["redisOptions"]) {
+            clusterOptions["redisOptions"] = redisConfig;
+          }
+          this.client = new iovalkey.Cluster(
+            redisClusterNodes,
+            clusterOptions
+          );
+        } else {
+          this.client = new iovalkey.Redis(redisConfig);
         }
-        this.client = new ioredis.Redis.Cluster(redisClusterNodes, redisClusterOptions);
+        loggy.info("Valkey provider initialized");
       } else {
-        this.client = new ioredis.Redis(redisConfig);
+        if (redisClusterNodes.length) {
+          const redisClusterOptions = this.strapi.plugin("strapi-cache").config("redisClusterOptions");
+          if (!redisClusterOptions["redisOptions"]) {
+            redisClusterOptions.redisOptions = redisConfig;
+          }
+          this.client = new ioredis.Redis.Cluster(redisClusterNodes, redisClusterOptions);
+        } else {
+          this.client = new ioredis.Redis(redisConfig);
+        }
+        loggy.info("Redis provider initialized");
       }
       this.initialized = true;
-      loggy.info("Redis provider initialized");
     } catch (error) {
       loggy.error(error);
     }
@@ -960,6 +981,7 @@ const resolveCacheProvider = (strapi2) => {
   let instance;
   switch (providerType) {
     case "redis":
+    case "valkey":
       instance = new RedisCacheProvider(strapi2);
       break;
     default:

package/dist/server/index.mjs

@@ -3,7 +3,8 @@ import Stream, { Readable } from "stream";
 import { createInflate, createBrotliDecompress, createGunzip } from "zlib";
 import rawBody from "raw-body";
 import { LRUCache } from "lru-cache";
-import { Redis } from "ioredis";
+import { Redis as Redis$1 } from "ioredis";
+import { Cluster, Redis } from "iovalkey";
 const loggy = {
   info: (msg) => {
     const shouldDebug = strapi.plugin("strapi-cache").config("debug") ?? false;
@@ -563,16 +564,18 @@ const config = {
     if (typeof config2.provider !== "string") {
       throw new Error(`Invalid config: provider must be a string`);
     }
-    if (config2.provider !== "memory" && config2.provider !== "redis") {
-      throw new Error(`Invalid config: provider must be 'memory' or 'redis'`);
+    if (config2.provider !== "memory" && config2.provider !== "redis" && config2.provider !== "valkey") {
+      throw new Error(`Invalid config: provider must be 'memory', 'redis' or 'valkey'`);
     }
-    if (config2.provider === "redis") {
+    if (config2.provider === "redis" || config2.provider === "valkey") {
       if (!config2.redisConfig) {
-        throw new Error(`Invalid config: redisConfig must be set when using redis provider`);
+        throw new Error(
+          `Invalid config: redisConfig must be set when using redis or valkey provider`
+        );
       }
       if (typeof config2.redisConfig !== "string" && typeof config2.redisConfig !== "object") {
         throw new Error(
-          `Invalid config: redisConfig must be a string or object when using redis provider`
+          `Invalid config: redisConfig must be a string or object when using redis or valkey provider`
         );
       }
       if (!Array.isArray(config2.redisClusterNodes) || config2.redisClusterNodes.some((item) => !("host" in item && "port" in item))) {
@@ -836,23 +839,41 @@ class RedisCacheProvider {
       return;
     }
     try {
+      const provider = this.strapi.plugin("strapi-cache").config("provider") || "redis";
       const redisConfig = this.strapi.plugin("strapi-cache").config("redisConfig") || "redis://localhost:6379";
       const redisClusterNodes = this.strapi.plugin("strapi-cache").config("redisClusterNodes");
       this.cacheGetTimeoutInMs = Number(
         this.strapi.plugin("strapi-cache").config("cacheGetTimeoutInMs")
       );
       this.keyPrefix = this.strapi.plugin("strapi-cache").config("redisConfig")?.["keyPrefix"] ?? "";
-      if (redisClusterNodes.length) {
-        const redisClusterOptions = this.strapi.plugin("strapi-cache").config("redisClusterOptions");
-        if (!redisClusterOptions["redisOptions"]) {
-          redisClusterOptions.redisOptions = redisConfig;
+      if (provider === "valkey") {
+        if (redisClusterNodes.length) {
+          const redisClusterOptions = this.strapi.plugin("strapi-cache").config("redisClusterOptions") ?? {};
+          const clusterOptions = { ...redisClusterOptions };
+          if (!clusterOptions["redisOptions"]) {
+            clusterOptions["redisOptions"] = redisConfig;
+          }
+          this.client = new Cluster(
+            redisClusterNodes,
+            clusterOptions
+          );
+        } else {
+          this.client = new Redis(redisConfig);
         }
-        this.client = new Redis.Cluster(redisClusterNodes, redisClusterOptions);
+        loggy.info("Valkey provider initialized");
       } else {
-        this.client = new Redis(redisConfig);
+        if (redisClusterNodes.length) {
+          const redisClusterOptions = this.strapi.plugin("strapi-cache").config("redisClusterOptions");
+          if (!redisClusterOptions["redisOptions"]) {
+            redisClusterOptions.redisOptions = redisConfig;
+          }
+          this.client = new Redis$1.Cluster(redisClusterNodes, redisClusterOptions);
+        } else {
+          this.client = new Redis$1(redisConfig);
+        }
+        loggy.info("Redis provider initialized");
       }
       this.initialized = true;
-      loggy.info("Redis provider initialized");
     } catch (error) {
       loggy.error(error);
     }
@@ -956,6 +977,7 @@ const resolveCacheProvider = (strapi2) => {
   let instance;
   switch (providerType) {
     case "redis":
+    case "valkey":
       instance = new RedisCacheProvider(strapi2);
       break;
     default:

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "1.8.1",
+  "version": "1.8.2-rc.1",
   "keywords": [
     "strapi cache",
     "strapi rest cache",
@@ -42,6 +42,7 @@
     "@strapi/design-system": "^2.0.1",
     "@strapi/icons": "^2.0.1",
     "ioredis": "^5.6.1",
+    "iovalkey": "^0.3.3",
     "lru-cache": "^11.1.0",
     "raw-body": "^3.0.0",
     "react-intl": "^7.1.10"