Class: Puma::Runner

Inherits:
Object
  • Object
show all
Defined in:
lib/puma/runner.rb

Overview

Generic class that is used by ‘Puma::Cluster` and `Puma::Single` to serve requests. This class spawns a new instance of `Puma::Server` via a call to `start_server`.

Direct Known Subclasses

Cluster, Single

Instance Method Summary collapse

Constructor Details

#initialize(cli, events) ⇒ Runner

Returns a new instance of Runner.



11
12
13
14
15
16
17
 
# File 'lib/puma/runner.rb', line 11

def initialize(cli, events)
  @launcher = cli
  @events = events
  @options = cli.options
  @app = nil
  @control = nil
end

Instance Method Details

#app ⇒ Object 



156
157
158
 
# File 'lib/puma/runner.rb', line 156

def app
  @app ||= @launcher.config.app
end

#before_restart ⇒ Object 



35
36
37
 
# File 'lib/puma/runner.rb', line 35

def before_restart
  @control.stop(true) if @control
end

#daemon? ⇒ Boolean

Returns:

  • (Boolean) 


19
20
21
 
# File 'lib/puma/runner.rb', line 19

def daemon?
  @options[:daemon]
end

#debug(str) ⇒ Object 



43
44
45
 
# File 'lib/puma/runner.rb', line 43

def debug(str)
  @events.log "- #{str}" if @options[:debug]
end

#development? ⇒ Boolean

Returns:

  • (Boolean) 


23
24
25
 
# File 'lib/puma/runner.rb', line 23

def development?
  @options[:environment] == "development"
end

#error(str) ⇒ Object 



39
40
41
 
# File 'lib/puma/runner.rb', line 39

def error(str)
  @events.error str
end

#load_and_bind ⇒ Object 



139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
 
# File 'lib/puma/runner.rb', line 139

def load_and_bind
  unless @launcher.config.app_configured?
    error "No application configured, nothing to run"
    exit 1
  end

  # Load the app before we daemonize.
  begin
    @app = @launcher.config.app
  rescue Exception => e
    log "! Unable to load application: #{e.class}: #{e.message}"
    raise e
  end

  @launcher.binder.parse @options[:binds], self
end

#log(str) ⇒ Object 



31
32
33
 
# File 'lib/puma/runner.rb', line 31

def log(str)
  @events.log str
end

#output_header(mode) ⇒ Object 



95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'lib/puma/runner.rb', line 95

def output_header(mode)
  min_t = @options[:min_threads]
  max_t = @options[:max_threads]

  log "Puma starting in #{mode} mode..."
  log "* Version #{Puma::Const::PUMA_VERSION} (#{ruby_engine}), codename: #{Puma::Const::CODE_NAME}"
  log "* Min threads: #{min_t}, max threads: #{max_t}"
  log "* Environment: #{ENV['RACK_ENV']}"

  if @options[:mode] == :tcp
    log "* Mode: Lopez Express (tcp)"
  end
end

#redirect_io ⇒ Object 



113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
 
# File 'lib/puma/runner.rb', line 113

def redirect_io
  stdout = @options[:redirect_stdout]
  stderr = @options[:redirect_stderr]
  append = @options[:redirect_append]

  if stdout
    unless Dir.exist?(File.dirname(stdout))
      raise "Cannot redirect STDOUT to #{stdout}"
    end

    STDOUT.reopen stdout, (append ? "a" : "w")
    STDOUT.sync = true
    STDOUT.puts "=== puma startup: #{Time.now} ==="
  end

  if stderr
    unless Dir.exist?(File.dirname(stderr))
      raise "Cannot redirect STDERR to #{stderr}"
    end

    STDERR.reopen stderr, (append ? "a" : "w")
    STDERR.sync = true
    STDERR.puts "=== puma startup: #{Time.now} ==="
  end
end

#redirected_io? ⇒ Boolean

Returns:

  • (Boolean) 


109
110
111
 
# File 'lib/puma/runner.rb', line 109

def redirected_io?
  @options[:redirect_stdout] || @options[:redirect_stderr]
end

#ruby_engine ⇒ Object 



83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/puma/runner.rb', line 83

def ruby_engine
  if !defined?(RUBY_ENGINE) || RUBY_ENGINE == "ruby"
    "ruby #{RUBY_VERSION}-p#{RUBY_PATCHLEVEL}"
  else
    if defined?(RUBY_ENGINE_VERSION)
      "#{RUBY_ENGINE} #{RUBY_ENGINE_VERSION} - ruby #{RUBY_VERSION}"
    else
      "#{RUBY_ENGINE} #{RUBY_VERSION}"
    end
  end
end

#start_control ⇒ Object 



47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/puma/runner.rb', line 47

def start_control
  str = @options[:control_url]
  return unless str

  require 'puma/app/status'

  uri = URI.parse str

  app = Puma::App::Status.new @launcher

  if token = @options[:control_auth_token]
    app.auth_token = token unless token.empty? or token == :none
  end

  control = Puma::Server.new app, @launcher.events
  control.min_threads = 0
  control.max_threads = 1

  case uri.scheme
  when "tcp"
    log "* Starting control server on #{str}"
    control.add_tcp_listener uri.host, uri.port
  when "unix"
    log "* Starting control server on #{str}"
    path = "#{uri.host}#{uri.path}"
    mask = @options[:control_url_umask]

    control.add_unix_listener path, mask
  else
    error "Invalid control URI: #{str}"
  end

  control.run
  @control = control
end

#start_server ⇒ Object 



160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
 
# File 'lib/puma/runner.rb', line 160

def start_server
  min_t = @options[:min_threads]
  max_t = @options[:max_threads]

  server = Puma::Server.new app, @launcher.events, @options
  server.min_threads = min_t
  server.max_threads = max_t
  server.inherit_binder @launcher.binder

  if @options[:mode] == :tcp
    server.tcp_mode!
  end

  if @options[:early_hints]
    server.early_hints = true
  end

  unless development? || test?
    server.leak_stack_on_error = false
  end

  server
end

#test? ⇒ Boolean

Returns:

  • (Boolean) 


27
28
29
 
# File 'lib/puma/runner.rb', line 27

def test?
  @options[:environment] == "test"
end