stomp 1.4.3 → 1.4.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d3b0e0643f14d3e248a463fd9e7dda3bbf193c3c
-  data.tar.gz: 3a0cc2781ddda5adec47b27085cbb4bd3154d7e3
+  metadata.gz: 138654f82256d2b0bf65dd034e2a2ec725eefb55
+  data.tar.gz: 72b543959edfb3122a83d7ed9e01b22f54225f72
 SHA512:
-  metadata.gz: d9f5f664f9ef05288b5e237c4871ae61ec571e109eed6db1babda61fff7ca374b200b5f127a8b999c6becab0442a40d56987d0a896330180fcdd33d2e92ec28f
-  data.tar.gz: f559956891901862a57db82e33439bc46796a5c30b5eb8cdad29bace81a8d88f111a49cb826f5362b15a3e6176176a7a2136ad57322d24c64ccb0cfff7ebd0c3
+  metadata.gz: 13af9a61a1843e1d08f99430287cd416dca94785287cc2542cfc7979bda7896e295c4085748a4daf8bce1064bfd01e11a2b4325ab60ee7310b8cc553bb504c02
+  data.tar.gz: b8ba033de3d30b6b1502a8e41e2d7015fe37dbb68b37c8e040ee9ec6fddcf2385a84e2295392bfa3eb7aafb93ab888087f17ee7136bf12c36b838410986a132e

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 # Stomp Gem Change Log
 
+## 1.4.4 20170611
+
+* Merge fix for issue 141.
+* Fix broken MatReconnectAttempts
+* Attempt to detect mismatched SSL port and params.
+* Issue 139, add ssl checks to receive timeout logic.
+* Eliminate assert_nothing_raised from tests.
+* Add Artemis suport to standard test bed.
+* Run JRuby tests more easily.
+
 ## 1.4.3 20160821
 
 * Quick fix of install failures.  Do not try to use install 1.4.2.

data/README.md

@@ -93,6 +93,7 @@ A Stomp URL must begin with 'stomp://' and can be in one of the following forms:
 
 See _CHANGELOG.rdoc_ for details.
 
+* Gem version 1.4.4. Miscellaneous fixes, see CHANGELOG.rdoc for details.
 * Gem version 1.4.3. Fix broken install.  Do not try to install 1.4.2.
 * Gem version 1.4.2. Fix memory leak, and others !: see CHANGELOG.md for details.
 * Gem version 1.4.1. Important SSL changes !: see CHANGELOG.md for details.
@@ -293,7 +294,7 @@ Thiago Morello
 2009-12-25
 </td>
 <td style="border: 1px solid black;padding-left: 10px;" >
-(0369)
+(0387)
 </td>
 <td style="border: 1px solid black;padding-left: 10px;" >
 <span style="font-weight: bold;" >
@@ -321,7 +322,7 @@ Rafael Rosa
 2010-03-23
 </td>
 <td style="border: 1px solid black;padding-left: 10px;" >
-(0024)
+(0042)
 </td>
 <td style="border: 1px solid black;padding-left: 10px;" >
 <span style="font-weight: bold;" >
@@ -727,7 +728,7 @@ Nikolay Khasanov
 2016-07-16
 </td>
 <td style="border: 1px solid black;padding-left: 10px;" >
-(0004)
+(0006)
 </td>
 <td style="border: 1px solid black;padding-left: 10px;" >
 <span style="font-weight: bold;" >
@@ -764,4 +765,46 @@ Alexandre Moutot
  / a.moutot@alphalink.fr
 </td>
 </tr>
