Remove WEBrick

WEBrick is not recommended for production usage, and the rackup gem dropped the dependency on it. [1], [2] With these changes in mind, just recommend Puma as the web server, for simplicity. [1]: ruby/webrick@70b026c [2]: rack/rackup#23
sinatra · Nov 7, 2024 · 4a55850 · 4a55850
1 parent 955682e
commit 4a55850
Show file tree

Hide file tree

Showing 7 changed files with 17 additions and 34 deletions.
diff --git a/README.md b/README.md
@@ -18,9 +18,7 @@ end
 Install the gems needed:
 
 ```shell
-gem install sinatra
-gem install rackup
-gem install puma # or any other server (optional step)
+gem install sinatra rackup puma
 ```
 
 And run with:
@@ -2087,12 +2085,8 @@ set :protection, :session => true
 
   <dt>server_settings</dt>
     <dd>
-      If you are using a WEBrick web server, presumably for your development
-      environment, you can pass a hash of options to <tt>server_settings</tt>,
-      such as <tt>SSLEnable</tt> or <tt>SSLVerifyClient</tt>. However, web
-      servers such as Puma do not support this, so you can set
-      <tt>server_settings</tt> by defining it as a method when you call
-      <tt>configure</tt>.
+      You can pass a hash of options to <tt>server_settings</tt>,
+      such as <tt>Host</tt> or <tt>Port</tt>.
     </dd>
 
   <dt>sessions</dt>
@@ -2813,7 +2807,7 @@ _Paraphrasing from
 by Konstantin_
 
 Sinatra doesn't impose any concurrency model but leaves that to the
-underlying Rack handler (server) like Puma or WEBrick. Sinatra
+underlying Rack handler (server) like Puma or Falcon. Sinatra
 itself is thread-safe, so there won't be any problem if the Rack handler
 uses a threaded model of concurrency.
 

diff --git a/lib/sinatra/base.rb b/lib/sinatra/base.rb
@@ -1600,20 +1600,20 @@ def quit!
       alias stop! quit!
 
       # Run the Sinatra app as a self-hosted server using
-      # Puma, Falcon, or WEBrick (in that order). If given a block, will call
+      # Puma, Falcon (in that order). If given a block, will call
       # with the constructed handler once we have taken the stage.
       def run!(options = {}, &block)
         unless defined?(Rackup::Handler)
           rackup_warning = <<~MISSING_RACKUP
-            Sinatra could not start, the "rackup" gem was not found!
+            Sinatra could not start, the required gems weren't found!
 
-            Add it to your bundle with:
+            Add them to your bundle with:
 
-                bundle add rackup
+                bundle add rackup puma
 
-            or install it with:
+            or install them with:
 
-                gem install rackup
+                gem install rackup puma
 
           MISSING_RACKUP
           warn rackup_warning
@@ -1963,7 +1963,7 @@ class << self
     set :running_server, nil
     set :handler_name, nil
     set :traps, true
-    set :server, %w[HTTP webrick]
+    set :server, %w[]
     set :bind, proc { development? ? 'localhost' : '0.0.0.0' }
     set :port, Integer(ENV['PORT'] && !ENV['PORT'].empty? ? ENV['PORT'] : 4567)
     set :quiet, false

diff --git a/rack-protection/lib/rack/protection/authenticity_token.rb b/rack-protection/lib/rack/protection/authenticity_token.rb
@@ -46,15 +46,15 @@ module Protection
     # Install the gem, then run the program:
     #
     #   gem install 'rack-protection'
-    #   ruby server.rb
+    #   puma server.ru
     #
-    # Here is <tt>server.rb</tt>:
+    # Here is <tt>server.ru</tt>:
     #
     #   require 'rack/protection'
     #   require 'rack/session'
     #
     #   app = Rack::Builder.app do
-    #     use Rack::Session::Cookie, secret: 'secret'
+    #     use Rack::Session::Cookie, secret: 'CHANGEMEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa'
     #     use Rack::Protection::AuthenticityToken
     #
     #     run -> (env) do
@@ -88,7 +88,7 @@ module Protection
     #     end
     #   end
     #
-    #   Rack::Handler::WEBrick.run app
+    #   run app
     #
     # == Example: Customize which POST parameter holds the token
     #

diff --git a/test/integration_helper.rb b/test/integration_helper.rb
@@ -78,10 +78,6 @@ def command
       end
     end
 
-    def webrick?
-      name.to_s == "webrick"
-    end
-
     def puma?
       name.to_s == "puma"
     end

diff --git a/test/integration_start_test.rb b/test/integration_start_test.rb
@@ -22,7 +22,7 @@ def test_app_start_without_rackup
     env = { "BUNDLE_GEMFILE" => gem_file }
 
     with_process(command: command, env: env) do |process, read_io|
-      assert wait_for_output(read_io, /Sinatra could not start, the "rackup" gem was not found/)
+      assert wait_for_output(read_io, /Sinatra could not start, the required gems weren't found/)
     end
   end
 

diff --git a/test/integration_test.rb b/test/integration_test.rb
@@ -19,15 +19,13 @@ class IntegrationTest < Minitest::Test
     count = server.log.scan("GET /ping?x=#{random}").count
     if server.net_http_server?
       assert_equal 0, count
-    elsif server.webrick?
-      assert(count > 0)
     else
       assert_equal(1, count)
     end
   end
 
   it 'streams' do
-    next if server.webrick? or server.trinidad?
+    next if server.trinidad?
     times, chunks = [Process.clock_gettime(Process::CLOCK_MONOTONIC)], []
     server.get_stream do |chunk|
       next if chunk.empty?

diff --git a/test/settings_test.rb b/test/settings_test.rb
@@ -479,11 +479,6 @@ def pub; end
   end
 
   describe 'server' do
-    it 'includes webrick' do
-      assert @base.server.include?('webrick')
-      assert @application.server.include?('webrick')
-    end
-
     it 'includes puma' do
       assert @base.server.include?('puma')
       assert @application.server.include?('puma')