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
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
|
# frozen_string_literal: true
RSpec.shared_examples 'graphql issue list request spec' do
let(:issue_ids) { graphql_dig_at(issues_data, :id) }
let(:fields) do
<<~QUERY
nodes {
#{all_graphql_fields_for('issues'.classify, excluded: ['relatedMergeRequests'])}
}
QUERY
end
it_behaves_like 'a working graphql query' do
before do
post_query
end
end
describe 'filters' do
before_all do
issue_a.assignee_ids = current_user.id
issue_b.assignee_ids = another_user.id
end
context 'when filtering by assignees' do
context 'when both assignee_username filters are provided' do
let(:issue_filter_params) do
{ assignee_username: current_user.username, assignee_usernames: [current_user.username] }
end
it 'returns a mutually exclusive param error' do
post_query
expect_graphql_errors_to_include(
'only one of [assigneeUsernames, assigneeUsername] arguments is allowed at the same time.'
)
end
end
context 'when filtering by a negated argument' do
let(:issue_filter_params) { { not: { assignee_usernames: [current_user.username] } } }
it 'returns correctly filtered issues' do
post_query
expect(issue_ids).to match_array(expected_negated_assignee_issues.map { |i| i.to_gid.to_s })
end
end
end
context 'when filtering by unioned arguments' do
context 'when filtering by assignees' do
let(:issue_filter_params) { { or: { assignee_usernames: [current_user.username, another_user.username] } } }
it 'returns correctly filtered issues' do
post_query
expect(issue_ids).to match_array([issue_a, issue_b].map { |i| i.to_gid.to_s })
end
end
context 'when filtering by labels' do
let_it_be(:label_a) { create(:label, project: issue_a.project) }
let_it_be(:label_b) { create(:label, project: issue_b.project) }
let(:issue_filter_params) { { or: { label_names: [label_a.title, label_b.title] } } }
it 'returns correctly filtered issues' do
issue_a.label_ids = label_a.id
issue_b.label_ids = label_b.id
post_graphql(query, current_user: current_user)
expect(issue_ids).to match_array([issue_a, issue_b].map { |i| i.to_gid.to_s })
end
end
context 'when argument is blank' do
let(:issue_filter_params) { { or: {} } }
it 'does not raise an error' do
post_query
expect_graphql_errors_to_be_empty
end
end
context 'when feature flag is disabled' do
let(:issue_filter_params) { { or: { assignee_usernames: [current_user.username] } } }
it 'returns an error' do
stub_feature_flags(or_issuable_queries: false)
post_query
expect_graphql_errors_to_include(
"'or' arguments are only allowed when the `or_issuable_queries` feature flag is enabled."
)
end
end
end
context 'when filtering by a blank negated argument' do
let(:issue_filter_params) { { not: {} } }
it 'does not raise an error' do
post_query
expect_graphql_errors_to_be_empty
end
end
context 'when filtering by reaction emoji' do
using RSpec::Parameterized::TableSyntax
where(:value, :issue_list) do
'thumbsup' | lazy { voted_issues }
'ANY' | lazy { voted_issues }
'any' | lazy { voted_issues }
'AnY' | lazy { voted_issues }
'NONE' | lazy { no_award_issues }
'thumbsdown' | lazy { [] }
end
with_them do
let(:issue_filter_params) { { my_reaction_emoji: value } }
let(:gids) { to_gid_list(issue_list) }
it 'returns correctly filtered issues' do
post_query
expect(issue_ids).to match_array(gids)
end
end
end
context 'when filtering by search' do
it_behaves_like 'query with a search term', [:TITLE] do
let(:search_term) { search_title_term }
let(:issuable_data) { issues_data }
let(:user) { current_user }
let(:issuable) { title_search_issue }
let(:ids) { issue_ids }
end
end
context 'when filtering by confidentiality' do
context 'when fetching confidential issues' do
let(:issue_filter_params) { { confidential: true } }
it 'returns only confidential issues' do
post_query
expect(issue_ids).to match_array(to_gid_list(confidential_issues))
end
context 'when user cannot see confidential issues' do
it 'returns an empty list' do
post_query(external_user)
expect(issue_ids).to be_empty
end
end
end
context 'when fetching non-confidential issues' do
let(:issue_filter_params) { { confidential: false } }
it 'returns only non-confidential issues' do
post_query
expect(issue_ids).to match_array(to_gid_list(non_confidential_issues))
end
context 'when user cannot see confidential issues' do
it 'returns an empty list' do
post_query(external_user)
expect(issue_ids).to match_array(to_gid_list(public_non_confidential_issues))
end
end
end
end
end
describe 'sorting and pagination' do
context 'when sorting by severity' do
let(:expected_severity_sorted_asc) { [issue_c, issue_a, issue_b, issue_e, issue_d] }
before_all do
create(:issuable_severity, issue: issue_a, severity: :unknown)
create(:issuable_severity, issue: issue_b, severity: :low)
create(:issuable_severity, issue: issue_d, severity: :critical)
create(:issuable_severity, issue: issue_e, severity: :high)
end
context 'when ascending' do
it_behaves_like 'sorted paginated query' do
let(:sort_param) { :SEVERITY_ASC }
let(:first_param) { 2 }
let(:all_records) { to_gid_list(expected_severity_sorted_asc) }
end
end
context 'when descending' do
it_behaves_like 'sorted paginated query' do
let(:sort_param) { :SEVERITY_DESC }
let(:first_param) { 2 }
let(:all_records) { to_gid_list(expected_severity_sorted_asc.reverse) }
end
end
end
context 'when sorting by priority' do
context 'when ascending' do
it_behaves_like 'sorted paginated query' do
let(:sort_param) { :PRIORITY_ASC }
let(:first_param) { 2 }
let(:all_records) { to_gid_list(expected_priority_sorted_asc) }
end
end
context 'when descending' do
it_behaves_like 'sorted paginated query' do
let(:sort_param) { :PRIORITY_DESC }
let(:first_param) { 2 }
let(:all_records) { to_gid_list(expected_priority_sorted_desc) }
end
end
end
context 'when sorting by due date' do
context 'when ascending' do
it_behaves_like 'sorted paginated query' do
let(:sort_param) { :DUE_DATE_ASC }
let(:first_param) { 2 }
let(:all_records) { to_gid_list(expected_due_date_sorted_asc) }
end
end
context 'when descending' do
it_behaves_like 'sorted paginated query' do
let(:sort_param) { :DUE_DATE_DESC }
let(:first_param) { 2 }
let(:all_records) { to_gid_list(expected_due_date_sorted_desc) }
end
end
end
context 'when sorting by relative position' do
context 'when ascending' do
it_behaves_like 'sorted paginated query', is_reversible: true do
let(:sort_param) { :RELATIVE_POSITION_ASC }
let(:first_param) { 2 }
let(:all_records) { to_gid_list(expected_relative_position_sorted_asc) }
end
end
end
context 'when sorting by label priority' do
context 'when ascending' do
it_behaves_like 'sorted paginated query' do
let(:sort_param) { :LABEL_PRIORITY_ASC }
let(:first_param) { 2 }
let(:all_records) { to_gid_list(expected_label_priority_sorted_asc) }
end
end
context 'when descending' do
it_behaves_like 'sorted paginated query' do
let(:sort_param) { :LABEL_PRIORITY_DESC }
let(:first_param) { 2 }
let(:all_records) { to_gid_list(expected_label_priority_sorted_desc) }
end
end
end
context 'when sorting by milestone due date' do
context 'when ascending' do
it_behaves_like 'sorted paginated query' do
let(:sort_param) { :MILESTONE_DUE_ASC }
let(:first_param) { 2 }
let(:all_records) { to_gid_list(expected_milestone_sorted_asc) }
end
end
context 'when descending' do
it_behaves_like 'sorted paginated query' do
let(:sort_param) { :MILESTONE_DUE_DESC }
let(:first_param) { 2 }
let(:all_records) { to_gid_list(expected_milestone_sorted_desc) }
end
end
end
end
describe 'N+1 query checks' do
let(:extra_iid_for_second_query) { issue_b.iid.to_s }
let(:search_params) { { iids: [issue_a.iid.to_s] } }
let(:issue_filter_params) { search_params }
let(:fields) do
<<~QUERY
nodes {
id
#{requested_fields}
}
QUERY
end
def execute_query
post_query
end
context 'when requesting `user_notes_count` and `user_discussions_count`' do
let(:requested_fields) { 'userNotesCount userDiscussionsCount' }
before do
create_list(:note_on_issue, 2, noteable: issue_a, project: issue_a.project)
create(:note_on_issue, noteable: issue_b, project: issue_b.project)
end
include_examples 'N+1 query check'
end
context 'when requesting `merge_requests_count`' do
let(:requested_fields) { 'mergeRequestsCount' }
before do
create_list(:merge_requests_closing_issues, 2, issue: issue_a)
create_list(:merge_requests_closing_issues, 3, issue: issue_b)
end
include_examples 'N+1 query check'
end
context 'when requesting `timelogs`' do
let(:requested_fields) { 'timelogs { nodes { timeSpent } }' }
before do
create_list(:issue_timelog, 2, issue: issue_a)
create(:issue_timelog, issue: issue_b)
end
include_examples 'N+1 query check'
end
context 'when requesting `closed_as_duplicate_of`' do
let(:requested_fields) { 'closedAsDuplicateOf { id }' }
let(:issue_a_dup) { create(:issue, project: issue_a.project) }
let(:issue_b_dup) { create(:issue, project: issue_b.project) }
before do
issue_a.update!(duplicated_to_id: issue_a_dup)
issue_b.update!(duplicated_to_id: issue_a_dup)
end
include_examples 'N+1 query check'
end
context 'when award emoji votes' do
let(:requested_fields) { 'upvotes downvotes' }
before do
create_list(:award_emoji, 2, name: 'thumbsup', awardable: issue_a)
create_list(:award_emoji, 2, name: 'thumbsdown', awardable: issue_b)
end
include_examples 'N+1 query check'
end
context 'when requesting participants' do
let(:search_params) { { iids: [issue_a.iid.to_s, issue_c.iid.to_s] } }
let(:requested_fields) { 'participants { nodes { name } }' }
before do
create(:award_emoji, :upvote, awardable: issue_a)
create(:award_emoji, :upvote, awardable: issue_b)
create(:award_emoji, :upvote, awardable: issue_c)
note_with_emoji_a = create(:note_on_issue, noteable: issue_a, project: issue_a.project)
note_with_emoji_b = create(:note_on_issue, noteable: issue_b, project: issue_b.project)
note_with_emoji_c = create(:note_on_issue, noteable: issue_c, project: issue_c.project)
create(:award_emoji, :upvote, awardable: note_with_emoji_a)
create(:award_emoji, :upvote, awardable: note_with_emoji_b)
create(:award_emoji, :upvote, awardable: note_with_emoji_c)
end
# Executes 3 extra queries to fetch participant_attrs
include_examples 'N+1 query check', threshold: 3
end
context 'when requesting labels', :use_sql_query_cache do
let(:requested_fields) { 'labels { nodes { id } }' }
let(:extra_iid_for_second_query) { same_project_issue2.iid.to_s }
let(:search_params) { { iids: [same_project_issue1.iid.to_s] } }
before do
current_project = same_project_issue1.project
project_labels = create_list(:label, 2, project: current_project)
group_labels = create_list(:group_label, 2, group: current_project.group)
same_project_issue1.update!(labels: [project_labels.first, group_labels.first].flatten)
same_project_issue2.update!(labels: [project_labels, group_labels].flatten)
end
include_examples 'N+1 query check', skip_cached: false
end
end
context 'when confidential issues exist' do
context 'when user can see confidential issues' do
it 'includes confidential issues' do
post_query
all_issues = confidential_issues + non_confidential_issues
expect(issue_ids).to match_array(to_gid_list(all_issues))
expect(issues_data.pluck('confidential')).to match_array(all_issues.map(&:confidential))
end
end
context 'when user cannot see confidential issues' do
let(:current_user) { external_user }
it 'does not include confidential issues' do
post_query
expect(issue_ids).to match_array(to_gid_list(public_non_confidential_issues))
end
end
end
context 'when limiting the number of results' do
let(:issue_limit) { 1 }
let(:issue_filter_params) { { first: issue_limit } }
it_behaves_like 'a working graphql query' do
before do
post_query
end
it 'only returns N issues' do
expect(issues_data.size).to eq(issue_limit)
end
end
context 'when no limit is provided' do
let(:issue_limit) { nil }
it 'returns all issues' do
post_query
expect(issues_data.size).to be > 1
end
end
it 'is expected to check permissions on the first issue only' do
allow(Ability).to receive(:allowed?).and_call_original
# Newest first, we only want to see the newest checked
expect(Ability).not_to receive(:allowed?).with(current_user, :read_issue, issues.first)
post_query
end
end
context 'when the user does not have access to the issue' do
let(:current_user) { external_user }
it 'returns no issues' do
public_projects.each do |public_project|
public_project.project_feature.update!(issues_access_level: ProjectFeature::PRIVATE)
end
post_query
expect(issues_data).to eq([])
end
end
context 'when fetching escalation status' do
let_it_be(:escalation_status) { create(:incident_management_issuable_escalation_status, issue: issue_a) }
let(:fields) do
<<~QUERY
nodes {
id
escalationStatus
}
QUERY
end
before do
issue_a.update_columns(issue_type: Issue.issue_types[:incident])
end
it 'returns the escalation status values' do
post_query
statuses = issues_data.pluck('escalationStatus')
expect(statuses).to contain_exactly(escalation_status.status_name.upcase.to_s, nil, nil, nil, nil)
end
it 'avoids N+1 queries', :aggregate_failures do
control = ActiveRecord::QueryRecorder.new { run_with_clean_state(query, context: { current_user: current_user }) }
new_incident = create(:incident, project: public_projects.first)
create(:incident_management_issuable_escalation_status, issue: new_incident)
expect { run_with_clean_state(query, context: { current_user: current_user }) }.not_to exceed_query_limit(control)
end
end
context 'when fetching alert management alert' do
let(:fields) do
<<~QUERY
nodes {
iid
alertManagementAlert {
title
}
alertManagementAlerts {
nodes {
title
}
}
}
QUERY
end
it 'avoids N+1 queries' do
control = ActiveRecord::QueryRecorder.new { post_query }
create(:alert_management_alert, :with_incident, project: public_projects.first)
expect { post_query }.not_to exceed_query_limit(control)
end
it 'returns the alert data' do
post_query
alert_titles = issues_data.map { |issue| issue.dig('alertManagementAlert', 'title') }
expected_titles = issues.map { |issue| issue.alert_management_alerts.first&.title }
expect(alert_titles).to contain_exactly(*expected_titles)
end
it 'returns the alerts data' do
post_query
alert_titles = issues_data.map { |issue| issue.dig('alertManagementAlerts', 'nodes') }
expected_titles = issues.map do |issue|
issue.alert_management_alerts.map { |alert| { 'title' => alert.title } }
end
expect(alert_titles).to contain_exactly(*expected_titles)
end
end
context 'when fetching customer_relations_contacts' do
let(:fields) do
<<~QUERY
nodes {
id
customerRelationsContacts {
nodes {
firstName
}
}
}
QUERY
end
def clean_state_query
run_with_clean_state(query, context: { current_user: current_user })
end
it 'avoids N+1 queries' do
create(:issue_customer_relations_contact, :for_issue, issue: issue_a)
control = ActiveRecord::QueryRecorder.new(skip_cached: false) { clean_state_query }
create(:issue_customer_relations_contact, :for_issue, issue: issue_a)
expect { clean_state_query }.not_to exceed_all_query_limit(control)
end
end
context 'when fetching labels' do
let(:fields) do
<<~QUERY
nodes {
id
labels {
nodes {
id
}
}
}
QUERY
end
before do
issues.each do |issue|
# create a label for each issue we have to properly test N+1
label = create(:label, project: issue.project)
issue.update!(labels: [label])
end
end
def response_label_ids(response_data)
response_data.map do |node|
node['labels']['nodes'].pluck('id')
end.flatten
end
def labels_as_global_ids(issues)
issues.map(&:labels).flatten.map(&:to_global_id).map(&:to_s)
end
it 'avoids N+1 queries', :aggregate_failures do
control = ActiveRecord::QueryRecorder.new { post_query }
expect(issues_data.count).to eq(5)
expect(response_label_ids(issues_data)).to match_array(labels_as_global_ids(issues))
public_project = public_projects.first
new_issues = issues + [
create(:issue, project: public_project, labels: [create(:label, project: public_project)])
]
expect { post_query }.not_to exceed_query_limit(control)
expect(issues_data.count).to eq(6)
expect(response_label_ids(issues_data)).to match_array(labels_as_global_ids(new_issues))
end
end
context 'when fetching assignees' do
let(:fields) do
<<~QUERY
nodes {
id
assignees {
nodes {
id
}
}
}
QUERY
end
before do
issues.each do |issue|
# create an assignee for each issue we have to properly test N+1
assignee = create(:user)
issue.update!(assignees: [assignee])
end
end
def response_assignee_ids(response_data)
response_data.map do |node|
node['assignees']['nodes'].pluck('id')
end.flatten
end
def assignees_as_global_ids(issues)
issues.map(&:assignees).flatten.map(&:to_global_id).map(&:to_s)
end
it 'avoids N+1 queries', :aggregate_failures do
control = ActiveRecord::QueryRecorder.new { post_query }
expect(issues_data.count).to eq(5)
expect(response_assignee_ids(issues_data)).to match_array(assignees_as_global_ids(issues))
public_project = public_projects.first
new_issues = issues + [create(:issue, project: public_project, assignees: [create(:user)])]
expect { post_query }.not_to exceed_query_limit(control)
expect(issues_data.count).to eq(6)
expect(response_assignee_ids(issues_data)).to match_array(assignees_as_global_ids(new_issues))
end
end
context 'when selecting `related_merge_requests`' do
let(:fields) do
<<~QUERY
nodes {
relatedMergeRequests {
nodes {
id
}
}
}
QUERY
end
it 'limits the field to 1 execution' do
post_query
expect_graphql_errors_to_include(
'"relatedMergeRequests" field can be requested only for 1 Issue(s) at a time.'
)
end
end
it 'includes a web_url' do
post_query
expect(issues_data[0]['webUrl']).to be_present
end
it 'includes discussion locked' do
post_query
expect(issues_data).to contain_exactly(
*locked_discussion_issues.map { |i| hash_including('id' => i.to_gid.to_s, 'discussionLocked' => true) },
*unlocked_discussion_issues.map { |i| hash_including('id' => i.to_gid.to_s, 'discussionLocked' => false) }
)
end
def to_gid_list(instance_list)
instance_list.map { |instance| instance.to_gid.to_s }
end
def issues_data
graphql_data.dig(*issue_nodes_path)
end
end
|