strapi-cache 1.8.3 → 1.8.4

package/dist/server/index.js

@@ -5,7 +5,6 @@ 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);
@@ -544,7 +543,8 @@ const config = {
     autoPurgeCache: true,
     autoPurgeCacheOnStart: true,
     disableAdminPopups: false,
-    disableAdminButtons: false
+    disableAdminButtons: false,
+    redisScanDeleteCount: 100
   }),
   validator: (config2) => {
     if (typeof config2.debug !== "boolean") {
@@ -624,6 +624,9 @@ const config = {
     if (typeof config2.disableAdminButtons !== "boolean") {
       throw new Error(`Invalid config: disableAdminButtons must be a boolean`);
     }
+    if (typeof config2.redisScanDeleteCount !== "number") {
+      throw new Error(`Invalid config: redisScanDeleteCount must be a number`);
+    }
   }
 };
 const contentTypes = {};
@@ -856,34 +859,20 @@ class RedisCacheProvider {
         this.strapi.plugin("strapi-cache").config("cacheGetTimeoutInMs")
       );
       this.keyPrefix = this.strapi.plugin("strapi-cache").config("redisConfig")?.["keyPrefix"] ?? "";
-      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.redisScanDeleteCount = Number(
+        this.strapi.plugin("strapi-cache").config("redisScanDeleteCount")
+      );
+      if (redisClusterNodes.length) {
+        const redisClusterOptions = this.strapi.plugin("strapi-cache").config("redisClusterOptions");
+        if (!redisClusterOptions["redisOptions"]) {
+          redisClusterOptions.redisOptions = redisConfig;
         }
-        loggy.info("Valkey provider initialized");
+        this.client = new ioredis.Redis.Cluster(redisClusterNodes, redisClusterOptions);
       } else {
-        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.client = new ioredis.Redis(redisConfig);
       }
       this.initialized = true;
+      loggy.info(`${provider === "valkey" ? "Valkey" : "Redis"} provider initialized`);
     } catch (error) {
       loggy.error(error);
     }
@@ -931,18 +920,6 @@ class RedisCacheProvider {
       return null;
     }
   }
