stomp 1.1.5 → 1.1.6

data/CHANGELOG.rdoc

@@ -1,3 +1,7 @@
+== ?
+
+* Fixed multi-thread app hanging
+
 == 1.1.5 2010-17-03
 
 * Added publish method (send is now deprecated)

data/lib/stomp.rb

@@ -17,6 +17,7 @@ require 'stomp/ext/hash'
 require 'stomp/connection'
 require 'stomp/client'
 require 'stomp/message'
+require 'stomp/version'
 require 'stomp/errors'
 
 module Stomp

data/lib/stomp/client.rb

@@ -286,15 +286,12 @@ module Stomp
 
         @listener_thread = Thread.start do
           while true
-            message = @connection.poll
-            case
-            when message.nil?
-              sleep 0.1
-            when message.command == 'MESSAGE'
+            message = @connection.receive
+            if message.command == 'MESSAGE'
               if listener = @listeners[message.headers['destination']]
                 listener.call(message)
               end
-            when message.command == 'RECEIPT'
+            elsif message.command == 'RECEIPT'
               if listener = @receipt_listeners[message.headers['receipt-id']]
                 listener.call(message)
               end

data/lib/stomp/connection.rb

@@ -1,5 +1,4 @@
 require 'socket'
-require 'monitor'
 require 'timeout'
 
 module Stomp
@@ -71,8 +70,11 @@ module Stomp
         @parameters = nil
       end
       
+      # Use Mutexes:  only one lock per each thread
+      # Revert to original implementation attempt
       @transmit_semaphore = Mutex.new
-      @read_semaphore = Monitor.new
+      @read_semaphore = Mutex.new
+      @socket_semaphore = Mutex.new
       
       @subscriptions = {}
       @failure = nil
@@ -98,7 +100,7 @@ module Stomp
     end
 
     def socket
-      @read_semaphore.synchronize do
+      @socket_semaphore.synchronize do
         used_socket = @socket
         used_socket = nil if closed?
         
@@ -154,7 +156,7 @@ module Stomp
     end
     
     def change_host
-      @parameters[:hosts].shuffle! if @parameters[:randomize]
+      @parameters[:hosts] = @parameters[:hosts].sort_by { rand } if @parameters[:randomize]
       
       # Set first as master and send it to the end of array
       current_host = @parameters[:hosts].shift
@@ -169,7 +171,7 @@ module Stomp
     end
     
     def max_reconnect_attempts?
-      !(@parameters.nil? || @parameters[:max_reconnect_attempts].nil?) && @parameters[:max_reconnect_attempts] != 0 && @connection_attempts > @parameters[:max_reconnect_attempts]
+      !(@parameters.nil? || @parameters[:max_reconnect_attempts].nil?) && @parameters[:max_reconnect_attempts] != 0 && @connection_attempts >= @parameters[:max_reconnect_attempts]
     end
     
     def increase_reconnect_delay
@@ -308,10 +310,10 @@ module Stomp
     # Return a pending message if one is available, otherwise
     # return nil
     def poll
-      @read_semaphore.synchronize do
-        return nil if @socket.nil? || !@socket.ready?
-        receive
-      end
+      # No need for a read lock here.  The receive method eventually fullfills
+      # that requirement.
+      return nil if @socket.nil? || !@socket.ready?
+      receive
     end
 
     # Receive a frame, block until the frame is received

data/lib/stomp/ext/hash.rb

@@ -20,5 +20,5 @@ class ::Hash
     end
 
     symbolized
-  end unless self.respond_to? :symbolize_keys
+  end unless self.method_defined?(:symbolize_keys)
 end

data/lib/stomp/version.rb

@@ -2,7 +2,7 @@ module Stomp
   module Version  #:nodoc: all
     MAJOR = 1
     MINOR = 1
-    PATCH = 5
+    PATCH = 6
     STRING = "#{MAJOR}.#{MINOR}.#{PATCH}"
   end
 end

data/spec/connection_spec.rb

@@ -334,11 +334,12 @@ describe Stomp::Connection do
       @parameters[:max_reconnect_attempts] = limit
       @connection = Stomp::Connection.new(@parameters)
       
-      @connection.instance_variable_set(:@connection_attempts, limit)
+      @connection.instance_variable_set(:@connection_attempts, limit-1)
       @connection.max_reconnect_attempts?.should be_false
       
