Set a connect_timeout for the creation of a socket #243

astratto · 2015-12-17T11:24:40Z

Currently when an LDAP server is not reachable (for instance, packets are dropped), users of this library end up waiting for a quite long period of time. This is very rarely acceptable and can easily lead to a chain of failures with several services timing out before the socket creation actually fails.

This patch uses Socket.tcp instead of TCPSocket.new and provides a default connect_timeout of 1 second.

Notes:

I couldn't find a way in the integration tests to write a proper test for this. As far as I can tell, there are no tests at that level to validate connection failures, etc... Am I right?
I set the timeout to 1 sec, but probably a better way could be setting it to a higher value and provide an easier way to customise it?

jch · 2015-12-17T17:56:15Z

@astratto interesting. It looks like Socket.tcp gained some options in 2.x that weren't available in 1.9.x. Since we've dropped support for 1.9, this is now possible.

As far as I can tell, there are no tests at that level to validate connection failures, etc... Am I right?

Yes. I don't know how to simulate a hanging connection. If you have ideas, I'd love to hear them.

I set the timeout to 1 sec, but probably a better way could be setting it to a higher value and provide an easier way to customise it?

Agree this should be parameterized. :connect_timeout seems like a good option name. A unit test we could write would be to verify that Socket.tcp is called with the parameter.

Thanks for opening this pull!

astratto · 2015-12-17T18:08:26Z

As far as I can tell, there are no tests at that level to validate connection failures, etc... Am I right?
Yes. I don't know how to simulate a hanging connection. If you have ideas, I'd love to hear them.

I actually already have tests for our projects to trigger that situation (hence the PR 😄), I'm just not sure how to do that with the integration tests here.

Basic idea is to use a firewall to drop packets.
A simple iptables -A OUTPUT -j DROP -p tcp --dport $LDAP_PORT would do the trick in this case.

I set the timeout to 1 sec, but probably a better way could be setting it to a higher value and provide an easier way to customise it?

Agree this should be parameterized. :connect_timeout seems like a good option name. A unit test we could write would be to verify that Socket.tcp is called with the parameter.

Yes, I just wanted to understand your point of view on the general PR.
I'll try to work on that tomorrow, but feel free to jump on it if you have time.

Thanks for opening this pull!

Thanks for this gem 😉

jch · 2015-12-17T18:33:18Z

The entry point for integration tests on travis is in https://github.com/ruby-ldap/ruby-net-ldap/blob/master/.travis.yml#L15-L17. This then runs script/install-openldap. I'm not sure whether travis supports iptables, but we could run your rule for the duration of one test and then clean up after that.

astratto · 2015-12-18T16:22:35Z

Hey @jch, I've just pushed a patch to expose :connect_timeout and :timeout.

I think it's worth trying to add some integration tests for connection errors in general, should we address that in another patchset?

satoryu · 2015-12-18T17:01:38Z

lib/net/ldap/connection.rb

@@ -31,10 +36,15 @@ def open_connection(server)
    hosts = server[:hosts]
    encryption = server[:encryption]

