mirror of
https://github.com/puma/puma.git
synced 2022-11-09 13:48:40 -05:00
c24c0c8834
This issue is somewhat tricky. When Rails is booted via `rails server` there are two types of configuration options passed, ones specified directly by a user like `rails s -p 3001` will always "win".
For any other config that is not explicitly passed in, puma will consider it a "default". For example when you run `rails s` (without -p) then the default port will be 3000.
There is one other way to configure puma though, and that is via a config file:
```
# config/puma.rb
port 3002
```
This is the order of precedence for configuration
1) Anything the user explicitly passes to `rails s`
2) Config specified in `config/puma.rb` file
3) Default values passed in via `rails s`
4) Defaults values stored in puma
This fallback mechanism works well except in the case of calling `port` in a `config/puma.rb` file. To understand look at the [old method definition](2668597ec1/lib/puma/dsl.rb (L140-L145)):
```
def port(port, host=nil)
host ||= Configuration::DefaultTCPHost
bind "tcp://#{host}:#{port}"
end
```
When the `port` method gets called, even if the user did not specify a `host` the `Configuration::DefaultTCPHost` will be used, which is a problem for local development because it defaults to `0.0.0.0`. [SO about 0.0.0.0 versus localhost](https://stackoverflow.com/questions/20778771/what-is-the-difference-between-0-0-0-0-127-0-0-1-and-localhost).
In this case, while a user did directly specify a port, they did not specify a host, so you would expect the `rails s` defaults passed in to take affect.
To make Puma respect that the host coming from `rails s` has more precedence than it's own default host, we must introduce the ability to set and retrieve a default_host value.
This is then used in the rack handler so when `rails s` passes in `:Host => "localhost"` then it is used instead of reverting to `0.0.0.0`.
The issue with #1699 is the test was wrong, it would have failed if a config file was present with a `port` invocation.
230 lines
5.4 KiB
Ruby
230 lines
5.4 KiB
Ruby
require_relative "helper"
|
|
|
|
require "rack/handler/puma"
|
|
|
|
class TestHandlerGetStrSym < Minitest::Test
|
|
def test_handler
|
|
handler = Rack::Handler.get(:puma)
|
|
assert_equal Rack::Handler::Puma, handler
|
|
handler = Rack::Handler.get('Puma')
|
|
assert_equal Rack::Handler::Puma, handler
|
|
end
|
|
end
|
|
|
|
class TestPathHandler < Minitest::Test
|
|
def app
|
|
Proc.new {|env| @input = env; [200, {}, ["hello world"]]}
|
|
end
|
|
|
|
def setup
|
|
@input = nil
|
|
end
|
|
|
|
def in_handler(app, options = {})
|
|
options[:Port] ||= 0
|
|
options[:Silent] = true
|
|
|
|
@launcher = nil
|
|
thread = Thread.new do
|
|
Rack::Handler::Puma.run(app, options) do |s, p|
|
|
@launcher = s
|
|
end
|
|
end
|
|
thread.abort_on_exception = true
|
|
|
|
# Wait for launcher to boot
|
|
Timeout.timeout(10) do
|
|
until @launcher
|
|
sleep 1
|
|
end
|
|
end
|
|
sleep 1
|
|
|
|
yield @launcher
|
|
ensure
|
|
@launcher.stop if @launcher
|
|
thread.join if thread
|
|
end
|
|
|
|
def test_handler_boots
|
|
host = windows? ? "127.0.1.1" : "0.0.0.0"
|
|
opts = { Host: host }
|
|
in_handler(app, opts) do |launcher|
|
|
hit(["http://#{host}:#{ launcher.connected_port }/test"])
|
|
assert_equal("/test", @input["PATH_INFO"])
|
|
end
|
|
end
|
|
end
|
|
|
|
class TestUserSuppliedOptionsPortIsSet < Minitest::Test
|
|
def setup
|
|
@options = {}
|
|
@options[:user_supplied_options] = [:Port]
|
|
end
|
|
|
|
def test_port_wins_over_config
|
|
user_port = 5001
|
|
file_port = 6001
|
|
|
|
Dir.mktmpdir do |d|
|
|
Dir.chdir(d) do
|
|
FileUtils.mkdir("config")
|
|
File.open("config/puma.rb", "w") { |f| f << "port #{file_port}" }
|
|
|
|
@options[:Port] = user_port
|
|
conf = Rack::Handler::Puma.config(->{}, @options)
|
|
conf.load
|
|
|
|
assert_equal ["tcp://0.0.0.0:#{user_port}"], conf.options[:binds]
|
|
end
|
|
end
|
|
end
|
|
end
|
|
|
|
class TestUserSuppliedOptionsHostIsSet < Minitest::Test
|
|
def setup
|
|
@options = {}
|
|
@options[:user_supplied_options] = [:Host]
|
|
end
|
|
|
|
def test_host_uses_supplied_port_default
|
|
user_port = rand(1000..9999)
|
|
user_host = "123.456.789"
|
|
|
|
@options[:Host] = user_host
|
|
@options[:Port] = user_port
|
|
conf = Rack::Handler::Puma.config(->{}, @options)
|
|
conf.load
|
|
|
|
assert_equal ["tcp://#{user_host}:#{user_port}"], conf.options[:binds]
|
|
end
|
|
end
|
|
|
|
class TestUserSuppliedOptionsIsEmpty < Minitest::Test
|
|
def setup
|
|
@options = {}
|
|
@options[:user_supplied_options] = []
|
|
end
|
|
|
|
def test_config_file_wins_over_port
|
|
user_port = 5001
|
|
file_port = 6001
|
|
|
|
Dir.mktmpdir do |d|
|
|
Dir.chdir(d) do
|
|
FileUtils.mkdir("config")
|
|
File.open("config/puma.rb", "w") { |f| f << "port #{file_port}" }
|
|
|
|
@options[:Port] = user_port
|
|
conf = Rack::Handler::Puma.config(->{}, @options)
|
|
conf.load
|
|
|
|
assert_equal ["tcp://0.0.0.0:#{file_port}"], conf.options[:binds]
|
|
end
|
|
end
|
|
end
|
|
|
|
def test_default_host_when_using_config_file
|
|
user_port = 5001
|
|
file_port = 6001
|
|
|
|
Dir.mktmpdir do |d|
|
|
Dir.chdir(d) do
|
|
FileUtils.mkdir("config")
|
|
File.open("config/puma.rb", "w") { |f| f << "port #{file_port}" }
|
|
|
|
@options[:Host] = "localhost"
|
|
@options[:Port] = user_port
|
|
conf = Rack::Handler::Puma.config(->{}, @options)
|
|
conf.load
|
|
|
|
assert_equal ["tcp://localhost:#{file_port}"], conf.options[:binds]
|
|
end
|
|
end
|
|
end
|
|
|
|
def test_default_host_when_using_config_file_with_explicit_host
|
|
user_port = 5001
|
|
file_port = 6001
|
|
|
|
Dir.mktmpdir do |d|
|
|
Dir.chdir(d) do
|
|
FileUtils.mkdir("config")
|
|
File.open("config/puma.rb", "w") { |f| f << "port #{file_port}, '1.2.3.4'" }
|
|
|
|
@options[:Host] = "localhost"
|
|
@options[:Port] = user_port
|
|
conf = Rack::Handler::Puma.config(->{}, @options)
|
|
conf.load
|
|
|
|
assert_equal ["tcp://1.2.3.4:#{file_port}"], conf.options[:binds]
|
|
end
|
|
end
|
|
end
|
|
end
|
|
|
|
class TestUserSuppliedOptionsIsNotPresent < Minitest::Test
|
|
def setup
|
|
@options = {}
|
|
end
|
|
|
|
def test_default_port_when_no_config_file
|
|
conf = Rack::Handler::Puma.config(->{}, @options)
|
|
conf.load
|
|
|
|
assert_equal ["tcp://0.0.0.0:9292"], conf.options[:binds]
|
|
end
|
|
|
|
def test_config_wins_over_default
|
|
file_port = 6001
|
|
|
|
Dir.mktmpdir do |d|
|
|
Dir.chdir(d) do
|
|
FileUtils.mkdir("config")
|
|
File.open("config/puma.rb", "w") { |f| f << "port #{file_port}" }
|
|
|
|
conf = Rack::Handler::Puma.config(->{}, @options)
|
|
conf.load
|
|
|
|
assert_equal ["tcp://0.0.0.0:#{file_port}"], conf.options[:binds]
|
|
end
|
|
end
|
|
end
|
|
|
|
def test_user_port_wins_over_default_when_user_supplied_is_blank
|
|
user_port = 5001
|
|
@options[:user_supplied_options] = []
|
|
@options[:Port] = user_port
|
|
conf = Rack::Handler::Puma.config(->{}, @options)
|
|
conf.load
|
|
|
|
assert_equal ["tcp://0.0.0.0:#{user_port}"], conf.options[:binds]
|
|
end
|
|
|
|
def test_user_port_wins_over_default
|
|
user_port = 5001
|
|
@options[:Port] = user_port
|
|
conf = Rack::Handler::Puma.config(->{}, @options)
|
|
conf.load
|
|
|
|
assert_equal ["tcp://0.0.0.0:#{user_port}"], conf.options[:binds]
|
|
end
|
|
|
|
def test_user_port_wins_over_config
|
|
user_port = 5001
|
|
file_port = 6001
|
|
|
|
Dir.mktmpdir do |d|
|
|
Dir.chdir(d) do
|
|
FileUtils.mkdir("config")
|
|
File.open("config/puma.rb", "w") { |f| f << "port #{file_port}" }
|
|
|
|
@options[:Port] = user_port
|
|
conf = Rack::Handler::Puma.config(->{}, @options)
|
|
conf.load
|
|
|
|
assert_equal ["tcp://0.0.0.0:#{user_port}"], conf.options[:binds]
|
|
end
|
|
end
|
|
end
|
|
end
|