mongrel2 0.48.0 → 0.49.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6786f4a00423675914ad7830e93d7914890817b1
-  data.tar.gz: 35b28c12214e875845894b4b1ec1dd812826cd4b
+  metadata.gz: 944abee18512b2a14ea074675313be9c301e3960
+  data.tar.gz: d46b4b9b56a054bb195f4a42bf14b08f69164768
 SHA512:
-  metadata.gz: 99f3d11f3f3479494dd1659e6081a43cacfc6ec38252b81614ec2a19be448f7eada8a0818a5d45a44b5de00295a4d9594156b20ae63434eae75c33cf92d5e074
-  data.tar.gz: a9852093ada84552f79d1a5d5bdfea3cd04213bae5889edb6bf9d15ef46a895cda9ccbeb68013ce3da8472620427ee662a7cedf1bbac01aa7686ca5c45d5f6a2
+  metadata.gz: 5c4efad71c6dde2c3a8b15951c5651c6ac4bf2e37ff157b4b6f385f2ab0b0c0c9ee31714ef50f3926e987d079416c218b0aca38a3304624e787cdfaf7b201c26
+  data.tar.gz: eef053a14975b06e55e4ce1c459d56adbf5592a4668a4c2571f6cb2d47789211497ca283ddbe72369325abd761c175f6b755734c18394222467663fab2dae459

data/ChangeLog

@@ -1,8 +1,16 @@
 2016-11-23  Mahlon E. Smith  <mahlon@martini.nu>
 
+	* .hgtags:
+	Added tag v0.47.0 for changeset 3298fb41de78
+	[b01f4b4e8c2f] [tip]
+
+	* .hgsigs:
+	Added signature for changeset c4ae80fe8067
+	[3298fb41de78] [v0.47.0]
+
 	* History.rdoc, lib/mongrel2.rb:
 	Bump version, update History.
-	[c4ae80fe8067] [tip]
+	[c4ae80fe8067]
 
 	* lib/mongrel2/handler.rb, spec/mongrel2/handler_spec.rb:
 	Rather than waiting for GC to free up a descriptor, close spooled
@@ -13,7 +21,7 @@
 
 	* .hgtags:
 	Added tag v0.46.0 for changeset e7c165fb6bb2
-	[7f3c8162e5ef]
+	[7f3c8162e5ef] [github/master]
 
 	* .hgsigs:
 	Added signature for changeset a28294965462

data/History.rdoc

@@ -1,3 +1,10 @@
+==  v0.49.0 [2017-03-10] Michael Granger <ged@FaerieMUD.org>
+
+Enhancements:
+
+- Use the CZTop library instead of rbczmq for ZeroMQ sockets.
+
+
 == v0.48.0 [2017-01-16] Mahlon E. Smith <mahlon@martini.nu>
 
 Housekeeping:

data/Manifest.txt

@@ -8,24 +8,8 @@ Manifest.txt
 README.rdoc
 Rakefile
 bin/m2sh.rb
-data/mongrel2/bootstrap.html
-data/mongrel2/config.rb.in
 data/mongrel2/config.sql
-data/mongrel2/css/master.css
-data/mongrel2/index.html.in
-data/mongrel2/js/websock-test.js
 data/mongrel2/mimetypes.sql
-data/mongrel2/websock-test.html
-examples/Procfile
-examples/README.txt
-examples/async-upload.rb
-examples/config.rb
-examples/helloworld-handler.rb
-examples/request-dumper.rb
-examples/request-dumper.tmpl
-examples/run
-examples/sendfile.rb
-examples/ws-echo.rb
 lib/mongrel2.rb
 lib/mongrel2/config.rb
 lib/mongrel2/config/directory.rb

data/README.rdoc

@@ -155,10 +155,6 @@ and generate the API documentation.
 There are two other Mongrel2 Ruby libraries, +m2r+ +rack-mongrel2+.
 This implementation differs from them in several ways:
 
-* It uses a C extension for 0MQ (rbczmq) instead of the FFI one. If you
-  strongly prefer the FFI library, both of the other Mongrel2 libraries use
-  it, so you'll want to stick to one of them.
-
 * It doesn't come with a Rack handler, or Rails examples, or anything too
   fancy. I intend to build my own webby framework bits around Mongrel2, and
   I thought maybe someone else might want to as well. If you don't, well

