hutch 0.14.0 → 0.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3c92582d4268b9d9623c60f4b2588d4afc244c17
-  data.tar.gz: f783601d90dd7031c90c6a6372eb6f2b6b4ef2e4
+  metadata.gz: 4edfb298acf9e73fb226a3708e76d7e99ad345e3
+  data.tar.gz: d17eb84b63b21b42501570196abe6ef57ca94cde
 SHA512:
-  metadata.gz: e40a52fafa102ec87c2df5e885dcffd48a0a6786b08cd4c133122e4da85a2a614aeca75513fbd4f3d464409b6d8189c8585ea4b9d456f893e44b97957ffcba0a
-  data.tar.gz: 19f8a9dc63bf258f9b0211f49f9b21a509266a1f09eb2d3e3865d3acc2d2eb13a6fdc5d4c682accbaf98ec6d4794f1775d28156723a62e88be2b68c651e4d8bc
+  metadata.gz: 99ba07374f0f8bcf407ef537ea0a8342cb4368cf323c0f41deee27a37e1b6cf156dc6a72645bf2ecc6181219a0723c9c6795035d7ac3cc46ad4783f936edd516
+  data.tar.gz: 8a6abf7f30f6dcb3c88d968deba3115389b6a043293a75609ff5e441c94da55ac3c31d81dad4049f52710ac12bff59d4643f878ee40bac143d35b3070edf8c84

data/.travis.yml

@@ -1,7 +1,8 @@
 language: ruby
 rvm:
-  - 2.1.0
-  - 2.0.0
-  - 1.9.3
+  - "2.2"
+  - "2.1"
+  - "2.0"
+  - "1.9.3"
 services:
   - rabbitmq

data/CHANGELOG.md

