jruby-jms 0.11.0 → 0.11.1

data/HISTORY.md

@@ -1,3 +1,8 @@
+## 0.11.1 (2011-05-25)
+
+* Fixes the condition where a bad session keeps being re-used in a session pool.
+  It is now removed from the pool anytime a JMS exception has occurred
+
 ## 0.11.0 (2011-04-18)
 
 * Compatibility with JRuby 1.6

data/Rakefile

@@ -9,7 +9,7 @@ desc "Build gem"
 task :gem  do |t|
   gemspec = Gem::Specification.new do |s|
     s.name = 'jruby-jms'
-    s.version = '0.11.0'
+    s.version = '0.11.1'
     s.author = 'Reid Morrison'
     s.email = 'rubywmq@gmail.com'
     s.homepage = 'https://github.com/reidmorrison/jruby-jms'

data/lib/jms/session_pool.rb

@@ -24,7 +24,7 @@ module JMS
   #                      Default: 5.0
   #   :pool_logger       Supply a logger that responds to #debug, #info, #warn and #debug?
   #                      For example: Rails.logger
-  #                      Default: None
+  #                      Default: JMS.logger
   # Example:
   #   session_pool = connection.create_session_pool(config)
   #   session_pool.session do |session|
@@ -35,7 +35,7 @@ module JMS
       # Save Session params since it will be used every time a new session is
       # created in the pool
       session_params = params.nil? ? {} : params.dup