data/Rakefile

@@ -25,15 +25,15 @@ hoespec = Hoe.spec 'mongrel2' do
 
 	self.developer 'Michael Granger', 'ged@FaerieMUD.org'
 
+	self.dependency 'cztop',       '~> 0.11'
+	self.dependency 'libxml-ruby', '~> 2.7'
+	self.dependency 'loggability', '~> 0.12'
 	self.dependency 'sequel',      '~> 4.2'
+	self.dependency 'sqlite3',     '~> 1.3'
+	self.dependency 'sysexits',    '~> 1.1'
 	self.dependency 'tnetstring',  '~> 0.3'
-	self.dependency 'yajl-ruby',   '~> 1.0'
 	self.dependency 'trollop',     '~> 2.0'
-	self.dependency 'sysexits',    '~> 1.1'
-	self.dependency 'rbczmq',      '~> 1.7'
-	self.dependency 'loggability', '~> 0.11'
-	self.dependency 'sqlite3',     '~> 1.3'
-	self.dependency 'libxml-ruby', '~> 2.7'
+	self.dependency 'yajl-ruby',   '~> 1.0'
 
 	self.dependency 'amalgalite',      '~> 1.5', :developer
 	self.dependency 'configurability', '~> 3.1', :developer
@@ -76,7 +76,7 @@ if File.directory?( '.hg' )
 end
 
 task :gemspec => GEMSPEC
-file GEMSPEC => __FILE__
+file GEMSPEC => [ __FILE__, 'Manifest.txt' ]
 task GEMSPEC do |task|
 	spec = $hoespec.spec
 	spec.files.delete( '.gemtest' )

data/lib/mongrel2.rb

@@ -1,11 +1,8 @@
 # -*- ruby -*-
 #encoding: utf-8
 
-# Ensure this is used instead of 'zmq' if it's also installed
-gem 'rbczmq'
-
 require 'loggability'
-require 'zmq'
+require 'cztop'
 
 #
 # A Mongrel2 connector and configuration library for Ruby.
@@ -25,10 +22,10 @@ module Mongrel2
 	abort "\n\n>>> Mongrel2 requires Ruby 2.2 or later. <<<\n\n" if RUBY_VERSION < '2.2.0'
 
 	# Library version constant
-	VERSION = '0.48.0'
+	VERSION = '0.49.0'
 
 	# Version-control revision constant
-	REVISION = %q$Revision: 50bb8c488bc4 $
+	REVISION = %q$Revision: e2508eadb52d $
 
 
 	require 'mongrel2/constants'
@@ -44,20 +41,6 @@ module Mongrel2
 	end
 
 
-	# ZMQ::Context (lazy-loaded)
-	@zmq_ctx = nil
-
-	### Fetch the ZMQ::Context for sockets, creating it if necessary.
-	def self::zmq_context
-		if @zmq_ctx.nil?
-			self.log.info "Using 0MQ %d.%d.%d" % ZMQ.version
-			@zmq_ctx = ZMQ::Context.new
-		end
-
-		return @zmq_ctx
-	end
-
-
 	require 'mongrel2/exceptions'
 	require 'mongrel2/connection'
 	require 'mongrel2/handler'
@@ -72,11 +55,3 @@ module Mongrel2
 end # module Mongrel2
 
 
-# Workaround for rbzmq <= 2.3.0
-unless defined?( ZMQ::Error )
-	module ZMQ
-		Error = ::RuntimeError
-	end
-end
-
-

data/lib/mongrel2/connection.rb

@@ -2,7 +2,7 @@
 #encoding: utf-8
 
 require 'socket'
-require 'zmq'
+require 'cztop'
 require 'yajl'
 require 'digest/sha1'
 require 'loggability'
@@ -66,17 +66,14 @@ class Mongrel2::Connection
 
 	### Establish both connections to the Mongrel2 server.
 	def connect
-		ctx = Mongrel2.zmq_context
-		self.log.debug "0mq Context is: %p" % [ ctx ]
-
 		self.log.info "Connecting PULL request socket (%s)" % [ self.sub_addr ]
