hutch 0.28.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 587ca7c6e7515a0efcf8999a5ad3bfc1ef186a701a758260f68abb528641b7cd
-  data.tar.gz: 7f4353919efb856a7ef9af3dc71e7d2024aaa85c1183da3a191bbbf2c22a8492
+  metadata.gz: 626b85f02b69ee2113376ff382173fd124cdcae1bdc404f0681874e76a80310e
+  data.tar.gz: 3d1d6a2cd275b1c2d72d4842841ad90f70145cabe6800ff3860b206aebf0308e
 SHA512:
-  metadata.gz: 9c00226f20383fc7ec3503197783a48e0d8f153dd7e45ea7d89dda7631f2e527f71b6d15182be677d24818e1ce1cfcf6766765ad6a0e67b753b76cc145b46782
-  data.tar.gz: 530af1729a20c10d555bac21529d18c94cb07b1957ce2b6c5386adede9e400c7f7f400491c7c716378fd4fc8d8a955d2537e956dc6d6994aab5fc3cd2f2b5970
+  metadata.gz: c1b0c80bf6362b0cfbc6f54b3257c74549c6d927fbae3bcaecb50aeb4ed0f28e01466a6a3013ce9175f55eb481b2e9378f89954edcc1453753da00b76873c766
+  data.tar.gz: 4c346421c5c1fa49440866b56486cc75d68c3eed8c3014ae2f51e2643f40a59b084634248b52d32965b65f692d1560250a8f5add30c4b75b2f541c895574aa26

data/.travis.yml

@@ -11,9 +11,10 @@ before_script:
   - "./bin/ci/before_build.sh"
 matrix:
   include:
-    - rvm: "2.6.4"
-    - rvm: "2.5.6"
-    - rvm: "2.4.7"
+    - rvm: "2.7.1"
+    - rvm: "2.6.6"
+    - rvm: "2.5.8"
+    - rvm: "2.4.10"
     - rvm: "2.3.8"
     - rvm: "jruby-9.2.9.0"
     - rvm: "ruby-head"

data/CHANGELOG.md

@@ -1,4 +1,76 @@
-## 0.28.0 (under development)
+## 1.0.1 (in development)
+
+No changes yet.
+
+## 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 `` 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
 

data/LICENSE

@@ -1,4 +1,5 @@
 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

data/hutch.gemspec

@@ -6,7 +6,7 @@ Gem::Specification.new do |gem|
     gem.add_runtime_dependency 'march_hare', '>= 3.0.0'
   else
     gem.platform = Gem::Platform::RUBY
-    gem.add_runtime_dependency 'bunny', '>= 2.14', '< 2.16'
+    gem.add_runtime_dependency 'bunny', '>= 2.15', '< 2.16'
   end
   gem.add_runtime_dependency 'carrot-top', '~> 0.0.7'
   gem.add_runtime_dependency 'multi_json', '~> 1.14'

data/lib/hutch/broker.rb

@@ -122,11 +122,12 @@ module Hutch
 
     def declare_exchange(ch = channel)
       exchange_name = @config[:mq_exchange]
+      exchange_type = @config[:mq_exchange_type]
       exchange_options = { durable: true }.merge(@config[:mq_exchange_options])
       logger.info "using topic exchange '#{exchange_name}'"
 
       with_bunny_precondition_handler('exchange') do
-        ch.topic(exchange_name, exchange_options)
+        Bunny::Exchange.new(ch, exchange_type, exchange_name, exchange_options)
       end
     end
 

data/lib/hutch/config.rb

@@ -49,6 +49,9 @@ module Hutch
     # RabbitMQ Exchange to use for publishing
     string_setting :mq_exchange, 'hutch'
 
+    # RabbitMQ Exchange type to use for publishing
+    string_setting :mq_exchange_type, 'topic'
+
     # RabbitMQ vhost to use
     string_setting :mq_vhost, '/'
 

data/lib/hutch/consumer.rb

@@ -29,8 +29,9 @@ module Hutch
       # wants to subscribe to.
       def consume(*routing_keys)
         @routing_keys = self.routing_keys.union(routing_keys)
-        @queue_mode = 'default'
-        @queue_type = 'classic'
+        # these are opt-in
+        @queue_mode = nil
+        @queue_type = nil
       end
 
       attr_reader :queue_mode, :queue_type, :initial_group_size
@@ -45,6 +46,11 @@ module Hutch
         @queue_mode = 'lazy'
       end
 
+      # Explicitly set the queue type to 'classic'
+      def classic_queue
+        @queue_type = 'classic'
+      end
+
       # Explicitly set the queue type to 'quorum'
       # @param [Hash] options the options params related to quorum queue
       # @option options [Integer] :initial_group_size Initial Replication Factor
@@ -53,7 +59,8 @@ module Hutch
         @initial_group_size = options[:initial_group_size]
       end
 
-      # Allow to specify custom arguments that will be passed when creating the queue.
+      # Configures an optional argument that will be passed when declaring the queue.
+      # Prefer using a policy to this DSL: https://www.rabbitmq.com/parameters.html#policies
       def arguments(arguments = {})
         @arguments = arguments
       end
@@ -76,11 +83,11 @@ module Hutch
       # Returns consumer custom arguments.
       def get_arguments
         all_arguments = @arguments || {}