-  /**
-   * Deletes all given keys in Redis pipeline.
-   * @param keys to delete from cache
-   */
-  async delAll(keys) {
-    const pipeline = this.client.pipeline();
-    keys.forEach((key) => {
-      const relativeKey = key.slice(this.keyPrefix.length);
-      pipeline.del(relativeKey);
-    });
-    await pipeline.exec();
-  }
   async keys() {
     if (!this.ready) return null;
     try {
@@ -972,13 +949,37 @@ class RedisCacheProvider {
       return null;
     }
   }
+  async deleteBatch(client, batch, regExps) {
+    const toDelete = batch.filter((key) => regExps.some((re) => re.test(key)));
+    if (toDelete.length === 0) return;
+    const pipeline = client.pipeline();
+    for (const key of toDelete) {
+      const relativeKey = key.startsWith(this.keyPrefix) ? key.slice(this.keyPrefix.length) : key;
+      pipeline.del(relativeKey);
+    }
+    await pipeline.exec();
+  }
+  scanAndDelete(client, regExps) {
+    return new Promise((resolve, reject) => {
+      const stream = client.scanStream({ match: `${this.keyPrefix}*`, count: this.redisScanDeleteCount });
+      stream.on("data", (batch) => {
+        stream.pause();
+        this.deleteBatch(client, batch, regExps).then(() => stream.resume()).catch(reject);
+      });
+      stream.on("end", resolve);
+      stream.on("error", reject);
+    });
+  }
+  /**
+   * ScanStream keys and batch delete for Redis,
+   * iterates over master nodes in case of Cluster.
+   */
   async clearByRegexp(regExps) {
-    const keys = await this.keys();
-    if (!keys) {
-      return;
+    if (this.client instanceof ioredis.Redis) {
+      return this.scanAndDelete(this.client, regExps);
     }
-    const toDelete = keys.filter((key) => regExps.some((re) => re.test(key)));
-    await this.delAll(toDelete);
+    const nodes = this.client.nodes("master");
+    await Promise.all(nodes.map((node) => this.scanAndDelete(node, regExps)));
   }
 }
 const resolveCacheProvider = (strapi2) => {

package/dist/server/index.mjs

@@ -3,8 +3,7 @@ import Stream, { Readable } from "stream";
 import { createInflate, createBrotliDecompress, createGunzip } from "zlib";
 import rawBody from "raw-body";
 import { LRUCache } from "lru-cache";
-import { Redis as Redis$1 } from "ioredis";
-import { Cluster, Redis } from "iovalkey";
+import { Redis } from "ioredis";
 const loggy = {
   info: (msg) => {
     const shouldDebug = strapi.plugin("strapi-cache").config("debug") ?? false;
@@ -540,7 +539,8 @@ const config = {
     autoPurgeCache: true,
     autoPurgeCacheOnStart: true,
     disableAdminPopups: false,
-    disableAdminButtons: false
+    disableAdminButtons: false,
+    redisScanDeleteCount: 100
   }),
   validator: (config2) => {
     if (typeof config2.debug !== "boolean") {
@@ -620,6 +620,9 @@ const config = {
     if (typeof config2.disableAdminButtons !== "boolean") {
       throw new Error(`Invalid config: disableAdminButtons must be a boolean`);
     }
+    if (typeof config2.redisScanDeleteCount !== "number") {
+      throw new Error(`Invalid config: redisScanDeleteCount must be a number`);
+    }
   }
 };
 const contentTypes = {};
@@ -852,34 +855,20 @@ class RedisCacheProvider {
         this.strapi.plugin("strapi-cache").config("cacheGetTimeoutInMs")
       );
       this.keyPrefix = this.strapi.plugin("strapi-cache").config("redisConfig")?.["keyPrefix"] ?? "";
-      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.redisScanDeleteCount = Number(
+        this.strapi.plugin("strapi-cache").config("redisScanDeleteCount")
+      );
+      if (redisClusterNodes.length) {
+        const redisClusterOptions = this.strapi.plugin("strapi-cache").config("redisClusterOptions");
+        if (!redisClusterOptions["redisOptions"]) {
+          redisClusterOptions.redisOptions = redisConfig;
         }
-        loggy.info("Valkey provider initialized");
+        this.client = new Redis.Cluster(redisClusterNodes, redisClusterOptions);
       } else {
-        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.client = new Redis(redisConfig);
       }
       this.initialized = true;
+      loggy.info(`${provider === "valkey" ? "Valkey" : "Redis"} provider initialized`);
     } catch (error) {
       loggy.error(error);
     }
@@ -927,18 +916,6 @@ class RedisCacheProvider {
       return null;
     }
   }
-  /**
-   * Deletes all given keys in Redis pipeline.
-   * @param keys to delete from cache
-   */
-  async delAll(keys) {
-    const pipeline = this.client.pipeline();
-    keys.forEach((key) => {
-      const relativeKey = key.slice(this.keyPrefix.length);
-      pipeline.del(relativeKey);
-    });
-    await pipeline.exec();
-  }
   async keys() {
     if (!this.ready) return null;
     try {
@@ -968,13 +945,37 @@ class RedisCacheProvider {
       return null;
     }
   }
+  async deleteBatch(client, batch, regExps) {
+    const toDelete = batch.filter((key) => regExps.some((re) => re.test(key)));
+    if (toDelete.length === 0) return;
+    const pipeline = client.pipeline();
+    for (const key of toDelete) {
+      const relativeKey = key.startsWith(this.keyPrefix) ? key.slice(this.keyPrefix.length) : key;
+      pipeline.del(relativeKey);
+    }
+    await pipeline.exec();
+  }
+  scanAndDelete(client, regExps) {
+    return new Promise((resolve, reject) => {
+      const stream = client.scanStream({ match: `${this.keyPrefix}*`, count: this.redisScanDeleteCount });
+      stream.on("data", (batch) => {
+        stream.pause();
+        this.deleteBatch(client, batch, regExps).then(() => stream.resume()).catch(reject);
+      });
+      stream.on("end", resolve);
+      stream.on("error", reject);
+    });
+  }
+  /**
+   * ScanStream keys and batch delete for Redis,
+   * iterates over master nodes in case of Cluster.
+   */
   async clearByRegexp(regExps) {
-    const keys = await this.keys();
-    if (!keys) {
-      return;
+    if (this.client instanceof Redis) {
+      return this.scanAndDelete(this.client, regExps);
     }
-    const toDelete = keys.filter((key) => regExps.some((re) => re.test(key)));
-    await this.delAll(toDelete);
+    const nodes = this.client.nodes("master");
+    await Promise.all(nodes.map((node) => this.scanAndDelete(node, regExps)));
   }
 }
 const resolveCacheProvider = (strapi2) => {

package/dist/server/src/config/index.d.ts

@@ -22,6 +22,7 @@ declare const _default: {
         autoPurgeCacheOnStart: boolean;
         disableAdminPopups: boolean;
         disableAdminButtons: boolean;
+        redisScanDeleteCount: number;
     };
     validator: (config: any) => void;
 };

package/dist/server/src/index.d.ts

@@ -31,6 +31,7 @@ declare const _default: {
             autoPurgeCacheOnStart: boolean;
             disableAdminPopups: boolean;
             disableAdminButtons: boolean;
+            redisScanDeleteCount: number;
         };
         validator: (config: any) => void;
     };

package/dist/server/src/services/redis/provider.d.ts

@@ -6,18 +6,20 @@ export declare class RedisCacheProvider implements CacheProvider {
     private client;
     private cacheGetTimeoutInMs;
     private keyPrefix;
+    private redisScanDeleteCount;
     constructor(strapi: Core.Strapi);
     init(): void;
     get ready(): boolean;
     get(key: string): Promise<any | null>;
     set(key: string, val: any): Promise<any | null>;
     del(key: string): Promise<any | null>;
-    /**
-     * Deletes all given keys in Redis pipeline.
-     * @param keys to delete from cache
-     */
-    delAll(keys: string[]): Promise<void>;
     keys(): Promise<string[] | null>;
     reset(): Promise<any | null>;
+    private deleteBatch;
+    private scanAndDelete;
+    /**
+     * ScanStream keys and batch delete for Redis,
+     * iterates over master nodes in case of Cluster.
+     */
     clearByRegexp(regExps: RegExp[]): Promise<void>;
 }

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "1.8.3",
+  "version": "1.8.4",
   "keywords": [
     "strapi cache",
     "strapi rest cache",
@@ -42,7 +42,6 @@
     "@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"