https://github.com/francescorivola/rabbit-lru-cache
A lib to invalidate lru cache keys in distributed systems powered by rabbitmq.
https://github.com/francescorivola/rabbit-lru-cache
distributed invalidation lru-cache rabbitmq
Last synced: 9 months ago
JSON representation
A lib to invalidate lru cache keys in distributed systems powered by rabbitmq.
- Host: GitHub
- URL: https://github.com/francescorivola/rabbit-lru-cache
- Owner: francescorivola
- License: mit
- Created: 2020-04-10T13:13:33.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2025-05-21T05:59:29.000Z (12 months ago)
- Last Synced: 2025-07-08T16:05:46.661Z (10 months ago)
- Topics: distributed, invalidation, lru-cache, rabbitmq
- Language: TypeScript
- Homepage:
- Size: 1.78 MB
- Stars: 6
- Watchers: 1
- Forks: 1
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# rabbit-lru-cache
A lib to invalidate lru cache keys in distributed systems powered by rabbitmq.
[ ](https://www.npmjs.com/package/rabbit-lru-cache)
[](https://github.com/francescorivola/rabbit-lru-cache/actions)
[](https://www.codefactor.io/repository/github/francescorivola/rabbit-lru-cache)
[](https://codecov.io/gh/francescorivola/rabbit-lru-cache)
[](https://dependabot.com/)
## Installation
`npm install --save rabbit-lru-cache`
## Getting Started
This library is powered by lru-cache and amqplib (both dependencies).
```js
const createRabbitLRUCache = require("rabbit-lru-cache").default;
const cache = await createRabbitLRUCache({
name: "example",
LRUCacheOptions: {
ttl: 120000,
max: 10000
},
amqpConnectOptions: {
hostname: "localhost",
username: "guest",
password: "guest"
}
});
cache.addInvalidationMessageReceivedListener((content, publisherCacheId) => {
console.log(
"Cache Message",
"publisherCacheId",
publisherCacheId,
"content",
content
);
});
cache.addReconnectingListener((error, attempt, retryInterval) => {
console.log(
"Reconnecting",
error.message,
"attempt",
attempt,
"retryInterval",
retryInterval
);
});
cache.addReconnectedListener((error, attempt, retryInterval) => {
console.log(
"Reconnected",
error.message,
"attempt",
attempt,
"retryInterval",
retryInterval
);
});
await cache.getOrLoad("key", () => Promise.resolve(5));
cache.delete("key");
await cache.close(); // gracefully shutdown RabbitMq connection
```
Every time the lru-cache **delete** or **clear** function is called a message is published in a fan out exchange and each cache subscribers consume the message to invalidate the corresponding key or the entire cache.
The **getOrLoad** function forces you to set item in cache only after loading it, avoiding a wrong usage of the library as, for instance, set in cache an item after modifying it. Finally, this function comes with concurrency mechanism to avoid stale data and [Thundering herd problem](https://en.wikipedia.org/wiki/Thundering_herd_problem) by use the same promise for concurrent requests of the same cache key while the corresponding item is not loaded in cache yet.
The lib handles RabbitMq connection errors and it reconnects automatically if the connection with the broker got lost. During reconnection the local cache get resetted and cache is disabled to ensure it does not store stale data.
## Examples
Examples of the usage of this lib can be found in test folder or [examples](./examples) folder.
## Test
Run test suite with the following command:
```sh
npm test
```
Test suite requires a RabbitMq server listening at port 5672.
## License
MIT