mozilla-mobile/application-services/components/merino/src/curated_recommendations/tests.rs

Revision control

Copy as Markdown

/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*/
use super::*;
use crate::curated_recommendations::models::feeds::FeedSection;
use crate::curated_recommendations::models::layout::{Layout, ResponsiveLayout, Tile};
use crate::curated_recommendations::models::locale::CuratedRecommendationLocale;
use crate::curated_recommendations::models::request::SectionSettings;
use crate::curated_recommendations::models::response::{
CuratedRecommendationsResponse, RecommendationDataItem,
};
struct FakeHttpClientSuccess;
impl http::HttpClientTrait for FakeHttpClientSuccess {
fn make_curated_recommendation_request(
&self,
_request: &CuratedRecommendationsRequest,
_user_agent_header: &str,
_base_host: Url,
) -> Result<CuratedRecommendationsResponse> {
Ok(CuratedRecommendationsResponse {
recommended_at: 1740764371347,
data: vec![
RecommendationDataItem {
corpus_item_id: "18fbf4e1-3a8b-4b28-84a0-b6b4b785a44b".to_string(),
scheduled_corpus_item_id: Some("af067d76-c72d-4dfa-ba53-7c6c5b204c17".to_string()),
title: "TEST Cat Accidentally Summons Eldritch Horror While Playing With String".to_string(),
excerpt: "TikTok's obsession with Scandinavian sweets, which began in early 2024, has squeezed global supply chains and shows no signs of slowing down.".to_string(),
topic: Option::from("business".to_string()),
publisher: "Bloomberg Business week".to_string(),
is_time_sensitive: false,
icon_url: None,
tile_id: Some(6487013562368874),
received_rank: 0,
},
RecommendationDataItem {
corpus_item_id: "e215a2b8-b188-484b-af03-c0fd99f853f5".to_string(),
scheduled_corpus_item_id: Some("2de2453f-b38b-4713-8dcb-82660856efd7".to_string()),
title: "TEST Breaking News: Even Moderately Maintained Roofs (Rooves?) Continue to Protect From Elements".to_string(),
excerpt: "Housing sector insiders say the mere threat of a tariff war with the U.S. is another painful blow to an industry that has been struggling to get projects off the ground and keep up with demand. ".to_string(),
topic: Option::from("business".to_string()),
publisher: "CBC".to_string(),
is_time_sensitive: false,
tile_id: Some(2140274178832306),
received_rank: 1,
},
RecommendationDataItem {
corpus_item_id: "51bdde04-058f-458b-9c41-91c3cdea6d35".to_string(),
scheduled_corpus_item_id: Some("552466da-2345-4a8c-a714-8b45c4561031".to_string()),
title: "TEST 'We're Not Prepared': The World Braces for Man to Step Into the Same River Twice".to_string(),
excerpt: "Trump has said he wants school policy to be left to the states, but state officials and lawmakers aren't clear on what that would look like. ".to_string(),
topic: Option::from("government".to_string()),
publisher: "NBC News".to_string(),
is_time_sensitive: true,
tile_id: Some(4434955254511817),
received_rank: 2,
},
RecommendationDataItem {
corpus_item_id: "b0b2d1f0-312b-4d9a-9bda-ecd37f32fb40".to_string(),
scheduled_corpus_item_id: Some("37bf860b-c91a-4d99-9923-ba3b640502cf".to_string()),
title: "TEST Dogs and cats get along after centuries of fighting".to_string(),
excerpt: "The US president calls his Ukrainian counterpart \"disrespectful\" and tells him to be \"thankful\" during heated exchanges in the Oval Office.".to_string(),
topic: Option::from("government".to_string()),
publisher: "BBC".to_string(),
is_time_sensitive: true,
tile_id: Some(1271137535326463),
received_rank: 3,
}
],
feeds: None,
interest_picker: None
})
}
}
struct FakeHttpClientValidationError;
impl http::HttpClientTrait for FakeHttpClientValidationError {
fn make_curated_recommendation_request(
&self,
_request: &CuratedRecommendationsRequest,
_user_agent_header: &str,
_base_host: Url,
) -> Result<CuratedRecommendationsResponse> {
Err(Error::Validation {
code: 422,
message: "Invalid input".to_string(),
})
}
}
struct FakeHttpClientServerError;
impl http::HttpClientTrait for FakeHttpClientServerError {
fn make_curated_recommendation_request(
&self,
_request: &CuratedRecommendationsRequest,
_user_agent_header: &str,
_base_host: Url,
) -> Result<CuratedRecommendationsResponse> {
Err(Error::Server {
code: 500,
message: "The server encountered an unexpected error".to_string(),
})
}
}
struct FakeHttpClientBadRequestError;
impl http::HttpClientTrait for FakeHttpClientBadRequestError {
fn make_curated_recommendation_request(
&self,
_request: &CuratedRecommendationsRequest,
_user_agent_header: &str,
_base_host: Url,
) -> Result<CuratedRecommendationsResponse> {
Err(Error::BadRequest {
code: 400,
message: "Invalid syntax".to_string(),
})
}
}
struct FakeCapturingClient {
captured_url: std::sync::Arc<std::sync::Mutex<Option<Url>>>,
}
impl http::HttpClientTrait for FakeCapturingClient {
fn make_curated_recommendation_request(
&self,
_request: &CuratedRecommendationsRequest,
_user_agent_header: &str,
url: Url,
) -> Result<CuratedRecommendationsResponse> {
let mut lock = self.captured_url.lock().unwrap();
*lock = Some(url);
Err(Error::Unexpected {
code: 999,
message: "test error".into(),
})
}
}
#[test]
fn test_get_curated_recommendations_success() {
let fake_client = FakeHttpClientSuccess;
let client_inner = CuratedRecommendationsClientInner::new_with_client(fake_client);
let request = CuratedRecommendationsRequest {
locale: CuratedRecommendationLocale::EnUs,
region: Some("US".parse().unwrap()),
count: Option::from(4),
topics: Some(vec!["business".into()]),
feeds: Some(vec!["sections".into()]),
sections: Some(vec![SectionSettings {
section_id: "d471863a-4ee9-4849-aff8-da087778b383".to_string(),
is_followed: true,
is_blocked: true,
}]),
experiment_name: Some("new-tab-extend-content-duration".parse().unwrap()),
experiment_branch: None,
enable_interest_picker: false,
};
let response_result = client_inner.get_curated_recommendations(
&request,
"Rust-HTTP-Client/0.1",
&Url::parse("https://merino.services.mozilla.com").unwrap(),
);
assert!(response_result.is_ok(), "Expected a successful response");
let response = response_result.unwrap();
assert_eq!(response.recommended_at, 1740764371347);
assert_eq!(response.data.len(), 4);
let first_item = &response.data[0];
let second_item = &response.data[1];
let third_item = &response.data[2];
let fourth_item = &response.data[3];
assert_eq!(
first_item.corpus_item_id,
"18fbf4e1-3a8b-4b28-84a0-b6b4b785a44b"
);
assert_eq!(
first_item.url,
);
assert_eq!(
first_item.title,
"TEST Cat Accidentally Summons Eldritch Horror While Playing With String"
);
assert_eq!(
second_item.scheduled_corpus_item_id,
Some("2de2453f-b38b-4713-8dcb-82660856efd7".to_string())
);
assert_eq!(third_item.publisher, "NBC News".to_string());
assert!(third_item.is_time_sensitive);
assert!(fourth_item.is_time_sensitive);
assert_eq!(fourth_item.topic, Option::from("government".to_string()));
}
#[test]
fn test_get_curated_recommendations_validation_error() {
let fake_client = FakeHttpClientValidationError;
let client_inner = CuratedRecommendationsClientInner::new_with_client(fake_client);
let request = CuratedRecommendationsRequest {
locale: CuratedRecommendationLocale::Fr,
region: None,
count: None,
topics: None,
feeds: None,
sections: None,
experiment_name: None,
experiment_branch: None,
enable_interest_picker: false,
};
let response = client_inner.get_curated_recommendations(
&request,
"Rust-HTTP-Client/0.1",
&Url::parse("https://merino.services.mozilla.com").unwrap(),
);
assert!(response.is_err());
let err = response.unwrap_err();
match err {
Error::Validation { code, message } => {
assert_eq!(code, 422);
assert_eq!(message, "Invalid input");
}
_ => panic!("Expected a validation error"),
}
}
#[test]
fn test_get_curated_recommendations_server_error() {
let fake_client = FakeHttpClientServerError;
let client_inner = CuratedRecommendationsClientInner::new_with_client(fake_client);
let request = CuratedRecommendationsRequest {
locale: CuratedRecommendationLocale::Fr,
region: None,
count: None,
topics: None,
feeds: None,
sections: None,
experiment_name: None,
experiment_branch: None,
enable_interest_picker: false,
};
let response = client_inner.get_curated_recommendations(
&request,
"Rust-HTTP-Client/0.1",
&Url::parse("https://merino.services.mozilla.com").unwrap(),
);
assert!(response.is_err());
let err = response.unwrap_err();
match err {
Error::Server { code, message } => {
assert_eq!(code, 500);
assert_eq!(message, "The server encountered an unexpected error");
}
_ => panic!("Expected a server error"),
}
}
#[test]
fn test_get_curated_recommendations_bad_request_error() {
let fake_client = FakeHttpClientBadRequestError;
let client_inner = CuratedRecommendationsClientInner::new_with_client(fake_client);
let request = CuratedRecommendationsRequest {
locale: CuratedRecommendationLocale::Fr,
region: None,
count: None,
topics: None,
feeds: None,
sections: None,
experiment_name: None,
experiment_branch: None,
enable_interest_picker: false,
};
let response = client_inner.get_curated_recommendations(
&request,
"Rust-HTTP-Client/0.1",
&Url::parse("https://merino.services.mozilla.com").unwrap(),
);
assert!(response.is_err());
let err = response.unwrap_err();
match err {
Error::BadRequest { code, message } => {
assert_eq!(code, 400);
assert_eq!(message, "Invalid syntax");
}
_ => panic!("Expected a bad request error"),
}
}
#[test]
fn test_client_builder_with_default_base_host() {
let config = CuratedRecommendationsConfig {
base_host: None,
user_agent_header: "test-agent/1.0".to_string(),
};
let client = CuratedRecommendationsClient::new(config);
assert!(client.is_ok());
}
#[test]
fn test_builder_uses_default_base_host_if_none_provided() {
let captured_url = std::sync::Arc::new(std::sync::Mutex::new(None));
let client_inner = CuratedRecommendationsClientInner::new_with_client(FakeCapturingClient {
captured_url: captured_url.clone(),
});
let config = CuratedRecommendationsConfig {
base_host: None,
user_agent_header: "agent/1.0".into(),
};
let builder =
CuratedRecommendationsClientBuilder::new().user_agent_header(config.user_agent_header);
let client = builder.build().unwrap();
let _ = client_inner.get_curated_recommendations(
&CuratedRecommendationsRequest {
locale: CuratedRecommendationLocale::EnUs,
region: None,
count: None,
topics: None,
feeds: None,
sections: None,
experiment_name: None,
experiment_branch: None,
enable_interest_picker: false,
},
&client.user_agent_header,
&client.endpoint_url,
);
let captured = captured_url.lock().unwrap();
assert_eq!(
captured.as_ref().unwrap().as_str(),
);
}
#[test]
fn test_builder_uses_custom_base_host_if_provided() {
let captured_url = std::sync::Arc::new(std::sync::Mutex::new(None));
let client_inner = CuratedRecommendationsClientInner::new_with_client(FakeCapturingClient {
captured_url: captured_url.clone(),
});
let base_host = "https://my.custom.host";
let config = CuratedRecommendationsConfig {
base_host: Some(base_host.to_string()),
user_agent_header: "agent/1.0".into(),
};
let builder = CuratedRecommendationsClientBuilder::new()
.user_agent_header(config.user_agent_header)
.base_host(config.base_host.clone().unwrap());
let client = builder.build().unwrap();
let _ = client_inner.get_curated_recommendations(
&CuratedRecommendationsRequest {
locale: CuratedRecommendationLocale::EnUs,
region: None,
count: None,
topics: None,
feeds: None,
sections: None,
experiment_name: None,
experiment_branch: None,
enable_interest_picker: false,
},
&client.user_agent_header,
&client.endpoint_url,
);
let captured = captured_url.lock().unwrap();
assert_eq!(
captured.as_ref().unwrap().as_str(),
);
}
// --- Request serialization tests (#3) ---
#[test]
fn test_request_serialization_camel_case_fields() {
let request = CuratedRecommendationsRequest {
locale: CuratedRecommendationLocale::EnUs,
region: Some("US".to_string()),
count: Some(10),
topics: Some(vec!["business".into()]),
feeds: None,
sections: None,
experiment_name: Some("test-experiment".to_string()),
experiment_branch: Some("control".to_string()),
enable_interest_picker: true,
};
let json = serde_json::to_value(&request).unwrap();
// Verify camelCase renames are applied
assert_eq!(json["experimentName"], "test-experiment");
assert_eq!(json["experimentBranch"], "control");
assert_eq!(json["enableInterestPicker"], true);
// Verify these snake_case keys do NOT appear
assert!(json.get("experiment_name").is_none());
assert!(json.get("experiment_branch").is_none());
assert!(json.get("enable_interest_picker").is_none());
}
#[test]
fn test_request_serialization_locale_value() {
let request = CuratedRecommendationsRequest {
locale: CuratedRecommendationLocale::FrFr,
region: None,
count: None,
topics: None,
feeds: None,
sections: None,
experiment_name: None,
experiment_branch: None,
enable_interest_picker: false,
};
let json = serde_json::to_value(&request).unwrap();
assert_eq!(json["locale"], "fr-FR");
}
#[test]
fn test_request_serialization_sections() {
let request = CuratedRecommendationsRequest {
locale: CuratedRecommendationLocale::EnUs,
region: None,
count: None,
topics: None,
feeds: None,
sections: Some(vec![SectionSettings {
section_id: "abc-123".to_string(),
is_followed: true,
is_blocked: false,
}]),
experiment_name: None,
experiment_branch: None,
enable_interest_picker: false,
};
let json = serde_json::to_value(&request).unwrap();
let section = &json["sections"][0];
// Verify camelCase renames on SectionSettings
assert_eq!(section["sectionId"], "abc-123");
assert_eq!(section["isFollowed"], true);
assert_eq!(section["isBlocked"], false);
assert!(section.get("section_id").is_none());
}
// --- Builder edge case tests (#4) ---
#[test]
fn test_builder_fails_without_user_agent_header() {
let result = CuratedRecommendationsClientBuilder::new().build();
match result {
Err(Error::Unexpected { message, .. }) => {
assert!(message.contains("user_agent_header"));
}
Err(other) => panic!("Expected Unexpected error, got: {:?}", other),
Ok(_) => panic!("Expected error for missing user_agent_header"),
}
}
#[test]
fn test_builder_fails_with_invalid_base_host() {
let result = CuratedRecommendationsClientBuilder::new()
.user_agent_header("agent/1.0")
.base_host("not a valid url")
.build();
match result {
Err(Error::UrlParse(_)) => {}
Err(other) => panic!("Expected UrlParse error, got: {:?}", other),
Ok(_) => panic!("Expected error for invalid base_host"),
}
}
#[test]
fn test_client_new_with_empty_user_agent() {
// Empty string is accepted — the builder only requires user_agent_header to be present.
let config = CuratedRecommendationsConfig {
base_host: None,
user_agent_header: "".to_string(),
};
let result = CuratedRecommendationsClient::new(config);
assert!(result.is_ok());
}
#[test]
fn test_response_feeds_deserialization_from_map() {
let json = r#"{
"recommendedAt": 1740764371347,
"data": [],
"feeds": {
"business": {
"receivedFeedRank": 1,
"recommendations": [{
"corpusItemId": "item-1",
"scheduledCorpusItemId": null,
"title": "Test Article",
"excerpt": "A short excerpt",
"topic": "business",
"publisher": "Test Publisher",
"isTimeSensitive": false,
"iconUrl": null,
"tileId": null,
"receivedRank": 0
}],
"title": "Business",
"subtitle": "Latest business news",
"layout": {
"name": "4-large",
"responsiveLayouts": [{
"columnCount": 4,
"tiles": [{"size": "large", "position": 0, "hasAd": false, "hasExcerpt": true}]
}]
},
"isFollowed": true,
"isBlocked": false
},
"top_stories_section": {
"receivedFeedRank": 0,
"recommendations": [],
"title": "Popular Today",
"subtitle": null,
"layout": {
"name": "3-medium",
"responsiveLayouts": []
},
"isFollowed": false,
"isBlocked": true
}
}
}"#;
let response: CuratedRecommendationsResponse = serde_json::from_str(json).unwrap();
let feeds = response.feeds.unwrap();
assert_eq!(feeds.len(), 2);
assert_eq!(feeds[0].feed_id, "top_stories_section");
assert_eq!(feeds[0].received_feed_rank, 0);
assert_eq!(feeds[0].title, "Popular Today");
assert!(feeds[0].is_blocked);
assert!(!feeds[0].is_followed);
assert_eq!(feeds[1].feed_id, "business");
assert_eq!(feeds[1].received_feed_rank, 1);
assert_eq!(feeds[1].title, "Business");
assert_eq!(feeds[1].subtitle, Some("Latest business news".to_string()));
assert!(feeds[1].is_followed);
assert!(!feeds[1].is_blocked);
assert_eq!(feeds[1].recommendations.len(), 1);
assert_eq!(feeds[1].recommendations[0].corpus_item_id, "item-1");
assert_eq!(feeds[1].recommendations[0].scheduled_corpus_item_id, None);
assert_eq!(feeds[1].recommendations[0].tile_id, None);
}
#[test]
fn test_response_feeds_deserialization_null() {
let json = r#"{
"recommendedAt": 1740764371347,
"data": [],
"feeds": null
}"#;
let response: CuratedRecommendationsResponse = serde_json::from_str(json).unwrap();
assert!(response.feeds.is_none());
}
#[test]
fn test_response_feeds_deserialization_absent() {
let json = r#"{
"recommendedAt": 1740764371347,
"data": []
}"#;
let response: CuratedRecommendationsResponse = serde_json::from_str(json).unwrap();
assert!(response.feeds.is_none());
}
struct FakeHttpClientSectionsSuccess;
impl http::HttpClientTrait for FakeHttpClientSectionsSuccess {
fn make_curated_recommendation_request(
&self,
_request: &CuratedRecommendationsRequest,
_user_agent_header: &str,
_base_host: Url,
) -> Result<CuratedRecommendationsResponse> {
Ok(CuratedRecommendationsResponse {
recommended_at: 1773841104683,
data: vec![],
feeds: Some(vec![
FeedSection {
feed_id: "top_stories_section".to_string(),
received_feed_rank: 0,
recommendations: vec![
RecommendationDataItem {
corpus_item_id: "23d83f22-8b36-47b1-9639-e84e153c6b39".to_string(),
scheduled_corpus_item_id: None,
title: "TEST Kayaker Scared Fish While He Was Stranded At Sea".to_string(),
excerpt: "Goran Radic was winched to safety by a rescue helicopter".to_string(),
topic: Some("travel".to_string()),
publisher: "The Guardian".to_string(),
is_time_sensitive: false,
tile_id: None,
received_rank: 0,
},
RecommendationDataItem {
corpus_item_id: "268edec7-9e09-43d6-ad36-e4d27ee5b7e8".to_string(),
scheduled_corpus_item_id: None,
title: "TEST Ghost Ship Found To Be Scooby Doo in a Mask All Along".to_string(),
excerpt: "Best game of hide-and-go-seek".to_string(),
topic: Some("tech".to_string()),
publisher: "Popular Mechanics".to_string(),
is_time_sensitive: false,
icon_url: None,
tile_id: None,
received_rank: 1,
},
],
title: "Popular Today".to_string(),
subtitle: None,
layout: Layout {
name: "7-double-row-2-ad".to_string(),
responsive_layouts: vec![
ResponsiveLayout {
column_count: 4,
tiles: vec![
Tile { size: "large".to_string(), position: 0, has_ad: false, has_excerpt: true },
Tile { size: "medium".to_string(), position: 1, has_ad: true, has_excerpt: false },
],
},
],
},
is_followed: false,
is_blocked: false,
},
FeedSection {
feed_id: "travel".to_string(),
received_feed_rank: 1,
recommendations: vec![
RecommendationDataItem {
corpus_item_id: "b9f0ca33-96f4-4558-8f67-afc8ec220dce".to_string(),
scheduled_corpus_item_id: None,
title: "TEST Southwest's Charts Going South East Due To Policy".to_string(),
excerpt: "Since the airline changed its policy".to_string(),
topic: Some("travel".to_string()),
publisher: "The New York Times".to_string(),
is_time_sensitive: false,
tile_id: None,
received_rank: 0,
},
],
title: "Travel".to_string(),
subtitle: None,
layout: Layout {
name: "6-small-medium-1-ad".to_string(),
responsive_layouts: vec![
ResponsiveLayout {
column_count: 4,
tiles: vec![
Tile { size: "medium".to_string(), position: 0, has_ad: false, has_excerpt: true },
Tile { size: "medium".to_string(), position: 1, has_ad: true, has_excerpt: true },
],
},
],
},
is_followed: false,
is_blocked: false,
},
]),
interest_picker: None,
})
}
}
#[test]
fn test_get_curated_recommendations_sections_success() {
let fake_client = FakeHttpClientSectionsSuccess;
let client_inner = CuratedRecommendationsClientInner::new_with_client(fake_client);
let request = CuratedRecommendationsRequest {
locale: CuratedRecommendationLocale::EnUs,
region: Some("US".to_string()),
count: None,
topics: None,
feeds: Some(vec!["sections".into()]),
sections: Some(vec![SectionSettings {
section_id: "top_stories_section".to_string(),
is_followed: true,
is_blocked: false,
}]),
experiment_name: None,
experiment_branch: None,
enable_interest_picker: false,
};
let response = client_inner
.get_curated_recommendations(
&request,
"Rust-HTTP-Client/0.1",
&Url::parse("https://merino.services.mozilla.com").unwrap(),
)
.unwrap();
assert_eq!(response.recommended_at, 1773841104683);
assert!(response.data.is_empty());
let feeds = response.feeds.unwrap();
assert_eq!(feeds.len(), 2);
// First section: top_stories_section
assert_eq!(feeds[0].feed_id, "top_stories_section");
assert_eq!(feeds[0].received_feed_rank, 0);
assert_eq!(feeds[0].title, "Popular Today");
assert_eq!(feeds[0].subtitle, None);
assert!(!feeds[0].is_followed);
assert!(!feeds[0].is_blocked);
assert_eq!(feeds[0].recommendations.len(), 2);
assert_eq!(feeds[0].layout.name, "7-double-row-2-ad");
assert_eq!(feeds[0].layout.responsive_layouts[0].column_count, 4);
let first_rec = &feeds[0].recommendations[0];
assert_eq!(
first_rec.corpus_item_id,
"23d83f22-8b36-47b1-9639-e84e153c6b39"
);
assert_eq!(first_rec.scheduled_corpus_item_id, None);
assert_eq!(first_rec.tile_id, None);
assert_eq!(first_rec.topic, Some("travel".to_string()));
assert_eq!(first_rec.publisher, "The Guardian");
// Second section: travel
assert_eq!(feeds[1].feed_id, "travel");
assert_eq!(feeds[1].received_feed_rank, 1);
assert_eq!(feeds[1].title, "Travel");
assert_eq!(feeds[1].recommendations.len(), 1);
assert_eq!(feeds[1].layout.name, "6-small-medium-1-ad");
}