-      logger = session_params[:pool_logger]
+      logger = session_params[:pool_logger] || JMS.logger
       # Define how GenePool can create new sessions
       @pool = GenePool.new(
         :name => session_params[:pool_name] || self.class.name,
@@ -54,10 +54,22 @@ module JMS
 
     # Obtain a session from the pool and pass it to the supplied block
     # The session is automatically returned to the pool once the block completes
+    #
+    # In the event a JMS Exception is thrown the session will be closed and removed
+    # from the pool to prevent re-using sessions that are no longer valid
     def session(&block)
-      #TODO Check if session is open?
-      @pool.with_connection &block
-      #TODO Catch connection failures and release from pool?
+      s = nil
+      begin
+        s = @pool.checkout
+        block.call(s)
+      rescue javax.jms.JMSException => e
+        s.close rescue nil
+        @pool.remove(s)
+        s = nil # Do not check back in since we have removed it
+        raise e
+      ensure
+        @pool.checkin(s) if s
+      end
     end
 
     # Obtain a session from the pool and create a MessageConsumer.
@@ -133,13 +145,16 @@ module JMS
 
     # Immediately Close all sessions in the pool and release from the pool
     #
+    # Note: This is an immediate close, active sessions will be aborted
+    #
+    # Note: Once closed a session pool cannot be re-used. A new instance must
+    #       be created
+    #
     # TODO: Allow an option to wait for active sessions to be returned before
     #       closing
     def close
       @pool.each do |s|
-        #@pool.remove(s)
         s.close
-        #@pool.remove(s)
       end
     end
 

data/test/message_test.rb

@@ -31,7 +31,7 @@ class JMSTest < Test::Unit::TestCase
           producer.send(session.message('Hello World'))
 
           # Consume Message
-          session.consume(:destination => producer.destination) do |message|
+          session.consume(:destination => producer.destination, :timeout=>1000) do |message|
             assert_equal message.java_kind_of?(JMS::TextMessage), true
             data = message.data
           end
@@ -44,7 +44,7 @@ class JMSTest < Test::Unit::TestCase
       JMS::Connection.session(@config) do |session|
         assert_not_nil session
         data = :timed_out
-        browse_data = nil
+        browse_data = :timed_out
         session.producer(:queue_name => @queue_name) do |producer|
           # Send Message
           producer.send(session.message('Hello World'))
@@ -56,7 +56,7 @@ class JMSTest < Test::Unit::TestCase
           end
 
           # Consume Message
-          session.consume(:queue_name => @queue_name) do |message|
+          session.consume(:queue_name => @queue_name, :timeout=>1000) do |message|
             assert_equal message.java_kind_of?(JMS::TextMessage), true
             data = message.data
           end
@@ -91,7 +91,7 @@ class JMSTest < Test::Unit::TestCase
           producer.send(message)
 
           # Consume Message
-          session.consume(:destination => producer.destination) do |message|
+          session.consume(:destination => producer.destination, :timeout=>1000) do |message|
             assert_equal message.java_kind_of?(JMS::TextMessage), true
             data = message.data
             #assert_equal :non_persistent, message.jms_delivery_mode
@@ -116,7 +116,7 @@ class JMSTest < Test::Unit::TestCase
           producer.send(message)
 
           # Consume Message
-          session.consume(:destination => producer.destination) do |message|
+          session.consume(:destination => producer.destination, :timeout=>1000) do |message|
             assert_equal message.java_kind_of?(JMS::TextMessage), true
             data = message.data
             assert_equal :persistent, message.jms_delivery_mode_sym

data/test/session_pool_test.rb

@@ -0,0 +1,86 @@
+# Allow examples to be run in-place without requiring a gem install
+$LOAD_PATH.unshift File.dirname(__FILE__) + '/../lib'
+
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+require 'jms'
+require 'yaml'
+
+class JMSTest < Test::Unit::TestCase
+  context 'JMS Session' do
+    # Load configuration from jms.yml
+    setup do
+      # To change the JMS provider, edit jms.yml and change :default
+
+      # Load Connection parameters from configuration file
+      cfg = YAML.load_file(File.join(File.dirname(__FILE__), 'jms.yml'))
+      jms_provider = cfg['default']
+      @config = cfg[jms_provider]
+      raise "JMS Provider option:#{jms_provider} not found in jms.yml file" unless @config
+      @queue_name = @config.delete(:queue_name) || raise("Mandatory :queue_name missing from jms.yml")
+      @topic_name = @config.delete(:topic_name) || raise("Mandatory :topic_name missing from jms.yml")
+      @pool_params = {
+        :pool_name         => 'Test::JMS::SessionPool',
+        :pool_size         => 10,
+        :pool_warn_timeout => 5.0,
+        #:pool_logger       =>
+      }
+    end
+
+    should 'create a session pool' do
+      JMS::Connection.start(@config) do |connection|
+        pool = connection.create_session_pool(@pool_params)
+        pool.session do |session|
+          assert_not_nil session
+          assert session.is_a?(javax.jms.Session)
+        end
+        pool.close
+      end
+    end
+
+    should 'remove bad session from pool' do
+      JMS::Connection.start(@config) do |connection|
+        pool = connection.create_session_pool(@pool_params.merge(:pool_size=>1))
+        s = nil
+        r = begin
+          pool.session do |session|
+            assert_not_nil session
+            assert session.is_a?(javax.jms.Session)
+            s = session
+            s.close
+            s.create_map_message
+            false
+          end
+        rescue javax.jms.IllegalStateException
+          true
+        end
+        assert r == true
+
+        # Now verify that the previous closed session was removed from the pool
+        pool.session do |session|
+          assert_not_nil session
+          assert session.is_a?(javax.jms.Session)
+          assert s != session
+          session.create_map_message
+        end
+      end
+    end
+
+    should 'allow multiple sessions to be used concurrently' do
+      JMS::Connection.start(@config) do |connection|
+        pool = connection.create_session_pool(@pool_params)
+        pool.session do |session|
+          assert_not_nil session
+          assert session.is_a?(javax.jms.Session)
+          pool.session do |session2|
+            assert_not_nil session2
+            assert session2.is_a?(javax.jms.Session)
+            assert session != session2
+          end
+        end
+      end
+    end
+
+  end
+end

metadata

@@ -2,7 +2,7 @@
 name: jruby-jms
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.11.0
+  version: 0.11.1
 platform: ruby
 authors: 
   - Reid Morrison
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-04-19 00:00:00 -04:00
+date: 2011-05-25 00:00:00 -04:00
 default_executable: 
 dependencies: []
 
@@ -92,6 +92,7 @@ files:
   - test/connection_test.rb
   - test/jms.yml
   - test/message_test.rb
+  - test/session_pool_test.rb
   - test/session_test.rb
 has_rdoc: true
 homepage: https://github.com/reidmorrison/jruby-jms