+<tr>
+<td style="border: 1px solid black;padding-left: 10px;" >
+2016-10-25
+</td>
+<td style="border: 1px solid black;padding-left: 10px;" >
+(0001)
+</td>
+<td style="border: 1px solid black;padding-left: 10px;" >
+<span style="font-weight: bold;" >
+Raducu Deaconu
+</span>
+ / raducu.deaconu@visma.com
+</td>
+</tr>
+<tr>
+<td style="border: 1px solid black;padding-left: 10px;" >
+2017-03-23
+</td>
+<td style="border: 1px solid black;padding-left: 10px;" >
+(0001)
+</td>
+<td style="border: 1px solid black;padding-left: 10px;" >
+<span style="font-weight: bold;" >
+Steve Traylen
+</span>
+ / steve.traylen@cern.ch
+</td>
+</tr>
+<tr>
+<td style="border: 1px solid black;padding-left: 10px;" >
+2017-06-01
+</td>
+<td style="border: 1px solid black;padding-left: 10px;" >
+(0001)
+</td>
+<td style="border: 1px solid black;padding-left: 10px;" >
+<span style="font-weight: bold;" >
+Michael Smith
+</span>
+ / michael.smith@puppet.com
+</td>
+</tr>
 </table>

data/examples/artemis/artlogger.rb

@@ -0,0 +1,41 @@
+# -*- encoding: utf-8 -*-
+
+require 'logger'	# use the standard Ruby logger .....
+#
+class Slogger
+
+  # Initialize a new callback logger instance.
+  def initialize(init_parms = nil)
+    _init
+    @log.info("Logger initialization complete.")
+  end
+
+  def _init
+    @log = Logger::new(STDERR)		# User preference
+    @log.level = Logger::DEBUG		# User preference
+  end
+
+  # Log connecting events
+  def on_connecting(parms)
+    begin
+      @log.debug "Connecting: #{parms}"
+    rescue Exception => ex
+      @log.debug "Connecting oops"
+      print ex.backtrace.join("\n")
+    end
+  end
+
+  # Log connected events
+  def on_connected(parms)
+    begin
+      @log.debug "Connected: #{parms}"
+    rescue Exception => ex
+      @log.debug "Connected oops"
+      print ex.backtrace.join("\n")
+    end
+  end
+
+  private
+
+end # of class
+

data/examples/artemis/cliwaiter_not_reliable.rb

@@ -0,0 +1,66 @@
+# -*- encoding: utf-8 -*-
+#
+require 'stomp'
+#
+class CliWaiter
+
+  @@retry_num = 0
+  @@max_retries = 3
+
+  # Initialize.
+  def initialize        # Change the following as needed.
+	@gem_retries = false
+	@host = ENV['STOMP_HOST'] ? ENV['STOMP_HOST'] : "localhost"
+	@port = ENV['STOMP_PORT'] ? ENV['STOMP_PORT'].to_i : 31613 # Artemis here
+	@slt = 75
+	@ver = ENV['STOMP_PROTOCOL'] ? ENV['STOMP_PROTOCOL'] : "1.2"
+	@hbdata = ENV['STOMP_HEARTBEATS'] ? ENV['STOMP_HEARTBEATS'] : "0,0"
+	@conn_hdrs = {"accept-version" => @ver, # version
+		"host" => "localhost",              # vhost
+		"heart-beat" => @hbdata,            # heartbeats
+	}
+	@hash = { :hosts => [
+				{:login => 'guest', :passcode => 'guest', :host => @host, :port => @port},
+		],
+		:reliable => @gem_retries, # reliable controls retries by the gem
+		:autoflush => true,
+		:connect_headers => @conn_hdrs,
+	}
+	p [ "DB1", @hash ]
+	@do_retry=true    # Retry ourself, gem code will not because of :reliable =>
+  end
+  # Run example.
+  def run
+	begin
+		@@retry_num += 1
+		puts "Try Number: #{@@retry_num}"
+		puts "Connect host: #{@host}, port: #{@port}"
+		puts "Connect hash: #{@hash.inspect}"
+		#
+		puts "CliWaiter Starts"
+		c = Stomp::Client.new(@hash)
+		#
+		puts "CliWaiter Sleeps: #{@slt} seconds"
+		sleep @slt
+		#
+		c.close
+		puts "CliWaiter Ends"
+	rescue Exception => ex
+		puts "Kaboom, we are in trouble"
+		puts "Exception Message: #{ex.message}"
+		puts "Exception Class: #{ex.class}"
+		puts "The gory details:"
+		print ex.backtrace.join("\n")
+		if @do_retry && @@retry_num < @@max_retries
+			retry
+		else
+			raise
+		end
+	end            
+  end
+end
+#
+
+#
+e = CliWaiter.new
+e.run

