bunny 1.3.1 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d9ff439246dbe426e92dd28209ffa0acab8fb5e9
-  data.tar.gz: 3762043ad87100abe20a84a0c63b5c4f0e54142a
+  metadata.gz: f1cf8263f0250d0bf8f2816bf1aaad837c5505eb
+  data.tar.gz: bafa849e30666c22ff3574507567d27d7859f89b
 SHA512:
-  metadata.gz: 766ba0c503ae3df0969214dee0d9d00da5550514aee46d3b5a95c232b78b62df0099f601ea2c85154ff0dce261ce41fc35ab4a2d91bf24aa4110cbb61176bb94
-  data.tar.gz: d5f8c93ac81cb252717c2e5d98fe06e4ab5e5027a82329f0ce2622f5b0e398b0f1b297af3f7f0ade43a548ff6e0724b8a6f75249ea38c9cd5300e3d8f8231499
+  metadata.gz: a5e14b69c7a128c20e95e2850e80d5517f27f1d93068468ff0058cf9c041a1a8f243ec9c67119580e55dcedb9c6370d59eea15a38be2384b38678fee4307c591
+  data.tar.gz: 849e7085e43ef4b3859940f492472c5058ffffdd0d18d1cdb1946fcf39b7b7761d7f2b4150f05dac6c7b39aa7e2a0e295d8a267d397d3b74815e9b97b4ab881f

data/ChangeLog.md

@@ -1,8 +1,20 @@
-## Changes between Bunny 1.3.0 and 1.3.1
+## Changes between Bunny 1.3.0 and 1.4.0
+
+### Channel#wait_for_confirms Returns Immediately If All Publishes Confirmed
+
+Contributed by Matt Campbell.
+
+### Publisher Confirms is In Sync After Recovery
+
+When a connection is recovered, the sequence counter resets on the
+broker, but not the client. To keep things in sync the client must store a confirmation
+offset after a recovery.
+
+Contributed by Devin Christensen.
 
 ### NoMethodError on Thread During Shutdown
 
-During abnormal termination, `Bunny::Session` no longer tries
+During abnormal termination, `Bunny::Session#close` no longer tries
 to call the non-existent `terminate_with` method on its origin
 thread.
 

data/Gemfile

@@ -35,7 +35,7 @@ end
 
 group :test do
   gem "rspec", "~> 2.13.0"
-  gem "rabbitmq_http_api_client", "~> 1.1.0"
+  gem "rabbitmq_http_api_client", "~> 1.2.0"
 end
 
 gemspec

data/README.md

@@ -95,7 +95,7 @@ gem install bunny
 To use Bunny in a project managed with Bundler:
 
 ``` ruby
-gem "bunny", "~> 1.1.7"
+gem "bunny", "~> 1.3.1"
 ```
 
 
