hutch 0.25.0.pre.rc1-java → 2.0.0.rc1-java

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: f44f4b993e19281740ceb3c410f363b72d74bc0b
-  data.tar.gz: fd44e56bac8081fb3902b1e33105a4a806fa7995
+SHA256:
+  metadata.gz: 459b3765c6db0fa6a1421837a714b8ced3e3c7e036c5d3cd058d1eb8180862b4
+  data.tar.gz: 2c1f461463321e705e2464373093135bf307b68dac9f08b284e8c5f6c9e710db
 SHA512:
-  metadata.gz: 134172ba6b7f1c79ae2c332d76cabf87d5c6a2032fc1d1a875b9ed587010620533b2792148efa925ee2617c05f321206e08c3053c042674adaef35c2773e4e82
-  data.tar.gz: 82c6f22d092760191c5a59f7d20588ad90ea500ed4df9324b579b5a6137b14bd1a11ef9e72cd3af47796b13629479742d276e65edf43d6ddc59f42bea817085e
+  metadata.gz: f083551b329e1911f0b16837ae9cdd868aed516ff57ec69fb01435c0686485260145ff478db42257b22640c517ba08872e01785eee02ffaa14b9b655ddb4dd18
+  data.tar.gz: e3c8b5ac42f24483a773167eb79d01e9e29e71859c0a78ccf01d59b018ec1f57a1a5c26c8da47ad9ebb743b04fed9d67989802eb0f495bd894c1b3c51cb830c3

data/CHANGELOG.md

@@ -1,8 +1,406 @@
-## 0.25.0 — (unreleased)
+# Hutch Change Log
 
-No changes yet.
+## 2.0.0 (TBD)
 
+### Breaking Changes
 
