X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=t%2F52leaks.t;h=c7af7013b2a8f0a638cde80d7d3473249fe2a303;hb=439a7283a981f27a56e745d99e456fc50a5a018f;hp=4d029f092625c71b98d23df5fcbf40684a78c820;hpb=21aa86aae083ccb5b94ba994dec030627e95e40b;p=dbsrgits%2FDBIx-Class.git diff --git a/t/52leaks.t b/t/52leaks.t index 4d029f0..c7af701 100644 --- a/t/52leaks.t +++ b/t/52leaks.t @@ -1,3 +1,5 @@ +BEGIN { do "./t/lib/ANFANG.pm" or die ( $@ || $! ) } + # work around brain damage in PPerl (yes, it has to be a global) $SIG{__WARN__} = sub { warn @_ unless $_[0] =~ /\QUse of "goto" to jump into a construct is deprecated/ @@ -21,23 +23,26 @@ use strict; use warnings; use Test::More; + +use DBICTest::RunMode; +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 older TBs warn in END after a ->reset - if ($TB->VERSION < 1.005) { - close ($TB->$_) for (qw/output failure_output todo_output/); - } - - # if I do not do this, I get happy sigpipes on new TB, no idea why - # (the above close-and-forget doesn't work - new TB does *not* reopen - # its handles automatically anymore) - else { - for (qw/failure_output todo_output/) { - close $TB->$_; - open ($TB->$_, '>&', *STDERR); - } + # without this explicit close TB warns in END after a ->reset + close ($TB->$_) for qw(output failure_output todo_output); - close $TB->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); } @@ -45,15 +50,6 @@ if ($ENV{DBICTEST_IN_PERSISTENT_ENV}) { $TB->reset; } -use lib qw(t/lib); -use DBICTest::RunMode; -use DBICTest::Util::LeakTracer qw(populate_weakregistry assert_empty_weakregistry visit_refs); -use DBIx::Class; -BEGIN { - plan skip_all => "Your perl version $] appears to leak like a sieve - skipping test" - if DBIx::Class::_ENV_::PEEPEENESS; -} - # this is what holds all weakened refs to be checked for leakage my $weak_registry = {}; @@ -61,7 +57,8 @@ 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/; @@ -85,9 +82,9 @@ unless (DBICTest::RunMode->is_plain) { # 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::/; + return $obj if (ref $obj) =~ /^TB2::|^Test::Stream/; - # weaken immediately to avoid weird side effects + # populate immediately to avoid weird side effects return populate_weakregistry ($weak_registry, $obj ); }; @@ -104,7 +101,7 @@ unless (DBICTest::RunMode->is_plain) { # 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; @@ -122,8 +119,6 @@ unless (DBICTest::RunMode->is_plain) { my $rs = $schema->resultset ('Artist'); my $storage = $schema->storage; - 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'); @@ -213,9 +208,6 @@ unless (DBICTest::RunMode->is_plain) { 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, @@ -238,8 +230,8 @@ unless (DBICTest::RunMode->is_plain) { 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, @@ -255,11 +247,40 @@ unless (DBICTest::RunMode->is_plain) { leaky_resultset_cond => $cond_rowobj, }; - # this needs to fire, even if it can't find anything - # see FIXME below - # we run this only on smokers - trying to establish a pattern - $rs_bind_circref->next - if ( ($ENV{TRAVIS}||'') ne 'true' and DBICTest::RunMode->is_smoker); + # 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 = ( @@ -274,6 +295,7 @@ unless (DBICTest::RunMode->is_plain) { 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 @@ -291,6 +313,65 @@ unless (DBICTest::RunMode->is_plain) { 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) { @@ -362,27 +443,78 @@ for my $addr (keys %$weak_registry) { # T::B 2.0 has result objects and other fancyness delete $weak_registry->{$addr}; } + elsif ($names =~ /^Class::Struct/m) { + # remove this when Path::Class is gone, what a crock of shit + delete $weak_registry->{$addr}; + } elsif ($names =~ /^Hash::Merge/m) { # only clear one object of a specific behavior - more would indicate trouble delete $weak_registry->{$addr} unless $cleared->{hash_merge_singleton}{$weak_registry->{$addr}{weakref}{behavior}}++; } + 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 ($names =~ /^DateTime::TimeZone::UTC/m) { + # DT is going through a refactor it seems - let it leak zones for now + 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}}++; + } } # 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 --> {CachedKids} # ^ / # \-------- bound value on prepared/cached STH <-----------/ # { - local $TODO = 'This fails intermittently - see RT#82942'; - if ( my $r = ($weak_registry->{'basic leaky_resultset_cond'}||{})->{weakref} ) { + 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 $r->result_source(undef); + 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); + } } } @@ -393,29 +525,7 @@ assert_empty_weakregistry ($weak_registry); # this is ugly and dirty but we do not yet have a Test::Embedded or # similar -# set up -I -require Config; -$ENV{PERL5LIB} = join ($Config::Config{path_sep}, @INC); -($ENV{PATH}) = $ENV{PATH} =~ /(.+)/; - - -my $persistence_tests = { - PPerl => { - cmd => [qw/pperl --prefork=1/, __FILE__], - }, - 'CGI::SpeedyCGI' => { - cmd => [qw/speedy -- -t5/, __FILE__], - }, -}; - -# 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}} ], -]; - +my $persistence_tests; SKIP: { skip 'Test already in a persistent loop', 1 if $ENV{DBICTEST_IN_PERSISTENT_ENV}; @@ -423,9 +533,39 @@ SKIP: { skip 'Main test failed - skipping persistent env tests', 1 unless $TB->is_passing; + 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; - require IPC::Open2; + $persistence_tests = { + PPerl => { + cmd => [qw/pperl --prefork=1/, __FILE__], + }, + 'CGI::SpeedyCGI' => { + cmd => [qw/speedy -- -t5/, __FILE__], + }, + }; + + # 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}} ], + ]; + + # set up -I + require Config; + $ENV{PERL5LIB} = join ($Config::Config{path_sep}, @INC); + + # adjust PATH for -T + if (length $ENV{PATH}) { + ( $ENV{PATH} ) = join ( $Config::Config{path_sep}, + map { length($_) ? File::Spec->rel2abs($_) : () } + split /\Q$Config::Config{path_sep}/, $ENV{PATH} + ) =~ /\A(.+)\z/; + } for my $type (keys %$persistence_tests) { SKIP: { unless (eval "require $type") { @@ -447,6 +587,8 @@ SKIP: { if system(@cmd); } + require IPC::Open2; + for (1,2,3) { note ("Starting run in persistent env ($type pass $_)"); IPC::Open2::open2(my $out, undef, @cmd); @@ -473,10 +615,13 @@ 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 $_ for (*STDIN, *STDOUT, *STDERR); + if ($persistence_tests->{PPerl}{termcmd}) { local $?; # otherwise test will inherit $? of the system() - system (@{$persistence_tests->{PPerl}{termcmd}}) - if $persistence_tests->{PPerl}{termcmd}; + require IPC::Open3; + open my $null, ">", File::Spec->devnull; + waitpid( + IPC::Open3::open3(undef, $null, $null, @{$persistence_tests->{PPerl}{termcmd}}), + 0, + ); } }