thrift 0.22.0 → 0.24.0

data/lib/thrift/transport/server_socket.rb

@@ -1,5 +1,6 @@
 # encoding: ascii-8bit
-# 
+# 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
@@ -7,23 +8,23 @@
 # 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 'socket'
 
 module Thrift
   class ServerSocket < BaseServerTransport
-    # call-seq: initialize(host = nil, port)
-    def initialize(host_or_port, port = nil)
+    # call-seq: initialize(host = nil, port, client_timeout: DEFAULT_CLIENT_TIMEOUT)
+    def initialize(host_or_port, port = nil, client_timeout: DEFAULT_CLIENT_TIMEOUT)
       if port
         @host = host_or_port
         @port = port
@@ -31,10 +32,11 @@ module Thrift
         @host = nil
         @port = host_or_port
       end
+      @client_timeout = client_timeout
       @handle = nil
     end
 
-    attr_reader :handle
+    attr_reader :handle, :client_timeout
 
     def listen
       @handle = TCPServer.new(@host, @port)
@@ -43,7 +45,9 @@ module Thrift
     def accept
       unless @handle.nil?
         sock = @handle.accept
+        sock.setsockopt(::Socket::IPPROTO_TCP, ::Socket::TCP_NODELAY, 1)
         trans = Socket.new
+        trans.timeout = @client_timeout
         trans.handle = sock
         trans
       end
@@ -58,7 +62,9 @@ module Thrift
       @handle.nil? or @handle.closed?
     end
 
-    alias to_io handle
+    def to_io
+      @handle&.to_io || raise(IOError, 'closed stream')
+    end
 
     def to_s
       "socket(#{@host}:#{@port})"

data/lib/thrift/transport/socket.rb

@@ -1,5 +1,6 @@
 # encoding: ascii-8bit
-# 
+# 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
@@ -7,22 +8,22 @@
 # 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 'socket'
 
 module Thrift
   class Socket < BaseTransport
-    def initialize(host='localhost', port=9090, timeout=nil)
+    def initialize(host = 'localhost', port = 9090, timeout = nil)
       @host = host
       @port = port
       @timeout = timeout
@@ -33,111 +34,176 @@ module Thrift
     attr_accessor :handle, :timeout
 
     def open
-      for addrinfo in ::Socket::getaddrinfo(@host, @port, nil, ::Socket::SOCK_STREAM) do
-        begin
-          socket = ::Socket.new(addrinfo[4], ::Socket::SOCK_STREAM, 0)
-          socket.setsockopt(::Socket::IPPROTO_TCP, ::Socket::TCP_NODELAY, 1)
-          sockaddr = ::Socket.sockaddr_in(addrinfo[1], addrinfo[3])
-          begin
-            socket.connect_nonblock(sockaddr)
-          rescue Errno::EINPROGRESS
-            unless IO.select(nil, [ socket ], nil, @timeout)
-              next
-            end
-            begin
-              socket.connect_nonblock(sockaddr)
-            rescue Errno::EISCONN
-            end
-          end
-          return @handle = socket
-        rescue StandardError => e
-          next
-        end
-      end
-      raise TransportException.new(TransportException::NOT_OPEN, "Could not connect to #{@desc}: #{e}")
+      deadline = Process.clock_gettime(Process::CLOCK_MONOTONIC) + @timeout unless @timeout.nil? || @timeout == 0
+      @handle = connect_socket(deadline)
     end
 
     def open?
-      !@handle.nil? and !@handle.closed?
+      !@handle.nil? && !@handle.closed?
     end
 
     def write(str)
-      raise IOError, "closed stream" unless open?
+      raise TransportException.new(TransportException::NOT_OPEN, "closed stream") unless open?
       str = Bytes.force_binary_encoding(str)
       begin
-        if @timeout.nil? or @timeout == 0
+        if @timeout.nil? || @timeout == 0
           @handle.write(str)
         else
+          deadline = Process.clock_gettime(Process::CLOCK_MONOTONIC) + @timeout
           len = 0
-          start = Time.now
-          while Time.now - start < @timeout
-            rd, wr, = IO.select(nil, [@handle], nil, @timeout)
-            if wr and not wr.empty?
+
+          while len < str.length
+            begin
               len += @handle.write_nonblock(str[len..-1])
-              break if len >= str.length
+            rescue IO::WaitWritable
+              wait_for(:write, deadline, str.length)
+            rescue IO::WaitReadable
+              wait_for(:read, deadline, str.length)
             end
           end
-          if len < str.length
-            raise TransportException.new(TransportException::TIMED_OUT, "Socket: Timed out writing #{str.length} bytes to #{@desc}")
-          else
-            len
-          end
+
+          len
         end
       rescue TransportException => e
         # pass this on
         raise e
       rescue StandardError => e
-        @handle.close
+        close_socket(@handle)
         @handle = nil
         raise TransportException.new(TransportException::NOT_OPEN, e.message)
       end
     end
 
     def read(sz)
-      raise IOError, "closed stream" unless open?
+      raise TransportException.new(TransportException::NOT_OPEN, "closed stream") unless open?
 
       begin
-        if @timeout.nil? or @timeout == 0
+        if @timeout.nil? || @timeout == 0
           data = @handle.readpartial(sz)
         else
-          # it's possible to interrupt select for something other than the timeout
-          # so we need to ensure we've waited long enough, but not too long
-          start = Time.now
-          timespent = 0
-          rd = loop do
-            rd, = IO.select([@handle], nil, nil, @timeout - timespent)
-            timespent = Time.now - start
-            break rd if (rd and not rd.empty?) or timespent >= @timeout
-          end
-          if rd.nil? or rd.empty?
-            raise TransportException.new(TransportException::TIMED_OUT, "Socket: Timed out reading #{sz} bytes from #{@desc}")
-          else
-            data = @handle.readpartial(sz)
+          deadline = Process.clock_gettime(Process::CLOCK_MONOTONIC) + @timeout
+
+          data = loop do
+            begin
+              break @handle.read_nonblock(sz)
+            rescue IO::WaitReadable
+              wait_for(:read, deadline, sz)
+            rescue IO::WaitWritable
+              wait_for(:write, deadline, sz)
+            end
           end
         end
       rescue TransportException => e
         # don't let this get caught by the StandardError handler
         raise e
       rescue StandardError => e
-        @handle.close unless @handle.closed?
+        close_socket(@handle)
         @handle = nil
         raise TransportException.new(TransportException::NOT_OPEN, e.message)
       end
-      if (data.nil? or data.length == 0)
+      if (data.nil? || data.length == 0)
         raise TransportException.new(TransportException::UNKNOWN, "Socket: Could not read #{sz} bytes from #{@desc}")
       end
       data
     end
 
     def close
-      @handle.close unless @handle.nil? or @handle.closed?
+      close_socket(@handle)
       @handle = nil
     end
 
-    alias to_io handle
+    def to_io
+      @handle&.to_io || raise(IOError, 'closed stream')
+    end
 
     def to_s
       "socket(#{@host}:#{@port})"
     end
+
+    private
+
+    def connect_socket(deadline)
+      last_error = nil
+      connected_socket = nil
+
+      Addrinfo.foreach(@host, @port, nil, :STREAM) do |addrinfo|
+        socket = nil
+
+        begin
+          socket = if deadline
+            remaining = deadline - Process.clock_gettime(Process::CLOCK_MONOTONIC)
+            raise TransportException.new(TransportException::TIMED_OUT, "Socket: Timed out opening connection to #{@desc}") if remaining <= 0
+
+            addrinfo.connect(timeout: remaining)
+          else
+            addrinfo.connect
+          end
+
+          socket.setsockopt(::Socket::IPPROTO_TCP, ::Socket::TCP_NODELAY, 1)
+          connected_socket = socket
+          break
+        rescue Errno::ETIMEDOUT => e
+          close_socket(socket)
+          last_error = e
+        rescue TransportException
+          close_socket(socket)
+          raise
+        rescue StandardError => e
+          close_socket(socket)
+          last_error = e
+        end
+      end
+
+      return connected_socket if connected_socket
+
+      if last_error.is_a?(Errno::ETIMEDOUT)
+        raise TransportException.new(TransportException::TIMED_OUT, "Socket: Timed out opening connection to #{@desc}")
+      end
+
+      if deadline && deadline - Process.clock_gettime(Process::CLOCK_MONOTONIC) <= 0
+        raise TransportException.new(TransportException::TIMED_OUT, "Socket: Timed out opening connection to #{@desc}")
+      end
+
+      raise TransportException.new(TransportException::NOT_OPEN, "Could not connect to #{@desc}"), cause: last_error
+    rescue TransportException
+      raise
+    rescue StandardError
+      raise TransportException.new(TransportException::NOT_OPEN, "Could not connect to #{@desc}")
+    end
+
+    def close_socket(socket)
+      return if socket.nil?
+      return if socket.respond_to?(:closed?) && socket.closed?
+
+      socket.close
+    rescue StandardError
+      nil
+    end
+
+    def wait_for(operation, deadline, sz)
+      rd_ary, wr_ary = case operation
+      when :read
+        [[@handle], nil]
+      when :write
+        [nil, [@handle]]
+      else
+        raise ArgumentError, "Unknown IO wait operation: #{operation.inspect}"
+      end
+
+      loop do
+        remaining = deadline - Process.clock_gettime(Process::CLOCK_MONOTONIC)
+        if remaining <= 0
+          case operation
+          when :read
+            raise TransportException.new(TransportException::TIMED_OUT, "Socket: Timed out reading #{sz} bytes from #{@desc}")
+          when :write
+            raise TransportException.new(TransportException::TIMED_OUT, "Socket: Timed out writing #{sz} bytes to #{@desc}")
+          end
+        end
+
+        rd, wr, = IO.select(rd_ary, wr_ary, nil, remaining)
+        return if (rd && !rd.empty?) || (wr && !wr.empty?)
+      end
+    end
   end
 end

data/lib/thrift/transport/ssl_server_socket.rb

@@ -1,4 +1,5 @@
 # encoding: ascii-8bit
+# frozen_string_literal: true
 #
 # Licensed to the Apache Software Foundation (ASF) under one
 # or more contributor license agreements. See the NOTICE file
@@ -22,8 +23,8 @@ require 'socket'
 
 module Thrift
   class SSLServerSocket < ServerSocket
-    def initialize(host_or_port, port = nil, ssl_context = nil)
-      super(host_or_port, port)
+    def initialize(host_or_port, port = nil, ssl_context = nil, client_timeout: DEFAULT_CLIENT_TIMEOUT)
+      super(host_or_port, port, client_timeout: client_timeout)
       @ssl_context = ssl_context
     end
 
@@ -33,7 +34,7 @@ module Thrift
       socket = TCPServer.new(@host, @port)
       @handle = OpenSSL::SSL::SSLServer.new(socket, @ssl_context)
     end
-    
+
     def to_s
       "ssl(#{super.to_s})"
     end

data/lib/thrift/transport/ssl_socket.rb

@@ -1,4 +1,5 @@
 # encoding: ascii-8bit
+# frozen_string_literal: true
 #
 # Licensed to the Apache Software Foundation (ASF) under one
 # or more contributor license agreements. See the NOTICE file
@@ -17,9 +18,11 @@
 # specific language governing permissions and limitations
 # under the License.
 
+require 'io/wait'
+
 module Thrift
   class SSLSocket < Socket
-    def initialize(host='localhost', port=9090, timeout=nil, ssl_context=nil)
+    def initialize(host = 'localhost', port = 9090, timeout = nil, ssl_context = nil)
       super(host, port, timeout)
       @ssl_context = ssl_context
     end
@@ -27,23 +30,52 @@ module Thrift
     attr_accessor :ssl_context
 
     def open
-      socket = super
-      @handle = OpenSSL::SSL::SSLSocket.new(socket, @ssl_context)
+      deadline = Process.clock_gettime(Process::CLOCK_MONOTONIC) + @timeout unless @timeout.nil? || @timeout == 0
+      socket = connect_socket(deadline)
+
       begin
-        @handle.connect_nonblock
+        ssl_socket = OpenSSL::SSL::SSLSocket.new(socket, @ssl_context)
+        ssl_socket.sync_close = true
+        @handle = ssl_socket
+
+        if deadline
+          loop do
+            result = @handle.connect_nonblock(exception: false)
+
+            case result
+            when @handle
+              break
+            when :wait_readable
+              remaining = deadline - Process.clock_gettime(Process::CLOCK_MONOTONIC)
+              if remaining <= 0 || !@handle.to_io.wait_readable(remaining)
+                raise TransportException.new(TransportException::TIMED_OUT, "SSL socket: Timed out establishing session with #{@desc}")
+              end
+            when :wait_writable
+              remaining = deadline - Process.clock_gettime(Process::CLOCK_MONOTONIC)
+              if remaining <= 0 || !@handle.to_io.wait_writable(remaining)
+                raise TransportException.new(TransportException::TIMED_OUT, "SSL socket: Timed out establishing session with #{@desc}")
+              end
+            else
+              raise TransportException.new(TransportException::NOT_OPEN, "Could not connect to #{@desc}: unexpected SSL connect result #{result.inspect}")
+            end
+          end
+        else
+          @handle.connect
+        end
+
         @handle.post_connection_check(@host)
         @handle
-      rescue IO::WaitReadable
-        IO.select([ @handle ], nil, nil, @timeout)
-        retry
-      rescue IO::WaitWritable
-        IO.select(nil, [ @handle ], nil, @timeout)
-        retry
-      rescue StandardError => e
-        raise TransportException.new(TransportException::NOT_OPEN, "Could not connect to #{@desc}: #{e}")
+      rescue TransportException
+        close_socket(@handle)
+        @handle = nil
+        raise
+      rescue StandardError
+        close_socket(@handle || socket)
+        @handle = nil
+        raise TransportException.new(TransportException::NOT_OPEN, "Could not connect to #{@desc}")
       end
     end
-    
+
     def to_s
       "ssl(#{super.to_s})"
     end

data/lib/thrift/transport/unix_server_socket.rb

@@ -1,5 +1,6 @@
 # encoding: ascii-8bit
-# 
+# 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
@@ -7,27 +8,29 @@
 # 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 'socket'
 
 module Thrift
   class UNIXServerSocket < BaseServerTransport
-    def initialize(path)
+    def initialize(path, client_timeout: DEFAULT_CLIENT_TIMEOUT)
       @path = path
+      @client_timeout = client_timeout
       @handle = nil
     end
 
     attr_accessor :handle
+    attr_reader :client_timeout
 
     def listen
       @handle = ::UNIXServer.new(@path)
@@ -37,6 +40,7 @@ module Thrift
       unless @handle.nil?
         sock = @handle.accept
         trans = UNIXSocket.new(nil)
+        trans.timeout = @client_timeout
         trans.handle = sock
         trans
       end

data/lib/thrift/transport/unix_socket.rb

@@ -1,5 +1,6 @@
 # encoding: ascii-8bit
-# 
+# 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
@@ -7,22 +8,22 @@
 # 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 'socket'
 
 module Thrift
   class UNIXSocket < Socket
-    def initialize(path, timeout=nil)
+    def initialize(path, timeout = nil)
       @path = path
       @timeout = timeout
       @desc = @path # for read()'s error
@@ -36,7 +37,7 @@ module Thrift
         raise TransportException.new(TransportException::NOT_OPEN, "Could not open UNIX socket at #{@path}")
       end
     end
-    
+
     def to_s
       "domain(#{@path})"
     end

data/lib/thrift/types.rb

@@ -1,4 +1,5 @@
-# 
+# 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
@@ -6,16 +7,16 @@
 # 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 'set'
 
@@ -34,6 +35,7 @@ module Thrift
     MAP = 13
     SET = 14
     LIST = 15
+    UUID = 16
   end
 
   class << self
@@ -43,7 +45,7 @@ module Thrift
   class TypeError < Exception
   end
 
-  def self.check_type(value, field, name, skip_nil=true)
+  def self.check_type(value, field, name, skip_nil = true)
     return if value.nil? and skip_nil
     klasses = case field[:type]
               when Types::VOID
@@ -56,6 +58,8 @@ module Thrift
                 Float
               when Types::STRING
                 String
+              when Types::UUID
+                String
               when Types::STRUCT
                 [Struct, Union]
               when Types::MAP
@@ -70,7 +74,7 @@ module Thrift
     # check elements now
     case field[:type]
     when Types::MAP
-      value.each_pair do |k,v|
+      value.each_pair do |k, v|
         check_type(k, field[:key], "#{name}.key", false)
         check_type(v, field[:value], "#{name}.value", false)
       end

data/lib/thrift/union.rb

@@ -1,4 +1,5 @@
-# 
+# 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
@@ -6,20 +7,20 @@
 # 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.
-# 
+#
 
 module Thrift
   class Union
-    def initialize(name=nil, value=nil)
+    def initialize(name = nil, value = nil)
       if name
         if name.is_a? Hash
           if name.size > 1
@@ -60,7 +61,9 @@ module Thrift
       iprot.read_field_end
 
       fname, ftype, fid = iprot.read_field_begin
-      raise "Too many fields for union" unless (ftype == Types::STOP) 
+      unless (ftype == Types::STOP)
+        raise ProtocolException.new(ProtocolException::INVALID_DATA, "Too many fields for union")
+      end
 
       iprot.read_struct_end
       validate
@@ -73,6 +76,10 @@ module Thrift
       fid = self.name_to_id(@setfield.to_s)
 
       field_info = struct_fields[fid]
+      unless field_info
+        raise ProtocolException.new(ProtocolException::INVALID_DATA, "set_field is not valid for this union!")
+      end
+
       type = field_info[:type]
       if is_container? type
         oprot.write_field_begin(@setfield, type, fid)
@@ -99,7 +106,7 @@ module Thrift
       klass.send :define_method, field_info[:name] do
         if field_info[:name].to_sym == @setfield
           @value
-        else 
+        else
           raise RuntimeError, "#{field_info[:name]} is not union's set field."
         end
       end
@@ -124,7 +131,7 @@ module Thrift
       end
     end
 
-    # get the symbol that indicates what the currently set field type is. 
+    # get the symbol that indicates what the currently set field type is.
     def get_set_field
       @setfield
     end