couchrest 2.0.0 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 35f90529f40322cb4c79feff70763d46e7feb0b0
-  data.tar.gz: 9cb8ed603d0898f37d1ebafeb23fa00204eaea62
+  metadata.gz: 75e93448320a86ecbcffd644ccb8afec72fdebf5
+  data.tar.gz: c5ca7599c73e5d86978bc0093e8758864a27a8eb
 SHA512:
-  metadata.gz: e927060a2d0c42fd94f761b7f4f161c6627738c92c51de6bf483b9ebbce3527ab165420eb54a3a1c0e9f447d8f1cfc3323b70a05e87a761bac387472bd8c3b3e
-  data.tar.gz: 431046aa57a718f9c2d9a1c966cf060b1123f49dff147ccd8a272b39ab1df5c59d8c038dc41c8d5f9cb6f84783c21e8c6abd380fbcca00b6999d5bee8754b460
+  metadata.gz: 3b025c928830967082f72203b020f303d794b5aca324c4e6acf3e4f353a7492ba975bae5d02f34f99aff6d59d0f91a137ec941ac3a09d05eb7a5dcca3ae13178
+  data.tar.gz: b2a1e1e2b507937ea8ccfa05a618a8e753ade2bda33a027ee817dfbae24b5256df93826f335132984d1f5350601f9d7140a8c8c9dcf8efcfb286477391e3ac49

data/.travis.yml

@@ -3,10 +3,13 @@ rvm:
   - 2.2.0
   - 2.1.0
   - 2.0.0
-  - jruby
+  - jruby-1.7.26
   - rbx
 services: couchdb
 before_install:
   - gem install bundler
 env:
   - JRUBY_OPTS=--2.0
+matrix:
+  allow_failures:
+    - rvm: rbx

data/README.md

