Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/xyy94813/rrnl-request-limiter-middleware
A RRNL middleware for limit number of request
https://github.com/xyy94813/rrnl-request-limiter-middleware
Last synced: 4 days ago
JSON representation
A RRNL middleware for limit number of request
- Host: GitHub
- URL: https://github.com/xyy94813/rrnl-request-limiter-middleware
- Owner: xyy94813
- License: mit
- Created: 2023-12-26T02:41:39.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2024-02-06T04:28:55.000Z (10 months ago)
- Last Synced: 2024-02-07T04:31:06.055Z (9 months ago)
- Language: TypeScript
- Size: 1.06 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: Contributing.md
- License: LICENSE
Awesome Lists containing this project
README
# RRNL-request-limiter-middleware
A RRNL middleware for limit number of request
[](https://github.com/xyy94813/rrnl-request-limiter-middleware)
[](https://github.com/xyy94813/rrnl-request-limiter-middleware)
[](https://www.npmjs.org/package/rrnl-request-limiter-middleware)
[](https://www.npmjs.org/package/rrnl-request-limiter-middleware)
[](http://npmjs.com/rrnl-request-limiter-middleware)
[](http://npmjs.com/rrnl-request-limiter-middleware)
[](https://github.com/xyy94813/rrnl-request-limiter-middleware/actions/workflows/codecov.yml)
[](https://codecov.io/gh/xyy94813/rrnl-request-limiter-middleware)
## Why need this middleware?
Adding loose limits on the number of requests prevents applications from generating a large number of server requests in a short period of time,
thus ultimately avoiding more serious problems
Despite the rigorous testing of our products, bugs that can't be reproduced are always there.
Despite our caching strategy. (with `React-Relay` cache policy or cache middleware)
### Inexperienced developers can easily make the following mistakes
```js
const res = useLazyLoadQuery(query, {
startDateTime: moment().subtract(7, "day").format("l HH:mm:ss"), // last 7 day
});
```
Think about this: "If the request time is large then 1 second?"
The precision of the time parameter in variables is small, it is more likely to result in frequent requests.
## How to use?
Install:
```shell
yarn add rrnl-request-limiter-middleware
// or npm install rrnl-request-limiter-middleware
```
Usage:
```js
import {
createRequestLimiterMiddleware,
SlidingLogRateLimiter,
} from "rrnl-request-limiter-middleware";
const network = new RelayNetworkLayer([
// your other middleware
// ...
cacheMiddleware(),
createRequestLimiterMiddleware(
new SlidingLogRateLimiter([
{ duration: 60_000, limitTimes: 60 }, // Maximum 60 requests in 60 second for a query id
{ duration: 1_000, limitTimes: 3 }, // Maximum 3 requests in 1 second for a query id
]),
),
// your other middlewares
// ...
]);
```
Use with `TokenBucketRateLimiter`:
```js
import {
createRequestLimiterMiddleware,
TokenBucketRateLimiter,
} from "rrnl-request-limiter-middleware";
const network = new RelayNetworkLayer([
// your other middleware
// ...
cacheMiddleware(),
createRequestLimiterMiddleware(new TokenBucketRateLimiter(20, 1)),
// your other middlewares
// ...
]);
```
**NOTE: Currently, `TokenBucketRateLimiter` does not distinguish between queryId limits, in order to avoid overly timed tasks.**
With `wait` limit policy:
```js
import {
createRequestLimiterMiddleware,
TokenBucketRateLimiter,
} from "rrnl-request-limiter-middleware";
const network = new RelayNetworkLayer([
// your other middleware
// ...
cacheMiddleware(),
createRequestLimiterMiddleware(new TokenBucketRateLimiter(20, 1), "wait"),
// your other middlewares
// ...
]);
```
## How to contribute?
[Contributing Guild](https://github.com/xyy94813/rrnl-request-limiter-middleware/blob/main/Contributing.md)
## Changelog
[Change Logs](https://github.com/xyy94813/rrnl-request-limiter-middleware/blob/main/CHANGELOG.md)
## License
[MIT](https://github.com/xyy94813/rrnl-request-limiter-middleware/blob/main/LICENSE)