-		@request_sock = ctx.socket( :PULL )
-		@request_sock.linger = 0
+		@request_sock = CZTop::Socket::PULL.new
+		@request_sock.options.linger = 0
 		@request_sock.connect( self.sub_addr )
 
 		self.log.info "Connecting PUB response socket (%s)" % [ self.pub_addr ]
-		@response_sock = ctx.socket( :PUB )
-		@response_sock.linger = 0
+		@response_sock = CZTop::Socket::PUB.new
+		@response_sock.options.linger = 0
 		@response_sock.connect( self.pub_addr )
 	end
 
@@ -104,7 +101,8 @@ class Mongrel2::Connection
 		self.check_closed
 
 		self.log.debug "Fetching next request (PULL)"
-		data = self.request_sock.recv or raise( ZMQ.error || 'unknown error' )
+		message = self.request_sock.receive
+		data = message.pop
 		self.log.debug "  got %d bytes of %s request data" % [ data.bytesize, data.encoding.name ]
 		return data
 	end
@@ -124,7 +122,7 @@ class Mongrel2::Connection
 		header = "%s %d:%s," % [ sender_id, conn_id.to_s.length, conn_id ]
 		buf = header + ' ' + data
 		self.log.debug "Sending response (PUB)"
-		self.response_sock.send( buf )
+		self.response_sock << buf
 		self.log.debug "  done with send (%d bytes)" % [ buf.bytesize ]
 	end
 
@@ -136,7 +134,7 @@ class Mongrel2::Connection
 		self.log.debug "Sending response with %s extended reply (PUB)"
 		header = "%s %d:X %s," % [ sender_id, conn_id.to_s.length + 2, conn_id ]
 		buf = header + ' ' + TNetstring.dump( [response_type] + data )
-		self.response_sock.send( buf )
+		self.response_sock << buf
 		self.log.debug "  done with send (%d bytes)" % [ buf.bytesize ]
 	end
 

data/lib/mongrel2/control.rb

@@ -1,6 +1,6 @@
 #!/usr/bin/ruby
 
-require 'zmq'
+require 'cztop'
 require 'yajl'
 require 'pathname'
 require 'tnetstring'
@@ -27,9 +27,8 @@ class Mongrel2::Control
 	### Create a new control port object using the current configuration.
 	def initialize( port=DEFAULT_PORT )
 		check_port( port )
-		@ctx = Mongrel2.zmq_context
-		@socket = @ctx.socket( :REQ )
-		@socket.linger = 0
+		@socket = CZTop::Socket::REQ.new
+		@socket.options.linger = 0
 		@socket.connect( port.to_s )
 	end
 
@@ -172,11 +171,11 @@ class Mongrel2::Control
 	def request( command, options={} )
 		msg = TNetstring.dump([ command, options ])
 		self.log.debug "Request: %p" % [ msg ]
-		self.socket.send( msg )
+		self.socket << msg
 
-		response = self.socket.recv
+		response = self.socket.receive
 		self.log.debug "Response: %p" % [ response ]
-		return unpack_response( response )
+		return unpack_response( response.pop )
 	end
 
 

data/lib/mongrel2/handler.rb

@@ -1,7 +1,7 @@
 #-*- ruby -*-
 #encoding: utf-8
 
-require 'zmq'
+require 'cztop'
 require 'loggability'
 
 require 'mongrel2' unless defined?( Mongrel2 )
@@ -135,8 +135,16 @@ class Mongrel2::Handler
 	### Create a new instance of the handler with the specified +app_id+, +send_spec+,
 	### and +recv_spec+.
 	def initialize( app_id, send_spec, recv_spec ) # :notnew:
-		@app_id = app_id
-		@conn   = Mongrel2::Connection.new( app_id, send_spec, recv_spec )
+		@app_id    = app_id
+		@conn      = Mongrel2::Connection.new( app_id, send_spec, recv_spec )
+#		@self_pipe = CZTop::Socket::PAIR.new( 'inproc://signal-handler' )
+
+		@self_pipe = {
+			reader: CZTop::Socket::PAIR.new( '@inproc://signal-handler' ),
+			writer: CZTop::Socket::PAIR.new( '>inproc://signal-handler' )
+		}
+
+		@poller = CZTop::Poller.new( @conn.request_sock, @self_pipe[:reader] )
 
 		Thread.main[:signal_queue] = []
 	end