@@ -12,6 +12,14 @@ For more complete modelling support based on ActiveModel, please checkout CouchR
 
 Tested on latest stable release (1.6.X), but should work on older versions above 1.0. Also known to work on [Cloudant](http://cloudant.com).
 
+### Performance with Persistent Connections
+
+When connecting to a CouchDB 1.X server from a Linux system, you may see a big drop in performance due to the change in library to HTTPClient using persistent connections. The issue is caused by the NOWAIT TCP configuration option causing sockets to hang as they wait for more information. The fix is a [simple configuration change](http://docs.couchdb.org/en/1.6.1/maintenance/performance.html#network):
+
+```bash
+curl -X PUT "http://localhost:5984/_config/httpd/socket_options" -d '"[{nodelay, true}]"'
+```
+
 ## Install
 
     $ sudo gem install couchrest

data/VERSION

@@ -1 +1 @@
-2.0.0
+2.0.1

data/couchrest.gemspec

@@ -34,6 +34,6 @@ Gem::Specification.new do |s|
   s.add_development_dependency "bundler", "~> 1.3"
   # s.add_development_dependency "json", ">= 2.0.1"
   s.add_development_dependency "rspec", "~> 2.14.1"
-  s.add_development_dependency "rake"
+  s.add_development_dependency "rake", "< 11.0"
   s.add_development_dependency "webmock"
 end

data/history.txt

@@ -1,3 +1,11 @@
+== 2.0.1 - 2017-02-13
+
+* Minor changes
+  * Removing option for persistent connections, everything is now persistent
+    (@samlown)
+  * Simplifying connection handling and thread safety. Removed caching and lazy
+    loading of connections. (@samlown)
+
 == 2.0.0 - 2016-07-06
 
 * Minor changes

data/lib/couchrest/connection.rb

@@ -5,7 +5,7 @@ module CouchRest
   # Handle connections to the CouchDB server and provide a set of HTTP based methods to
   # perform requests.
   #
-  # All connections are persistent, unless configured otherwise. A connection cannot be re-used to connect to other servers.
+  # All connections are persistent and thread safe. A connection cannot be re-used to connect to other servers once instantiated.
   #
   # Six types of REST requests are supported: get, put, post, delete, copy and head.
   #
@@ -16,7 +16,6 @@ module CouchRest
   #
   # When initializing a connection, the following options are available:
   #
-  #  * `:persistent` true by default, forces the HTTP connection to be persistent to ensure each request attempts to use the same TCP socket, especially important for SSL connections.
   #  * `:timeout` (or `:read_timeout`) and `:open_timeout` the time in miliseconds to wait for the request, see the [Net HTTP Persistent documentation](http://docs.seattlerb.org/net-http-persistent/Net/HTTP/Persistent.html#attribute-i-read_timeout) for more details.
   #  * `:verify_ssl` verify ssl certificates (or not)
   #  * `:ssl_client_cert`, `:ssl_client_key` parameters controlling ssl client certificate authentication
@@ -54,13 +53,13 @@ module CouchRest
 
     SUCCESS_RESPONSE_CODES = [200, 201, 202, 204]
 
-    attr_reader :uri, :last_response, :options
+    attr_reader :uri, :last_response, :options, :http
 
     def initialize(uri, options = {})
       raise "CouchRest::Connection.new requires URI::HTTP(S) parameter" unless uri.is_a?(URI::HTTP)
       @uri = clean_uri(uri)
       @options = options.dup
-      @options[:persistent] = true if @options[:persistent].nil?
+      @http = prepare_http_connection
     end
 
     # Send a GET request.
@@ -97,13 +96,7 @@ module CouchRest
       execute('HEAD', path, options)
     end
 
-    # Special accessor that will either return the last used http
-    # connection or prepare a new one if none available.
-    def http
-      @http || prepare_http_connection
-    end
-
-    protected
+    private
 
     # Duplicate and remove excess baggage from the provided URI
     def clean_uri(uri)
@@ -116,12 +109,8 @@ module CouchRest
 
     # Take a look at the options povided and try to apply them to the HTTP conneciton.
     def prepare_http_connection
-      conn = @http
-      if conn.nil? || !options[:persistent]
-        conn = HTTPClient.new(options[:proxy] || self.class.proxy)
-        set_http_connection_options(conn, options)
-        @http = conn # Always set to last used connection
-      end
+      conn = HTTPClient.new(options[:proxy] || self.class.proxy)
+      set_http_connection_options(conn, options)
       conn
     end
 
@@ -149,8 +138,6 @@ module CouchRest
     end
 
     def execute(method, path, options, payload = nil, &block)
-      conn = prepare_http_connection
-
       req = {
         :method => method,
         :uri    => uri + path
@@ -167,13 +154,13 @@ module CouchRest
         req[:body] = payload_from_doc(req, payload, options)
       end
 
-      send_and_parse_response(conn, req, options, &block)
+      send_and_parse_response(req, options, &block)
     end
 
-    def send_and_parse_response(conn, req, opts, &block)
+    def send_and_parse_response(req, opts, &block)
       if block_given?
         parser = CouchRest::StreamRowParser.new(opts[:continuous] ? :feed : :array)
-        response = send_request(conn, req) do |chunk|
+        response = send_request(req) do |chunk|
           parser.parse(chunk) do |doc|
             block.call(parse_body(doc, opts))
           end
@@ -181,15 +168,15 @@ module CouchRest
         handle_response_code(response)
         parse_body(parser.header, opts)
       else
-        response = send_request(conn, req)
+        response = send_request(req)
         handle_response_code(response)
         parse_response(response, opts)
       end
     end
 
     # Send request, and leave a reference to the response for debugging purposes
-    def send_request(conn, req, &block)
-      @last_response = conn.request(req.delete(:method), req.delete(:uri), req, &block)
+    def send_request(req, &block)
+      @last_response = @http.request(req.delete(:method), req.delete(:uri), req, &block)
     end
 
     def handle_response_code(response)

data/lib/couchrest/server.rb

@@ -12,6 +12,9 @@ module CouchRest
     # saving new documents. See also #next_uuid.
     attr_reader :uuids
 
+    # Connection object prepared on initialization
+    attr_reader :connection
+
     # The connection options we should use to connect with
     attr_reader :connection_options
 
@@ -26,13 +29,7 @@ module CouchRest
         @connection_options = opts
       end
       @uuid_batch_count ||= 1000
-    end
-
-    # Lazy load the connection for the current thread
-    def connection
-      conns = (Thread.current['couchrest.connections'] ||= {})
-      key = "#{uri.to_s}##{connection_options.hash}"
-      conns[key] ||= Connection.new(uri, connection_options)
+      @connection = Connection.new(uri, connection_options)
     end
 
     # Lists all databases on the server

data/spec/couchrest/connection_spec.rb

@@ -172,29 +172,6 @@ describe CouchRest::Connection do
         expect(res['name']).to eql(doc['name'])
       end
 
-      context "persistency" do
-        before :each do
-          stub_request(:get, "http://mock/db/test-doc")
-            .to_return(:body => doc.to_json)
-        end
-
-        it "should have persistency enabled by default" do
-          conn = CouchRest::Connection.new(mock_uri)
-          expect(conn.options[:persistent]).to be_true
-          http1 = conn.http
-          conn.get(mock_uri.path)
-          expect(conn.http.object_id).to eql(http1.object_id)
-        end
-
-        it "should disable persistency" do
-          conn = CouchRest::Connection.new(mock_uri, :persistent => false)
-          expect(conn.options[:persistent]).to be_false
-          http1 = conn.http
-          conn.get(mock_uri.path)
-          expect(conn.http.object_id).to_not eql(http1.object_id)
-        end
-      end
-
       it "should raise exception if document missing" do
         uri = URI(DB.to_s + "/missingdoc")
         conn = CouchRest::Connection.new(uri)

data/spec/couchrest/database_spec.rb

@@ -209,7 +209,7 @@ describe CouchRest::Database do
         end
       rescue RuntimeError
       end
-      expect(changes.first["seq"]).to eql(1)
+      expect(changes.first["seq"].to_i).to eql(1)
     end
 
     it "should provide id of last document" do

data/spec/couchrest/server_spec.rb

@@ -51,35 +51,18 @@ describe CouchRest::Server do
       expect(server.connection).to be_a(CouchRest::Connection)
     end
 
-    it "should cache connection in current thread" do
-      server.connection # instantiate
-      conns = Thread.current['couchrest.connections']
-      expect(server.connection).to eql(conns[COUCHHOST + "##{{}.hash}"])
-    end
-
-    it "should cache connection in current thread with options" do
-      Thread.current['couchrest.connections'] = {}
-      srv = CouchRest::Server.new(mock_url, :persistent => false)
-      srv.connection # instantiate
-      conns = Thread.current['couchrest.connections']
-      expect(srv.connection.object_id).to eql(conns[conns.keys.last].object_id)
-      expect(conns.length).to eql(1)
-    end
-
-    it "should not cache connection in current thread with different options" do
-      conns = Thread.current['couchrest.connections'] = {}
-      srv = CouchRest::Server.new(mock_url, :persistent => true)
-      srv.connection # init
-      srv2 = CouchRest::Server.new(mock_url, :persistent => false)
-      srv2.connection # init
-      expect(conns.length).to eql(2)
-      expect(srv.connection.object_id).to_not eql(srv2.connection.object_id)
+    it "should be shared by all threads" do
+      conn = server.connection
+      conn2 = nil
+      Thread.new {
+        conn2 = server.connection
+      }.join
+      expect(conn.object_id).to eql(conn2.object_id)
     end
 
     it "should pass configuration options to the connection" do
-      expect(mock_server.connection.options[:persistent]).to be_true
-      srv = CouchRest::Server.new(mock_url, :persistent => false)
-      expect(srv.connection.options[:persistent]).to be_false
+      srv = CouchRest::Server.new(mock_url, :timeout => 120)
+      expect(srv.connection.options[:timeout]).to eql(120)
     end
 
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: couchrest
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.0.1
 platform: ruby
 authors:
 - J. Chris Anderson
@@ -12,7 +12,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-06 00:00:00.000000000 Z
+date: 2017-02-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httpclient
@@ -88,16 +88,16 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '11.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '11.0'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
@@ -206,7 +206,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: Lean and RESTful interface to CouchDB.