hutch 0.25.0-java → 2.0.0-java

data/spec/integration/channel_recovery_spec.rb

@@ -0,0 +1,187 @@
+require 'spec_helper'
+
+# Channel recovery is bunny-only, see MarchHareAdapter#install_channel_recovery
+return if defined?(JRUBY_VERSION)
+require 'hutch/broker'
+require 'hutch/worker'
+require 'hutch/consumer'
+require 'bunny'
+require 'json'
+require 'securerandom'
+
+describe 'channel recovery after delivery acknowledgement timeout', rabbitmq: true, adapter: :bunny do
+  CONSUMER_TIMEOUT_MS = 5_000
+  # A 4.3 quorum queue times the consumer out on its own timer, which fires at
+  # the deadline. Earlier series detect it from the channel tick instead, and
+  # `channel_tick_interval` defaults to 60s, so detection lags by up to that much.
+  BLOCKED_HANDLER_SECONDS = 20
+  BLOCKED_HANDLER_SECONDS_BEFORE_4_3 = 100
+
+  let(:log) { StringIO.new }
+  let(:logger) { Logger.new(log) }
+  let(:exchange_name) { "hutch.integration.exchange.#{SecureRandom.hex(4)}" }
+  let(:queue_name) { "hutch.integration.queue.#{SecureRandom.hex(4)}" }
+  let(:routing_key) { "hutch.integration.key.#{SecureRandom.hex(4)}" }
+
+  let(:processed) { [] }
+  let(:processed_lock) { Mutex.new }
+  let(:timed_out_once) { [false] }
+
+  let(:server_version) do
+    Gem::Version.new(publisher.server_properties['version'].to_s[/\A\d+(\.\d+)*/])
+  end
+
+  let(:blocked_handler_seconds) do
+    if server_version >= Gem::Version.new('4.3')
+      BLOCKED_HANDLER_SECONDS
+    else
+      BLOCKED_HANDLER_SECONDS_BEFORE_4_3
+    end
+  end
+
+  let(:consumer_class) do
+    msgs = processed
+    lock = processed_lock
+    rk = routing_key
+    qn = queue_name
+    timed_out = timed_out_once
+    blocked = blocked_handler_seconds
+
+    Class.new do
+      include Hutch::Consumer
+
+      consume rk
+      queue_name qn
+      arguments(
+        'x-queue-type' => 'quorum',
+        'x-consumer-timeout' => CONSUMER_TIMEOUT_MS
+      )
+
+      # Both `CONSUMER_TIMEOUT_MS` and this sleep run from the same delivery,
+      # so the margin between them does not shrink on a loaded machine.
+      define_method(:process) do |message|
+        if message['id'] == 'trigger-timeout' && !timed_out[0]
+          timed_out[0] = true
+          sleep blocked
+        end
+
+        lock.synchronize { msgs << message['id'] }
+      end
+    end
+  end
+
+  let(:broker) { Hutch::Broker.new }
+  let(:worker) { Hutch::Worker.new(broker, [consumer_class], []) }
+
+  let(:publisher) do
+    Bunny.new(
+      host: Hutch::Config[:mq_host],
+      port: Hutch::Config[:mq_port],
+      username: Hutch::Config[:mq_username],
+      password: Hutch::Config[:mq_password],
+      vhost: Hutch::Config[:mq_vhost]
+    ).tap(&:start)
+  end
+
+  let(:publisher_channel) { publisher.create_channel }
+  let(:exchange) { publisher_channel.topic(exchange_name, durable: true) }
+
+  before do
+    Hutch::Logging.logger = logger
+    Hutch::Config.set(:mq_exchange, exchange_name)
+    Hutch::Config.set(:force_publisher_confirms, false)
+    Hutch::Config.set(:client_logger, logger)
+    # Channel replacement waits this long for the deliberately blocked
+    # handler: the default of 11s would use up most of the consumption window.
+    @graceful_exit_timeout = Hutch::Config[:graceful_exit_timeout]
+    Hutch::Config.set(:graceful_exit_timeout, 1)
+  end
+
+  after do
+    publisher_channel.close rescue nil
+    publisher.close rescue nil
+    broker.disconnect rescue nil
+    Hutch::Config.set(:graceful_exit_timeout, @graceful_exit_timeout)
+    Hutch::Logging.logger = Logger.new(File::NULL)
+  end
+
+  def wait_for(timeout, label, &condition)
+    await_condition(timeout, label, &condition)
+  rescue AwaitHelpers::ConditionTimeout => e
+    raise <<~MSG
+      #{e.message}
+
+      processed_messages=#{processed_messages.inspect}
+      channel_open=#{broker.channel.open? rescue 'unknown'}
+      channel_closed=#{broker.channel.closed? rescue 'unknown'}
+
+      log output:
+      #{log_output}
+    MSG
+  end
+
+  def processed_messages
+    processed_lock.synchronize { processed.dup }
+  end
+
+  # `StringIO#string` does not touch the stream position: a rewind here would
+  # race with the worker threads that log concurrently and corrupt the buffer.
+  def log_output
+    log.string
+  end
+
+  def publish_message(id)
+    exchange.publish(
+      JSON.dump('id' => id),
+      routing_key: routing_key,
+      content_type: 'application/json',
+      persistent: true
+    )
+  end
+
+  # RabbitMQ up to 4.2 closes the channel on a delivery acknowledgement
+  # timeout; 4.3+ quorum queues instead cancel only the timed out consumer.
+  let(:cancels_the_consumer) { server_version >= Gem::Version.new('4.3') }
+
+  let(:recovery_log_pattern) do
+    if cancels_the_consumer
+      /cancelled by the server, re-subscribing/i
+    else
+      /delivery acknowledgement on channel \d+ timed out/i
+    end
+  end
+
+  # Replacing the channel requeues what the cancelled consumer still held, so
+  # consumption resumes at once. Reopening one does not, so it resumes at the
+  # next consumer timeout tick.
+  let(:recovery_seconds) { cancels_the_consumer ? 15 : 90 }
+
+  # This spec is intentionally slow because RabbitMQ enforces delivery
+  # acknowledgement timeouts periodically on a timer, not immediately at the deadline.
+  it 're-subscribes and consumes later messages after RabbitMQ times out an unacknowledged delivery' do
+    broker.connect
+    worker.setup_queues
+
+    publish_message('trigger-timeout')
+
+    wait_for(240, 'a delivery acknowledgement timeout to close the channel or cancel the consumer') do
+      log_output.match?(recovery_log_pattern)
+    end
+
+    publish_message('after-recovery')
+
+    wait_for(recovery_seconds, 'after-recovery message consumption') do
+      processed_messages.include?('after-recovery')
+    end
+
+    expect(log_output).to match(recovery_log_pattern)
+
+    # A consumed message proves the recovery finished, the publisher rebuild
+    # included.
+    broker.publish(routing_key, 'id' => 'published-after-recovery')
+
+    wait_for(15, 'published-after-recovery message consumption') do
+      processed_messages.include?('published-after-recovery')
+    end
+  end
+end

