Switch from Thin to Puma (port of smashing/puma_webserver branch)

.gitignore

@@ -3,6 +3,5 @@
 *.gem
 coverage/
 log/
-tmp/
 .ruby-version
 history.yml

lib/dashing/app.rb

@@ -6,7 +6,6 @@
 require 'sass'
 require 'json'
 require 'yaml'
-require 'thin'
 
 SCHEDULER = Rufus::Scheduler.new
 
@@ -34,7 +33,7 @@ def authenticated?(token)
 set :sprockets,     Sprockets::Environment.new(settings.root)
 set :assets_prefix, '/assets'
 set :digest_assets, false
-set :server, 'thin'
+set :server, 'puma'
 set :connections, []
 set :history_file, 'history.yml'
 set :public_folder, File.join(settings.root, 'public')
@@ -75,10 +74,19 @@ def authenticated?(token)
 get '/events', :provides => 'text/event-stream' do
   protected!
   response.headers['X-Accel-Buffering'] = 'no' # Disable buffering for nginx
-  stream :keep_open do |out|
-    settings.connections << out
+  stream do |out|
     out << latest_events
-    out.callback { settings.connections.delete(out) }
+    settings.connections << connection = {out: out, mutex: Mutex.new, terminated: false}
+    terminated = false
+
+    loop do
+      connection[:mutex].synchronize do
+        terminated = true if connection[:terminated]
+      end
+      break if terminated
+    end
+
+    settings.connections.delete(connection)
   end
 end
 
@@ -126,22 +134,23 @@ def authenticated?(token)
   "Drats! Unable to find a widget file named: #{params[:widget]} to render."
 end
 
-Thin::Server.class_eval do
-  def stop_with_connection_closing
-    Sinatra::Application.settings.connections.dup.each(&:close)
-    stop_without_connection_closing
-  end
-
-  alias_method :stop_without_connection_closing, :stop
-  alias_method :stop, :stop_with_connection_closing
-end
-
 def send_event(id, body, target=nil)
   body[:id] = id
-  body[:updatedAt] ||= (Time.now.to_f * 1000.0).to_i 
+  body[:updatedAt] ||= (Time.now.to_f * 1000.0).to_i
   event = format_event(body.to_json, target)
   Sinatra::Application.settings.history[id] = event unless target == 'dashboards'
-  Sinatra::Application.settings.connections.each { |out| out << event }
+  Sinatra::Application.settings.connections.each do |connection|
+    connection[:mutex].synchronize do
+      begin
+        connection[:out] << event unless connection[:out].closed?
+      rescue Puma::ConnectionError
+        connection[:terminated] = true
+      rescue Exception => e
+        connection[:terminated] = true
+        puts e
+      end
+    end
+  end
 end
 
 def format_event(body, name=nil)

lib/dashing/cli.rb

@@ -57,16 +57,20 @@ def install(gist_id, *args)
     desc "start", "Starts the server in style!"
     method_option :job_path, :desc => "Specify the directory where jobs are stored"
     def start(*args)
-      port_option = args.include?('-p') ? '' : ' -p 3030'
+      daemonize = args.include?('-d')
       args = args.join(' ')
-      command = "bundle exec thin -R config.ru start#{port_option} #{args}"
+      command = "bundle exec puma #{args}"
       command.prepend "export JOB_PATH=#{options[:job_path]}; " if options[:job_path]
+      command.prepend "export DAEMONIZE=true; " if daemonize
       run_command(command)
     end
 
-    desc "stop", "Stops the thin server"
-    def stop
-      command = "bundle exec thin stop"
+    desc "stop", "Stops the puma server (daemon mode only)"
+    def stop(*args)
+      args = args.join(' ')
+      # TODO correctly handle pidfile location change in puma config
+      daemon_pidfile = !args.include?('--pidfile') ? '--pidfile ./tmp/pids/puma.pid' : args
+      command = "bundle exec pumactl #{daemon_pidfile} stop"
       run_command(command)
     end
 

smashing.gemspec

@@ -20,7 +20,7 @@ Gem::Specification.new do |s|
   s.add_dependency('execjs', '~> 2.0.2')
   s.add_dependency('sinatra', '~> 1.4.4')
   s.add_dependency('sinatra-contrib', '~> 1.4.2')
-  s.add_dependency('thin', '~> 1.6.1')
+  s.add_dependency('puma', '~> 3.11.0')
   s.add_dependency('rufus-scheduler', '~> 3.2.0')
   s.add_dependency('thor', '~> 0.19')
   s.add_dependency('sprockets', '~> 2.10.1')

templates/project/config/puma.rb

