server-starter 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2f0ef5edbfbb9ba17014f1db7a34876b5b06b687
-  data.tar.gz: 0e38e80a7d760ea3c774f7c677a7f259bf9c7133
+  metadata.gz: 5c33bf7654cdd263ceabd3df64f6e30547a9777f
+  data.tar.gz: 3be2ad74bce595b12379df6990ae42e61702418a
 SHA512:
-  metadata.gz: d91568f35236855ce8d0a7a77cefb05ca73543d60af9d241886233a49e1479a13665aea0c7219bfb79ee078f2e207562ce755aad4fffa7eb0a0f8de2cbfcfafc
-  data.tar.gz: 2c8f16573b6cab8c5cc834881b7001c566d47236572b3a0c5c0de731d5d0390a927a62833ddb3ffc33b6d416f5fc2cf0145363f07ebcbfc49d4691adc2e16319
+  metadata.gz: 0d579041eb87e8bb6ee920b2958bd3852e30ca94481525708d4862b5fa396533176b47bd00f6e006e15e8871f71ea4cec6929b303ca50f25fb39cbbce5c2f9c9
+  data.tar.gz: 04d86d76d42a50798edc7f74efa4111fe89c296ab6df6f1eff08aa25e2cc273d9a3998c55747857bb3393f6c6267e2c908bd49c83f45f39a8d85c74d63907704

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## 0.1.2 (2015/03/16)
+
+Fixes:
+
+* Trivial bugfix (fix typo)
+
 ## 0.1.1 (2015/03/16)
 
 Enhancements:

data/bin/start_server.rb

@@ -189,104 +189,3 @@ start_server(
     %opts,
     exec => \@ARGV,
 );
-
-__END__
-
-=head1 NAME
-
-start_server - a superdaemon for hot-deploying server programs
-
-=head1 SYNOPSIS
-
-  start_server [options] -- server-prog server-arg1 server-arg2 ...
-
-  # start Plack using Starlet listening at TCP port 8000
-  start_server --port=8000 -- plackup -s Starlet --max-workers=100 index.psgi
-
-=head1 DESCRIPTION
-
-This script is a frontend of L<Server::Starter>.  For more information please refer to the documentation of the module.
-
-=head1 OPTIONS
-
-=head2 --port=(port|host:port)
-
-TCP port to listen to (if omitted, will not bind to any ports)
-
-=head2 --path=path
-
-path at where to listen using unix socket (optional)
-
-=head2 --dir=path
-
-working directory, start_server do chdir to before exec (optional)
-
-=head2 --interval=seconds
-
-minimum interval to respawn the server program (default: 1)
-
-=head2 --signal-on-hup=SIGNAL
-
-name of the signal to be sent to the server process when start_server receives a SIGHUP (default: SIGTERM). If you use this option, be sure to also use C<--signal-on-term> below.
-
-=head2 --signal-on-term=SIGNAL
-
-name of the signal to be sent to the server process when start_server receives a SIGTERM (default: SIGTERM)
-
-=head2 --pid-file=filename
-
-if set, writes the process id of the start_server process to the file
-
-=head2 --status-file=filename
-
-if set, writes the status of the server process(es) to the file
-
-=head2 --envdir=ENVDIR
-
-directory that contains environment variables to the server processes.
-It is intended for use with C<envdir> in C<daemontools>.
-This can be overwritten by environment variable C<ENVDIR>.
-
-=head2 --enable-auto-restart
-
-enables automatic restart by time.
-This can be overwritten by environment variable C<ENABLE_AUTO_RESTART>.
-
-=head2 --auto-restart-interval=seconds
-
-automatic restart interval (default 360). It is used with C<--enable-auto-restart> option.
-This can be overwritten by environment variable C<AUTO_RESTART_INTERVAL>.
-
-=head2 --kill-old-delay=seconds
-
-time to suspend to send a signal to the old worker. The default value is 5 when C<--enable-auto-restart> is set, 0 otherwise.
-This can be overwritten by environment variable C<KILL_OLD_DELAY>.
-
-=head2 --restart
-
-this is a wrapper command that reads the pid of the start_server process from --pid-file, sends SIGHUP to the process and waits until the server(s) of the older generation(s) die by monitoring the contents of the --status-file
-
-=head2 --backlog
-specifies a listen backlog parameter, whose default is SOMAXCONN (usually 128 on Linux). While SOMAXCONN is enough for most loads, large backlog is required for heavy loads.
-
-=head2 --help
-
-prints this help
-
-=head2 --version
-
-prints the version number
-
-=head1 AUTHOR
-
-Kazuho Oku
-
-=head1 SEE ALSO
-
-L<Server::Starter>
-
-=head1 LICENSE
-
-This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
-
-=cut

