File Coverage

blib/lib/OpenTracing/Role/Span.pm

Criterion	Covered	Total	%
statement	92	94	97.8
branch	28	34	82.3
condition	5	9	55.5
subroutine	25	26	96.1
pod	13	14	92.8
total	163	177	92.0

package OpenTracing::Role::Span;

our $VERSION = 'v0.86.1';



use Moo::Role;
use MooX::HandlesVia;
use MooX::ProtectedAttributes;
use MooX::Should;

use Carp;
use OpenTracing::Types qw/:types :is/;
use Time::HiRes qw/time/;
use Types::Standard qw/CodeRef HashRef Maybe Num Object Str Value/;
use Types::Common::Numeric qw/PositiveOrZeroNum/;

has operation_name => (
    is              => 'rwp',
    should          => Str,
    required        => 1,
#   writer          => 'overwrite_operation_name',
    reader          => 'get_operation_name', # it's not in the Interface
);

has start_time => (
    is              => 'ro',
    should          => PositiveOrZeroNum,
    default         => sub { epoch_floatingpoint() }
);

has finish_time => (
    is              => 'rwp',
    should          => PositiveOrZeroNum,
    predicate       => 'has_finished',
    init_arg        => undef,
);

has tags => (
    is              => 'rwp',
    should          => HashRef[Value],
    handles_via     => 'Hash',
    handles         => {
        get_tags => 'all',
    },
    default         => sub{ {} },
);

has context => (
    is              => 'ro',
    should          => SpanContext,
    reader          => 'get_context',
#   writer          => '_set_context',
    required        => 1, # either from Span->get_context or SpanContext self
    handles         => {
        get_span_id     => 'span_id',
    },
);

sub overwrite_operation_name {
    my $self = shift;

    croak "Can't overwrite an operation-name on an already finished span"
        if $self->has_finished;

    my $operation_name = shift; # or throw an exception

    $self->_set_operation_name( $operation_name );

    return $self
}

sub finish {
    my $self = shift;

    carp "Span has already been finished" and return $self
        if $self->has_finished;

    my $epoch_timestamp = shift // epoch_floatingpoint();

    $self->_set_finish_time( $epoch_timestamp );

    $self->on_finish->( $self )
        if $self->has_on_finish;

    return $self
}

sub add_tag {
    my $self = shift;

    croak "Can't set a tag on an already finished span"
        if $self->has_finished;

    my $key = shift;
    my $value = shift;

    $self->add_tags( $key => $value );

    return $self
}

sub add_tags {
    my $self = shift;

    croak "Can't set a tag on an already finished span"
        if $self->has_finished;

    my %tags = @_;
    $self->_set_tags(
        { $self->get_tags, %tags }
    );

    return $self
}

sub log_data {
    my $self = shift;

    croak "Can't log any more data on an already finished span"
        if $self->has_finished;

    my %log_data = @_;

#   ... # shall we just use Log::Any ?

    return $self
}

sub add_baggage_item {
    my $self = shift;

    croak "Can't set baggage-items on an already finished span"
        if $self->has_finished;

    my $key = shift;
    my $value = shift;

    $self->add_baggage_items( $key => $value );

    return $self
}

sub add_baggage_items {
    my $self = shift;

    croak "Can't set baggage-items on an already finished span"
        if $self->has_finished;

    my %items = @_;

    my $new_context = $self->get_context()->with_baggage_items( %items );
    $self->_set_context( $new_context );

    return $self
}

sub get_baggage_item {
    my $self = shift;
    my $key = shift;

    return $self->get_context()->get_baggage_item( $key )
}

sub get_baggage_items {
    my $self = shift;

    return $self->get_context()->get_baggage_items
}

sub duration {
    my $self = shift;

    my $start_time = $self->{ start_time }
        or croak
            "Span has not been started: ['"
            .
            ( $self->get_operation_name || "'undef'" )
            .
            "'] ... how did you do that ?";
    my $finish_time = $self->{ finish_time }
        or croak
            "Span has not been finished: ['"
            .
            ( $self->get_operation_name || "'undef'" )
            .
            "'] ... yet!";

    return $finish_time - $start_time
}

protected_has child_of => (
    is => 'ro',
    should => Span | SpanContext,
    required => 0,
);
#
# this is just non of your business, and will get depricated as soon as there is
# references

sub _get_child_of { $_[0]->child_of }
#
# so this can be swapped for something more clever once using references

sub get_parent_span_id {
    my $self = shift;

    my $child_of = $self->_get_child_of;

    return unless defined $child_of;

    return $child_of->span_id
        if is_SpanContext($child_of);

    return $child_of->get_context->span_id
        if is_Span($child_of);

    croak "No 'parent span_id' for 'child_of' attribute [$child_of]"
    #
    # execution should never end up here

}
#
# This may not be the right way to implement it, for the `child_of` attribute
# may not be such a good idea, maybe it should use references, but not sure how
# those are used



sub is_root_span { ! shift->get_parent_span_id() }

# _set_context
#
# you really shouldn't change the context yourself, only on instantiation
#
sub _set_context {
    my $self = shift;

    croak "Can't set context on an already finished span"
        if $self->has_finished;

    my $context = shift or die "Missing context";

    $self->{ context } = $context;

    return $self
}

has on_finish => (
    is              => 'ro',
    should          => Maybe[CodeRef],
    predicate       => 1,
);

sub DEMOLISH {
    my $self = shift;
    my $in_global_destruction = shift;

    return if $self->has_finished;

#   carp "Span not programmatically finished before being demolished";

    $self->finish( )
        unless $in_global_destruction;

    return
}

sub epoch_floatingpoint {
    return time()
}
#
# well, this is a bit off a silly idea:
# some implentations may want nano-second accuracy, but floating point
# computations using 64bits (IEEE) are only having 16 digits in the mantissa.
# The number of nano-seconds since epoch is 19 digits that barely fits in a
# signed 64 bit integer.



BEGIN {
#   use Role::Tiny::With;
    with 'OpenTracing::Interface::Span'
}



1;