use warnings;
use Test::More;
-my $TB = Test::More->builder;
-if ($ENV{DBICTEST_IN_PERSISTENT_ENV}) {
- # without this explicit close ->reset below warns
- close ($TB->$_) for qw/output failure_output/;
-
- # so done_testing can work
- $TB->reset;
-
- # this simulates a subtest
- $TB->_indent(' ' x 4);
-}
-
use lib qw(t/lib);
use DBICTest::RunMode;
-use DBICTest::Util qw/populate_weakregistry assert_empty_weakregistry/;
-use DBIx::Class;
-use B 'svref_2object';
+use DBICTest::Util::LeakTracer qw(populate_weakregistry assert_empty_weakregistry visit_refs);
+use Scalar::Util qw(weaken blessed reftype);
+use DBIx::Class::_Util qw(hrefaddr sigwarn_silencer modver_gt_or_eq modver_gt_or_eq_and_lt);
BEGIN {
plan skip_all => "Your perl version $] appears to leak like a sieve - skipping test"
if DBIx::Class::_ENV_::PEEPEENESS;
}
+
+my $TB = Test::More->builder;
+if ($ENV{DBICTEST_IN_PERSISTENT_ENV}) {
+ # without this explicit close TB warns in END after a ->reset
+ close ($TB->$_) for qw(output failure_output todo_output);
+
+ # newer TB does not auto-reopen handles
+ if ( modver_gt_or_eq( 'Test::More', '1.200' ) ) {
+ open ($TB->$_, '>&', *STDERR)
+ for qw( failure_output todo_output );
+ open ($TB->output, '>&', *STDOUT);
+ }
+
+ # so done_testing can work on every persistent pass
+ $TB->reset;
+}
+
# this is what holds all weakened refs to be checked for leakage
my $weak_registry = {};
my $has_dt;
# Skip the heavy-duty leak tracing when just doing an install
-unless (DBICTest::RunMode->is_plain) {
+# or when having Moose crap all over everything
+if ( !$ENV{DBICTEST_VIA_REPLICATED} and !DBICTest::RunMode->is_plain ) {
# redefine the bless override so that we can catch each and every object created
no warnings qw/redefine once/;
}
);
- # weaken immediately to avoid weird side effects
+ # unicode is tricky, and now we happen to invoke it early via a
+ # regex in connection()
+ return $obj if (ref $obj) =~ /^utf8/;
+
+ # Test Builder is now making a new object for every pass/fail (que bloat?)
+ # and as such we can't really store any of its objects (since it will
+ # re-populate the registry while checking it, ewwww!)
+ return $obj if (ref $obj) =~ /^TB2::|^Test::Stream/;
+
+ # populate immediately to avoid weird side effects
return populate_weakregistry ($weak_registry, $obj );
};
# Load them and empty the registry
# this loads the DT armada
- $has_dt = DBIx::Class::Optional::Dependencies->req_ok_for('test_dt_sqlite');
+ $has_dt = DBIx::Class::Optional::Dependencies->req_ok_for([qw( test_rdbms_sqlite ic_dt )]);
require Errno;
require DBI;
require DBD::SQLite;
require FileHandle;
+ require Moo;
%$weak_registry = ();
}
-my @compose_ns_classes;
{
use_ok ('DBICTest');
my $rs = $schema->resultset ('Artist');
my $storage = $schema->storage;
- @compose_ns_classes = map { "DBICTest::${_}" } keys %{$schema->source_registrations};
-
- ok ($storage->connected, 'we are connected');
-
my $row_obj = $rs->search({}, { rows => 1})->next; # so that commits/rollbacks work
ok ($row_obj, 'row from db');
my $getcol_rs = $cds_rs->get_column('me.cdid');
my $pref_getcol_rs = $cds_with_stuff->get_column('me.cdid');
- # fire the column getters
- my @throwaway = $pref_getcol_rs->all;
-
my $base_collection = {
resultset => $rs,
get_column_rs_pref => $pref_getcol_rs,
# twice so that we make sure only one H::M object spawned
- chained_resultset => $rs->search_rs ({}, { '+columns' => [ 'foo' ] } ),
- chained_resultset2 => $rs->search_rs ({}, { '+columns' => [ 'bar' ] } ),
+ chained_resultset => $rs->search_rs ({}, { '+columns' => { foo => 'artistid' } } ),
+ chained_resultset2 => $rs->search_rs ({}, { '+columns' => { bar => 'artistid' } } ),
row_object => $row_obj,
leaky_resultset => $rs_bind_circref,
leaky_resultset_cond => $cond_rowobj,
- leaky_resultset_member => $rs_bind_circref->next,
};
+ # fire all resultsets multiple times, once here, more below
+ # some of these can't find anything (notably leaky_resultset)
+ my @rsets = grep {
+ blessed $_
+ and
+ (
+ $_->isa('DBIx::Class::ResultSet')
+ or
+ $_->isa('DBIx::Class::ResultSetColumn')
+ )
+ } values %$base_collection;
+
+
+ my $fire_resultsets = sub {
+ local $ENV{DBIC_COLUMNS_INCLUDE_FILTER_RELS} = 1;
+ local $SIG{__WARN__} = sigwarn_silencer(
+ qr/Unable to deflate 'filter'-type relationship 'artist'.+related object primary key not retrieved/
+ );
+
+ map
+ { $_, (blessed($_) ? { $_->get_columns } : ()) }
+ map
+ { $_->all }
+ @rsets
+ ;
+ };
+
+ push @{$base_collection->{random_results}}, $fire_resultsets->();
+
+ # FIXME - something throws a Storable for a spin if we keep
+ # the results in-collection. The same problem is seen above,
+ # swept under the rug back in 0a03206a, damned lazy ribantainer
+{
+ local $base_collection->{random_results};
+
require Storable;
%$base_collection = (
%$base_collection,
fresh_pager => $rs->page(5)->pager,
pager => $pager,
);
+}
+
+ # FIXME - ideally this kind of collector ought to be global, but attempts
+ # with an invasive debugger-based tracer did not quite work out... yet
+ # Manually scan the innards of everything we have in the base collection
+ # we assembled so far (skip the DT madness below) *recursively*
+ #
+ # Only do this when we do have the bits to look inside CVs properly,
+ # without it we are liable to pick up object defaults that are locked
+ # in method closures
+ if (DBICTest::Util::LeakTracer::CV_TRACING) {
+ visit_refs(
+ refs => [ $base_collection ],
+ action => sub {
+ populate_weakregistry ($weak_registry, $_[0]);
+ 1; # true means "keep descending"
+ },
+ );
+
+ # do a heavy-duty fire-and-compare loop on all resultsets
+ # this is expensive - not running on install
+ my $typecounts = {};
+ if (
+ ! DBICTest::RunMode->is_plain
+ and
+ ! $ENV{DBICTEST_IN_PERSISTENT_ENV}
+ ) {
+
+ # FIXME - ideally we should be able to just populate an alternative
+ # registry, subtract everything from the main one, and arrive at
+ # an "empty" resulting hash
+ # However due to gross inefficiencies in the ::ResultSet code we
+ # end up recalculating a new set of aliasmaps which could have very
+ # well been cached if it wasn't for... anyhow
+ # What we do here for the time being is similar to the lazy approach
+ # of Devel::LeakTrace - we just make sure we do not end up with more
+ # reftypes than when we started. At least we are not blanket-counting
+ # SVs like D::LT does, but going by reftype... sigh...
+
+ for (values %$weak_registry) {
+ if ( my $r = reftype($_->{weakref}) ) {
+ $typecounts->{$r}--;
+ }
+ }
+
+ # For now we can only reuse the same registry, see FIXME above/below
+ #for my $interim_wr ({}, {}) {
+ for my $interim_wr ( ($weak_registry) x 4 ) {
+
+ visit_refs(
+ refs => [ $fire_resultsets->(), @rsets ],
+ action => sub {
+ populate_weakregistry ($interim_wr, $_[0]);
+ 1; # true means "keep descending"
+ },
+ );
+
+ # FIXME - this is what *should* be here
+ #
+ ## anything we have seen so far is cool
+ #delete @{$interim_wr}{keys %$weak_registry};
+ #
+ ## moment of truth - the rest ought to be gone
+ #assert_empty_weakregistry($interim_wr);
+ }
+
+ for (values %$weak_registry) {
+ if ( my $r = reftype($_->{weakref}) ) {
+ $typecounts->{$r}++;
+ }
+ }
+ }
+
+ for (keys %$typecounts) {
+ fail ("Amount of $_ refs changed by $typecounts->{$_} during resultset mass-execution")
+ if ( abs ($typecounts->{$_}) > 1 ); # there is a pad caught somewhere, the +1/-1 can be ignored
+ }
+ }
if ($has_dt) {
my $rs = $base_collection->{icdt_rs} = $schema->resultset('Event');
$base_collection->{"DBI handle $_"} = $_;
}
- SKIP: {
- if ( DBIx::Class::Optional::Dependencies->req_ok_for ('test_leaks') ) {
- Test::Memory::Cycle::memory_cycle_ok ($base_collection, 'No cycles in the object collection')
- }
- else {
- skip 'Circular ref test needs ' . DBIx::Class::Optional::Dependencies->req_missing_for ('test_leaks'), 1;
- }
- }
-
populate_weakregistry ($weak_registry, $base_collection->{$_}, "basic $_")
for keys %$base_collection;
}
{
my $phantom;
for (
- sub { DBICTest->init_schema },
+ sub { DBICTest->init_schema( sqlite_use_file => 0 ) },
sub { shift->source('Artist') },
sub { shift->resultset },
sub { shift->result_source },
# Naturally we have some exceptions
my $cleared;
-for my $slot (keys %$weak_registry) {
- if ($slot =~ /^Test::Builder/) {
+for my $addr (keys %$weak_registry) {
+ my $names = join "\n", keys %{$weak_registry->{$addr}{slot_names}};
+
+ if ($names =~ /^Test::Builder/m) {
# T::B 2.0 has result objects and other fancyness
- delete $weak_registry->{$slot};
+ delete $weak_registry->{$addr};
}
- elsif ($slot =~ /^Method::Generate::(?:Accessor|Constructor)/) {
- # Moo keeps globals around, this is normal
- delete $weak_registry->{$slot};
- }
- elsif ($slot =~ /^SQL::Translator/) {
- # SQLT is a piece of shit, leaks all over
- delete $weak_registry->{$slot};
- }
- elsif ($slot =~ /^Hash::Merge/) {
+ elsif ($names =~ /^Hash::Merge/m) {
# only clear one object of a specific behavior - more would indicate trouble
- delete $weak_registry->{$slot}
- unless $cleared->{hash_merge_singleton}{$weak_registry->{$slot}{weakref}{behavior}}++;
+ delete $weak_registry->{$addr}
+ unless $cleared->{hash_merge_singleton}{$weak_registry->{$addr}{weakref}{behavior}}++;
}
- elsif (DBIx::Class::_ENV_::INVISIBLE_DOLLAR_AT and $slot =~ /^__TxnScopeGuard__FIXUP__/) {
- delete $weak_registry->{$slot}
+ elsif ($names =~ /^B::Hooks::EndOfScope::PP::_TieHintHashFieldHash/m) {
+ # there is one tied lexical which stays alive until GC time
+ # https://metacpan.org/source/ETHER/B-Hooks-EndOfScope-0.15/lib/B/Hooks/EndOfScope/PP/FieldHash.pm#L24
+ # simply ignore it here, instead of teaching the leaktracer to examine ties
+ # the latter is possible yet terrible: https://github.com/dbsrgits/dbix-class/blob/v0.082820/t/lib/DBICTest/Util/LeakTracer.pm#L113-L117
+ delete $weak_registry->{$addr}
+ unless $cleared->{bheos_pptiehinthashfieldhash}++;
}
- elsif ($slot =~ /^DateTime::TimeZone/) {
+ elsif ($names =~ /^DateTime::TimeZone::UTC/m) {
# DT is going through a refactor it seems - let it leak zones for now
- delete $weak_registry->{$slot};
+ delete $weak_registry->{$addr};
+ }
+ elsif (
+# # if we can look at closed over pieces - we will register it as a global
+# !DBICTest::Util::LeakTracer::CV_TRACING
+# and
+ $names =~ /^SQL::Translator::Generator::DDL::SQLite/m
+ ) {
+ # SQLT::Producer::SQLite keeps global generators around for quoted
+ # and non-quoted DDL, allow one for each quoting style
+ delete $weak_registry->{$addr}
+ unless $cleared->{sqlt_ddl_sqlite}->{@{$weak_registry->{$addr}{weakref}->quote_chars}}++;
}
-}
-
-# every result class has a result source instance as classdata
-# make sure these are all present and distinct before ignoring
-# (distinct means only 1 reference)
-for my $rs_class (
- 'DBICTest::BaseResult',
- @compose_ns_classes,
- map { DBICTest::Schema->class ($_) } DBICTest::Schema->sources
-) {
- # need to store the SVref and examine it separately, to push the rsrc instance off the pad
- my $SV = svref_2object($rs_class->result_source_instance);
- is( $SV->REFCNT, 1, "Source instance of $rs_class referenced exactly once" );
-
- # ignore it
- delete $weak_registry->{$rs_class->result_source_instance};
-}
-
-# Schema classes also hold sources, but these are clones, since
-# each source contains the schema (or schema class name in this case)
-# Hence the clone so that the same source can be registered with
-# multiple schemas
-for my $moniker ( keys %{DBICTest::Schema->source_registrations || {}} ) {
-
- my $SV = svref_2object(DBICTest::Schema->source($moniker));
- is( $SV->REFCNT, 1, "Source instance registered under DBICTest::Schema as $moniker referenced exactly once" );
-
- delete $weak_registry->{DBICTest::Schema->source($moniker)};
}
# FIXME !!!
# There is an actual strong circular reference taking place here, but because
-# half of it is in XS no leaktracer sees it, and Devel::FindRef is equally
-# stumped when trying to trace the origin. The problem is:
+# half of it is in XS, so it is a bit harder to track down (it stumps D::FR)
+# (our tracker does not yet do it, but it'd be nice)
+# The problem is:
#
-# $cond_object --> result_source --> schema --> storage --> $dbh --> {cached_kids}
+# $cond_object --> result_source --> schema --> storage --> $dbh --> {CachedKids}
# ^ /
# \-------- bound value on prepared/cached STH <-----------/
#
-TODO: {
- local $TODO = 'Not sure how to fix this yet, an entanglment could be an option';
- my $r = $weak_registry->{'basic leaky_resultset_cond'}{weakref};
- ok(! defined $r, 'We no longer leak!')
- or $r->result_source(undef);
+{
+ my @circreffed;
+
+ for my $r (map
+ { $_->{weakref} }
+ grep
+ { $_->{slot_names}{'basic leaky_resultset_cond'} }
+ values %$weak_registry
+ ) {
+ local $TODO = 'Needs Data::Entangled or somesuch - see RT#82942';
+ ok(! defined $r, 'Self-referential RS conditions no longer leak!')
+ or push @circreffed, $r;
+ }
+
+ if (@circreffed) {
+ is (scalar @circreffed, 1, 'One resultset expected to leak');
+
+ # this is useless on its own, it is to showcase the circref-diag
+ # and eventually test it when it is operational
+ local $TODO = 'Needs Data::Entangled or somesuch - see RT#82942';
+ while (@circreffed) {
+ weaken (my $r = shift @circreffed);
+
+ populate_weakregistry( (my $mini_registry = {}), $r );
+ assert_empty_weakregistry( $mini_registry );
+
+ $r->result_source(undef);
+ }
+ }
}
assert_empty_weakregistry ($weak_registry);
# this is ugly and dirty but we do not yet have a Test::Embedded or
# similar
-my @pperl_cmd = (qw/pperl --prefork=1/, __FILE__);
-my @pperl_term_cmd = @pperl_cmd;
-splice @pperl_term_cmd, 1, 0, '--kill';
+# set up -I
+require Config;
+$ENV{PERL5LIB} = join ($Config::Config{path_sep}, @INC);
+($ENV{PATH}) = $ENV{PATH} =~ /(.+)/;
-# scgi is smart and will auto-reap after -t amount of seconds
-my @scgi_cmd = (qw/speedy -- -t5/, __FILE__);
+my $persistence_tests;
SKIP: {
skip 'Test already in a persistent loop', 1
if $ENV{DBICTEST_IN_PERSISTENT_ENV};
- skip 'Persistence test disabled on regular installs', 1
- if DBICTest::RunMode->is_plain;
-
skip 'Main test failed - skipping persistent env tests', 1
unless $TB->is_passing;
- # set up -I
- require Config;
- local $ENV{PERL5LIB} = join ($Config::Config{path_sep}, @INC);
+ skip "Test::Builder\@@{[ Test::Builder->VERSION ]} known to break persistence tests", 1
+ if modver_gt_or_eq_and_lt( 'Test::More', '1.200', '1.301001_099' );
local $ENV{DBICTEST_IN_PERSISTENT_ENV} = 1;
- # try with pperl
- SKIP: {
- skip 'PPerl persistent environment tests require PPerl', 1
- unless eval { require PPerl };
-
- # since PPerl is racy and sucks - just prime the "server"
- {
- local $ENV{DBICTEST_PERSISTENT_ENV_BAIL_EARLY} = 1;
- system(@pperl_cmd);
- sleep 1;
-
- # see if it actually runs - if not might as well bail now
- skip "Something is wrong with pperl ($!)", 1
- if system(@pperl_cmd);
- }
+ $persistence_tests = {
+ PPerl => {
+ cmd => [qw/pperl --prefork=1/, __FILE__],
+ },
+ 'CGI::SpeedyCGI' => {
+ cmd => [qw/speedy -- -t5/, __FILE__],
+ },
+ };
- for (1,2,3) {
- system(@pperl_cmd);
- ok (!$?, "Run in persistent env (PPerl pass $_): exit $?");
+ # scgi is smart and will auto-reap after -t amount of seconds
+ # pperl needs an actual killer :(
+ $persistence_tests->{PPerl}{termcmd} = [
+ $persistence_tests->{PPerl}{cmd}[0],
+ '--kill',
+ @{$persistence_tests->{PPerl}{cmd}}[ 1 .. $#{$persistence_tests->{PPerl}{cmd}} ],
+ ];
+
+ require IPC::Open2;
+
+ for my $type (keys %$persistence_tests) { SKIP: {
+ unless (eval "require $type") {
+ # Don't terminate what we didn't start
+ delete $persistence_tests->{$type}{termcmd};
+ skip "$type module not found", 1;
}
- ok (! system (@pperl_term_cmd), 'killed pperl instance');
- }
-
- # try with speedy-cgi
- SKIP: {
- skip 'SPeedyCGI persistent environment tests require CGI::SpeedyCGI', 1
- unless eval { require CGI::SpeedyCGI };
+ my @cmd = @{$persistence_tests->{$type}{cmd}};
+ # since PPerl is racy and sucks - just prime the "server"
{
local $ENV{DBICTEST_PERSISTENT_ENV_BAIL_EARLY} = 1;
- skip "Something is wrong with speedy ($!)", 1
- if system(@scgi_cmd);
+ system(@cmd);
sleep 1;
+
+ # see if the thing actually runs, if not - might as well bail now
+ skip "Something is wrong with $type ($!)", 1
+ if system(@cmd);
}
for (1,2,3) {
- system(@scgi_cmd);
- ok (!$?, "Run in persistent env (SpeedyCGI pass $_): exit $?");
+ note ("Starting run in persistent env ($type pass $_)");
+ IPC::Open2::open2(my $out, undef, @cmd);
+ my @out_lines;
+ while (my $ln = <$out>) {
+ next if $ln =~ /^\s*$/;
+ push @out_lines, " $ln";
+ last if $ln =~ /^\d+\.\.\d+$/; # this is persistence, we need to terminate reading on our end
+ }
+ print $_ for @out_lines;
+ close $out;
+ wait;
+ ok (!$?, "Run in persistent env ($type pass $_): exit $?");
+ ok (scalar @out_lines, "Run in persistent env ($type pass $_): got output");
}
- }
+
+ ok (! system (@{$persistence_tests->{$type}{termcmd}}), "killed $type server instance")
+ if $persistence_tests->{$type}{termcmd};
+ }}
}
done_testing;
# just an extra precaution in case we blew away from the SKIP - since there are no
# PID files to go by (man does pperl really suck :(
END {
- unless ($ENV{DBICTEST_IN_PERSISTENT_ENV}) {
- close STDOUT;
- close STDERR;
+ if ($persistence_tests->{PPerl}{termcmd}) {
local $?; # otherwise test will inherit $? of the system()
- system (@pperl_term_cmd);
+ require IPC::Open3;
+ open my $null, ">", File::Spec->devnull;
+ waitpid(
+ IPC::Open3::open3(undef, $null, $null, @{$persistence_tests->{PPerl}{termcmd}}),
+ 0,
+ );
}
}