docbrown/spec/models/billboard_spec.rb
Ben Halpern f0673648c2
Add preferred_article_ids to billboards (#20437)
* Add preferred_article_ids to billboards

* Adjust query

* Refactor method

* Refactor method

* Fix input type

* Add feature flag
2023-12-18 19:20:56 +00:00

632 lines
24 KiB
Ruby

require "rails_helper"
RSpec.describe Billboard do
let(:organization) { build(:organization) }
let(:billboard) { build(:billboard, organization: nil) }
let(:audience_segment) { create(:audience_segment) }
it_behaves_like "Taggable"
describe "validations" do
describe "builtin validations" do
subject { billboard }
it { is_expected.to belong_to(:organization).optional }
it { is_expected.to have_many(:billboard_events).dependent(:destroy) }
it { is_expected.to validate_presence_of(:placement_area) }
it { is_expected.to validate_presence_of(:body_markdown) }
it { is_expected.to have_many(:tags) }
end
it "allows sidebar_right" do
billboard.placement_area = "sidebar_right"
expect(billboard).to be_valid
end
it "allows sidebar_left" do
billboard.placement_area = "sidebar_left"
expect(billboard).to be_valid
end
it "allows home_hero with in_house" do
billboard.placement_area = "home_hero"
billboard.type_of = "in_house"
expect(billboard).to be_valid
end
it "does not allow home_hero with community" do
billboard.placement_area = "home_hero"
billboard.type_of = "community"
expect(billboard).not_to be_valid
expect(billboard.errors[:type_of])
.to include("must be in_house if billboard is a Home Hero")
end
it "disallows unacceptable placement_area" do
billboard.placement_area = "tsdsdsdds"
expect(billboard).not_to be_valid
end
it "returns human readable name" do
billboard.placement_area = "sidebar_left_2"
expect(billboard.human_readable_placement_area).to eq("Sidebar Left (Second Position)")
end
it "allows creator_id to be set" do
billboard.creator = build(:user)
expect(billboard).to be_valid
end
it "does not require creator to be valid" do
billboard.creator = nil
expect(billboard).to be_valid
end
it "requires organization_id for community-type ads" do
expect(billboard).to be_valid
billboard.type_of = "community"
expect(billboard).not_to be_valid
expect(billboard.errors[:organization]).not_to be_blank
billboard.organization = organization
expect(billboard).to be_valid
expect(billboard.errors[:organization]).to be_blank
end
it "allows clear audience segment" do
billboard.audience_segment_id = audience_segment.id
expect(billboard).to be_valid
billboard.audience_segment_id = audience_segment.id
billboard.audience_segment_type = audience_segment.type_of
expect(billboard).to be_valid
end
it "disallows invalid audience segment" do
billboard.audience_segment_id = audience_segment.id
billboard.audience_segment_type = "something_invalid_here"
expect(audience_segment.type_of).not_to eq("something_invalid_here")
expect(billboard).not_to be_valid
end
it "disallows valid but ambiguous audience segment & id mismatch" do
billboard.audience_segment_id = audience_segment.id
billboard.audience_segment_type = "posted"
expect(audience_segment.type_of).not_to eq("posted")
expect(billboard).not_to be_valid
end
it "disallows valid but imprecise manual audience segment type" do
billboard.audience_segment = nil
billboard.audience_segment_type = "manual"
expect(billboard).not_to be_valid
end
end
context "when range env var is set" do
it "translates jiberrish to 0" do
allow(ApplicationConfig).to receive(:[]).with("SELDOM_SEEN_MIN_FOR_SIDEBAR_LEFT").and_return("jibberish")
expect(described_class.random_range_max("sidebar_left")).to eq 0
end
it "still performs query with number" do
allow(ApplicationConfig).to receive(:[]).with("SELDOM_SEEN_MIN_FOR_SIDEBAR_LEFT").and_return("100")
expect(described_class.random_range_max("sidebar_left")).to eq 100
end
it "falls back to broadly set range vars" do
allow(ApplicationConfig).to receive(:[]).with("SELDOM_SEEN_MIN_FOR_SIDEBAR_LEFT").and_return(nil)
allow(ApplicationConfig).to receive(:[]).with("SELDOM_SEEN_MIN").and_return("89")
expect(described_class.random_range_max("sidebar_left")).to eq 89
end
end
context "when parsing liquid tags" do
it "renders username embed" do
user = create(:user)
url = "#{URL.url}/#{user.username}"
allow(UnifiedEmbed::Tag).to receive(:validate_link).with(any_args).and_return(url)
username_ad = create(:billboard, body_markdown: "Hello! {% embed #{url}} %}")
expect(username_ad.processed_html).to include("/#{user.username}")
expect(username_ad.processed_html).to include("ltag__user__link")
end
end
context "when render_mode is set to raw" do
it "outputs processed html that matches the body input" do
raw_input = "<style>.bb { color: red }</style><div class=\"bb\">This is a raw div</div>"
raw_billboard = create(:billboard, body_markdown: raw_input, render_mode: "raw")
expect(raw_billboard.processed_html).to eq raw_input
end
it "still processes images in raw mode" do
raw_input = "<div class=\"bb\"><img src=\"https://dummyimage.com/100x100\" /></div>"
raw_billboard = create(:billboard, body_markdown: raw_input, render_mode: "raw")
expect(raw_billboard.processed_html).to include "dummyimage.com/100x100\" width=\"\" height=\"\" loading=\"lazy\""
end
end
context "when render_mode is not set to raw" do
it "outputs processed html that sanitizes raw html as if it were markdown" do
raw_input = "<style>.bb { color: red }</style><div class=\"bb\">This is a raw div</div>"
raw_billboard = create(:billboard, body_markdown: raw_input) # default render mode
expect(raw_billboard.processed_html).to eq "<p>.bb { color: red }</p>This is a raw div"
end
end
context "when callbacks are triggered before save" do
before { billboard.save! }
it "generates #processed_html from #body_markdown" do
expect(billboard.processed_html).to start_with("<p>Hello <em>hey</em> Hey hey")
end
it "does not render <div>" do
div_html = "<div>Good morning, how are you?</div>"
p_html = "<p>Good morning, how are you?</p>"
billboard.update(body_markdown: div_html)
billboard.reload
expect(billboard.processed_html).to eq(p_html)
end
it "does not render disallowed tags" do
billboard.update(body_markdown: "<style>body { color: black}</style> Hey hey")
expect(billboard.processed_html).to eq("<p>body { color: black} Hey hey</p>")
end
it "does not render disallowed attributes" do
billboard.update(body_markdown: "<p style='margin-top:100px'>Hello <em>hey</em> Hey hey</p>")
expect(billboard.processed_html).to start_with("<p>Hello <em>hey</em> Hey hey</p>")
end
end
describe "#process_markdown" do
# FastImage.size is called when synchronous_detail_detection: true is passed to Html::Parser#prefix_all_images
# which should be the case for Billboard
# Images::Optimizer is also called with widht
it "calls Html::Parser#prefix_all_images with parameters" do
# Html::Parser.new(html).prefix_all_images(prefix_width, synchronous_detail_detection: true).html
image_url = "https://dummyimage.com/100x100"
allow(FastImage).to receive(:size)
allow(Images::Optimizer).to receive(:call).and_return(image_url)
image_md = "![Image description](#{image_url})<p style='margin-top:100px'>Hello <em>hey</em> Hey hey</p>"
create(:billboard, body_markdown: image_md, placement_area: "post_comments")
options = { http_header: { "User-Agent" => "DEV(local) (http://forem.test)" }, timeout: 10 }
expect(FastImage).to have_received(:size).with(image_url, options)
# width is billboard.prefix_width
expect(Images::Optimizer).to have_received(:call).with(image_url, width: Billboard::POST_WIDTH, quality: 100)
# Images::Optimizer.call(source, width: width)
end
it "uses sidebar width for sidebar location" do
image_url = "https://dummyimage.com/100x100"
allow(FastImage).to receive(:size)
allow(Images::Optimizer).to receive(:call).and_return(image_url)
image_md = "![Image description](#{image_url})<p style='margin-top:100px'>Hello <em>hey</em> Hey hey</p>"
create(:billboard, body_markdown: image_md, placement_area: "post_sidebar")
expect(Images::Optimizer).to have_received(:call).with(image_url, width: Billboard::SIDEBAR_WIDTH, quality: 100)
end
it "uses post width for feed location" do
image_url = "https://dummyimage.com/100x100"
allow(FastImage).to receive(:size)
allow(Images::Optimizer).to receive(:call).and_return(image_url)
image_md = "![Image description](#{image_url})<p style='margin-top:100px'>Hello <em>hey</em> Hey hey</p>"
create(:billboard, body_markdown: image_md, placement_area: "feed_second")
expect(Images::Optimizer).to have_received(:call).with(image_url, width: Billboard::POST_WIDTH, quality: 100)
end
it "keeps the same processed_html if markdown was not changed" do
billboard = create(:billboard)
html = billboard.processed_html
billboard.update(name: "Sample billboard")
billboard.reload
expect(billboard.processed_html).to eq(html)
end
end
describe "after_save callbacks" do
let!(:billboard) { create(:billboard, name: nil) }
it "generates a name when one does not exist" do
billboard_with_name = create(:billboard, name: "Test")
expect(billboard.name).to eq("Billboard #{billboard.id}")
expect(billboard_with_name.name).to eq("Test")
end
end
describe ".search_ads" do
let!(:billboard) do
create(:billboard, name: "This is a billboard", body_markdown: "Billboard Body", placement_area: "post_comments")
end
it "finds via name" do
expect(described_class.search_ads("this").ids).to contain_exactly(billboard.id)
end
it "finds via body" do
expect(described_class.search_ads("body").ids).to contain_exactly(billboard.id)
end
it "finds via placement_area" do
expect(described_class.search_ads("comment").ids).to contain_exactly(billboard.id)
end
it "finds just one result via multiple criteria" do
expect(described_class.search_ads("billboard").ids).to contain_exactly(billboard.id)
end
it "returns empty when no match" do
expect(described_class.search_ads("foo")).to eq([])
end
end
describe ".validate_tag" do
it "rejects more than 10 tags" do
twenty_six_tags = Array.new(26) { SecureRandom.alphanumeric(8) }.join(", ")
expect(build(:billboard,
name: "This is a billboard",
body_markdown: "Billboard Body",
placement_area: "post_comments",
tag_list: twenty_six_tags).valid?).to be(false)
end
it "rejects tags with length > 30" do
tags = "'testing tag length with more than 30 chars', tag"
expect(build(:billboard,
name: "This is a billboard",
body_markdown: "Billboard Body",
placement_area: "post_comments",
tag_list: tags).valid?).to be(false)
end
it "rejects tag with non-alphanumerics" do
expect do
build(:billboard,
name: "This is a billboard",
body_markdown: "Billboard Body",
placement_area: "post_comments",
tag_list: "c++").validate!
end.to raise_error(ActiveRecord::RecordInvalid)
end
it "always downcase tags" do
tags = "UPPERCASE, CAPITALIZE"
billboard = create(:billboard, name: "This is a billboard",
body_markdown: "Billboard Body",
placement_area: "post_comments",
tag_list: tags)
expect(billboard.tag_list).to eq(tags.downcase.split(", "))
end
end
describe ".validate_geolocations" do
subject(:billboard) do
build(
:billboard,
name: "This is a billboard",
body_markdown: "Billboard Body",
placement_area: "post_comments",
target_geolocations: geo_input,
)
end
let(:target_geolocations) do
[
Geolocation.new("US", "CA"),
Geolocation.new("CA", "ON"),
Geolocation.new("CA", "BC"),
]
end
context "with nil" do
let(:geo_input) { nil }
it "permits them" do
expect(billboard).to be_valid
expect(billboard.target_geolocations).to be_empty
end
end
context "with empty string" do
let(:geo_input) { "" }
it "permits them" do
expect(billboard).to be_valid
expect(billboard.target_geolocations).to be_empty
end
end
context "with empty array" do
let(:geo_input) { [] }
it "permits them" do
expect(billboard).to be_valid
expect(billboard.target_geolocations).to be_empty
end
end
context "with comma-separated list of ISO 3166-2" do
let(:geo_input) { "US-CA, CA-ON, CA-BC" }
it "permits them" do
expect(billboard).to be_valid
expect(billboard.target_geolocations).to match_array(target_geolocations)
end
end
context "with array of ISO 3166-2" do
let(:geo_input) { %w[US-CA CA-ON CA-BC] }
it "permits them" do
expect(billboard).to be_valid
expect(billboard.target_geolocations).to match_array(target_geolocations)
end
end
context "with array of geolocations" do
let(:geo_input) { [Geolocation.new("US", "CA"), Geolocation.new("CA", "ON"), Geolocation.new("CA", "BC")] }
it "permits them" do
expect(billboard).to be_valid
expect(billboard.target_geolocations).to match_array(target_geolocations)
end
end
context "with invalid comma-separated ISO 3166-2 codes" do
let(:geo_input) { "US-CA, NOT-REAL" }
it "does not permit them" do
expect(billboard).not_to be_valid
expect(billboard.errors_as_sentence).to include("NOT-REAL is not an enabled target ISO 3166-2 code")
end
end
context "with invalid array of ISO 3166-2 codes" do
let(:geo_input) { %w[CA-QC CA-FAKE] }
it "does not permit them" do
expect(billboard).not_to be_valid
expect(billboard.errors_as_sentence).to include("CA-FAKE is not an enabled target ISO 3166-2 code")
end
end
context "with valid ISO 3166-2 country codes that are not enabled" do
let(:geo_input) { %w[MX NG] }
it "does not permit them" do
expect(billboard).not_to be_valid
expect(billboard.errors_as_sentence).to include("MX is not an enabled target ISO 3166-2 code")
expect(billboard.errors_as_sentence).to include("NG is not an enabled target ISO 3166-2 code")
end
end
context "with countries that don't have region targeting enabled" do
let(:geo_input) { %w[FR-BRE NL GB US-CA] }
let(:enabled_countries) do
{
"US" => :with_regions,
"FR" => :without_regions,
"NL" => :without_regions,
"GB" => :without_regions
}
end
it "permits country-level targets but not region-level ones" do
allow(Settings::General).to receive(:billboard_enabled_countries).and_return(enabled_countries)
expect(billboard).not_to be_valid
expect(billboard.errors_as_sentence).to include("FR-BRE is not an enabled target ISO 3166-2 code")
# Remove faulty region targeting
billboard.target_geolocations = %w[FR NL GB US-CA]
expect(billboard).to be_valid
# Allow French region targeting
enabled_countries["FR"] = :with_regions
billboard.target_geolocations = geo_input
expect(billboard).to be_valid
end
end
end
describe "#exclude_articles_ids" do
it "processes array of integer ids as expected" do
billboard.exclude_article_ids = ["11"]
expect(billboard.exclude_article_ids).to contain_exactly(11)
billboard.exclude_article_ids = %w[11 12 13 14]
expect(billboard.exclude_article_ids).to contain_exactly(11, 12, 13, 14)
billboard.exclude_article_ids = "11,12,13,14"
expect(billboard.exclude_article_ids).to contain_exactly(11, 12, 13, 14)
billboard.exclude_article_ids = ""
expect(billboard.exclude_article_ids).to eq([])
billboard.exclude_article_ids = []
expect(billboard.exclude_article_ids).to eq([])
billboard.exclude_article_ids = ["", "", ""]
expect(billboard.exclude_article_ids).to eq([])
billboard.exclude_article_ids = [nil]
expect(billboard.exclude_article_ids).to eq([])
billboard.exclude_article_ids = nil
expect(billboard.exclude_article_ids).to eq([])
end
it "round-trips to the database as expected" do
billboard.exclude_article_ids = [11]
billboard.save!
expect(billboard.exclude_article_ids).to contain_exactly(11)
billboard.update(exclude_article_ids: "11,12,13,14")
expect(billboard.exclude_article_ids).to contain_exactly(11, 12, 13, 14)
billboard.update(exclude_article_ids: nil)
expect(billboard.exclude_article_ids).to eq([])
end
end
describe "when a stale audience segment is associated" do
let(:audience_segment) do
Timecop.travel(5.days.ago) do
create(:audience_segment)
end
end
before { allow(AudienceSegmentRefreshWorker).to receive(:perform_async) }
it "refreshes audience segment as an asynchronous callback" do
billboard.save!
expect(AudienceSegmentRefreshWorker).not_to have_received(:perform_async)
billboard.update audience_segment: audience_segment
expect(AudienceSegmentRefreshWorker).to have_received(:perform_async)
.with(audience_segment.id)
end
end
describe "when a fresh audience segment is associated" do
let(:audience_segment) { create(:audience_segment) }
before { allow(AudienceSegmentRefreshWorker).to receive(:perform_async) }
it "does not need to refresh audience segment" do
billboard.update audience_segment: audience_segment
expect(AudienceSegmentRefreshWorker).not_to have_received(:perform_async)
end
end
describe "seldom_seen scope" do
let(:low_impression_count) { Billboard::LOW_IMPRESSION_COUNT }
let!(:low_impression_ad) { create(:billboard, impressions_count: low_impression_count - 1) }
let!(:high_impression_ad) { create(:billboard, impressions_count: low_impression_count + 1) }
before { create(:billboard, priority: true, impressions_count: low_impression_count + 1) }
it "includes ads with impressions count less than LOW_IMPRESSION_COUNT" do
expect(described_class.seldom_seen("sidebar_left")).to include(low_impression_ad)
end
it "does not include ads with impression count more than env area override of LOW_IMPRESSION_COUNT" do
allow(ApplicationConfig).to receive(:[]).with("LOW_IMPRESSION_COUNT_FOR_SIDEBAR_LEFT").and_return("990")
expect(described_class.seldom_seen("sidebar_left")).not_to include(low_impression_ad)
end
it "includes ads with impression count less than than env area override of LOW_IMPRESSION_COUNT" do
allow(ApplicationConfig).to receive(:[]).with("LOW_IMPRESSION_COUNT_FOR_SIDEBAR_LEFT").and_return("1010")
expect(described_class.seldom_seen("sidebar_left")).to include(low_impression_ad)
end
it "does not include ads with impression count more than env GLOBAL override of LOW_IMPRESSION_COUNT" do
allow(ApplicationConfig).to receive(:[]).with("LOW_IMPRESSION_COUNT").and_return("990")
allow(ApplicationConfig).to receive(:[]).with("LOW_IMPRESSION_COUNT_FOR_SIDEBAR_LEFT").and_return(nil)
expect(described_class.seldom_seen("sidebar_left")).not_to include(low_impression_ad)
end
it "includes ads with impression count less than than env GLOBAL override of LOW_IMPRESSION_COUNT" do
allow(ApplicationConfig).to receive(:[]).with("LOW_IMPRESSION_COUNT").and_return("1010")
allow(ApplicationConfig).to receive(:[]).with("LOW_IMPRESSION_COUNT_FOR_SIDEBAR_LEFT").and_return(nil)
expect(described_class.seldom_seen("sidebar_left")).to include(low_impression_ad)
end
it "ignores override of LOW_IMPRESSION_COUNT to a different location" do
allow(ApplicationConfig).to receive(:[]).with("LOW_IMPRESSION_COUNT_FOR_POST_COMMENTS").and_return("990")
allow(ApplicationConfig).to receive(:[]).with("LOW_IMPRESSION_COUNT_FOR_SIDEBAR_LEFT").and_return(nil)
allow(ApplicationConfig).to receive(:[]).with("LOW_IMPRESSION_COUNT").and_return(nil)
expect(described_class.seldom_seen("sidebar_left")).to include(low_impression_ad)
end
it "excludes ads with impressions count greater than or equal to LOW_IMPRESSION_COUNT" do
expect(described_class.seldom_seen("sidebar_left")).not_to include(high_impression_ad)
end
it "includes both priority to be proper size when two qualifying ads exist" do
expect(described_class.seldom_seen("sidebar_left").size).to be 2
end
end
describe ".weighted_random_selection" do
context "when no target_article_id is provided" do
it "samples with weights correctly" do
described_class.delete_all
bb1 = create(:billboard, weight: 5)
bb2 = create(:billboard, weight: 1)
bb3 = create(:billboard, weight: 1)
bb4 = create(:billboard, weight: 2)
bb5 = create(:billboard, weight: 1)
total_weight = 5 + 1 + 1 + 2 + 1 # 10
expected_probabilities = {
bb1.id => 5.0 / total_weight,
bb2.id => 1.0 / total_weight,
bb3.id => 1.0 / total_weight,
bb4.id => 2.0 / total_weight,
bb5.id => 1.0 / total_weight
}
counts = Hash.new(0)
num_trials = 5_000
num_trials.times do
id = described_class.weighted_random_selection(described_class.all).id
counts[id] += 1
end
counts.each do |id, count|
observed_probability = count.to_f / num_trials
expected_probability = expected_probabilities[id]
expect(observed_probability).to be_within(0.025).of(expected_probability)
end
end
end
context "when a target_article_id is provided" do
it "favors records containing the target_article_id" do
allow(FeatureFlag).to receive(:enabled?).with(:article_id_adjusted_weight).and_return(true)
described_class.delete_all
target_article_id = 123
favored_weight_multiplier = 10
# Create billboards with different weights and article_ids
bb1 = create(:billboard, weight: 5, preferred_article_ids: [target_article_id])
bb2 = create(:billboard, weight: 1, preferred_article_ids: [])
bb3 = create(:billboard, weight: 1, preferred_article_ids: [target_article_id])
bb4 = create(:billboard, weight: 2, preferred_article_ids: [])
bb5 = create(:billboard, weight: 1, preferred_article_ids: [])
# Adjusted total weight accounting for the favored records
total_weight = (5 * favored_weight_multiplier) + 1 + (1 * favored_weight_multiplier) + 2 + 1
expected_probabilities = {
bb1.id => (5.0 * favored_weight_multiplier) / total_weight,
bb2.id => 1.0 / total_weight,
bb3.id => (1.0 * favored_weight_multiplier) / total_weight,
bb4.id => 2.0 / total_weight,
bb5.id => 1.0 / total_weight
}
counts = Hash.new(0)
num_trials = 5_000
num_trials.times do
id = described_class.weighted_random_selection(described_class.all, target_article_id).id
counts[id] += 1
end
counts.each do |id, count|
observed_probability = count.to_f / num_trials
expected_probability = expected_probabilities[id]
expect(observed_probability).to be_within(0.025).of(expected_probability)
end
end
end
end
end