]> Sergey Matveev's repositories - public-inbox.git/blobdiff - lib/PublicInbox/Qspawn.pm
qspawn: capture errors from parse_hdr callback
[public-inbox.git] / lib / PublicInbox / Qspawn.pm
index 33e20147bbb9bad6acc18c621bc42a0e91c69d54..aebcb1f7db091ea8d3283407a2c0cbd559d407f8 100644 (file)
@@ -1,4 +1,4 @@
-# Copyright (C) 2016-2019 all contributors <meta@public-inbox.org>
+# Copyright (C) 2016-2020 all contributors <meta@public-inbox.org>
 # License: AGPL-3.0+ <https://www.gnu.org/licenses/agpl-3.0.txt>
 
 # Like most Perl modules in public-inbox, this is internal and
@@ -27,7 +27,6 @@ package PublicInbox::Qspawn;
 use strict;
 use warnings;
 use PublicInbox::Spawn qw(popen_rd);
-require Plack::Util;
 
 # n.b.: we get EAGAIN with public-inbox-httpd, and EINTR on other PSGI servers
 use Errno qw(EAGAIN EINTR);
@@ -46,27 +45,25 @@ sub new ($$$;) {
 sub _do_spawn {
        my ($self, $start_cb, $limiter) = @_;
        my $err;
-       my ($cmd, $cmd_env, $opts) = @{$self->{args}};
-       my %opts = %{$opts || {}};
+       my ($cmd, $cmd_env, $opt) = @{delete $self->{args}};
+       my %o = %{$opt || {}};
        $self->{limiter} = $limiter;
        foreach my $k (PublicInbox::Spawn::RLIMITS()) {
                if (defined(my $rlimit = $limiter->{$k})) {
-                       $opts{$k} = $rlimit;
+                       $o{$k} = $rlimit;
                }
        }
+       $self->{cmd} = $o{quiet} ? undef : $cmd;
+       eval {
+               # popen_rd may die on EMFILE, ENFILE
+               ($self->{rpipe}, $self->{pid}) = popen_rd($cmd, $cmd_env, \%o);
 
-       ($self->{rpipe}, $self->{pid}) = popen_rd($cmd, $cmd_env, \%opts);
+               die "E: $!" unless defined($self->{pid});
 
-       # drop any IO handles opt was holding open via $opt->{hold}
-       # No need to hold onto the descriptor once the child process has it.
-       $self->{args} = $cmd; # keep this around for logging
-
-       if (defined $self->{pid}) {
                $limiter->{running}++;
-       } else {
-               $self->{err} = $!;
-       }
-       $start_cb->($self);
+               $start_cb->($self); # EPOLL_CTL_ADD may ENOSPC/ENOMEM
+       };
+       finish($self, $@) if $@;
 }
 
 sub child_err ($) {
@@ -83,16 +80,8 @@ sub log_err ($$) {
        $env->{'psgi.errors'}->print($msg, "\n");
 }
 
-# callback for dwaitpid
-sub waitpid_err ($$) {
-       my ($self, $pid) = @_;
-       my $xpid = delete $self->{pid};
-       my $err;
-       if ($pid > 0) { # success!
-               $err = child_err($?);
-       } elsif ($pid < 0) { # ??? does this happen in our case?
-               $err = "W: waitpid($xpid, 0) => $pid: $!";
-       } # else should not be called with pid == 0
+sub finalize ($$) {
+       my ($self, $err) = @_;
 
        my ($env, $qx_cb, $qx_arg, $qx_buf) =
                delete @$self{qw(psgi_env qx_cb qx_arg qx_buf)};
@@ -108,12 +97,37 @@ sub waitpid_err ($$) {
        }
 
        if ($err) {
-               $self->{err} = $err;
-               if ($env && !$env->{'qspawn.quiet'}) {
-                       log_err($env, join(' ', @{$self->{args}}) . ": $err");
+               if (defined $self->{err}) {
+                       $self->{err} .= "; $err";
+               } else {
+                       $self->{err} = $err;
+               }
+               if ($env && $self->{cmd}) {
+                       log_err($env, join(' ', @{$self->{cmd}}) . ": $err");
                }
        }
-       eval { $qx_cb->($qx_buf, $qx_arg) } if $qx_cb;
+       if ($qx_cb) {
+               eval { $qx_cb->($qx_buf, $qx_arg) };
+       } elsif (my $wcb = delete $env->{'qspawn.wcb'}) {
+               # have we started writing, yet?
+               require PublicInbox::WwwStatic;
+               $wcb->(PublicInbox::WwwStatic::r(500));
+       }
+}
+
+# callback for dwaitpid
+sub waitpid_err ($$) {
+       my ($self, $pid) = @_;
+       my $xpid = delete $self->{pid};
+       my $err;
+       if (defined $pid) {
+               if ($pid > 0) { # success!
+                       $err = child_err($?);
+               } elsif ($pid < 0) { # ??? does this happen in our case?
+                       $err = "W: waitpid($xpid, 0) => $pid: $!";
+               } # else should not be called with pid == 0
+       }
+       finalize($self, $err);
 }
 
 sub do_waitpid ($) {
@@ -129,14 +143,12 @@ sub do_waitpid ($) {
        }
 }
 
-sub finish ($) {
-       my ($self) = @_;
+sub finish ($;$) {
+       my ($self, $err) = @_;
        if (delete $self->{rpipe}) {
                do_waitpid($self);
        } else {
-               my ($env, $qx_cb, $qx_arg, $qx_buf) =
-                       delete @$self{qw(psgi_env qx_cb qx_arg qx_buf)};
-               eval { $qx_cb->($qx_buf, $qx_arg) } if $qx_cb;
+               finalize($self, $err);
        }
 }
 
@@ -149,6 +161,37 @@ sub start ($$$) {
        }
 }
 
+sub psgi_qx_init_cb {
+       my ($self) = @_;
+       my $async = delete $self->{async};
+       my ($r, $buf);
+       my $qx_fh = $self->{qx_fh};
+reread:
+       $r = sysread($self->{rpipe}, $buf, 65536);
+       if ($async) {
+               $async->async_pass($self->{psgi_env}->{'psgix.io'},
+                                       $qx_fh, \$buf);
+       } elsif (defined $r) {
+               $r ? (print $qx_fh $buf) : event_step($self, undef);
+       } else {
+               return if $! == EAGAIN; # try again when notified
+               goto reread if $! == EINTR;
+               event_step($self, $!);
+       }
+}
+
+sub psgi_qx_start {
+       my ($self) = @_;
+       if (my $async = $self->{psgi_env}->{'pi-httpd.async'}) {
+               # PublicInbox::HTTPD::Async->new(rpipe, $cb, cb_arg, $end_obj)
+               $self->{async} = $async->($self->{rpipe},
+                                       \&psgi_qx_init_cb, $self, $self);
+               # init_cb will call ->async_pass or ->close
+       } else { # generic PSGI
+               psgi_qx_init_cb($self) while $self->{qx_fh};
+       }
+}
+
 # Similar to `backtick` or "qx" ("perldoc -f qx"), it calls $qx_cb with
 # the stdout of the given command when done; but respects the given limiter
 # $env is the PSGI env.  As with ``/qx; only use this when output is small
@@ -162,44 +205,8 @@ sub psgi_qx {
        $self->{qx_arg} = $qx_arg;
        $self->{qx_fh} = $qx_fh;
        $self->{qx_buf} = \$qx_buf;
-       my $async = $env->{'pi-httpd.async'};
-       my $cb = sub {
-               my ($r, $buf);
-reread:
-               $r = sysread($self->{rpipe}, $buf, 65536);
-               if ($async) {
-                       $async->async_pass($env->{'psgix.io'}, $qx_fh, \$buf);
-               } elsif (defined $r) {
-                       $r ? $qx_fh->write($buf) : event_step($self, undef);
-               } else {
-                       return if $! == EAGAIN; # try again when notified
-                       goto reread if $! == EINTR;
-                       event_step($self, $!);
-               }
-       };
        $limiter ||= $def_limiter ||= PublicInbox::Qspawn::Limiter->new(32);
-       $self->start($limiter, sub { # start_cb, may run later, much later...
-               if ($async) {
-               # PublicInbox::HTTPD::Async->new(rpipe, $cb, $end_obj)
-                       $async = $async->($self->{rpipe}, $cb, undef, $self);
-                       # $cb will call ->async_pass or ->close
-               } else { # generic PSGI
-                       $cb->() while $self->{qx_fh};
-               }
-       });
-}
-
-# create a filter for "push"-based streaming PSGI writes used by HTTPD::Async
-sub filter_fh ($$) {
-       my ($fh, $filter) = @_;
-       Plack::Util::inline_object(
-               close => sub {
-                       $fh->write($filter->(undef));
-                       $fh->close;
-               },
-               write => sub {
-                       $fh->write($filter->($_[0]));
-               });
+       start($self, $limiter, \&psgi_qx_start);
 }
 
 # this is called on pipe EOF to reap the process, may be called
@@ -221,12 +228,17 @@ sub rd_hdr ($) {
        my $ret;
        my $total_rd = 0;
        my $hdr_buf = $self->{hdr_buf};
+       my ($ph_cb, $ph_arg) = @{$self->{parse_hdr}};
        do {
                my $r = sysread($self->{rpipe}, $$hdr_buf, 4096,
                                length($$hdr_buf));
                if (defined($r)) {
                        $total_rd += $r;
-                       $ret = $self->{parse_hdr}->($total_rd, $hdr_buf);
+                       eval { $ret = $ph_cb->($total_rd, $hdr_buf, $ph_arg) };
+                       if ($@) {
+                               log_err($self->{psgi_env}, "parse_hdr: $@");
+                               $ret = [ 500, [], [ "Internal error\n" ] ];
+                       }
                } else {
                        # caller should notify us when it's ready:
                        return if $! == EAGAIN;
@@ -258,7 +270,7 @@ sub psgi_return_init_cb {
        } elsif ($async) {
                # done reading headers, handoff to read body
                my $fh = $wcb->($r); # scalar @$r == 2
-               $fh = filter_fh($fh, $filter) if $filter;
+               $fh = $filter->attach($fh) if $filter;
                $self->{fh} = $fh;
                $async->async_pass($env->{'psgix.io'}, $fh,
                                        delete($self->{hdr_buf}));
@@ -296,8 +308,9 @@ sub psgi_return_start { # may run later, much later...
 #                          psgi_return will return an anonymous
 #                          sub for the PSGI server to call
 #
-#   $env->{'qspawn.filter'} - filter callback, receives a string as input,
-#                             undef on EOF
+#   $env->{'qspawn.filter'} - filter object, responds to ->attach for
+#                             pi-httpd.async and ->translate for generic
+#                             PSGI servers
 #
 # $limiter - the Limiter object to use (uses the def_limiter if not given)
 #
@@ -309,10 +322,10 @@ sub psgi_return_start { # may run later, much later...
 #              psgix.io.  3-element arrays means the body is available
 #              immediately (or streamed via ->getline (pull-based)).
 sub psgi_return {
-       my ($self, $env, $limiter, $parse_hdr) = @_;
+       my ($self, $env, $limiter, $parse_hdr, $hdr_arg) = @_;
        $self->{psgi_env} = $env;
        $self->{hdr_buf} = \(my $hdr_buf = '');
-       $self->{parse_hdr} = $parse_hdr;
+       $self->{parse_hdr} = [ $parse_hdr, $hdr_arg ];
        $limiter ||= $def_limiter ||= PublicInbox::Qspawn::Limiter->new(32);
 
        # the caller already captured the PSGI write callback from