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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ Process

Returns a new instance of Process.



64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/ferrum/browser/process.rb', line 64

def initialize(options)
  @pid = @xvfb = @user_data_dir = nil

  if options.ws_url || options.url
    # `:ws_url` option is higher priority than `:url`, parse versions
    # and use it as a ws_url, otherwise use what has been parsed.
    response = parse_json_version(options.ws_url || options.url)
    self.ws_url = options.ws_url || response&.[]("webSocketDebuggerUrl")
    return
  end

  @logger = options.logger
  @process_timeout = options.process_timeout
  @env = Hash(options.env)

  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

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
57
58
59
60
61
62
 
# File 'lib/ferrum/browser/process.rb', line 54

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

.process_killer(pid) ⇒ Object 



32
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 32

def self.process_killer(pid)
  proc do
    if Utils::Platform.windows?
      # Process.kill is unreliable on Windows
      ::Process.kill("KILL", pid) unless system("taskkill /f /t /pid #{pid} >NUL 2>NUL")
    else
      ::Process.kill("USR1", pid)
      start = Utils::ElapsedTime.monotonic_time
      while ::Process.wait(pid, ::Process::WNOHANG).nil?
        sleep(WAIT_KILLED)
        next unless Utils::ElapsedTime.timeout?(start, KILL_TIMEOUT)

        ::Process.kill("KILL", pid)
        ::Process.wait(pid)
        break
      end
    end
  rescue Errno::ESRCH, Errno::ECHILD
    # nop
  end
end

.start(*args) ⇒ Object 



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

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

Instance Method Details

#inspect ⇒ Object 



127
128
129
130
131
132
133
134
135
136
 
# File 'lib/ferrum/browser/process.rb', line 127

def inspect
  "#<#{self.class} " \
    "@user_data_dir=#{@user_data_dir.inspect} " \
    "@command=#<#{@command.class}:#{@command.object_id}> " \
    "@default_user_agent=#{@default_user_agent.inspect} " \
    "@ws_url=#{@ws_url.inspect} " \
    "@v8_version=#{@v8_version.inspect} " \
    "@browser_version=#{@browser_version.inspect} " \
    "@webkit_version=#{@webkit_version.inspect}>"
end

#restart ⇒ Object 



122
123
124
125
 
# File 'lib/ferrum/browser/process.rb', line 122

def restart
  stop
  start
end

#start ⇒ Object 



85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'lib/ferrum/browser/process.rb', line 85

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 Utils::Platform.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

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

    parse_ws_url(read_io, @process_timeout)
    parse_json_version(ws_url)
  ensure
    close_io(read_io, write_io)
  end
end

#stop ⇒ Object 



111
112
113
114
115
116
117
118
119
120
 
# File 'lib/ferrum/browser/process.rb', line 111

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