# frozen_string_literal: true require 'spec_helper' RSpec.describe 'getting an issue list for a project' do include GraphqlHelpers let_it_be(:group) { create(:group) } let_it_be(:project) { create(:project, :repository, :public, group: group) } let_it_be(:current_user) { create(:user) } let_it_be(:issue_a, reload: true) { create(:issue, project: project, discussion_locked: true) } let_it_be(:issue_b, reload: true) { create(:issue, :with_alert, project: project) } let_it_be(:issues, reload: true) { [issue_a, issue_b] } let(:issue_a_gid) { issue_a.to_global_id.to_s } let(:issue_b_gid) { issue_b.to_global_id.to_s } let(:issues_data) { graphql_data['project']['issues']['edges'] } let(:issue_filter_params) { {} } let(:fields) do <<~QUERY edges { node { #{all_graphql_fields_for('issues'.classify)} } } QUERY end it_behaves_like 'a working graphql query' do before do post_graphql(query, current_user: current_user) end end it 'includes a web_url' do post_graphql(query, current_user: current_user) expect(issues_data[0]['node']['webUrl']).to be_present end it 'includes discussion locked' do post_graphql(query, current_user: current_user) expect(issues_data[0]['node']['discussionLocked']).to eq(false) expect(issues_data[1]['node']['discussionLocked']).to eq(true) end context 'when both assignee_username filters are provided' do let(:issue_filter_params) { { assignee_username: current_user.username, assignee_usernames: [current_user.username] } } it 'returns a mutually exclusive param error' do post_graphql(query, current_user: current_user) expect_graphql_errors_to_include('only one of [assigneeUsernames, assigneeUsername] arguments is allowed at the same time.') end end context 'filtering by my_reaction_emoji' do using RSpec::Parameterized::TableSyntax let_it_be(:upvote_award) { create(:award_emoji, :upvote, user: current_user, awardable: issue_a) } where(:value, :gids) do 'thumbsup' | lazy { [issue_a_gid] } 'ANY' | lazy { [issue_a_gid] } 'any' | lazy { [issue_a_gid] } 'AnY' | lazy { [issue_a_gid] } 'NONE' | lazy { [issue_b_gid] } 'thumbsdown' | lazy { [] } end with_them do let(:issue_filter_params) { { my_reaction_emoji: value } } it 'returns correctly filtered issues' do post_graphql(query, current_user: current_user) expect(issues_ids).to eq(gids) end end end context 'when filtering by search' do it_behaves_like 'query with a search term' do let(:issuable_data) { issues_data } let(:user) { current_user } let_it_be(:issuable) { create(:issue, project: project, description: 'bar') } end end context 'when limiting the number of results' do let(:query) do <<~GQL query($path: ID!, $n: Int) { project(fullPath: $path) { issues(first: $n) { #{fields} } } } GQL end let(:issue_limit) { 1 } let(:variables) do { path: project.full_path, n: issue_limit } end it_behaves_like 'a working graphql query' do before do post_graphql(query, current_user: current_user, variables: variables) 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_graphql(query, current_user: current_user, variables: variables) 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_graphql(query, current_user: current_user, variables: variables) end end context 'when the user does not have access to the issue' do it 'returns nil' do project.project_feature.update!(issues_access_level: ProjectFeature::PRIVATE) post_graphql(query) expect(issues_data).to eq([]) end end context 'when there is a confidential issue' do let_it_be(:confidential_issue) do create(:issue, :confidential, project: project) end let(:confidential_issue_gid) { confidential_issue.to_global_id.to_s } context 'when the user cannot see confidential issues' do it 'returns issues without confidential issues' do post_graphql(query, current_user: current_user) expect(issues_data.size).to eq(2) issues_data.each do |issue| expect(issue.dig('node', 'confidential')).to eq(false) end end context 'filtering for confidential issues' do let(:issue_filter_params) { { confidential: true } } it 'returns no issues' do post_graphql(query, current_user: current_user) expect(issues_data.size).to eq(0) end end context 'filtering for non-confidential issues' do let(:issue_filter_params) { { confidential: false } } it 'returns correctly filtered issues' do post_graphql(query, current_user: current_user) expect(issues_ids).to contain_exactly(issue_a_gid, issue_b_gid) end end end context 'when the user can see confidential issues' do before do project.add_developer(current_user) end it 'returns issues with confidential issues' do post_graphql(query, current_user: current_user) expect(issues_data.size).to eq(3) confidentials = issues_data.map do |issue| issue.dig('node', 'confidential') end expect(confidentials).to eq([true, false, false]) end context 'filtering for confidential issues' do let(:issue_filter_params) { { confidential: true } } it 'returns correctly filtered issues' do post_graphql(query, current_user: current_user) expect(issues_ids).to contain_exactly(confidential_issue_gid) end end context 'filtering for non-confidential issues' do let(:issue_filter_params) { { confidential: false } } it 'returns correctly filtered issues' do post_graphql(query, current_user: current_user) expect(issues_ids).to contain_exactly(issue_a_gid, issue_b_gid) end end end end describe 'sorting and pagination' do let_it_be(:sort_project) { create(:project, :public) } let_it_be(:data_path) { [:project, :issues] } def pagination_query(params) graphql_query_for( :project, { full_path: sort_project.full_path }, query_graphql_field(:issues, params, "#{page_info} nodes { iid }") ) end def pagination_results_data(data) data.map { |issue| issue['iid'].to_i } end context 'when sorting by severity' do let_it_be(:severty_issue1) { create(:issue, project: sort_project) } let_it_be(:severty_issue2) { create(:issue, project: sort_project) } let_it_be(:severty_issue3) { create(:issue, project: sort_project) } let_it_be(:severty_issue4) { create(:issue, project: sort_project) } let_it_be(:severty_issue5) { create(:issue, project: sort_project) } before(:all) do create(:issuable_severity, issue: severty_issue1, severity: :unknown) create(:issuable_severity, issue: severty_issue2, severity: :low) create(:issuable_severity, issue: severty_issue4, severity: :critical) create(:issuable_severity, issue: severty_issue5, 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) { [severty_issue3.iid, severty_issue1.iid, severty_issue2.iid, severty_issue5.iid, severty_issue4.iid] } 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) { [severty_issue4.iid, severty_issue5.iid, severty_issue2.iid, severty_issue1.iid, severty_issue3.iid] } end end end context 'when sorting by due date' do let_it_be(:due_issue1) { create(:issue, project: sort_project, due_date: 3.days.from_now) } let_it_be(:due_issue2) { create(:issue, project: sort_project, due_date: nil) } let_it_be(:due_issue3) { create(:issue, project: sort_project, due_date: 2.days.ago) } let_it_be(:due_issue4) { create(:issue, project: sort_project, due_date: nil) } let_it_be(:due_issue5) { create(:issue, project: sort_project, due_date: 1.day.ago) } context 'when ascending' do it_behaves_like 'sorted paginated query' do let(:sort_param) { :DUE_DATE_ASC } let(:first_param) { 2 } let(:all_records) { [due_issue3.iid, due_issue5.iid, due_issue1.iid, due_issue4.iid, due_issue2.iid] } 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) { [due_issue1.iid, due_issue5.iid, due_issue3.iid, due_issue4.iid, due_issue2.iid] } end end end context 'when sorting by relative position' do let_it_be(:relative_issue1) { create(:issue, project: sort_project, relative_position: 2000) } let_it_be(:relative_issue2) { create(:issue, project: sort_project, relative_position: nil) } let_it_be(:relative_issue3) { create(:issue, project: sort_project, relative_position: 1000) } let_it_be(:relative_issue4) { create(:issue, project: sort_project, relative_position: nil) } let_it_be(:relative_issue5) { create(:issue, project: sort_project, relative_position: 500) } 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) do [ relative_issue5.iid, relative_issue3.iid, relative_issue1.iid, relative_issue2.iid, relative_issue4.iid ] end end end end context 'when sorting by priority' do let_it_be(:on_project) { { project: sort_project } } let_it_be(:early_milestone) { create(:milestone, **on_project, due_date: 10.days.from_now) } let_it_be(:late_milestone) { create(:milestone, **on_project, due_date: 30.days.from_now) } let_it_be(:priority_1) { create(:label, **on_project, priority: 1) } let_it_be(:priority_2) { create(:label, **on_project, priority: 5) } let_it_be(:priority_issue1) { create(:issue, **on_project, labels: [priority_1], milestone: late_milestone) } let_it_be(:priority_issue2) { create(:issue, **on_project, labels: [priority_2]) } let_it_be(:priority_issue3) { create(:issue, **on_project, milestone: early_milestone) } let_it_be(:priority_issue4) { create(:issue, **on_project) } context 'when ascending' do it_behaves_like 'sorted paginated query' do let(:sort_param) { :PRIORITY_ASC } let(:first_param) { 2 } let(:all_records) do [ priority_issue3.iid, priority_issue1.iid, priority_issue2.iid, priority_issue4.iid ] end 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) do [priority_issue1.iid, priority_issue3.iid, priority_issue2.iid, priority_issue4.iid] end end end end context 'when sorting by label priority' do let_it_be(:label1) { create(:label, project: sort_project, priority: 1) } let_it_be(:label2) { create(:label, project: sort_project, priority: 5) } let_it_be(:label3) { create(:label, project: sort_project, priority: 10) } let_it_be(:label_issue1) { create(:issue, project: sort_project, labels: [label1]) } let_it_be(:label_issue2) { create(:issue, project: sort_project, labels: [label2]) } let_it_be(:label_issue3) { create(:issue, project: sort_project, labels: [label1, label3]) } let_it_be(:label_issue4) { create(:issue, project: sort_project) } context 'when ascending' do it_behaves_like 'sorted paginated query' do let(:sort_param) { :LABEL_PRIORITY_ASC } let(:first_param) { 2 } let(:all_records) { [label_issue3.iid, label_issue1.iid, label_issue2.iid, label_issue4.iid] } 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) { [label_issue2.iid, label_issue3.iid, label_issue1.iid, label_issue4.iid] } end end end context 'when sorting by milestone due date' do let_it_be(:early_milestone) { create(:milestone, project: sort_project, due_date: 10.days.from_now) } let_it_be(:late_milestone) { create(:milestone, project: sort_project, due_date: 30.days.from_now) } let_it_be(:milestone_issue1) { create(:issue, project: sort_project) } let_it_be(:milestone_issue2) { create(:issue, project: sort_project, milestone: early_milestone) } let_it_be(:milestone_issue3) { create(:issue, project: sort_project, milestone: late_milestone) } context 'when ascending' do it_behaves_like 'sorted paginated query' do let(:sort_param) { :MILESTONE_DUE_ASC } let(:first_param) { 2 } let(:all_records) { [milestone_issue2.iid, milestone_issue3.iid, milestone_issue1.iid] } 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) { [milestone_issue3.iid, milestone_issue2.iid, milestone_issue1.iid] } end end end end context 'when fetching alert management alert' do let(:fields) do <<~QUERY edges { node { iid alertManagementAlert { title } alertManagementAlerts { nodes { title } } } } QUERY end # Alerts need to have developer permission and above before do project.add_developer(current_user) end it 'avoids N+1 queries' do control = ActiveRecord::QueryRecorder.new { post_graphql(query, current_user: current_user) } create(:alert_management_alert, :with_incident, project: project) expect { post_graphql(query, current_user: current_user) }.not_to exceed_query_limit(control) end it 'returns the alert data' do post_graphql(query, current_user: current_user) alert_titles = issues_data.map { |issue| issue.dig('node', 'alertManagementAlert', 'title') } expected_titles = issues.map { |issue| issue.alert_management_alert&.title } expect(alert_titles).to contain_exactly(*expected_titles) end it 'returns the alerts data' do post_graphql(query, current_user: current_user) alert_titles = issues_data.map { |issue| issue.dig('node', '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 edges { node { 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: project) issue.update!(labels: [label]) end end def response_label_ids(response_data) response_data.map do |edge| edge['node']['labels']['nodes'].map { |u| u['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_graphql(query, current_user: current_user) } expect(issues_data.count).to eq(2) expect(response_label_ids(issues_data)).to match_array(labels_as_global_ids(issues)) new_issues = issues + [create(:issue, project: project, labels: [create(:label, project: project)])] expect { post_graphql(query, current_user: current_user) }.not_to exceed_query_limit(control) # graphql_data is memoized (see spec/support/helpers/graphql_helpers.rb) # so we have to parse the body ourselves the second time issues_data = Gitlab::Json.parse(response.body)['data']['project']['issues']['edges'] expect(issues_data.count).to eq(3) 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 edges { node { 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 |edge| edge['node']['assignees']['nodes'].map { |node| node['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_graphql(query, current_user: current_user) } expect(issues_data.count).to eq(2) expect(response_assignee_ids(issues_data)).to match_array(assignees_as_global_ids(issues)) new_issues = issues + [create(:issue, project: project, assignees: [create(:user)])] expect { post_graphql(query, current_user: current_user) }.not_to exceed_query_limit(control) # graphql_data is memoized (see spec/support/helpers/graphql_helpers.rb) # so we have to parse the body ourselves the second time issues_data = Gitlab::Json.parse(response.body)['data']['project']['issues']['edges'] expect(issues_data.count).to eq(3) expect(response_assignee_ids(issues_data)).to match_array(assignees_as_global_ids(new_issues)) end end context 'when fetching escalation status' do let_it_be(:escalation_status) { create(:incident_management_issuable_escalation_status, issue: issue_a) } let(:statuses) { issue_data.to_h { |issue| [issue['iid'], issue['escalationStatus']] } } let(:fields) do <<~QUERY edges { node { id escalationStatus } } QUERY end before do issue_a.update!(issue_type: Issue.issue_types[:incident]) end it 'returns the escalation status values' do post_graphql(query, current_user: current_user) statuses = issues_data.map { |issue| issue.dig('node', 'escalationStatus') } expect(statuses).to contain_exactly(escalation_status.status_name.upcase.to_s, nil) end it 'avoids N+1 queries', :aggregate_failures do base_count = ActiveRecord::QueryRecorder.new { run_with_clean_state(query, context: { current_user: current_user }) } new_incident = create(:incident, project: project) 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(base_count) 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] } } def execute_query query = graphql_query_for( :project, { full_path: project.full_path }, query_graphql_field( :issues, search_params, query_graphql_field(:nodes, nil, requested_fields) ) ) post_graphql(query, current_user: current_user) end context 'when requesting `user_notes_count`' do let(:requested_fields) { [:user_notes_count] } before do create_list(:note_on_issue, 2, noteable: issue_a, project: project) create(:note_on_issue, noteable: issue_b, project: project) end include_examples 'N+1 query check' end context 'when requesting `user_discussions_count`' do let(:requested_fields) { [:user_discussions_count] } before do create_list(:note_on_issue, 2, noteable: issue_a, project: project) create(:note_on_issue, noteable: issue_b, project: project) end include_examples 'N+1 query check' end context 'when requesting `merge_requests_count`' do let(:requested_fields) { [:merge_requests_count] } 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: project) } let(:issue_b_dup) { create(:issue, project: 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_it_be(:issue_c) { create(:issue, project: project) } 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: project) note_with_emoji_b = create(:note_on_issue, noteable: issue_b, project: project) note_with_emoji_c = create(:note_on_issue, noteable: issue_c, project: 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' do let(:requested_fields) { ['labels { nodes { id } }'] } before do project_labels = create_list(:label, 2, project: project) group_labels = create_list(:group_label, 2, group: group) issue_a.update!(labels: [project_labels.first, group_labels.first].flatten) issue_b.update!(labels: [project_labels, group_labels].flatten) end include_examples 'N+1 query check', skip_cached: false end end def issues_ids graphql_dig_at(issues_data, :node, :id) end def query(params = issue_filter_params) graphql_query_for( 'project', { 'fullPath' => project.full_path }, query_graphql_field('issues', params, fields) ) end end