puma 2.8.1 → 2.8.2

data/History.txt

@@ -1,3 +1,30 @@
+=== 2.8.2 / 2014-04-12
+
+* 4 bug fixes:
+  * During upgrade, change directory in main process instead of workers.
+  * Close the client properly on error
+  * Capistrano: fallback from phased restart to start when not started
+  * Allow tag option in conf file
+
+* 4 doc fixes:
+  * Fix Puma daemon service README typo
+  * `preload_app!` instead of `preload_app`
+  * add preload_app and prune_bundler to example config
+  * allow changing of worker_timeout in config file
+
+* 11 PRs merged:
+  * Merge pull request #487 from ckuttruff/master
+  * Merge pull request #492 from ckuttruff/master
+  * Merge pull request #493 from alepore/config_tag
+  * Merge pull request #503 from mariuz/patch-1
+  * Merge pull request #505 from sammcj/patch-1
+  * Merge pull request #506 from FlavourSys/config_worker_timeout
+  * Merge pull request #510 from momer/rescue-block-handle-servers-fix
+  * Merge pull request #511 from macool/patch-1
+  * Merge pull request #514 from edogawaconan/refactor_env
+  * Merge pull request #517 from misfo/patch-1
+  * Merge pull request #518 from LongMan/master
+
 === 2.8.1 / 2014-03-06
 
 * 1 bug fixes:

data/README.md

@@ -116,6 +116,10 @@ If you're preloading your application and using ActiveRecord, it's recommend you
         ActiveRecord::Base.establish_connection
       end
     end
+    
+When you use preload_app, your new code goes all in the master process, and is then copied in the workers (meaning it’s only compatible with cluster mode). General rule is to use preload_app when your workers die often and need fast starts. If you don’t have many workers, you should probably don’t use preload_app.
+
+Note that preload_app can’t be used with phased restart, since phased restart kills and restarts workers one-by-one, and preload_app is all about copying the code of master into the workers.
 
 ### Binding TCP / Sockets
 
@@ -170,6 +174,19 @@ No code is shared between the current and restarted process, so it should be saf
 
 If the new process is unable to load, it will simply exit. You should therefore run Puma under a supervisor when using it in production.
 
+### Normal vs Hot vs Phased Restart
+
+A hot restart means that no requests while deploying your new code will be lost, since the server socket is kept open between restarts.
+
+But beware, hot restart does not mean that the incoming requests won’t hang for multiple seconds while your new code has not fully deployed. If you need a zero downtime and zero hanging requests deploy, you must use phased restart.
+
+When you run pumactl phased-restart, Puma kills workers one-by-one, meaning that at least another worker is still available to serve requests, which lead in zero hanging request (yay!).
+
+But again beware, upgrading an application sometimes involves upgrading the database schema. With phased restart, there may be a moment during the deployment where processes belonging to the previous version and processes belonging to the new version both exist at the same time. Any database schema upgrades you perform must therefore be backwards-compatible with the old application version.
+
+if you perform a lot of database migrations, you probably should not use phased restart and use a normal/hot restart instead (pumactl restart). That way, no code is shared while deploying (in that case, preload_app might help for quicker deployment, see below).
+
+
 ### Cleanup Code
 
 Puma isn't able to understand all the resources that your app may use, so it provides a hook in the configuration file you pass to `-C` called `on_restart`. The block passed to `on_restart` will be called, unsurprisingly, just before Puma restarts itself.
