hutch 0.18.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: ae290b72e28ca5ca72f8014fe5688e35b4c31716
-  data.tar.gz: 2a817eece4ab761d6558255395e123d5cea19ea0
+SHA256:
+  metadata.gz: 74721c392b797963bf268ff65d638b888e11d43307446ed63bd3de14e36aa97e
+  data.tar.gz: 1ddb6053bd164c0332650169415ae9a20daa9724039be7765cc90aade1e0f304
 SHA512:
-  metadata.gz: b929abefa84452c0b5a74fc2dcfc5f2918fb752d80f97b77e97cf4d0fbfad99e119cd09f3251f17edf1450ee7ccc063a76efaa9e31d318526aabf5a147779b84
-  data.tar.gz: c5c04b649c3ea2333ff86273d7d17a1d843a02e782bd981d19ef2ea4025286761b4b96fd8200026ce2f503108d588c0aa61f204997632f02ac467ac5fa4633c3
+  metadata.gz: e690481212eeca9499f491b34c39e9f8e4f883f617063a5123bf1471e87b7f7251c52e0c92b103fe73dfa8db1859ad5feca76b6f0694ff68554191e66621f209
+  data.tar.gz: 043c203877a230f2d50c023a005ce84c7a7fc764c2b6ce3d452ab8aa143fa4175e4ba4bd54a4e2e611839360b2ec292d28c03ec338c92bbaa3b84e34b8a644f0

data/.gitignore

@@ -5,3 +5,6 @@ Gemfile.lock
 .ruby-gemset
 .idea
 coverage
+.yardoc
+doc
+gemfiles/Gemfile.*.lock

data/.rspec

@@ -0,0 +1 @@
+--order random

data/.travis.yml

@@ -1,11 +1,23 @@
+dist: bionic
+sudo: required
+
 language: ruby
-rvm:
-  - "2.2"
-  - "2.1"
-  - "2.0"
-  - "jruby-9.0.0.0"
-services:
-  - rabbitmq
+cache: bundler
+before_install:
+  - gem install bundler
+before_script:
+  - "./bin/ci/install_on_debian.sh"
+  - until sudo lsof -i:5672; do echo "Waiting for RabbitMQ to start..."; sleep 1; done
+  - "./bin/ci/before_build.sh"
 matrix:
+  include:
+    - rvm: "3.0.0"  
+    - rvm: "2.7.1"
+    - rvm: "2.6.6"
+    - rvm: "2.5.8"
+    - rvm: "jruby-9.2.19.0"
+      name: "Latest JRuby"
+    - rvm: "ruby-head"
   allow_failures:
-    - rvm: jruby-9.0.0.0
+    - name: "Latest JRuby"
+    - rvm: ruby-head

data/.yardopts

@@ -0,0 +1,5 @@
+--load "./lib/yard-settings/yard-settings.rb"
+--title "Hutch API docs"
+-
+README.md
+

data/CHANGELOG.md

