d0b8e6cc694cc17bbd75eb6c95ab4909e5a0c315
[dbsrgits/DBIx-Class.git] / t / prefetch / grouped.t
1 use strict;
2 use warnings;
3
4 use Test::More;
5 use Test::Exception;
6
7 use lib qw(t/lib);
8 use DBICTest;
9 use DBIC::SqlMakerTest;
10
11 my $schema = DBICTest->init_schema();
12 my $sdebug = $schema->storage->debug;
13
14 my $cd_rs = $schema->resultset('CD')->search (
15   { 'tracks.cd' => { '!=', undef } },
16   { prefetch => 'tracks' },
17 );
18
19 # Database sanity check
20 is($cd_rs->count, 5, 'CDs with tracks count');
21 for ($cd_rs->all) {
22   is ($_->tracks->count, 3, '3 tracks for CD' . $_->id );
23 }
24
25 # Test a belongs_to prefetch of a has_many
26 {
27   my $track_rs = $schema->resultset ('Track')->search (
28     { 'me.cd' => { -in => [ $cd_rs->get_column ('cdid')->all ] } },
29     {
30       select => [
31         'me.cd',
32         { count => 'me.trackid' },
33       ],
34       as => [qw/
35         cd
36         track_count
37       /],
38       group_by => [qw/me.cd/],
39       prefetch => 'cd',
40     },
41   );
42
43   # this used to fuck up ->all, do not remove!
44   ok ($track_rs->first, 'There is stuff in the rs');
45
46   is($track_rs->count, 5, 'Prefetched count with groupby');
47   is($track_rs->all, 5, 'Prefetched objects with groupby');
48
49   {
50     my $query_cnt = 0;
51     $schema->storage->debugcb ( sub { $query_cnt++ } );
52     $schema->storage->debug (1);
53
54     while (my $collapsed_track = $track_rs->next) {
55       my $cdid = $collapsed_track->get_column('cd');
56       is($collapsed_track->get_column('track_count'), 3, "Correct count of tracks for CD $cdid" );
57       ok($collapsed_track->cd->title, "Prefetched title for CD $cdid" );
58     }
59
60     is ($query_cnt, 1, 'Single query on prefetched titles');
61     $schema->storage->debugcb (undef);
62     $schema->storage->debug ($sdebug);
63   }
64
65   # Test sql by hand, as the sqlite db will simply paper over
66   # improper group/select combinations
67   #
68   is_same_sql_bind (
69     $track_rs->count_rs->as_query,
70     '(
71       SELECT COUNT( * )
72         FROM (
73           SELECT me.cd
74             FROM track me
75             JOIN cd cd ON cd.cdid = me.cd
76           WHERE ( me.cd IN ( ?, ?, ?, ?, ? ) )
77           GROUP BY me.cd
78         )
79       me
80     )',
81     [ map { [ 'me.cd' => $_] } ($cd_rs->get_column ('cdid')->all) ],
82     'count() query generated expected SQL',
83   );
84
85   is_same_sql_bind (
86     $track_rs->as_query,
87     '(
88       SELECT me.cd, me.track_count, cd.cdid, cd.artist, cd.title, cd.year, cd.genreid, cd.single_track
89         FROM (
90           SELECT me.cd, COUNT (me.trackid) AS track_count
91             FROM track me
92             JOIN cd cd ON cd.cdid = me.cd
93           WHERE ( me.cd IN ( ?, ?, ?, ?, ? ) )
94           GROUP BY me.cd
95           ) me
96         JOIN cd cd ON cd.cdid = me.cd
97       WHERE ( me.cd IN ( ?, ?, ?, ?, ? ) )
98     )',
99     [ map { [ 'me.cd' => $_] } ( ($cd_rs->get_column ('cdid')->all) x 2 ) ],
100     'next() query generated expected SQL',
101   );
102
103
104   # add an extra track to one of the cds, and then make sure we can get it on top
105   # (check if limit works)
106   my $top_cd = $cd_rs->slice (1,1)->next;
107   $top_cd->create_related ('tracks', {
108     title => 'over the top',
109   });
110
111   my $top_cd_collapsed_track = $track_rs->search ({}, {
112     rows => 2,
113     order_by => [
114       { -desc => 'track_count' },
115     ],
116   });
117
118   is ($top_cd_collapsed_track->count, 2);
119
120   is (
121     $top_cd->title,
122     $top_cd_collapsed_track->first->cd->title,
123     'Correct collapsed track with prefetched CD returned on top'
124   );
125 }
126
127 # test a has_many/might_have prefetch at the same level
128 # Note that one of the CDs now has 4 tracks instead of 3
129 {
130   my $most_tracks_rs = $schema->resultset ('CD')->search (
131     {
132       'me.cdid' => { '!=' => undef },  # duh - this is just to test WHERE
133     },
134     {
135       prefetch => [qw/tracks liner_notes/],
136       select => ['me.cdid', { count => 'tracks.trackid' }, { max => 'tracks.trackid', -as => 'maxtr'} ],
137       as => [qw/cdid track_count max_track_id/],
138       group_by => 'me.cdid',
139       order_by => [ { -desc => 'track_count' }, { -asc => 'maxtr' } ],
140       rows => 2,
141     }
142   );
143
144   is_same_sql_bind (
145     $most_tracks_rs->count_rs->as_query,
146     '(
147       SELECT COUNT( * )
148         FROM (
149           SELECT me.cdid
150             FROM cd me
151           WHERE ( me.cdid IS NOT NULL )
152           GROUP BY me.cdid
153           LIMIT 2
154         ) me
155     )',
156     [],
157     'count() query generated expected SQL',
158   );
159
160   is_same_sql_bind (
161     $most_tracks_rs->as_query,
162     '(
163       SELECT  me.cdid, me.track_count, me.maxtr,
164               tracks.trackid, tracks.cd, tracks.position, tracks.title, tracks.last_updated_on, tracks.last_updated_at,
165               liner_notes.liner_id, liner_notes.notes
166         FROM (
167           SELECT me.cdid, COUNT( tracks.trackid ) AS track_count, MAX( tracks.trackid ) AS maxtr
168             FROM cd me
169             LEFT JOIN track tracks ON tracks.cd = me.cdid
170           WHERE ( me.cdid IS NOT NULL )
171           GROUP BY me.cdid
172           ORDER BY track_count DESC, maxtr ASC
173           LIMIT 2
174         ) me
175         LEFT JOIN track tracks ON tracks.cd = me.cdid
176         LEFT JOIN liner_notes liner_notes ON liner_notes.liner_id = me.cdid
177       WHERE ( me.cdid IS NOT NULL )
178       ORDER BY track_count DESC, maxtr ASC, tracks.cd
179     )',
180     [],
181     'next() query generated expected SQL',
182   );
183
184   is ($most_tracks_rs->count, 2, 'Limit works');
185   my $top_cd = $most_tracks_rs->first;
186   is ($top_cd->id, 2, 'Correct cd fetched on top'); # 2 because of the slice(1,1) earlier
187
188   my $query_cnt = 0;
189   $schema->storage->debugcb ( sub { $query_cnt++ } );
190   $schema->storage->debug (1);
191
192   is ($top_cd->get_column ('track_count'), 4, 'Track count fetched correctly');
193   is ($top_cd->tracks->count, 4, 'Count of prefetched tracks rs still correct');
194   is ($top_cd->tracks->all, 4, 'Number of prefetched track objects still correct');
195   is (
196     $top_cd->liner_notes->notes,
197     'Buy Whiskey!',
198     'Correct liner pre-fetched with top cd',
199   );
200
201   is ($query_cnt, 0, 'No queries executed during prefetched data access');
202   $schema->storage->debugcb (undef);
203   $schema->storage->debug ($sdebug);
204 }
205
206 # make sure that distinct still works
207 {
208   my $rs = $schema->resultset("CD")->search({}, {
209     prefetch => 'tags',
210     order_by => 'cdid',
211     distinct => 1,
212   });
213
214   is_same_sql_bind (
215     $rs->as_query,
216     '(
217       SELECT me.cdid, me.artist, me.title, me.year, me.genreid, me.single_track,
218              tags.tagid, tags.cd, tags.tag
219         FROM (
220           SELECT me.cdid, me.artist, me.title, me.year, me.genreid, me.single_track
221             FROM cd me
222           GROUP BY me.cdid, me.artist, me.title, me.year, me.genreid, me.single_track
223           ORDER BY cdid
224         ) me
225         LEFT JOIN tags tags ON tags.cd = me.cdid
226       ORDER BY cdid, tags.cd, tags.tag
227     )',
228     [],
229     'Prefetch + distinct resulted in correct group_by',
230   );
231
232   is ($rs->all, 5, 'Correct number of CD objects');
233   is ($rs->count, 5, 'Correct count of CDs');
234 }
235
236 # RT 47779, test group_by as a scalar ref
237 {
238   my $track_rs = $schema->resultset ('Track')->search (
239     { 'me.cd' => { -in => [ $cd_rs->get_column ('cdid')->all ] } },
240     {
241       select => [
242         'me.cd',
243         { count => 'me.trackid' },
244       ],
245       as => [qw/
246         cd
247         track_count
248       /],
249       group_by => \'SUBSTR(me.cd, 1, 1)',
250       prefetch => 'cd',
251     },
252   );
253
254   is_same_sql_bind (
255     $track_rs->count_rs->as_query,
256     '(
257       SELECT COUNT( * )
258         FROM (
259           SELECT SUBSTR(me.cd, 1, 1)
260             FROM track me
261             JOIN cd cd ON cd.cdid = me.cd
262           WHERE ( me.cd IN ( ?, ?, ?, ?, ? ) )
263           GROUP BY SUBSTR(me.cd, 1, 1)
264         )
265       me
266     )',
267     [ map { [ 'me.cd' => $_] } ($cd_rs->get_column ('cdid')->all) ],
268     'count() query generated expected SQL',
269   );
270 }
271
272 {
273     my $cd_rs = $schema->resultset('CD')->search({}, {
274             distinct => 1,
275             join     => [qw/ tracks /],
276             prefetch => [qw/ artist /],
277         });
278     is($cd_rs->count, 5, 'complex prefetch + non-prefetching has_many join count correct');
279     is($cd_rs->all, 5, 'complex prefetch + non-prefetching has_many join number of objects correct');
280
281     # make sure join tracks was thrown out
282     is_same_sql_bind (
283       $cd_rs->as_query,
284       '(
285         SELECT me.cdid, me.artist, me.title, me.year, me.genreid, me.single_track,
286                artist.artistid, artist.name, artist.rank, artist.charfield
287           FROM (
288             SELECT me.cdid, me.artist, me.title, me.year, me.genreid, me.single_track
289               FROM cd me
290               JOIN artist artist ON artist.artistid = me.artist
291             GROUP BY me.cdid, me.artist, me.title, me.year, me.genreid, me.single_track
292           ) me
293           JOIN artist artist ON artist.artistid = me.artist
294       )',
295       [],
296     );
297
298
299
300     # try the same as above, but add a condition so the tracks join can not be thrown away
301     my $cd_rs2 = $cd_rs->search ({ 'tracks.title' => { '!=' => 'ugabuganoexist' } });
302     is($cd_rs2->count, 5, 'complex prefetch + non-prefetching restricted has_many join count correct');
303     is($cd_rs2->all, 5, 'complex prefetch + non-prefetching restricted has_many join number of objects correct');
304
305     # the outer group_by seems like a necessary evil, if someone can figure out how to take it away
306     # without breaking compat - be my guest
307     is_same_sql_bind (
308       $cd_rs2->as_query,
309       '(
310         SELECT me.cdid, me.artist, me.title, me.year, me.genreid, me.single_track,
311                artist.artistid, artist.name, artist.rank, artist.charfield
312           FROM (
313             SELECT me.cdid, me.artist, me.title, me.year, me.genreid, me.single_track
314               FROM cd me
315               LEFT JOIN track tracks ON tracks.cd = me.cdid
316               JOIN artist artist ON artist.artistid = me.artist
317             WHERE ( tracks.title != ? )
318             GROUP BY me.cdid, me.artist, me.title, me.year, me.genreid, me.single_track
319           ) me
320           LEFT JOIN track tracks ON tracks.cd = me.cdid
321           JOIN artist artist ON artist.artistid = me.artist
322         WHERE ( tracks.title != ? )
323         GROUP BY me.cdid, me.artist, me.title, me.year, me.genreid, me.single_track,
324                  artist.artistid, artist.name, artist.rank, artist.charfield
325       )',
326       [ map { [ 'tracks.title' => 'ugabuganoexist' ] } (1 .. 2) ],
327     );
328 }
329
330 {
331     my $rs = $schema->resultset('CD')->search({},
332         {
333            '+select' => [{ count => 'tags.tag' }],
334            '+as' => ['test_count'],
335            prefetch => ['tags'],
336            distinct => 1,
337            order_by => {'-asc' => 'tags.tag'},
338            rows => 1
339         }
340     );
341     is_same_sql_bind($rs->as_query, q{
342         (SELECT me.cdid, me.artist, me.title, me.year, me.genreid, me.single_track, me.test_count, tags.tagid, tags.cd, tags.tag
343           FROM (SELECT me.cdid, me.artist, me.title, me.year, me.genreid, me.single_track, COUNT( tags.tag ) AS test_count
344                 FROM cd me LEFT JOIN tags tags ON tags.cd = me.cdid
345             GROUP BY me.cdid, me.artist, me.title, me.year, me.genreid, me.single_track, tags.tag
346             ORDER BY tags.tag ASC LIMIT 1)
347             me
348           LEFT JOIN tags tags ON tags.cd = me.cdid
349          ORDER BY tags.tag ASC, tags.cd, tags.tag
350         )
351     }, []);
352 }
353
354 done_testing;