ziguzagu.org

Writing Plack::Middleware modifying the response body

response body をいじる Plack::Middleware を作る場合、call で渡すコールバック関数の戻り値はサブルーチンにするのがよい（というかそうすべき？）。

sub call {
    my ($self, $env) = @_;
    my $res = $self->app->($env);
    $self->response_cb($res, sub {
        my $res = shift;
        ## こゆこと
        return sub {
            my $chunk = shift;
            $chunk .= 'test';
            return $chunk;
        };
    }
}

ただ $res をそのまんま書き換えてもちゃんと動いている風。

sub call {
    my ($self, $env) = @_;
    my $res = $self->app->($env);
    $self->response_cb($res, sub {
        my $res = shift;
        ## なまなましい感じで
        push @{ $res->[2] }, 'test';
    }
}

でも、後者をやってしまうと、Content-Length ヘッダがすでに設定されてしまっている場合、response body が変更されているにもかかわらず値が変更されない、という問題があったりする。

response_cb メソッドの実態は（いまのところ）Plack::Util::response_cb で、その中では、戻り値がサブルーチンだった場合にのみ設定済みの Content-Length を削除してくれるようになっている（ので、ContentLength Middleware も enable しておく必要がある）。以下、Plack::Util::response_cb (v0.9946) より抜粋。

my $body_filter = sub {
    my($cb, $res) = @_;
    my $filter_cb = $cb->($res);
    # If response_cb returns a callback, treat it as a $body filter
    if (defined $filter_cb && ref $filter_cb eq 'CODE') {
        Plack::Util::header_remove($res->[1], 'Content-Length');
        if (defined $res->[2]) {
            if (ref $res->[2] eq 'ARRAY') {
                for my $line (@{$res->[2]}) {
                    $line = $filter_cb->($line);
                }
                # Send EOF.
                my $eof = $filter_cb->( undef );
                push @{ $res->[2] }, $eof if defined $eof;
            } else {
                my $body    = $res->[2];
                my $getline = sub { $body->getline };
                $res->[2] = Plack::Util::inline_object
                    getline => sub { $filter_cb->($getline->()) },
                    close => sub { $body->close };
            }
        } else {
            return $filter_cb;
        }
    }
};

なんでサブルーチン返したときのみこうするようにしてるのかはよくわかっていないんだけど、、、そうなってるのでそうしましょう。。。（くぅ…、弱い）

# そして、P::U::response_cb の doc を書くという issue が github にあることに今気づいた

Plack::Middleware::Watermark

HTML や XML なんかのケツにコメントとしてテキストを埋め込む Plack::Middleware を作ってみた。

http://github.com/ziguzagu/Plack-Middleware-Watermark

やってることといえば、content type を見て適当なコメントシンタックスを選んで、指定された文字列を追加するだけのお仕事。

use Plack::Builder;
my $app = sub {
    [ 200, [ 'Content-Type' => 'text/html' ], [ "Hello World\n" ] ]
};
builder {
    enable 'Watermark', comment => 'HELLO HELLO!!';
    $app;
}

こうすると、

Hello World
<!-- HELLO HELLO!! -->

こういう出力になる。サブルーチンも渡せたりするので、

builder {
    enable 'Watermark', comment => sub { 'Generated by ' . Sys::Hostname::hostname };
    $app;
}

とかってのもできたり。HTML/CSS/XML/JS な Content-Type にとりあえず対応してる感じ。

でもまぁ、あんまり使い道はないですね :) ただ Plack & Plack::Middleware の勉強にはもろもろちょうど良かったです。まる。

"plackup -s Starman" or "starman"

% plackup -s Starman app.psgi

と

% starman app.psgi

は、機能的には全く同じ。なんだけど、plackup 使ったほうは ps コマンドでプロセスみるとコマンドラインから渡したパラメーターが見えなくなる。たとえば、worker の数調整して --daemonize したとする。

% plackup -s Starman --workers 2 --daemonize app.psgi
% ps x | grep starman
18801   ??  Ss     0:00.01 starman master
18803   ??  S      0:00.00 starman worker
18804   ??  S      0:00.00 starman worker

こんな表示。一方 starman コマンド使ったほう。

% starman --workers 2 --daemonize app.psgi
% ps x | grep starman
18835   ??  Ss     0:00.01 starman master --workers 2 --daemonize app.psgi
18837   ??  S      0:00.00 starman worker --workers 2 --daemonize app.psgi
18838   ??  S      0:00.00 starman worker --workers 2 --daemonize app.psgi

引数見えてる。

１つのホストで複数のアプリを plackup 経由で動かしていて、さてアプリ更新しよ、HUP だ、ってときに

% ps x | grep starman

したら、いっぱい出てきて焦った...。

それぞれのアプリでもちろん listen してる port も違ったけど、--pid で pid ファイル作っていたので、そっちから、kill して難を逃れた...。

% kill -HUP $(cat hello.pid)

きょうびのイケてる人達は daemontools 使って、plackup なり starman なりなんなり動かしてるようなので、たぶん問題ないんだろうけど（ daemontools まだ使った事ないからよくわからん...＞＜ ）、コマンド用意されている PSGI なサーバーはとりあえずそれを使おうと思った。

ていうかなんで ps がああなるかわかっていないのはダメ男な気がする...。アウチ。