@@ -1,4 +1,469 @@
-## 0.18.0 — (unreleased)
+## 1.1.0 (July 26th, 2021)
+
+### Bugsnag Error Handler
+
+Contributed by @ivanhuang1.
+
+GitHub issue: [#362](https://github.com/ruby-amqp/hutch/pull/362)
+
+### 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)
+
+
+## 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
+
+### Configurable Consumer Prefixes
+
+Hutch consumers now can use user-provided prefixes for consumer tags.
+
+Contributed by Dávid Lantos.
+
+GitHub issue: [#265](https://github.com/gocardless/hutch/pull/265)
+
+### Signal Handling in Workers
+
+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)
+
+### Opbeat Tracer
+
+Hutch now provides a tracer implementation for [Opbeat](https://opbeat.com/).
+
+Contributed by Olle Jonsson.
+
+GitHub issue: [#262](https://github.com/gocardless/hutch/pull/262)
+
+### `HUTCH_URI` Support
+
+The `HUTCH_URI` environment variable now can be used to configure
+Hutch connection URI.
+
+Contributed by Sam Stickland.
+
+GitHub issue: [#270](https://github.com/gocardless/hutch/pull/270)
+
+
+## 0.23.1 — October 20th, 2016
+
+This release contains a **breaking change** in the error
+handlers interface.
+
+### All Message Properties Passed to Error Handlers
+
+Previously error handlers were provided a message ID as first
+argument to `ErrorHandler#handle`. Now it is a hash of all message
+properties.
+
+This is a **breaking public API change**. If you do not use custom
+error handlers, you are not affected.
+
+Contributed by Pierre-Louis Gottfrois.
+
+GH issue: [hutch#238](https://github.com/gocardless/hutch/pull/238)
+
+### Opbeat Error Handler
+
+Contributed by Olle Jonsson.
+
+
+## 0.22.1 — June 7th, 2016
+
+### Message Payload is Reported to Sentry
+
+Contributed by Matt Thompson.
+
+### Daemonization Flag Ignored on JRuby
+
+Hutch will no longer try to daemonize its process on JRuby
+(since it is not supported) and will emit a warning instead.
+
+Contributed by Olle Jonsson.
+
+### Custom Setup Steps in Hutch::Worker
+
+`Hutch::Worker` now accepts a list of callables that are invoked
+after queue setup.
+
+Contributed by Kelly Stannard.
+
+### More Flexible and Better Abstracted Hutch::Broker
+
+`Hutch::Broker` was refactored with some bits extracted into separate
+classes or methods, making them easier to override.
+
+Contributed by Aleksandar Ivanov and Ryan Hosford.
+
+### Configurable Consumer Thread Pool Exception Handling (MRI only)
+
+`:consumer_pool_abort_on_exception` is a new option
+(defaults to `false`) which defines whether Bunny's
+consumer work pool threads should abort on exception.
+The option is ignored on JRuby.
+
+Contributed by Seamus Abshere.
+
+### Worker: Log received messages using level DEBUG instead of INFO
+
+Received messages used to be logged using severity level INFO.
+This has been lowered to DEBUG.
+
+Contributed by Jesper Josefsson.
+
+### Refactoring
+
+Olle Jonsson and Kelly Stannard have contributed
+multiple internal improvements that have no behaviour changes.
+
+
+## 0.21.0 — February 7th, 2016
+
+### JRuby Compatibility Restored
+
+Contributed by Jesper Josefsson.
+
+### More Reliable Rails app Detection
+
+Rails application detection now won't produce false positives
+for applications that include `config/environment.rb`. Instead,
+`bin/rails` and `script/rails` are used.
+
+Contributed by @bisusubedi.
+
+### Refactoring
+
+Contributed by Jesper Josefsson and Olle Jonsson.
+
+
+## 0.20.0 — November 16th, 2015
+
+### Hutch::Exception includes Bunny::Exception
+
+`Hutch::Exception` now inherits from `Bunny::Exception` which
+inherits from `StandardError`.
+
+GH issue: [#137](https://github.com/gocardless/hutch/issues/137).
+
+
+### Pluggable (Negative) Acknowledge Handlers
+
+Hutch now can be configured to use a user-provided
+object(s) to perform acknowledgement on consumer exceptions.
+
+For example, this is what the default handler looks like:
+
+``` ruby
+require 'hutch/logging'
+require 'hutch/acknowledgements/base'
+
+module Hutch
+  module Acknowledgements
+    class NackOnAllFailures < Base
+      include Logging
+
+      def handle(delivery_info, properties, broker, ex)
+        prefix = "message(#{properties.message_id || '-'}): "
+        logger.debug "#{prefix} nacking message"
+
+        broker.nack(delivery_info.delivery_tag)
+
+        # terminates further chain processing
+        true
+      end
+    end
+  end
+end
+```
+
+Handlers are configured similarly to exception notification handlers,
+via `:error_acknowledgements` in Hutch config.
+
+Contributed by Derek Kastner.
+
+GH issue: [#177](https://github.com/gocardless/hutch/pull/177).
+
+
+### Configurable Exchange Properties
+
+`:mq_exchange_options` is a new config option that can be used
+to provide a hash of exchange attributes (durable, auto-delete).
+The options will be passed directly to Bunny (or March Hare, when
+running on JRuby).
+
+Contributed by Derek Kastner.
+
+GH issue: [#170](https://github.com/gocardless/hutch/pull/170).
+
+
+### Bunny Update
+
+Bunny is updated to 2.2.1.
+
+
+## 0.19.0 — September 7th, 2015
+
+### Pluggable Serialisers
+
+Hutch now supports pluggable serialisers: see `Hutch::Serializer::JSON` for
+an example. Serialiser is configured via Hutch config as a Ruby
+class.
+
+Contributed by Dmitry Galinsky.
+
+
+### multi_json Update
+
+Hutch now depends on multi_json `1.11.x`.
+
+### Bunny Update
+
+Bunny is updated to [2.2.0](http://blog.rubyrabbitmq.info/blog/2015/09/06/bunny-2-dot-2-0-is-released/).
+
+### More Bunny SSL Options
+
+`:mq_tls_ca_certificates` and `:mq_verify_peer` options will now be passed on to Bunny as `:tls_ca_certificates` and `:verify_peer` respectively.
+
+Contributed by Kennon Ballou.
+
+## 0.18.0 — August 16th, 2015
 
 ### JRuby Support (Using March Hare)
 
@@ -410,4 +875,3 @@ Hutch.global_properties = proc {
 ## 0.1.0 - September 9, 2013
 
 - Initial release
-

data/Gemfile

@@ -1,19 +1,33 @@
 source 'https://rubygems.org'
 
+ruby '>= 2.3.0'
+
 gemspec
 
 group :development do
   gem "rake"
-  gem "guard", "~> 0.8.8"
-  gem "guard-rspec", "~> 0.5.4"
+  gem "guard", "~> 2.14", platform: :mri_23
+  gem "guard-rspec", "~> 4.7", platform: :mri_23
+
+  gem "yard", "~> 0.9"
+  gem 'kramdown', "> 0", platform: :jruby
+  gem "redcarpet", "> 0", platform: :mri
+  gem "github-markup", "> 0"
 end
 
 group :development, :test do
+  gem "rspec", "~> 3.5"
+  gem "simplecov", "~> 0.12"
+
   gem "sentry-raven"
+  gem "sentry-ruby"
   gem "honeybadger"
-  gem "coveralls", require: false
+  gem "coveralls", "~> 0.8.15", require: false
   gem "newrelic_rpm"
-  gem "airbrake"
+  gem "ddtrace"
+  gem "airbrake", "~> 10.0"
+  gem "rollbar"
+  gem "bugsnag"
 end
 
 group :development, :darwin do

data/Guardfile

@@ -1,5 +1,14 @@
-guard 'rspec', :version => 2, :cli => '--color --format doc' do
-  watch(%r{^spec/.+_spec\.rb$})
-  watch(%r{^lib/(.+)\.rb$}) { |m| "spec/#{m[1]}_spec.rb" }
-  watch('spec/spec_helper.rb') { "spec" }
+guard :rspec, cmd: "bundle exec rspec" do
+  require "guard/rspec/dsl"
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
 end

data/LICENSE

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