thrift 0.23.0 → 0.25.0

data/lib/thrift/server/base_server.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Licensed to the Apache Software Foundation (ASF) under one
 # or more contributor license agreements. See the NOTICE file
@@ -17,13 +18,21 @@
 # under the License.
 #
 
+require "logger"
+
 module Thrift
   class BaseServer
-    def initialize(processor, server_transport, transport_factory = nil, protocol_factory = nil)
+    def initialize(processor, server_transport, transport_factory = nil, protocol_factory = nil, logger: nil)
       @processor = processor
       @server_transport = server_transport
       @transport_factory = transport_factory ? transport_factory : Thrift::BaseTransportFactory.new
       @protocol_factory = protocol_factory ? protocol_factory : Thrift::BinaryProtocolFactory.new
+      if logger.nil?
+        @logger = Logger.new(STDERR)
+        @logger.level = Logger::WARN
+      else
+        @logger = logger
+      end
     end
 
     def serve
@@ -31,7 +40,7 @@ module Thrift
     end
 
     def to_s
-      "server(#{@protocol_factory.to_s}(#{@transport_factory.to_s}(#{@server_transport.to_s})))"
+      "server(#{@protocol_factory}(#{@transport_factory}(#{@server_transport})))"
     end
   end
 end

data/lib/thrift/server/nonblocking_server.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Licensed to the Apache Software Foundation (ASF) under one
 # or more contributor license agreements. See the NOTICE file
@@ -17,15 +18,20 @@
 # under the License.
 #
 
-require 'logger'
-require 'thread'
+require "logger"
+require "thread"
 
 module Thrift
   # this class expects to always use a FramedTransport for reading messages
   class NonblockingServer < BaseServer
-    def initialize(processor, server_transport, transport_factory = nil, protocol_factory = nil, num = 20, logger = nil)
+    def initialize(processor, server_transport, transport_factory = nil, protocol_factory = nil, num = 20, logger = nil,
+                   max_frame_size: FramedTransport::DEFAULT_MAX_FRAME_SIZE)
       super(processor, server_transport, transport_factory, protocol_factory)
+      unless max_frame_size > 0 && max_frame_size <= FramedTransport::HARD_MAX_FRAME_SIZE
+        raise ArgumentError, "max_frame_size must be > 0 and <= #{FramedTransport::HARD_MAX_FRAME_SIZE}"
+      end
       @num_threads = num
+      @max_frame_size = max_frame_size
       if logger.nil?
         @logger = Logger.new(STDERR)
         @logger.level = Logger::WARN
@@ -52,11 +58,16 @@ module Thrift
             break
           end
           next if rd.nil?
-          socket = @server_transport.accept
+          begin
+            socket = @server_transport.accept
+          rescue => e
+            next if defined?(OpenSSL::SSL::SSLError) && e.is_a?(OpenSSL::SSL::SSLError)
+            raise
+          end
           @logger.debug "Accepted socket: #{socket.inspect}"
           @io_manager.add_connection socket
         end
-      rescue IOError => e
+      rescue IOError
       end
       # we must be shutting down
       @logger.info "#{self} is shutting down, goodbye"
@@ -83,14 +94,17 @@ module Thrift
       if block
         shutdown_proc.call
       else
-        Thread.new &shutdown_proc
+        Thread.new(&shutdown_proc)
       end
     end
 
     private
 
     def start_io_manager
-      iom = IOManager.new(@processor, @server_transport, @transport_factory, @protocol_factory, @num_threads, @logger)
+      iom = IOManager.new(
+        @processor, @server_transport, @transport_factory, @protocol_factory, @num_threads, @logger,
+        max_frame_size: @max_frame_size,
+      )
       iom.spawn
       iom
     end
@@ -98,15 +112,17 @@ module Thrift
     class IOManager # :nodoc:
       DEFAULT_BUFFER = 2**20
 
-      def initialize(processor, server_transport, transport_factory, protocol_factory, num, logger)
+      def initialize(processor, server_transport, transport_factory, protocol_factory, num, logger,
+                     max_frame_size: FramedTransport::DEFAULT_MAX_FRAME_SIZE)
         @processor = processor
         @server_transport = server_transport
         @transport_factory = transport_factory
         @protocol_factory = protocol_factory
         @num_threads = num
         @logger = logger
