Fix image webhook rewriting for uploads
This rewrote URLs to be absolute URLs. However, for uploads (the most common case), we actually need them to point to not just the GitLab instance, but the project they're from. Thankfully, we can normally get that information from the object we're building the hook for.
This commit is contained in:
Sean McGivern
parent
c7fd95584e
commit
0bcfd0adb3
|
|
@ -0,0 +1,5 @@
|
|||
---
|
||||
title: Fix auto-corrected upload URLs in webhooks
|
||||
merge_request: 22361
|
||||
author:
|
||||
type: fixed
|
||||
|
|
@ -73,8 +73,8 @@ Below are described the supported events.
|
|||
|
||||
Triggered when you push to the repository except when pushing tags.
|
||||
|
||||
> **Note:** When more than 20 commits are pushed at once, the `commits` web hook
|
||||
attribute will only contain the first 20 for performance reasons. Loading
|
||||
> **Note:** When more than 20 commits are pushed at once, the `commits` web hook
|
||||
attribute will only contain the first 20 for performance reasons. Loading
|
||||
detailed commit data is expensive. Note that despite only 20 commits being
|
||||
present in the `commits` attribute, the `total_commits_count` attribute will
|
||||
contain the actual total.
|
||||
|
|
@ -1157,10 +1157,11 @@ its description:
|
|||
```
|
||||
|
||||
It will appear in the webhook body as the below (assuming that GitLab is
|
||||
installed at gitlab.example.com):
|
||||
installed at gitlab.example.com, and the project is at
|
||||
example-group/example-project):
|
||||
|
||||
```markdown
|
||||
|
||||
|
||||
```
|
||||
|
||||
This will not rewrite URLs that already are pointing to HTTP, HTTPS, or
|
||||
|
|
|
|||
|
|
@ -25,6 +25,7 @@ module Gitlab
|
|||
markdown_text.gsub(MARKDOWN_SIMPLE_IMAGE) do
|
||||
if $~[:image]
|
||||
url = $~[:url]
|
||||
url = "#{uploads_prefix}#{url}" if url.start_with?('/uploads')
|
||||
url = "/#{url}" unless url.start_with?('/')
|
||||
|
||||
"![#{$~[:title]}](#{Gitlab.config.gitlab.url}#{url})"
|
||||
|
|
@ -33,6 +34,16 @@ module Gitlab
|
|||
end
|
||||
end
|
||||
end
|
||||
|
||||
def uploads_prefix
|
||||
project&.full_path || ''
|
||||
end
|
||||
|
||||
def project
|
||||
return unless object.respond_to?(:project)
|
||||
|
||||
object.project
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
|
|
|
|||
|
|
@ -8,57 +8,94 @@ describe Gitlab::HookData::BaseBuilder do
|
|||
end
|
||||
end
|
||||
|
||||
subject { subclass.new(nil) }
|
||||
|
||||
using RSpec::Parameterized::TableSyntax
|
||||
|
||||
where do
|
||||
{
|
||||
'relative image URL' => {
|
||||
input: '',
|
||||
output: ""
|
||||
},
|
||||
'HTTP URL' => {
|
||||
input: '',
|
||||
output: ''
|
||||
},
|
||||
'HTTPS URL' => {
|
||||
input: '',
|
||||
output: ''
|
||||
},
|
||||
'protocol-relative URL' => {
|
||||
input: '',
|
||||
output: ''
|
||||
},
|
||||
'URL reference by title' => {
|
||||
input: "![foo]\n\n[foo]: foo.png",
|
||||
output: "![foo]\n\n[foo]: foo.png"
|
||||
},
|
||||
'URL reference by label' => {
|
||||
input: "![][foo]\n\n[foo]: foo.png",
|
||||
output: "![][foo]\n\n[foo]: foo.png"
|
||||
},
|
||||
'in Markdown inline code block' => {
|
||||
input: '``',
|
||||
output: "``"
|
||||
},
|
||||
'in HTML tag on the same line' => {
|
||||
input: '<p></p>',
|
||||
output: "<p></p>"
|
||||
},
|
||||
'in Markdown multi-line code block' => {
|
||||
input: "```\n\n```",
|
||||
output: "```\n\n```"
|
||||
},
|
||||
'in HTML tag on different lines' => {
|
||||
input: "<p>\n\n</p>",
|
||||
output: "<p>\n\n</p>"
|
||||
context 'with an upload prefix specified' do
|
||||
let(:project_with_path) { double(full_path: 'baz/bar') }
|
||||
let(:object_with_project) { double(project: project_with_path) }
|
||||
subject { subclass.new(object_with_project) }
|
||||
|
||||
where do
|
||||
{
|
||||
'relative image URL' => {
|
||||
input: '',
|
||||
output: ""
|
||||
},
|
||||
'absolute upload URL' => {
|
||||
input: '',
|
||||
output: ""
|
||||
},
|
||||
'absolute non-upload URL' => {
|
||||
input: '',
|
||||
output: ""
|
||||
}
|
||||
}
|
||||
}
|
||||
end
|
||||
|
||||
with_them do
|
||||
it { expect(subject.absolute_image_urls(input)).to eq(output) }
|
||||
end
|
||||
end
|
||||
|
||||
with_them do
|
||||
it { expect(subject.absolute_image_urls(input)).to eq(output) }
|
||||
context 'without an upload prefix specified' do
|
||||
subject { subclass.new(nil) }
|
||||
|
||||
where do
|
||||
{
|
||||
'relative image URL' => {
|
||||
input: '',
|
||||
output: ""
|
||||
},
|
||||
'absolute upload URL' => {
|
||||
input: '',
|
||||
output: ""
|
||||
},
|
||||
'absolute non-upload URL' => {
|
||||
input: '',
|
||||
output: ""
|
||||
},
|
||||
'HTTP URL' => {
|
||||
input: '',
|
||||
output: ''
|
||||
},
|
||||
'HTTPS URL' => {
|
||||
input: '',
|
||||
output: ''
|
||||
},
|
||||
'protocol-relative URL' => {
|
||||
input: '',
|
||||
output: ''
|
||||
},
|
||||
'URL reference by title' => {
|
||||
input: "![foo]\n\n[foo]: foo.png",
|
||||
output: "![foo]\n\n[foo]: foo.png"
|
||||
},
|
||||
'URL reference by label' => {
|
||||
input: "![][foo]\n\n[foo]: foo.png",
|
||||
output: "![][foo]\n\n[foo]: foo.png"
|
||||
},
|
||||
'in Markdown inline code block' => {
|
||||
input: '``',
|
||||
output: "``"
|
||||
},
|
||||
'in HTML tag on the same line' => {
|
||||
input: '<p></p>',
|
||||
output: "<p></p>"
|
||||
},
|
||||
'in Markdown multi-line code block' => {
|
||||
input: "```\n\n```",
|
||||
output: "```\n\n```"
|
||||
},
|
||||
'in HTML tag on different lines' => {
|
||||
input: "<p>\n\n</p>",
|
||||
output: "<p>\n\n</p>"
|
||||
}
|
||||
}
|
||||
end
|
||||
|
||||
with_them do
|
||||
it { expect(subject.absolute_image_urls(input)).to eq(output) }
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
|
|
|
|||
|
|
@ -46,7 +46,10 @@ describe Gitlab::HookData::IssueBuilder do
|
|||
let(:builder) { described_class.new(issue_with_description) }
|
||||
|
||||
it 'sets the image to use an absolute URL' do
|
||||
expect(data[:description]).to eq("test")
|
||||
expected_path = "#{issue_with_description.project.path_with_namespace}/uploads/abc/Issue_Image.png"
|
||||
|
||||
expect(data[:description])
|
||||
.to eq("test")
|
||||
end
|
||||
end
|
||||
end
|
||||
|
|
|
|||
|
|
@ -58,11 +58,14 @@ describe Gitlab::HookData::MergeRequestBuilder do
|
|||
end
|
||||
|
||||
context 'when the MR has an image in the description' do
|
||||
let(:mr_with_description) { create(:merge_request, description: 'test') }
|
||||
let(:mr_with_description) { create(:merge_request, description: 'test') }
|
||||
let(:builder) { described_class.new(mr_with_description) }
|
||||
|
||||
it 'sets the image to use an absolute URL' do
|
||||
expect(data[:description]).to eq("test")
|
||||
expected_path = "#{mr_with_description.project.path_with_namespace}/uploads/abc/MR_Image.png"
|
||||
|
||||
expect(data[:description])
|
||||
.to eq("test")
|
||||
end
|
||||
end
|
||||
end
|
||||
|
|
|
|||
Loading…
Reference in New Issue