msgr 0.15.2.1.b175 → 0.15.2.1.b178

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 42747ff1144b8ca1909b6e590abeeba4c01d6987cc30e9a0f4e0d4af35e3eb68
-  data.tar.gz: 485f6a9381d87a4806da5bd49b35577a7ca88adcdd2f814721d28bbe3bf6ba41
+  metadata.gz: 1c2aba57e013a4e5972ec47493539cb0b8a0ccfafd94279fc8040000aab0a8f5
+  data.tar.gz: c6d5c25f205476087f183d1b59abcad36d1bf1877ebf0f1015e870d0ccb302c7
 SHA512:
-  metadata.gz: 0811f5754236dabc42b98f7b7af105589058515a6cddc93b764b86bf9a7c8d93ab1fbc926cd5c3aec39846cf3e1a1725ce658beba942f357b5fe360db1d94968
-  data.tar.gz: 2f3e9772b9ad8d24fab608cfa5ac59193a594dd5b29a9274af8f9ea06ec52e5a9e02daee910c6e2d28f4554e22e82b2d40b9e5b641a8ee8e55dac30a57ddfbd4
+  metadata.gz: 1fd16f2b6f7414ef21dab90dad31170c0de7dc833f2a6f1737d47ff45476505aa179a4d184c27bb92446570225aa8b8a478d99690992c980199e43a07be8168e
+  data.tar.gz: fcc9d1e8251987c80958538c468c7c20fb9a526b0f4b777a08bc26f8cfacf1a4f58c22b76ad06230a79c657a7a1e594f5453b5080b2c04da44576ab621188129

data/README.md

