strapi-cache 1.9.0 → 1.10.0

package/README.md

@@ -72,6 +72,7 @@ Full configuration example:
     size: 1024 * 1024 * 1024, // Maximum size of the cache (1 GB) (only for memory cache)
     allowStale: false, // Allow stale cache items (only for memory cache)
     cacheableRoutes: ['/api/products', '/api/categories'], // Caches routes which start with these paths (if empty array, all '/api' routes are cached)
+    keyGenerator: (ctx) => `${ctx.request.method}:${ctx.request.url}`, // Optional custom cache key for REST requests; receives koa ctx
     // 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'], // 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', 'redis' or 'valkey')
@@ -109,6 +110,7 @@ Possible configuration keys are listed below; omitted keys keep the plugin defau
 | `size`                    | Approximate max total size in bytes (in-memory provider only)                                                                 | Positive integer (default: `10485760`, i.e. 10 MB)                                                                            |
 | `allowStale`              | Whether stale entries may be returned (in-memory provider only)                                                               | `true` or `false` (default: `false`)                                                                                          |
 | `cacheableRoutes`         | Only URLs starting with one of these paths are cached; if empty, every URL under the REST API prefix matches                  | Array of path prefix strings (default: `[]` meaning “all API routes”)                                                         |
+| `keyGenerator`            | Custom function to build REST cache keys; receives Koa `ctx`; when omitted, default key is `${method}:${url}`                 | Function `(ctx) => string` (default: unset)                                                                                   |
 | `cacheableEntities`       | If non-empty, only these API “entity” segments are cached; **when set, this drives eligibility instead of** `cacheableRoutes` | Array of strings (e.g. collection/table names), or omit / leave empty to use `cacheableRoutes`                                |
 | `excludeRoutes`           | URLs starting with any of these prefixes are **never** cached; evaluated before `cacheableRoutes` / entities                  | Array of path prefix strings (default: `[]`)                                                                                  |
 | `cacheHeaders`            | Store and replay response headers with the body                                                                               | `true` or `false` (default: `true`)                                                                                           |

package/dist/server/index.js

@@ -152,7 +152,13 @@ const bootstrap = ({ strapi: strapi2 }) => {
   loggy.info("Plugin initialized");
   strapi2.admin.services.permission.actionProvider.registerMany(actions);
 };
