1# frozen_string_literal: true
2
3require "spec_helper"
4
5RSpec.describe NotesHelper do
6  include RepoHelpers
7
8  let_it_be(:owner) { create(:owner) }
9  let_it_be(:group) { create(:group) }
10  let_it_be(:project) { create(:project, namespace: group) }
11  let_it_be(:maintainer) { create(:user) }
12  let_it_be(:reporter) { create(:user) }
13  let_it_be(:guest) { create(:user) }
14
15  let_it_be(:owner_note) { create(:note, author: owner, project: project) }
16  let_it_be(:maintainer_note) { create(:note, author: maintainer, project: project) }
17  let_it_be(:reporter_note) { create(:note, author: reporter, project: project) }
18
19  let!(:notes) { [owner_note, maintainer_note, reporter_note] }
20
21  before_all do
22    group.add_owner(owner)
23    project.add_maintainer(maintainer)
24    project.add_reporter(reporter)
25    project.add_guest(guest)
26  end
27
28  describe '#note_target_title' do
29    context 'note does not exist' do
30      it 'returns nil' do
31        expect(helper.note_target_title(nil)).to be_blank
32      end
33    end
34
35    context 'target does not exist' do
36      it 'returns nil' do
37        note = Note.new
38        expect(helper.note_target_title(note)).to be_blank
39      end
40    end
41
42    context 'when given a design target' do
43      it 'returns nil' do
44        note = build_stubbed(:note_on_design)
45        expect(helper.note_target_title(note)).to be_blank
46      end
47    end
48
49    context 'when given a non-design target' do
50      it 'returns the issue title' do
51        issue = build_stubbed(:issue, title: 'Issue 1')
52        note = build_stubbed(:note, noteable: issue)
53        expect(helper.note_target_title(note)).to eq('Issue 1')
54      end
55    end
56  end
57
58  describe "#notes_max_access_for_users" do
59    it 'returns access levels' do
60      expect(helper.note_max_access_for_user(owner_note)).to eq(Gitlab::Access::OWNER)
61      expect(helper.note_max_access_for_user(maintainer_note)).to eq(Gitlab::Access::MAINTAINER)
62      expect(helper.note_max_access_for_user(reporter_note)).to eq(Gitlab::Access::REPORTER)
63    end
64
65    it 'handles access in different projects' do
66      second_project = create(:project)
67      second_project.add_reporter(maintainer)
68      other_note = create(:note, author: maintainer, project: second_project)
69
70      expect(helper.note_max_access_for_user(maintainer_note)).to eq(Gitlab::Access::MAINTAINER)
71      expect(helper.note_max_access_for_user(other_note)).to eq(Gitlab::Access::REPORTER)
72    end
73  end
74
75  describe '#discussion_path' do
76    let_it_be(:project) { create(:project, :repository) }
77
78    let(:anchor) { discussion.line_code }
79
80    context 'for a merge request discusion' do
81      let_it_be(:merge_request) { create(:merge_request, source_project: project, target_project: project, importing: true) }
82      let_it_be(:merge_request_diff1) { merge_request.merge_request_diffs.create!(head_commit_sha: '6f6d7e7ed97bb5f0054f2b1df789b39ca89b6ff9') }
83      let_it_be(:merge_request_diff2) { merge_request.merge_request_diffs.create!(head_commit_sha: nil) }
84      let_it_be(:merge_request_diff3) { merge_request.merge_request_diffs.create!(head_commit_sha: '5937ac0a7beb003549fc5fd26fc247adbce4a52e') }
85
86      context 'for a diff discussion' do
87        context 'when the discussion is active' do
88          let(:discussion) { create(:diff_note_on_merge_request, noteable: merge_request, project: project).to_discussion }
89
90          it 'returns the diff path with the line code' do
91            expect(helper.discussion_path(discussion)).to eq(diffs_project_merge_request_path(project, merge_request, anchor: discussion.line_code))
92          end
93        end
94
95        context 'when the discussion is on an older merge request version' do
96          let(:position) do
97            build(:text_diff_position, :added,
98              file: ".gitmodules",
99              new_line: 4,
100              diff_refs: merge_request_diff1.diff_refs
101            )
102          end
103
104          let(:diff_note) { create(:diff_note_on_merge_request, noteable: merge_request, project: project, position: position) }
105          let(:discussion) { diff_note.to_discussion }
106
107          before do
108            diff_note.position = diff_note.original_position
109            diff_note.save!
110          end
111
112          it 'returns the diff version path with the line code' do
113            expect(helper.discussion_path(discussion)).to eq(diffs_project_merge_request_path(project, merge_request, diff_id: merge_request_diff1, anchor: discussion.line_code))
114          end
115        end
116
117        context 'when the discussion is on a comparison between merge request versions' do
118          let(:position) do
119            build(:text_diff_position,
120              file: ".gitmodules",
121              old_line: 4,
122              new_line: 4,
123              diff_refs: merge_request_diff3.compare_with(merge_request_diff1.head_commit_sha).diff_refs
124            )
125          end
126
127          let(:diff_note) { create(:diff_note_on_merge_request, noteable: merge_request, project: project, position: position) }
128          let(:discussion) { diff_note.to_discussion }
129
130          before do
131            diff_note.position = diff_note.original_position
132            diff_note.save!
133          end
134
135          it 'returns the diff version comparison path with the line code' do
136            expect(helper.discussion_path(discussion)).to eq(diffs_project_merge_request_path(project, merge_request, diff_id: merge_request_diff3, start_sha: merge_request_diff1.head_commit_sha, anchor: discussion.line_code))
137          end
138        end
139
140        context 'when the discussion does not have a merge request version' do
141          let(:outdated_diff_note) { create(:diff_note_on_merge_request, noteable: merge_request, project: project, diff_refs: project.commit(sample_commit.id).diff_refs) }
142          let(:discussion) { outdated_diff_note.to_discussion }
143
144          before do
145            outdated_diff_note.position = outdated_diff_note.original_position
146            outdated_diff_note.save!
147          end
148
149          it 'returns nil' do
150            expect(helper.discussion_path(discussion)).to be_nil
151          end
152        end
153      end
154
155      context 'for a legacy diff discussion' do
156        let(:discussion) { create(:legacy_diff_note_on_merge_request, noteable: merge_request, project: project).to_discussion }
157
158        context 'when the discussion is active' do
159          before do
160            allow(discussion).to receive(:active?).and_return(true)
161          end
162
163          it 'returns the diff path with the line code' do
164            expect(helper.discussion_path(discussion)).to eq(diffs_project_merge_request_path(project, merge_request, anchor: discussion.line_code))
165          end
166        end
167
168        context 'when the discussion is outdated' do
169          before do
170            allow(discussion).to receive(:active?).and_return(false)
171          end
172
173          it 'returns nil' do
174            expect(helper.discussion_path(discussion)).to be_nil
175          end
176        end
177      end
178
179      context 'for a non-diff discussion' do
180        let(:discussion) { create(:discussion_note_on_merge_request, noteable: merge_request, project: project).to_discussion }
181
182        it 'returns nil' do
183          expect(helper.discussion_path(discussion)).to be_nil
184        end
185      end
186
187      context 'for a contextual commit discussion' do
188        let(:commit) { merge_request.commits.last }
189        let(:discussion) { create(:diff_note_on_merge_request, noteable: merge_request, project: project, commit_id: commit.id).to_discussion }
190
191        it 'returns the merge request diff discussion scoped in the commit' do
192          expect(helper.discussion_path(discussion)).to eq(diffs_project_merge_request_path(project, merge_request, commit_id: commit.id, anchor: anchor))
193        end
194      end
195    end
196
197    context 'for a commit discussion' do
198      let(:commit) { discussion.noteable }
199
200      context 'for a diff discussion' do
201        let(:discussion) { create(:diff_note_on_commit, project: project).to_discussion }
202
203        it 'returns the commit path with the line code' do
204          expect(helper.discussion_path(discussion)).to eq(project_commit_path(project, commit, anchor: anchor))
205        end
206      end
207
208      context 'for a legacy diff discussion' do
209        let(:discussion) { create(:legacy_diff_note_on_commit, project: project).to_discussion }
210
211        it 'returns the commit path with the line code' do
212          expect(helper.discussion_path(discussion)).to eq(project_commit_path(project, commit, anchor: anchor))
213        end
214      end
215
216      context 'for a non-diff discussion' do
217        let(:discussion) { create(:discussion_note_on_commit, project: project).to_discussion }
218
219        it 'returns the commit path with the note anchor' do
220          expect(helper.discussion_path(discussion)).to eq(project_commit_path(project, commit, anchor: "note_#{discussion.first_note.id}"))
221        end
222      end
223    end
224  end
225
226  describe '#notes_url' do
227    it 'return snippet notes path for personal snippet' do
228      @snippet = create(:personal_snippet)
229
230      expect(helper.notes_url).to eq("/-/snippets/#{@snippet.id}/notes")
231    end
232
233    it 'return project notes path for project snippet' do
234      @project = project
235      @snippet = create(:project_snippet, project: @project)
236      @noteable = @snippet
237
238      expect(helper.notes_url).to eq("/#{project.full_path}/noteable/project_snippet/#{@noteable.id}/notes")
239    end
240
241    it 'return project notes path for other noteables' do
242      @project = project
243      @noteable = create(:issue, project: @project)
244
245      expect(helper.notes_url).to eq("/#{@project.full_path}/noteable/issue/#{@noteable.id}/notes")
246    end
247  end
248
249  describe '#note_url' do
250    it 'return snippet notes path for personal snippet' do
251      note = create(:note_on_personal_snippet)
252
253      expect(helper.note_url(note)).to eq("/-/snippets/#{note.noteable.id}/notes/#{note.id}")
254    end
255
256    it 'return project notes path for project snippet' do
257      @project = project
258      note = create(:note_on_project_snippet, project: @project)
259
260      expect(helper.note_url(note)).to eq("/#{project.full_path}/notes/#{note.id}")
261    end
262
263    it 'return project notes path for other noteables' do
264      @project = project
265      note = create(:note_on_issue, project: @project)
266
267      expect(helper.note_url(note)).to eq("/#{project.full_path}/notes/#{note.id}")
268    end
269  end
270
271  describe '#form_resources' do
272    it 'returns note for personal snippet' do
273      @snippet = create(:personal_snippet)
274      @note = create(:note_on_personal_snippet)
275
276      expect(helper.form_resources).to eq([@note])
277    end
278
279    it 'returns namespace, project and note for project snippet' do
280      @project = project
281      @snippet = create(:project_snippet, project: @project)
282      @note = create(:note_on_personal_snippet)
283
284      expect(helper.form_resources).to eq([@project, @note])
285    end
286
287    it 'returns namespace, project and note path for other noteables' do
288      @project = project
289      @note = create(:note_on_issue, project: @project)
290
291      expect(helper.form_resources).to eq([@project, @note])
292    end
293  end
294
295  describe '#noteable_note_url' do
296    let(:issue) { create(:issue, project: project) }
297    let(:note) { create(:note_on_issue, noteable: issue, project: project) }
298
299    it 'returns the noteable url with an anchor to the note' do
300      expect(noteable_note_url(note)).to match("/#{project.namespace.path}/#{project.path}/-/issues/#{issue.iid}##{dom_id(note)}")
301    end
302  end
303
304  describe '#discussion_resolved_intro' do
305    context 'when the discussion was resolved by a push' do
306      let(:discussion) { double(:discussion, resolved_by_push?: true) }
307
308      it 'returns "Automatically resolved"' do
309        expect(discussion_resolved_intro(discussion)).to eq('Automatically resolved')
310      end
311    end
312
313    context 'when the discussion was not resolved by a push' do
314      let(:discussion) { double(:discussion, resolved_by_push?: false) }
315
316      it 'returns "Resolved"' do
317        expect(discussion_resolved_intro(discussion)).to eq('Resolved')
318      end
319    end
320  end
321
322  describe '#notes_data' do
323    let(:issue) { create(:issue, project: project) }
324
325    before do
326      @project = project
327      @noteable = issue
328
329      allow(helper).to receive(:current_user).and_return(guest)
330    end
331
332    it 'sets last_fetched_at to 0 when start_at_zero is true' do
333      expect(helper.notes_data(issue, true)[:lastFetchedAt]).to eq(0)
334    end
335
336    it 'includes the current notes filter for the user' do
337      guest.set_notes_filter(UserPreference::NOTES_FILTERS[:only_comments], issue)
338
339      expect(helper.notes_data(issue)[:notesFilter]).to eq(UserPreference::NOTES_FILTERS[:only_comments])
340    end
341  end
342end
343