data/spec/integration/publish_consume_spec.rb

@@ -0,0 +1,47 @@
+require 'spec_helper'
+require 'hutch/broker'
+require 'hutch/worker'
+require 'hutch/consumer'
+require 'securerandom'
+
+describe 'publishing and consuming messages', rabbitmq: true, adapter: :bunny do
+  let(:exchange_name) { "hutch.test.#{SecureRandom.hex(4)}" }
+  let(:routing_key) { "test.message" }
+  let(:received) { [] }
+
+  let(:consumer_class) do
+    msgs = received
+    rk = routing_key
+    qn = "test_consumer_#{SecureRandom.hex(4)}"
+
+    Class.new do
+      include Hutch::Consumer
+      consume rk
+      queue_name qn
+
+      define_method(:process) { |message| msgs << message.body }
+    end
+  end
+
+  let(:broker) { Hutch::Broker.new }
+  let(:worker) { Hutch::Worker.new(broker, [consumer_class], []) }
+
+  before do
+    Hutch::Config.set(:mq_exchange, exchange_name)
+  end
+
+  after do
+    broker.disconnect rescue nil
+  end
+
+  it 'publishes and consumes a message' do
+    broker.connect
+    worker.setup_queues
+
+    broker.publish(routing_key, { test: 'data' })
+
+    await_condition(15, 'message consumption') { received.any? }
+
+    expect(received.first).to eq('test' => 'data')
+  end
+end

