all tests run at trace log level with a null log output; new tests for watchdog,...

[scpubgit/Object-Remote.git] / lib / Object / Remote / Role / Connector / PerlInterpreter.pm

package Object::Remote::Role::Connector::PerlInterpreter;

use IPC::Open2;
use IPC::Open3; 
use IO::Handle;
use Symbol; 
use Object::Remote::Logging qw( :log :dlog );
use Object::Remote::ModuleSender;
use Object::Remote::Handle;
use Object::Remote::Future;
use Scalar::Util qw(blessed weaken);
use Moo::Role;

with 'Object::Remote::Role::Connector';

has module_sender => (is => 'lazy');
has ulimit => ( is => 'ro' );
has nice => ( is => 'ro' );
has watchdog_timeout => ( is => 'ro', required => 1, default => sub { undef } );
has perl_command => (is => 'lazy');

#if no child_stderr file handle is specified then stderr
#of the child will be connected to stderr of the parent
has stderr => ( is => 'rw', default => sub { undef } );

sub _build_module_sender {
  my ($hook) =
    grep {blessed($_) && $_->isa('Object::Remote::ModuleLoader::Hook') }
      @INC;
  return $hook ? $hook->sender : Object::Remote::ModuleSender->new;
}

#SSH requires the entire remote command to be
#given as one single argument to the ssh 
#command line program so this jumps through
#some hoops

#TODO this is SSH's problem not perl's so move
#this to the SSH connector
sub _build_perl_command {
    my ($self) = @_; 
    my $nice = $self->nice;
    my $ulimit = $self->ulimit; 
    my $shell_code = 'sh -c "';
    
    if (defined($ulimit)) {
        $shell_code .= "ulimit -v $ulimit; ";
    }
    
    if (defined($nice)) {
        $shell_code .= "nice -n $nice ";
    }
    
    $shell_code .= 'perl -"';
    
    return [ $shell_code ];        
}

around connect => sub {
  my ($orig, $self) = (shift, shift);
  my $f = $self->$start::start($orig => @_);
  return future {
    $f->on_done(sub {
      my ($conn) = $f->get;
      $self->_setup_watchdog_reset($conn); 
      my $sub = $conn->remote_sub('Object::Remote::Logging::init_logging_forwarding');
      $sub->('Object::Remote::Logging', Object::Remote::Logging->arg_router);
      Object::Remote::Handle->new(
        connection => $conn,
        class => 'Object::Remote::ModuleLoader',
        args => { module_sender => $self->module_sender }
      )->disarm_free;
      require Object::Remote::Prompt;
      Object::Remote::Prompt::maybe_set_prompt_command_on($conn);
    });
    $f;
  } 2;
};

sub final_perl_command { shift->perl_command }

sub _start_perl {
  my $self = shift;
  my $given_stderr = $self->stderr;
  my $foreign_stderr;
 
  Dlog_debug { "invoking connection to perl interpreter using command line: $_" } @{$self->final_perl_command};
    
  if (defined($given_stderr)) {
      #if the stderr data goes to an existing file handle
      #an anonymous file handle is required
      #as the other half of a pipe style file handle pair
      #so the file handles can go into the run loop
      $foreign_stderr = gensym();
  } else {
      #if no file handle has been specified
      #for the child's stderr then connect
      #the child stderr to the parent stderr
      $foreign_stderr = ">&STDERR";
  }
  
  my $pid = open3(
    my $foreign_stdin,
    my $foreign_stdout,
    $foreign_stderr,
    @{$self->final_perl_command},
  ) or die "Failed to run perl at '$_[0]': $!";
  
  if (defined($given_stderr)) {   
      Dlog_debug { "Child process STDERR is being handled via run loop" };
        
      Object::Remote->current_loop
                    ->watch_io(
                        handle => $foreign_stderr,
                        on_read_ready => sub {
                          my $buf = ''; 
                          my $len = sysread($foreign_stderr, $buf, 32768);
                          if (!defined($len) or $len == 0) {
                            log_trace { "Got EOF or error on child stderr, removing from watcher" };
                            $self->stderr(undef);
                            Object::Remote->current_loop
                                          ->unwatch_io(
                                              handle => $foreign_stderr,
                                              on_read_ready => 1
                                            );
                          } else {
                              Dlog_trace { "got $len characters of stderr data for connection" };
                              print $given_stderr $buf or die "could not send stderr data: $!";
                          }
                         } 
                      );     
  }
      
  return ($foreign_stdin, $foreign_stdout, $pid);
}