@@ -156,6 +164,7 @@ class Mongrel2::Handler
 	### Run the handler.
 	def run
 		self.log.info "Starting up %p" % [ self ]
+
 		self.set_signal_handlers
 		self.start_accepting_requests
 
@@ -164,7 +173,6 @@ class Mongrel2::Handler
 		self.restore_signal_handlers
 		self.log.info "Done: %p" % [ self ]
 		@conn.close
-		Mongrel2.zmq_context.close if Mongrel2.zmq_context.respond_to?( :close )
 	end
 
 
@@ -222,6 +230,9 @@ class Mongrel2::Handler
 		self.log.info "Restarting"
 		old_conn = @conn
 		@conn = @conn.dup
+
+		@poller = CZTop::Poller.new( @conn.request_sock, @self_pipe[:reader] )
+
 		self.log.debug "  conn %p -> %p" % [ old_conn, @conn ]
 		old_conn.close
 	end
@@ -229,26 +240,34 @@ class Mongrel2::Handler
 
 	### Start a loop, accepting a request and handling it.
 	def start_accepting_requests
+		self.log.info "Starting the request loop."
 		until @conn.closed?
-			ZMQ.select([ @conn.request_sock ])
-			self.accept_request unless @conn.closed?
+			begin
+				if event = @poller.wait
+					case event.socket
+					when @conn.request_sock
+						req = @conn.receive
+						self.accept_request( req ) unless @conn.closed?
+					when @self_pipe[:reader]
+						@self_pipe[:reader].wait
+						self.process_signal_queue
+					else
+						self.log.warn "Got unhandled poller event: %p" % [ event ]
+					end
+				end
+			rescue Errno::EAGAIN
+				# self.log.debug "Got EAGAIN, retrying."
+			rescue Interrupt
+				# self.log.debug "Got an Interrupt; retrying."
+			end
 		end
-	rescue ZMQ::Error => err
-		self.process_signal_queue
-
-		unless @conn.closed?
-			self.log.error "%p while accepting requests: %s" % [ err.class, err.message ]
-			self.log.debug { err.backtrace.join("\n  ") }
 
-			# Restart the method
-			retry
-		end
+		self.log.debug "Done accepting requests."
 	end
 
 
 	### Read a request from the connection and dispatch it.
-	def accept_request
-		req = @conn.receive
+	def accept_request( req )
 		self.log.info( req.inspect )
 		res = self.dispatch_request( req )
 
@@ -414,11 +433,23 @@ class Mongrel2::Handler
 	# be handled, override #set_signal_handlers with an empty method.
 	#
 
+	### Wake up the handler when a signal needs to be processed.
+	def wake_up
+		$stderr.puts "Waking up the signal handler"
+		@self_pipe[ :writer ].signal( 0 )
+		$stderr.puts "Done sending the wakeup."
+	end
+
+
 	### Set up signal handlers for common signals that will shut down, restart, etc.
 	def set_signal_handlers
 		self.log.debug "Setting up deferred signal handlers."
 		QUEUE_SIGS.each do |sig|
-			Signal.trap( sig ) { Thread.main[:signal_queue] << sig }
+			Signal.trap( sig ) do
+				Thread.main[:signal_queue] << sig
+				self.wake_up
+				$stderr.puts "Done handling the signal."
+			end
 		end
 	end
 
@@ -440,6 +471,7 @@ class Mongrel2::Handler
 		end
 	end
 
+
 	### Handle any queued signals.
 	def process_signal_queue
 		# Look for any signals that arrived and handle them

data/spec/mongrel2/connection_spec.rb

@@ -2,6 +2,7 @@
 
 require_relative '../helpers'
 
+require 'ostruct'
 require 'mongrel2'
 require 'mongrel2/connection'
 
@@ -18,16 +19,9 @@ describe Mongrel2::Connection do
 
 	# Ensure 0MQ never actually gets called
 	before( :each ) do
-		@ctx = double( "0mq context" )
-		Mongrel2.instance_variable_set( :@zmq_ctx, @ctx )
-
 		@conn = Mongrel2::Connection.new( TEST_UUID, TEST_SEND_SPEC, TEST_RECV_SPEC )
 	end
 
-	after( :each ) do
-		Mongrel2.instance_variable_set( :@zmq_ctx, nil )
-	end
-
 
 	it "doesn't connect to the endpoints when it's created" do
 		expect( @conn.instance_variable_get( :@request_sock ) ).to be_nil()
