Switch most remaining debug-hooks to $dbictest_schema->is_executed_querycount()

[dbsrgits/DBIx-Class.git] / t / prefetch / manual.t

use strict;
use warnings;

use Test::More;
use Test::Deep;
use Test::Warn;
use Test::Exception;
use lib qw(t/lib);
use DBICTest;

delete $ENV{DBIC_COLUMNS_INCLUDE_FILTER_RELS};

my $schema = DBICTest->init_schema(no_populate => 1);

$schema->resultset('Artist')->create({ name => 'JMJ', cds => [{
  title => 'Magnetic Fields',
  year => 1981,
  genre => { name => 'electro' },
  tracks => [
    { title => 'm1' },
    { title => 'm2' },
    { title => 'm3' },
    { title => 'm4' },
  ],
} ] });

$schema->resultset('CD')->create({
  title => 'Equinoxe',
  year => 1978,
  artist => { name => 'JMJ' },
  genre => { name => 'electro' },
  tracks => [
    { title => 'e1' },
    { title => 'e2' },
    { title => 'e3' },
  ],
  single_track => {
    title => 'o1',
    cd => {
      title => 'Oxygene',
      year => 1976,
      artist => { name => 'JMJ' },
      tracks => [
        { title => 'o2', position => 2},  # the position should not be here, bug in MC
      ],
    },
  },
});

my $rs = $schema->resultset ('CD')->search ({}, {
  join => [ 'tracks', { single_track => { cd => { artist => { cds => 'tracks' } } } }  ],
  collapse => 1,
  columns => [
    { 'year'                                    => 'me.year' },               # non-unique
    { 'genreid'                                 => 'me.genreid' },            # nullable
    { 'tracks.title'                            => 'tracks.title' },          # non-unique (no me.id)
    { 'single_track.cd.artist.cds.cdid'         => 'cds.cdid' },              # to give uniquiness to ...tracks.title below
    { 'single_track.cd.artist.artistid'         => 'artist.artistid' },       # uniqufies entire parental chain
    { 'single_track.cd.artist.cds.year'         => 'cds.year' },              # non-unique
    { 'single_track.cd.artist.cds.genreid'      => 'cds.genreid' },           # nullable
    { 'single_track.cd.artist.cds.tracks.title' => 'tracks_2.title' },        # unique when combined with ...cds.cdid above
    { 'latest_cd'                     => \ "(SELECT MAX(year) FROM cd)" },    # random function
    { 'title'                                   => 'me.title' },              # uniquiness for me
    { 'artist'                                  => 'me.artist' },             # uniquiness for me
  ],
  order_by => [{ -desc => 'cds.year' }, { -desc => 'me.title'}, 'tracks.title', 'tracks_2.title' ],
});

my $hri_rs = $rs->search({}, { result_class => 'DBIx::Class::ResultClass::HashRefInflator' });

cmp_deeply (
  [$hri_rs->all],
  [
    { artist => 1, genreid => 1, latest_cd => 1981, title => "Equinoxe", year => 1978,
      single_track => {
        cd => {
          artist => { artistid => 1, cds => [
            { cdid => 1, genreid => 1, year => 1981, tracks => [
              { title => "m1" },
              { title => "m2" },
              { title => "m3" },
              { title => "m4" },
            ]},
            { cdid => 3, genreid => 1, year => 1978, tracks => [
              { title => "e1" },
              { title => "e2" },
              { title => "e3" },
            ]},
            { cdid => 2, genreid => undef, year => 1976, tracks => [
              { title => "o1" },
              { title => "o2" },
            ]},
          ]},
        },
      },
      tracks => [
        { title => "e1" },
        { title => "e2" },
        { title => "e3" },
      ],
    },
    {
      artist => 1, genreid => undef, latest_cd => 1981, title => "Oxygene", year => 1976, single_track => undef,
      tracks => [
        { title => "o1" },
        { title => "o2" },
      ],
    },
    {
      artist => 1, genreid => 1, latest_cd => 1981, title => "Magnetic Fields", year => 1981, single_track => undef,
      tracks => [
        { title => "m1" },
        { title => "m2" },
        { title => "m3" },
        { title => "m4" },
      ],
    },
  ],
  'W00T, manual prefetch with collapse works'
);