data/examples/artemis/cliwaiter_reliable.rb

@@ -0,0 +1,61 @@
+# -*- encoding: utf-8 -*-
+#
+require 'stomp'
+#
+if Kernel.respond_to?(:require_relative)
+  require_relative("artlogger")
+else
+  $LOAD_PATH << File.dirname(__FILE__)
+  require "artlogger"
+end
+#
+class CliWaiter
+
+  # Initialize.
+  def initialize        # Change the following as needed.
+	#
+	mylog = Slogger::new  # a stomp callback logger
+	#
+	@gem_retries = true
+	@host = ENV['STOMP_HOST'] ? ENV['STOMP_HOST'] : "localhost"
+	@port = ENV['STOMP_PORT'] ? ENV['STOMP_PORT'].to_i : 31613 # Artemis here
+	@slt = 75
+	@ver = ENV['STOMP_PROTOCOL'] ? ENV['STOMP_PROTOCOL'] : "1.2"
+	@hbdata = ENV['STOMP_HEARTBEATS'] ? ENV['STOMP_HEARTBEATS'] : "0,0"
+	@conn_hdrs = {"accept-version" => @ver, # version
+		"host" => "localhost",              # vhost
+		"heart-beat" => @hbdata,            # heartbeats		
+	}
+	@hash = { :hosts => [
+				{:login => 'guest', :passcode => 'guest', :host => @host, :port => @port},
+		],
+		:reliable => @gem_retries, # reliable controls retries by the gem
+	    :logger => mylog,	# This enables callback logging!
+		:autoflush => true,
+		:connect_headers => @conn_hdrs,
+		:initial_reconnect_delay => 1.0,    # initial delay before reconnect (secs)
+		:use_exponential_back_off => false, # don't backoff
+		:max_reconnect_attempts => 3,       # retry 3 times
+	}
+  end
+  # Run example.
+  def run
+	puts "Connect host: #{@host}, port: #{@port}"
+	puts "Connect hash: #{@hash}"
+	#
+	puts "CliWaiter Starts"
+	c = Stomp::Client.new(@hash)
+	#
+	while true 
+		puts "CliWaiter Sleeps: #{@slt} seconds"
+		sleep @slt
+	end
+	#
+	c.close
+  end
+end
+#
+
+#
+e = CliWaiter.new
+e.run

data/examples/contrib.sh

@@ -2,5 +2,5 @@
 #
 # git log --reverse --all --date=short --pretty --format='%aI;%cI;%cn;%ce' | \
 git log --reverse --all --date=short --pretty --format='%ad;%cd;%cn;%ce' | \
-    ruby examples/contributors.rb
- 
+    ruby $HOME/bin/contributors.rb
+ 

data/examples/examplogger.rb

@@ -102,9 +102,11 @@ class Slogger
       @log.debug "Connect Fail oops"
     end
 =begin
-    # An example LoggerConnectionError raise
-    @log.debug "Connect Fail, will raise"
-    raise Stomp::Error::LoggerConnectionError.new("quit from connect fail")
+    rescue
+      # An example LoggerConnectionError raise
+      @log.debug "Connect Fail, will raise"
+      raise Stomp::Error::LoggerConnectionError.new("quit from connect fail")
+    end
 =end
   end
 

data/examples/ssl_uc1.rb

@@ -33,7 +33,10 @@ class ExampleSSL1
   # Run example.
   def run
 		puts "Connect host: #{@host}, port: #{@port}"
