Skip to content

A platform for community discussion. Free, open, simple.

DEV: move inline_data check for onbox to be after domain check (#39792)

Gabriel Grubbaa2853178bf4c
diff --git a/lib/inline_oneboxer.rb b/lib/inline_oneboxer.rb
index 2eb89218a7d..6d78c3776f2 100644
--- a/lib/inline_oneboxer.rb
+++ b/lib/inline_oneboxer.rb
@@ -58,41 +58,43 @@ class InlineOneboxer
end
end
- if data = Oneboxer.inline_data_for(url)
- return onebox_for(url, data[:title], opts, css_class: data[:css_class])
- end
-
always_allow = SiteSetting.enable_inline_onebox_on_all_domains
allowed_domains = SiteSetting.allowed_inline_onebox_domains&.split("|") unless always_allow
- if always_allow || allowed_domains
- uri =
- begin
- URI(url)
- rescue URI::Error
- end
+ return nil unless always_allow || allowed_domains
- if uri.present? && uri.hostname.present? &&
- (always_allow || allowed_domains.include?(uri.hostname)) &&
- !Onebox::DomainChecker.is_blocked?(uri.hostname)
- max_redirects = 0 if SiteSetting.block_onebox_on_redirect
- headers = { "Accept-Language" => Oneboxer.accept_language }
- if SiteSetting.inline_onebox_user_agent.present?
- headers["User-Agent"] = SiteSetting.inline_onebox_user_agent
- end
- title =
- RetrieveTitle.crawl(
- url,
- max_redirects: max_redirects,
- initial_https_redirect_ignore_limit: SiteSetting.block_onebox_on_redirect,
- headers: headers,
- )
- title = nil if title && title.length < MIN_TITLE_LENGTH
- return onebox_for(url, title, opts)
+ uri =
+ begin
+ URI(url)
+ rescue URI::Error
+ nil
end
+
+ return nil if uri.blank? || uri.hostname.blank?
+ return nil unless always_allow || allowed_domains.include?(uri.hostname)
+ return nil if Onebox::DomainChecker.is_blocked?(uri.hostname)
+
+ if data = Oneboxer.inline_data_for(url)
+ return onebox_for(url, data[:title], opts, css_class: data[:css_class])
end
- nil
+ max_redirects = 0 if SiteSetting.block_onebox_on_redirect
+ headers = { "Accept-Language" => Oneboxer.accept_language }
+
+ if SiteSetting.inline_onebox_user_agent.present?
+ headers["User-Agent"] = SiteSetting.inline_onebox_user_agent
+ end
+
+ title =
+ RetrieveTitle.crawl(
+ url,
+ max_redirects: max_redirects,
+ initial_https_redirect_ignore_limit: SiteSetting.block_onebox_on_redirect,
+ headers: headers,
+ )
+ title = nil if title && title.length < MIN_TITLE_LENGTH
+
+ onebox_for(url, title, opts)
end
def self.is_previewing?(user_id)
diff --git a/spec/lib/inline_oneboxer_spec.rb b/spec/lib/inline_oneboxer_spec.rb
index 188c35eb63e..af7c46111bb 100644
--- a/spec/lib/inline_oneboxer_spec.rb
+++ b/spec/lib/inline_oneboxer_spec.rb
@@ -435,17 +435,77 @@ RSpec.describe InlineOneboxer do
end
end
- it "returns engine-supplied title and css_class" do
- url = "https://example.com/foo"
- allow(Oneboxer).to receive(:inline_data_for).with(url).and_return(
- title: "Engine title",
- css_class: "--engine-class",
- )
-
- expect(InlineOneboxer.lookup(url, skip_cache: true)).to eq(
- url: url,
- title: "Engine title",
- css_class: "--engine-class",
- )
+ describe "engine-supplied inline data" do
+ let(:url) { "https://example.com/foo" }
+ let(:engine_data) { { title: "Engine title", css_class: "--engine-class" } }
+
+ it "returns engine-supplied title and css_class when domain is allowed" do
+ SiteSetting.enable_inline_onebox_on_all_domains = false
+ SiteSetting.allowed_inline_onebox_domains = "example.com"
+ allow(Oneboxer).to receive(:inline_data_for).with(url).and_return(engine_data)
+
+ expect(InlineOneboxer.lookup(url, skip_cache: true)).to eq(
+ url: url,
+ title: "Engine title",
+ css_class: "--engine-class",
+ )
+ end
+
+ it "returns engine-supplied data under enable_inline_onebox_on_all_domains" do
+ SiteSetting.enable_inline_onebox_on_all_domains = true
+ allow(Oneboxer).to receive(:inline_data_for).with(url).and_return(engine_data)
+
+ expect(InlineOneboxer.lookup(url, skip_cache: true)).to eq(
+ url: url,
+ title: "Engine title",
+ css_class: "--engine-class",
+ )
+ end
+
+ it "does not call the engine when no inline-onebox policy permits the domain" do
+ SiteSetting.enable_inline_onebox_on_all_domains = false
+ SiteSetting.allowed_inline_onebox_domains = ""
+ allow(Oneboxer).to receive(:inline_data_for)
+
+ expect(InlineOneboxer.lookup(url, skip_cache: true)).to be_nil
+ expect(Oneboxer).not_to have_received(:inline_data_for)
+ end
+
+ it "does not call the engine when the domain is not in allowed_inline_onebox_domains" do
+ SiteSetting.enable_inline_onebox_on_all_domains = false
+ SiteSetting.allowed_inline_onebox_domains = "other.com"
+ allow(Oneboxer).to receive(:inline_data_for)
+
+ expect(InlineOneboxer.lookup(url, skip_cache: true)).to be_nil
+ expect(Oneboxer).not_to have_received(:inline_data_for)
+ end
+
+ it "does not call the engine when the domain is in blocked_onebox_domains" do
+ SiteSetting.allowed_inline_onebox_domains = "example.com"
+ SiteSetting.blocked_onebox_domains = "example.com"
+ allow(Oneboxer).to receive(:inline_data_for)
+
+ expect(InlineOneboxer.lookup(url, skip_cache: true)).to be_nil
+ expect(Oneboxer).not_to have_received(:inline_data_for)
+ end
+
+ it "does not call the engine when blocked_onebox_domains matches under enable_inline_onebox_on_all_domains" do
+ SiteSetting.enable_inline_onebox_on_all_domains = true
+ SiteSetting.blocked_onebox_domains = "example.com"
+ allow(Oneboxer).to receive(:inline_data_for)
+
+ expect(InlineOneboxer.lookup(url, skip_cache: true)).to be_nil
+ expect(Oneboxer).not_to have_received(:inline_data_for)
+ end
+
+ it "does not call the engine when blocked_onebox_domains matches a parent domain" do
+ SiteSetting.enable_inline_onebox_on_all_domains = true
+ SiteSetting.blocked_onebox_domains = "example.com"
+ allow(Oneboxer).to receive(:inline_data_for)
+
+ subdomain_url = "https://api.example.com/foo"
+ expect(InlineOneboxer.lookup(subdomain_url, skip_cache: true)).to be_nil
+ expect(Oneboxer).not_to have_received(:inline_data_for)
+ end
end
end