passenger 5.2.3 → 5.3.0

data/src/cxx_supportlib/vendor-copy/adhoc_lve.h

@@ -38,6 +38,7 @@
 #include <boost/shared_ptr.hpp>
 #include <boost/scoped_ptr.hpp>
 #include <boost/thread/once.hpp>
+#include <boost/noncopyable.hpp>
 
 #include <sys/types.h>
 #include <unistd.h>

data/src/helper-scripts/node-loader.js

@@ -117,8 +117,8 @@ vm.runInThisContext = function() {
 	return orig_func.apply(this, arguments);
 };
 
+
 var LineReader = require('phusion_passenger/line_reader').LineReader;
-var ustLog = require('phusion_passenger/ustrouter_connector');
 
 var instrumentModulePaths = [ 'phusion_passenger/log_express', 'phusion_passenger/log_mongodb'];
 var instrumentedModules = [];
@@ -126,44 +126,42 @@ var instrumentedModules = [];
 module.isApplicationLoader = true; // https://groups.google.com/forum/#!topic/compoundjs/4txxkNtROQg
 global.PhusionPassenger = exports.PhusionPassenger = new EventEmitter();
 var stdinReader = new LineReader(process.stdin);
-beginHandshake();
-readInitializationHeader();
 
+recordJourneyStepEnd('SUBPROCESS_EXEC_WRAPPER', 'STEP_PERFORMED');
+recordJourneyStepBegin('SUBPROCESS_WRAPPER_PREPARATION', 'STEP_IN_PROGRESS');
+var options = readStartupArguments();
+setupEnvironment(options);
 
-function beginHandshake() {
-	process.stdout.write("!> I have control 1.0\n");
-}
 