metadata

@@ -1,100 +1,71 @@
 --- !ruby/object:Gem::Specification
 name: hutch
 version: !ruby/object:Gem::Version
-  version: 0.25.0
+  version: 2.0.0
 platform: java
 authors:
 - Harry Marr
-autorequire:
+- Michael Klishin
 bindir: bin
 cert_chain: []
-date: 2018-01-17 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
+  name: march_hare
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.0
-  name: march_hare
-  prerelease: false
+        version: 4.7.0
   type: :runtime
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: 4.7.0
 - !ruby/object:Gem::Dependency
+  name: carrot-top
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.0.7
-  name: carrot-top
-  prerelease: false
   type: :runtime
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.0.7
-- !ruby/object:Gem::Dependency
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.12'
-  name: multi_json
   prerelease: false
-  type: :runtime
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.12'
+        version: 0.0.7
 - !ruby/object:Gem::Dependency
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '4.2'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '6'
-  name: activesupport
-  prerelease: false
   type: :runtime
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '4.2'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '6'
 description: Hutch is a Ruby library for enabling asynchronous inter-service communication
-  using RabbitMQ.
-email:
-- developers@gocardless.com
+  using RabbitMQ
 executables:
 - hutch
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".rspec"
-- ".travis.yml"
-- ".yardopts"
 - CHANGELOG.md
-- Gemfile
-- Guardfile
 - LICENSE
 - README.md
-- Rakefile
+- bin/ci/before_build.sh
+- bin/ci/before_build_docker.sh
+- bin/ci/install_on_debian.sh
 - bin/hutch
-- examples/consumer.rb
-- examples/producer.rb
-- hutch.gemspec
 - lib/hutch.rb
 - lib/hutch/acknowledgements/base.rb
 - lib/hutch/acknowledgements/nack_on_all_failures.rb
@@ -108,9 +79,10 @@ files:
 - lib/hutch/error_handlers.rb
 - lib/hutch/error_handlers/airbrake.rb
 - lib/hutch/error_handlers/base.rb
+- lib/hutch/error_handlers/bugsnag.rb
 - lib/hutch/error_handlers/honeybadger.rb
 - lib/hutch/error_handlers/logger.rb
-- lib/hutch/error_handlers/opbeat.rb
+- lib/hutch/error_handlers/rollbar.rb
 - lib/hutch/error_handlers/sentry.rb
 - lib/hutch/exceptions.rb
 - lib/hutch/logging.rb
@@ -119,9 +91,9 @@ files:
 - lib/hutch/serializers/identity.rb
 - lib/hutch/serializers/json.rb
 - lib/hutch/tracers.rb
+- lib/hutch/tracers/datadog.rb
 - lib/hutch/tracers/newrelic.rb
 - lib/hutch/tracers/null_tracer.rb
-- lib/hutch/tracers/opbeat.rb
 - lib/hutch/version.rb
 - lib/hutch/waiter.rb
 - lib/hutch/worker.rb
@@ -132,18 +104,20 @@ files:
 - spec/hutch/config_spec.rb
 - spec/hutch/consumer_spec.rb
 - spec/hutch/error_handlers/airbrake_spec.rb
+- spec/hutch/error_handlers/bugsnag_spec.rb
 - spec/hutch/error_handlers/honeybadger_spec.rb
 - spec/hutch/error_handlers/logger_spec.rb
-- spec/hutch/error_handlers/opbeat_spec.rb
+- spec/hutch/error_handlers/rollbar_spec.rb
 - spec/hutch/error_handlers/sentry_spec.rb
 - spec/hutch/logger_spec.rb
 - spec/hutch/message_spec.rb
 - spec/hutch/serializers/json_spec.rb
+- spec/hutch/tracers/datadog_spec.rb
 - spec/hutch/waiter_spec.rb
 - spec/hutch/worker_spec.rb
 - spec/hutch_spec.rb
