strapi-cache 1.11.1 → 1.11.2

package/README.md

@@ -79,6 +79,7 @@ Full configuration example:
     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
+    redisScanDeleteCount: 100, // COUNT hint for SCAN when purging keys (Redis/Valkey only)
     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)
     cacheHeadersAllowList: ['content-type', 'content-security-policy'], // Headers to include in the cache (must be lowercase, if empty array, all headers are cached, cacheHeaders must be true)
@@ -139,7 +140,7 @@ All of these routes are protected by the policies `admin::isAuthenticatedAdmin`
 
 - **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**: When `autoPurgeCache` is enabled (default), relevant REST cache entries are invalidated on content create, update, or delete. When `autoPurgeGraphQL` is enabled, GraphQL cache is invalidated the same way (it is off unless you set it in config).
+- **Automatic Invalidation**: When `autoPurgeCache` is enabled (default), relevant REST cache entries are invalidated on content create, update, or delete. REST invalidation honors `excludeRoutes`, `cacheableEntities`, and `cacheableRoutes`, and runs in the background so content writes do not wait for cache scans to finish. When `autoPurgeGraphQL` is enabled, GraphQL cache is invalidated the same way (it is off unless you set it in config).
 - **`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` or predefined graphql route from graphql plugin config. You can customize which routes or entities to cache using `cacheableRoutes` or `cacheableEntities` config options.
 

package/dist/admin/src/components/PluginIcon.d.ts

@@ -1,2 +1,3 @@
-declare const PluginIcon: () => import("react/jsx-runtime").JSX.Element;
+/// <reference types="react" />
+declare const PluginIcon: () => import("react").JSX.Element;
 export { PluginIcon };

package/dist/admin/src/components/PurgeCacheButton/index.d.ts

@@ -1,2 +1,3 @@
-declare function PurgeCacheButton(): import("react/jsx-runtime").JSX.Element | null;
+/// <reference types="react" />
+declare function PurgeCacheButton(): import("react").JSX.Element | null;
 export default PurgeCacheButton;

package/dist/admin/src/components/PurgeEntityButton/index.d.ts

@@ -1,2 +1,3 @@
-declare function PurgeEntityButton(): import("react/jsx-runtime").JSX.Element | null;
+/// <reference types="react" />
+declare function PurgeEntityButton(): import("react").JSX.Element | null;
 export default PurgeEntityButton;

package/dist/admin/src/components/PurgeModal/index.d.ts

