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
|
# frozen_string_literal: true
require 'spec_helper'
RSpec.describe Banzai::Filter::References::AlertReferenceFilter do
include FilterSpecHelper
let_it_be(:project) { create(:project, :public) }
let_it_be(:alert) { create(:alert_management_alert, project: project) }
let_it_be(:reference) { alert.to_reference }
it 'requires project context' do
expect { described_class.call('') }.to raise_error(ArgumentError, /:project/)
end
%w(pre code a style).each do |elem|
it "ignores valid references contained inside '#{elem}' element" do
exp = act = "<#{elem}>Alert #{reference}</#{elem}>"
expect(reference_filter(act).to_html).to eq exp
end
end
context 'internal reference' do
it 'links to a valid reference' do
doc = reference_filter("See #{reference}")
expect(doc.css('a').first.attr('href')).to eq alert.details_url
end
it 'links with adjacent text' do
doc = reference_filter("Alert (#{reference}.)")
expect(doc.to_html).to match(%r{\(<a.+>#{Regexp.escape(reference)}</a>\.\)})
end
it 'ignores invalid alert IDs' do
exp = act = "Alert #{invalidate_reference(reference)}"
expect(reference_filter(act).to_html).to eq exp
end
it 'includes a title attribute' do
doc = reference_filter("Alert #{reference}")
expect(doc.css('a').first.attr('title')).to eq alert.title
end
it 'escapes the title attribute' do
allow(alert).to receive(:title).and_return(%{"></a>whatever<a title="})
doc = reference_filter("Alert #{reference}")
expect(doc.text).to eq "Alert #{reference}"
end
it 'includes default classes' do
doc = reference_filter("Alert #{reference}")
expect(doc.css('a').first.attr('class')).to eq 'gfm gfm-alert has-tooltip'
end
it 'includes a data-project attribute' do
doc = reference_filter("Alert #{reference}")
link = doc.css('a').first
expect(link).to have_attribute('data-project')
expect(link.attr('data-project')).to eq project.id.to_s
end
it 'includes a data-alert attribute' do
doc = reference_filter("See #{reference}")
link = doc.css('a').first
expect(link).to have_attribute('data-alert')
expect(link.attr('data-alert')).to eq alert.id.to_s
end
it 'supports an :only_path context' do
doc = reference_filter("Alert #{reference}", only_path: true)
link = doc.css('a').first.attr('href')
expect(link).not_to match %r(https?://)
expect(link).to eq urls.details_project_alert_management_url(project, alert.iid, only_path: true)
end
end
context 'cross-project / cross-namespace complete reference' do
let_it_be(:namespace) { create(:namespace) }
let_it_be(:project2) { create(:project, :public, namespace: namespace) }
let_it_be(:alert) { create(:alert_management_alert, project: project2) }
let_it_be(:reference) { "#{project2.full_path}^alert##{alert.iid}" }
it 'links to a valid reference' do
doc = reference_filter("See #{reference}")
expect(doc.css('a').first.attr('href')).to eq alert.details_url
end
it 'link has valid text' do
doc = reference_filter("See (#{reference}.)")
expect(doc.css('a').first.text).to eql(reference)
end
it 'has valid text' do
doc = reference_filter("See (#{reference}.)")
expect(doc.text).to eql("See (#{reference}.)")
end
it 'ignores invalid alert IDs on the referenced project' do
exp = act = "See #{invalidate_reference(reference)}"
expect(reference_filter(act).to_html).to eq exp
end
end
context 'cross-project / same-namespace complete reference' do
let_it_be(:namespace) { create(:namespace) }
let_it_be(:project) { create(:project, :public, namespace: namespace) }
let_it_be(:project2) { create(:project, :public, namespace: namespace) }
let_it_be(:alert) { create(:alert_management_alert, project: project2) }
let_it_be(:reference) { "#{project2.full_path}^alert##{alert.iid}" }
it 'links to a valid reference' do
doc = reference_filter("See #{reference}")
expect(doc.css('a').first.attr('href')).to eq alert.details_url
end
it 'link has valid text' do
doc = reference_filter("See (#{project2.path}^alert##{alert.iid}.)")
expect(doc.css('a').first.text).to eql("#{project2.path}^alert##{alert.iid}")
end
it 'has valid text' do
doc = reference_filter("See (#{project2.path}^alert##{alert.iid}.)")
expect(doc.text).to eql("See (#{project2.path}^alert##{alert.iid}.)")
end
it 'ignores invalid alert IDs on the referenced project' do
exp = act = "See #{invalidate_reference(reference)}"
expect(reference_filter(act).to_html).to eq exp
end
end
context 'cross-project shorthand reference' do
let_it_be(:namespace) { create(:namespace) }
let_it_be(:project) { create(:project, :public, namespace: namespace) }
let_it_be(:project2) { create(:project, :public, namespace: namespace) }
let_it_be(:alert) { create(:alert_management_alert, project: project2) }
let_it_be(:reference) { "#{project2.path}^alert##{alert.iid}" }
it 'links to a valid reference' do
doc = reference_filter("See #{reference}")
expect(doc.css('a').first.attr('href')).to eq alert.details_url
end
it 'link has valid text' do
doc = reference_filter("See (#{project2.path}^alert##{alert.iid}.)")
expect(doc.css('a').first.text).to eql("#{project2.path}^alert##{alert.iid}")
end
it 'has valid text' do
doc = reference_filter("See (#{project2.path}^alert##{alert.iid}.)")
expect(doc.text).to eql("See (#{project2.path}^alert##{alert.iid}.)")
end
it 'ignores invalid alert IDs on the referenced project' do
exp = act = "See #{invalidate_reference(reference)}"
expect(reference_filter(act).to_html).to eq exp
end
end
context 'cross-project URL reference' do
let_it_be(:namespace) { create(:namespace, name: 'cross-reference') }
let_it_be(:project2) { create(:project, :public, namespace: namespace) }
let_it_be(:alert) { create(:alert_management_alert, project: project2) }
let_it_be(:reference) { alert.details_url }
it 'links to a valid reference' do
doc = reference_filter("See #{reference}")
expect(doc.css('a').first.attr('href')).to eq alert.details_url
end
it 'links with adjacent text' do
doc = reference_filter("See (#{reference}.)")
expect(doc.to_html).to match(%r{\(<a.+>#{Regexp.escape(alert.to_reference(project))}</a>\.\)})
end
it 'ignores invalid alert IDs on the referenced project' do
act = "See #{invalidate_reference(reference)}"
expect(reference_filter(act).to_html).to match(%r{<a.+>#{Regexp.escape(invalidate_reference(reference))}</a>})
end
end
context 'group context' do
let_it_be(:group) { create(:group) }
it 'links to a valid reference' do
reference = "#{project.full_path}^alert##{alert.iid}"
result = reference_filter("See #{reference}", { project: nil, group: group } )
expect(result.css('a').first.attr('href')).to eq(alert.details_url)
end
it 'ignores internal references' do
exp = act = "See ^alert##{alert.iid}"
expect(reference_filter(act, project: nil, group: group).to_html).to eq exp
end
end
context 'checking N+1' do
let(:namespace) { create(:namespace) }
let(:project2) { create(:project, :public, namespace: namespace) }
let(:alert2) { create(:alert_management_alert, project: project2) }
let(:alert_reference) { alert.to_reference }
let(:alert2_reference) { alert2.to_reference(full: true) }
it 'does not have N+1 per multiple references per project', :use_sql_query_cache do
markdown = "#{alert_reference}"
max_count = ActiveRecord::QueryRecorder.new(skip_cached: false) do
reference_filter(markdown)
end.count
expect(max_count).to eq 1
markdown = "#{alert_reference} ^alert#2 ^alert#3 ^alert#4 #{alert2_reference}"
# Since we're not batching alert queries across projects,
# we have to account for that.
# 1 for both projects, 1 for alerts in each project == 3
# TODO: https://gitlab.com/gitlab-org/gitlab/-/issues/330359
max_count += 2
expect do
reference_filter(markdown)
end.not_to exceed_all_query_limit(max_count)
end
end
end
|