Class: Ferrum::Browser::Process

Inherits:
Object
  • Object
show all
Extended by:
Forwardable
Defined in:
lib/ferrum/browser/process.rb

Constant Summary collapse

KILL_TIMEOUT = 
2
WAIT_KILLED = 
0.05
PROCESS_TIMEOUT = 
ENV.fetch("FERRUM_PROCESS_TIMEOUT", 10).to_i

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ Process

Returns a new instance of Process.



58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/ferrum/browser/process.rb', line 58

def initialize(options)
  if options[:url]
    url = URI.join(options[:url].to_s, "/json/version")
    response = JSON.parse(::Net::HTTP.get(url))
    set_ws_url(response["webSocketDebuggerUrl"])
    parse_browser_versions
    return
  end

  @pid = @xvfb = @user_data_dir = nil
  @logger = options[:logger]
  @process_timeout = options.fetch(:process_timeout, PROCESS_TIMEOUT)

  tmpdir = Dir.mktmpdir("ferrum_user_data_dir_")
  ObjectSpace.define_finalizer(self, self.class.directory_remover(tmpdir))
  @user_data_dir = tmpdir
  @command = Command.build(options, tmpdir)
end

Instance Attribute Details

#browser_version ⇒ Object (readonly)

Returns the value of attribute browser_version.



21
22
23
 
# File 'lib/ferrum/browser/process.rb', line 21

def browser_version
  @browser_version
end

#command ⇒ Object (readonly)

Returns the value of attribute command.



21
22
23
 
# File 'lib/ferrum/browser/process.rb', line 21

def command
  @command
end

#default_user_agent ⇒ Object (readonly)

Returns the value of attribute default_user_agent.



21
22
23
 
# File 'lib/ferrum/browser/process.rb', line 21

def default_user_agent
  @default_user_agent
end

#host ⇒ Object (readonly)

Returns the value of attribute host.



21
22
23
 
# File 'lib/ferrum/browser/process.rb', line 21

def host
  @host
end

#pid ⇒ Object (readonly)

Returns the value of attribute pid.



21
22
23
 
# File 'lib/ferrum/browser/process.rb', line 21

def pid
  @pid
end

#port ⇒ Object (readonly)

Returns the value of attribute port.



21
22
23
 
# File 'lib/ferrum/browser/process.rb', line 21

def port
  @port
end

#protocol_version ⇒ Object (readonly)

Returns the value of attribute protocol_version.



21
22
23
 
# File 'lib/ferrum/browser/process.rb', line 21

def protocol_version
  @protocol_version
end

#v8_version ⇒ Object (readonly)

Returns the value of attribute v8_version.



21
22
23
 
# File 'lib/ferrum/browser/process.rb', line 21

def v8_version
  @v8_version
end

#webkit_version ⇒ Object (readonly)

Returns the value of attribute webkit_version.



21
22
23
 
# File 'lib/ferrum/browser/process.rb', line 21

def webkit_version
  @webkit_version
end

#ws_url ⇒ Object (readonly)

Returns the value of attribute ws_url.



21
22
23
 
# File 'lib/ferrum/browser/process.rb', line 21

def ws_url
  @ws_url
end

#xvfb ⇒ Object (readonly)

Returns the value of attribute xvfb.



21
22
23
 
# File 'lib/ferrum/browser/process.rb', line 21

def xvfb
  @xvfb
end

Class Method Details

.directory_remover(path) ⇒ Object 



54
55
56
 
# File 'lib/ferrum/browser/process.rb', line 54

def self.directory_remover(path)
  proc { FileUtils.remove_entry(path) rescue Errno::ENOENT }
end

.process_killer(pid) ⇒ Object 



33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
 
# File 'lib/ferrum/browser/process.rb', line 33

def self.process_killer(pid)
  proc do
    begin
      if Ferrum.windows?
        ::Process.kill("KILL", pid)
      else
        ::Process.kill("USR1", pid)
        start = Ferrum.monotonic_time
        while ::Process.wait(pid, ::Process::WNOHANG).nil?
          sleep(WAIT_KILLED)
          next unless Ferrum.timeout?(start, KILL_TIMEOUT)
          ::Process.kill("KILL", pid)
          ::Process.wait(pid)
          break
        end
      end
    rescue Errno::ESRCH, Errno::ECHILD
    end
  end
end

.start(*args) ⇒ Object 



29
30
31
 
# File 'lib/ferrum/browser/process.rb', line 29

def self.start(*args)
  new(*args).tap(&:start)
end

Instance Method Details

#restart ⇒ Object 



113
114
115
116
 
# File 'lib/ferrum/browser/process.rb', line 113

def restart
  stop
  start
end

#start ⇒ Object 



77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/ferrum/browser/process.rb', line 77

def start
  # Don't do anything as browser is already running as external process.
  return if ws_url

  begin
    read_io, write_io = IO.pipe
    process_options = { in: File::NULL }
    process_options[:pgroup] = true unless Ferrum.windows?
    process_options[:out] = process_options[:err] = write_io

    if @command.xvfb?
      @xvfb = Xvfb.start(@command.options)
      ObjectSpace.define_finalizer(self, self.class.process_killer(@xvfb.pid))
    end

    @pid = ::Process.spawn(Hash(@xvfb&.to_env), *@command.to_a, process_options)
    ObjectSpace.define_finalizer(self, self.class.process_killer(@pid))

    parse_ws_url(read_io, @process_timeout)
    parse_browser_versions
  ensure
    close_io(read_io, write_io)
  end
end

#stop ⇒ Object 



102
103
104
105
106
107
108
109
110
111
 
# File 'lib/ferrum/browser/process.rb', line 102

def stop
  if @pid
    kill(@pid)
    kill(@xvfb.pid) if @xvfb&.pid
    @pid = nil
  end

  remove_user_data_dir if @user_data_dir
  ObjectSpace.undefine_finalizer(self)
end