- Notifications
You must be signed in to change notification settings - Fork27
🔌 A cache middleware forhttps://strapi.io
License
patrixr/strapi-middleware-cache
Folders and files
| Name | Name | Last commit message | Last commit date | |
|---|---|---|---|---|
Repository files navigation
A cache middleware for the headless CMS strapi.io
THIS PROJECT IS DEPRECATED
Since the release of Strapi v4, this project has been parked in favor of the newStrapi Plugin Rest Cache which was forked from this repository. Maintainers have now moved there, and we recommend you switch to the new and improved plugin.A big thank you to all those that contributed to this middleware, it has served many.
Strapi V4 users:https://strapi-community.github.io/strapi-plugin-rest-cache/
- Strapi LRU Caching middleware - Legacy
This middleware caches incomingGET requests on the strapi API, based on query params and model ID.The cache is automatically busted everytime aPUT,PATCH,POST, orDELETE request comes in.
Supported storage engines
- Memory(default)
- Redis
Important: Caching must be explicitely enabledper model
Using npm
npm install --save strapi-middleware-cache
Using yarn
yarn add strapi-middleware-cache
Since2.0.1:
- strapi
3.4.0 - node
14
See1.5.0 for strapi <3.4.0
For Strapi stable versions, add amiddleware.js file within your config folder
e.g
touch config/middleware.js
To use different settings per environment, see theStrapi docs for environments.
You can parse environment variables for the config here as well if you wish to, please see theStrapi docs for environment variables.
Enable the cache middleware by adding the following snippet to an empty middleware file or simply add in the settings from the below example:
module.exports=({ env})=>({settings:{cache:{enabled:true,},},});
Starting the CMS should now log the following
$ strapi develop[2021-02-26T07:03:18.981Z] info [cache] Mounting LRU cache middleware[2021-02-26T07:03:18.982Z] info [cache] Storage engine: memThe middleware will only cache models which have been explicitely enabled.Add a list of models to enable to the module's configuration object.
e.g
// config/middleware.jsmodule.exports=({ env})=>({settings:{cache:{enabled:true,models:['review'],},},});
Starting the CMS should now log the following
$ strapi develop[2021-02-26T07:03:18.981Z] info [cache] Mounting LRU cache middleware[2021-02-26T07:03:18.982Z] info [cache] Storage engine: mem[2021-02-26T07:03:18.985Z] debug [cache] Register review routes middlewares[2021-02-26T07:03:18.986Z] debug [cache] POST /reviews purge[2021-02-26T07:03:18.987Z] debug [cache] DELETE /reviews/:id purge[2021-02-26T07:03:18.987Z] debug [cache] PUT /reviews/:id purge[2021-02-26T07:03:18.987Z] debug [cache] GET /reviews recv maxAge=3600000[2021-02-26T07:03:18.988Z] debug [cache] GET /reviews/:id recv maxAge=3600000[2021-02-26T07:03:18.988Z] debug [cache] GET /reviews/count recv maxAge=3600000The module's configuration object supports the following properties
// config/middleware.js/** *@typedef {import('strapi-middleware-cache').UserMiddlewareCacheConfig} UserMiddlewareCacheConfig */module.exports=({ env})=>({settings:{/** *@type {UserMiddlewareCacheConfig} */cache:{enabled:true,type:'redis',models:['review'],redisConfig:{sentinels:[{host:'192.168.10.41',port:26379},{host:'192.168.10.42',port:26379},{host:'192.168.10.43',port:26379},],name:'redis-primary',},},},});
// config/middleware.js/** *@typedef {import('strapi-middleware-cache').UserMiddlewareCacheConfig} UserMiddlewareCacheConfig */module.exports=({ env})=>({settings:{/** *@type {UserMiddlewareCacheConfig} */cache:{enabled:true,type:'redis',models:['review'],redisConfig:{cluster:[{host:'192.168.10.41',port:6379},{host:'192.168.10.42',port:6379},{host:'192.168.10.43',port:6379},],},},},});
Running the CMS will output the following
$ strapi develop[2021-02-26T07:03:18.981Z] info [cache] Mounting LRU cache middleware[2021-02-26T07:03:18.982Z] info [cache] Storage engine: mem[2021-02-26T07:03:18.985Z] debug [cache] Register review routes middlewares[2021-02-26T07:03:18.986Z] debug [cache] POST /reviews purge[2021-02-26T07:03:18.987Z] debug [cache] DELETE /reviews/:id purge[2021-02-26T07:03:18.987Z] debug [cache] PUT /reviews/:id purge[2021-02-26T07:03:18.987Z] debug [cache] GET /reviews recv maxAge=3600000[2021-02-26T07:03:18.988Z] debug [cache] GET /reviews/:id recv maxAge=3600000[2021-02-26T07:03:18.988Z] debug [cache] GET /reviews/count recv maxAge=3600000Each route can hold its own configuration object for more granular control. This can be done simplyby replacing the model strings in the list by object.
On which you can set:
- Its own custom
maxAge - Headers to include in the cache-key (e.g the body may differ depending on the language requested)
e.g
// config/middleware.js/** *@typedef {import('strapi-middleware-cache').UserModelCacheConfig} UserModelCacheConfig */module.exports=({ env})=>({settings:{cache:{enabled:true,type:'redis',maxAge:3600000,models:[/** *@type {UserModelCacheConfig} */{model:'reviews',headers:['accept-language']maxAge:1000000,routes:['/reviews/:slug','/reviews/:id/custom-route',{path:'/reviews/:slug',method:'DELETE'},]},]}}});
Running the CMS should now show the following
$ strapi develop[2021-02-26T07:03:18.981Z] info [cache] Mounting LRU cache middleware[2021-02-26T07:03:18.982Z] info [cache] Storage engine: mem[2021-02-26T07:03:18.985Z] debug [cache] Register review routes middlewares[2021-02-26T07:03:18.986Z] debug [cache] POST /reviews purge[2021-02-26T07:03:18.987Z] debug [cache] DELETE /reviews/:id purge[2021-02-26T07:03:18.987Z] debug [cache] PUT /reviews/:id purge[2021-02-26T07:03:18.987Z] debug [cache] GET /reviews recv maxAge=1000000 vary=accept-language[2021-02-26T07:03:18.988Z] debug [cache] GET /reviews/:id recv maxAge=1000000 vary=accept-language[2021-02-26T07:03:18.988Z] debug [cache] GET /reviews/count recv maxAge=1000000 vary=accept-language[2021-02-26T07:03:18.990Z] debug [cache] GET /reviews/:slug maxAge=1000000 vary=accept-language[2021-02-26T07:03:18.990Z] debug [cache] GET /reviews/:id/custom-route maxAge=1000000 vary=accept-language[2021-02-26T07:03:18.990Z] debug [cache] DELETE /reviews/:slug purgeBy default, the middleware assumes that the specified models are collections. Meaning that having'post' or'posts' in your configuration will result in the/posts/* being cached. Pluralization is applied in order to match the Strapi generated endpoints.
That behaviour is however not desired forsingle types such ashomepage which should remain singular in the endpoint (/homepage)
You can mark a specific model as being a single type by using thesingleType boolean field on model configurations
e.g
// config/middleware.jsmodule.exports=({ env})=>({settings:{cache:{enabled:true,models:[{model:'footer',singleType:true,},],},},});
Running the CMS should now show the following
$ strapi develop[2021-02-26T07:03:18.981Z] info [cache] Mounting LRU cache middleware[2021-02-26T07:03:18.982Z] info [cache] Storage engine: mem[2021-02-26T07:03:18.985Z] debug [cache] Register review routes middlewares[2021-02-26T07:03:18.986Z] debug [cache] PUT /footer purge[2021-02-26T07:03:18.987Z] debug [cache] DELETE /footer purge[2021-02-26T07:03:18.987Z] debug [cache] GET /review recv maxAge=3600000By default, cache is not looked up ifAuthorization orCookie header are present.To dissable this behaviour addhitpass: false to the model cache configuration
You can customize event further with a functionhitpass: (ctx) => true wherectx is the koa context of the request. Keep in mind that this function is executed before everyrecv requests.
e.g
// config/middleware.jsmodule.exports=({ env})=>({settings:{cache:{enabled:true,models:[{model:'footer',hitpass:false,singleType:true,},],},},});
By setting theenableEtagSupport totrue, the middleware will automatically create an Etag for each payload it caches.
Further requests sent with theIf-None-Match header will be returned a304 Not Modified status if the content for that url has not changed.
By setting theclearRelatedCache totrue, the middleware will inspect the Strapi models before a cache clearing operation to locate models that have relations with the queried model so that their cache is also cleared (this clears the whole cache for the related models). The inspection is performed by looking for direct relations between models and also by doing a deep dive in components, looking for relations to the queried model there too.
By setting thewithKoaContext configuration totrue, the middleware will extend the Koa Context with an entry point which can be used to clear the cache from within controllers
// config/middleware.jsmodule.exports=({ env})=>({settings:{cache:{enabled:true,withKoaContext:true,models:['post'],},},});// controllermodule.exports={asyncindex(ctx){ctx.middleware.cache;// A direct access to the Cache API},};
IMPORTANT: We do not recommend using this unless truly necessary. It is disabled by default as it goes against the non-intrusive/transparent nature of this middleware.
By setting thewithStrapiMiddleware configuration totrue, the middleware will extend the Strapi middleware object with an entry point which can be used to clear the cache from anywhere (e.g., inside a Model's lifecycle hook wherectx is not available).
// config/middleware.jsmodule.exports=({ env})=>({settings:{cache:{enabled:true,withStrapiMiddleware:true,models:['post'],},},});// modelmodule.exports={lifecycles:{asyncbeforeUpdate(params,data){strapi.middleware.cache;// A direct access to the Cache API},},};
IMPORTANT: We do not recommend using this unless truly necessary. It is disabled by default as it goes against the non-intrusive/transparent nature of this middleware.
/** *@typedef {import('strapi-middleware-cache').CacheStore} CacheStore *@typedef {import('strapi-middleware-cache').MiddlewareCacheConfig} MiddlewareCacheConfig *@typedef {import('strapi-middleware-cache').ModelCacheConfig} ModelCacheConfig *@typedef {import('strapi-middleware-cache').CustomRoute} CustomRoute */constcache={/** *@type {CacheStore} */ store,/** *@type {MiddlewareCacheConfig} */ options,/** * Clear cache with uri parameters * *@param {ModelCacheConfig} cacheConf *@param {{ [key: string]: string; }=} params */ clearCache,/** * Get related ModelCacheConfig * *@param {string} model *@param {string=} plugin *@returns {ModelCacheConfig=} */ getCacheConfig,/** * Get related ModelCacheConfig with an uid * * uid: * - application::sport.sport * - plugins::users-permissions.user * *@param {string} uid *@returns {ModelCacheConfig=} */ getCacheConfigByUid,/** * Get models uid that is related to a ModelCacheConfig * *@param {ModelCacheConfig} cacheConf The model used to find related caches to purge *@return {string[]} Array of related models uid */ getRelatedModelsUid,/** * Get regexs to match all ModelCacheConfig keys with given params * *@param {ModelCacheConfig} cacheConf *@param {{ [key: string]: string; }=} params *@param {boolean=} wildcard *@returns {RegExp[]} */ getCacheConfRegExp,/** * Get regexs to match CustomRoute keys with given params * *@param {CustomRoute} route *@param {{ [key: string]: string; }=} params *@param {boolean=} wildcard *@returns {RegExp[]} */ getRouteRegExp,};
The strapi admin panel uses a separate rest api to apply changes to records, e.g/content-manager/explorer/application::post.post the middleware will also watch for write operations on that endpoint and bust the cache accordingly
About
🔌 A cache middleware forhttps://strapi.io
Topics
Resources
License
Uh oh!
There was an error while loading.Please reload this page.
Stars
Watchers
Forks
Packages0
Uh oh!
There was an error while loading.Please reload this page.
Contributors15
Uh oh!
There was an error while loading.Please reload this page.