-      @connection.instance_variable_set(:@connection_attempts, limit+1)
+      @connection.instance_variable_set(:@connection_attempts, limit)
       @connection.max_reconnect_attempts?.should be_true
+      
     end
   end
 end

data/stomp.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{stomp}
-  s.version = "1.1.5"
+  s.version = "1.1.6"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Brian McCallister", "Marius Mathiesen", "Thiago Morello"]
-  s.date = %q{2010-03-17}
+  s.date = %q{2010-06-10}
   s.description = %q{Ruby client for the Stomp messaging protocol}
   s.email = ["brianm@apache.org", "marius@stones.com", "morellon@gmail.com"]
   s.executables = ["catstomp", "stompcat"]

data/test/test_client.rb

@@ -7,6 +7,9 @@ class TestClient < Test::Unit::TestCase
   
   def setup
     @client = Stomp::Client.new(user, passcode, host, port)
+    # Multi_thread test data
+    @max_threads = 20
+    @max_msgs = 50
   end
 
   def teardown
@@ -36,7 +39,6 @@ class TestClient < Test::Unit::TestCase
     assert_equal message_text, received.body
   end
 
-  # BROKEN
   def test_noack
     @client.publish destination, message_text
 
@@ -49,11 +51,13 @@ class TestClient < Test::Unit::TestCase
     # was never acked so should be resent to next client
 
     @client = Stomp::Client.new(user, passcode, host, port)
-    received = nil
-    @client.subscribe(destination) {|msg| received = msg}
-    sleep 0.01 until received
+    received2 = nil
+    @client.subscribe(destination) {|msg| received2 = msg}
+    sleep 0.01 until received2
 
-    assert_equal message_text, received.body
+    assert_equal message_text, received2.body
+    assert_equal received.body, received2.body
+    assert_equal received.headers['message-id'], received2.headers['message-id']
   end
 
   def test_receipts
@@ -178,13 +182,82 @@ class TestClient < Test::Unit::TestCase
   def test_unsubscribe
     message = nil
     client = Stomp::Client.new(user, passcode, host, port, true)
-    client.subscribe(destination, :ack => 'client') { |m| message = m }
-    @client.publish destination, message_text
-    Timeout::timeout(4) do
-      sleep 0.01 until message
+    assert_nothing_raised {
+      client.subscribe(destination, :ack => 'client') { |m| message = m }
+      @client.publish destination, message_text
+      Timeout::timeout(4) do
+        sleep 0.01 until message
+      end
+    }
+    assert_equal message_text, message.body
+    assert_nothing_raised {
+      client.unsubscribe destination # was throwing exception on unsub at one point
+      client.close
+    }
+    #  Same message should remain on the queue.  Receive it again with ack=>auto.
+    message_copy = nil
+    client = Stomp::Client.new(user, passcode, host, port, true)
+    assert_nothing_raised {
+      client.subscribe(destination, :ack => 'auto') { |m| message_copy = m }
+      Timeout::timeout(4) do
+        sleep 0.01 until message_copy
+      end
+    }
+    assert_equal message_text, message_copy.body
+    assert_equal message.headers['message-id'], message_copy.headers['message-id']
+  end
+
+  def test_thread_one_subscribe
+    msg = nil
+    Thread.new(@client) do |acli|
+      assert_nothing_raised {
+        acli.subscribe(destination) { |m| msg = m }
+        Timeout::timeout(4) do
+          sleep 0.01 until msg
+        end
+      }
     end
-    client.unsubscribe destination # was throwing exception on unsub at one point
+    #
+    @client.publish(destination, message_text)
+    sleep 1
+    assert_not_nil msg
+  end
 
+  def test_thread_multi_subscribe
+    #
+    lock = Mutex.new
+    msg_ctr = 0
+    1.upto(@max_threads) do |tnum|
+      # Threads within threads .....
+      Thread.new(@client) do |acli|
+        assert_nothing_raised {
+          acli.subscribe(destination) { |m| 
+            msg = m
+            lock.synchronize do
+              msg_ctr += 1
+            end
+            # Simulate message processing
+            sleep 0.05
+          }
+        }
+      end
+    end
+    #
+    1.upto(@max_msgs) do |mnum|
+      msg = Time.now.to_s + " #{mnum}"
+      @client.publish(destination, message_text)
+    end
+    #
+    max_sleep=5
+    sleep_incr = 0.10
+    total_slept = 0
+    while true
+      break if @max_msgs == msg_ctr
+      total_slept += sleep_incr
+      break if total_slept > max_sleep
+      sleep sleep_incr
+    end
+    assert_equal @max_msgs, msg_ctr
   end
 
   private

