Remove daemonization (#2170)

* Remove daemonization

* Fix t2 integration

History.md

@@ -13,6 +13,7 @@
   * `--control` has been removed. Use `--control-url` (#1487)
   * `worker_directory` has been removed. Use `directory`.
   * `tcp_mode` has been removed without replacement. (#2169)
+  * Daemonization has been removed without replacement. (#2170)
   * Changed #connected_port to #connected_ports (#2076)
 
 * Bugfixes

README.md

@@ -270,7 +270,7 @@ It is common to use process monitors with Puma. Modern process monitors like sys
 provide continuous monitoring and restarts for increased
 reliability in production environments:
 
-* [tools/jungle](https://github.com/puma/puma/tree/master/tools/jungle) for sysvinit (init.d) and upstart
+* [docs/jungle](https://github.com/puma/puma/tree/master/docs/jungle) for rc.d and upstart
 * [docs/systemd](https://github.com/puma/puma/blob/master/docs/systemd.md)
 
 ## Community Extensions

docs/deployment.md

@@ -74,7 +74,9 @@ thread to become available.
     * haproxy: `%Th` (TLS handshake time) and `%Ti` (idle time before request) can
       can also be added as headers.
 
-## Daemonizing
+## Should I daemonize?
+
+Daemonization was removed in Puma 5.0. For alternatives, continue reading.
 
 I prefer to not daemonize my servers and use something like `runit` or `upstart` to
 monitor them as child processes. This gives them fast response to crashes and

docs/jungle/README.md

@@ -0,0 +1,13 @@
+# Puma as a service
+
+## Upstart
+
+See `/docs/jungle/upstart` for Ubuntu's upstart scripts.
+
+## Systemd
+
+See [/docs/systemd](https://github.com/puma/puma/blob/master/docs/systemd.md).
+
+## rc.d
+
+See `/docs/jungle/rc.d` for FreeBSD's rc.d scripts

docs/systemd.md

@@ -209,66 +209,6 @@ Apr 07 08:40:19 hx puma[28320]: * Activated ssl://0.0.0.0:9234?key=key.pem&cert=
 Apr 07 08:40:19 hx puma[28320]: Use Ctrl-C to stop
 ~~~~
 
-## Alternative Forking Configuration
-
-Other systems/tools might expect or need puma to be run as a
-"traditional" forking server, for example so that the `pumactl`
-command can be used directly and outside of systemd for
-stop/start/restart. This use case is incompatible with systemd socket
-activation, so it should not be configured. Below is an alternative
-puma.service config sample, using `Type=forking` and the `--daemon`
-flag in `ExecStart`. Here systemd is playing a role more equivalent to
-SysV init.d, where it is responsible for starting Puma on boot
-(multi-user.target) and stopping it on shutdown, but is not performing
-continuous restarts. Therefore running Puma in cluster mode, where the
-master can restart workers, is highly recommended. See the systemd
-[Restart] directive for details.
-
-~~~~ ini
-[Unit]
-Description=Puma HTTP Forking Server
-After=network.target
-
-[Service]
-# Background process configuration (use with --daemon in ExecStart)
-Type=forking
-
-# Preferably configure a non-privileged user
-# User=
-
-# The path to the puma application root
-# Also replace the "<WD>" place holders below with this path.
-WorkingDirectory=
-
-# The command to start Puma
-# (replace "<WD>" below)
-ExecStart=bundle exec puma -C <WD>/shared/puma.rb --daemon
-
-# The command to stop Puma
-# (replace "<WD>" below)
-ExecStop=bundle exec pumactl -S <WD>/shared/tmp/pids/puma.state stop
-
-# Path to PID file so that systemd knows which is the master process
-PIDFile=<WD>/shared/tmp/pids/puma.pid
-
-# Should systemd restart puma?
-# Use "no" (the default) to ensure no interference when using
-# stop/start/restart via `pumactl`.  The "on-failure" setting might
-# work better for this purpose, but you must test it.
-# Use "always" if only `systemctl` is used for start/stop/restart, and
-# reconsider if you actually need the forking config.
-Restart=no
-
-# `puma_ctl restart` wouldn't work without this. It's because `pumactl`
-# changes PID on restart and systemd stops the service afterwards
-# because of the PID change. This option prevents stopping after PID
-# change.
-RemainAfterExit=yes
-
-[Install]
-WantedBy=multi-user.target
-~~~~
-
 ### capistrano3-puma
 
 By default,

lib/puma/cli.rb

@@ -117,11 +117,6 @@ def setup_options
             @control_options[:auth_token] = arg
           end
 
-          o.on "-d", "--daemon", "Daemonize the server into the background" do
-            user_config.daemonize
-            user_config.quiet
-          end
-
           o.on "--debug", "Log lowlevel debugging information" do
             user_config.debug
           end

lib/puma/cluster.rb

@@ -469,12 +469,7 @@ def run
       #
       @check_pipe, @suicide_pipe = Puma::Util.pipe
 
-      if daemon?
-        log "* Daemonizing..."
-        Process.daemon(true)
-      else
-        log "Use Ctrl-C to stop"
-      end
+      log "Use Ctrl-C to stop"
 
       redirect_io
 

lib/puma/configuration.rb

@@ -175,7 +175,6 @@ def puma_default_options
         :debug => false,
         :binds => ["tcp://#{DefaultTCPHost}:#{DefaultTCPPort}"],
         :workers => 0,
-        :daemon => false,
         :mode => :http,
         :worker_timeout => DefaultWorkerTimeout,
         :worker_boot_timeout => DefaultWorkerTimeout,

lib/puma/dsl.rb

@@ -210,20 +210,6 @@ def clean_thread_locals(which=true)
       @options[:clean_thread_locals] = which
     end
 
-    # Daemonize the server into the background. It's highly recommended to
-    # use this in combination with +pidfile+ and +stdout_redirect+.
-    #
-    # The default is "false".
-    #
-    # @example
-    #   daemonize
-    #
-    # @example
-    #   daemonize false
-    def daemonize(which=true)
-      @options[:daemon] = which
-    end
-
     # When shutting down, drain the accept socket of pending
     # connections and process them. This loops over the accept
     # socket until there are no more read events and then stops

lib/puma/jruby_restart.rb

@@ -22,63 +22,5 @@ def self.chdir_exec(dir, argv)
       execlp(cmd, *argv)
       raise SystemCallError.new(FFI.errno)
     end
-
-    PermKey = 'PUMA_DAEMON_PERM'
-    RestartKey = 'PUMA_DAEMON_RESTART'
-
-    # Called to tell things "Your now always in daemon mode,
-    # don't try to reenter it."
-    #
-    def self.perm_daemonize
-      ENV[PermKey] = "1"
-    end
-
-    def self.daemon?
-      ENV.key?(PermKey) || ENV.key?(RestartKey)
-    end
-
-    def self.daemon_init
-      return true if ENV.key?(PermKey)
-
-      return false unless ENV.key? RestartKey
-
-      master = ENV[RestartKey]
-
-      # In case the master disappears early
-      begin
-        Process.kill "SIGUSR2", master.to_i
-      rescue SystemCallError => e
-      end
-
-      ENV[RestartKey] = ""
-
-      setsid
-
-      null = File.open "/dev/null", "w+"
-      STDIN.reopen null
-      STDOUT.reopen null
-      STDERR.reopen null
-
-      true
-    end
-
-    def self.daemon_start(dir, argv)
-      ENV[RestartKey] = Process.pid.to_s
-
-      if k = ENV['PUMA_JRUBY_DAEMON_OPTS']
-        ENV['JRUBY_OPTS'] = k
-      end
-
-      cmd = argv.first
-      argv = ([:string] * argv.size).zip(argv).flatten
-      argv << :string
-      argv << nil
-
-      chdir(dir)
-      ret = fork
-      return ret if ret != 0
-      execlp(cmd, *argv)
-      raise SystemCallError.new(FFI.errno)
-    end
   end
 end

lib/puma/launcher.rb

@@ -70,10 +70,6 @@ def initialize(conf, launcher_args={})
         unsupported "worker mode not supported on #{RUBY_ENGINE} on this platform"
       end
 
-      if @options[:daemon] && Puma.windows?
-        unsupported 'daemon mode not supported on Windows'
-      end
-
       Dir.chdir(@restart_dir)
 
       prune_bundler if prune_bundler?

lib/puma/rack/builder.rb

@@ -67,10 +67,6 @@ def parse!(args)
           options[:environment] = e
         }
 
-        opts.on("-D", "--daemonize", "run daemonized in the background") { |d|
-          options[:daemonize] = d ? true : false
-        }
-
         opts.on("-P", "--pid FILE", "file to store PID") { |f|
           options[:pid] = ::File.expand_path(f)
         }

lib/puma/runner.rb

@@ -18,10 +18,6 @@ def initialize(cli, events)
       @started_at = Time.now
     end
 
-    def daemon?
-      @options[:daemon]
-    end
-
     def development?
       @options[:environment] == "development"
     end
@@ -130,7 +126,6 @@ def load_and_bind
         exit 1
       end
 
-      # Load the app before we daemonize.
       begin
         @app = @launcher.config.app
       rescue Exception => e

lib/puma/single.rb

@@ -42,64 +42,10 @@ def stop_blocked
       @server.stop(true) if @server
     end
 
-    def jruby_daemon?
-      daemon? and Puma.jruby?
-    end
-
-    def jruby_daemon_start
-      require 'puma/jruby_restart'
-      JRubyRestart.daemon_start(@restart_dir, @launcher.restart_args)
-    end
-
     def run
-      already_daemon = false
-
-      if jruby_daemon?
-        require 'puma/jruby_restart'
-
-        if JRubyRestart.daemon?
-          # load and bind before redirecting IO so errors show up on stdout/stderr
-          load_and_bind
-          redirect_io
-        end
-
-        already_daemon = JRubyRestart.daemon_init
-      end
-
       output_header "single"
 
-      if jruby_daemon?
-        if already_daemon
-          JRubyRestart.perm_daemonize
-        else
-          pid = nil
-
-          Signal.trap "SIGUSR2" do
-            log "* Started new process #{pid} as daemon..."
-
-            # Must use exit! so we don't unwind and run the ensures
-            # that will be run by the new child (such as deleting the
-            # pidfile)
-            exit!(true)
-          end
-
-          Signal.trap "SIGCHLD" do
-            log "! Error starting new process as daemon, exiting"
-            exit 1
-          end
-
-          jruby_daemon_start
-          sleep
-        end
-      else
-        if daemon?
-          log "* Daemonizing..."
-          Process.daemon(true)
-          redirect_io
-        end
-
-        load_and_bind
-      end
+      load_and_bind
 
       Plugins.fire_background
 
@@ -109,10 +55,9 @@ def run
 
       @server = server = start_server
 
-      unless daemon?
-        log "Use Ctrl-C to stop"
-        redirect_io
-      end
+
+      log "Use Ctrl-C to stop"
+      redirect_io
 
       @launcher.events.fire_on_booted!
 

test/shell/t2.rb

@@ -1,4 +1,4 @@
-system "ruby -rrubygems -Ilib bin/pumactl -F test/shell/t2_conf.rb start"
+system "ruby -rrubygems -Ilib bin/pumactl -F test/shell/t2_conf.rb start &"
 sleep 5
 system "curl http://localhost:10103/"
 

test/shell/t2_conf.rb

@@ -3,4 +3,3 @@
 pidfile "t2-pid"
 bind "tcp://0.0.0.0:10103"
 rackup File.expand_path('../rackup/hello.ru', File.dirname(__FILE__))
-daemonize