lives_ok { my $dummy = $rs;  warnings_exist {

##############
### This is a bunch of workarounds for deprecated behavior - delete entire block when fixed
  my $cd_obj = ($rs->all)[0]->single_track->cd;
  my $art_obj = $cd_obj->artist;

  my $empty_single_columns = {
    cd => undef
  };
  my $empty_single_inflated_columns = {
    cd => $cd_obj
  };
  my $empty_cd_columns = {
    artist => $art_obj->artistid
  };
  my $empty_cd_inflated_columns = {
    artist => $art_obj
  };

  {
    local $TODO = "Returning prefetched 'filter' rels as part of get_columns/get_inflated_columns is deprecated";
    is_deeply($_, {}) for (
      $empty_single_columns, $empty_single_inflated_columns, $empty_cd_columns, $empty_cd_inflated_columns
    );
  }
##############


### this tests the standard root -> single -> filter ->filter
  my ($row) = $rs->all; # don't trigger order warnings

  is_deeply(
    { $row->single_track->get_columns },
    $empty_single_columns,
    "No unexpected columns available on intermediate 'single' rel with a chained 'filter' prefetch",
  );

  is_deeply(
    { $row->single_track->get_inflated_columns },
    $empty_single_inflated_columns,
    "No unexpected inflated columns available on intermediate 'single' rel with a chained 'filter' prefetch",
  );

  is_deeply(
    { $row->single_track->cd->get_columns },
    $empty_cd_columns,
    "No unexpected columns available on intermediate 'single' rel with 2x chained 'filter' prefetch",
  );

  is_deeply(
    { $row->single_track->cd->get_inflated_columns },
    $empty_cd_inflated_columns,
    "No unexpected inflated columns available on intermediate 'single' rel with 2x chained 'filter' prefetch",
  );

### also try a different arangement root -> single -> single ->filter
  ($row) = $rs->result_source->resultset->search({ 'artist.artistid' => 1 }, {
    join => { single_track => { disc => { artist => 'cds' } } },
    '+columns' => {
      'single_track.disc.artist.artistid' => 'artist.artistid',
      'single_track.disc.artist.cds.cdid' => 'cds.cdid',
    },
    collapse => 1,
  })->all;

  is_deeply(
    { $row->single_track->get_columns },
    {},
    "No unexpected columns available on intermediate 'single' rel with a chained 'single' prefetch",
  );

  is_deeply(
    { $row->single_track->get_inflated_columns },
    {},
    "No unexpected inflated columns available on intermediate 'single' rel with a chained 'single' prefetch",
  );

  is_deeply(
    { $row->single_track->disc->get_columns },
    $empty_cd_columns,
    "No unexpected columns available on intermediate 'single' rel with chained 'single' and chained 'filter' prefetch",
  );

  is_deeply(
    { $row->single_track->disc->get_inflated_columns },
    $empty_cd_inflated_columns,
    "No unexpected inflated columns available on intermediate 'single' rel with chained 'single' and chained 'filter' prefetch",
  );

} [
  qr/\QReturning primary keys of prefetched 'filter' rels as part of get_columns()/,
  qr/\QUnable to deflate 'filter'-type relationship 'cd' (related object primary key not retrieved)/,
  qr/\QReturning prefetched 'filter' rels as part of get_inflated_columns()/,
  qr/\QReturning primary keys of prefetched 'filter' rels as part of get_columns()/,
  qr/\QReturning prefetched 'filter' rels as part of get_inflated_columns()/,
  qr/\QReturning primary keys of prefetched 'filter' rels as part of get_columns()/,
  qr/\QReturning prefetched 'filter' rels as part of get_inflated_columns()/,
], 'expected_warnings'
} 'traversing prefetch chain with empty intermediates works';

