use lib qw(t/lib);
use DBICTest::RunMode;
+use DBICTest::Util qw/populate_weakregistry assert_empty_weakregistry/;
use DBIx::Class;
+use B 'svref_2object';
BEGIN {
plan skip_all => "Your perl version $] appears to leak like a sieve - skipping test"
- if DBIx::Class::_ENV_::PEEPEENESS();
+ if DBIx::Class::_ENV_::PEEPEENESS;
}
-use Scalar::Util qw/refaddr reftype weaken/;
-
# this is what holds all weakened refs to be checked for leakage
my $weak_registry = {};
# Skip the heavy-duty leak tracing when just doing an install
unless (DBICTest::RunMode->is_plain) {
- # have our own little stack maker - Carp infloops due to the bless override
- my $trace = sub {
- my $depth = 1;
- my (@stack, @frame);
-
- while (@frame = caller($depth++)) {
- push @stack, [@frame[3,1,2]];
- }
-
- $stack[0][0] = '';
- return join "\tinvoked as ", map { sprintf ("%s at %s line %d\n", @$_ ) } @stack;
- };
-
# redefine the bless override so that we can catch each and every object created
no warnings qw/redefine once/;
no strict qw/refs/;
}
);
- my $slot = (sprintf '%s=%s(0x%x)', # so we don't trigger stringification
- ref $obj,
- reftype $obj,
- refaddr $obj,
- );
-
# weaken immediately to avoid weird side effects
- $weak_registry->{$slot} = { weakref => $obj, strace => $trace->() };
- weaken $weak_registry->{$slot}{weakref};
-
- return $obj;
+ return populate_weakregistry ($weak_registry, $obj );
};
require Try::Tiny;
for my $func (qw/try catch finally/) {
my $orig = \&{"Try::Tiny::$func"};
*{"Try::Tiny::$func"} = sub (&;@) {
-
- my $slot = sprintf ('CODE(0x%x)', refaddr $_[0]);
-
- $weak_registry->{$slot} = { weakref => $_[0], strace => $trace->() };
- weaken $weak_registry->{$slot}{weakref};
-
+ populate_weakregistry( $weak_registry, $_[0] );
goto $orig;
}
}
%$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
# txn_do to invoke more codepaths
my ($mc_row_obj, $pager, $pager_explicit_count) = $schema->txn_do (sub {
- my $artist = $rs->create ({
+ my $artist = $schema->resultset('Artist')->create ({
name => 'foo artist',
cds => [{
title => 'foo cd',
year => 1984,
+ tracks => [
+ { title => 't1' },
+ { title => 't2' },
+ ],
+ genre => { name => 'mauve' },
}],
});
return ($artist, $pg, $pg_wcount);
});
+ # more codepaths - error handling in txn_do
+ {
+ eval { $schema->txn_do ( sub {
+ $storage->_dbh->begin_work;
+ fail ('how did we get so far?!');
+ } ) };
+
+ eval { $schema->txn_do ( sub {
+ $schema->txn_do ( sub {
+ die "It's called EXCEPTION";
+ fail ('how did we get so far?!');
+ } );
+ fail ('how did we get so far?!');
+ } ) };
+ like( $@, qr/It\'s called EXCEPTION/, 'Exception correctly propagated in nested txn_do' );
+ }
+
+ # dbh_do codepath
+ my ($rs_bind_circref, $cond_rowobj) = $schema->storage->dbh_do ( sub {
+ my $row = $_[0]->schema->resultset('Artist')->new({});
+ my $rs = $_[0]->schema->resultset('Artist')->search({
+ name => $row, # this is deliberately bogus, see FIXME below!
+ });
+ return ($rs, $row);
+ });
+
is ($pager->next_page, 3, 'There is one more page available');
# based on 66 per 10 pages
$schema->txn_rollback;
}
+ # prefetching
+ my $cds_rs = $schema->resultset('CD');
+ my $cds_with_artist = $cds_rs->search({}, { prefetch => 'artist' });
+ my $cds_with_tracks = $cds_rs->search({}, { prefetch => 'tracks' });
+ my $cds_with_stuff = $cds_rs->search({}, { prefetch => [ 'genre', { artist => { cds => { tracks => 'cd_single' } } } ] });
+
+ # implicit pref
+ my $cds_with_impl_artist = $cds_rs->search({}, { columns => [qw/me.title artist.name/], join => 'artist' });
+
+ # get_column
+ 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,
+ pref_precursor => $cds_rs,
+
+ pref_rs_single => $cds_with_artist,
+ pref_rs_multi => $cds_with_tracks,
+ pref_rs_nested => $cds_with_stuff,
+
+ pref_rs_implicit => $cds_with_impl_artist,
+
+ pref_row_single => $cds_with_artist->next,
+ pref_row_multi => $cds_with_tracks->next,
+ pref_row_nested => $cds_with_stuff->next,
+
+ # even though this does not leak Storable croaks on it :(((
+ #pref_row_implicit => $cds_with_impl_artist->next,
+
+ get_column_rs_plain => $getcol_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' ] } ),
row_object => $row_obj,
+ mc_row_object => $mc_row_obj,
+
result_source => $rs->result_source,
result_source_handle => $rs->result_source->handle,
- fresh_pager => $rs->page(5)->pager,
- pager => $pager,
pager_explicit_count => $pager_explicit_count,
+ leaky_resultset => $rs_bind_circref,
+ leaky_resultset_cond => $cond_rowobj,
+ leaky_resultset_member => $rs_bind_circref->next,
};
require Storable;
%$base_collection,
refrozen => Storable::dclone( $base_collection ),
rerefrozen => Storable::dclone( Storable::dclone( $base_collection ) ),
+ pref_row_implicit => $cds_with_impl_artist->next,
schema => $schema,
storage => $storage,
sql_maker => $storage->sql_maker,
dbh => $storage->_dbh,
+ fresh_pager => $rs->page(5)->pager,
+ pager => $pager,
);
if ($has_dt) {
$base_collection->{"DBI handle $_"} = $_;
}
- if ( DBIx::Class::Optional::Dependencies->req_ok_for ('test_leaks') ) {
- Test::Memory::Cycle::memory_cycle_ok ($base_collection, 'No cycles in the object collection')
+ 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;
+ }
}
- for (keys %$base_collection) {
- $weak_registry->{"basic $_"} = { weakref => $base_collection->{$_} };
- weaken $weak_registry->{"basic $_"}{weakref};
- }
+ populate_weakregistry ($weak_registry, $base_collection->{$_}, "basic $_")
+ for keys %$base_collection;
}
# check that "phantom-chaining" works - we never lose track of the original $schema
{
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 },
sub { shift->result_source },
sub { shift->schema },
sub { shift->clone },
- sub { shift->resultset('Artist') },
+ sub { shift->resultset('CD') },
+ sub { shift->next },
+ sub { shift->artist },
+ sub { shift->search_related('cds') },
sub { shift->next },
+ sub { shift->search_related('artist') },
sub { shift->result_source },
sub { shift->resultset },
sub { shift->create({ name => 'detached' }) },
sub { shift->delete },
sub { shift->insert },
) {
- $phantom = $_->($phantom);
-
- my $slot = (sprintf 'phantom %s=%s(0x%x)', # so we don't trigger stringification
- ref $phantom,
- reftype $phantom,
- refaddr $phantom,
- );
- $weak_registry->{$slot} = $phantom;
- weaken $weak_registry->{$slot};
+ $phantom = populate_weakregistry ( $weak_registry, scalar $_->($phantom) );
}
ok( $phantom->in_storage, 'Properly deleted/reinserted' );
# T::B 2.0 has result objects and other fancyness
delete $weak_registry->{$slot};
}
+ 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};
}
}
-
-# FIXME
-# For reasons I can not yet fully understand the table() god-method (located in
-# ::ResultSourceProxy::Table) attaches an actual source instance to each class
-# as virtually *immortal* class-data.
-# For now just ignore these instances manually but there got to be a saner way
-for ( map { $_->result_source_instance } (
+# 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
-)) {
- delete $weak_registry->{$_};
-}
+) {
+ # 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" );
-# FIXME
-# same problem goes for the schema - its classdata contains live result source
-# objects, which to add insult to the injury are *different* instances from the
-# ones we ignored above
-for ( values %{DBICTest::Schema->source_registrations || {}} ) {
- delete $weak_registry->{$_};
+ # ignore it
+ delete $weak_registry->{$rs_class->result_source_instance};
}
-for my $slot (sort keys %$weak_registry) {
-
- ok (! defined $weak_registry->{$slot}{weakref}, "No leaks of $slot") or do {
- my $diag = '';
+# 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 || {}} ) {
- $diag .= Devel::FindRef::track ($weak_registry->{$slot}{weakref}, 20) . "\n"
- if ( $ENV{TEST_VERBOSE} && eval { require Devel::FindRef });
+ my $SV = svref_2object(DBICTest::Schema->source($moniker));
+ is( $SV->REFCNT, 1, "Source instance registered under DBICTest::Schema as $moniker referenced exactly once" );
- if (my $stack = $weak_registry->{$slot}{strace}) {
- $diag .= " Reference first seen$stack";
- }
+ delete $weak_registry->{DBICTest::Schema->source($moniker)};
+}
- diag $diag if $diag;
- };
+# 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:
+#
+# $cond_object --> result_source --> schema --> storage --> $dbh --> {cached_kids}
+# ^ /
+# \-------- 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);
}
+assert_empty_weakregistry ($weak_registry);
# we got so far without a failure - this is a good thing
# now let's try to rerun this script under a "persistent" environment