data/lib/server/starter.rb

@@ -31,7 +31,7 @@ class Server::Starter
     ports = Array(opts[:port])
     paths = Array(opts[:path])
     unless ports.empty? || paths.empty?
-      croak "either of ``port'' or ``path'' option is andatory"
+      croak "either of ``port'' or ``path'' option is mandatory"
     end
     unless opts[:exec] && opts[:exec].is_a?(Array)
       croak "mandatory option ``exec'' is missing or not an array"
@@ -47,7 +47,7 @@ class Server::Starter
     if opts[:pid_file]
       File.open(opts[:pid_file], "w") do |fh|
         fh.puts $$
-      end rescue die $!, "failed to open file:#{opts[:pid_file]}"
+      end rescue die "failed to open file:#{opts[:pid_file]}"
       at_exit { File.unlink opts[:pid_file] rescue nil }
     end
 
@@ -56,8 +56,8 @@ class Server::Starter
       File.open(opts[:log_file], "a") do |fh|
         $stdout.flush
         $stderr.flush
-        $stdout.reopen(fh) rescue die $!, "failed to reopen STDOUT to file"
-        $stderr.reopen(fh) rescue die $!, "failed to reopen STDERR to file"
+        $stdout.reopen(fh) rescue die "failed to reopen STDOUT to file"
+        $stderr.reopen(fh) rescue die "failed to reopen STDERR to file"
       end
     end
 
@@ -92,9 +92,9 @@ class Server::Starter
           croak "invalid ``port'' value:#{port}"
         end
       rescue
-        die $!, "failed to listen to port"
+        die "failed to listen to #{port}"
       end
-      sock.fcntl(Fcntl::F_SETFD, 0) rescue die $!, "fcntl(F_SETFD, 0) failed"
+      sock.fcntl(Fcntl::F_SETFD, 0) rescue die "fcntl(F_SETFD, 0) failed"
       sockenvs.push "#{port}=#{sock.fileno}"
       socks.push sock
     end
@@ -107,7 +107,7 @@ class Server::Starter
     paths.each do |path|
       if File.symlink?(path)
         warn "removing existing socket file:#{path}"
-        File.unlink(path) rescue die $!, "failed to remove existing socket file:#{path}"
+        File.unlink(path) rescue die "failed to remove existing socket file:#{path}"
       end
       File.unlink(path) rescue nil
       saved_umask = File.umask(0)
@@ -115,9 +115,9 @@ class Server::Starter
         sock = UNIXServer.new(path)
         sock.listen(opts[:backlog])
       rescue
-        die $!, "failed to listen to file #{path}"
+        die "failed to listen to file #{path}"
       end
-      sock.fcntl(Fcntl::F_SETFD, 0) rescue die $!, "fcntl(F_SETFD, 0) failed"
+      sock.fcntl(Fcntl::F_SETFD, 0) rescue die "fcntl(F_SETFD, 0) failed"
       sockenvs.push "path=#{sock.fileno}"
       socks.push sock
     end
@@ -144,11 +144,11 @@ class Server::Starter
               {}
             @old_workers.each {|pid, gen| gen_pids[gen] = pid }
             gen_pids.keys.map(&:to_i).sort.each {|gen| tmpfh.puts "#{gen}:#{gen_pids[gen.to_s]}" }
-          end rescue die $!, "failed to create temporary file:#{tmpfn}"
+          end rescue die "failed to create temporary file:#{tmpfn}"
           begin
             File.rename(tmpfn, opts[:status_file])
           rescue
-            die $!, "failed to rename #{tmpfn} to #{opts[:status_file]}"
+            die "failed to rename #{tmpfn} to #{opts[:status_file]}"
           end
         }
       else
@@ -163,12 +163,12 @@ class Server::Starter
         begin
           pid = fork
         rescue