-- spec/spec_helper.rb
-- spec/tracers/opbeat_spec.rb
+- spec/integration/channel_recovery_spec.rb
+- spec/integration/publish_consume_spec.rb
 - templates/default/class/html/settings.erb
 - templates/default/class/setup.rb
 - templates/default/fulldoc/html/css/hutch.css
@@ -153,11 +127,10 @@ files:
 - templates/default/method_details/text/settings.erb
 - templates/default/module/html/settings.erb
 - templates/default/module/setup.rb
-homepage: https://github.com/gocardless/hutch
+homepage: https://github.com/ruby-amqp/hutch
 licenses:
 - MIT
 metadata: {}
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -165,33 +138,33 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.2'
+      version: '3.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project:
-rubygems_version: 2.6.13
-signing_key:
+rubygems_version: 4.0.16
 specification_version: 4
-summary: Easy inter-service communication using RabbitMQ.
+summary: Opinionated asynchronous inter-service communication using RabbitMQ
 test_files:
 - spec/hutch/broker_spec.rb
 - spec/hutch/cli_spec.rb
 - spec/hutch/config_spec.rb
 - spec/hutch/consumer_spec.rb
 - spec/hutch/error_handlers/airbrake_spec.rb
+- spec/hutch/error_handlers/bugsnag_spec.rb
 - spec/hutch/error_handlers/honeybadger_spec.rb
 - spec/hutch/error_handlers/logger_spec.rb
-- spec/hutch/error_handlers/opbeat_spec.rb
+- spec/hutch/error_handlers/rollbar_spec.rb
 - spec/hutch/error_handlers/sentry_spec.rb
 - spec/hutch/logger_spec.rb
 - spec/hutch/message_spec.rb
 - spec/hutch/serializers/json_spec.rb
+- spec/hutch/tracers/datadog_spec.rb
 - spec/hutch/waiter_spec.rb
 - spec/hutch/worker_spec.rb
 - spec/hutch_spec.rb
-- spec/spec_helper.rb
-- spec/tracers/opbeat_spec.rb
+- spec/integration/channel_recovery_spec.rb
+- spec/integration/publish_consume_spec.rb

data/.gitignore

@@ -1,10 +0,0 @@
-.bundle
-hutch-*.gem
-Gemfile.lock
-.ruby-version
-.ruby-gemset
-.idea
-coverage
-.yardoc
-doc
-gemfiles/Gemfile.*.lock

data/.rspec

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

data/.travis.yml

@@ -1,16 +0,0 @@
-language: ruby
-cache: bundler
-before_install:
-  - gem install bundler
-matrix:
-  include:
-    - rvm: 2.4.2
-    - rvm: 2.3.5
-    - rvm: 2.2.8
-    - rvm: jruby-9.1.15.0
-      jdk: oraclejdk8
-      env:
-        - JRUBY_OPTS='--debug'
-
-services:
-  - rabbitmq

data/.yardopts

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

data/Gemfile

@@ -1,33 +0,0 @@
-source 'https://rubygems.org'
-
-ruby RUBY_VERSION
-
-gemspec
-
-group :development do
-  gem "rake"
-  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 "honeybadger"
-  gem "coveralls", "~> 0.8.15", require: false
-  gem "newrelic_rpm"
-  gem "airbrake", "~> 7.0"
-  gem "opbeat", "~> 3.0.9"
-end
-
-group :development, :darwin do
-  gem "rb-fsevent", "~> 0.9"
-  gem "growl", "~> 1.0.3"
-end

data/Guardfile

@@ -1,14 +0,0 @@
-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/Rakefile

@@ -1,21 +0,0 @@
-require 'rspec/core/rake_task'
-
-desc "Run an IRB session with Hutch pre-loaded"
-task :console do
-  exec "irb -I lib -r hutch"
-end
-
-desc "Run the test suite"
-RSpec::Core::RakeTask.new(:spec) do |t|
-  t.pattern = FileList['spec/**/*_spec.rb']
-  t.rspec_opts = %w(--color --format doc)
-end
-
-task default: :spec
-
-#
-# Re-generate API docs
-#
-require 'yard'
-require 'yard/rake/yardoc_task'
-YARD::Rake::YardocTask.new

data/examples/consumer.rb

