Class: Capybara::Server

Inherits:
Object
  • Object
show all
Defined in:
lib/capybara/server.rb,
lib/capybara/server/checker.rb,
lib/capybara/server/middleware.rb,
lib/capybara/server/animation_disabler.rb

Defined Under Namespace

Classes: AnimationDisabler, Checker, Middleware

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(app, *deprecated_options, port: Capybara.server_port, host: Capybara.server_host, reportable_errors: Capybara.server_errors, extra_middleware: []) ⇒ Server

Returns a new instance of Server.



20
21
22
23
24
25
26
27
28
29
30
31
 
# File 'lib/capybara/server.rb', line 20

def initialize(app, *deprecated_options, port: Capybara.server_port, host: Capybara.server_host, reportable_errors: Capybara.server_errors, extra_middleware: [])
  warn "Positional arguments, other than the application, to Server#new are deprecated, please use keyword arguments" unless deprecated_options.empty?
  @app = app
  @extra_middleware = extra_middleware
  @server_thread = nil # suppress warnings
  @host = deprecated_options[1] || host
  @reportable_errors = deprecated_options[2] || reportable_errors
  @port = deprecated_options[0] || port
  @port ||= Capybara::Server.ports[port_key]
  @port ||= find_available_port(host)
  @checker = Checker.new(@host, @port)
end

Instance Attribute Details

#app ⇒ Object (readonly)

Returns the value of attribute app.



18
19
20
 
# File 'lib/capybara/server.rb', line 18

def app
  @app
end

#host ⇒ Object (readonly)

Returns the value of attribute host.



18
19
20
 
# File 'lib/capybara/server.rb', line 18

def host
  @host
end

#port ⇒ Object (readonly)

Returns the value of attribute port.



18
19
20
 
# File 'lib/capybara/server.rb', line 18

def port
  @port
end

Class Method Details

.ports ⇒ Object 



13
14
15
 
# File 'lib/capybara/server.rb', line 13

def ports
  @ports ||= {}
end

Instance Method Details

#boot ⇒ Object 



64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/capybara/server.rb', line 64

def boot
  unless responsive?
    Capybara::Server.ports[port_key] = port

    @server_thread = Thread.new do
      Capybara.server.call(middleware, port, host)
    end

    timer = Capybara::Helpers.timer(expire_in: 60)
    until responsive?
      raise "Rack application timed out during boot" if timer.expired?
      @server_thread.join(0.1)
    end
  end

  self
end

#error ⇒ Object 



37
38
39
 
# File 'lib/capybara/server.rb', line 37

def error
  middleware.error
end

#reset_error! ⇒ Object 



33
34
35
 
# File 'lib/capybara/server.rb', line 33

def reset_error!
  middleware.error = nil
end

#responsive? ⇒ Boolean

Returns:

  • (Boolean) 


45
46
47
48
49
50
51
52
53
54
 
# File 'lib/capybara/server.rb', line 45

def responsive?
  return false if @server_thread&.join(0)
  res = @checker.request { |http| http.get('/__identify__') }

  if res.is_a?(Net::HTTPSuccess) || res.is_a?(Net::HTTPRedirection)
    return res.body == app.object_id.to_s
  end
rescue SystemCallError
  false
end

#using_ssl? ⇒ Boolean

Returns:

  • (Boolean) 


41
42
43
 
# File 'lib/capybara/server.rb', line 41

def using_ssl?
  @checker.ssl?
end

#wait_for_pending_requests ⇒ Object 



56
57
58
59
60
61
62
 
# File 'lib/capybara/server.rb', line 56

def wait_for_pending_requests
  timer = Capybara::Helpers.timer(expire_in: 60)
  while pending_requests?
    raise "Requests did not finish in 60 seconds" if timer.expired?
    sleep 0.01
  end
end