-    ssl_opts = Stomp::SSLParams.new
+
+    ssl_opts = Stomp::SSLParams.new # or ssl_opts = true (for this use case)
+    #### ssl_opts = false # for testing HandShakeDetectedError exception
+    
     hash = { :hosts => [
         {:login => 'guest', :passcode => 'guest', :host => @host, :port => @port, :ssl => ssl_opts},
       ],
@@ -52,4 +55,3 @@ end
 #
 e = ExampleSSL1.new
 e.run
-

data/lib/client/utils.rb

@@ -25,12 +25,15 @@ module Stomp
       url = regexp.match(login)
       $VERBOSE = original_verbose
       return false unless url
-
+      @login =  url[3] || ""
+      @passcode = url[4] || ""
+      @host = url[5]
+      @port = url[6].to_i
       @parameters = { :reliable => false,
-                      :hosts => [ { :login => url[3] || "",
-                                    :passcode => url[4] || "",
-                                    :host => url[5],
-                                    :port => url[6].to_i} ] }
+                      :hosts => [ { :login => @login,
+                                    :passcode => @passcode,
+                                    :host => @host,
+                                    :port => @port} ] }
       true
     end
 
@@ -78,6 +81,7 @@ module Stomp
     def build_subscription_id(destination, headers)
       return headers[:id] until headers[:id].nil?
       return headers['id'] until headers['id'].nil?
+      # p [ "DBBSID1", destination, headers ]
       Digest::SHA1.hexdigest(destination)
     end
 
@@ -106,7 +110,7 @@ module Stomp
       @parameters[:hosts].each do |hv|
         # Validate port requested
         raise ArgumentError.new("empty :port value in #{hv.inspect}") if hv[:port] == ''
-        unless hv[:port].nil? 
+        unless hv[:port].nil?
           tpv = hv[:port].to_i
           raise ArgumentError.new("invalid :port value=#{tpv} from #{hv.inspect}") if tpv < 1 || tpv > 65535
         end
@@ -204,4 +208,3 @@ module Stomp
   end # class Client
 
 end # module Stomp
-

data/lib/connection/heartbeats.rb

@@ -107,9 +107,9 @@ module Stomp
           compval = (@hbsend_interval - (@hbsend_interval/5.0)) / 1000000.0
           if delta > compval || first_time
             first_time = false
-            slog(:on_hbfire, log_params, "send_heartbeat", :last_sleep => slt,
+            slog(:on_hbfire, log_params, "send_heartbeat", {:last_sleep => slt,
                     :curt => curt, :last_send => @ls, :delta => delta,
-                    :compval => compval)
+                    :compval => compval})
             # Send a heartbeat
             @transmit_semaphore.synchronize do
               begin
@@ -194,7 +194,8 @@ module Stomp
                   slog(:on_hbread_fail, log_params, {"ticker_interval" => sleeptime,
                     "read_fail_count" => read_fail_count,
                     "lock_fail" => false,
-                    "lock_fail_count" => lock_fail_count})
+                    "lock_fail_count" => lock_fail_count,
+                    "fail_point" => "not_ready"})
                 end
               else  # try_lock failed
                 # Shrug.  Could not get lock.  Client must be actually be reading.
@@ -204,7 +205,8 @@ module Stomp
                 slog(:on_hbread_fail, log_params, {"ticker_interval" => sleeptime,
                   "read_fail_count" => read_fail_count,
                   "lock_fail" => true,
-                  "lock_fail_count" => lock_fail_count})
+                  "lock_fail_count" => lock_fail_count,
+                  "fail_point" => "try_lock_fail"})
               end # of the try_lock
 
             else # delta <= sleeptime
@@ -216,7 +218,8 @@ module Stomp
             slog(:on_hbread_fail, log_params, {"ticker_interval" => sleeptime,
               "exception" => recvex,
               "read_fail_count" => read_fail_count,
-              "lock_fail_count" => lock_fail_count})
+              "lock_fail_count" => lock_fail_count,
+              "fail_point" => "receive_exception"})
             fail_hard = true
           end
           # Do we want to attempt a retry?
