Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[NEUTRAL] Update dependency express-rate-limit to v7 #896

Open
wants to merge 1 commit into
base: unstable
Choose a base branch
from

Conversation

mend-for-github-com[bot]
Copy link

@mend-for-github-com mend-for-github-com bot commented Nov 2, 2023

This PR contains the following updates:

Package Change Age Adoption Passing Confidence
express-rate-limit ^5.1.3 -> ^7.0.0 age adoption passing confidence

Release Notes

express-rate-limit/express-rate-limit (express-rate-limit)

v7.3.0

Compare Source

You can view the changelog here.

v7.2.0

Compare Source

You can view the changelog here.

v7.1.5

Compare Source

You can view the changelog here.

v7.1.4

Compare Source

You can view the changelog here.

v7.1.3

Compare Source

You can view the changelog here.

v7.1.2

Compare Source

You can view the changelog here.

v7.1.1

Compare Source

Misc

You can view the full changelog here.

v7.1.0

Compare Source

You can view the changelog here.

v7.0.2

Compare Source

You can view the changelog here.

v7.0.1

Compare Source

You can view the changelog here.

v7.0.0

Compare Source

Breaking
  • Changed behavior when max is set to 0:
    • Previously, max: 0 was treated as a 'disable' flag and would allow all requests through.
    • Starting with v7, all requests will be blocked when max is set to 0.
    • To replicate the old behavior, use the skip function instead.
  • Renamed req.rateLimit.current to req.rateLimit.used.
    • current is now a hidden getter that will return the used value, but it will not appear when iterating over the keys or calling JSON.stringify().
  • Changed the minimum required Node version from v14 to v16.
    • express-rate-limit now targets es2022 in TypeScript/ESBuild.
  • Bumped TypeScript from v4 to v5 and dts-bundle-generator from v7 to v8.
Deprecated
  • Removed the draft_polli_ratelimit_headers option (it was deprecated in v6).
    • Use standardHeaders: 'draft-6' instead.
  • Removed the onLimitReached option (it was deprecated in v6).
    • This is an example of how to replicate it's behavior with a custom handler option.
Changed
  • The MemoryStore now uses precise, per-user reset times rather than a global window that resets all users at once.
  • The limit configuration option is now prefered to max.
    • It still shows the same behavior, and max is still supported. The change was made to better align with terminology used in the IETF standard drafts.
Added
  • The validate config option can now be an object with keys to enable or disable specific validation checks. For more information, see this.

v6.11.2

Compare Source