-function readInitializationHeader() {
-	stdinReader.readLine(function(line) {
-		if (line != "You have control 1.0\n") {
-			console.error('Invalid initialization header');
-			process.exit(1);
-		} else {
-			readOptions();
-		}
-	});
+function tryWriteFile(path, contents) {
+	try {
+		fs.writeFileSync(path, contents);
+	} catch (e) {
+		console.error('Warning: unable to write to ' + path + ': ' + e.message);
+	}
 }
 
-function readOptions() {
-	var options = {};
+function recordJourneyStepBegin(step, state) {
+	var workDir = process.env['PASSENGER_SPAWN_WORK_DIR'];
+	var stepDir = workDir + '/response/steps/' + step.toLowerCase();
+	tryWriteFile(stepDir + '/state', 'STEP_IN_PROGRESS');
+	tryWriteFile(stepDir + '/begin_time', Date.now() / 1000);
+}
 
-	function readNextOption() {
-		stdinReader.readLine(function(line) {
-			if (line == "\n") {
-				setupEnvironment(options);
-			} else if (line == "") {
-				console.error("End of stream encountered while reading initialization options");
-				process.exit(1);
-			} else {
-				var matches = line.replace(/\n/, '').match(/(.*?) *: *(.*)/);
-				options[matches[1]] = matches[2];
-				readNextOption();
-			}
-		});
+function recordJourneyStepEnd(step, state) {
+	var workDir = process.env['PASSENGER_SPAWN_WORK_DIR'];
+	var stepDir = workDir + '/response/steps/' + step.toLowerCase();
+	tryWriteFile(stepDir + '/state', 'STEP_IN_PROGRESS');
+	if (!fs.existsSync(stepDir + '/begin_time') && !fs.existsSync(stepDir + '/begin_time_monotonic')) {
+		tryWriteFile(stepDir + '/begin_time', Date.now() / 1000);
 	}
+	tryWriteFile(stepDir + '/end_time', Date.now() / 1000);
+}
 
-	readNextOption();
+function readStartupArguments() {
+	var workDir = process.env['PASSENGER_SPAWN_WORK_DIR'];
+	var doc = fs.readFileSync(workDir + '/args.json');
+	return JSON.parse(doc);
 }
 
 function passengerToWinstonLogLevel(passengerLogLevel) {
@@ -206,35 +204,14 @@ function setupEnvironment(options) {
 	http.Server.prototype.originalListen = http.Server.prototype.listen;
 	http.Server.prototype.listen = installServer;
 
-	ustLog.init(logger, PhusionPassenger.options.ust_router_address, PhusionPassenger.options.ust_router_username,
-		PhusionPassenger.options.ust_router_password, PhusionPassenger.options.union_station_key, PhusionPassenger.options.app_group_name);
-
-	if (ustLog.isEnabled()) {
-		// must be first so other modules can use the cls context
-		require('vendor-copy/continuation-local-storage').createNamespace('passenger-request-ctx');
-
-		global.phusion_passenger_ustReporter = require('phusion_passenger/ustreporter');
-		global.phusion_passenger_ustReporter.init(logger, options.app_root, ustLog);
-
-		instrumentModulePaths.forEach(function(modulePath) {
-			var module = require(modulePath);
-			instrumentedModules.push(module);
-			module.initPreLoad(logger, options.app_root, ustLog);
-		});
-	}
-
 	stdinReader.close();
 	stdinReader = undefined;
 	process.stdin.on('end', shutdown);
 	process.stdin.resume();
 
+	recordJourneyStepEnd('SUBPROCESS_WRAPPER_PREPARATION', 'STEP_PERFORMED');
+	recordJourneyStepBegin('SUBPROCESS_APP_LOAD_OR_EXEC', 'STEP_IN_PROGRESS');
 	loadApplication();
-
-	if (ustLog.isEnabled()) {
-		instrumentedModules.forEach(function(module) {
-			module.initPostLoad();
-		});
-	}
 }
 
 /**
@@ -339,6 +316,9 @@ function installServer() {
 		PhusionPassenger._appInstalled = true;
 		PhusionPassenger._server = server;
 
+		recordJourneyStepEnd('SUBPROCESS_APP_LOAD_OR_EXEC', 'STEP_PERFORMED');
+		recordJourneyStepBegin('SUBPROCESS_LISTEN', 'STEP_IN_PROGRESS');
+
 		// Ensure that req.connection.remoteAddress and remotePort return something
 		// instead of undefined. Apps like Etherpad expect it.
 		// See https://github.com/phusion/passenger/issues/1224
@@ -379,11 +359,26 @@ function listenAndMaybeInstall(port) {
 }
 
 function finalizeStartup() {
-	process.stdout.write("!> Ready\n");
-	process.stdout.write("!> socket: main;unix:" +
-		PhusionPassenger._server.address() +
-		";http_session;0\n");
-	process.stdout.write("!> \n");
+	recordJourneyStepEnd('SUBPROCESS_LISTEN', 'STEP_PERFORMED');
+
+	var workDir = process.env['PASSENGER_SPAWN_WORK_DIR'];
+
+	fs.writeFileSync(workDir + '/response/properties.json', JSON.stringify({
+		sockets: [
+			{
+				name: 'main',
+				address: 'unix:' + PhusionPassenger.options.socket_path,
+				protocol: 'http',
+				concurrency: 0,
+				accept_http_requests: true
+			}
+		]
+	}));
+
+	// fs.writeFileSync() does not work on FIFO files
+	var stream = fs.createWriteStream(workDir + '/response/finish');
+	stream.write('1');
+	stream.close();
 }
 
 function shutdown() {

data/src/helper-scripts/rack-loader.rb

@@ -34,61 +34,51 @@ module PhusionPassenger
       @@app
     end
 
-    def self.format_exception(e)
-      result = "#{e} (#{e.class})"
-      if !e.backtrace.empty?
-        if e.respond_to?(:html?) && e.html?
-          require 'erb' if !defined?(ERB)
-          result << "\n<pre>  " << ERB::Util.h(e.backtrace.join("\n  ")) << "</pre>"
-        else
-          result << "\n  " << e.backtrace.join("\n  ")
-        end
+    def self.init_passenger
+      STDOUT.sync = true
+      STDERR.sync = true
+
+      work_dir = ENV['PASSENGER_SPAWN_WORK_DIR'].to_s
+      if work_dir.empty?
+        abort "This program may only be invoked from Passenger (error: $PASSENGER_SPAWN_WORK_DIR not set)."
       end
-      result
+
+      record_journey_step_end('SUBPROCESS_EXEC_WRAPPER', 'STEP_PERFORMED')
+      record_journey_step_begin('SUBPROCESS_WRAPPER_PREPARATION', 'STEP_IN_PROGRESS')
+
+      ruby_libdir = File.read("#{work_dir}/args/ruby_libdir").strip
+      passenger_root = File.read("#{work_dir}/args/passenger_root").strip
+      require "#{ruby_libdir}/phusion_passenger"
+      PhusionPassenger.locate_directories(passenger_root)
+
+      PhusionPassenger.require_passenger_lib 'loader_shared_helpers'
     end
 
-    def self.exit_code_for_exception(e)
-      if e.is_a?(SystemExit)
-        e.status
-      else
-        1
+    def self.try_write_file(path, contents)
+      begin
+        File.open(path, 'wb') do |f|
+          f.write(contents)
+        end
+      rescue SystemCallError => e
+        STDERR.puts "Warning: unable to write to #{path}: #{e}"
       end
     end
 
-    def self.handshake_and_read_startup_request
-      STDOUT.sync = true
-      STDERR.sync = true
-      puts "!> I have control 1.0"
-      abort "Invalid initialization header" if STDIN.readline != "You have control 1.0\n"
-
-      @@options = {}
-      while (line = STDIN.readline) != "\n"
-        name, value = line.strip.split(/: */, 2)
-        @@options[name] = value
-      end
+    def self.record_journey_step_begin(step, state)
+      dir = ENV['PASSENGER_SPAWN_WORK_DIR']
+      step_dir = "#{dir}/response/steps/#{step.downcase}"
+      try_write_file("#{step_dir}/state", state)
+      try_write_file("#{step_dir}/begin_time", Time.now.to_f)
     end
 
-    def self.init_passenger
-      require "#{options["ruby_libdir"]}/phusion_passenger"
-      PhusionPassenger.locate_directories(options["passenger_root"])
-      PhusionPassenger.require_passenger_lib 'native_support'
-      PhusionPassenger.require_passenger_lib 'ruby_core_enhancements'
-      PhusionPassenger.require_passenger_lib 'ruby_core_io_enhancements'
-      PhusionPassenger.require_passenger_lib 'loader_shared_helpers'
-      PhusionPassenger.require_passenger_lib 'request_handler'
-      PhusionPassenger.require_passenger_lib 'rack/thread_handler_extension'
-      @@options = LoaderSharedHelpers.init(@@options)
-      if defined?(NativeSupport)
-        NativeSupport.disable_stdio_buffering
+    def self.record_journey_step_end(step, state)
+      dir = ENV['PASSENGER_SPAWN_WORK_DIR']
+      step_dir = "#{dir}/response/steps/#{step.downcase}"
+      try_write_file("#{step_dir}/state", state)
+      if !File.exist?("#{step_dir}/begin_time") && !File.exist?("#{step_dir}/begin_time_monotonic")
+        try_write_file("#{step_dir}/begin_time", Time.now.to_f)
       end
-      RequestHandler::ThreadHandler.send(:include, Rack::ThreadHandlerExtension)
-    rescue Exception => e
-      LoaderSharedHelpers.about_to_abort(options, e) if defined?(LoaderSharedHelpers)
-      puts "!> Error"
-      puts "!> html: true" if e.respond_to?(:html?) && e.html?
-      puts "!> "
-      puts format_exception(e)
-      exit exit_code_for_exception(e)
+      try_write_file("#{step_dir}/end_time", Time.now.to_f)
     end
 
     def self.load_app
@@ -97,9 +87,9 @@ module PhusionPassenger
       LoaderSharedHelpers.before_loading_app_code_step2(options)
       LoaderSharedHelpers.activate_gem 'rack'
 
-      app_root = options["app_root"]
+      app_root = options['app_root']
       rackup_file = LoaderSharedHelpers.maybe_make_path_relative_to_app_root(
-        app_root, options["startup_file"] || "#{app_root}/config.ru")
+        app_root, options['startup_file'] || "#{app_root}/config.ru")
       rackup_code = ::File.open(rackup_file, 'rb') do |f|
         f.read
       end
@@ -108,26 +98,39 @@ module PhusionPassenger
 
       LoaderSharedHelpers.after_loading_app_code(options)
     rescue Exception => e
+      LoaderSharedHelpers.record_and_print_exception(e)
       LoaderSharedHelpers.about_to_abort(options, e)
-      puts "!> Error"
-      puts "!> html: true" if e.respond_to?(:html?) && e.html?
-      puts "!> "
-      puts format_exception(e)
-      exit exit_code_for_exception(e)
+      exit LoaderSharedHelpers.exit_code_for_exception(e)
     end
 
 
     ################## Main code ##################
 
 
-    handshake_and_read_startup_request
     init_passenger
-    load_app
-    LoaderSharedHelpers.before_handling_requests(false, options)
-    handler = RequestHandler.new(STDIN, options.merge("app" => app))
-    LoaderSharedHelpers.advertise_readiness
-    LoaderSharedHelpers.advertise_sockets(STDOUT, handler)
-    puts "!> "
+    @@options = LoaderSharedHelpers.init(self)
+    LoaderSharedHelpers.record_journey_step_end('SUBPROCESS_WRAPPER_PREPARATION',
+      'STEP_PERFORMED')
+
+    LoaderSharedHelpers.run_block_and_record_step_progress('SUBPROCESS_APP_LOAD_OR_EXEC') do
+      load_app
+    end
+
+    handler = nil
+    LoaderSharedHelpers.run_block_and_record_step_progress('SUBPROCESS_LISTEN') do
+      begin
+        LoaderSharedHelpers.before_handling_requests(false, options)
+        handler = RequestHandler.new(STDIN, options.merge('app' => app))
+        LoaderSharedHelpers.advertise_sockets(options, handler)
+      rescue Exception => e
+        LoaderSharedHelpers.record_and_print_exception(e)
+        LoaderSharedHelpers.about_to_abort(options, e)
+        exit LoaderSharedHelpers.exit_code_for_exception(e)
+      end
+    end
+
+    LoaderSharedHelpers.advertise_readiness(options)
+
     handler.main_loop
     handler.cleanup
     LoaderSharedHelpers.after_handling_requests

data/src/helper-scripts/rack-preloader.rb

@@ -36,63 +36,54 @@ module PhusionPassenger
       @@app
     end
 
-    def self.format_exception(e)
-      result = "#{e} (#{e.class})"
-      if !(e.backtrace.nil? || e.backtrace.empty?)
-        if e.respond_to?(:html?) && e.html?
-          require 'erb' if !defined?(ERB)
-          result << "\n<pre>  " << ERB::Util.h(e.backtrace.join("\n  ")) << "</pre>"
-        else
-          result << "\n  " << e.backtrace.join("\n  ")
-        end
+    def self.init_passenger
+      STDOUT.sync = true
+      STDERR.sync = true
+
+      work_dir = ENV['PASSENGER_SPAWN_WORK_DIR'].to_s
+      if work_dir.empty?
+        abort "This program may only be invoked from Passenger (error: $PASSENGER_SPAWN_WORK_DIR not set)."
       end
-      result
+
+      record_journey_step_end('SUBPROCESS_EXEC_WRAPPER', 'STEP_PERFORMED')
+      record_journey_step_begin('SUBPROCESS_WRAPPER_PREPARATION', 'STEP_IN_PROGRESS')
+
+      ruby_libdir = File.read("#{work_dir}/args/ruby_libdir").strip
+      passenger_root = File.read("#{work_dir}/args/passenger_root").strip
+      require "#{ruby_libdir}/phusion_passenger"
+      PhusionPassenger.locate_directories(passenger_root)
+
+      PhusionPassenger.require_passenger_lib 'loader_shared_helpers'
+      PhusionPassenger.require_passenger_lib 'preloader_shared_helpers'
+      PhusionPassenger.require_passenger_lib 'utils/json'
+      require 'socket'
     end
 
-    def self.exit_code_for_exception(e)
-      if e.is_a?(SystemExit)
-        e.status
-      else
-        1
+    def self.try_write_file(path, contents)
+      begin
+        File.open(path, 'wb') do |f|
+          f.write(contents)
+        end
+      rescue SystemCallError => e
+        STDERR.puts "Warning: unable to write to #{path}: #{e}"
       end
     end
 
-    def self.handshake_and_read_startup_request
-      STDOUT.sync = true
-      STDERR.sync = true
-      puts "!> I have control 1.0"
-      abort "Invalid initialization header" if STDIN.readline != "You have control 1.0\n"
-
-      @@options = {}
-      while (line = STDIN.readline) != "\n"
-        name, value = line.strip.split(/: */, 2)
-        @@options[name] = value
-      end
+    def self.record_journey_step_begin(step, state, work_dir = nil)
+      dir = work_dir || ENV['PASSENGER_SPAWN_WORK_DIR']
+      step_dir = "#{dir}/response/steps/#{step.downcase}"
+      try_write_file("#{step_dir}/state", state)
+      try_write_file("#{step_dir}/begin_time", Time.now.to_f)
     end
 
-    def self.init_passenger
-      require "#{options["ruby_libdir"]}/phusion_passenger"
-      PhusionPassenger.locate_directories(options["passenger_root"])
-      PhusionPassenger.require_passenger_lib 'native_support'
-      PhusionPassenger.require_passenger_lib 'ruby_core_enhancements'
-      PhusionPassenger.require_passenger_lib 'ruby_core_io_enhancements'
-      PhusionPassenger.require_passenger_lib 'preloader_shared_helpers'
-      PhusionPassenger.require_passenger_lib 'loader_shared_helpers'
-      PhusionPassenger.require_passenger_lib 'request_handler'
-      PhusionPassenger.require_passenger_lib 'rack/thread_handler_extension'
-      @@options = LoaderSharedHelpers.init(@@options)
-      @@options = PreloaderSharedHelpers.init(@@options)
-      if defined?(NativeSupport)
-        NativeSupport.disable_stdio_buffering
+    def self.record_journey_step_end(step, state, work_dir = nil)
+      dir = work_dir || ENV['PASSENGER_SPAWN_WORK_DIR']
+      step_dir = "#{dir}/response/steps/#{step.downcase}"
+      try_write_file("#{step_dir}/state", state)
+      if !File.exist?("#{step_dir}/begin_time") && !File.exist?("#{step_dir}/begin_time_monotonic")
+        try_write_file("#{step_dir}/begin_time", Time.now.to_f)
       end
-      RequestHandler::ThreadHandler.send(:include, Rack::ThreadHandlerExtension)
-    rescue Exception => e
-      LoaderSharedHelpers.about_to_abort(options, e) if defined?(LoaderSharedHelpers)
-      puts "!> Error"
-      puts "!> html: true" if e.respond_to?(:html?) && e.html?
-      puts "!> "
-      puts format_exception(e)
-      exit exit_code_for_exception(e)
+      try_write_file("#{step_dir}/end_time", Time.now.to_f)
     end
 
     def self.preload_app
@@ -112,38 +103,76 @@ module PhusionPassenger
 
       LoaderSharedHelpers.after_loading_app_code(options)
     rescue Exception => e
+      LoaderSharedHelpers.record_and_print_exception(e)
       LoaderSharedHelpers.about_to_abort(options, e)
-      puts "!> Error"
-      puts "!> html: true" if e.respond_to?(:html?) && e.html?
-      puts "!> "
-      puts format_exception(e)
-      exit exit_code_for_exception(e)
+      exit LoaderSharedHelpers.exit_code_for_exception(e)
     end
 
-    def self.negotiate_spawn_command
-      puts "!> I have control 1.0"
-      abort "Invalid initialization header" if STDIN.readline != "You have control 1.0\n"
+    def self.create_server(options)
+      if defined?(NativeSupport)
+        unix_path_max = NativeSupport::UNIX_PATH_MAX
+      else
+        unix_path_max = options.fetch('UNIX_PATH_MAX', 100).to_i
+      end
+      if options['socket_dir']
+        socket_dir = options['socket_dir']
+        socket_prefix = "preloader"
+      else
+        socket_dir = Dir.tmpdir
+        socket_prefix = "PsgPreloader"
+      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)
 
+      [server, socket_filename]
+    end
+
+    def self.reinitialize_std_channels(work_dir)
+      if File.exist?("#{work_dir}/stdin")
+        STDIN.reopen("#{work_dir}/stdin", 'r')
+      end
+      if File.exist?("#{work_dir}/stdout_and_err")
+        STDOUT.reopen("#{work_dir}/stdout_and_err", 'w')
+        STDERR.reopen(STDOUT)
+      end
+      STDOUT.sync = STDERR.sync = true
+    end
+
+    def self.negotiate_spawn_command
       begin
-        while (line = STDIN.readline) != "\n"
-          name, value = line.strip.split(/: */, 2)
-          options[name] = value
+        work_dir = ENV['PASSENGER_SPAWN_WORK_DIR']
+        @@options = File.open("#{work_dir}/args.json", 'rb') do |f|
+          Utils::JSON.parse(f.read)
+        end
+
+        reinitialize_std_channels(work_dir)
+
+        LoaderSharedHelpers.run_block_and_record_step_progress('SUBPROCESS_PREPARE_AFTER_FORKING_FROM_PRELOADER') do
+          LoaderSharedHelpers.before_handling_requests(true, options)
+        end
+
+        handler = nil
+        LoaderSharedHelpers.run_block_and_record_step_progress('SUBPROCESS_LISTEN') do
+          handler = RequestHandler.new(STDIN, options.merge("app" => app))
         end
-        @@options = LoaderSharedHelpers.sanitize_spawn_options(@@options)
 
-        LoaderSharedHelpers.before_handling_requests(true, options)
-        handler = RequestHandler.new(STDIN, options.merge("app" => app))
+        LoaderSharedHelpers.dump_all_information(options)
+        LoaderSharedHelpers.advertise_sockets(options, handler)
+        LoaderSharedHelpers.advertise_readiness(options)
       rescue Exception => e
+        LoaderSharedHelpers.record_and_print_exception(e)
         LoaderSharedHelpers.about_to_abort(options, e)
-        puts "!> Error"
-        puts "!> "
-        puts format_exception(e)
-        exit exit_code_for_exception(e)
+        exit LoaderSharedHelpers.exit_code_for_exception(e)
       end
 
-      LoaderSharedHelpers.advertise_readiness
-      LoaderSharedHelpers.advertise_sockets(STDOUT, handler)
-      puts "!> "
       handler
     end
 
@@ -151,10 +180,34 @@ module PhusionPassenger
     ################## Main code ##################
 
 
-    handshake_and_read_startup_request
     init_passenger
-    preload_app
-    if PreloaderSharedHelpers.run_main_loop(options) == :forked
+    @@options = PreloaderSharedHelpers.init(self)
+    LoaderSharedHelpers.record_journey_step_end('SUBPROCESS_WRAPPER_PREPARATION',
+      'STEP_PERFORMED')
+
+    LoaderSharedHelpers.run_block_and_record_step_progress('SUBPROCESS_APP_LOAD_OR_EXEC') do
+      preload_app
+    end
+
+    server = nil
+    LoaderSharedHelpers.run_block_and_record_step_progress('SUBPROCESS_LISTEN') do
+      begin
+        server = create_server(options)
+        PreloaderSharedHelpers.advertise_sockets(options, server)
+        LoaderSharedHelpers.dump_all_information(options)
+      rescue Exception => e
+        LoaderSharedHelpers.record_and_print_exception(e)
+        LoaderSharedHelpers.about_to_abort(options, e)
+        exit LoaderSharedHelpers.exit_code_for_exception(e)
+      end
+    end
+
+    LoaderSharedHelpers.advertise_readiness(options)
+
+    subprocess_work_dir = PreloaderSharedHelpers.run_main_loop(server, options)
+    if subprocess_work_dir
+      # Inside forked subprocess
+      ENV['PASSENGER_SPAWN_WORK_DIR'] = subprocess_work_dir
       handler = negotiate_spawn_command
       handler.main_loop
       handler.cleanup