-          die $!, "fork(2) failed"
+          die "fork(2) failed"
         end
         if pid.nil? # child process
           args = Array(opts[:exec]).dup
           if opts[:dir]
-            Dir.chdir opts[:dir] rescue die $1, "failed to chdir"
+            Dir.chdir opts[:dir] rescue die "failed to chdir"
           end
           begin
             bundler_with_clean_env do
@@ -334,7 +334,7 @@ class Server::Starter
           line.chomp
         end
       rescue
-        die $!, "failed to open file:#{opts[:pid_file]}"
+        die "failed to open file:#{opts[:pid_file]}"
       end
     }.call
 
@@ -345,7 +345,7 @@ class Server::Starter
           line =~ /^(\d+):/ ? $1 : nil
         end.compact.map(&:to_i).sort.uniq
       rescue
-        die $!, "failed to open file:#{opts[:status_file]}"
+        die "failed to open file:#{opts[:status_file]}"
       end
     }
 
@@ -357,7 +357,7 @@ class Server::Starter
     }.call
 
     # send HUP
-    Process.kill('HUP', pid.to_i) rescue die $!, "failed to send SIGHUP to the server process"
+    Process.kill('HUP', pid.to_i) rescue die "failed to send SIGHUP to the server process"
 
     # wait for the generation
     while true
@@ -778,69 +778,3 @@ sub _reload_env {
 }
 
 1;
-__END__
-
-=head1 NAME
-
-Server::Starter - a superdaemon for hot-deploying server programs
-
-=head1 SYNOPSIS
-
-  # from command line
-  % start_server --port=80 my_httpd
-
-  # in my_httpd
-  use Server::Starter qw(server_ports);
-
-  my $listen_sock = IO::Socket::INET->new(
-      Proto => 'tcp',
-  );
-  $listen_sock->fdopen((values %{server_ports()})[0], 'w')
-      or die "failed to bind to listening socket:$!";
-
-  while (1) {
-      if (my $conn = $listen_sock->accept) {
-          ....
-      }
-  }
-
-=head1 DESCRIPTION
-
-It is often a pain to write a server program that supports graceful restarts, with no resource leaks.  L<Server::Starter> solves the problem by splitting the task into two.  One is L<start_server>, a script provided as a part of the module, which works as a superdaemon that binds to zero or more TCP ports or unix sockets, and repeatedly spawns the server program that actually handles the necessary tasks (for example, responding to incoming commenctions).  The spawned server programs under L<Server::Starter> call accept(2) and handle the requests.
-
-To gracefully restart the server program, send SIGHUP to the superdaemon.  The superdaemon spawns a new server program, and if (and only if) it starts up successfully, sends SIGTERM to the old server program.
-
-By using L<Server::Starter> it is much easier to write a hot-deployable server.  Following are the only requirements a server program to be run under L<Server::Starter> should conform to:
-
-- receive file descriptors to listen to through an environment variable
-- perform a graceful shutdown when receiving SIGTERM
-
-A Net::Server personality that can be run under L<Server::Starter> exists under the name L<Net::Server::SS::PreFork>.
-
-=head1 METHODS
-
-=over 4
-
-=item server_ports
-
-Returns zero or more file descriptors on which the server program should call accept(2) in a hashref.  Each element of the hashref is: (host:port|port|path_of_unix_socket) => file_descriptor.
-
-=item start_server
-
-Starts the superdaemon.  Used by the C<start_server> script.
-
-=back
-
-=head1 AUTHOR
-
-Kazuho Oku
-
-=head1 SEE ALSO
-
-L<Net::Server::SS::PreFork>
-
-=head1 LICENSE
-
-This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
-
-=cut

data/lib/server/starter/helper.rb

@@ -10,12 +10,10 @@ class Server
         exit 1
       end
 
-      def die(*args)
-        if args.size == 2
-          e, msg = args[0], args[1]
-          $stderr.puts "#{msg}:#{e.class} #{e.message}"
+      def die(msg)
+        if $!
+          $stderr.puts "#{msg}:#{$!.class} #{$!.message}"
         else
-          msg = args[0]
           $stderr.puts msg
         end
         exit 1

data/lib/server/starter/version.rb

@@ -1,5 +1,5 @@
 class Server
   class Starter
-    VERSION = '0.1.1'
+    VERSION = '0.1.2'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: server-starter
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Naotoshi Seo