Fixed
  • Restored IncrementResponse TypeScript type (See #​397)

v6.11.1

Compare Source

Fixed
  • Check for prefixed keys when validating that the stores have single counted keys (See #​395).

v6.11.0

Compare Source

Added
  • Support for retrieving the current hit count and reset time for a given key from a store (See #​390).

v6.10.0

Compare Source

Added
  • Support for combined RateLimit header from the RateLimit header fields for HTTP standardization draft adopted by the IETF. Enable by setting standardHeaders: 'draft-7'
  • New standardHeaders: 'draft-6' option, treated equivalent to standardHeaders: true from previous releases. (true and false are still supported.)
  • New RateLimit-Policy header added when standardHeaders is set to 'draft-6', 'draft-7', or true
  • Warning when using deprecated draft_polli_ratelimit_headers option
  • Warning when using deprecated onLimitReached option
  • Warning when totalHits value returned from Store is invalid

v6.9.0

Compare Source

Added
  • New validaion check for double-counted requests
  • Added help link to each ValidationError, directing users to the appropriate wiki page for more info
Changed
  • Miscaleanous documenation improvements

You can view the full changelog here.

v6.8.1

Compare Source

Changed
  • Revert 6.7.1 change that bumped typescript from 5.x to 4.x and dts-bundle-generator from 8.x to 7.x (See #​360)

You can view the full changelog here.

v6.8.0

Compare Source

Added

You can view the changelog here.

v6.7.2

Compare Source

(Backport of v6.8.1)

You can view the full changelog here.

v6.7.1

Compare Source

Fixed
  • Fixed compatibility with TypeScript's TypeScript new node16 module
    resolution strategy (See
    #​355)
Changed
  • Bumped development dependencies.
  • Added node 20 to list of versions the CI jobs run on.

No functional changes.

You can view the changelog here.

v6.7.0

Compare Source

No functional changes.

Changed
  • Updated links to point to the new express-rate-limit organization on GitHub.
  • Added advertisement to readme.md for project sponsor Zuplo.
  • Updated to typescript version 5 and bumped other dependencies.
  • Dropped node 12, and added node 19 to the list of versions the CI jobs run on.

You can view the changelog here.

v6.6.0

Compare Source

Added
  • Added shutdown method to the Store interface and the MemoryStore. (#​322)

You can view the full changelog here.

v6.5.2

Compare Source

Fixed
  • Fixed an issue with missing types in ESM monorepos. (#​321)

You can view the changelog here.

v6.5.1

Compare Source

Changed

  • The message option can now be a (sync/asynx) function that returns a value (#​311)
  • Updated all dependencies

v6.4.0

Compare Source

Added

  • Adds Express 5 (5.0.0-beta.1) as a supported peer dependency (#​304)

Changed

  • Tests are now run on Node 12, 14, 16 and 18 on CI (#​305)
  • Updated all development dependencies (#​306)

v6.3.0

Compare Source

Changed
  • Changes the build target to es2019 so that ESBuild outputs code that can run with Node 12.
  • Changes the minimum required Node version to 12.9.0.

v6.2.1

Compare Source

Fixed
  • Use the default value for an option when undefined is passed to the rate
    limiter.

v6.2.0

Compare Source

Added
  • Export the MemoryStore, so it can now be imported as a named import
    (import { MemoryStore } from 'express-rate-limit').
Fixed
  • Deprecate the onLimitReached option (this was supposed to be deprecated in
    v6.0.0 itself); developers should use a custom handler function that checks if
    the rate limit has been exceeded instead.

v6.1.0

Compare Source

Added
  • Added a named export rateLimit in case the default import does not work.
Fixed
  • Added a named export default, so Typescript CommonJS developers can default-import the library (import rateLimit from 'express-rate-limit').

v6.0.5

Compare Source

Fixed
  • Use named imports for ExpressJS types so users do not need to enable the esModuleInterop flag in their Typescript compiler configuration.

v6.0.4

Compare Source

Fixed
  • Upload the built package as a .tgz to GitHub releases.
Changed
  • Add main and module fields to package.json. This helps tools such as ESLint that do not yet support the exports field.
  • Bumped the minimum node.js version in package-lock.json to match package.json

v6.0.3

Compare Source

Changed

v6.0.2

Compare Source

Fixed
  • Ensure CommonJS projects can import the module.
Added
  • Add additional tests that test:
    • importing the library in js-cjs, js-esm, ts-cjs, ts-esm environments.
    • usage of the library with external stores (redis, mongo, memcached, precise).
Changed
  • Use esbuild to generate ESM and CJS output. This reduces the size of the built package from 138 kb to 13kb and build time to 4 ms! 🚀
  • Use dts-bundle-generator to generate a single Typescript declaration file.

v6.0.1

Compare Source

Fixed
  • Ensure CommonJS projects can import the module.

v6.0.0

Compare Source

Added
  • express 4.x as a peer dependency.
  • Better Typescript support (the library was rewritten in Typescript).
  • Export the package as both ESM and CJS.
  • Publish the built package (.tgz file) on GitHub releases as well as the npm registry.
  • Issue and PR templates.
  • A contributing guide.
  • A changelog.
Changed
  • Rename the draft_polli_ratelimit_headers option to standardHeaders.
  • Rename the headers option to legacyHeaders.
  • Retry-After header is now sent if either legacyHeaders or standardHeaders is set.
  • Allow keyGenerator to be an async function/return a promise.
  • Change the way custom stores are defined.
    • Add the init method for stores to set themselves up using options passed to the middleware.
    • Rename the incr method to increment.
    • Allow the increment, decrement, resetKey and resetAll methods to return a promise.
    • Old stores will automatically be promisified and used.
  • The package can now only be used with NodeJS version 12.9.0 or greater.
  • The onLimitReached configuration option is now deprecated. Replace it with a custom handler that checks the number of hits.
Removed
  • Remove the deprecated limiter.resetIp method (use the limiter.resetKey method instead).
  • Remove the deprecated options delayMs, delayAfter (the delay functionality was moved to the express-slow-down package) and global (use a key generator that returns a constant value).

v5.5.1

Compare Source

v5.5.0

Compare Source

v5.4.1

Compare Source

v5.4.0

Compare Source

v5.3.0

Compare Source

v5.2.6

Compare Source

v5.2.5

Compare Source

v5.2.3

Compare Source

v5.2.2

Compare Source

v5.2.1

Compare Source


Configuration

📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 Ignore: Close this PR and you won't be reminded about this update again.


  • If you want to rebase/retry this PR, check this box

Copy link
Author

⚠ Artifact update problem

Renovate failed to update an artifact related to this branch. You probably do not want to merge this PR as-is.

♻ Renovate will retry this branch, including artifacts, only when one of the following happens:

  • any of the package files in this branch needs updating, or
  • the branch becomes conflicted, or
  • you click the rebase/retry checkbox if found above, or
  • you rename this PR's title to start with "rebase!" to trigger it manually

The artifact failure details are included below:

File name: package-lock.json
npm ERR! code ERESOLVE
npm ERR! ERESOLVE unable to resolve dependency tree
npm ERR! 
npm ERR! While resolving: zenbot4@4.1.0
npm ERR! Found: webpack@4.47.0
npm ERR! node_modules/webpack
npm ERR!   webpack@"^4.44.1" from the root project
npm ERR! 
npm ERR! Could not resolve dependency:
npm ERR! peer webpack@"^5.0.0" from postcss-loader@5.3.0
npm ERR! node_modules/postcss-loader
npm ERR!   postcss-loader@"^5.0.0" from the root project
npm ERR! 
npm ERR! Fix the upstream dependency conflict, or retry
npm ERR! this command with --force, or --legacy-peer-deps
npm ERR! to accept an incorrect (and potentially broken) dependency resolution.
npm ERR! 
npm ERR! See /tmp/renovate/cache/others/npm/eresolve-report.txt for a full report.

npm ERR! A complete log of this run can be found in:
npm ERR!     /tmp/renovate/cache/others/npm/_logs/2023-11-02T02_09_09_973Z-debug-0.log

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

0 participants