data/test/test_connection.rb

@@ -7,6 +7,9 @@ class TestStomp < Test::Unit::TestCase
   
   def setup
     @conn = Stomp::Connection.open(user, passcode, host, port)
+    # Data for multi_thread tests
+    @max_threads = 20
+    @max_msgs = 100
   end
 
   def teardown
@@ -107,6 +110,117 @@ class TestStomp < Test::Unit::TestCase
     assert_equal "b\0", msg_b.body
   end
 
+  def test_thread_hang_one
+    received = nil
+    Thread.new(@conn) do |amq|
+        while true
+            received = amq.receive
+        end
+    end
+    #
+    @conn.subscribe( make_destination )
+    message = Time.now.to_s
+    @conn.publish(make_destination, message)
+    sleep 1
+    assert_not_nil received
+    assert_equal message, received.body
+  end
+
+  def test_thread_poll_one
+    received = nil
+    Thread.new(@conn) do |amq|
+        while true
+          received = amq.poll
+          # One message is needed
+          Thread.exit if received
+          sleep 0.1
+        end
+    end
+    #
+    @conn.subscribe( make_destination )
+    message = Time.now.to_s
+    @conn.publish(make_destination, message)
+    sleep 1
+    assert_not_nil received
+    assert_equal message, received.body
+  end
+
+  def test_multi_thread_receive
+    lock = Mutex.new
+    msg_ctr = 0
+    #
+    1.upto(@max_threads) do |tnum|
+      Thread.new(@conn) do |amq|
+        while true
+          received = amq.receive
+          lock.synchronize do
+            msg_ctr += 1
+          end
+          # Simulate message processing
+          sleep 0.05
+        end
+      end
+    end
+    #
+    @conn.subscribe( make_destination )
+    1.upto(@max_msgs) do |mnum|
+      msg = Time.now.to_s + " #{mnum}"
+      @conn.publish(make_destination, msg)
+    end
+    #
+    max_sleep=5
+    sleep_incr = 0.10
+    total_slept = 0
+    while true
+      break if @max_msgs == msg_ctr
+      total_slept += sleep_incr
+      break if total_slept > max_sleep
+      sleep sleep_incr
+    end
+    assert_equal @max_msgs, msg_ctr
+  end
+
+  def test_multi_thread_poll
+    #
+    lock = Mutex.new
+    msg_ctr = 0
+    #
+    1.upto(@max_threads) do |tnum|
+      Thread.new(@conn) do |amq|
+        while true
+          received = amq.poll
+          if received
+            lock.synchronize do
+              msg_ctr += 1
+            end
+            # Simulate message processing
+            sleep 0.05
+          else
+            # Wait a bit for more work
+            sleep 0.05
+          end
+        end
+      end
+    end
+    #
+    @conn.subscribe( make_destination )
+    1.upto(@max_msgs) do |mnum|
+      msg = Time.now.to_s + " #{mnum}"
+      @conn.publish(make_destination, msg)
+    end
+    #
+    max_sleep=5
+    sleep_incr = 0.10
+    total_slept = 0
+    while true
+      break if @max_msgs == msg_ctr
+      total_slept += sleep_incr
+      break if total_slept > max_sleep
+      sleep sleep_incr
+    end
+    assert_equal @max_msgs, msg_ctr
+  end
+
   private
     def make_destination
       "/queue/test/ruby/stomp/" + name
@@ -133,3 +247,4 @@ class TestStomp < Test::Unit::TestCase
       assert_equal "txn message", msg.body
     end
 end
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: stomp
 version: !ruby/object:Gem::Version 
-  version: 1.1.5
+  version: 1.1.6
 platform: ruby
 authors: 
 - Brian McCallister
@@ -11,7 +11,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-03-17 00:00:00 -03:00
+date: 2010-06-10 00:00:00 -03:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency