right_http_connection 1.2.1 → 1.2.3

data/History.txt

@@ -39,4 +39,14 @@ Initial public release
   * "RightAws: incompatible Net::HTTP monkey-patch" exception is raised if our net_fix
     patch was overriden (by attachment_fu for example, to avoid this load attachment_fu 
     before loading the right_http_connection gem).
-    
+
+== 1.2.2
+
+*  r3524, konstantin, 2008-04-17 11:35:42 +0400
+  * Fixed a problem with incorrect error handling (connection retries always failed).
+
+== 1.2.3
+
+- Added support for setting retry & timeout parameters in the constructor
+- Improve handling of data streams during upload: if there is a failure and a retry, reset
+  the seek pointer for the subsequent re-request

data/README.txt

@@ -28,7 +28,7 @@ algorithm for low-level network errors.
 
 == INSTALL:
 
-sudo gem install
+sudo gem install right_http_connection
 
 == LICENSE:
 

data/lib/right_http_connection.rb

@@ -34,7 +34,7 @@ module RightHttpConnection #:nodoc:
   module VERSION #:nodoc:
     MAJOR = 1
     MINOR = 2
-    TINY  = 1
+    TINY  = 3
 
     STRING = [MAJOR, MINOR, TINY].join('.')
   end
@@ -82,22 +82,31 @@ them.
     # Throw a Timeout::Error if a connection isn't established within this number of seconds
     HTTP_CONNECTION_OPEN_TIMEOUT  = 5   
     # Throw a Timeout::Error if no data have been read on this connnection within this number of seconds
-    HTTP_CONNECTION_READ_TIMEOUT  = 30  
+    HTTP_CONNECTION_READ_TIMEOUT  = 120  
     # Length of the post-error probationary period during which all requests will fail 
     HTTP_CONNECTION_RETRY_DELAY   = 15  
 
     #--------------------
     # class methods
     #--------------------
-      # Params hash
-      # :user_agent => 'www.HostName.com'    # String to report as HTTP User agent 
-      # :ca_file    => 'path_to_file'        # Path to a CA certification file in PEM format. The file can contain several CA certificates.  If this parameter isn't set, HTTPS certs won't be verified.
-      # :logger     => Logger object         # If omitted, HttpConnection logs to STDOUT
-      # :exception  => Exception to raise    # The type of exception to raise
-                                             # if a request repeatedly fails. RuntimeError is raised if this parameter is omitted.
+    #
     @@params = {}
+    @@params[:http_connection_retry_count]  = HTTP_CONNECTION_RETRY_COUNT
+    @@params[:http_connection_open_timeout] = HTTP_CONNECTION_OPEN_TIMEOUT
+    @@params[:http_connection_read_timeout] = HTTP_CONNECTION_READ_TIMEOUT
+    @@params[:http_connection_retry_delay]  = HTTP_CONNECTION_RETRY_DELAY
    
-    # Query the global (class-level) parameters
+    # Query the global (class-level) parameters:
+    # 
+    #  :user_agent => 'www.HostName.com'    # String to report as HTTP User agent 
+    #  :ca_file    => 'path_to_file'        # Path to a CA certification file in PEM format. The file can contain several CA certificates.  If this parameter isn't set, HTTPS certs won't be verified.
+    #  :logger     => Logger object         # If omitted, HttpConnection logs to STDOUT
+    #  :exception  => Exception to raise    # The type of exception to raise
+    #                                       # if a request repeatedly fails. RuntimeError is raised if this parameter is omitted.
+    #  :http_connection_retry_count         # by default == Rightscale::HttpConnection::HTTP_CONNECTION_RETRY_COUNT
+    #  :http_connection_open_timeout        # by default == Rightscale::HttpConnection::HTTP_CONNECTION_OPEN_TIMEOUT
+    #  :http_connection_read_timeout        # by default == Rightscale::HttpConnection::HTTP_CONNECTION_READ_TIMEOUT
+    #  :http_connection_retry_delay         # by default == Rightscale::HttpConnection::HTTP_CONNECTION_RETRY_DELAY
     def self.params
       @@params
     end
@@ -115,16 +124,22 @@ them.
     attr_accessor :params      # see @@params
     attr_accessor :logger
 
-=begin rdoc
-      Params hash:
-       :user_agent => 'www.HostName.com'     String to report as HTTP User agent 
-       :ca_file    => 'path_to_file'         A path of a CA certification file in PEM format. The file can contain several CA certificates.
-       :logger     => Logger object          If omitted, HttpConnection logs to STDOUT
-       :exception  => Exception to raise     The type of exception to raise if a request repeatedly fails. RuntimeError is raised if this parameter is omitted.
-                                            
-=end 
+     # Params hash:
+     #  :user_agent => 'www.HostName.com'    # String to report as HTTP User agent 
+     #  :ca_file    => 'path_to_file'        # A path of a CA certification file in PEM format. The file can contain several CA certificates.
+     #  :logger     => Logger object         # If omitted, HttpConnection logs to STDOUT
+     #  :exception  => Exception to raise    # The type of exception to raise if a request repeatedly fails. RuntimeError is raised if this parameter is omitted.
+     #  :http_connection_retry_count         # by default == Rightscale::HttpConnection.params[:http_connection_retry_count]
+     #  :http_connection_open_timeout        # by default == Rightscale::HttpConnection.params[:http_connection_open_timeout]
+     #  :http_connection_read_timeout        # by default == Rightscale::HttpConnection.params[:http_connection_read_timeout]
+     #  :http_connection_retry_delay         # by default == Rightscale::HttpConnection.params[:http_connection_retry_delay]
+     #
     def initialize(params={})
-      @params = params     
+      @params = params
+      @params[:http_connection_retry_count]  ||= @@params[:http_connection_retry_count]
+      @params[:http_connection_open_timeout] ||= @@params[:http_connection_open_timeout]
+      @params[:http_connection_read_timeout] ||= @@params[:http_connection_read_timeout]
+      @params[:http_connection_retry_delay]  ||= @@params[:http_connection_retry_delay]
       @http   = nil
       @server = nil
       @logger = get_param(:logger) || 
@@ -218,10 +233,10 @@ them.
       @@eof[@server] && @@eof[@server].last
     end
     
-      # Returns true if we are receiving EOFs during last HTTP_CONNECTION_RETRY_DELAY seconds
+      # Returns true if we are receiving EOFs during last @params[:http_connection_retry_delay] seconds
       # and there were no successful response from server
     def raise_on_eof_exception?
-      @@eof[@server].blank? ? false : ( (Time.now.to_i-HTTP_CONNECTION_RETRY_DELAY) > @@eof[@server].last.to_i )
+      @@eof[@server].blank? ? false : ( (Time.now.to_i-@params[:http_connection_retry_delay]) > @@eof[@server].last.to_i )
     end 
     
       # Reset a list of EOFs for this server.
@@ -229,6 +244,36 @@ them.
     def eof_reset
       @@eof.delete(@server)
     end
+    
+    # Detects if an object is 'streamable' - can we read from it, and can we know the size?  
+    def setup_streaming(request)
+      if(request.body && request.body.respond_to?(:read))
+        body = request.body
+        request.content_length = body.respond_to?(:lstat) ? body.lstat.size : body.size 
+        request.body_stream = request.body
+        true
+      end
+    end
+    
+    def get_fileptr_offset(request_params)
+      request_params[:request].body.pos
+    rescue Exception => e
+      # Probably caught this because the body doesn't support the pos() method, like if it is a socket.
+      # Just return 0 and get on with life.
+      0
+    end
+    
+    def reset_fileptr_offset(request, offset = 0)
+      if(request.body_stream && request.body_stream.respond_to?(:pos))
+        begin
+          request.body_stream.pos = offset
+        rescue Exception => e
+          @logger.warn("Failed file pointer reset; aborting HTTP retries." +
+                             " -- #{err_header} #{e.inspect}")
+          raise e
+        end
+      end  
+    end
 
     # Start a fresh connection. The object closes any existing connection and
     # opens a new one.
@@ -242,8 +287,8 @@ them.
       
       @logger.info("Opening new #{@protocol.upcase} connection to #@server:#@port")
       @http = Net::HTTP.new(@server, @port)
-      @http.open_timeout = HTTP_CONNECTION_OPEN_TIMEOUT
-      @http.read_timeout = HTTP_CONNECTION_READ_TIMEOUT
+      @http.open_timeout = @params[:http_connection_open_timeout]
+      @http.read_timeout = @params[:http_connection_read_timeout]
       
       if @protocol == 'https'
         verifyCallbackProc = Proc.new{ |ok, x509_store_ctx|
@@ -271,25 +316,30 @@ them.
     Send HTTP request to server
 
      request_params hash:
-     :server   => 'www.HostName.com'   Hostname or IP address of HTTP server
-     :port     => '80'                 Port of HTTP server 
-     :protocol => 'https'              http and https are supported on any port 
-     :request  => 'requeststring'      Fully-formed HTTP request to make
+     :server   => 'www.HostName.com'   # Hostname or IP address of HTTP server
+     :port     => '80'                 # Port of HTTP server 
+     :protocol => 'https'              # http and https are supported on any port 
+     :request  => 'requeststring'      # Fully-formed HTTP request to make
 
     Raises RuntimeError, Interrupt, and params[:exception] (if specified in new).
     
 =end
     def request(request_params, &block)
+      # We save the offset here so that if we need to retry, we can return the file pointer to its initial position
+      mypos = get_fileptr_offset(request_params)
       loop do
         # if we are inside a delay between retries: no requests this time!
-        if error_count > HTTP_CONNECTION_RETRY_COUNT \
-        && error_time + HTTP_CONNECTION_RETRY_DELAY > Time.now
-          @logger.warn("#{err_header} re-raising same error: #{banana_message} " +
+        if error_count > @params[:http_connection_retry_count] && 
+           error_time + @params[:http_connection_retry_delay] > Time.now
+          # store the message (otherwise it will be lost after error_reset and
+          # we will raise an exception with an empty text)
+          banana_message_text = banana_message
+          @logger.warn("#{err_header} re-raising same error: #{banana_message_text} " +
                       "-- error count: #{error_count}, error age: #{Time.now.to_i - error_time.to_i}")  
           exception = get_param(:exception) || RuntimeError
-          raise exception.new(banana_message)
+          raise exception.new(banana_message_text)
         end
-      
+        
         # try to connect server(if connection does not exist) and get response data
         begin
           request_params[:protocol] ||= (request_params[:port] == 443 ? 'https' : 'http')
@@ -308,11 +358,7 @@ them.
 
           # Detect if the body is a streamable object like a file or socket.  If so, stream that
           # bad boy.
-          if(request.body && request.body.respond_to?(:read))
-            body = request.body
-            request.content_length = body.respond_to?(:lstat) ? body.lstat.size : body.size 
-            request.body_stream = request.body
-          end
+          setup_streaming(request)
           response = @http.request(request, &block)
           
           error_reset
@@ -341,6 +387,8 @@ them.
           else
               # ... else just sleep a bit before new retry
             sleep(add_eof)
+            # We will be retrying the request, so reset the file pointer
+            reset_fileptr_offset(request, mypos)
           end 
         rescue Exception => e  # See comment at bottom for the list of errors seen...
           @http = nil
@@ -356,6 +404,10 @@ them.
           # oops - we got a banana: log it
           error_add(e.message)
           @logger.warn("#{err_header} request failure count: #{error_count}, exception: #{e.inspect}")
+
+          # We will be retrying the request, so reset the file pointer
+          reset_fileptr_offset(request, mypos)
+          
         end
       end
     end

metadata

@@ -1,33 +1,28 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.9.4
-specification_version: 1
 name: right_http_connection
 version: !ruby/object:Gem::Version 
-  version: 1.2.1
-date: 2008-02-11 00:00:00 -08:00
-summary: RightScale's robust HTTP/S connection module
-require_paths: 
-- lib
-email: support@rightscale.com
-homepage: http://rightaws.rubyforge.org
-rubyforge_project: rightaws
-description: RightScale's robust HTTP/S connection module
-autorequire: 
-default_executable: 
-bindir: bin
-has_rdoc: true
-required_ruby_version: !ruby/object:Gem::Version::Requirement 
-  requirements: 
-  - - ">"
-    - !ruby/object:Gem::Version 
-      version: 0.0.0
-  version: 
+  version: 1.2.3
 platform: ruby
-signing_key: 
-cert_chain: 
-post_install_message: 
 authors: 
 - RightScale
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-06-27 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: RightScale's robust HTTP/S connection module
+email: support@rightscale.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.txt
 files: 
 - History.txt
 - Manifest.txt
@@ -36,20 +31,32 @@ files:
 - lib/net_fix.rb
 - lib/right_http_connection.rb
 - setup.rb
-test_files: []
-
+has_rdoc: true
+homepage: http://rightaws.rubyforge.org
+post_install_message: 
 rdoc_options: 
 - --main
 - README.txt
-extra_rdoc_files: 
-- History.txt
-- Manifest.txt
-- README.txt
-executables: []
-
-extensions: []
-
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
 requirements: []
 
-dependencies: []
+rubyforge_project: rightaws
+rubygems_version: 1.0.1
+signing_key: 
+specification_version: 2
+summary: RightScale's robust HTTP/S connection module
+test_files: []