+        @max_frame_size = max_frame_size
         @connections = []
-        @buffers = Hash.new { |h, k| h[k] = '' }
+        @buffers = Hash.new { |h, k| h[k] = Bytes.empty_byte_buffer }
         @signal_queue = Queue.new
         @signal_pipes = IO.pipe
         @signal_pipes[1].sync = true
@@ -138,7 +154,12 @@ module Thrift
 
       def ensure_closed
         kill_worker_threads if @worker_threads
-        @iom_thread.kill
+        if @iom_thread&.alive?
+          @iom_thread.kill
+          @iom_thread.join
+        end
+        close_connections
+        close_signal_pipes
       end
 
       private
@@ -152,15 +173,13 @@ module Thrift
             break if read_signals == :shutdown
           end
           rd.each do |fd|
-            begin
-              if fd.handle.eof?
-                remove_connection fd
-              else
-                read_connection fd
-              end
-            rescue Errno::ECONNRESET
+            if fd.handle.eof?
               remove_connection fd
+            else
+              read_connection fd
             end
+          rescue Errno::ECONNRESET
+            remove_connection fd
           end
         end
         join_worker_threads(@shutdown_timeout)
@@ -169,8 +188,22 @@ module Thrift
       end
 
       def read_connection(fd)
-        @buffers[fd] << fd.read(DEFAULT_BUFFER)
-        while(frame = slice_frame!(@buffers[fd]))
+        buf = @buffers[fd]
+        buf << fd.read(DEFAULT_BUFFER)
+        while buf.length >= 4
+          # Refuse the size before collecting the frame: the four-byte length
+          # is read here and the bytes are then buffered as they arrive, for as
+          # long as the declared length allows. FramedTransport applies the
+          # same maximum to the frame the worker later reads back.
+          size = buf.unpack1("N")
+          if size > @max_frame_size
+            @logger.error "Frame size #{size} exceeds maximum #{@max_frame_size}, closing connection"
+            fd.close
+            remove_connection fd
+            break
+          end
+          frame = slice_frame!(buf)
+          break if frame.nil?
           @logger.debug "#{self} is processing a frame"
           @worker_queue.push [:frame, fd, frame]
         end
@@ -246,9 +279,25 @@ module Thrift
         @worker_threads.clear
       end
 
+      def close_connections
+        @connections.each do |fd|
+          fd.close
+        rescue IOError, SystemCallError, TransportException
+        end
+        @connections.clear
+        @buffers.clear
+      end
+
+      def close_signal_pipes
+        @signal_pipes.each do |pipe|
+          pipe.close unless pipe.closed?
+        rescue IOError
+        end
+      end
+
       def slice_frame!(buf)
         if buf.length >= 4
-          size = buf.unpack('N').first
+          size = buf.unpack1("N")
           if buf.length >= size + 4
             buf.slice!(0, size + 4)
           else

data/lib/thrift/server/rack_application.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+#
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements. See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership. The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License. You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied. See the License for the
+# specific language governing permissions and limitations
+# under the License.
+#
+
+require "rack"
+require "thrift/transport/io_stream_transport"
+
+module Thrift
+  class RackApplication
+    THRIFT_HEADER = "application/x-thrift"
+
+    def initialize(processor, protocol_factory = BinaryProtocolFactory.new)
+      @processor = processor
+      @protocol_factory = protocol_factory
+    end
+
+    def call(env)
+      request = Rack::Request.new(env)
+
+      if self.class.valid_thrift_request?(request)
+        self.class.successful_request(request, @processor, @protocol_factory).finish
+      else
+        self.class.failed_request.finish
+      end
+    end
+
+    def self.mapped(path, processor, protocol_factory = BinaryProtocolFactory.new)
+      Rack::Builder.new do
+        use Rack::ContentLength
+        map path do
+          run RackApplication.new(processor, protocol_factory)
+        end
+      end
+    end
+
+    def self.successful_request(rack_request, processor, protocol_factory)
+      response = Rack::Response.new([], 200, {Rack::CONTENT_TYPE => THRIFT_HEADER})
+      transport = IOStreamTransport.new(rack_request.body, response)
+      protocol = protocol_factory.get_protocol(transport)
+      processor.process protocol, protocol
+
+      response
+    end
+
+    def self.failed_request
+      Rack::Response.new(["Not Found"], 404, {Rack::CONTENT_TYPE => THRIFT_HEADER})
+    end
+
+    def self.valid_thrift_request?(rack_request)
+      rack_request.post? && rack_request.media_type == THRIFT_HEADER
+    end
+  end
+end

