Update bottleneck to the latest version 🚀

greenkeeper[bot] commented 6 years ago

Version 2.0.0 of bottleneck was just published.

Dependency	bottleneck
Current Version	1.16.0
Type	dependency

The version 2.0.0 is not covered by your current version range.

If you don’t accept this pull request, your project will work just like it did before. However, you might be missing out on a bunch of new features, fixes and/or performance improvements from the dependency update.

It might be worth looking into these changes and trying to get this project onto the latest version of bottleneck.

If you have a solid test suite and good coverage, a passing build is a strong indicator that you can take advantage of these changes directly by merging the proposed change into your project. If the build fails or you don’t have such unconditional trust in your tests, this branch is a great starting point for you to work on the update.

Release Notes

Version 2

Bottleneck Version 2

This new version is almost 100% compatible with Version 1 and it adds some powerful features such as:

True Clustering support. You can now rate limit and schedule jobs across multiple Node.js instances. It uses strictly atomic operations to stay reliable in the presence of unreliable clients. 100% of Bottleneck's features are supported.
Support for custom job weights. Not all jobs are equally resource intensive.
Support for job timeouts. Bottleneck can automatically cancel jobs if they exceed their execution time limit.
Many improvements to the interface, such as better method names and errors, improved debugging tools.

Upgrading to v2

The internal algorithms essentially haven't changed from v1, but many small changes to the interface were made to introduce new features.

All the breaking changes:

Bottleneck v2 uses ES6/ES2015. v1 will continue to use ES5 only.
The Bottleneck constructor now takes an options object.
Jobs take an optional options object.
Removed submitPriority(), use submit() with an options object instead.
Removed schedulePriority(), use schedule() with an options object instead.
The rejectOnDrop option is now true by default.
Use null instead of 0 to indicate an unlimited maxConcurrent value.
Use null instead of -1 to indicate an unlimited highWater value.
Renamed changeSettings() to updateSettings(), it now returns a promise to indicate completion. It takes the same options object as the constructor.
Renamed nbQueued() to queued().
Renamed nbRunning to running(), it now returns its result using a promise.
Removed isBlocked().
Changing the Promise library is now done through the options object like any other limiter setting.
Removed changePenalty(), it is now done through the options object like any other limiter setting.
Removed changeReservoir(), it is now done through the options object like any other limiter setting.
Removed stopAll(). Use the reservoir feature to disable execution instead.
check() now accepts an optional weight argument, and returns its result using a promise.
The Cluster feature is now called Group. This is to distinguish it from the new v2 Clustering feature.
The Group constructor takes an options object to match the limiter constructor.
Renamed the Group changeTimeout() method to updateSettings(), it now takes an options object.

Version 2 is more user-friendly, powerful and reliable.

Commits

The new version differs by 33 commits.

7c22c90 2.0.0 Updated dep
1aed0a4 2.0.0
49cff2e Fixed Group autocleanup
7d6cc14 README feedback
bdf0d9f 2.0.0-beta.4
1f59c3c Typecript typings for v2
7ef79ef Update beta version
5038ca6 2.0.0-beta.3
4b4954f 2.0.0-beta.2
2044e9d Readme improvements
ea86d03 Minor readme fixes
e57bed5 v2-beta1 docs update
f772707 2.0.0-beta.1
ff4e5b9 Updated Readme for v2
02db071 Error handling improvements

There are 33 commits in total.

See the full diff

FAQ and help

There is a collection of [frequently asked questions](https://greenkeeper.io/faq.html). If those don’t help, you can always [ask the humans behind Greenkeeper](https://github.com/greenkeeperio/greenkeeper/issues/new).

Your Greenkeeper bot :palm_tree:

greenkeeper[bot] commented 6 years ago

timdp / winston-aws-cloudwatch