@@ -227,17 +230,17 @@ module Stomp
               # This is an attempt at a connection retry.
               @st.kill if @st   # Kill the sender thread if one exists
               _reconn_prep_hb() # Drive reconnection logic
-              Thread.exit       # This receiver thread is done            
+              Thread.exit       # This receiver thread is done
             end
             # Retry on max lock fails.  Different logic in order to avoid a deadlock.
             if (@max_hbrlck_fails > 0 && lock_fail_count >= @max_hbrlck_fails)
               # This is an attempt at a connection retry.
-              begin
-                @socket.close # Attempt a forced close
-              rescue
+              @gets_semaphore.synchronize do
+                @getst.raise(Errno::EBADF.new) if @getst # kill the socket reading thread if exists
+                @socket.close rescue nil # Attempt a forced close
               end
               @st.kill if @st   # Kill the sender thread if one exists
-              Thread.exit       # This receiver thread is done            
+              Thread.exit       # This receiver thread is done
             end
           end
           Thread.pass         # Prior to next receive loop
@@ -259,4 +262,3 @@ module Stomp
   end # class Connection
 
 end # module Stomp
-

data/lib/connection/netio.rb

@@ -9,6 +9,17 @@ module Stomp
 
   class Connection
 
+      def _interruptible_gets(read_socket)
+        # The gets thread may be interrupted by the heartbeat thread. Ensure that
+        # if so interrupted, a new gets cannot start until after the heartbeat
+        # thread finishes its work. This is PURELY to avoid a segfault bug
+        # involving OpenSSL::Buffer.
+        @gets_semaphore.synchronize { @getst = Thread.current }
+        read_socket.gets
+      ensure
+        @gets_semaphore.synchronize { @getst = nil }
+      end
+
       private
 
       # Really read from the wire.
@@ -40,6 +51,9 @@ module Stomp
           return nil if line.nil?
           #An extra \n at the beginning of the frame, possibly not caught by is_ready?
           line = '' if line == "\n"
+          if line == HAND_SHAKE_DATA
+            raise Stomp::Error::HandShakeDetectedError
+          end
           p [ "wiredatain_01A", line, Time.now ] if drdbg
           line = _normalize_line_end(line) if @protocol >= Stomp::SPL_12
           p [ "wiredatain_01B", line, Time.now ] if drdbg
@@ -48,11 +62,11 @@ module Stomp
           begin
             message_header += line
             p [ "wiredatain_02A", line, Time.now ] if drdbg
-            unless connread
+            unless connread || @ssl
               raise Stomp::Error::ReceiveTimeout unless IO.select([read_socket], nil, nil, @iosto)
             end
             p [ "wiredatain_02B", line, Time.now ] if drdbg
-            line = read_socket.gets
+            line = _interruptible_gets(read_socket)
             p [ "wiredatain_02C", line ] if drdbg
             raise  if line.nil?
             line = _normalize_line_end(line) if @protocol >= Stomp::SPL_12
@@ -66,18 +80,18 @@ module Stomp
           p [ "wiredatain_03B", content_length ] if drdbg
           # If content_length is present, read the specified amount of bytes
           if content_length
-            unless connread
+            unless connread || @ssl
               raise Stomp::Error::ReceiveTimeout unless IO.select([read_socket], nil, nil, @iosto)
             end
             p [ "CL01" ] if drdbg
             message_body = read_socket.read content_length[1].to_i
-            unless connread
+            unless connread || @ssl
               raise Stomp::Error::ReceiveTimeout unless IO.select([read_socket], nil, nil, @iosto)
             end
             raise Stomp::Error::InvalidMessageLength unless parse_char(read_socket.getc) == "\0"
             # Else read the rest of the message until the first \0
           else