-const generateCacheKey = (context) => {
+const generateCacheKey = (context, keyGenerator) => {
+  if (typeof keyGenerator === "function") {
+    const customKey = keyGenerator(context);
+    if (typeof customKey === "string") {
+      return customKey;
+    }
+  }
   const { url } = context.request;
   const { method } = context.request;
   return `${method}:${url}`;
@@ -238,10 +244,11 @@ const middleware$1 = async (ctx, next) => {
   const cacheableEntities = strapi.plugin("strapi-cache").config("cacheableEntities");
   const cacheableRoutes = strapi.plugin("strapi-cache").config("cacheableRoutes");
   const excludeRoutes = strapi.plugin("strapi-cache").config("excludeRoutes");
+  const keyGenerator = strapi.plugin("strapi-cache").config("keyGenerator");
   const { cacheHeaders, cacheHeadersDenyList, cacheHeadersAllowList, cacheAuthorizedRequests } = getCacheHeaderConfig();
   const cacheStore = cacheService.getCacheInstance();
   const { url } = ctx.request;
-  const key = generateCacheKey(ctx);
+  const key = generateCacheKey(ctx, keyGenerator);
   const cacheEntry = await cacheStore.get(key);
   const cacheControlHeader = ctx.request.headers["cache-control"];
   const noCache = cacheControlHeader && cacheControlHeader.includes("no-cache");
@@ -533,6 +540,7 @@ const config = {
     size: 1024 * 1024 * 10,
     allowStale: false,
     cacheableRoutes: [],
+    keyGenerator: void 0,
     provider: "memory",
     excludeRoutes: [],
     redisConfig: env("REDIS_URL"),
@@ -568,6 +576,9 @@ const config = {
     if (!Array.isArray(config2.cacheableRoutes) || config2.cacheableRoutes.some((item) => typeof item !== "string")) {
       throw new Error(`Invalid config: cacheableRoutes must be an string array`);
     }
+    if (config2.keyGenerator !== void 0 && typeof config2.keyGenerator !== "function") {
+      throw new Error(`Invalid config: keyGenerator must be a function`);
+    }
     if (config2.cacheableEntities !== void 0 && (!Array.isArray(config2.cacheableEntities) || config2.cacheableEntities.some((item) => typeof item !== "string"))) {
       throw new Error(`Invalid config: cacheableEntities must be a string array`);
     }

package/dist/server/index.mjs

@@ -148,7 +148,13 @@ const bootstrap = ({ strapi: strapi2 }) => {
   loggy.info("Plugin initialized");
   strapi2.admin.services.permission.actionProvider.registerMany(actions);
 };
-const generateCacheKey = (context) => {
+const generateCacheKey = (context, keyGenerator) => {
+  if (typeof keyGenerator === "function") {
+    const customKey = keyGenerator(context);
+    if (typeof customKey === "string") {
+      return customKey;
+    }
+  }
   const { url } = context.request;
   const { method } = context.request;
   return `${method}:${url}`;
@@ -234,10 +240,11 @@ const middleware$1 = async (ctx, next) => {
   const cacheableEntities = strapi.plugin("strapi-cache").config("cacheableEntities");
   const cacheableRoutes = strapi.plugin("strapi-cache").config("cacheableRoutes");
   const excludeRoutes = strapi.plugin("strapi-cache").config("excludeRoutes");
+  const keyGenerator = strapi.plugin("strapi-cache").config("keyGenerator");
   const { cacheHeaders, cacheHeadersDenyList, cacheHeadersAllowList, cacheAuthorizedRequests } = getCacheHeaderConfig();
   const cacheStore = cacheService.getCacheInstance();
   const { url } = ctx.request;
-  const key = generateCacheKey(ctx);
+  const key = generateCacheKey(ctx, keyGenerator);
   const cacheEntry = await cacheStore.get(key);
   const cacheControlHeader = ctx.request.headers["cache-control"];
   const noCache = cacheControlHeader && cacheControlHeader.includes("no-cache");
@@ -529,6 +536,7 @@ const config = {
     size: 1024 * 1024 * 10,
     allowStale: false,
     cacheableRoutes: [],
+    keyGenerator: void 0,
     provider: "memory",
     excludeRoutes: [],
     redisConfig: env("REDIS_URL"),
@@ -564,6 +572,9 @@ const config = {
     if (!Array.isArray(config2.cacheableRoutes) || config2.cacheableRoutes.some((item) => typeof item !== "string")) {
       throw new Error(`Invalid config: cacheableRoutes must be an string array`);
     }
+    if (config2.keyGenerator !== void 0 && typeof config2.keyGenerator !== "function") {
+      throw new Error(`Invalid config: keyGenerator must be a function`);
+    }
     if (config2.cacheableEntities !== void 0 && (!Array.isArray(config2.cacheableEntities) || config2.cacheableEntities.some((item) => typeof item !== "string"))) {
       throw new Error(`Invalid config: cacheableEntities must be a string array`);
     }

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

@@ -8,6 +8,7 @@ declare const _default: {
         size: number;
         allowStale: boolean;
         cacheableRoutes: any[];
+        keyGenerator: any;
         provider: string;
         excludeRoutes: any[];
         redisConfig: any;

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

@@ -17,6 +17,7 @@ declare const _default: {
             size: number;
             allowStale: boolean;
             cacheableRoutes: any[];
+            keyGenerator: any;
             provider: string;
             excludeRoutes: any[];
             redisConfig: any;

package/dist/server/src/utils/key.d.ts

@@ -1,6 +1,7 @@
 import { Core } from '@strapi/strapi';
 import { Context } from 'koa';
-export declare const generateCacheKey: (context: Context) => string;
+export type CacheKeyGenerator = (context: Context) => string;
+export declare const generateCacheKey: (context: Context, keyGenerator?: CacheKeyGenerator) => string;
 export declare const generateGraphqlCacheKey: (payload: string, method?: 'GET' | 'POST', rootFields?: string[], strapi?: Core.Strapi) => string;
 export declare const escapeRegExp: (s: string) => string;
 export declare const generateEntityKey: (url: string, restApiPrefix: string) => string;

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "1.9.0",
+  "version": "1.10.0",
   "keywords": [
     "strapi cache",
     "strapi rest cache",
@@ -35,7 +35,7 @@
     "test:ts:front": "run -T tsc -p admin/tsconfig.json",
     "test:ts:back": "run -T tsc -p server/tsconfig.json",
     "test": "vitest run --exclude 'test/integration/**'",
-    "test:integration": "npm run build && rm -rf playground/.cache && mkdir -p playground/.yalc/strapi-cache && cp -r dist package.json LICENSE README.md playground/.yalc/strapi-cache/ && cd playground && npm install && npm run build && cd .. && NODE_ENV=test jest --config jest.integration.config.js --runInBand --forceExit --detectOpenHandles",
+    "test:integration": "npm run build && rm -rf playground/.cache playground/node_modules playground/.yalc && mkdir -p playground/.yalc/strapi-cache && cp -r dist package.json LICENSE README.md playground/.yalc/strapi-cache/ && node -e \"const fs=require('fs');const p='playground/.yalc/strapi-cache/package.json';const pkg=JSON.parse(fs.readFileSync(p,'utf8'));delete pkg.devDependencies;delete pkg.optionalDependencies;delete pkg.scripts;fs.writeFileSync(p,JSON.stringify(pkg,null,2));\" && cd playground && npm ci --ignore-scripts && npm rebuild better-sqlite3 @swc/core sharp --foreground-scripts && npm run build && cd .. && NODE_ENV=test jest --config jest.integration.config.js --runInBand --forceExit --detectOpenHandles",
     "test:all": "npm test -- --run && npm run test:integration"
   },
   "dependencies": {