@@ -35,16 +29,16 @@ describe Mongrel2::Connection do
 	end
 
 	it "connects to the endpoints specified on demand" do
-		request_sock = double( "request socket" )
-		response_sock = double( "response socket" )
+		request_sock = double( "request socket", options: OpenStruct.new )
+		response_sock = double( "response socket", options: OpenStruct.new )
 
-		expect( @ctx ).to receive( :socket ).with( :PULL ).and_return( request_sock )
-		expect( request_sock ).to receive( :linger= ).with( 0 )
+		expect( CZTop::Socket::PULL ).to receive( :new ).and_return( request_sock )
+		expect( request_sock.options ).to receive( :linger= ).with( 0 )
 		expect( request_sock ).to receive( :connect ).with( TEST_SEND_SPEC )
 
-		expect( @ctx ).to receive( :socket ).with( :PUB ).and_return( response_sock )
-		expect( response_sock ).to receive( :linger= ).with( 0 )
-		expect( response_sock ).to_not receive( :identity= )
+		expect( CZTop::Socket::PUB ).to receive( :new ).and_return( response_sock )
+		expect( response_sock.options ).to receive( :linger= ).with( 0 )
+		expect( response_sock.options ).to_not receive( :identity= )
 		expect( response_sock ).to receive( :connect ).with( TEST_RECV_SPEC )
 
 		expect( @conn.request_sock ).to eq( request_sock )
@@ -58,11 +52,11 @@ describe Mongrel2::Connection do
 	context "after a connection has been established" do
 
 		before( :each ) do
-			@request_sock = double( "request socket", :linger= => nil, :connect => nil )
-			@response_sock = double( "response socket", :linger= => nil, :connect => nil )
+			@request_sock = double( "request socket", :options => OpenStruct.new, :connect => nil )
+			@response_sock = double( "response socket", :options => OpenStruct.new, :connect => nil )
 
-			allow( @ctx ).to receive( :socket ).with( :PULL ).and_return( @request_sock )
-			allow( @ctx ).to receive( :socket ).with( :PUB ).and_return( @response_sock )
+			allow( CZTop::Socket::PULL ).to receive( :new ).and_return( @request_sock )
+			allow( CZTop::Socket::PUB ).to receive( :new ).and_return( @response_sock )
 
 			@conn.connect
 		end
@@ -87,10 +81,10 @@ describe Mongrel2::Connection do
 		end
 
 		it "doesn't keep its request and response sockets when duped" do
-			request_sock2 = double( "request socket", :linger= => nil, :connect => nil )
-			response_sock2 = double( "response socket", :linger= => nil, :connect => nil )
-			allow( @ctx ).to receive( :socket ).with( :PULL ).and_return( request_sock2 )
-			allow( @ctx ).to receive( :socket ).with( :PUB ).and_return( response_sock2 )
+			request_sock2 = double( "request socket", :options => OpenStruct.new, :connect => nil )
+			response_sock2 = double( "response socket", :options => OpenStruct.new, :connect => nil )
+			allow( CZTop::Socket::PULL ).to receive( :new ).and_return( request_sock2 )
+			allow( CZTop::Socket::PUB ).to receive( :new ).and_return( response_sock2 )
 
 			duplicate = @conn.dup
 
@@ -109,72 +103,56 @@ describe Mongrel2::Connection do
 		end
 
 		it "can read raw request messages off of the request_sock" do
-			expect( @request_sock ).to receive( :recv ).and_return( "the data" )
+			expect( @request_sock ).to receive( :receive ).and_return( CZTop::Message.new( "the data" ) )
 			expect( @conn.recv ).to eq( "the data" )
 		end
 
 		it "can read request messages off of the request_sock as Mongrel2::Request objects" do
 			msg = make_request()
-			expect( @request_sock ).to receive( :recv ).and_return( msg )
+			expect( @request_sock ).to receive( :receive ).and_return( CZTop::Message.new( msg ) )
 			expect( @conn.receive ).to be_a( Mongrel2::Request )
 		end
 