-            unless connread
+            unless connread || @ssl
               raise Stomp::Error::ReceiveTimeout unless IO.select([read_socket], nil, nil, @iosto)
             end
             p [ "NOCL01" ] if drdbg
@@ -99,7 +113,7 @@ module Stomp
           # asynchronous nature of the 'poll' method.
           p [ "wiredatain_05_prep", "isr", _is_ready?(read_socket) ] if drdbg
           while _is_ready?(read_socket)
-            unless connread
+            unless connread || @ssl
               raise Stomp::Error::ReceiveTimeout unless IO.select([read_socket], nil, nil, @iosto)
             end
             p [ "WHIR01" ] if drdbg
@@ -162,7 +176,7 @@ module Stomp
       # transmit logically puts a Message on the wire.
       def transmit(command, headers = {}, body = '')
         # The transmit may fail so we may need to retry.
-        while TRUE
+        while true
           begin
             used_socket = socket()
             _transmit(used_socket, command, headers, body)
@@ -207,7 +221,7 @@ module Stomp
           # For more information refer to http://juretta.com/log/2009/05/24/activemq-jms-stomp/
           # Lets send this header in the message, so it can maintain state when using unreceive
           headers[:'content-length'] = "#{body_length_bytes}" unless headers[:suppress_content_length]
-          headers[:'content-type'] = "text/plain; charset=UTF-8" unless headers[:'content-type']
+          headers[:'content-type'] = "text/plain; charset=UTF-8" unless headers[:'content-type'] || headers[:suppress_content_type]
           _wire_write(used_socket,command)
           headers.each do |k,v|
             if v.is_a?(Array)
@@ -219,7 +233,17 @@ module Stomp
             end
           end
           _wire_write(used_socket,"")
-          used_socket.write body unless body == ''
+          if body != ''
+            if headers[:suppress_content_length]
+              if tz = body.index("\00")
+                used_socket.write body[0..tz-1]
+              else
+                used_socket.write body
+              end
+            else
+              used_socket.write body
+            end
+          end
           used_socket.write "\0"
           used_socket.flush if autoflush
 
@@ -332,7 +356,7 @@ module Stomp
             # Set SSLContext Options if user asks for it in Stomp::SSLParams
             # and SSL supports it.
             if @ssl.ssl_ctxopts && ctx.respond_to?(:options=)
-	            ctx.options = @ssl.ssl_ctxopts
+              ctx.options = @ssl.ssl_ctxopts
             end
 
           end
@@ -449,24 +473,24 @@ module Stomp
               if RUBY_VERSION <  "2"
                 while true
                   ### p [ "ilrjr01A1", _is_ready?(read_socket) ]
-                  line = read_socket.gets # Data from wire
+                  line = _interruptible_gets(read_socket) # Data from wire
                   break unless line == "\n"
                   line = ''
                 end
               else # RUBY_VERSION >= "2"
                 while _is_ready?(read_socket)
                   ### p [ "ilrjr01B2", _is_ready?(read_socket) ]
-                  line = read_socket.gets # Data from wire
+                  line = _interruptible_gets(read_socket) # Data from wire
                   break unless line == "\n"
                   line = ''
                 end
               end
             else
-              line = read_socket.gets # The old way
+              line = _interruptible_gets(read_socket) # The old way
             end
           else # We are >= 1.1 *AND* receiving heartbeats.
             while true
-              line = read_socket.gets # Data from wire
+              line = _interruptible_gets(read_socket) # Data from wire
               break unless line == "\n"
               line = ''
               @lr = Time.now.to_f
@@ -490,6 +514,15 @@ module Stomp
         end
       end # _dump_callstack
 
+      # used for debugging
+      def _dump_threads()
+        tl = Thread::list
+        tl.each do |at|
+          p [ "THDMPN", at ]
+        end
+        p [ "THDMPMain", @parameters[:client_main] ]
+      end
+
   end # class Connection
 
 end # module Stomp