# multi-has_many with underdefined root, with rather random order
$rs = $schema->resultset ('CD')->search ({}, {
  join => [ 'tracks', { single_track => { cd => { artist => { cds => 'tracks' } } } }  ],
  collapse => 1,
  columns => [
    { 'single_track.trackid'                    => 'single_track.trackid' },  # definitive link to root from 1:1:1:1:M:M chain
    { 'year'                                    => 'me.year' },               # non-unique
    { 'tracks.cd'                               => 'tracks.cd' },             # \ together both uniqueness for second multirel
    { 'tracks.title'                            => 'tracks.title' },          # / and definitive link back to root
    { 'single_track.cd.artist.cds.cdid'         => 'cds.cdid' },              # to give uniquiness to ...tracks.title below
    { 'single_track.cd.artist.cds.year'         => 'cds.year' },              # non-unique
    { 'single_track.cd.artist.artistid'         => 'artist.artistid' },       # uniqufies entire parental chain
    { 'single_track.cd.artist.cds.genreid'      => 'cds.genreid' },           # nullable
    { 'single_track.cd.artist.cds.tracks.title' => 'tracks_2.title' },        # unique when combined with ...cds.cdid above
  ],
});

for (1..3) {
  $rs->create({ artist => 1, year => 1977, title => "fuzzy_$_" });
}

my $rs_random = $rs->search({}, { order_by => \ 'RANDOM()' });
is ($rs_random->count, 6, 'row count matches');

if ($ENV{TEST_VERBOSE}) {
 my @lines = (
    [ "What are we actually trying to collapse (Select/As, tests below will see a *DIFFERENT* random order):" ],
    [ map { my $s = $_; $s =~ s/single_track\./sngl_tr./; $s } @{$rs_random->{_attrs}{select} } ],
    $rs_random->{_attrs}{as},
    [ "-" x 159 ],
    $rs_random->cursor->all,
  );

  diag join ' # ', map { sprintf '% 15s', (defined $_ ? $_ : 'NULL') } @$_
    for @lines;
}

$schema->is_executed_querycount( sub {
  for my $use_next (0, 1) {
    my @random_cds;
    my $rs_r = $rs_random;
    if ($use_next) {
      warnings_exist {
        while (my $o = $rs_r->next) {
          push @random_cds, $o;
        }
      } qr/performed an eager cursor slurp underneath/,
      'Warned on auto-eager cursor';
    }
    else {
      @random_cds = $rs_r->all;
    }

    is (@random_cds, 6, 'object count matches');

    for my $cd (@random_cds) {
      if ($cd->year == 1977) {
        is( scalar $cd->tracks, 0, 'no tracks on 1977 cd' );
        is( $cd->single_track, undef, 'no single_track on 1977 cd' );
      }
      elsif ($cd->year == 1976) {
        is( scalar $cd->tracks, 2, 'Two tracks on 1976 cd' );
        like( $_->title, qr/^o\d/, "correct title" )
          for $cd->tracks;
        is( $cd->single_track, undef, 'no single_track on 1976 cd' );
      }
      elsif ($cd->year == 1981) {
        is( scalar $cd->tracks, 4, 'Four tracks on 1981 cd' );
        like( $_->title, qr/^m\d/, "correct title" )
          for $cd->tracks;
        is( $cd->single_track, undef, 'no single_track on 1981 cd' );
      }
      elsif ($cd->year == 1978) {
        is( scalar $cd->tracks, 3, 'Three tracks on 1978 cd' );
        like( $_->title, qr/^e\d/, "correct title" )
          for $cd->tracks;
        ok( defined $cd->single_track, 'single track prefetched on 1987 cd' );
        is( $cd->single_track->cd->artist->id, 1, 'Single_track->cd->artist prefetched on 1978 cd' );
        is( scalar $cd->single_track->cd->artist->cds, 6, '6 cds prefetched on artist' );
      }
    }
  }
}, 2, "Only two queries for two prefetch calls total");

# can't cmp_deeply a random set - need *some* order
my $ord_rs = $rs->search({}, {
  order_by => [ 'tracks_2.title', 'tracks.title', 'cds.cdid', \ 'RANDOM()' ],
  result_class => 'DBIx::Class::ResultClass::HashRefInflator',
});
my @hris_all = sort { $a->{year} cmp $b->{year} } $ord_rs->all;
is (@hris_all, 6, 'hri count matches' );