@@ -1,3 +1,4 @@
+/// <reference types="react" />
 export type PurgeProps = {
     buttonText: string;
     buttonWidth?: string;
@@ -6,5 +7,5 @@ export type PurgeProps = {
     isSettingsPage?: boolean;
     isPurgeAll?: boolean;
 };
-declare function PurgeModal({ buttonText, keyToUse, buttonWidth, contentTypeName, isSettingsPage, isPurgeAll, }: PurgeProps): import("react/jsx-runtime").JSX.Element | null;
+declare function PurgeModal({ buttonText, keyToUse, buttonWidth, contentTypeName, isSettingsPage, isPurgeAll, }: PurgeProps): import("react").JSX.Element | null;
 export default PurgeModal;

package/dist/admin/src/components/SettingsPage/index.d.ts

@@ -1,2 +1,3 @@
-declare const SettingsPage: () => import("react/jsx-runtime").JSX.Element;
+/// <reference types="react" />
+declare const SettingsPage: () => import("react").JSX.Element;
 export default SettingsPage;

package/dist/server/index.js

@@ -39,11 +39,8 @@ async function invalidateCache(event, cacheStore, strapi2) {
   const uid = model.uid;
   const restApiPrefix = strapi2.config.get("api.rest.prefix", "/api");
   const cacheableEntities = strapi2.plugin("strapi-cache").config("cacheableEntities");
-  const entityIsCacheable = cacheableEntities?.length ? cacheableEntities.includes(model.tableName) : true;
-  if (!entityIsCacheable) {
-    loggy.info(`Not invalidated. ${model.tableName} is not cacheable.`);
-    return;
-  }
+  const cacheableRoutes = strapi2.plugin("strapi-cache").config("cacheableRoutes") ?? [];
+  const excludeRoutes = strapi2.plugin("strapi-cache").config("excludeRoutes") ?? [];
   try {
     const contentType = strapi2.contentType(uid);
     if (!contentType || !contentType.kind) {
@@ -52,7 +49,20 @@ async function invalidateCache(event, cacheStore, strapi2) {
     }
     const pluralName = contentType.kind === "singleType" ? contentType.info.singularName : contentType.info.pluralName;
     const apiPath = `${restApiPrefix}/${pluralName}`;
-    const regex = new RegExp(`^.*:${apiPath}(/.*)?(\\?.*)?$`);
+    const entityNames = [
+      model.tableName,
+      contentType.info.singularName,
+      contentType.info.pluralName
+    ].filter(Boolean);
+    const entityIsCacheable = cacheableEntities?.length ? entityNames.some((name) => cacheableEntities.includes(name)) : void 0;
+    const routeIsExcluded = excludeRoutes.some((route) => apiPath.startsWith(route));
+    const routeIsCacheable = cacheableRoutes.some((route) => apiPath.startsWith(route)) || cacheableRoutes.length === 0 && apiPath.startsWith(restApiPrefix);
+    const isCacheable = !routeIsExcluded && (entityIsCacheable ?? routeIsCacheable);
+    if (!isCacheable) {
+      loggy.info(`Not invalidated. ${apiPath} is not cacheable.`);
+      return;
+    }
+    const regex = new RegExp(`^.*:${escapeRegex(apiPath)}(/.*)?(\\?.*)?$`);
     await cacheStore.clearByRegexp([regex]);
     loggy.info(`Invalidated cache for ${apiPath}`);
   } catch (error) {
@@ -104,6 +114,12 @@ const actions = [
     pluginName: "strapi-cache"
   }
 ];
+const runInBackground = (label, task) => {
+  void Promise.resolve().then(task).catch((error) => {
+    loggy.error(`${label} error:`);
+    loggy.error(error);
+  });
+};
 const bootstrap = ({ strapi: strapi2 }) => {
   loggy.info("Initializing");
   try {
@@ -119,27 +135,36 @@ const bootstrap = ({ strapi: strapi2 }) => {
     cacheStore.init();
     if (autoPurgeCache) {
       strapi2.db.lifecycles.subscribe({
-        async afterCreate(event) {
-          await invalidateCache(event, cacheStore, strapi2);
+        afterCreate(event) {
+          runInBackground("Cache invalidation", () => invalidateCache(event, cacheStore, strapi2));
         },
-        async afterUpdate(event) {
-          await invalidateCache(event, cacheStore, strapi2);
+        afterUpdate(event) {
+          runInBackground("Cache invalidation", () => invalidateCache(event, cacheStore, strapi2));
         },
-        async afterDelete(event) {
-          await invalidateCache(event, cacheStore, strapi2);
+        afterDelete(event) {
+          runInBackground("Cache invalidation", () => invalidateCache(event, cacheStore, strapi2));
         }
       });
     }
     if (autoPurgeGraphQL) {
       strapi2.db.lifecycles.subscribe({
-        async afterCreate(event) {
-          await invalidateGraphqlCache(event, cacheStore, strapi2);
+        afterCreate(event) {
+          runInBackground(
+            "GraphQL cache invalidation",
+            () => invalidateGraphqlCache(event, cacheStore, strapi2)
+          );
         },
-        async afterUpdate(event) {
-          await invalidateGraphqlCache(event, cacheStore, strapi2);
+        afterUpdate(event) {
+          runInBackground(
+            "GraphQL cache invalidation",
+            () => invalidateGraphqlCache(event, cacheStore, strapi2)
+          );
         },
-        async afterDelete(event) {
-          await invalidateGraphqlCache(event, cacheStore, strapi2);
+        afterDelete(event) {
+          runInBackground(
+            "GraphQL cache invalidation",
+            () => invalidateGraphqlCache(event, cacheStore, strapi2)
+          );
         }
       });
     }

package/dist/server/index.mjs

@@ -35,11 +35,8 @@ async function invalidateCache(event, cacheStore, strapi2) {
   const uid = model.uid;
   const restApiPrefix = strapi2.config.get("api.rest.prefix", "/api");
   const cacheableEntities = strapi2.plugin("strapi-cache").config("cacheableEntities");
-  const entityIsCacheable = cacheableEntities?.length ? cacheableEntities.includes(model.tableName) : true;
-  if (!entityIsCacheable) {
-    loggy.info(`Not invalidated. ${model.tableName} is not cacheable.`);
-    return;
-  }
+  const cacheableRoutes = strapi2.plugin("strapi-cache").config("cacheableRoutes") ?? [];
+  const excludeRoutes = strapi2.plugin("strapi-cache").config("excludeRoutes") ?? [];
   try {
     const contentType = strapi2.contentType(uid);
     if (!contentType || !contentType.kind) {
@@ -48,7 +45,20 @@ async function invalidateCache(event, cacheStore, strapi2) {
     }
     const pluralName = contentType.kind === "singleType" ? contentType.info.singularName : contentType.info.pluralName;
     const apiPath = `${restApiPrefix}/${pluralName}`;
-    const regex = new RegExp(`^.*:${apiPath}(/.*)?(\\?.*)?$`);
+    const entityNames = [
+      model.tableName,
+      contentType.info.singularName,
+      contentType.info.pluralName
+    ].filter(Boolean);
+    const entityIsCacheable = cacheableEntities?.length ? entityNames.some((name) => cacheableEntities.includes(name)) : void 0;
+    const routeIsExcluded = excludeRoutes.some((route) => apiPath.startsWith(route));
+    const routeIsCacheable = cacheableRoutes.some((route) => apiPath.startsWith(route)) || cacheableRoutes.length === 0 && apiPath.startsWith(restApiPrefix);
+    const isCacheable = !routeIsExcluded && (entityIsCacheable ?? routeIsCacheable);
+    if (!isCacheable) {
+      loggy.info(`Not invalidated. ${apiPath} is not cacheable.`);
+      return;
+    }
+    const regex = new RegExp(`^.*:${escapeRegex(apiPath)}(/.*)?(\\?.*)?$`);
     await cacheStore.clearByRegexp([regex]);
     loggy.info(`Invalidated cache for ${apiPath}`);
   } catch (error) {
@@ -100,6 +110,12 @@ const actions = [
     pluginName: "strapi-cache"
   }
 ];
+const runInBackground = (label, task) => {
+  void Promise.resolve().then(task).catch((error) => {
+    loggy.error(`${label} error:`);
+    loggy.error(error);
+  });
+};
 const bootstrap = ({ strapi: strapi2 }) => {
   loggy.info("Initializing");
   try {
@@ -115,27 +131,36 @@ const bootstrap = ({ strapi: strapi2 }) => {
     cacheStore.init();
     if (autoPurgeCache) {
       strapi2.db.lifecycles.subscribe({
-        async afterCreate(event) {
-          await invalidateCache(event, cacheStore, strapi2);
+        afterCreate(event) {
+          runInBackground("Cache invalidation", () => invalidateCache(event, cacheStore, strapi2));
         },
-        async afterUpdate(event) {
-          await invalidateCache(event, cacheStore, strapi2);
+        afterUpdate(event) {
+          runInBackground("Cache invalidation", () => invalidateCache(event, cacheStore, strapi2));
         },
-        async afterDelete(event) {
-          await invalidateCache(event, cacheStore, strapi2);
+        afterDelete(event) {
+          runInBackground("Cache invalidation", () => invalidateCache(event, cacheStore, strapi2));
         }
       });
     }
     if (autoPurgeGraphQL) {
       strapi2.db.lifecycles.subscribe({
-        async afterCreate(event) {
-          await invalidateGraphqlCache(event, cacheStore, strapi2);
+        afterCreate(event) {
+          runInBackground(
+            "GraphQL cache invalidation",
+            () => invalidateGraphqlCache(event, cacheStore, strapi2)
+          );
         },
-        async afterUpdate(event) {
-          await invalidateGraphqlCache(event, cacheStore, strapi2);
+        afterUpdate(event) {
+          runInBackground(
+            "GraphQL cache invalidation",
+            () => invalidateGraphqlCache(event, cacheStore, strapi2)
+          );
         },
-        async afterDelete(event) {
-          await invalidateGraphqlCache(event, cacheStore, strapi2);
+        afterDelete(event) {
+          runInBackground(
+            "GraphQL cache invalidation",
+            () => invalidateGraphqlCache(event, cacheStore, strapi2)
+          );
         }
       });
     }

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "1.11.1",
+  "version": "1.11.2",
   "keywords": [
     "strapi cache",
     "strapi rest cache",
@@ -39,8 +39,8 @@
     "test:all": "npm test -- --run && npm run test:integration"
   },
   "dependencies": {
-    "@strapi/design-system": "^2.0.1",
-    "@strapi/icons": "^2.0.1",
+    "@strapi/design-system": "2.2.1",
+    "@strapi/icons": "2.2.1",
     "ioredis": "^5.6.1",
     "lru-cache": "^11.1.0",
     "raw-body": "^3.0.0",
@@ -52,8 +52,8 @@
     "@strapi/typescript-utils": "^5.0.0",
     "@types/jest": "^30.0.0",
     "@types/koa": "^2.15.0",
-    "@types/react": "^19.1.0",
-    "@types/react-dom": "^19.1.1",
+    "@types/react": "^18.3.0",
+    "@types/react-dom": "^18.3.0",
     "@types/supertest": "^6.0.3",
     "better-sqlite3": "^12.6.2",
     "jest": "^30.2.0",