@@ -83,7 +83,34 @@ class TestController < ApplicationController
 end
 ```
 
-## Msgr and fork web server like unicorn
+## Advanced configuration
+
+### Manual message acknowledgement
+
+Per default messages are automatically acknowledged, if no (n)ack is sent explicitly by the consumer. This can be disabled by setting the `auto_ack` attribute to `false`. 
+
+```ruby
+class TestConsumer < Msgr::Consumer
+  self.auto_ack = false
+  
+  def index
+    data = { fuubar: 'abc' }
+
+    publish data, to: 'local.test.another_action'
+  end
+end
+```
+
+
+### Prefetch count
+
+Per default each message queue has a prefetch count of 1. This value can be changed when specifying the messaging routes:
+
+ ```ruby
+ route 'local.test.index', to: 'test#index', prefetch: 42
+ ```
+
+### Msgr and fork web server like unicorn
 
 Per default msgr opens the rabbitmq connect when rails is loaded. If you use a multi-process web server that preloads the application (like unicorn) will lead to unexpected behavior. In this case adjust `config/rabbitmq.yml` and adjust `autostart = false`:
 

data/lib/msgr/binding.rb

@@ -4,18 +4,19 @@ module Msgr
   class Binding
     include Logging
 
-    attr_reader :queue, :subscription, :connection, :route, :dispatcher
+    attr_reader :queue, :subscription, :connection, :channel, :route, :dispatcher
 
     def initialize(connection, route, dispatcher)
       @connection = connection
+      @channel    = connection.channel(prefetch: route.prefetch)
       @route      = route
       @dispatcher = dispatcher
-      @queue      = connection.queue(route.name)
+      @queue      = @channel.queue(route.name)
 
       route.keys.each do |key|
         log(:debug) { "Bind #{key} to #{queue.name}." }
 
-        queue.bind connection.exchange, routing_key: key
+        queue.bind @channel.exchange, routing_key: key
       end
 
       subscribe
@@ -43,7 +44,7 @@ module Msgr
     def subscribe
       @subscription = queue.subscribe(manual_ack: true) do |*args|
         begin
-          dispatcher.call Message.new(connection, *args, route)
+          dispatcher.call Message.new(channel, *args, route)
         rescue => err
           log(:error) do
             "Rescued error from subscribe: #{err.class.name}: " \

data/lib/msgr/channel.rb

@@ -0,0 +1,65 @@
+module Msgr
+  class Channel
+    include Logging
+
+    EXCHANGE_NAME = 'msgr'
+
+    attr_reader :config, :channel
+
+    def initialize(config, connection)
+      @config  = config
+      @channel = connection.create_channel
+    end
+
+    def prefetch(count)
+      @channel.prefetch count
+    end
+
+    def exchange
+      @exchange ||= begin
+        @channel.topic(prefix(EXCHANGE_NAME), durable: true).tap do |ex|
+          log(:debug) do
+            "Created exchange #{ex.name} (type: #{ex.type}, " \
+                "durable: #{ex.durable?}, auto_delete: #{ex.auto_delete?})"
+          end
+        end
+      end
+    end
+
+    def queue(name)
+      @channel.queue(prefix(name), durable: true).tap do |queue|
+        log(:debug) do
+          "Create queue #{queue.name} (durable: #{queue.durable?}, " \
+          "auto_delete: #{queue.auto_delete?})"
+        end
+      end
+    end
+
+    def prefix(name)
+      if config[:prefix].present?
+        "#{config[:prefix]}-#{name}"
+      else
+        name
+      end
+    end
+
+    def ack(delivery_tag)
+      @channel.ack delivery_tag
+      log(:debug) { "Acked message: #{delivery_tag}" }
+    end
+
+    def nack(delivery_tag)
+      @channel.nack delivery_tag, false, true
+      log(:debug) { "Nacked message: #{delivery_tag}" }
+    end
+
+    def reject(delivery_tag, requeue = true)
+      @channel.reject delivery_tag, requeue
+      log(:debug) { "Rejected message: #{delivery_tag}" }
+    end
+
+    def close
+      @channel.close if @channel.open?
+    end
+  end
+end

data/lib/msgr/connection.rb

@@ -8,14 +8,13 @@ module Msgr
   class Connection
     include Logging
 
-    EXCHANGE_NAME = 'msgr'
-
     attr_reader :uri, :config
 
     def initialize(uri, config, dispatcher)
       @uri        = uri
       @config     = config
       @dispatcher = dispatcher
+      @channels   = []
     end
 
     def running?
@@ -38,12 +37,15 @@ module Msgr
       connection
     end
 
-    def channel
-      @channel ||= begin
-        channel = connection.create_channel
-        channel.prefetch 1
-        channel
-      end
+    def channel(prefetch: 1)
+      channel = Msgr::Channel.new(config, connection)
+      channel.prefetch(prefetch)
+      @channels << channel
+      channel
+    end
+
+    def exchange
+      @exchange ||= channel.exchange
     end
 
     def release
@@ -71,34 +73,6 @@ module Msgr
       @bindings ||= []
     end
 
-    def prefix(name)
-      if config[:prefix].present?
-        "#{config[:prefix]}-#{name}"
-      else
-        name
-      end
-    end
-
-    def exchange
-      @exchange ||= begin
-        channel.topic(prefix(EXCHANGE_NAME), durable: true).tap do |ex|
-          log(:debug) do
-            "Created exchange #{ex.name} (type: #{ex.type}, " \
-                "durable: #{ex.durable?}, auto_delete: #{ex.auto_delete?})"
-          end
-        end
-      end
-    end
-
-    def queue(name)
-      channel.queue(prefix(name), durable: true).tap do |queue|
-        log(:debug) do
-          "Create queue #{queue.name} (durable: #{queue.durable?}, " \
-          "auto_delete: #{queue.auto_delete?})"
-        end
-      end
-    end
-
     def bind(routes)
       if routes.empty?
         log(:warn) do
@@ -110,23 +84,8 @@ module Msgr
       end
     end
 
-    def ack(delivery_tag)
-      channel.ack delivery_tag
-      log(:debug) { "Acked message: #{delivery_tag}" }
-    end
-
-    def nack(delivery_tag)
-      channel.nack delivery_tag, false, true
-      log(:debug) { "Nacked message: #{delivery_tag}" }
-    end
-
-    def reject(delivery_tag, requeue = true)
-      channel.reject delivery_tag, requeue
-      log(:debug) { "Rejected message: #{delivery_tag}" }
-    end
-
     def close
-      channel.close    if @channel && @channel.open?
+      @channels.each(&:close)
       connection.close if @connection
       log(:debug) { 'Closed.' }
     end

data/lib/msgr/consumer.rb

@@ -9,6 +9,16 @@ module Msgr
     delegate :action, to: :'@message.route'
     delegate :consumer, to: :'@message.consumer'
 
+    class << self
+      def auto_ack?
+        @auto_ack || @auto_ack.nil?
+      end
+
+      def auto_ack=(val)
+        @auto_ack = val
+      end
+    end
+
     def dispatch(message)
       @message = message
 

data/lib/msgr/dispatcher.rb

@@ -37,8 +37,8 @@ module Msgr
 
       consumer_class.new.dispatch message
 
-      # Acknowledge message unless it is already acknowledged.
-      message.ack unless message.acked?
+      # Acknowledge message unless it is already acknowledged or auto_ack is disabled.
+      message.ack unless message.acked? or not consumer_class.auto_ack?
     rescue => error
       message.nack unless message.acked?
 

data/lib/msgr/message.rb

@@ -4,8 +4,8 @@ module Msgr
   class Message
     attr_reader :delivery_info, :metadata, :payload, :route
 
-    def initialize(connection, delivery_info, metadata, payload, route)
-      @connection    = connection
+    def initialize(channel, delivery_info, metadata, payload, route)
+      @channel       = channel
       @delivery_info = delivery_info
       @metadata      = metadata
       @payload       = payload
@@ -40,7 +40,7 @@ module Msgr
       return if acked?
 
       @acked = true
-      @connection.ack delivery_info.delivery_tag
+      @channel.ack delivery_info.delivery_tag
     end
 
     # Send negative message acknowledge to broker unless
@@ -52,7 +52,7 @@ module Msgr
       return if acked?
 
       @acked = true
-      @connection.nack delivery_info.delivery_tag
+      @channel.nack delivery_info.delivery_tag
     end
   end
 end

data/lib/msgr/route.rb

@@ -31,6 +31,10 @@ module Msgr
     end
     alias routing_keys keys
 
+    def prefetch
+      @opts[:prefetch] || 1
+    end
+
     def add(key)
       raise ArgumentError.new 'Routing key required.' unless key.present?
 

data/lib/msgr.rb

@@ -11,6 +11,7 @@ require 'active_support/core_ext/hash/keys'
 require 'msgr/logging'
 require 'msgr/client'
 require 'msgr/binding'
+require 'msgr/channel'
 require 'msgr/connection'
 require 'msgr/consumer'
 require 'msgr/dispatcher'

data/spec/integration/msgr/dispatcher_spec.rb

@@ -24,8 +24,8 @@ describe Msgr::Dispatcher do
       allow(t).to receive(:action).and_return 'index'
     end
   end
-  let(:connection) do
-    double(:connection).tap do |c|
+  let(:channel) do
+    double(:channel).tap do |c|
       allow(c).to receive(:ack)
     end
   end
@@ -40,7 +40,7 @@ describe Msgr::Dispatcher do
       allow(metadata).to receive(:content_type).and_return('text/plain')
     end
   end
-  let(:message) { Msgr::Message.new connection, delivery_info, metadata, payload, route }
+  let(:message) { Msgr::Message.new channel, delivery_info, metadata, payload, route }
   let(:action) { -> { dispatcher.call message } }
 
   it 'should consume message' do

data/spec/msgr/msgr/dispatcher_spec.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+class MsgrAutoAckConsumer < Msgr::Consumer
+  self.auto_ack = true
+
+  def index
+  end
+end
+
+class MsgrManualAckConsumer < Msgr::Consumer
+  self.auto_ack = false
+
+  def index
+  end
+end
+
+describe Msgr::Dispatcher do
+  let(:config) { {} }
+  let(:args) { [config] }
+  let(:dispatcher) { Msgr::Dispatcher.new(*args) }
+  subject { dispatcher }
+
+  describe 'dispatch' do
+    it 'should ack messages automatically if auto_ack is enabled' do
+      route_db = double('Route', :consumer => 'MsgrAutoAckConsumer', :action => :index)
+      msg_db = double('Message', :route => route_db, :acked? => false)
+      expect(msg_db).to receive(:ack)
+      expect(msg_db).not_to receive(:nack)
+
+      dispatcher.dispatch(msg_db)
+    end
+
+    it 'should not ack messages if auto_ack is disabled' do
+      route_db = double('Route', :consumer => 'MsgrManualAckConsumer', :action => :index)
+      msg_db = double('Message', :route => route_db, :acked? => false)
+      expect(msg_db).not_to receive(:ack)
+      expect(msg_db).not_to receive(:nack)
+
+      dispatcher.dispatch(msg_db)
+    end
+  end
+end

data/spec/msgr/msgr_spec.rb

@@ -16,6 +16,14 @@ class MsgrTestConsumer < Msgr::Consumer
   end
 end
 
+class MsgrPrefetchTestConsumer < Msgr::Consumer
+  self.auto_ack = false
+
+  def index
+    Receiver.batch message
+  end
+end
+
 describe Msgr do
   let(:queue) { Queue.new }
   let(:client) { Msgr::Client.new size: 1, prefix: SecureRandom.hex(2) }
@@ -24,6 +32,7 @@ describe Msgr do
     client.routes.configure do
       route 'test.index', to: 'msgr_test#index'
       route 'test.error', to: 'msgr_test#error'
+      route 'test.batch', to: 'msgr_prefetch_test#index', prefetch: 2
     end
 
     client.start
@@ -49,4 +58,27 @@ describe Msgr do
 
     Timeout.timeout(4) { queue.pop }
   end
+
+  it 'should receive 2 messages when prefetch is set to 2' do
+    expect(Receiver).to receive(:batch).twice { |msg| queue << msg }
+
+    2.times { client.publish 'Payload', to: 'test.batch' }
+
+    2.times { Timeout.timeout(4) { queue.pop } }
+  end
+
+  it 'should not bulk ack all unacknowledged messages when acknowledging the last one' do
+    expect(Receiver).to receive(:batch).exactly(3).times { |msg| queue << msg }
+
+    2.times { client.publish 'Payload', to: 'test.batch' }
+
+    messages = 2.times.map { Timeout.timeout(4) { queue.pop } }
+    messages[1].ack
+    messages[0].nack
+
+    # Test whether the nacked message gets redelivered. In this case, it was not acked when acknowledging the other message
+    message = Timeout.timeout(4) { queue.pop }
+    expect(message.payload).to eq(messages[0].payload)
+    expect(message.delivery_info.redelivered).to eq(true)
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: msgr
 version: !ruby/object:Gem::Version
-  version: 0.15.2.1.b175
+  version: 0.15.2.1.b178
 platform: ruby
 authors:
 - Jan Graichen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-19 00:00:00.000000000 Z
+date: 2017-12-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -93,6 +93,7 @@ files:
 - gemfiles/Gemfile.rails-master
 - lib/msgr.rb
 - lib/msgr/binding.rb
+- lib/msgr/channel.rb
 - lib/msgr/client.rb
 - lib/msgr/connection.rb
 - lib/msgr/consumer.rb
@@ -139,6 +140,7 @@ files:
 - spec/msgr/msgr/client_spec.rb
 - spec/msgr/msgr/connection_spec.rb
 - spec/msgr/msgr/consumer_spec.rb
+- spec/msgr/msgr/dispatcher_spec.rb
 - spec/msgr/msgr/route_spec.rb
 - spec/msgr/msgr/routes_spec.rb
 - spec/msgr/msgr_spec.rb
@@ -202,6 +204,7 @@ test_files:
 - spec/msgr/msgr/client_spec.rb
 - spec/msgr/msgr/connection_spec.rb
 - spec/msgr/msgr/consumer_spec.rb
+- spec/msgr/msgr/dispatcher_spec.rb
 - spec/msgr/msgr/route_spec.rb
 - spec/msgr/msgr/routes_spec.rb
 - spec/msgr/msgr_spec.rb