node-rate-limiter-flexible

• RateLimiterRedis supports for customIncrTtlLuaScript option now. You can set custom Lua script as a string. It will be executed instead of built-in Lua script that is called on every upsert. See this rejected when consume more than maximum points and multiply delay test for example. Thanks to @roggervalf
• Readme language fixes. Thanks to @DePasqualeOrg

👍

What's Changed

1. Add RateLimiterPrisma. Read about it on Wiki. Prisma supports PostgreSQL, MySQL, SQLite, MongoDB and many other databases. Thank you @animir

2. Test environment and github actions got a number of improvements. Thank you @mroderick

3. BREAKING CHANGES: we dropped support for Node.js 14 and all previous versions.

Full Changelog: https://github.com/animir/node-rate-limiter-flexible/compare/v4.0.1...v5.0.0

RateLimiterMongo TypeError: Cannot read properties of null (reading 'value') error was fixed. See https://github.com/animir/node-rate-limiter-flexible/issues/251 for reference.

Thanks to @o-ali

Thanks to @Daniel-97 rate-limiter-flexible supports DynamoDB now!
Usage example can be found here.

BREAKING CHANGES: we dropped support for Node.js 12 and previous versions.

🐯

• RateLimiterUnion.consume return type fixed. Thanks to @Omers-Frontegg

• fix memory storage consuming points when msBeforeNext is negative (key is expired). Thank you @animir

• use quotation for table name in RateLimiterPostgres queries. Thanks to @komachi
• add optional schemaName to RateLimiterPostgres limiter. Thanks to @paulsc54
• special thanks to @roggervalf who configured Github Actions for tests

🍯

I have really great news!
rate-limiter-flexible supports ioredis v4+ and redis v4+ now.
We have been waiting for this moment for years.

Thanks to @roggervalf. And one big thank you from me personally

Since this is major release, there are

BREAKING CHANGES:

1. rate-limiter-flexible works with ioredis package of any version (tested versions 2, 3, 4 and 5) by default now. If you want it to work with the latest redis package, you should set useRedisPackage flag. If you use redis of version 3 or lower, you should stick to rate-limiter-flexible version 2.
2. deprecated options started with lowercased inmemory prefix are removed. You can use inMemoryBlockOnConsumed and
   inMemoryBlockDuration instead.
3. deprecated redis option for RateLimiterRedis was removed. (Most likely you never heard about it, since it was deprecated years ago). You should use storeClient option instead.

Thank you @dmozgovoi for the quick improvement.

In some cases especially with insuranceLimiter set it is important to reject requests quickly based on Redis client status being not ready. Thanks @dmozgovoi

Thank you @svsool

• RateLimiterQueue getTokensRemaining with RateLimiterPostgres fixed. https://github.com/animir/node-rate-limiter-flexible/issues/125
• clear timeout on key delete from memory storage. https://github.com/animir/node-rate-limiter-flexible/pull/146 Thank you @jiddmeye
• clearExpiredByTimeout is added to TS types for MySQL and Postgres limiters. https://github.com/animir/node-rate-limiter-flexible/issues/156
• fix negative remaining points in memory limiter. https://github.com/animir/node-rate-limiter-flexible/issues/172 Thank you @MiniKraken-Team
• added browser package.json settings to allow bundling. https://github.com/animir/node-rate-limiter-flexible/commit/6ce34b394a2b82e36ab959eb884e475b5dad5fcc Thank you @achingbrain
• use nodejs.util.inspect.custom for Symbol flexibility. https://github.com/animir/node-rate-limiter-flexible/commit/2c8bedb973c3931a068ba23b5207763ecc26f988 Thank you @shlavik
• inmemoryBlockOnConsumed and inmemoryBlockDuration options are renamed to inMemoryBlockOnConsumed and inMemoryBlockDuration. Old options are still supported, but deprecated and will be removed in v3 major release. https://github.com/animir/node-rate-limiter-flexible/issues/106

• MongoDB version detection is fixed for mongoose client. Thank you @adrianvlupu
• MongoDB version detection is fixed for 3.6.7+. Thank you @pavittarx
• Internal fix of get method. It incorrectly processed undefined result from a store. Thank you @animir
• .editorconfig added. Thank you @vinibeloni
• TypeScript type for RateLimiterQueueError added. Thank you @adilhafeez
• TypeScript type for deleteInMemoryBlockedAll method is added. Thank you @animir

• replace replaceOne with findOneAndUpdate to fix a bug related to absent ops attribute in MongoDB client v4+. Thank you @vdiez
• delete method on any store limiter deletes inMemoryBlocked key if it is there. Thank you @evan361425
• new deleteInMemoryBlockedAll method added to clean up all blocked keys at once. Thank you @evan361425 again :-)
• @evan361425 also added tests to cover new lines 🥇

• Missing get/set Typescript types added and documentation improved. Thanks @rijkvanzanten
• mongodb client v4 support. Thank you @backflip

• TypeORM Support for RateLimitPostgres, thank you @seromenho
• Readme links fixed, thanks @mriedem
• RateLimiterQueue TS types fixed
• Fix postgres consumed points increment on block, issue https://github.com/animir/node-rate-limiter-flexible/issues/95

• RateLimiterQueue support of tokens removed by key. (single bucket for every key)
• Add RateLimiterQueue missing methods types. Thank you @bmenant
• RateLimiterPostgres fixed for [email protected] update. Thank you @matomesc
• tableCreated option for MySQL and PostgreSQL to skip checks for limiter tables.
• BurstyRateLimiter compatible with RateLimiterQueue now. Thanks a lot to @matomesc for a big help on this.
• RateLimiterMemory limiter works in browser now. Thanks a bunch to @cha0s. Also, thank you for test scripts improvements.

Every time consume method executed, it returns msBeforeNext milliseconds. This can be used to block key in memory for exact msBeforeNext milliseconds until points are reset on store. Set inmemoryBlockOnConsumed option and omit inmemoryBlockDuration for this feature.

Allow traffic bursts with BurstyRateLimiter

Changes

• Redis uses Lua script for expiring atomic increments. It allowed to remove a hack, which made extra queries to Redis, when TTL is not set on key set.
• RateLimiterCluster options type fixed.

BREAKING CHANGES:

• isWhite and isBlack getters/setters and options support removed from RLWrapperBlackAndWhite. isWhiteListed and isBlackListed options should be used instead.
• IRateLimiterResOptions interface type removed from lib/index.d.ts. IRateLimiterRes should be used.