@@ -162,7 +162,7 @@ Other documentation guides are available at [rubybunny.info](http://rubybunny.in
 ### Mailing List
 
 [Bunny has a mailing list](http://groups.google.com/group/ruby-amqp). We encourage you
-to also join the [rabbitmq-discuss](https://lists.rabbitmq.com/cgi-bin/mailman/listinfo/rabbitmq-discuss) mailing list. Feel free to ask any questions that you may have.
+to also join the [RabbitMQ mailing list](https://groups.google.com/forum/#!forum/rabbitmq-users) mailing list. Feel free to ask any questions that you may have.
 
 
 ### IRC

data/lib/bunny/channel.rb

@@ -195,6 +195,7 @@ module Bunny
       @threads_waiting_on_basic_get_continuations = Set.new
 
       @next_publish_seq_no = 0
+      @delivery_tag_offset = 0
 
       @recoveries_counter = Bunny::Concurrent::AtomicFixnum.new(0)
       @uncaught_exception_handler = Proc.new do |e, consumer|
@@ -1359,6 +1360,7 @@ module Bunny
         @unconfirmed_set        = Set.new
         @nacked_set             = Set.new
         @next_publish_seq_no    = 1
+        @only_acks_received = true
       end
 
       @confirms_callback = callback
@@ -1373,19 +1375,18 @@ module Bunny
     end
 
     # Blocks calling thread until confirms are received for all
-    # currently unacknowledged published messages.
+    # currently unacknowledged published messages. Returns immediately
+    # if there are no outstanding confirms.
     #
-    # @return [Boolean] true if all messages were acknowledged positively, false otherwise
+    # @return [Boolean] true if all messages were acknowledged positively since the last time this method was called, false otherwise
     # @see #confirm_select
     # @see #unconfirmed_set
     # @see #nacked_set
     # @see http://rubybunny.info/articles/extensions.html RabbitMQ Extensions guide
     # @api public
     def wait_for_confirms
-      @only_acks_received = true
       wait_on_confirms_continuations
-
-      @only_acks_received
+      read_and_reset_only_acks_received
     end
 
     # @endgroup
@@ -1467,7 +1468,10 @@ module Bunny
     #
     # @api plugin
     def recover_confirm_mode
-      confirm_select if @confirm_mode
+      if using_publisher_confirmations?
+        @delivery_tag_offset = @next_publish_seq_no - 1
+        confirm_select(@confirms_callback)
+      end
     end
 
     # Recovers transaction mode. Used by the Automatic Network Failure
@@ -1691,28 +1695,26 @@ module Bunny
     end
 
     # @private
-    def handle_ack_or_nack(delivery_tag, multiple, nack)
+    def handle_ack_or_nack(delivery_tag_before_offset, multiple, nack)
+      delivery_tag          = delivery_tag_before_offset + @delivery_tag_offset
+      confirmed_range_start = multiple ? @delivery_tag_offset + 1 : delivery_tag
+      confirmed_range_end   = delivery_tag
+      confirmed_range       = (confirmed_range_start..confirmed_range_end)
+
       @unconfirmed_set_mutex.synchronize do
         if nack
-          cloned_set = @unconfirmed_set.clone
-          if multiple
-            cloned_set.keep_if { |i| i <= delivery_tag }
-            @nacked_set.merge(cloned_set)
-          else
-            @nacked_set.add(delivery_tag)
-          end
+          @nacked_set.merge(@unconfirmed_set & confirmed_range)
         end
 
-        if multiple
-          @unconfirmed_set.delete_if { |i| i <= delivery_tag }
-        else
-          @unconfirmed_set.delete(delivery_tag)
-        end
+        @unconfirmed_set.subtract(confirmed_range)
 
         @only_acks_received = (@only_acks_received && !nack)
 
         @confirms_continuations.push(true) if @unconfirmed_set.empty?
-        @confirms_callback.call(delivery_tag, multiple, nack) if @confirms_callback
+
+        if @confirms_callback
+          confirmed_range.each { |tag| @confirms_callback.call(tag, false, nack) }
+        end
       end
     end
 
@@ -1759,17 +1761,32 @@ module Bunny
         @threads_waiting_on_confirms_continuations << t
 
         begin
-          @confirms_continuations.poll(@connection.continuation_timeout)
+          outstanding_confirms = false
+          @unconfirmed_set_mutex.synchronize do
+            outstanding_confirms = !@unconfirmed_set.empty?
+          end
+          @confirms_continuations.poll(@connection.continuation_timeout) if outstanding_confirms
         ensure
           @threads_waiting_on_confirms_continuations.delete(t)
         end
       else
-        connection.reader_loop.run_once until @confirms_continuations.length > 0
+        unless @unconfirmed_set.empty?
+          connection.reader_loop.run_once until @confirms_continuations.length > 0
+          @confirms_continuations.pop
+        end
+      end
+    end
 
-        @confirms_continuations.pop
+    # @private
+    def read_and_reset_only_acks_received
+      @unconfirmed_set_mutex.synchronize do
+        result = @only_acks_received
+        @only_acks_received = true
+        result
       end
     end
 
+
     # Releases all continuations. Used by automatic network recovery.
     # @private
     def release_all_continuations

data/lib/bunny/version.rb

@@ -2,5 +2,5 @@
 
 module Bunny
   # @return [String] Version of the library
-  VERSION = "1.3.1"
+  VERSION = "1.4.0"
 end

data/spec/higher_level_api/integration/publisher_confirms_spec.rb

@@ -1,53 +1,13 @@
 require "spec_helper"
 
 describe Bunny::Channel do
-  let(:connection) do
-    c = Bunny.new(:user => "bunny_gem", :password => "bunny_password", :vhost => "bunny_testbed", :continuation_timeout => 10000)
-    c.start
-    c
-  end
-
   after :each do
     connection.close if connection.open?
   end
 
   let(:n) { 200 }
 
-  context "when publishing with confirms enabled" do
-    it "increments delivery index" do
-      ch = connection.create_channel
-      ch.should_not be_using_publisher_confirmations
-
-      ch.confirm_select
-      ch.should be_using_publisher_confirmations
-
-      q  = ch.queue("", :exclusive => true)
-      x  = ch.default_exchange
-
-      n.times do
-        x.publish("xyzzy", :routing_key => q.name)
-      end
-
-      ch.next_publish_seq_no.should == n + 1
-      ch.wait_for_confirms.should be_true
-      sleep 0.25
-
-      q.message_count.should == n
-      q.purge
-
-      ch.close
-    end
-  end
-
-
-  context "with a single-threaded connection" do
-    let(:connection) do
-      c = Bunny.new(:user => "bunny_gem", :password => "bunny_password", :vhost => "bunny_testbed", :continuation_timeout => 10000, :threaded => false)
-      c.start
-      c
-    end
-
-
+  shared_examples "publish confirms" do
     context "when publishing with confirms enabled" do
       it "increments delivery index" do
         ch = connection.create_channel
@@ -72,6 +32,95 @@ describe Bunny::Channel do
 
         ch.close
       end
+
+      describe "#wait_for_confirms" do
+        it "should not hang when all the publishes are confirmed" do
+          ch = connection.create_channel
+          ch.should_not be_using_publisher_confirmations
+
+          ch.confirm_select
+          ch.should be_using_publisher_confirmations
+
+          q  = ch.queue("", :exclusive => true)
+          x  = ch.default_exchange
+
+          n.times do
+            x.publish("xyzzy", :routing_key => q.name)
+          end
+
+          ch.next_publish_seq_no.should == n + 1
+          ch.wait_for_confirms.should be_true
+
+          sleep 0.25
+
+          expect {
+            Bunny::Timeout.timeout(2) do
+              ch.wait_for_confirms.should be_true
+            end
+          }.not_to raise_error
+
+        end
+      end
+
+      context "when some of the messages get nacked" do
+        it "puts the nacks in the nacked_set" do
+          ch = connection.create_channel
+          ch.should_not be_using_publisher_confirmations
+
+          ch.confirm_select
+          ch.should be_using_publisher_confirmations
+
+          q  = ch.queue("", :exclusive => true)
+          x  = ch.default_exchange
+
+          n.times do
+            x.publish("xyzzy", :routing_key => q.name)
+          end
+
+          #be sneaky to simulate a nack
+          nacked_tag = nil
+          ch.instance_variable_get(:@unconfirmed_set_mutex).synchronize do
+            expect(ch.unconfirmed_set).to_not be_empty
+            nacked_tag = ch.unconfirmed_set.reduce(ch.next_publish_seq_no - 1) { |lowest, i| i < lowest ? i : lowest }
+            ch.handle_ack_or_nack(nacked_tag, false, true)
+          end
+
+          ch.nacked_set.should_not be_empty
+          ch.nacked_set.should include(nacked_tag)
+
+          ch.next_publish_seq_no.should == n + 1
+          ch.wait_for_confirms.should be_false
+
+          ch.nacked_set.should_not be_empty
+          ch.nacked_set.should include(nacked_tag)
+
+          sleep 0.25
+          q.message_count.should == n
+          q.purge
+
+          ch.close
+        end
+      end
     end
   end
+
+  context "with a multi-threaded connection" do
+    let(:connection) do
+      c = Bunny.new(:user => "bunny_gem", :password => "bunny_password", :vhost => "bunny_testbed", :continuation_timeout => 10000)
+      c.start
+      c
+    end
+
+    include_examples "publish confirms"
+  end
+
+  context "with a single-threaded connection" do
+    let(:connection) do
+      c = Bunny.new(:user => "bunny_gem", :password => "bunny_password", :vhost => "bunny_testbed", :continuation_timeout => 10000, :threaded => false)
+      c.start
+      c
+    end
+
+    include_examples "publish confirms"
+  end
 end

data/spec/issues/issue224_spec.rb

@@ -0,0 +1,40 @@
+# -*- coding: utf-8 -*-
+require "spec_helper"
+
+unless ENV["CI"]
+  describe "Message framing implementation" do
+    let(:connection) do
+      c = Bunny.new(:user     => "bunny_gem",
+        :password => "bunny_password",
+        :vhost    => "bunny_testbed",
+        :port     => ENV.fetch("RABBITMQ_PORT", 5672))
+      c.start
+      c
+    end
+
+    after :each do
+      connection.close if connection.open?
+    end
+
+
+    context "with payload 272179 bytes in size" do
+      it "successfully frames the message" do
+        ch = connection.create_channel
+
+        q  = ch.queue("", :exclusive => true)
+        x  = ch.default_exchange
+
+        as = ("a" * 272179)
+        x.publish(as, :routing_key => q.name, :persistent => true)
+
+        sleep(1)
+        q.message_count.should == 1
+
+        _, _, payload      = q.pop
+        payload.bytesize.should == as.bytesize
+
+        ch.close
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bunny
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 1.4.0
 platform: ruby
 authors:
 - Chris Duncan
@@ -12,7 +12,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-19 00:00:00.000000000 Z
+date: 2014-07-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: amq-protocol
@@ -184,6 +184,7 @@ files:
 - spec/issues/issue100_spec.rb
 - spec/issues/issue141_spec.rb
 - spec/issues/issue202_spec.rb
+- spec/issues/issue224_spec.rb
 - spec/issues/issue78_spec.rb
 - spec/issues/issue83_spec.rb
 - spec/issues/issue97_attachment.json
@@ -281,6 +282,7 @@ test_files:
 - spec/issues/issue100_spec.rb
 - spec/issues/issue141_spec.rb
 - spec/issues/issue202_spec.rb
+- spec/issues/issue224_spec.rb
 - spec/issues/issue78_spec.rb
 - spec/issues/issue83_spec.rb
 - spec/issues/issue97_attachment.json