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
|
# frozen_string_literal: true
require 'spec_helper'
# rubocop:disable RSpec/MultipleMemoizedHelpers
RSpec.describe 'getting an issue list at root level', feature_category: :team_planning do
include GraphqlHelpers
let_it_be(:developer) { create(:user) }
let_it_be(:reporter) { create(:user) }
let_it_be(:current_user) { developer }
let_it_be(:group1) { create(:group, developers: developer) }
let_it_be(:group2) { create(:group, developers: developer, reporters: reporter) }
let_it_be(:project_a) { create(:project, :repository, :public, group: group1) }
let_it_be(:project_b) { create(:project, :repository, :private, group: group1) }
let_it_be(:project_c) { create(:project, :repository, :public, group: group2) }
let_it_be(:project_d) { create(:project, :repository, :private, group: group2) }
let_it_be(:archived_project) { create(:project, :repository, :archived, group: group2) }
let_it_be(:milestone1) { create(:milestone, project: project_c, due_date: 10.days.from_now) }
let_it_be(:milestone2) { create(:milestone, project: project_d, due_date: 20.days.from_now) }
let_it_be(:milestone3) { create(:milestone, project: project_d, due_date: 30.days.from_now) }
let_it_be(:milestone4) { create(:milestone, project: project_a, due_date: 40.days.from_now) }
let_it_be(:priority1) { create(:label, project: project_c, priority: 1) }
let_it_be(:priority2) { create(:label, project: project_d, priority: 5) }
let_it_be(:priority3) { create(:label, project: project_a, priority: 10) }
let_it_be(:priority4) { create(:label, project: project_d, priority: 15) }
let_it_be(:issue_a) do
create(
:issue,
project: project_a,
labels: [priority3],
due_date: 1.day.ago,
milestone: milestone4,
relative_position: 1000
)
end
let_it_be(:issue_b) do
create(
:issue,
:with_alert,
project: project_b,
discussion_locked: true,
due_date: 1.day.from_now,
relative_position: 3000
)
end
let_it_be(:issue_c) do
create(
:issue,
:confidential,
project: project_c,
title: 'title matching issue plus',
labels: [priority1],
milestone: milestone1,
due_date: 3.days.from_now,
relative_position: nil
)
end
let_it_be(:issue_d) do
create(
:issue,
:with_alert,
project: project_d,
discussion_locked: true,
labels: [priority2],
milestone: milestone3,
relative_position: 5000
)
end
let_it_be(:issue_e) do
create(
:issue,
:confidential,
project: project_d,
milestone: milestone2,
due_date: 3.days.ago,
relative_position: nil,
labels: [priority2, priority4]
)
end
let_it_be(:archived_issue) { create(:issue, project: archived_project) }
let_it_be(:issues, reload: true) { [issue_a, issue_b, issue_c, issue_d, issue_e] }
# we need to always provide at least one filter to the query so it doesn't fail
let_it_be(:base_params) { { iids: issues.map { |issue| issue.iid.to_s } } }
let_it_be(:subscription) { create(:subscription, subscribable: issue_a, user: current_user, subscribed: true) }
let_it_be(:unsubscription) do
create(:subscription, subscribable: issue_b, user: current_user, subscribed: false)
end
let(:issue_filter_params) { {} }
let(:all_query_params) { base_params.merge(**issue_filter_params) }
let(:fields) do
<<~QUERY
nodes { id }
QUERY
end
shared_examples 'query that requires at least one filter' do
it 'requires at least one filter to be provided to the query' do
post_graphql(query, current_user: developer)
expect(graphql_errors).to contain_exactly(
hash_including('message' => _('You must provide at least one filter argument for this query'))
)
end
end
describe 'includeArchived filter' do
let(:base_params) { { iids: [archived_issue.iid.to_s] } }
it 'excludes issues from archived projects' do
post_query
issue_ids = graphql_dig_at(graphql_data_at('issues', 'nodes'), :id)
expect(issue_ids).not_to include(archived_issue.to_gid.to_s)
end
context 'when includeArchived is true' do
let(:issue_filter_params) { { include_archived: true } }
it 'includes issues from archived projects' do
post_query
issue_ids = graphql_dig_at(graphql_data_at('issues', 'nodes'), :id)
expect(issue_ids).to include(archived_issue.to_gid.to_s)
end
end
end
it 'excludes issues from archived projects' do
post_query
issue_ids = graphql_dig_at(graphql_data_at('issues', 'nodes'), :id)
expect(issue_ids).not_to include(archived_issue.to_gid.to_s)
end
context 'when no filters are provided' do
let(:all_query_params) { {} }
it_behaves_like 'query that requires at least one filter'
end
context 'when only non filter arguments are provided' do
let(:all_query_params) { { sort: :SEVERITY_ASC } }
it_behaves_like 'query that requires at least one filter'
end
# All new specs should be added to the shared example if the change also
# affects the `issues` query at the root level of the API.
# Shared example also used in spec/requests/api/graphql/project/issues_spec.rb
it_behaves_like 'graphql issue list request spec' do
let_it_be(:external_user) { create(:user) }
let_it_be(:another_user) { reporter }
let(:public_projects) { [project_a, project_c] }
let(:issue_nodes_path) { %w[issues nodes] }
# filters
let(:expected_negated_assignee_issues) { [issue_b, issue_c, issue_d, issue_e] }
let(:voted_issues) { [issue_a, issue_c] }
let(:no_award_issues) { [issue_b, issue_d, issue_e] }
let(:locked_discussion_issues) { [issue_b, issue_d] }
let(:unlocked_discussion_issues) { [issue_a, issue_c, issue_e] }
let(:search_title_term) { 'matching issue' }
let(:title_search_issue) { issue_c }
let(:confidential_issues) { [issue_c, issue_e] }
let(:non_confidential_issues) { [issue_a, issue_b, issue_d] }
let(:public_non_confidential_issues) { [issue_a] }
let(:subscribed_issues) { [issue_a] }
let(:unsubscribed_issues) { [issue_b] }
# sorting
let(:data_path) { [:issues] }
let(:expected_priority_sorted_asc) { [issue_c, issue_e, issue_d, issue_a, issue_b] }
let(:expected_priority_sorted_desc) { [issue_a, issue_d, issue_e, issue_c, issue_b] }
let(:expected_due_date_sorted_desc) { [issue_c, issue_b, issue_a, issue_e, issue_d] }
let(:expected_due_date_sorted_asc) { [issue_e, issue_a, issue_b, issue_c, issue_d] }
let(:expected_relative_position_sorted_asc) { [issue_a, issue_b, issue_d, issue_c, issue_e] }
let(:expected_label_priority_sorted_asc) { [issue_c, issue_e, issue_d, issue_a, issue_b] }
let(:expected_label_priority_sorted_desc) { [issue_a, issue_e, issue_d, issue_c, issue_b] }
let(:expected_milestone_sorted_asc) { [issue_c, issue_e, issue_d, issue_a, issue_b] }
let(:expected_milestone_sorted_desc) { [issue_a, issue_d, issue_e, issue_c, issue_b] }
# N+1 queries
let(:same_project_issue1) { issue_d }
let(:same_project_issue2) { issue_e }
before_all do
create(:award_emoji, :upvote, user: developer, awardable: issue_a)
create(:award_emoji, :upvote, user: developer, awardable: issue_c)
end
def pagination_query(params)
graphql_query_for(
:issues,
base_params.merge(**params.to_h),
"#{page_info} nodes { id }"
)
end
end
context 'when fetching issues from multiple projects' do
it 'avoids N+1 queries', :use_sql_query_cache do
post_query # warm-up
control = ActiveRecord::QueryRecorder.new(skip_cached: false) { post_query }
expect_graphql_errors_to_be_empty
new_private_project = create(:project, :private, developers: current_user)
create(:issue, project: new_private_project)
private_group = create(:group, :private, developers: current_user)
private_project = create(:project, :private, group: private_group)
create(:issue, project: private_project)
expect { post_query }.not_to exceed_all_query_limit(control)
expect_graphql_errors_to_be_empty
end
end
context 'with rate limiting' do
it_behaves_like 'rate limited endpoint', rate_limit_key: :search_rate_limit, graphql: true do
let_it_be(:current_user) { developer }
let(:error_message) do
'This endpoint has been requested with the search argument too many times. Try again later.'
end
def request
post_graphql(query({ search: 'test' }), current_user: developer)
end
end
it_behaves_like 'rate limited endpoint', rate_limit_key: :search_rate_limit_unauthenticated, graphql: true do
let_it_be(:current_user) { nil }
let(:error_message) do
'This endpoint has been requested with the search argument too many times. Try again later.'
end
def request
post_graphql(query({ search: 'test' }))
end
end
end
def execute_query
post_query
end
def post_query(request_user = current_user)
post_graphql(query, current_user: request_user)
end
def query(params = all_query_params)
graphql_query_for(
:issues,
params,
fields
)
end
end
# rubocop:enable RSpec/MultipleMemoizedHelpers
|