一个有意思的Ruby Webdriver超时问题的解决过程

rescue in receive

由于写ruby的时候感觉混身上下都拽起来了，所以比較喜欢用ruby写代码。

今天遇到了一个webdriver timeout的问题，问题本身还是由于我对webdriver不了解以及破文档导致的。首先我们把问题简化一下：

driver = Selenium::WebDriver.for :safari

driver.navigate.to "http://www.faraway.com"

wait = Selenium::WebDriver::Wait.new(:timeout => 1000) # seconds

wait.until { driver.find_element(:css, 'input[name="username"]') }

由于考虑到站点太远了，速度比較慢，于是timeout设的值比較大:timeout => 1000

这里我们訪问：faraway这个站点，然后等待出现输入框输入username。

得到了例如以下错误信息：

/Users/twer/.rvm/gems/ruby-2.1.1@global/gems/selenium-webdriver-2.42.0/lib/selenium/webdriver/safari/server.rb:41:in`rescue
in receive': timed out waiting for Safari to respond (Selenium::WebDriver::Error::TimeOutError)

from /Users/twer/.rvm/gems/ruby-2.1.1@global/gems/selenium-webdriver-2.42.0/lib/selenium/webdriver/safari/server.rb:36:in `receive'

from /Users/twer/.rvm/gems/ruby-2.1.1@global/gems/selenium-webdriver-2.42.0/lib/selenium/webdriver/safari/bridge.rb:68:in `raw_execute'

from /Users/twer/.rvm/gems/ruby-2.1.1@global/gems/selenium-webdriver-2.42.0/lib/selenium/webdriver/remote/bridge.rb:612:in `execute'

from /Users/twer/.rvm/gems/ruby-2.1.1@global/gems/selenium-webdriver-2.42.0/lib/selenium/webdriver/remote/bridge.rb:110:in `get'

from /Users/twer/.rvm/gems/ruby-2.1.1@global/gems/selenium-webdriver-2.42.0/lib/selenium/webdriver/common/navigation.rb:14:in `to'

fromfaraway.rb:26:in `<main>'

看了出错的地方就是我wait的地方调用的。我心想我这不是设了:timeout => 1000。wait的等待时间为1000秒吗，怎么还搞不定啊？

Monkey Patch来解救我了

搞不定啊，上面有人在吹啊，咋办嘛。暴力解决。

我找到了上面红色部分标明的文件/selenium/webdriver/safari/server.rb。（https://code.google.com/p/selenium/source/browse/rb/lib/selenium/webdriver/safari/server.rb）

找到了出错的地方41行，是在receive函数里：

def receive

   @frame ||= WebSocket::Frame::Incoming::Server.new(:version => @version)

   until msg = @frame.next

end_time = Time.now + @command_timeout



   begin

      data = @ws.read_nonblock(1)

      rescue Errno::EWOULDBLOCK, Errno::EAGAIN

         now = Time.now

         if now >= end_time

            raise Error::TimeOutError, "timed out waiting for Safari to respond"   #第41行

         end



         IO.select([@ws], nil, nil, end_time - now)

         retry

      end



      @frame << data

   end



   puts "<<< #{msg}" if $DEBUG



   WebDriver.json_load msg.to_s

end





能够看出，是now >= end_time用来计算是否超时。在看前面end_time是由Time.now + @command_timeout得到的，然后进入begin/rescue/retry的。奇怪，我的:timeout => 1000不应该是work的吗?

第一个monkey patch

我把上面那部分代码直接拷到了我的源文件faraway.rb中，做了例如以下改动：

if now >= end_time

   puts @command_timeout

   raise Error::TimeOutError, "timed out waiting for Safari to respond"

end

发现@command_timeout不是1000。而是60，也就是一分钟

第二个monkey patch

until msg = @frame.next

   end_time = Time.now + 1000

这样强制让@command_timeout设为1000

这样执行，没有问题了

探个到底

尽管monkey patch能够解决我连接faraway的问题。可是，作为高速试验得到反馈还行。真这样用还是不太愉快。

于是我就開始读源码，webdriver本身的代码还是挺简单的。非常easy看懂。详细怎么看我就不讲了。分分钟发现了问题事实上是在这里：

driver = Selenium::WebDriver.for :safari,
timeout: 1000

driver.navigate.to "http://www.faraway.com"

红色的部分在文档上是没有交代的，那这里的timeout是什么意思呢？我的wait不是已经有timeout了吗。怎么在Driver的创建时还须要呢？

原因是这是两种不同的timeout。wait的timeout表示的是。我们的driver会等待多久知道这个元素出现。而我们出错的地方是driver接收server返回信息的timeout。

还不清楚？

这样说，在wait的时候，driver会周期轮询的去运行until中的代码。看看until中的情况是否得到了满足。

每次运行的时候Driver对会发一个请求。这个请求事实上也是有timeout时间的。所以我们最開始遇到的问题并非wait本身timeout了。

而是driver发送命令后接收的时候timeout了。

明了了吧，都是faraway.com搞得怪，想重现这个问题。把command timeout改为1试试

假设我再次不幸。。

。

我一仅仅搅得自己是运气比較背的那种人。

只是解决这个问题的过程还是非常开心。ruby这样的动态语言，能够打monkey patch，对于高速定位问题，解决这个问题还是非常有帮助的。开心。