-        all_arguments['x-queue-mode'] = @queue_mode
-        all_arguments['x-queue-type'] = @queue_type
-        if @initial_group_size
-          all_arguments['x-quorum-initial-group-size'] = @initial_group_size
-        end
+
+        all_arguments['x-queue-mode'] = @queue_mode if @queue_mode
+        all_arguments['x-queue-type'] = @queue_type if @queue_type
+        all_arguments['x-quorum-initial-group-size'] = @initial_group_size if @initial_group_size
+
         all_arguments
       end
 

data/lib/hutch/version.rb

@@ -1,3 +1,3 @@
 module Hutch
-  VERSION = '0.28.0'.freeze
+  VERSION = '1.0.0'.freeze
 end

data/spec/hutch/consumer_spec.rb

@@ -28,17 +28,30 @@ describe Hutch::Consumer do
     ComplexConsumer
   end
 
-  let(:consumer_with_custom_queue_options) do
-    unless defined? ConsumerWithCustomQueueOptions
-      class ConsumerWithCustomQueueOptions
+  let(:consumer_using_quorum_queue) do
+    unless defined? ConsumerUsingQuorumQueue
+      class ConsumerUsingQuorumQueue
         include Hutch::Consumer
         consume 'hutch.test1'
         arguments foo: :bar
-        lazy_queue
+        
         quorum_queue
       end
     end
-    ConsumerWithCustomQueueOptions
+    ConsumerUsingQuorumQueue
+  end
+
+  let(:consumer_using_classic_queue) do
+    unless defined? ConsumerUsingLazyQueue
+      class ConsumerUsingLazyQueue
+        include Hutch::Consumer
+        consume 'hutch.test1'
+        arguments foo: :bar
+        lazy_queue
+        classic_queue
+      end
+    end
+    ConsumerUsingLazyQueue
   end
 
   describe 'module inclusion' do
@@ -84,26 +97,33 @@ describe Hutch::Consumer do
     end
   end
 
-  describe '.lazy_queue' do
-    it 'does not use lazy mode by default' do
-      expect(simple_consumer.queue_mode).to eq('default')
+  describe 'default queue mode' do
+    it 'does not specify any mode by default' do
+      expect(simple_consumer.queue_mode).to eq(nil)
+      expect(simple_consumer.queue_type).to eq(nil)
     end
+  end
 
+  describe '.lazy_queue' do
     context 'when queue mode has been set explicitly to lazy' do
       it 'sets queue mode to lazy' do
-        expect(consumer_with_custom_queue_options.queue_mode).to eq('lazy')
+        expect(consumer_using_classic_queue.queue_mode).to eq('lazy')
       end
     end
   end
 
-  describe '.quorum_queue' do
-    it 'does not have quorum type by default' do
-      expect(simple_consumer.queue_type).to eq('classic')
+  describe '.classic_queue' do
+    context 'when queue type has been set explicitly to classic' do
+      it 'sets queue type to classic' do
+        expect(consumer_using_classic_queue.queue_type).to eq('classic')
+      end
     end
+  end
 
+  describe '.quorum_queue' do
     context 'when queue type has been set explicitly to quorum' do
       it 'sets queue type to quorum' do
-        expect(consumer_with_custom_queue_options.queue_type).to eq('quorum')
+        expect(consumer_using_quorum_queue.queue_type).to eq('quorum')
       end
 
       it 'accepts initial group size as an option' do
@@ -125,34 +145,26 @@ describe Hutch::Consumer do
   end
 
   describe '.get_arguments' do
-
     context 'when defined' do
       it { expect(complex_consumer.get_arguments).to include(foo: :bar) }
     end
 
-    context 'when not defined' do
-      it 'has the default values for queue custom options' do
-        expect(simple_consumer.get_arguments).to have_key('x-queue-mode')
-          .and have_key('x-queue-type')
-      end
-    end
-
     context 'when queue is lazy' do
       it 'has the x-queue-mode argument set to lazy' do
-        expect(consumer_with_custom_queue_options.get_arguments['x-queue-mode'])
+        expect(consumer_using_classic_queue.get_arguments['x-queue-mode'])
           .to eq('lazy')
       end
     end
 
     context "when queue's type is quorum" do
-      let(:arguments) { consumer_with_custom_queue_options.get_arguments }
+      let(:arguments) { consumer_using_quorum_queue.get_arguments }
       it 'has the x-queue-type argument set to quorum' do
         expect(arguments['x-queue-type']).to eq('quorum')
         expect(arguments).to_not have_key('x-quorum-initial-group-size')
       end
 
       it 'has the x-quorum-initial-group-size argument set to quorum' do
-        consumer_with_custom_queue_options.quorum_queue(initial_group_size: 5)
+        consumer_using_quorum_queue.quorum_queue(initial_group_size: 5)
         expect(arguments['x-queue-type']).to eq('quorum')
         expect(arguments['x-quorum-initial-group-size']).to eq(5)
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hutch
 version: !ruby/object:Gem::Version
-  version: 0.28.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Harry Marr
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-17 00:00:00.000000000 Z
+date: 2020-04-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bunny
@@ -16,7 +16,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '2.14'
+        version: '2.15'
     - - "<"
       - !ruby/object:Gem::Version
         version: '2.16'
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '2.14'
+        version: '2.15'
     - - "<"
       - !ruby/object:Gem::Version
         version: '2.16'
@@ -178,7 +178,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Easy inter-service communication using RabbitMQ.