@@ -0,0 +1,42 @@
+# For a complete list of puma configuration parameters, please see
+# https://github.com/puma/puma
+
+# Puma can serve each request in a thread from an internal thread pool.
+# The `threads` method setting takes two numbers a minimum and maximum.
+# Any libraries that use thread pools should be configured to match
+# the maximum value specified for Puma. Default is set to 5 threads for minimum
+# and maximum.
+#
+threads_count = ENV.fetch("PUMA_MAX_THREADS") { 5 }.to_i
+threads threads_count, threads_count
+
+# Specifies the `port` that Puma will listen on to receive requests, default is 2020.
+#
+port        ENV.fetch("DASHING_PORT") { 3030 }
+
+# Specifies the `environment` that Puma will run in.
+#
+environment ENV.fetch("RACK_ENV") { "production" }
+
+# Daemonize the server into the background. Highly suggest that
+# this be combined with "pidfile" and "stdout_redirect".
+#
+# The default is "false".
+#
+daemonize ENV.fetch("DAEMONIZE") { false }
+
+# Store the pid of the server in the file at "path".
+#
+pidfile './tmp/pids/puma.pid'
+
+# Use "path" as the file to store the server info state. This is
+# used by "pumactl" to query and control the server.
+#
+state_path './tmp/pids/puma.state'
+
+# Redirect STDOUT and STDERR to files specified. The 3rd parameter
+# ("append") specifies whether the output is appended, the default is
+# "false".
+#
+# stdout_redirect '/u/apps/lolcat/log/stdout', '/u/apps/lolcat/log/stderr'
+# stdout_redirect '/u/apps/lolcat/log/stdout', '/u/apps/lolcat/log/stderr', true

templates/project/tmp/pids/.empty_directory

@@ -0,0 +1 @@
+.empty_directory

test/app_test.rb

@@ -1,10 +1,16 @@
 require 'test_helper'
 require 'haml'
 
+class StreamStub < Array
+  def closed?
+    return false
+  end
+end
+
 class AppTest < Dashing::Test
   def setup
-    @connection = []
-    app.settings.connections = [@connection]
+    @connection = {out: StreamStub.new, mutex: Mutex.new, terminated: false}
+    app.settings.connections = [ @connection ]
     app.settings.auth_token = nil
     app.settings.default_dashboard = nil
     app.settings.history_file = File.join(Dir.tmpdir, 'history.yml')
@@ -48,9 +54,8 @@ def test_errors_out_when_no_dashboards_available
   def test_post_widgets_without_auth_token
     post '/widgets/some_widget', JSON.generate({value: 6})
     assert_equal 204, last_response.status
-
-    assert_equal 1, @connection.length
-    data = parse_data @connection[0]
+    assert_equal 1, @connection[:out].length
+    data = parse_data @connection[:out][0]
     assert_equal 6, data['value']
     assert_equal 'some_widget', data['id']
     assert data['updatedAt']
@@ -72,19 +77,15 @@ def test_get_events
     post '/widgets/some_widget', JSON.generate({value: 8})
     assert_equal 204, last_response.status
 
-    get '/events'
-    assert_equal 200, last_response.status
-    assert_equal 8, parse_data(@connection[0])['value']
+    assert_equal 8, parse_data(@connection[:out][0])['value']
   end
 
   def test_dashboard_events
     post '/dashboards/my_super_sweet_dashboard', JSON.generate({event: 'reload'})
     assert_equal 204, last_response.status
 
-    get '/events'
-    assert_equal 200, last_response.status
-    assert_equal 'dashboards', parse_event(@connection[0])
-    assert_equal 'reload', parse_data(@connection[0])['event']
+    assert_equal 'dashboards', parse_event(@connection[:out][0])
+    assert_equal 'reload', parse_data(@connection[:out][0])['event']
   end
 
   def test_get_dashboard

test/cli_test.rb

@@ -101,31 +101,41 @@ def test_install_task_warns_when_gist_not_found
     assert_includes output, 'Could not find gist at '
   end
 
-  def test_start_task_starts_thin_with_default_port
-    command = 'bundle exec thin -R config.ru start -p 3030 '
+  def test_start_task_starts_puma_with_default_port
+    command = 'bundle exec puma '
     @cli.stubs(:run_command).with(command).once
     @cli.start
   end
 
-  def test_start_task_starts_thin_with_specified_port
-    command = 'bundle exec thin -R config.ru start -p 2020'
+  def test_start_task_starts_puma_in_daemon_mode
+      commands =  [
+          'export DAEMONIZE=true; ',
+          'bundle exec puma -d'
+      ]
+
+      @cli.stubs(:run_command).with(commands.join('')).once
+      @cli.start('-d')
+  end
+
+  def test_start_task_starts_puma_with_specified_port
+    command = 'bundle exec puma -p 2020'
     @cli.stubs(:run_command).with(command).once
     @cli.start('-p', '2020')
   end
 
   def test_start_task_supports_job_path_option
     commands = [
       'export JOB_PATH=other_spot; ',
-      'bundle exec thin -R config.ru start -p 3030 '
+      'bundle exec puma '
     ]
 
     @cli.stubs(:options).returns(job_path: 'other_spot')
     @cli.stubs(:run_command).with(commands.join('')).once
     @cli.start
   end
 
-  def test_stop_task_stops_thin_server
-    @cli.stubs(:run_command).with('bundle exec thin stop')
+  def test_stop_task_stops_puma_server
+    @cli.stubs(:run_command).with('bundle exec pumactl --pidfile ./tmp/pids/puma.pid stop')
     @cli.stop
   end