add non-blocking file handle support for reading in miniloop and change miniloop...
[scpubgit/Object-Remote.git] / lib / Object / Remote / Connection.pm
index c5bc9f6..d338a21 100644 (file)
@@ -4,7 +4,11 @@ use Object::Remote::Future;
 use Object::Remote::Null;
 use Object::Remote::Handle;
 use Object::Remote::CodeContainer;
+use Object::Remote::GlobProxy;
+use Object::Remote::GlobContainer;
+use Object::Remote::Logging qw (:log :dlog);
 use Object::Remote;
+use Symbol;
 use IO::Handle;
 use Module::Runtime qw(use_module);
 use Scalar::Util qw(weaken blessed refaddr);
@@ -12,35 +16,46 @@ use JSON::PP qw(encode_json);
 use Moo;
 
 our $DEBUG = !!$ENV{OBJECT_REMOTE_DEBUG};
+#numbering each connection allows it to be
+#tracked along with file handles in
+#the logs
+BEGIN { our $NEXT_CONNECTION_ID = 0 }
+has _id => ( is => 'ro', required => 1, default => sub { our $NEXT_CONNECTION_ID++ } );
 
 has send_to_fh => (
   is => 'ro', required => 1,
-  trigger => sub { $_[1]->autoflush(1) },
+  trigger => sub {
+      my $self = $_[0];
+      $_[1]->autoflush(1);
+      Dlog_trace { my $id = $self->_id; "connection had send_to_fh set to $_"  } $_[1];
+  },
 );
 