data/lib/thrift/server/simple_server.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Licensed to the Apache Software Foundation (ASF) under one
 # or more contributor license agreements. See the NOTICE file
@@ -20,28 +21,39 @@
 module Thrift
   class SimpleServer < BaseServer
     def serve
-      begin
-        @server_transport.listen
-        loop do
+      @server_transport.listen
+      loop do
+        begin
           client = @server_transport.accept
-          trans = @transport_factory.get_transport(client)
-          prot = @protocol_factory.get_protocol(trans)
-          begin
-            loop do
-              @processor.process(prot, prot)
-            end
-          rescue Thrift::TransportException, Thrift::ProtocolException
-          ensure
-            trans.close
+        rescue Errno::ECONNRESET, Errno::EPIPE
+          next
+        rescue => e
+          next if defined?(OpenSSL::SSL::SSLError) && e.is_a?(OpenSSL::SSL::SSLError)
+          raise
+        end
+        trans = @transport_factory.get_transport(client)
+        prot = @protocol_factory.get_protocol(trans)
+        begin
+          loop do
+            @processor.process(prot, prot)
           end
+        rescue Thrift::TransportException, Thrift::ProtocolException
+          # The client hung up or sent a message this connection could not
+          # read. Close it below and keep accepting other clients.
+        rescue => e
+          # Any other error raised while serving this one client must not end
+          # the accept loop. Log it, close the connection, and keep serving.
+          @logger.error("Error while serving a client connection: #{e.inspect}")
+        ensure
+          trans.close
         end
-      ensure
-        @server_transport.close
       end
+    ensure
+      @server_transport.close
     end
 
     def to_s
-      "simple(#{super.to_s})"
+      "simple(#{super})"
     end
   end
 end

data/lib/thrift/server/thin_http_server.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Licensed to the Apache Software Foundation (ASF) under one
 # or more contributor license agreements. See the NOTICE file
@@ -17,14 +18,16 @@
 # under the License.
 #
 
-require 'rack'
-require 'thin'
+require "rack"
+require "thin"
+require "thrift/server/rack_application"
 
 ##
 # Wraps the Thin web server to provide a Thrift server over HTTP.
+# <b>DEPRECATED:</b> Use <tt>Thrift::RackApplication</tt> with a maintained Rack
+# server instead.
 module Thrift
   class ThinHTTPServer < BaseServer
-
     ##
     # Accepts a Thrift::Processor
     # Options include:
@@ -32,13 +35,26 @@ module Thrift
     # * :ip
     # * :path
     # * :protocol_factory
+    # * :ssl
+    # * :ssl_options
     def initialize(processor, options = {})
+      Kernel.warn "[DEPRECATION WARNING] `Thrift::ThinHTTPServer` is deprecated because Thin is no longer maintained. Please use `Thrift::RackApplication` with a maintained Rack server instead."
       port = options[:port] || 80
       ip = options[:ip] || "0.0.0.0"
       path = options[:path] || "/"
       protocol_factory = options[:protocol_factory] || BinaryProtocolFactory.new
-      app = RackApplication.for(path, processor, protocol_factory)
+      endpoint = RackApplication.mapped(path, processor, protocol_factory)
+      app = Rack::Builder.new do
+        use Rack::CommonLogger
+        use Rack::ShowExceptions
+        use Rack::Lint
+        run endpoint
+      end
       @server = Thin::Server.new(ip, port, app)
+      if options[:ssl]
+        @server.ssl = true
+        @server.ssl_options = options[:ssl_options] || {}
+      end
     end
 
     ##
@@ -47,45 +63,6 @@ module Thrift
       @server.start
     end
 