@@ -1,4 +1,12 @@
-## 0.14.0 — (unreleased)
+## 0.15.0 — (unreleased)
+
+Allow to set custom arguments per consumers by using the `arguments` setter.
+Arguments are usually used by rabbitmq plugins or to set queue policies. You can
+find a list of supported arguments [here](https://www.rabbitmq.com/extensions.html).
+
+Contributed by Pierre-Louis Gottfrois.
+
+## 0.14.0 — Feb 23rd, 2015
 
 ### Configurable Socket Timeouts
 

data/README.md

@@ -80,6 +80,19 @@ class FailedPaymentConsumer
 end
 ```
 
+You can also set custom arguments per consumer. This example declares a consumer with
+a maximum length of 10 messages:
+
+```ruby
+class FailedPaymentConsumer
+  include Hutch::Consumer
+  consume 'gc.ps.payment.failed'
+  arguments 'x-max-length' => 10
+end
+```
+
+Custom queue arguments can be found on [this page](https://www.rabbitmq.com/extensions.html).
+
 If you are using Hutch with Rails and want to make Hutch log to the Rails
 logger rather than `stdout`, add this to `config/initializers/hutch.rb`
 
@@ -134,8 +147,6 @@ mq_host: broker.yourhost.com
 Passing a setting as a command-line option will overwrite what's specified
 in the config file, allowing for easy customization.
 
-
-
 ### Loading Consumers
 
 Using Hutch with a Rails app is simple. Either start Hutch in the working
@@ -153,6 +164,20 @@ $ hutch --require path/to/rails-app  # loads a rails app
 $ hutch --require path/to/file.rb    # loads a ruby file
 ```
 
+### Stopping Hutch
+
+Hutch supports graceful stops. That means that if done correctly, Hutch will wait for your consumer to finish processing before exiting.
+
+To gracefully stop your workers, you may send the following signals to your Hutch processes: `INT`, `TERM`, or `QUIT`.
+
+```bash
+kill -SIGINT 123 # or kill -2 123
+kill -SIGTERM 456 # or kill -15 456
+kill -SIGQUIT 789 # or kill -3 789
+```
+
+![](http://g.recordit.co/wyCdzG9Kh3.gif)
+
 ## Producers
 
 Hutch includes a `publish` method for sending messages to Hutch consumers. When

data/lib/hutch/broker.rb

@@ -141,11 +141,11 @@ module Hutch
     end
 
     # Create / get a durable queue and apply namespace if it exists.
-    def queue(name)
+    def queue(name, arguments = {})
       with_bunny_precondition_handler('queue') do
         namespace = @config[:namespace].to_s.downcase.gsub(/[^-_:\.\w]/, "")
         name = name.prepend(namespace + ":") unless namespace.empty?
-        channel.queue(name, durable: true)
+        channel.queue(name, durable: true, arguments: arguments)
       end
     end
 
@@ -193,7 +193,12 @@ module Hutch
     end
 
     def stop
-      @channel.work_pool.kill
+      # Enqueue a failing job that kills the consumer loop
+      channel_work_pool.shutdown
+      # Give `timeout` seconds to jobs that are still being processed
+      channel_work_pool.join(@config[:graceful_exit_timeout])
+      # If after `timeout` they are still running, they are killed
+      channel_work_pool.kill
     end
 
     def requeue(delivery_tag)
@@ -305,7 +310,11 @@ module Hutch
     end
 
     def work_pool_threads
-      @channel.work_pool.threads || []
+      channel_work_pool.threads || []
+    end
+
+    def channel_work_pool
+      @channel.work_pool
     end
 
     def generate_id

data/lib/hutch/config.rb

@@ -1,4 +1,5 @@
 require 'hutch/error_handlers/logger'
+require 'erb'
 require 'logger'
 
 module Hutch
@@ -43,7 +44,11 @@ module Hutch
         connection_timeout: 11,
         read_timeout: 11,
         write_timeout: 11,
-        enable_http_api_use: true
+        enable_http_api_use: true,
+        # Number of seconds that a running consumer is given
+        # to finish its job when gracefully exiting Hutch, before
+        # it's killed.
+        graceful_exit_timeout: 11,
       }.merge(params)
     end
 
@@ -78,7 +83,7 @@ module Hutch
     end
 
     def self.load_from_file(file)
-      YAML.load(file).each do |attr, value|
+      YAML.load(ERB.new(File.read(file)).result).each do |attr, value|
         Hutch::Config.send("#{attr}=", value)
       end
     end

data/lib/hutch/consumer.rb

@@ -32,6 +32,11 @@ module Hutch
         @queue_name = name
       end
 
+      # Allow to specify custom arguments that will be passed when creating the queue.
+      def arguments(arguments = {})
+        @arguments = arguments
+      end
+
       # The RabbitMQ queue name for the consumer. This is derived from the
       # fully-qualified class name. Module separators are replaced with single
       # colons, camelcased class names are converted to snake case.
@@ -42,6 +47,11 @@ module Hutch
         queue_name.downcase
       end
 
+      # Returns consumer custom arguments.
+      def get_arguments
+        @arguments || {}
+      end
+
       # Accessor for the consumer's routing key.
       def routing_keys
         @routing_keys ||= Set.new

data/lib/hutch/version.rb

@@ -1,4 +1,4 @@
 module Hutch
-  VERSION = '0.14.0'.freeze
+  VERSION = '0.15.0'.freeze
 end
 

data/lib/hutch/worker.rb

@@ -62,7 +62,7 @@ module Hutch
     # Bind a consumer's routing keys to its queue, and set up a subscription to
     # receive messages sent to the queue.
     def setup_queue(consumer)
-      queue = @broker.queue(consumer.get_queue_name)
+      queue = @broker.queue(consumer.get_queue_name, consumer.get_arguments)
       @broker.bind_queue(queue, consumer.routing_keys)
 
       queue.subscribe(manual_ack: true) do |delivery_info, properties, payload|

data/spec/hutch/broker_spec.rb

@@ -128,14 +128,16 @@ describe Hutch::Broker do
 
   describe '#queue' do
     let(:channel) { double('Channel') }
+    let(:arguments) { { foo: :bar } }
     before { allow(broker).to receive(:channel) { channel } }
 
     it 'applies a global namespace' do
       config[:namespace] = 'mirror-all.service'
       expect(broker.channel).to receive(:queue) do |*args|
-        args.first == 'mirror-all.service:test'
+        args.first == ''
+        args.last == arguments
       end
-      broker.queue('test')
+      broker.queue('test', arguments)
     end
   end
 
@@ -211,6 +213,25 @@ describe Hutch::Broker do
     end
   end
 
+  describe '#stop' do
+    let(:thread_1) { double('Thread') }
+    let(:thread_2) { double('Thread') }
+    let(:work_pool) { double('Bunny::ConsumerWorkPool') }
+    let(:config) { { graceful_exit_timeout: 2 } }
+
+    before do
+      allow(broker).to receive(:channel_work_pool).and_return(work_pool)
+    end
+
+    it 'gracefully stops the work pool' do
+      expect(work_pool).to receive(:shutdown)
+      expect(work_pool).to receive(:join).with(2)
+      expect(work_pool).to receive(:kill)
+
+      broker.stop
+    end
+  end
+
   describe '#publish' do
     context 'with a valid connection' do
       before { broker.set_up_amqp_connection }

data/spec/hutch/config_spec.rb

@@ -97,4 +97,30 @@ describe Hutch::Config do
       end
     end
   end
+
+  describe '.load_from_file' do
+    let(:host) { 'localhost' }
+    let(:username) { 'calvin' }
+    let(:file) do
+      Tempfile.new('configs.yaml').tap do |t|
+        t.write(config_contents)
+        t.rewind
+      end
+    end
+
+    context 'when using ERb' do
+      let(:config_contents) do
+        <<-YAML
+mq_host: 'localhost'
+mq_username: '<%= "calvin" %>'
+YAML
+      end
+
+      it 'loads in the config data' do
+        Hutch::Config.load_from_file(file)
+        expect(Hutch::Config.mq_host).to eq host
+        expect(Hutch::Config.mq_username).to eq username
+      end
+    end
+  end
 end

data/spec/hutch/consumer_spec.rb

@@ -22,6 +22,7 @@ describe Hutch::Consumer do
       class ComplexConsumer
         include Hutch::Consumer
         consume 'hutch.test1', 'hutch.test2'
+        arguments foo: :bar
       end
     end
     ComplexConsumer
@@ -62,11 +63,36 @@ describe Hutch::Consumer do
   end
 
   describe '.queue_name' do
+    let(:queue_name) { 'foo' }
+
     it 'overrides the queue name' do
-      
+      simple_consumer.queue_name(queue_name)
+      expect(simple_consumer.get_queue_name).to eq(queue_name)
     end
   end
 
+  describe '.arguments' do
+    let(:args) { { foo: :bar} }
+
+    it 'overrides the arguments' do
+      simple_consumer.arguments(args)
+      expect(simple_consumer.get_arguments).to eq(args)
+    end
+
+  end
+
+  describe '.get_arguments' do
+
+    context 'when defined' do
+      it { expect(complex_consumer.get_arguments).to eq(foo: :bar) }
+    end
+
+    context 'when not defined' do
+      it { expect(simple_consumer.get_arguments).to eq({}) }
+    end
+
+  end
+
   describe '.get_queue_name' do
 
     context 'when queue name has been set explicitly' do

data/spec/hutch/worker_spec.rb

@@ -3,7 +3,7 @@ require 'hutch/worker'
 
 describe Hutch::Worker do
   let(:consumer) { double('Consumer', routing_keys: %w( a b c ),
-                          get_queue_name: 'consumer') }
+                          get_queue_name: 'consumer', get_arguments: {}) }
   let(:consumers) { [consumer, double('Consumer')] }
   let(:broker) { Hutch::Broker.new }
   subject(:worker) { Hutch::Worker.new(broker, consumers) }
@@ -23,7 +23,7 @@ describe Hutch::Worker do
     before { allow(broker).to receive_messages(queue: queue, bind_queue: nil) }
 
     it 'creates a queue' do
-      expect(broker).to receive(:queue).with(consumer.get_queue_name).and_return(queue)
+      expect(broker).to receive(:queue).with(consumer.get_queue_name, consumer.get_arguments).and_return(queue)
       worker.setup_queue(consumer)
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hutch
 version: !ruby/object:Gem::Version
-  version: 0.14.0
+  version: 0.15.0
 platform: ruby
 authors:
 - Harry Marr
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-23 00:00:00.000000000 Z
+date: 2015-05-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bunny