1# frozen_string_literal: true 2 3require 'spec_helper' 4 5RSpec.describe Noteable do 6 let!(:active_diff_note1) { create(:diff_note_on_merge_request) } 7 let(:project) { active_diff_note1.project } 8 subject { active_diff_note1.noteable } 9 10 let!(:active_diff_note2) { create(:diff_note_on_merge_request, project: project, noteable: subject, in_reply_to: active_diff_note1) } 11 let!(:active_diff_note3) { create(:diff_note_on_merge_request, project: project, noteable: subject, position: active_position2) } 12 let!(:outdated_diff_note1) { create(:diff_note_on_merge_request, project: project, noteable: subject, position: outdated_position) } 13 let!(:outdated_diff_note2) { create(:diff_note_on_merge_request, project: project, noteable: subject, in_reply_to: outdated_diff_note1) } 14 let!(:discussion_note1) { create(:discussion_note_on_merge_request, project: project, noteable: subject) } 15 let!(:discussion_note2) { create(:discussion_note_on_merge_request, in_reply_to: discussion_note1) } 16 let!(:commit_diff_note1) { create(:diff_note_on_commit, project: project) } 17 let!(:commit_diff_note2) { create(:diff_note_on_commit, project: project, in_reply_to: commit_diff_note1) } 18 let!(:commit_note1) { create(:note_on_commit, project: project) } 19 let!(:commit_note2) { create(:note_on_commit, project: project) } 20 let!(:commit_discussion_note1) { create(:discussion_note_on_commit, project: project) } 21 let!(:commit_discussion_note2) { create(:discussion_note_on_commit, in_reply_to: commit_discussion_note1) } 22 let!(:commit_discussion_note3) { create(:discussion_note_on_commit, project: project) } 23 let!(:note1) { create(:note, project: project, noteable: subject) } 24 let!(:note2) { create(:note, project: project, noteable: subject) } 25 26 let(:active_position2) do 27 Gitlab::Diff::Position.new( 28 old_path: 'files/ruby/popen.rb', 29 new_path: 'files/ruby/popen.rb', 30 old_line: 16, 31 new_line: 22, 32 diff_refs: subject.diff_refs 33 ) 34 end 35 36 let(:outdated_position) do 37 Gitlab::Diff::Position.new( 38 old_path: 'files/ruby/popen.rb', 39 new_path: 'files/ruby/popen.rb', 40 old_line: nil, 41 new_line: 9, 42 diff_refs: project.commit('874797c3a73b60d2187ed6e2fcabd289ff75171e').diff_refs 43 ) 44 end 45 46 describe '#discussions' do 47 let(:discussions) { subject.discussions } 48 49 it 'includes discussions for diff notes, commit diff notes, commit notes, and regular notes' do 50 expect(discussions).to eq([ 51 DiffDiscussion.new([active_diff_note1, active_diff_note2], subject), 52 DiffDiscussion.new([active_diff_note3], subject), 53 DiffDiscussion.new([outdated_diff_note1, outdated_diff_note2], subject), 54 Discussion.new([discussion_note1, discussion_note2], subject), 55 DiffDiscussion.new([commit_diff_note1, commit_diff_note2], subject), 56 OutOfContextDiscussion.new([commit_note1, commit_note2], subject), 57 Discussion.new([commit_discussion_note1, commit_discussion_note2], subject), 58 Discussion.new([commit_discussion_note3], subject), 59 IndividualNoteDiscussion.new([note1], subject), 60 IndividualNoteDiscussion.new([note2], subject) 61 ]) 62 end 63 end 64 65 describe '#discussion_ids_relation' do 66 it 'returns ordered discussion_ids' do 67 discussion_ids = subject.discussion_ids_relation.pluck(:discussion_id) 68 69 expect(discussion_ids).to eq([ 70 active_diff_note1, 71 active_diff_note3, 72 outdated_diff_note1, 73 discussion_note1, 74 note1, 75 note2 76 ].map(&:discussion_id)) 77 end 78 end 79 80 describe '#discussion_root_note_ids' do 81 let!(:label_event) { create(:resource_label_event, merge_request: subject) } 82 let!(:system_note) { create(:system_note, project: project, noteable: subject) } 83 let!(:milestone_event) { create(:resource_milestone_event, merge_request: subject) } 84 let!(:state_event) { create(:resource_state_event, merge_request: subject) } 85 86 it 'returns ordered discussion_ids and synthetic note ids' do 87 discussions = subject.discussion_root_note_ids(notes_filter: UserPreference::NOTES_FILTERS[:all_notes]).map do |n| 88 { table_name: n.table_name, discussion_id: n.discussion_id, id: n.id } 89 end 90 91 expect(discussions).to match([ 92 a_hash_including(table_name: 'notes', discussion_id: active_diff_note1.discussion_id), 93 a_hash_including(table_name: 'notes', discussion_id: active_diff_note3.discussion_id), 94 a_hash_including(table_name: 'notes', discussion_id: outdated_diff_note1.discussion_id), 95 a_hash_including(table_name: 'notes', discussion_id: discussion_note1.discussion_id), 96 a_hash_including(table_name: 'notes', discussion_id: commit_diff_note1.discussion_id), 97 a_hash_including(table_name: 'notes', discussion_id: commit_note1.discussion_id), 98 a_hash_including(table_name: 'notes', discussion_id: commit_note2.discussion_id), 99 a_hash_including(table_name: 'notes', discussion_id: commit_discussion_note1.discussion_id), 100 a_hash_including(table_name: 'notes', discussion_id: commit_discussion_note3.discussion_id), 101 a_hash_including(table_name: 'notes', discussion_id: note1.discussion_id), 102 a_hash_including(table_name: 'notes', discussion_id: note2.discussion_id), 103 a_hash_including(table_name: 'resource_label_events', id: label_event.id), 104 a_hash_including(table_name: 'notes', discussion_id: system_note.discussion_id), 105 a_hash_including(table_name: 'resource_milestone_events', id: milestone_event.id), 106 a_hash_including(table_name: 'resource_state_events', id: state_event.id) 107 ]) 108 end 109 110 it 'filters by comments only' do 111 discussions = subject.discussion_root_note_ids(notes_filter: UserPreference::NOTES_FILTERS[:only_comments]).map do |n| 112 { table_name: n.table_name, discussion_id: n.discussion_id, id: n.id } 113 end 114 115 expect(discussions).to match([ 116 a_hash_including(table_name: 'notes', discussion_id: active_diff_note1.discussion_id), 117 a_hash_including(table_name: 'notes', discussion_id: active_diff_note3.discussion_id), 118 a_hash_including(table_name: 'notes', discussion_id: outdated_diff_note1.discussion_id), 119 a_hash_including(table_name: 'notes', discussion_id: discussion_note1.discussion_id), 120 a_hash_including(table_name: 'notes', discussion_id: commit_diff_note1.discussion_id), 121 a_hash_including(table_name: 'notes', discussion_id: commit_note1.discussion_id), 122 a_hash_including(table_name: 'notes', discussion_id: commit_note2.discussion_id), 123 a_hash_including(table_name: 'notes', discussion_id: commit_discussion_note1.discussion_id), 124 a_hash_including(table_name: 'notes', discussion_id: commit_discussion_note3.discussion_id), 125 a_hash_including(table_name: 'notes', discussion_id: note1.discussion_id), 126 a_hash_including(table_name: 'notes', discussion_id: note2.discussion_id) 127 ]) 128 end 129 130 it 'filters by system notes only' do 131 discussions = subject.discussion_root_note_ids(notes_filter: UserPreference::NOTES_FILTERS[:only_activity]).map do |n| 132 { table_name: n.table_name, discussion_id: n.discussion_id, id: n.id } 133 end 134 135 expect(discussions).to match([ 136 a_hash_including(table_name: 'resource_label_events', id: label_event.id), 137 a_hash_including(table_name: 'notes', discussion_id: system_note.discussion_id), 138 a_hash_including(table_name: 'resource_milestone_events', id: milestone_event.id), 139 a_hash_including(table_name: 'resource_state_events', id: state_event.id) 140 ]) 141 end 142 end 143 144 describe '#grouped_diff_discussions' do 145 let(:grouped_diff_discussions) { subject.grouped_diff_discussions } 146 147 it 'includes active discussions' do 148 discussions = grouped_diff_discussions.values.flatten 149 150 expect(discussions.count).to eq(2) 151 expect(discussions.map(&:id)).to eq([active_diff_note1.discussion_id, active_diff_note3.discussion_id]) 152 expect(discussions.all?(&:active?)).to be true 153 154 expect(discussions.first.notes).to eq([active_diff_note1, active_diff_note2]) 155 expect(discussions.last.notes).to eq([active_diff_note3]) 156 end 157 158 it 'does not include outdated discussions' do 159 expect(grouped_diff_discussions.values.flatten.map(&:id)).not_to include(outdated_diff_note1.discussion_id) 160 end 161 162 it 'groups the discussions by line code' do 163 expect(grouped_diff_discussions[active_diff_note1.line_code].first.id).to eq(active_diff_note1.discussion_id) 164 expect(grouped_diff_discussions[active_diff_note3.line_code].first.id).to eq(active_diff_note3.discussion_id) 165 end 166 end 167 168 context 'discussion status' do 169 let(:first_discussion) { build_stubbed(:discussion_note_on_merge_request, noteable: subject, project: project).to_discussion } 170 let(:second_discussion) { build_stubbed(:discussion_note_on_merge_request, noteable: subject, project: project).to_discussion } 171 let(:third_discussion) { build_stubbed(:discussion_note_on_merge_request, noteable: subject, project: project).to_discussion } 172 173 before do 174 allow(subject).to receive(:resolvable_discussions).and_return([first_discussion, second_discussion, third_discussion]) 175 end 176 177 describe '#discussions_resolvable?' do 178 context 'when all discussions are unresolvable' do 179 before do 180 allow(first_discussion).to receive(:resolvable?).and_return(false) 181 allow(second_discussion).to receive(:resolvable?).and_return(false) 182 allow(third_discussion).to receive(:resolvable?).and_return(false) 183 end 184 185 it 'returns false' do 186 expect(subject.discussions_resolvable?).to be false 187 end 188 end 189 190 context 'when some discussions are unresolvable and some discussions are resolvable' do 191 before do 192 allow(first_discussion).to receive(:resolvable?).and_return(true) 193 allow(second_discussion).to receive(:resolvable?).and_return(false) 194 allow(third_discussion).to receive(:resolvable?).and_return(true) 195 end 196 197 it 'returns true' do 198 expect(subject.discussions_resolvable?).to be true 199 end 200 end 201 202 context 'when all discussions are resolvable' do 203 before do 204 allow(first_discussion).to receive(:resolvable?).and_return(true) 205 allow(second_discussion).to receive(:resolvable?).and_return(true) 206 allow(third_discussion).to receive(:resolvable?).and_return(true) 207 end 208 209 it 'returns true' do 210 expect(subject.discussions_resolvable?).to be true 211 end 212 end 213 end 214 215 describe '#discussions_resolved?' do 216 context 'when discussions are not resolvable' do 217 before do 218 allow(subject).to receive(:discussions_resolvable?).and_return(false) 219 end 220 221 it 'returns false' do 222 expect(subject.discussions_resolved?).to be false 223 end 224 end 225 226 context 'when discussions are resolvable' do 227 before do 228 allow(subject).to receive(:discussions_resolvable?).and_return(true) 229 230 allow(first_discussion).to receive(:resolvable?).and_return(true) 231 allow(second_discussion).to receive(:resolvable?).and_return(false) 232 allow(third_discussion).to receive(:resolvable?).and_return(true) 233 end 234 235 context 'when all resolvable discussions are resolved' do 236 before do 237 allow(first_discussion).to receive(:resolved?).and_return(true) 238 allow(third_discussion).to receive(:resolved?).and_return(true) 239 end 240 241 it 'returns true' do 242 expect(subject.discussions_resolved?).to be true 243 end 244 end 245 246 context 'when some resolvable discussions are not resolved' do 247 before do 248 allow(first_discussion).to receive(:resolved?).and_return(true) 249 allow(third_discussion).to receive(:resolved?).and_return(false) 250 end 251 252 it 'returns false' do 253 expect(subject.discussions_resolved?).to be false 254 end 255 end 256 end 257 end 258 259 describe '#discussions_to_be_resolved' do 260 before do 261 allow(first_discussion).to receive(:to_be_resolved?).and_return(true) 262 allow(second_discussion).to receive(:to_be_resolved?).and_return(false) 263 allow(third_discussion).to receive(:to_be_resolved?).and_return(false) 264 end 265 266 it 'includes only discussions that need to be resolved' do 267 expect(subject.discussions_to_be_resolved).to eq([first_discussion]) 268 end 269 end 270 271 describe '#discussions_can_be_resolved_by?' do 272 let(:user) { build(:user) } 273 274 context 'all discussions can be resolved by the user' do 275 before do 276 allow(first_discussion).to receive(:can_resolve?).with(user).and_return(true) 277 allow(second_discussion).to receive(:can_resolve?).with(user).and_return(true) 278 allow(third_discussion).to receive(:can_resolve?).with(user).and_return(true) 279 end 280 281 it 'allows a user to resolve the discussions' do 282 expect(subject.discussions_can_be_resolved_by?(user)).to be(true) 283 end 284 end 285 286 context 'one discussion cannot be resolved by the user' do 287 before do 288 allow(first_discussion).to receive(:can_resolve?).with(user).and_return(true) 289 allow(second_discussion).to receive(:can_resolve?).with(user).and_return(true) 290 allow(third_discussion).to receive(:can_resolve?).with(user).and_return(false) 291 end 292 293 it 'allows a user to resolve the discussions' do 294 expect(subject.discussions_can_be_resolved_by?(user)).to be(false) 295 end 296 end 297 end 298 end 299 300 describe '.replyable_types' do 301 it 'exposes the replyable types' do 302 expect(described_class.replyable_types).to include('Issue', 'MergeRequest') 303 end 304 end 305 306 describe '.resolvable_types' do 307 it 'exposes the replyable types' do 308 expect(described_class.resolvable_types).to include('MergeRequest', 'DesignManagement::Design') 309 end 310 end 311 312 describe '.email_creatable_types' do 313 it 'exposes the email creatable types' do 314 expect(described_class.email_creatable_types).to include('Issue') 315 end 316 end 317 318 describe '#capped_notes_count' do 319 context 'notes number < 10' do 320 it 'the number of notes is returned' do 321 expect(subject.capped_notes_count(10)).to eq(9) 322 end 323 end 324 325 context 'notes number > 10' do 326 before do 327 create_list(:note, 2, project: project, noteable: subject) 328 end 329 330 it '10 is returned' do 331 expect(subject.capped_notes_count(10)).to eq(10) 332 end 333 end 334 end 335 336 describe '#has_any_diff_note_positions?' do 337 let(:source_branch) { 'compare-with-merge-head-source' } 338 let(:target_branch) { 'compare-with-merge-head-target' } 339 let(:merge_request) { create(:merge_request, source_branch: source_branch, target_branch: target_branch) } 340 341 let!(:note) do 342 path = 'files/markdown/ruby-style-guide.md' 343 344 position = Gitlab::Diff::Position.new( 345 old_path: path, 346 new_path: path, 347 new_line: 508, 348 diff_refs: merge_request.diff_refs 349 ) 350 351 create(:diff_note_on_merge_request, project: merge_request.project, position: position, noteable: merge_request) 352 end 353 354 before do 355 MergeRequests::MergeToRefService.new(project: merge_request.project, current_user: merge_request.author).execute(merge_request) 356 Discussions::CaptureDiffNotePositionsService.new(merge_request).execute 357 end 358 359 it 'returns true when it has diff note positions' do 360 expect(merge_request.has_any_diff_note_positions?).to be(true) 361 end 362 363 it 'returns false when it has notes but no diff note positions' do 364 DiffNotePosition.where(note: note).find_each(&:delete) 365 366 expect(merge_request.has_any_diff_note_positions?).to be(false) 367 end 368 369 it 'returns false when it has no notes' do 370 merge_request.notes.find_each(&:destroy) 371 372 expect(merge_request.has_any_diff_note_positions?).to be(false) 373 end 374 end 375 376 describe '#creatable_note_email_address' do 377 let_it_be(:user) { create(:user) } 378 let_it_be(:source_branch) { 'compare-with-merge-head-source' } 379 380 let(:issue) { create(:issue, project: project) } 381 let(:snippet) { build(:snippet) } 382 383 context 'incoming email enabled' do 384 before do 385 stub_incoming_email_setting(enabled: true, address: "p+%{key}@gl.ab") 386 end 387 388 it 'returns the address to create a note' do 389 address = "p+#{project.full_path_slug}-#{project.project_id}-#{user.incoming_email_token}-issue-#{issue.iid}@gl.ab" 390 391 expect(issue.creatable_note_email_address(user)).to eq(address) 392 end 393 394 it 'returns nil for unsupported types' do 395 expect(snippet.creatable_note_email_address(user)).to be_nil 396 end 397 end 398 399 context 'incoming email disabled' do 400 before do 401 stub_incoming_email_setting(enabled: false) 402 end 403 404 it 'returns nil' do 405 expect(issue.creatable_note_email_address(user)).to be_nil 406 end 407 end 408 end 409end 410