-		it "handles a socket error while receiving" do
-			expect( @request_sock ).to receive( :recv ).and_return( nil )
-			expect( ZMQ ).to receive( :error ).and_return( ZMQ::Error.new("something bad happened") )
-			expect {
-				@conn.receive
-			}.to raise_error( ZMQ::Error, 'something bad happened' )
-		end
-
-		it "handles a socket error that doesn't set an error message while receiving" do
-			expect( @request_sock ).to receive( :recv ).and_return( nil )
-			expect( ZMQ ).to receive( :error ).and_return( nil )
-			expect {
-				@conn.receive
-			}.to raise_error( RuntimeError, 'unknown error' )
-		end
-
 		it "can write raw response messages with a TNetString header onto the response_sock" do
-			expect( @response_sock ).to receive( :send ).with( "#{TEST_UUID} 1:8, the data" )
+			expect( @response_sock ).to receive( :<< ).with( "#{TEST_UUID} 1:8, the data" )
 			@conn.send( TEST_UUID, 8, "the data" )
 		end
 
 		it "can write Mongrel2::Responses to the response_sock" do
-			expect( @response_sock ).to receive( :send ).with( "#{TEST_UUID} 1:8, the data" )
+			expect( @response_sock ).to receive( :<< ).with( "#{TEST_UUID} 1:8, the data" )
 
 			response = Mongrel2::Response.new( TEST_UUID, 8, 'the data' )
 			@conn.reply( response )
 		end
 
 		it "can write raw response messages to more than one conn_id at the same time" do
-			expect( @response_sock ).to receive( :send ).
+			expect( @response_sock ).to receive( :<< ).
 				with( "#{TEST_UUID} 15:8 16 44 45 1833, the data" )
 			@conn.broadcast( TEST_UUID, [8, 16, 44, 45, 1833], 'the data' )
 		end
 
 		it "can write raw response messages to more than one conn_id at the same time" do
-			expect( @response_sock ).to receive( :send ).
+			expect( @response_sock ).to receive( :<< ).
 				with( "#{TEST_UUID} 15:8 16 44 45 1833, the data" )
 			@conn.broadcast( TEST_UUID, [8, 16, 44, 45, 1833], 'the data' )
 		end
 
 		it "can write an extended response message" do
-			expect( @response_sock ).to receive( :send ).
+			expect( @response_sock ).to receive( :<< ).
 				with( "#{TEST_UUID} 3:X 8, 27:8:sendfile,12:the_data.txt,]" )
 			@conn.send_extended( TEST_UUID, 8, :sendfile, "the_data.txt" )
 		end
 
 		it "can broadcast an extended response message" do
-			expect( @response_sock ).to receive( :send ).
+			expect( @response_sock ).to receive( :<< ).
 				with( "#{TEST_UUID} 9:X 8 16 32, 27:8:sendfile,12:the_data.txt,]" )
 			@conn.broadcast_extended( TEST_UUID, [8,16,32], :sendfile, "the_data.txt" )
 		end
 
 		it "can write a Mongrel2::Response with extended reply" do
-			expect( @response_sock ).to receive( :send ).
+			expect( @response_sock ).to receive( :<< ).
 				with( "#{TEST_UUID} 1:8, " )
-			expect( @response_sock ).to receive( :send ).
+			expect( @response_sock ).to receive( :<< ).
 				with( "#{TEST_UUID} 3:X 8, 27:8:sendfile,12:the_data.txt,]" )
 
 			response = Mongrel2::Response.new( TEST_UUID, 8, '' )
@@ -185,14 +163,14 @@ describe Mongrel2::Connection do
 		end
 
 		it "can tell the connection a request or a response was from to close" do
-			expect( @response_sock ).to receive( :send ).with( "#{TEST_UUID} 1:8, " )
+			expect( @response_sock ).to receive( :<< ).with( "#{TEST_UUID} 1:8, " )
 
 			response = Mongrel2::Response.new( TEST_UUID, 8 )
 			@conn.reply_close( response )
 		end
 
 		it "can broadcast a close to multiple connection IDs" do
-			expect( @response_sock ).to receive( :send ).with( "#{TEST_UUID} 15:8 16 44 45 1833, " )
+			expect( @response_sock ).to receive( :<< ).with( "#{TEST_UUID} 15:8 16 44 45 1833, " )
 			@conn.broadcast_close( TEST_UUID, [8, 16, 44, 45, 1833] )
 		end