@@ -1,13 +0,0 @@
-require 'hutch'
-
-class TestConsumer
-  include Hutch::Consumer
-  consume 'hutch.test'
-
-  def process(message)
-    puts "TestConsumer got a message: #{message}"
-    puts "Processing..."
-    sleep(1)
-    puts "Done"
-  end
-end

data/examples/producer.rb

@@ -1,10 +0,0 @@
-require 'hutch'
-
-Hutch.connect
-loop do
-  print "Press return to send test message..."
-  gets
-  Hutch.publish('hutch.test', subject: 'test message')
-  puts "Send message with routing key 'hutch.test'"
-end
-

data/hutch.gemspec

@@ -1,29 +0,0 @@
-require File.expand_path('../lib/hutch/version', __FILE__)
-
-Gem::Specification.new do |gem|
-  if defined?(JRUBY_VERSION)
-    gem.platform = 'java'
-    gem.add_runtime_dependency 'march_hare', '>= 3.0.0'
-  else
-    gem.platform = Gem::Platform::RUBY
-    gem.add_runtime_dependency 'bunny', '~> 2.9.0'
-  end
-  gem.add_runtime_dependency 'carrot-top', '~> 0.0.7'
-  gem.add_runtime_dependency 'multi_json', '~> 1.12'
-  gem.add_runtime_dependency 'activesupport', '>= 4.2', '< 6'
-
-  gem.name = 'hutch'
-  gem.summary = 'Easy inter-service communication using RabbitMQ.'
-  gem.description = 'Hutch is a Ruby library for enabling asynchronous ' \
-                    'inter-service communication using RabbitMQ.'
-  gem.version = Hutch::VERSION.dup
-  gem.required_ruby_version = '>= 2.2'
-  gem.authors = ['Harry Marr']
-  gem.email = ['developers@gocardless.com']
-  gem.homepage = 'https://github.com/gocardless/hutch'
-  gem.require_paths = ['lib']
-  gem.license = 'MIT'
-  gem.executables = ['hutch']
-  gem.files = `git ls-files`.split("\n")
-  gem.test_files = `git ls-files -- spec/*`.split("\n")
-end

data/lib/hutch/tracers/opbeat.rb

@@ -1,37 +0,0 @@
-require 'opbeat'
-
-module Hutch
-  module Tracers
-    # Tracer for Opbeat, which traces each message processed.
-    class Opbeat
-      KIND = 'messaging.hutch'.freeze
-
-      # @param klass [Consumer] Consumer instance (!)
-      def initialize(klass)
-        @klass = klass
-      end
-
-      # @param message [Message]
-      def handle(message)
-        ::Opbeat.transaction(sig, KIND, extra: extra_from(message)) do
-          @klass.process(message)
-        end.done(true)
-      end
-
-      private
-
-      def sig
-        @klass.class.name
-      end
-
-      def extra_from(message)
-        {
-          body: message.body.to_s,
-          message_id: message.message_id,
-          timestamp: message.timestamp,
-          routing_key: message.routing_key
-        }
-      end
-    end
-  end
-end

data/spec/hutch/error_handlers/opbeat_spec.rb

@@ -1,37 +0,0 @@
-require 'spec_helper'
-
-describe Hutch::ErrorHandlers::Opbeat do
-  let(:error_handler) { Hutch::ErrorHandlers::Opbeat.new }
-
-  describe '#handle' do
-    let(:properties) { OpenStruct.new(message_id: "1") }
-    let(:payload) { "{}" }
-    let(:error) do
-      begin
-        raise "Stuff went wrong"
-      rescue RuntimeError => err
-        err
-      end
-    end
-
-    it "logs the error to Opbeat" do
-      expect(Opbeat).to receive(:report).with(error, extra: { payload: payload })
-      error_handler.handle(properties, payload, double, error)
-    end
-  end
-
-  describe '#handle_setup_exception' do
-    let(:error) do
-      begin
-        raise "Stuff went wrong during setup"
-      rescue RuntimeError => err
-        err
-      end
-    end
-
-    it "logs the error to Opbeat" do
-      expect(Opbeat).to receive(:report).with(error)
-      error_handler.handle_setup_exception(error)
-    end
-  end
-end