sub _open2_for {
  my $self = shift;
  my ($foreign_stdin, $foreign_stdout, $pid) = $self->_start_perl(@_);
  my $to_send = $self->fatnode_text;
  log_debug { my $len = length($to_send); "Sending contents of fat node to remote node; size is '$len' characters"  };
  Object::Remote->current_loop
                ->watch_io(
                    handle => $foreign_stdin,
                    on_write_ready => sub {
                      my $len = syswrite($foreign_stdin, $to_send, 32768);
                      if (defined $len) {
                        substr($to_send, 0, $len) = '';
                      }
                      # if the stdin went away, we'll never get Shere
                      # so it's not a big deal to simply give up on !defined
                      if (!defined($len) or 0 == length($to_send)) {
                        log_trace { "Got EOF or error when writing fatnode data to filehandle, unwatching it" };
                        Object::Remote->current_loop
                                      ->unwatch_io(
                                          handle => $foreign_stdin,
                                          on_write_ready => 1
                                        );
                      } else {
                          log_trace { "Sent $len bytes of fatnode data to remote side" };
                      }
                    }
                  );
  return ($foreign_stdin, $foreign_stdout, $pid);
}

sub _setup_watchdog_reset {
    my ($self, $conn) = @_;
    my $timer_id; 
    
    return unless $self->watchdog_timeout; 
        
    Dlog_trace { "Creating Watchdog management timer for connection id $_" } $conn->_id;
    
    weaken($conn);
        
    $timer_id = Object::Remote->current_loop->watch_time(
        every => $self->watchdog_timeout / 3,
        code => sub {
            unless(defined($conn)) {
                log_trace { "Weak reference to connection in Watchdog was lost, terminating update timer $timer_id" };
                Object::Remote->current_loop->unwatch_time($timer_id);
                return;  
            }
            
            Dlog_trace { "Reseting Watchdog for connection id $_" } $conn->_id;
            #we do not want to block in the run loop so send the
            #update off and ignore any result, we don't need it
            #anyway
            $conn->send_class_call(0, 'Object::Remote::WatchDog', 'reset');
        }
    );     
}

sub fatnode_text {
  my ($self) = @_;
  my $text = '';

  require Object::Remote::FatNode;
  
  if (defined($self->watchdog_timeout)) {
    $text = "my \$WATCHDOG_TIMEOUT = '" . $self->watchdog_timeout . "';\n";   
    $text .= "alarm(\$WATCHDOG_TIMEOUT);\n";    
  } else {
      $text = "my \$WATCHDOG_TIMEOUT = undef;\n";
  }
  
  $text .= 'BEGIN { $ENV{OBJECT_REMOTE_DEBUG} = 1 }'."\n"
    if $ENV{OBJECT_REMOTE_DEBUG};
  $text .= <<'END';
$INC{'Object/Remote/FatNode.pm'} = __FILE__;
$Object::Remote::FatNode::DATA = <<'ENDFAT';
END
  $text .= do { no warnings 'once'; $Object::Remote::FatNode::DATA };
  $text .= "ENDFAT\n";
  $text .= <<'END';
eval $Object::Remote::FatNode::DATA;
die $@ if $@;
END
  
  $text .= "__END__\n";
  return $text;
}

1;