-    class RackApplication
-
-      THRIFT_HEADER = "application/x-thrift"
-
-      def self.for(path, processor, protocol_factory)
-        Rack::Builder.new do
-          use Rack::CommonLogger
-          use Rack::ShowExceptions
-          use Rack::Lint
-          map path do
-            run lambda { |env|
-              request = Rack::Request.new(env)
-              if RackApplication.valid_thrift_request?(request)
-                RackApplication.successful_request(request, processor, protocol_factory).finish
-              else
-                RackApplication.failed_request.finish
-              end
-            }
-          end
-        end
-      end
-
-      def self.successful_request(rack_request, processor, protocol_factory)
-        response = Rack::Response.new([], 200, {'Content-Type' => THRIFT_HEADER})
-        transport = IOStreamTransport.new rack_request.body, response
-        protocol = protocol_factory.get_protocol transport
-        processor.process protocol, protocol
-        response
-      end
-
-      def self.failed_request
-        Rack::Response.new(['Not Found'], 404, {'Content-Type' => THRIFT_HEADER})
-      end
-
-      def self.valid_thrift_request?(rack_request)
-        rack_request.post? && rack_request.env["CONTENT_TYPE"] == THRIFT_HEADER
-      end
-
-    end
-
+    RackApplication = Thrift::RackApplication
   end
 end

data/lib/thrift/server/thread_pool_server.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Licensed to the Apache Software Foundation (ASF) under one
 # or more contributor license agreements. See the NOTICE file
@@ -17,7 +18,7 @@
 # under the License.
 #
 
-require 'thread'
+require "thread"
 
 module Thrift
   class ThreadPoolServer < BaseServer
@@ -46,25 +47,28 @@ module Thrift
         loop do
           @thread_q.push(:token)
           Thread.new do
-            begin
-              loop do
+            loop do
+              begin
                 client = @server_transport.accept
-                trans = @transport_factory.get_transport(client)
-                prot = @protocol_factory.get_protocol(trans)
-                begin
-                  loop do
-                    @processor.process(prot, prot)
-                  end
-                rescue Thrift::TransportException, Thrift::ProtocolException => e
-                ensure
-                  trans.close
+              rescue => e
+                next if defined?(OpenSSL::SSL::SSLError) && e.is_a?(OpenSSL::SSL::SSLError)
+                raise
+              end
+              trans = @transport_factory.get_transport(client)
+              prot = @protocol_factory.get_protocol(trans)
+              begin
+                loop do
+                  @processor.process(prot, prot)
                 end
+              rescue Thrift::TransportException, Thrift::ProtocolException
+              ensure
+                trans.close
               end
-            rescue => e
-              @exception_q.push(e)
-            ensure
-              @thread_q.pop # thread died!
             end
+          rescue => e
+            @exception_q.push(e)
+          ensure
+            @thread_q.pop # thread died!
           end
         end
       ensure
@@ -73,7 +77,7 @@ module Thrift
     end
 
     def to_s
-      "threadpool(#{super.to_s})"
+      "threadpool(#{super})"
     end
   end
 end

data/lib/thrift/server/threaded_server.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Licensed to the Apache Software Foundation (ASF) under one
 # or more contributor license agreements. See the NOTICE file
@@ -17,35 +18,38 @@
 # under the License.
 #
 
-require 'thread'
+require "thread"
 
 module Thrift
   class ThreadedServer < BaseServer
     def serve
-      begin
-        @server_transport.listen
-        loop do
+      @server_transport.listen
+      loop do
+        begin
           client = @server_transport.accept
-          trans = @transport_factory.get_transport(client)
-          prot = @protocol_factory.get_protocol(trans)
-          Thread.new(prot, trans) do |p, t|
-            begin
-              loop do
-                @processor.process(p, p)
-              end
-            rescue Thrift::TransportException, Thrift::ProtocolException
-            ensure
-              t.close
-            end
+        rescue Errno::ECONNRESET, Errno::EPIPE
+          next
+        rescue => e
+          next if defined?(OpenSSL::SSL::SSLError) && e.is_a?(OpenSSL::SSL::SSLError)
+          raise
+        end
+        trans = @transport_factory.get_transport(client)
+        prot = @protocol_factory.get_protocol(trans)
+        Thread.new(prot, trans) do |p, t|
+          loop do
+            @processor.process(p, p)
           end
+        rescue Thrift::TransportException, Thrift::ProtocolException
+        ensure
+          t.close
         end
-      ensure
-        @server_transport.close
       end
+    ensure
+      @server_transport.close
     end
 
     def to_s
-      "threaded(#{super.to_s})"
+      "threaded(#{super})"
     end
   end
 end