+ * Ruby `3.2` or JRuby `10` is now required
+ * The Datadog tracer now depends on the [`datadog`](https://github.com/DataDog/dd-trace-rb)
+   gem, which replaces the EOL `ddtrace`
+   ([migration guide](https://github.com/DataDog/dd-trace-rb/blob/master/docs/UpgradeGuide2.md))
+ * `Hutch::ErrorHandlers::SentryRaven` has been replaced by
+   `Hutch::ErrorHandlers::Sentry`, backed by `sentry-ruby`
+   ([migration guide](https://docs.sentry.io/platforms/ruby/migration/))
+ * Messages are serialized with the stdlib `json` instead of `multi_json`, which
+   means that `MultiJson` configuration such as `MultiJson.use(:oj)` no longer
+   affects Hutch
+
+### Consumer Recovery After a RabbitMQ 4.3 Quorum Queue Consumer Timeout
+
+RabbitMQ 4.3 quorum queues cancel a timed out consumer with `basic.cancel`
+instead of closing the channel. Hutch 1.4.0 does not react to that, so on 4.3
+a consumer stops consuming its queue until the worker restarts.
+
+Workers now re-subscribe consumers cancelled by the server, but only if
+the queue still exists: a `basic.cancel` carries no reason, so a consumer
+timeout is indistinguishable from a queue deletion. The consumer channel is
+replaced in the process, so the deliveries the cancelled consumer still held
+are requeued instead of dropped.
+
+Handlers that are still running get a graceful exit to finish before
+the old channel is closed, and their acknowledgements are dropped rather than
+sent on the new channel, where their delivery tags mean nothing.
+
+### Connection URIs Are Now Percent-Decoded
+
+The virtual host, username and password of a connection URI are now decoded, as
+[the URI specification](https://www.rabbitmq.com/docs/uri-spec) requires.
+`amqp://host/%2F` connects to the default virtual host instead of one literally
+named `%2F`, and credentials containing a space, `#` or `@` authenticate again.
+
+Reported by @deissimon.
+
+GitHub issue: [#422](https://github.com/ruby-amqp/hutch/issues/422)
+
+### Fixed Two JRuby Regressions
+
+Opening a channel raised, and the `march_hare` adapter did not declare the
+exchange it instantiated.
+
+GitHub issue: [#427](https://github.com/ruby-amqp/hutch/issues/427)
+
+### The JRuby Variant Is Revived
+
+The `java` platform gem, which depends on March Hare instead of Bunny, was last
+published as `0.25.0` in January 2018 and has seen little more than CI version
+bumps since. This release requires JRuby `10` and `march_hare` `4.7.0`, adds a
+JRuby CI job, and publishes the gem again.
+
+Recovering a channel the broker closed remains Bunny-only: `MarchHare::Channel`
+has no `on_error` callback and no `reopen`.
+
+## 1.4.0 (Apr 7, 2026)
+
+### Ruby 3.0 is Now Required
+
+This version adopts [Bunny `3.x`](https://github.com/ruby-amqp/bunny/releases/tag/3.0.0)
+and as a result, requires Ruby 3.0.
+
+### `without_namespace` Consumer DSL Option
+
+Consumers can now opt out of the automatic namespace prefix
+for their queue name using the `without_namespace` DSL method:
+
+``` ruby
+class DeadLetterConsumer
+  include Hutch::Consumer
+  consume 'dead.letters'
+  queue_name 'deadletter'
+  without_namespace
+end
+```
+
+Originally contributed by @tlloydthwaites.
+
+GitHub issue: [#393](https://github.com/ruby-amqp/hutch/pull/393)
+
+### Consumer Channel Recovery After Delivery Acknowledgement Timeout
+
+Hutch now automatically "recovers" (reopens) consumer channels closed by RabbitMQ
+due to a [delivery acknowledgement timeout](https://www.rabbitmq.com/docs/consumers#acknowledgement-timeout).
+
+Note that this exception indicates a potential issue on Hutch's end:
+a delivery was not acknowledged in time (30 minutes by default). Even then,
+recovering the channel in this specific scenario is an operational improvement.
+
+Contributed by @Garaio-REM.
+
+GitHub issue: [#414](https://github.com/ruby-amqp/hutch/pull/414)
+
+### Migrated Datadog Tracer From the `ddtrace` Gem to `datadog`
+
+The Datadog tracer now uses the `datadog` gem instead of the deprecated `ddtrace`.
+The `ddtrace` gem is still supported but emits a deprecation warning at load time.
+Support for `ddtrace` will be removed in Hutch 2.0.
+
+### Deprecated `SentryRaven` Error Handler
+
+`Hutch::ErrorHandlers::SentryRaven` now emits a deprecation warning and will be
+removed in Hutch 2.0. Use `Hutch::ErrorHandlers::Sentry` (backed by `sentry-ruby`) instead.
+
+### Rails 8.x Compatibility
+
+Contributed by @drobny.
+
+GitHub issue: [#404](https://github.com/ruby-amqp/hutch/pull/404)
+
+
+## 1.3.0 (Nov 11, 2024)
+
+### Ruby 3.2 Compatibility
+
+GitHub issue: [#392](https://github.com/ruby-amqp/hutch/pull/392)
+
+### Relaxed ActiveSupport Dependency Constraints
+
+Contributed by drobny.
+
+GitHub issue: [#402](https://github.com/ruby-amqp/hutch/pull/402)
+
+### Client-Provided Connection Name
+
+Contributed by @sharshenov.
+
+GitHub issue: [#399](https://github.com/ruby-amqp/hutch/pull/399)
+
+
+## 1.1.1 (March 18th, 2022)
+
+### Dependency Bump
+
+Hutch now allows ActiveSupport 7.x.
+
+
+## 1.1.0 (July 26th, 2021)
+
+### Bugsnag Error Handler
+
+Contributed by @ivanhuang1.
+
+GitHub issue: [#362](https://github.com/ruby-amqp/hutch/pull/362)
+
+### Datadog Tracer
+
+Contributed by Karol @Azdaroth Galanciak.
+
+GitHub issue: [#360](https://github.com/ruby-amqp/hutch/pull/360)
+
+### Updated Sentry Error Handler
+
+Contributed by Karol @Azdaroth Galanciak.
+
+GitHub issue: [#363](https://github.com/ruby-amqp/hutch/pull/363)
+
+### Type Casting for Values Set Using Hutch::Config.set
+
+Values set with `Hutch::Config.set` now have expected setting type casting
+applied to them.
+
+Contributed by Karol @Azdaroth Galanciak.
+
+GitHub issue: [#358](https://github.com/ruby-amqp/hutch/pull/358)
+
+### Wider MultiJson Adoption
+
+Contributed by Ulysse @BuonOmo Buonomo.
+
+GitHub issue: [#356](https://github.com/ruby-amqp/hutch/pull/356)
+
+### README Corrections
+
+Contributed by Johan @johankok Kok.
+
+GitHub issue: [#353](https://github.com/ruby-amqp/hutch/pull/353)
+
+## 1.0.0 (April 8th, 2020)
+
+Hutch has been around for several years. It is time to ship a 1.0. With it we try to correct
+a few of overly opinionated decisions from recent releases. This means this release
+contains potentially breaking changes.
+
+### Breaking Changes
+
+ * Hutch will no longer configure any queue type (such as [quorum queues](https://www.rabbitmq.com/quorum-queues.html))
+   or queue mode (used by classic [lazy queues](https://www.rabbitmq.com/lazy-queues.html))
+   by default as that can be breaking change for existing Hutch and RabbitMQ installations due to the
+   [property equivalence requirement](https://www.rabbitmq.com/queues.html#property-equivalence) in AMQP 0-9-1.
+
+   This means **some defaults introduced in `0.28.0` ([gocardless/hutch#341](https://github.com/gocardless/hutch/pull/341)) were reverted**.
+   The user has to opt in to configure the queue type and mode and other [optional arguments](https://www.rabbitmq.com/queues.html#optional-arguments) they need to use.
+   Most optional arguments can be set via [policies](https://www.rabbitmq.com/parameters.html#policies) which is always the recommended approach.
+   Queue type, unfortunately, is not one of them as different queue types have completely different
+   implementation details, on disk data formats and so on.
+
+   To use a quorum queue, use the `quorum_queue` consumer DSL method:
+
+   ``` ruby
+   class ConsumerUsingQuorumQueue
+      include Hutch::Consumer
+      consume 'hutch.test1'
+      # when in doubt, prefer using a policy to this DSL
+      # https://www.rabbitmq.com/parameters.html#policies
+      arguments 'x-key': :value
+
+      quorum_queue
+   end
+   ```
+
+   To use a classic lazy queue, use the `lazy_queue` consumer DSL method:
+
+   ``` ruby
+   class ConsumerUsingLazyQueue
+     include Hutch::Consumer
+     consume 'hutch.test1'
+     # when in doubt, prefer using a policy to this DSL
+      # https://www.rabbitmq.com/parameters.html#policies
+      arguments 'x-key': :value
+
+     lazy_queue
+     classic_queue
+   end
+   ```
+
+   By default Hutch will not configure any `x-queue-type` or `x-queue-mode` optional arguments
+   which is identical to RabbitMQ defaults (a regular classic queue).
+
+   Note that as of RabbitMQ 3.8.2, an omitted `x-queue-type` is [considered to be identical](https://github.com/rabbitmq/rabbitmq-common/issues/341)
+   to `x-queue-type` set to `classic` by RabbitMQ server.
+
+
+   #### Enhancements
+
+    * Exchange type is now configurable via the `mq_exchange_type` config setting. Supported exchanges must be
+      compatible with topic exchanges (e.g. wrap it). Default value is `topic`.
+
+      This feature is limited to topic and delayed message exchange plugins and is mostly
+      useful for forward compatibility.
+
+      Contributed by Michael Bumann.
+
+      GitHub issue: [gocardless/hutch#349](https://github.com/gocardless/hutch/pull/349)
+
+
+## 0.28.0 (March 17, 2020)
+
+### Enhancements
+
+  * Add lazy and quorum options for queues.
+
+    GitHub issue: [gocardless/hutch#341](https://github.com/gocardless/hutch/pull/341)
+
+    Contributed by: Arthur Del Esposte
+
+  * Log level in the message publisher switched to DEBUG.
+
+    GitHub issue: [gocardless/hutch#343](https://github.com/gocardless/hutch/pull/343)
+
+    Contributed by: Codruț Constantin Gușoi
+
+### Documentation
+
+  * Add zeitwerk note to README.
+
+    GitHub issue: [gocardless/hutch#342](https://github.com/gocardless/hutch/pull/342)
+
+    Contributed by: Paolo Zaccagnini
+
+### CI
+
+  * Use jruby-9.2.9.0
+
+    GitHub issue: [gocardless/hutch#336](https://github.com/gocardless/hutch/pull/336)
+
+    Contributed by: Olle Jonsson
+
+## 0.27.0 (September 9th, 2019)
+
+### Enhancements
+
+ * Error handler for Rollback.
+
+   GitHub issue: [gocardless/hutch#332](https://github.com/gocardless/hutch/pull/332)
+
+   Contributed by Johan Kok.
+
+### Bug Fixes
+
+ * Allow for the latest ActiveSupport version.
+
+   GitHub issue: [gocardless/hutch#334](https://github.com/gocardless/hutch/pull/334)
+
+ * Signal tests are now skipped on JRuby.
+
+   Contributed by Olle Jonsson.
+
+   GitHub issue: [gocardless/hutch#326](https://github.com/gocardless/hutch/pull/326)
+
+### Dependency Bumps
+
+Bunny and other dependencies were updated to their latest release
+series.
+
+
+## 0.26.0 (February 13th, 2019)
+
+### Dependency Bumps
+
+Bunny and other dependencies were updated to their latest release
+series.
+
+### Synchronized Connection Code
+
+The methods that connect to RabbitMQ are now synchronized which makes
+them safer to use in concurrent settings. Note that Hutch still
+uses a single Bunny channel which is not meant to be shared
+between threads without application-level synchronization for publishing.
+
+Contributed by Chris Barton.
+
+GitHub issue: [#308](https://github.com/gocardless/hutch/pull/308).
+
+### More Bunny Options Propagated
+
+Contributed by Damian Le Nouaille.
+
+GitHub issue: [#322](https://github.com/gocardless/hutch/pull/322).
+
+### Removed Opbeat Integration
+
+The service is no longer generally available.
+
+Contributed by Olle Jonsson.
+
+GitHub issue: [#313](https://github.com/gocardless/hutch/pull/313)
+
+
+## 0.25.0 - January 17th, 2018
+
+### Consumer groups
+
+Consumer groups allow you to run groups of consumers together, rather than running them
+all at once in a single process. You define groups in your config file, and then specify
+a `--only-group` option when starting up Hutch with `hutch`.
+
+Contributed by Nickolai Smirnov.
+
+GitHub pull request: [#296](https://github.com/gocardless/hutch/pull/296)
+
+### Fix configuring Hutch with a URI
+
+When Hutch is configured to connect to RabbitMQ with a URI, we should respect the
+`amqps` specification, defaulting to the standard protocol ports when not specified.
+
+This means, for example, that `amqp://guest:guest@127.0.0.1/` connects to the server on
+port 5672 and does not use TLS, whereas `amqps://guest:guest@127.0.0.1/` connects to the
+server on port 5671 and uses TLS.
+
+This behaviour was introduced in [#159](https://github.com/gocardless/hutch/pull/159) but
+broken since then. This fixes it, and includes tests.
+
+Contributed by Michael Canden-Lennox.
+
+GitHub pull request: [#305](https://github.com/gocardless/hutch/pull/305)
+
+### Pass exceptions when setting up the client to configured error handlers
+
+When an error occurs during Hutch's startup, it is currently not passed to the configured
+error handlers. This starts handling those exceptions.
+
+Contributed by Valentin Krasontovitsch.
+
+GitHub issue: [#288](https://github.com/gocardless/hutch/issues/288)
+GitHub pull request: [#301](https://github.com/gocardless/hutch/pull/301)
+
+### Log the Rails environment when running Hutch in verbose mode
+
+When starting up Hutch in verbose mode with `hutch -v`, the Rails environment is now
+logged.
+
+Contributed by [@wppurking](https://github.com/wppurking).
+
+GitHub pull request: [#282](https://github.com/gocardless/hutch/pull/282)
+
+### Make the Honeybadger error handler compatible with new versions of `honeybadger-ruby`
+
+[`honeybadger-ruby`](https://github.com/honeybadger-io/honeybadger-ruby/)
+[changed](https://github.com/honeybadger-io/honeybadger-ruby/blob/master/CHANGELOG.md#300---2017-02-06)
+its API in v3.0.0. This updates our error handler to work with that, whilst still
+maintaining our existing behaviour.
+
+Contributed by Olle Jonsson and Bill Ruddock.
+
+GitHub pull requests: [#274](https://github.com/gocardless/hutch/pull/274),
+[#290](https://github.com/gocardless/hutch/pull/290)
 
 ## 0.24.0 — February 1st, 2017
 
@@ -20,7 +418,7 @@ Hutch will now handle several OS signals:
 
  * `USR2` will log stack traces of all alive VM threads
  * `QUIT` (except on JRuby), `INT`, `TERM` will cause Hutch daemon to shut down
- 
+
  Contributed by Olle Jonsson.
 
 GitHub issues: [#263](https://github.com/gocardless/hutch/pull/263), [#271](https://github.com/gocardless/hutch/pull/271)
@@ -104,7 +502,7 @@ Contributed by Seamus Abshere.
 
 ### Worker: Log received messages using level DEBUG instead of INFO
 
-Received messages used to be logged using severity level INFO. 
+Received messages used to be logged using severity level INFO.
 This has been lowered to DEBUG.
 
 Contributed by Jesper Josefsson.
@@ -636,4 +1034,3 @@ Hutch.global_properties = proc {
 ## 0.1.0 - September 9, 2013
 
 - Initial release
-

data/LICENSE

@@ -1,4 +1,5 @@
 Copyright (c) 2013-2016 GoCardless
+Copyright (c) 2016-2026 Hutch contributors
 
 Permission is hereby granted, free of charge, to any person
 obtaining a copy of this software and associated documentation