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

rescue in receive

因为写ruby的时候感觉混身上下都拽起来了，所以比较喜欢用ruby写代码。今天遇到了一个webdriver timeout的问题，问题本身还是因为我对webdriver不了解以及破文档导致的。首先我们把问题简化一下：

driver = Selenium::WebDriver.for :safari
driver.navigate.to "http://www.faraway.com"

因为考虑到网站太远了，速度比较慢，于是timeout设的值比较大:timeout => 1000

这里我们访问：faraway这个网站，然后等待出现输入框输入用户名。得到了如下错误信息：

看了出错的地方就是我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本身的代码还是挺简单的。很容易看懂，具体怎么看我就不讲了。分分钟发现了问题其实是在这里：

driver = Selenium::WebDriver.for :safari, timeout: 1000
driver.navigate.to "http://www.faraway.com"

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

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

这样说，在wait的时候，driver会周期轮询的去执行until中的代码，看看until中的情况是否得到了满足。每次执行的时候Driver对会发一个请求，这个请求其实也是有timeout时间的，所以我们最开始遇到的问题并不是wait本身timeout了。而是driver发送命令后接收的时候timeout了。

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

如果我再次不幸。。。

我一只搅得自己是运气比较背的那种人。不过解决问题的过程还是很开心。ruby这种动态语言，可以打monkey patch，对于快速定位问题，解决问题还是很有帮助的。开心。

一个有意思的Ruby Webdriver超时问题的解决过程,古老的榕树,5-wow.com