my $iter_rs = $rs->search({}, {
  order_by => [ 'me.year', 'me.cdid', 'tracks_2.title', 'tracks.title', 'cds.cdid', \ 'RANDOM()' ],
  result_class => 'DBIx::Class::ResultClass::HashRefInflator',
});
my @hris_iter;
while (my $r = $iter_rs->next) {
  push @hris_iter, $r;
}

cmp_deeply(
  \@hris_iter,
  \@hris_all,
  'Iteration works correctly',
);

my @hri_contents = (
  { year => 1976, single_track => undef, tracks => [
    { cd => 2, title => "o1" },
    { cd => 2, title => "o2" },
  ]},
  { year => 1977, single_track => undef, tracks => [] },
  { year => 1977, single_track => undef, tracks => [] },
  { year => 1977, single_track => undef, tracks => [] },
  {
    year => 1978,
    single_track => {
      trackid => 6,
      cd => {
        artist => {
          artistid => 1, cds => [
            { cdid => 4, genreid => undef, year => 1977, tracks => [] },
            { cdid => 5, genreid => undef, year => 1977, tracks => [] },
            { cdid => 6, genreid => undef, year => 1977, tracks => [] },
            { cdid => 3, genreid => 1, year => 1978, tracks => [
              { title => "e1" },
              { title => "e2" },
              { title => "e3" },
            ]},
            { cdid => 1, genreid => 1, year => 1981, tracks => [
              { title => "m1" },
              { title => "m2" },
              { title => "m3" },
              { title => "m4" },
            ]},
            { cdid => 2, genreid => undef, year => 1976, tracks => [
              { title => "o1" },
              { title => "o2" },
            ]},
          ]
        },
      },
    },
    tracks => [
      { cd => 3, title => "e1" },
      { cd => 3, title => "e2" },
      { cd => 3, title => "e3" },
    ],
  },
  { year => 1981, single_track => undef, tracks => [
    { cd => 1, title => "m1" },
    { cd => 1, title => "m2" },
    { cd => 1, title => "m3" },
    { cd => 1, title => "m4" },
  ]},
);

cmp_deeply (\@hris_all, \@hri_contents, 'W00T, multi-has_many manual underdefined root prefetch with collapse works');

cmp_deeply(
  $rs->search({}, {
    order_by => [ 'me.year', 'tracks_2.title', 'tracks.title', 'cds.cdid', { -desc => 'name' } ],
    rows => 4,
    offset => 2,
  })->all_hri,
  [ @hri_contents[2..5] ],
  'multi-has_many prefetch with limit works too',
);

# left-ordered real iterator
$rs = $rs->search({}, { order_by => [ 'me.year', 'me.cdid', \ 'RANDOM()' ] });
my @objs_iter;
while (my $r = $rs->next) {
  push @objs_iter, $r;
}

for my $i (0 .. $#objs_iter) {
  is ($objs_iter[$i]->year, $hris_all[$i]{year}, "Expected year on object $i" );
  is (
    (defined $objs_iter[$i]->single_track),
    (defined $hris_all[$i]{single_track}),
    "Expected single relation on object $i"
  );
}

$rs = $schema->resultset('Artist')->search({}, {
  join => 'cds',
  columns => ['cds.title', 'cds.artist' ],
  collapse => 1,
  order_by => [qw( me.name cds.title )],
});

$rs->create({ name => "${_}_cdless" })
  for (qw( Z A ));

cmp_deeply (
  $rs->all_hri,
  [
    { cds => [] },
    { cds => [
      { artist => 1, title => "Equinoxe" },
      { artist => 1, title => "Magnetic Fields" },
      { artist => 1, title => "Oxygene" },
      { artist => 1, title => "fuzzy_1" },
      { artist => 1, title => "fuzzy_2" },
      { artist => 1, title => "fuzzy_3" },
    ] },
    { cds => [] },
  ],
  'Expected HRI of 1:M with empty root selection',
);

done_testing;