+    socket_opts = {
+      connect_timeout: server[:connect_timeout] || DefaultConnectTimeout,
+      timeout: server[:timeout] || DefaultTimeout


According to the doc, Socket.tcp deals with only connect_timeout. Does timeout make sense?

Interesting, it was there in 2.0.0... http://docs.ruby-lang.org/en/2.0.0/Socket.html#method-c-tcp
I'm gonna remove it 😄

well-done! 👍

jch · 2015-12-18T19:46:11Z

I think it's worth trying to add some integration tests for connection errors in general, should we address that in another patchset?

👍 that's be amazing!

jch · 2015-12-18T19:47:37Z

lib/net/ldap/connection.rb

@@ -3,6 +3,9 @@
 class Net::LDAP::Connection #:nodoc:
  include Net::LDAP::Instrumentation

+  # Seconds before failing for socket connect timeout
+  DefaultConnectTimeout = 1


Could we make this value a bit more generous so it doesn't surprise any users with slow connections?

Sure, it's 5 seconds now.
I doubt more than that would be of any use, but let me know if you want to bump it further.

astratto · 2015-12-21T10:11:13Z

@jch I'd like to decouple this PR with the integration tests.
I've just created #244 to track that.

astratto · 2015-12-21T16:15:50Z

Okay, it was actually straightforward given that the box is used by Travis has iptables available.
There's one integration test for this now.

jch · 2016-01-04T21:59:28Z

@astratto looks like there's a travis error. Could we re-run it somehow?

satoryu · 2016-01-04T23:32:51Z

@astratto this failure seems like spotify/rspec-dns#26 .

so will be fixed by adding the following lines to .travis.yml.

before_install:
  - gem update bundler

satoryu · 2016-01-05T00:40:08Z

@jch @astratto I sent another PR #245 to fix this failure. please have a look :)

This patch prevents LDAP connections to hang up for an eccessive amount of time and instead returns earlier in case of failures (e.g., packets dropped). A new option is now exposed through Net::LDAP: - connect_timeout: sets a timeout for socket#connect (defaults to 1s) It also provides an integration test to validate the new behaviour (ruby-ldap#244)

astratto · 2016-01-05T17:43:45Z

@jch I've just rebased and now it's all green.

Thanks @satoryu

jch · 2016-01-05T17:57:34Z

script/install-openldap

@@ -109,4 +109,7 @@ chgrp ssl-cert /etc/ssl/private/ldap01_slapd_key.pem
 chmod g+r /etc/ssl/private/ldap01_slapd_key.pem
 chmod o-r /etc/ssl/private/ldap01_slapd_key.pem

+# Drop packets on a secondary port used to specific timeout tests


👍 helpful comment

Set a connect_timeout for the creation of a socket

jch · 2016-01-05T17:58:52Z

Looks great. I especially appreciate you taking the time to add an integration test. 🎉

astratto force-pushed the connect_timeout branch from 30099e8 to 41846bb Compare December 17, 2015 14:02

astratto force-pushed the connect_timeout branch 2 times, most recently from 01b8309 to a447c11 Compare December 18, 2015 16:20

satoryu reviewed Dec 18, 2015
View reviewed changes

astratto force-pushed the connect_timeout branch from a447c11 to 68bdf96 Compare December 18, 2015 17:28

jch reviewed Dec 18, 2015
View reviewed changes

astratto force-pushed the connect_timeout branch from 68bdf96 to 960ad23 Compare December 21, 2015 09:00

astratto force-pushed the connect_timeout branch from 960ad23 to c03e044 Compare December 21, 2015 16:11

satoryu mentioned this pull request Jan 5, 2016

Update bundler before installing gems with bundler #245

Merged

astratto added 2 commits January 5, 2016 17:27

Remove trailing spaces

b05d766

astratto force-pushed the connect_timeout branch from c03e044 to f6611e2 Compare January 5, 2016 17:28

jch reviewed Jan 5, 2016
View reviewed changes

jch added a commit that referenced this pull request Jan 5, 2016

Merge pull request #243 from astratto/connect_timeout

7b692fc

Set a connect_timeout for the creation of a socket

jch merged commit 7b692fc into ruby-ldap:master Jan 5, 2016

astratto deleted the connect_timeout branch January 5, 2016 18:26

dependabot bot mentioned this pull request Dec 18, 2023

Bump the bundler group across 1 directories with 5 updates GrantBirki/ldap-api#1

Closed

dependabot bot mentioned this pull request May 14, 2024

Bump the bundler group across 1 directory with 18 updates chrisemoulton/cartodb#1

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Set a connect_timeout for the creation of a socket #243

Set a connect_timeout for the creation of a socket #243

astratto commented Dec 17, 2015

jch commented Dec 17, 2015

astratto commented Dec 17, 2015

jch commented Dec 17, 2015

astratto commented Dec 18, 2015

satoryu Dec 18, 2015

astratto Dec 18, 2015

astratto Dec 18, 2015

satoryu Dec 18, 2015

jch commented Dec 18, 2015

jch Dec 18, 2015

astratto Dec 21, 2015

astratto commented Dec 21, 2015

astratto commented Dec 21, 2015

jch commented Jan 4, 2016

satoryu commented Jan 4, 2016

satoryu commented Jan 5, 2016

astratto commented Jan 5, 2016

jch Jan 5, 2016

jch commented Jan 5, 2016

Set a connect_timeout for the creation of a socket #243

Set a connect_timeout for the creation of a socket #243

Conversation

astratto commented Dec 17, 2015

jch commented Dec 17, 2015

astratto commented Dec 17, 2015

jch commented Dec 17, 2015

astratto commented Dec 18, 2015

satoryu Dec 18, 2015

Choose a reason for hiding this comment

astratto Dec 18, 2015

Choose a reason for hiding this comment

astratto Dec 18, 2015

Choose a reason for hiding this comment

satoryu Dec 18, 2015

Choose a reason for hiding this comment

jch commented Dec 18, 2015

jch Dec 18, 2015

Choose a reason for hiding this comment

astratto Dec 21, 2015

Choose a reason for hiding this comment

astratto commented Dec 21, 2015

astratto commented Dec 21, 2015

jch commented Jan 4, 2016

satoryu commented Jan 4, 2016

satoryu commented Jan 5, 2016

astratto commented Jan 5, 2016

jch Jan 5, 2016

Choose a reason for hiding this comment

jch commented Jan 5, 2016