passenger 5.2.3 → 5.3.0

data/src/ruby_supportlib/phusion_passenger/nginx/config_options.rb

@@ -106,6 +106,8 @@
 PhusionPassenger.require_passenger_lib 'constants'
 
 NGINX_CONFIGURATION_OPTIONS = [
+  ###### Global configuration ######
+
   {
     :name     => 'passenger_root',
     :scope    => :global,
@@ -292,6 +294,14 @@ NGINX_CONFIGURATION_OPTIONS = [
     :type     => :uinteger,
     :dynamic_default => 'passenger_core_file_descriptor_ulimit'
   },
+  {
+    :name     => 'passenger_max_instances_per_app',
+    :scope    => :global,
+    :context  => [:main],
+    :type     => :uinteger,
+    :default  => 0,
+    :header   => 'PASSENGER_MAX_PROCESSES'
+  },
   {
     :name     => 'passenger_admin_panel_url',
     :scope    => :global,
@@ -320,15 +330,10 @@ NGINX_CONFIGURATION_OPTIONS = [
     :context  => [:main],
     :struct   => 'NGX_HTTP_MAIN_CONF_OFFSET'
   },
-  {
-    :name     => 'passenger_enabled',
-    :scope    => :location,
-    :type     => :flag,
-    :default  => false,
-    :function => 'passenger_enabled',
-    :field    => 'enabled',
-    :header   => nil
-  },
+
+
+  ###### Per-application configuration ######
+
   {
     :name     => 'passenger_ruby',
     :scope    => :application,
@@ -372,39 +377,12 @@ NGINX_CONFIGURATION_OPTIONS = [
     :default  => 1,
     :header   => 'PASSENGER_MIN_PROCESSES'
   },
-  {
-    :name     => 'passenger_max_instances_per_app',
-    :scope    => :global,
-    :context  => [:main],
-    :type     => :uinteger,
-    :default  => 0,
-    :header   => 'PASSENGER_MAX_PROCESSES'
-  },
-  {
-    :name     => 'passenger_max_requests',
-    :scope    => :location,
-    :type     => :uinteger,
-    :default  => 0
-  },
   {
     :name     => 'passenger_start_timeout',
     :scope    => :application,
-    :type     => :integer,
+    :type     => :uinteger,
     :default  => DEFAULT_START_TIMEOUT / 1000
   },
-  {
-    :name     => 'passenger_base_uri',
-    :scope    => :location,
-    :type     => :string_array,
-    :field    => 'base_uris',
-    :header   => nil
-  },
-  {
-    :name     => 'passenger_document_root',
-    :scope    => :location,
-    :type     => :string,
-    :header   => nil
-  },
   {
     :name     => 'passenger_user',
     :scope    => :application,
@@ -452,6 +430,93 @@ NGINX_CONFIGURATION_OPTIONS = [
     :type     => :integer,
     :default  => DEFAULT_MAX_PRELOADER_IDLE_TIME
   },
+  {
+    :name     => 'passenger_env_var',
+    :scope    => :application,
+    :type     => :string_keyval,
+    :field    => 'env_vars',
+    :header   => nil
+  },
+  {
+    :name     => 'passenger_spawn_method',
+    :scope    => :application,
+    :dynamic_default => "'smart' for Ruby apps, 'direct' for all other apps",
+    :type     => :string
+  },
+  {
+    :name     => 'passenger_load_shell_envvars',
+    :scope    => :application,
+    :type     => :flag,
+    :default  => true
+  },
+  {
+    :name     => 'passenger_max_request_queue_size',
+    :scope    => :application,
+    :type     => :uinteger,
+    :default  => DEFAULT_MAX_REQUEST_QUEUE_SIZE
+  },
+  {
+    :name     => 'passenger_app_type',
+    :scope    => :application,
+    :type     => :string,
+    :dynamic_default => 'Autodetected',
+    :header   => nil
+  },
+  {
+    :name     => 'passenger_startup_file',
+    :scope    => :application,
+    :type     => :string,
+    :dynamic_default => 'Autodetected'
+  },
+  {
+    :name     => 'passenger_restart_dir',
+    :scope    => :application,
+    :type     => :string,
+    :default  => 'tmp'
+  },
+  {
+    :name     => 'passenger_abort_websockets_on_process_shutdown',
+    :scope    => :application,
+    :type     => :flag,
+    :default  => true
+  },
+  {
+    :name     => 'passenger_force_max_concurrent_requests_per_process',
+    :scope    => :application,
+    :type     => :integer,
+    :default  => -1
+  },
+
+  ###### Per-location/per-request configuration ######
+
+  {
+    :name     => 'passenger_enabled',
+    :scope    => :location,
+    :type     => :flag,
+    :default  => false,
+    :function => 'passenger_enabled',
+    :field    => 'enabled',
+    :header   => nil
+  },
+  {
+    :name     => 'passenger_max_requests',
+    :scope    => :location,
+    :type     => :uinteger,
+    :default  => 0
+  },
+  {
+    :name     => 'passenger_base_uri',
+    :scope    => :location,
+    :type     => :string_array,
+    :field    => 'base_uris',
+    :header   => nil
+  },
+  {
+    :name     => 'passenger_document_root',
+    :scope    => :location,
+    :type     => :string,
+    :header   => nil
+  },
   {
     :name     => 'passenger_ignore_headers',
     :scope    => :location,
@@ -461,13 +526,6 @@ NGINX_CONFIGURATION_OPTIONS = [
     :post     => '&ngx_http_upstream_ignore_headers_masks',
     :auto_generate_nginx_tracking_code => false
   },
-  {
-    :name     => 'passenger_env_var',
-    :scope    => :application,
-    :type     => :string_keyval,
-    :field    => 'env_vars',
-    :header   => nil
-  },
   {
     :name     => 'passenger_set_header',
     :scope    => :location,
@@ -551,49 +609,12 @@ NGINX_CONFIGURATION_OPTIONS = [
     :default  => false,
     :field    => 'upstream_config.intercept_errors'
   },
-  {
-    :name     => 'passenger_spawn_method',
-    :scope    => :application,
-    :dynamic_default => "'smart' for Ruby apps, 'direct' for all other apps",
-    :type     => :string
-  },
-  {
-    :name     => 'passenger_load_shell_envvars',
-    :scope    => :application,
-    :type     => :flag,
-    :default  => true
-  },
-  {
-    :name     => 'passenger_max_request_queue_size',
-    :scope    => :application,
-    :type     => :uinteger,
-    :default  => DEFAULT_MAX_REQUEST_QUEUE_SIZE
-  },
   {
     :name     => 'passenger_request_queue_overflow_status_code',
     :scope    => :location,
     :type     => :integer,
     :default  => 503
   },
-  {
-    :name     => 'passenger_restart_dir',
-    :scope    => :application,
-    :type     => :string,
-    :default  => 'tmp'
-  },
-  {
-    :name     => 'passenger_app_type',
-    :scope    => :application,
-    :type     => :string,
-    :dynamic_default => 'Autodetected',
-    :header   => nil
-  },
-  {
-    :name     => 'passenger_startup_file',
-    :scope    => :application,
-    :type     => :string,
-    :dynamic_default => 'Autodetected'
-  },
   {
     :name     => 'passenger_sticky_sessions',
     :scope    => :location,
@@ -611,20 +632,10 @@ NGINX_CONFIGURATION_OPTIONS = [
     :scope    => :location,
     :type     => :string
   },
-  {
-    :name     => 'passenger_abort_websockets_on_process_shutdown',
-    :scope    => :application,
-    :type     => :flag,
-    :default  => true
-  },
-  {
-    :name     => 'passenger_force_max_concurrent_requests_per_process',
-    :scope    => :application,
-    :type     => :integer,
-    :default  => -1
-  },
+
 
   ###### Enterprise features (placeholders in OSS) ######
+
   {
     :context  => [:main],
     :name     => 'passenger_fly_with',
@@ -690,8 +701,17 @@ NGINX_CONFIGURATION_OPTIONS = [
     :function => 'passenger_enterprise_only',
     :field    => nil
   },
+  {
+    :name     => 'passenger_app_log_file',
+    :scope    => :application,
+    :type     => :string,
+    :function => 'passenger_enterprise_only',
+    :dynamic_default => 'passenger_log_file'
+  },
+
+
+  ###### Aliases and backwards compatibility options ######
 
-  ###### Aliases for backwards compatibility ######
   {
     :name      => 'passenger_debug_log_file',
     :alias_for => 'passenger_log_file'
@@ -713,7 +733,9 @@ NGINX_CONFIGURATION_OPTIONS = [
     :alias_for => 'passenger_max_preloader_idle_time'
   },
 
-  ###### Obsolete options ######
+
+  ###### Deprecated/obsolete options ######
+
   {
     :name     => 'rails_framework_spawner_idle_time',
     :scope    => :application,

data/src/ruby_supportlib/phusion_passenger/packaging.rb

@@ -104,7 +104,6 @@ module PhusionPassenger
       'src/ruby_supportlib/phusion_passenger/vendor/*/.*',
       'src/ruby_supportlib/phusion_passenger/vendor/*/hacking/**/*',
       'src/ruby_supportlib/phusion_passenger/vendor/*/spec/**/*',
-      'src/ruby_supportlib/phusion_passenger/vendor/union_station_hooks_rails/rails_test_apps/**/*',
       'src/cxx_supportlib/vendor-copy/*/.*',
       'packaging/**/*',
       'test/**/*'

data/src/ruby_supportlib/phusion_passenger/platform_info/depcheck_specs/apache2.rb

@@ -58,7 +58,11 @@ define 'apache2-dev' do
     end
   end
   on :debian do
-    apt_get_install "apache2-threaded-dev"
+    if PlatformInfo::os_version >= '9.4'
+      apt_get_install "apache2-dev"
+    else
+      apt_get_install "apache2-threaded-dev"
+    end
   end
   on :mandriva do
     urpmi "apache-devel"

data/src/ruby_supportlib/phusion_passenger/preloader_shared_helpers.rb

@@ -23,8 +23,8 @@
 #  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 #  THE SOFTWARE.
 
-require 'socket'
 require 'tmpdir'
+PhusionPassenger.require_passenger_lib 'constants'
 PhusionPassenger.require_passenger_lib 'utils'
 PhusionPassenger.require_passenger_lib 'native_support'
 
@@ -34,58 +34,57 @@ module PhusionPassenger
   module PreloaderSharedHelpers
     extend self
 
-    def init(options)
+    def init(main_app)
+      options = LoaderSharedHelpers.init(main_app)
+
+      $0 = "#{SHORT_PROGRAM_NAME} AppPreloader: #{options['app_root']}"
+
       if !Kernel.respond_to?(:fork)
         message = "Smart spawning is not available on this Ruby " +
           "implementation because it does not support `Kernel.fork`. "
-        if ENV['SERVER_SOFTWARE'].to_s =~ /nginx/i
+        case options['integration_mode']
+        when 'nginx'
           message << "Please set `passenger_spawn_method` to `direct`."
-        else
+        when 'apache'
           message << "Please set `PassengerSpawnMethod` to `direct`."
+        else
+          message << "Please set `spawn_method` to `direct`."
         end
         raise(message)
       end
-      return options
+
+      options
     end
 
     def accept_and_process_next_client(server_socket)
-      original_pid = Process.pid
       client = server_socket.accept
       client.binmode
       begin
-        command = client.readline
+        line = client.readline
       rescue EOFError
         return nil
       end
-      if command !~ /\n\Z/
-        STDERR.puts "Command must end with a newline"
-      elsif command == "spawn\n"
-        while client.readline != "\n"
-          # Do nothing.
-        end
 
-        # Improve copy-on-write friendliness.
-        GC.start
+      begin
+        doc = Utils::JSON.parse(line)
+      rescue RuntimeError => e
+        client.write(Utils::JSON.generate(
+          :result => 'error',
+          :message => "JSON parse error: #{e}"
+        ))
+      end
 
-        pid = fork
-        if pid.nil?
-          $0 = "#{$0} (forking...)"
-          client.puts "OK"
-          client.puts Process.pid
-          client.flush
-          client.sync = true
-          return [:forked, client]
-        elsif defined?(NativeSupport)
-          NativeSupport.detach_process(pid)
-        else
-          Process.detach(pid)
-        end
+      if doc['command'] == 'spawn'
+        handle_spawn_command(client, doc)
       else
-        STDERR.puts "Unknown command '#{command.inspect}'"
+        client.write(Utils::JSON.generate(
+          :result => 'error',
+          :message => "Unknown command #{doc['command'].inspect}"
+        ))
+        nil
       end
-      return nil
     ensure
-      if client && Process.pid == original_pid
+      if client
         begin
           client.close
         rescue Errno::EINVAL
@@ -95,55 +94,79 @@ module PhusionPassenger
       end
     end
 
-    def run_main_loop(options)
-      $0 = "Passenger AppPreloader: #{options['app_root']}"
-      client = nil
-      original_pid = Process.pid
+    def handle_spawn_command(client, doc)
+      work_dir = doc['work_dir']
+      LoaderSharedHelpers.record_journey_step_end('PRELOADER_PREPARATION',
+        'STEP_PERFORMED', work_dir)
+      LoaderSharedHelpers.record_journey_step_begin('PRELOADER_FORK_SUBPROCESS',
+        'STEP_IN_PROGRESS', work_dir)
 
-      if defined?(NativeSupport)
-        unix_path_max = NativeSupport::UNIX_PATH_MAX
-      else
-        unix_path_max = options.fetch('UNIX_PATH_MAX', 100).to_i
+      # Improve copy-on-write friendliness.
+      GC.start
+
+      begin
+        pid = fork
+      rescue SystemCallError => e
+        LoaderSharedHelpers.record_journey_step_end('PRELOADER_FORK_SUBPROCESS',
+          'STEP_ERRORED', work_dir)
+        raise e
       end
-      if options['socket_dir']
-        socket_dir = options['socket_dir']
-        socket_prefix = "preloader"
+
+      if pid.nil?
+        begin
+          $0 = "#{$0} (forking...)"
+          LoaderSharedHelpers.record_journey_step_end('PRELOADER_FORK_SUBPROCESS',
+            'STEP_PERFORMED', work_dir)
+          LoaderSharedHelpers.run_block_and_record_step_progress('PRELOADER_SEND_RESPONSE', work_dir) do
+            client.write(Utils::JSON.generate(
+              :result => 'ok',
+              :pid => Process.pid
+            ))
+          end
+          LoaderSharedHelpers.record_journey_step_end('PRELOADER_FINISH',
+            'STEP_PERFORMED', work_dir)
+          [:forked, work_dir]
+        rescue Exception => e
+          STDERR.puts("Error: #{e}\n#{e.backtrace.join("\n")}")
+          exit!(1)
+        end
+      elsif defined?(NativeSupport)
+        NativeSupport.detach_process(pid)
       else
-        socket_dir = Dir.tmpdir
-        socket_prefix = "PsgPreloader"
+        Process.detach(pid)
       end
+    end
 
-      socket_filename = nil
-      server = nil
-      Utils.retry_at_most(128, Errno::EADDRINUSE) do
-        socket_filename = "#{socket_dir}/#{socket_prefix}.#{rand(0xFFFFFFFF).to_s(36)}"
-        socket_filename = socket_filename.slice(0, unix_path_max - 10)
-        server = UNIXServer.new(socket_filename)
-      end
-      server.close_on_exec!
-      File.chmod(0600, socket_filename)
+    def advertise_sockets(_options, server)
+      json = {
+        :sockets => [
+          {
+            :name => 'main',
+            :address => "unix:#{server[1]}",
+            :protocol => 'preloader',
+            :concurrency => 1
+          }
+        ]
+      }
 
-      # Update the dump information just before telling the preloader that we're
-      # ready because the Passenger core will read and memorize this information.
-      LoaderSharedHelpers.dump_all_information(options)
+      File.open(ENV['PASSENGER_SPAWN_WORK_DIR'] + '/response/properties.json', 'w') do |f|
+        f.write(PhusionPassenger::Utils::JSON.generate(json))
+      end
+    end
 
-      puts "!> Ready"
-      puts "!> socket: unix:#{socket_filename}"
-      puts "!> "
+    def run_main_loop(server, options)
+      server_socket, socket_filename = server
+      original_pid = Process.pid
 
       while true
         # We call ::select just in case someone overwrites the global select()
         # function by including ActionView::Helpers in the wrong place.
         # https://code.google.com/p/phusion-passenger/issues/detail?id=915
-        ios = Kernel.select([server, STDIN])[0]
-        if ios.include?(server)
-          result, client = accept_and_process_next_client(server)
+        ios = Kernel.select([server_socket, STDIN])[0]
+        if ios.include?(server_socket)
+          result, subprocess_work_dir = accept_and_process_next_client(server_socket)
           if result == :forked
-            STDIN.reopen(client)
-            STDOUT.reopen(client)
-            STDOUT.sync = true
-            client.close
-            return :forked
+            return subprocess_work_dir
           end
         end
         if ios.include?(STDIN)
@@ -158,9 +181,9 @@ module PhusionPassenger
           break
         end
       end
-      return nil
+      nil
     ensure
-      server.close if server
+      server_socket.close if server_socket
       if original_pid == Process.pid
         File.unlink(socket_filename) rescue nil
       end