File Coverage

blib/lib/Net/Stomp/MooseHelpers/TracerRole.pm

Criterion	Covered	Total	%
statement	59	62	95.1
branch	7	10	70.0
condition	6	8	75.0
subroutine	14	15	93.3
pod			n/a
total	86	95	90.5

package Net::Stomp::MooseHelpers::TracerRole;
$Net::Stomp::MooseHelpers::TracerRole::VERSION = '3.0';
{
  $Net::Stomp::MooseHelpers::TracerRole::DIST = 'Net-Stomp-MooseHelpers';
}
use Moose::Role;
use MooseX::Types::Path::Class;
use Net::Stomp::MooseHelpers::Types qw(Permissions OctalPermissions);
use Time::HiRes ();
use File::Temp ();
use Try::Tiny;
use List::Util 1.33 'none';
use namespace::autoclean;

# ABSTRACT: role to dump Net::Stomp frames to disk


has trace_basedir => (
    is => 'rw',
    isa => 'Path::Class::Dir',
    coerce => 1,
);


has trace => (
    is => 'rw',
    isa => 'Bool',
    default => 0,
);


has trace_permissions => (
    is => 'rw',
    isa => Permissions,
    default => '0600',
    coerce => 1,
);


has trace_directory_permissions => (
    is => 'rw',
    isa => Permissions,
    default => '0700',
    coerce => 1,
);



has trace_types => (
    is => 'rw',
    isa => 'ArrayRef[Str]',
    default => sub {+['SEND','MESSAGE']},
);


sub _dirname_from_destination {
    my ($self,$destination) = @_;

    return '' unless defined $destination;

    my $ret = $destination;
    $ret =~ s{^(queue|topic)/}{/$1/};
    $ret =~ s/\W+/_/g;
    return $ret;
}


sub _filename_from_frame {
    my ($self,$frame,$direction) = @_;

    my $base = sprintf '%0.5f',Time::HiRes::time();
    my $dir = $self->trace_basedir->subdir(
        $self->_dirname_from_destination($frame->headers->{destination})
    );
    $dir->mkpath({mode => $self->trace_directory_permissions});

    return File::Temp::tempfile("${base}-${direction}-XXXX",
                                DIR => $dir->stringify);
}

sub _temp_trace_file {
    my ($self,$frame,$direction) = @_;

    my $base = sprintf '%0.5f',Time::HiRes::time();
    my $dir = $self->trace_basedir->subdir('tmp');
    $dir->mkpath({mode => $self->trace_directory_permissions});

    return File::Temp::tempfile("${base}-temp-XXXX",
                                DIR => $dir->stringify);
}

sub _save_frame {
    my ($self,$frame,$direction) = @_;

    return unless $self->trace;
    return unless $frame;
    return if $self->trace_types and @{$self->trace_types} and
        none { lc($frame->command) eq lc($_) } @{$self->trace_types};
    $direction||='';

    if (!$self->trace_basedir) {
        warn "trace_basedir not set, but tracing requested, ignoring\n";
        return;
    }

    my ($tmp_fh,$tmp_filename) = $self->_temp_trace_file;
    binmode $tmp_fh;
    syswrite $tmp_fh,$frame->as_string;
    try {
        chmod $self->trace_permissions & (~umask),$tmp_fh;
    }
    catch {
        chmod $self->trace_permissions & (~umask),$tmp_filename;
    };
    close $tmp_fh;

    my ($fh,$filename) = $self->_filename_from_frame($frame,$direction);
    close $fh;
    rename $tmp_filename,$filename;

    return;
}

1;

__END__

=pod

=encoding UTF-8

=head1 NAME

Net::Stomp::MooseHelpers::TracerRole - role to dump Net::Stomp frames to disk

=head1 VERSION

version 3.0

=head1 DESCRIPTION

This role is not to be used directly, look at
L<Net::Stomp::MooseHelpers::TraceStomp> and
L<Net::Stomp::MooseHelpers::TraceOnly>.

This role provides attributes and methods to write to disk every
outgoing and incoming STOMP frame.

The frames are written as they are "on the wire" (no encoding
conversion happens), one file per frame. Each frame is written into a
directory under L</trace_basedir> with a name derived from the frame
destination.

=head1 ATTRIBUTES

=head2 C<trace_basedir>

The directory under which frames will be dumped. Accepts strings and
L<Path::Class::Dir> objects. If it's not specified and you enable
L</trace>, every frame will generate a warning.

=head2 C<trace>

Boolean attribute to enable or disable tracing / dumping of frames. If
you enable tracing but don't set L</trace_basedir>, every frame will
generate a warning.

=head2 C<trace_permissions>

The permissions (as in L<perlfunc/chmod>) to set the dumped files
to. Accepts integers and strings with base-8 representation (see
L<Net::Stomp::MooseHelpers::Types/Permissions> and
L<Net::Stomp::MooseHelpers::Types/OctalPermissions>). The actual
permissions applied will also depend on the L<umask>.

=head2 C<trace_directory_permissions>

The permissions (as in L<perlfunc/chmod>) to set the directories for
dumped files to. Accepts integers and strings with base-8
representation (see L<Net::Stomp::MooseHelpers::Types/Permissions> and
L<Net::Stomp::MooseHelpers::Types/OctalPermissions>). The actual
permissions applied will also depend on the L<umask>.

=head2 C<trace_types>

Arrayref of frame types to dump (strings, compared
case-insensitively). Defaults to C<['SEND','MESSAGE']>. If set to an
empty array, all frame types will be dumped (this was the behaviour is
previous versions).

=head1 METHODS

=head2 C<_dirname_from_destination>

Generate a directory name from a frame destination. By default,
replaces every sequence of non-word characters with C<'_'>.

=head2 C<_filename_from_frame>

Returns a filehandle / filename pair for the file to write the frame
into. Avoids duplicates by using L<Time::HiRes>'s C<time> as a
starting filename, and L<File::Temp>.

=head1 AUTHOR

Gianni Ceccarelli <[e-mail]>

=head1 COPYRIGHT AND LICENSE

This software is copyright (c) 2014 by Net-a-porter.com.

This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.

=cut