Sifaka is a pluggable caching library with an emphasis on protecting the backend from being overloaded.
npm install sifaka
Sifaka is a pluggable caching library with an emphasis on protecting the backend from being overloaded. Approaches taken:
* Cache Stampede / dog piling protection by maintaining a distributed lock between cache clients, so the work function is executed at most once at any time for a given key.
* Allowing stale data to be served for a configurable period of time. During this time, one request will be triggered to update the cache for the key.
* Configurable cache policies, allowing stale and expiry times to be calculated based upon the duration of the operation (e.g. if an operation takes 30s to complete, you may wish to recalculate it less frequently than an operation that takes 30ms to complete).
redis module installed to use the redis backend.#### sifaka.get(key,workFunction,[options], callback)
Try to retrieve an item from the cache. If it is not there, either wait for another cache client to do the work (if it is already underway) or do the work locally. The value will then be returned via callback(err, data, meta, extra).
The workFunction should callback(err, data, extra), where extra is an optional object to store alongside the data.
##### Options Values
###### options.metaOnly - request that metadata only be returned from the backend in either a hit or miss scenario
| options.metaOnly value | cache (hit|miss) | data returned | work function called |
|:---:|:---:|:---:|:---:|
| not set / null | hit | y | n |
| not set / null | miss | y | if required |
| "hit" | hit | n | n |
| "hit" | miss | y | if required |
| "miss" | hit | y | n |
| "miss" | miss | n | n |
This means you can short circuit the work function on a miss and fetching data from the backend on a hit. This may be useful to:
Return data on a hit, but not recalculate the data on a miss
Recalculate on a miss, but only report the existence on a hit.
#### sifaka.exists(key,[options], callback)
Check the state of an item in the cache. Will be returned by callback(err, meta)
* mocha tests can be run using npm test mocha or make test!
* there is a loadtest harness in /loadtest. Run node index.js --handler [handler] in one console, then hit localhost on port 8002 (e.g. with the node package loadtest: node loadtest.js -n 5000 -c 20 http://127.0.0.1:8002 --rps 50). There are some example results with various handlers: no caching (work function gets called for every request), using the node-cache module - which will hit the work with a stampede, and two sifaka handlers.
Why not. I decided to spend more cycles on getting the caching side of things right, rather than coming up with a better name. Also, they're awesome.