Allow Faraday init params to be passed to HTTP adaptor #288

heavydawson · 2017-03-11T14:44:27Z

This pull introduces/changes:

Restores the ability to pass Faraday request init params to allow things like over-riding the initial connection and request timeout values
A new key called :faraday_opts is available for use in the options array passed to the HTTP adaptor

Example usage:
adaptor ||= Neo4j::Core::CypherSession::Adaptors::HTTP.new("http://"
"#{@user}:"
"#{@password}@"
"#{@host}:"
"#{@http_port}",
faraday_opts: {initialize: { request: { open_timeout: 2, timeout: 600 }} })

Pings:
@cheerfulstoic
@subvertallchris

coveralls · 2017-03-11T14:52:55Z

Coverage decreased (-2.1%) to 90.268% when pulling 62ad69c on heavydawson:master into 73bf469 on neo4jrb:master.

cheerfulstoic

Wonderful, thank you so much! A few items of feedback to look over which I don't think will be hard to change. Happy to discuss!

cheerfulstoic · 2017-03-12T14:18:03Z

lib/neo4j/core/cypher_session/adaptors/http.rb

@@ -16,7 +16,7 @@ def initialize(url, options = {})
          end

          def connect
-            @requestor = Requestor.new(@url, USER_AGENT_STRING, self.class.method(:instrument_request))
+            @requestor = Requestor.new(@url, USER_AGENT_STRING, self.class.method(:instrument_request), @options[:faraday_opts] = {})


Nitpick: faraday_options would be better, I think

Also, did you mean to do @options[:faraday_opts] ||= {} here? Otherwise it's going to always set / pass through an empty Hash. You could also do @options.fetch(:faraday_options, {})

Nice catch. That was some post-implementation cleanup I thought was correct, so thanks for spotting

cheerfulstoic · 2017-03-12T14:25:45Z

lib/neo4j/core/cypher_session/adaptors/http.rb

              self.url = url
              @user = user
              @password = password
              @user_agent_string = user_agent_string
-              @faraday = wrap_connection_failed! { faraday_connection }
+              init_params = params[:initialize] && params.delete(:initialize) if params.key?(:initialize)


I know this is what the previous code did, but I don't like the delete because it modifies the Hash that we were given. I'd be happy with just the following if it works:

@faraday = wrap_connection_failed! { faraday_connection(params.fetch(:initialize, {})) }

Honestly since we're passing in a hash with the key of :faraday_options above, I don't know why we need the extra :initialize key underneath. I would actually probably just rename params to faraday_options and pass it through.

Separately we're going to need to make the Rails integration like this work:

config.neo4j.session.options = {initialize: { ssl: { verify: true }}}

But I think that we could simply pass down the values of initialize from the railtie in the neo4j gem into here as well as also supporting:

config.neo4j.session.options = {faraday_options: { ssl: { verify: true }}}

And probably raising a deprecation warning about how initialize should be replaced with faraday_options

Done (apart from rails-related config changes)

cheerfulstoic · 2017-03-12T14:27:20Z

lib/neo4j/core/cypher_session/adaptors/http.rb

@@ -144,12 +144,13 @@ def get(path, body = '', options = {})

            private

-            def faraday_connection
+            def faraday_connection(params = {})


Since we're in the place where we're creating the Faraday connection, I would probably just call this variable options to match with the naming of faraday_options. Also, I've seen a general pattern of using options as the hash of optional arguments at the end of a Ruby function. When I see params I think of Rails' controller parameters (that may just be my preference, but I think it's a trend)

coveralls · 2017-03-13T12:13:34Z

Coverage decreased (-2.2%) to 90.235% when pulling 0b42d54 on heavydawson:master into 73bf469 on neo4jrb:master.

coveralls · 2017-03-13T13:46:24Z

Coverage increased (+0.001%) to 92.4% when pulling 424843a on heavydawson:master into 73bf469 on neo4jrb:master.

coveralls · 2017-03-13T14:32:35Z