@@ -194,12 +211,21 @@ If you want an easy way to manage multiple scripts at once check [tools/jungle](
 
 ## Capistrano deployment
 
-Puma has included Capistrano [deploy script](https://github.com/puma/puma/blob/master/lib/puma/capistrano.rb), you just need require that:
+Puma has support for Capistrano3 with an [external gem](https://github.com/seuros/capistrano-puma), you just need require that in Gemfile:
+
+```ruby
+gem 'capistrano3-puma'
+```
+And then execute:
+
+```bash
+bundle
+```
 
-config/deploy.rb
+Then add to Capfile
 
 ```ruby
-require 'puma/capistrano'
+require 'capistrano/puma'
 ```
 
 and then

data/Rakefile

@@ -8,7 +8,6 @@ Hoe.plugin :git
 Hoe.plugin :ignore
 
 HOE = Hoe.spec "puma" do
-  self.rubyforge_name = 'puma'
   self.readme_file    = "README.md"
   self.urls = %w!http://puma.io https://github.com/puma/puma!
 

data/lib/puma/capistrano.rb

@@ -42,7 +42,12 @@ Capistrano::Configuration.instance.load do
 
     desc 'Restart puma (phased restart)'
     task :phased_restart, :roles => lambda { puma_role }, :on_no_matching_servers => :continue do
-      run "cd #{current_path} && #{pumactl_cmd} -S #{state_path} phased-restart"
+      begin
+        run "cd #{current_path} && #{pumactl_cmd} -S #{state_path} phased-restart"
+      rescue Capistrano::CommandError => ex
+        puts "Failed to restart puma: #{ex}\nAssuming not started."
+        start
+      end
     end
 
   end

data/lib/puma/cli.rb

@@ -257,14 +257,13 @@ module Puma
       end
     end
 
-    def set_rack_environment
+    def env
       # Try the user option first, then the environment variable,
       # finally default to development
+      @options[:environment] || ENV['RACK_ENV'] || 'development'
+    end
 
-      env = @options[:environment] ||
-                   ENV['RACK_ENV'] ||
-                     'development'
-
+    def set_rack_environment
       @options[:environment] = env
       ENV['RACK_ENV'] = env
     end
@@ -286,13 +285,7 @@ module Puma
         return
       end
 
-      pos = []
-
-      if env = (@options[:environment] || ENV['RACK_ENV'])
-        pos << "config/puma/#{env}.rb"
-      end
-
-      pos << "config/puma.rb"
+      pos = ["config/puma/#{env}.rb", "config/puma.rb"]
       @options[:config_file] = pos.find { |f| File.exist? f }
     end
 

data/lib/puma/cluster.rb

@@ -27,6 +27,13 @@ module Puma
     def start_phased_restart
       @phase += 1
       log "- Starting phased worker restart, phase: #{@phase}"
+
+      # Be sure to change the directory again before loading
+      # the app. This way we can pick up new code.
+      if dir = @options[:worker_directory]
+        log "+ Changing to #{dir}"
+        Dir.chdir dir
+      end
     end
 
     class Worker
@@ -80,14 +87,12 @@ module Puma
     def spawn_workers
       diff = @options[:workers] - @workers.size
 
-      upgrade = (@phased_state == :waiting)
-
       master = Process.pid
 
       diff.times do
         idx = next_worker_index
 
-        pid = fork { worker(idx, upgrade, master) }
+        pid = fork { worker(idx, master) }
         @cli.debug "Spawned worker: #{pid}"
         @workers << Worker.new(idx, pid, @phase)
         @options[:after_worker_boot].each { |h| h.call }
@@ -163,7 +168,7 @@ module Puma
       end
     end
 
-    def worker(index, upgrade, master)
+    def worker(index, master)
       $0 = "puma: cluster worker #{index}: #{master}"
       Signal.trap "SIGINT", "IGNORE"
 
@@ -176,15 +181,6 @@ module Puma
         exit! 1
       end
 
-      # Be sure to change the directory again before loading
-      # the app. This way we can pick up new code.
-      if upgrade
-        if dir = @options[:worker_directory]
-          log "+ Changing to #{dir}"
-          Dir.chdir dir
-        end
-      end
-
       # If we're not running under a Bundler context, then
       # report the info about the context we will be using
       if !ENV['BUNDLER_GEMFILE'] and File.exist?("Gemfile")

data/lib/puma/configuration.rb

@@ -362,6 +362,16 @@ module Puma
       def prune_bundler(answer=true)
         @options[:prune_bundler] = answer
       end
+
+      # Additional text to display in process listing
+      def tag(string)
+        @options[:tag] = string
+      end
+
+      # *Cluster mode only* Set the timeout for workers
+      def worker_timeout(timeout)
+        @options[:worker_timeout] = timeout
+      end
     end
   end
 end

data/lib/puma/const.rb

@@ -28,7 +28,7 @@ module Puma
   # too taxing on performance.
   module Const
 
-    PUMA_VERSION = VERSION = "2.8.1".freeze
+    PUMA_VERSION = VERSION = "2.8.2".freeze
     CODE_NAME = "Sir Edmund Percival Hillary".freeze
 
     FAST_TRACK_KA_TIMEOUT = 0.2

data/lib/puma/server.rb

@@ -185,8 +185,8 @@ module Puma
               else
                 begin
                   if io = sock.accept_nonblock
-                    c = Client.new io, nil
-                    pool << c
+                    client = Client.new io, nil
+                    pool << client
                   end
                 rescue SystemCallError
                 end
@@ -292,8 +292,8 @@ module Puma
               else
                 begin
                   if io = sock.accept_nonblock
-                    c = Client.new io, @binder.env(sock)
-                    pool << c
+                    client = Client.new io, @binder.env(sock)
+                    pool << client
                   end
                 rescue SystemCallError
                 end
@@ -732,8 +732,8 @@ module Puma
             begin
               if io = sock.accept_nonblock
                 count += 1
-                c = Client.new io, @binder.env(sock)
-                @thread_pool << c
+                client = Client.new io, @binder.env(sock)
+                @thread_pool << client
               end
             rescue SystemCallError
             end

data/tools/jungle/init.d/README.md

@@ -31,7 +31,7 @@ You can add an instance by editing the file or running the following command:
 The config and log paths are optional parameters and default to:
 
 * config: /path/to/app/*config/puma.rb*
-* log: /path/to/app/*config/puma.log*
+* log: /path/to/app/*log/puma.log*
 
 To remove an app, simply delete the line from the config file or run:
 

metadata

@@ -1,77 +1,86 @@
 --- !ruby/object:Gem::Specification
 name: puma
 version: !ruby/object:Gem::Version
-  version: 2.8.1
+  version: 2.8.2
+  prerelease: 
 platform: ruby
 authors:
 - Evan Phoenix
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-06 00:00:00.000000000 Z
+date: 2014-04-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '1.1'
-    - - "<"
+    - - <
       - !ruby/object:Gem::Version
         version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '1.1'
-    - - "<"
+    - - <
       - !ruby/object:Gem::Version
         version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rdoc
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '4.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '4.0'
 - !ruby/object:Gem::Dependency
   name: rake-compiler
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 0.8.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 0.8.0
 - !ruby/object:Gem::Dependency
   name: hoe
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '3.9'
+        version: '3.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '3.9'
+        version: '3.6'
 description: Puma is a simple, fast, threaded, and highly concurrent HTTP 1.1 server
   for Ruby/Rack applications. Puma is intended for use in both development and production
   environments. In order to get the best throughput, it is highly recommended that
@@ -155,6 +164,14 @@ files:
 - lib/puma/util.rb
 - lib/rack/handler/puma.rb
 - puma.gemspec
+- tools/jungle/README.md
+- tools/jungle/init.d/README.md
+- tools/jungle/init.d/puma
+- tools/jungle/init.d/run-puma
+- tools/jungle/upstart/README.md
+- tools/jungle/upstart/puma-manager.conf
+- tools/jungle/upstart/puma.conf
+- tools/trickletest.rb
 - test/test_app_status.rb
 - test/test_cli.rb
 - test/test_config.rb
@@ -172,39 +189,32 @@ files:
 - test/test_thread_pool.rb
 - test/test_unix_socket.rb
 - test/test_ws.rb
-- tools/jungle/README.md
-- tools/jungle/init.d/README.md
-- tools/jungle/init.d/puma
-- tools/jungle/init.d/run-puma
-- tools/jungle/upstart/README.md
-- tools/jungle/upstart/puma-manager.conf
-- tools/jungle/upstart/puma.conf
-- tools/trickletest.rb
 homepage: http://puma.io
 licenses:
 - BSD
-metadata: {}
 post_install_message: 
 rdoc_options:
-- "--main"
+- --main
 - README.md
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
-  - - ">="
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: 1.8.7
 required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
-  - - ">="
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: puma
-rubygems_version: 2.2.2
+rubygems_version: 1.8.25
 signing_key: 
-specification_version: 4
+specification_version: 3
 summary: Puma is a simple, fast, threaded, and highly concurrent HTTP 1.1 server for
   Ruby/Rack applications
 test_files:

checksums.yaml

@@ -1,7 +0,0 @@
----
-SHA1:
-  metadata.gz: 74aab6aaab377487d53393978bbb59ffae181f66
-  data.tar.gz: 383b6735116a87480a5c73403107de1941da3e99
-SHA512:
-  metadata.gz: 2d9663eec2cf39f8e7471937887633cb56a6b8a8989ab3055a8c64497637decc45b56b9d87d2873004ee56665ba9d8386da28c1dd9d216ff9c15942a5961a1e5
-  data.tar.gz: e65857e59cda95b3980761ec5bf8b00f55c55fa1798d6dc43c56c775e84872f7d36d28a5260c232c360f354d4fe865fcc9a76e731b1430e7f26d6291066c60fd