-has receive_from_fh => (
+has read_channel => (
   is => 'ro', required => 1,
   trigger => sub {
-    my ($self, $fh) = @_;
+    my ($self, $ch) = @_;
+    Dlog_trace { my $id = $self->_id; "trigger for read_channel has been invoked for connection $id; file handle is " } $ch->fh; 
     weaken($self);
-    Object::Remote->current_loop
-                  ->watch_io(
-                      handle => $fh,
-                      on_read_ready => sub { $self->_receive_data_from($fh) }
-                    );
+    $ch->on_line_call(sub { $self->_receive(@_) });
+    $ch->on_close_call(sub { $self->on_close->done(@_) });
   },
 );
 
-has on_close => (is => 'rw', default => sub { CPS::Future->new });
+has on_close => (
+  is => 'ro', default => sub { CPS::Future->new },
+  trigger => sub {
+    my ($self, $f) = @_;
+    Dlog_trace { "trigger for on_close has been invoked for connection $_" } $self->_id;
+    weaken($self);
+    $f->on_done(sub {
+      $self->_fail_outstanding("Connection lost: ".($f->get)[0]);
+    });
+  }
+);
 
 has child_pid => (is => 'ro');
 
-has ready_future => (is => 'lazy');
-
-sub _build_ready_future { CPS::Future->new }
-
-has _receive_data_buffer => (is => 'ro', default => sub { my $x = ''; \$x });
-
 has local_objects_by_id => (
   is => 'ro', default => sub { {} },
   coerce => sub { +{ %{$_[0]} } }, # shallow clone on the way in
@@ -53,6 +68,15 @@ has remote_objects_by_id => (
 
 has outstanding_futures => (is => 'ro', default => sub { {} });
 
+sub _fail_outstanding {
+  my ($self, $error) = @_;
+  Dlog_debug { "Failing outstanding futures with '$error' for connection $_" } $self->_id;
+  my $outstanding = $self->outstanding_futures;
+  $_->fail($error) for values %$outstanding;
+  %$outstanding = ();
+  return;
+}
+
 has _json => (
   is => 'lazy',
   handles => {
@@ -63,6 +87,7 @@ has _json => (
 
 sub _id_to_remote_object {
   my ($self, $id) = @_;
+  Dlog_trace { "fetching proxy for remote object with id '$id' for connection $_" } $self->_id;
   return bless({}, 'Object::Remote::Null') if $id eq 'NULL';
   (
     $self->remote_objects_by_id->{$id}
@@ -81,6 +106,22 @@ sub _build__json {
       my $code_container = $self->_id_to_remote_object(@_);
       sub { $code_container->call(@_) };
     }
+  )->filter_json_single_key_object(
+    __scalar_ref__ => sub {
+      my $value = shift;
+      return \$value;
+    }
+  )->filter_json_single_key_object(
+    __glob_ref__ => sub {
+      my $glob_container = $self->_id_to_remote_object(@_);
+      my $handle = Symbol::gensym;
+      tie *$handle, 'Object::Remote::GlobProxy', $glob_container;
+      return $handle;
+    }
+  )->filter_json_single_key_object(
+    __local_object__ => sub {
+      $self->local_objects_by_id->{$_[0]}
+    }
   );
 }
 
@@ -95,8 +136,12 @@ BEGIN {
 sub new_from_spec {
   my ($class, $spec) = @_;
   return $spec if blessed $spec;
+  Dlog_debug { "creating a new connection from spec" };
   foreach my $poss (do { our @Guess }) {
-    if (my $obj = $poss->($spec)) { return $obj }
+    if (my $conn = $poss->($spec)) {
+      #Dlog_debug { my $id = $conn->_id; "created connection $id for spec $_" } $spec;
+      return $conn->maybe::start::connect;
+    }
   }
   die "Couldn't figure out what to do with ${spec}";
 }
@@ -110,30 +155,53 @@ sub remote_object {
 
 sub connect {
   my ($self, $to) = @_;
-  return await_future($self->send(
-    class_call => 'Object::Remote', 0, connect => $to
-  ));
+  Dlog_debug { "Creating connection to remote node '$to' for connection $_" } $self->_id;
+  return await_future(
+    $self->send_class_call(0, 'Object::Remote', connect => $to)
+  );
 }
 
 sub remote_sub {
   my ($self, $sub) = @_;
   my ($pkg, $name) = $sub =~ m/^(.*)::([^:]+)$/;
-  return await_future($self->send(class_call => $pkg, 0, can => $name));
+  Dlog_debug { "Invoking remote sub '$sub' for connection $_" } $self->_id;
+  return await_future($self->send_class_call(0, $pkg, can => $name));
+}
+
+sub send_class_call {
+  my ($self, $ctx, @call) = @_;
+  Dlog_trace { "Sending a class call for connection $_" } $self->_id;
+  $self->send(call => class_call_handler => $ctx => call => @call);
+}
+
+sub register_class_call_handler {
+  my ($self) = @_;
+  $self->local_objects_by_id->{'class_call_handler'} ||= do {
+    my $o = $self->new_class_call_handler;
+    $self->_local_object_to_id($o);
+    $o;
+  };
+}
+
+sub new_class_call_handler {
+  Object::Remote::CodeContainer->new(
+    code => sub {
+      my ($class, $method) = (shift, shift);
+      use_module($class)->$method(@_);
+    }
+  );
 }
 
 sub register_remote {
   my ($self, $remote) = @_;
+  Dlog_trace { my $i = $remote->id; "Registered a remote object with id of '$i' for connection $_" } $self->_id;
   weaken($self->remote_objects_by_id->{$remote->id} = $remote);
   return $remote;
 }
 
-sub await_ready {
-  my ($self) = @_;
-  await_future($self->ready_future);
-}
-
 sub send_free {
   my ($self, $id) = @_;
+  Dlog_debug { "sending request to free object '$id' for connection $_" } $self->_id;
   delete $self->remote_objects_by_id->{$id};
   $self->_send([ free => $id ]);
 }
@@ -141,11 +209,17 @@ sub send_free {
 sub send {
   my ($self, $type, @call) = @_;
 
-  unshift @call, $type => my $future = CPS::Future->new;
+  my $future = CPS::Future->new;
+  my $remote = $self->remote_objects_by_id->{$call[0]};
+
+  unshift @call, $type => $self->_local_object_to_id($future);
 
   my $outstanding = $self->outstanding_futures;
   $outstanding->{$future} = $future;
-  $future->on_ready(sub { delete $outstanding->{$future} });
+  $future->on_ready(sub {
+    undef($remote);
+    delete $outstanding->{$future}
+  });
 
   $self->_send(\@call);
 
@@ -155,22 +229,29 @@ sub send {
 sub send_discard {
   my ($self, $type, @call) = @_;
 
-  unshift @call, $type => { __remote_object__ => 'NULL' };
+  unshift @call, $type => 'NULL';
 
   $self->_send(\@call);
 }
 
 sub _send {
   my ($self, $to_send) = @_;
-
-  $self->await_ready;
-
-  print { $self->send_to_fh } $self->_serialize($to_send)."\n";
+  my $fh = $self->send_to_fh;
+  Dlog_trace { "Starting to serialize data in argument to _send for connection $_" } $self->_id;
+  my $serialized = $self->_serialize($to_send)."\n";
+  Dlog_trace { my $l = length($serialized); "serialization is completed; sending '$l' characters of serialized data to $_" } $fh;
+  #TODO this is very risky for deadlocks unless it's set to non-blocking and then with out extra
+  #logic it could easily do short-writes to the remote side
+  my $ret = print $fh $serialized;
+  Dlog_trace { my $r = defined $ret ? $ret : 'undef'; "print() returned $r with $_" } $fh;
+  #TODO hrm reason print's return value was ignored?
+  die "could not write to filehandle: $!" unless $ret;
+  return $ret; 
 }
 
 sub _serialize {
   my ($self, $data) = @_;
-  local our @New_Ids;
+  local our @New_Ids = (-1);
   return eval {
     my $flat = $self->_encode($self->_deobjectify($data));
     warn "$$ >>> ${flat}\n" if $DEBUG;
@@ -187,7 +268,7 @@ sub _local_object_to_id {
   my ($self, $object) = @_;
   my $id = refaddr($object);
   $self->local_objects_by_id->{$id} ||= do {
-    push our(@New_Ids), $id;
+    push our(@New_Ids), $id if @New_Ids;
     $object;
   };
   return $id;
@@ -196,7 +277,14 @@ sub _local_object_to_id {
 sub _deobjectify {
   my ($self, $data) = @_;
   if (blessed($data)) {
-    return +{ __remote_object__ => $self->_local_object_to_id($data) };
+    if (
+      $data->isa('Object::Remote::Proxy')
+      and $data->{remote}->connection == $self
+    ) {
+      return +{ __local_object__ => $data->{remote}->id };
+    } else {
+      return +{ __remote_object__ => $self->_local_object_to_id($data) };
+    }
   } elsif (my $ref = ref($data)) {
     if ($ref eq 'HASH') {
       return +{ map +($_ => $self->_deobjectify($data->{$_})), keys %$data };
@@ -207,6 +295,12 @@ sub _deobjectify {
                  Object::Remote::CodeContainer->new(code => $data)
                );
       return +{ __remote_code__ => $id };
+    } elsif ($ref eq 'SCALAR') {
+      return +{ __scalar_ref__ => $$data };
+    } elsif ($ref eq 'GLOB') {
+      return +{ __glob_ref__ => $self->_local_object_to_id(
+        Object::Remote::GlobContainer->new(handle => $data)
+      ) };
     } else {
       die "Can't collapse reftype $ref";
     }
@@ -214,41 +308,13 @@ sub _deobjectify {
   return $data; # plain scalar
 }
 
-sub _receive_data_from {
-  my ($self, $fh) = @_;
-  my $rb = $self->_receive_data_buffer;
-  my $ready = $self->ready_future->is_ready;
-  my $len = sysread($fh, $$rb, 1024, length($$rb));
-  my $err = defined($len) ? undef : ": $!";
-  if (defined($len) and $len > 0) {
-    while ($$rb =~ s/^(.*)\n//) {
-      if ($ready) {
-        $self->_receive($1);
-      } else {
-        my $line = $1;
-        die "New remote container did not send Shere - got ${line}"
-          unless $line eq "Shere";
-        $self->ready_future->done;
-      }
-    }
-  } else {
-    Object::Remote->current_loop
-                  ->unwatch_io(
-                      handle => $self->receive_from_fh,
-                      on_read_ready => 1
-                    );
-    my $outstanding = $self->outstanding_futures;
-    $_->fail("Connection lost${err}") for values %$outstanding;
-    %$outstanding = ();
-    $self->on_close->done();
-  }
-}
-
 sub _receive {
   my ($self, $flat) = @_;
   warn "$$ <<< $flat\n" if $DEBUG;
+  Dlog_trace { my $l = length($flat); "Starting to deserialize $l characters of data for connection $_" } $self->_id;
   my ($type, @rest) = eval { @{$self->_deserialize($flat)} }
     or do { warn "Deserialize failed for ${flat}: $@"; return };
+  Dlog_trace { "deserialization complete for connection $_" } $self->_id;
   eval { $self->${\"receive_${type}"}(@rest); 1 }
     or do { warn "Receive failed for ${flat}: $@"; return };
   return;
@@ -256,13 +322,16 @@ sub _receive {
 
 sub receive_free {
   my ($self, $id) = @_;
+  Dlog_trace { "got a receive_free for object '$id' for connection $_" } $self->_id;
   delete $self->local_objects_by_id->{$id}
     or warn "Free: no such object $id";
   return;
 }
 
 sub receive_call {
-  my ($self, $future, $id, @rest) = @_;
+  my ($self, $future_id, $id, @rest) = @_;
+  Dlog_trace { "got a receive_call for object '$id' for connection $_" } $self->_id;
+  my $future = $self->_id_to_remote_object($future_id);
   $future->{method} = 'call_discard_free';
   my $local = $self->local_objects_by_id->{$id}
     or do { $future->fail("No such object $id"); return };
@@ -271,20 +340,14 @@ sub receive_call {
 
 sub receive_call_free {
   my ($self, $future, $id, @rest) = @_;
+  Dlog_trace { "got a receive_call_free for object '$id' for connection $_" } $self->_id;
   $self->receive_call($future, $id, undef, @rest);
   $self->receive_free($id);
 }
 
-sub receive_class_call {
-  my ($self, $future, $class, @rest) = @_;
-  $future->{method} = 'call_discard_free';
-  eval { use_module($class) }
-    or do { $future->fail("Error loading ${class}: $@"); return };
-  $self->_invoke($future, $class, @rest);
-}
-
 sub _invoke {
   my ($self, $future, $local, $ctx, $method, @args) = @_;
+  Dlog_trace { "got _invoke for a method named '$method' for connection $_" } $self->_id;
   if ($method =~ /^start::/) {
     my $f = $local->$method(@args);
     $f->on_done(sub { undef($f); $future->done(@_) });
@@ -304,14 +367,14 @@ sub _invoke {
   return;
 }
 
-sub DEMOLISH {
-  my ($self, $gd) = @_;
-  return if $gd;
-  Object::Remote->current_loop
-                ->unwatch_io(
-                    handle => $self->receive_from_fh,
-                    on_read_ready => 1
-                  );
-}
-
 1;
+
+=head1 NAME
+
+Object::Remote::Connection - An underlying connection for L<Object::Remote>
+
+=head1 LAME
+
+Shipping prioritised over writing this part up. Blame mst.
+
+=cut