-
Notifications
You must be signed in to change notification settings - Fork 151
/
52leaks.t
508 lines (416 loc) · 15.7 KB
/
52leaks.t
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
# 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/
} if ($ENV{DBICTEST_IN_PERSISTENT_ENV});
# the persistent environments run with this flag first to see if
# we will run at all (e.g. it will fail if $^X doesn't match)
exit 0 if $ENV{DBICTEST_PERSISTENT_ENV_BAIL_EARLY};
# Do the override as early as possible so that CORE::bless doesn't get compiled away
# We will replace $bless_override only if we are in author mode
my $bless_override;
BEGIN {
$bless_override = sub {
CORE::bless( $_[0], (@_ > 1) ? $_[1] : caller() );
};
*CORE::GLOBAL::bless = sub { goto $bless_override };
}
use strict;
use warnings;
use Test::More;
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);
}
close $TB->output;
open ($TB->output, '>&', *STDOUT);
}
# so done_testing can work on every persistent pass
$TB->reset;
}
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;
}
# this is what holds all weakened refs to be checked for leakage
my $weak_registry = {};
# whether or to invoke IC::DT
my $has_dt;
# Skip the heavy-duty leak tracing when just doing an install
unless (DBICTest::RunMode->is_plain) {
# redefine the bless override so that we can catch each and every object created
no warnings qw/redefine once/;
no strict qw/refs/;
$bless_override = sub {
my $obj = CORE::bless(
$_[0], (@_ > 1) ? $_[1] : do {
my ($class, $fn, $line) = caller();
fail ("bless() of $_[0] into $class without explicit class specification at $fn line $line")
if $class =~ /^ (?: DBIx\:\:Class | DBICTest ) /x;
$class;
}
);
# 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::/;
# weaken immediately to avoid weird side effects
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 (&;@) {
populate_weakregistry( $weak_registry, $_[0] );
goto $orig;
}
}
# Some modules are known to install singletons on-load
# Load them and empty the registry
# this loads the DT armada
$has_dt = DBIx::Class::Optional::Dependencies->req_ok_for('test_dt_sqlite');
require Errno;
require DBI;
require DBD::SQLite;
require FileHandle;
require Moo;
%$weak_registry = ();
}
my @compose_ns_classes;
{
use_ok ('DBICTest');
my $schema = DBICTest->init_schema;
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');
# txn_do to invoke more codepaths
my ($mc_row_obj, $pager, $pager_explicit_count) = $schema->txn_do (sub {
my $artist = $schema->resultset('Artist')->create ({
name => 'foo artist',
cds => [{
title => 'foo cd',
year => 1984,
tracks => [
{ title => 't1' },
{ title => 't2' },
],
genre => { name => 'mauve' },
}],
});
my $pg = $rs->search({}, { rows => 1})->page(2)->pager;
my $pg_wcount = $rs->page(4)->pager->total_entries (66);
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
is ($pager_explicit_count->last_page, 7, 'Correct last page');
# do some population (invokes some extra codepaths)
# also exercise the guard code and the manual txn control
{
my $guard = $schema->txn_scope_guard;
# populate with bindvars
$rs->populate([{ name => 'James Bound' }]);
$guard->commit;
$schema->txn_begin;
# populate mixed
$rs->populate([{ name => 'James Rebound', rank => \ '11' }]);
$schema->txn_commit;
$schema->txn_begin;
# and without bindvars
$rs->populate([{ name => \ '"James Unbound"' }]);
$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,
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 = (
%$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) {
my $rs = $base_collection->{icdt_rs} = $schema->resultset('Event');
my $now = DateTime->now;
for (1..5) {
$base_collection->{"icdt_row_$_"} = $rs->create({
created_on => DateTime->new(year => 2011, month => 1, day => $_, time_zone => "-0${_}00" ),
starts_at => $now->clone->add(days => $_),
});
}
# re-search
my @dummy = $rs->all;
}
# dbh's are created in XS space, so pull them separately
for ( grep { defined } map { @{$_->{ChildHandles}} } values %{ {DBI->installed_drivers()} } ) {
$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;
}
# check that "phantom-chaining" works - we never lose track of the original $schema
# and have access to the entire tree without leaking anything
{
my $phantom;
for (
sub { DBICTest->init_schema( sqlite_use_file => 0 ) },
sub { shift->source('Artist') },
sub { shift->resultset },
sub { shift->result_source },
sub { shift->schema },
sub { shift->resultset('Artist') },
sub { shift->find_or_create({ name => 'detachable' }) },
sub { shift->result_source },
sub { shift->schema },
sub { shift->clone },
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->update({ name => 'reattached' }) },
sub { shift->discard_changes },
sub { shift->delete },
sub { shift->insert },
) {
$phantom = populate_weakregistry ( $weak_registry, scalar $_->($phantom) );
}
ok( $phantom->in_storage, 'Properly deleted/reinserted' );
is( $phantom->name, 'reattached', 'Still correct name' );
}
# Naturally we have some exceptions
my $cleared;
for my $slot (keys %$weak_registry) {
if ($slot =~ /^Test::Builder/) {
# 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};
}
elsif ($slot =~ /^Hash::Merge/) {
# 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}}++;
}
elsif (DBIx::Class::_ENV_::INVISIBLE_DOLLAR_AT and $slot =~ /^__TxnScopeGuard__FIXUP__/) {
delete $weak_registry->{$slot}
}
elsif ($slot =~ /^DateTime::TimeZone/) {
# DT is going through a refactor it seems - let it leak zones for now
delete $weak_registry->{$slot};
}
}
# 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:
#
# $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
# 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}} ],
];
SKIP: {
skip 'Test already in a persistent loop', 1
if $ENV{DBICTEST_IN_PERSISTENT_ENV};
skip 'Main test failed - skipping persistent env tests', 1
unless $TB->is_passing;
local $ENV{DBICTEST_IN_PERSISTENT_ENV} = 1;
require IPC::Open2;
for my $type (keys %$persistence_tests) { SKIP: {
skip "$type module not found", 1
unless eval "require $type";
my @cmd = @{$persistence_tests->{$type}{cmd}};
# since PPerl is racy and sucks - just prime the "server"
{
local $ENV{DBICTEST_PERSISTENT_ENV_BAIL_EARLY} = 1;
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) {
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 $_ for (*STDIN, *STDOUT, *STDERR);
local $?; # otherwise test will inherit $? of the system()
system (@{$persistence_tests->{PPerl}{termcmd}});
}
}