use crate::i18n::{I18nBundle, Locale};
use crate::impl_basic_error_conversions;
use thiserror::Error;
use tokio::time::error::Elapsed;
#[derive(Debug, Error)]
pub enum SearchError {
#[error("Network request failed: {0}")]
Network(#[from] reqwest::Error),
#[error("Search timed out: {0}")]
Timeout(#[from] Elapsed),
#[error("Parse error: {0}")]
Parse(String),
#[error("Content parsing error: {0}")]
ContentParsing(String),
#[error("Engine {0} client call failed: {1}")]
EngineClient(String, String),
#[error("Engine {0} returned HTTP error status: {1}")]
BadHttpStatus(String, u16),
#[error("Engine rate limited: {0}")]
RateLimited(String),
#[error("Engine {0} returned a CAPTCHA page")]
Captcha(String),
#[error("Engine {0} returned insufficient content: {1}")]
InsufficientContent(String, String),
#[error("All search engines failed.")]
AllEnginesFailed,
#[error("Engine {0} execution failed.")]
EngineFailed(String),
#[error("Smart routing failed: {0}")]
SmartRoutingFailed(String),
#[error("Smart routing timed out: {0}s")]
SmartRoutingTimeout(u64),
#[error("Engine creation failed: {0}")]
EngineCreationFailed(String),
#[error("Circuit breaker open: {0}")]
CircuitOpen(String),
#[error("No available search engine.")]
NoEngineAvailable,
}
impl_basic_error_conversions!(SearchError, Parse);
impl SearchError {
pub fn user_message_locale(&self, locale: &Locale, bundle: &I18nBundle) -> String {
match self {
SearchError::Network(inner) => bundle.translate_with_args(
locale,
"search-error-network",
&[("message", inner.to_string())],
),
SearchError::Timeout(inner) => bundle.translate_with_args(
locale,
"search-error-timeout",
&[("message", inner.to_string())],
),
SearchError::Parse(message) => bundle.translate_with_args(
locale,
"search-error-parse",
&[("message", message.as_str().to_string())],
),
SearchError::ContentParsing(message) => bundle.translate_with_args(
locale,
"search-error-content-parsing",
&[("message", message.as_str().to_string())],
),
SearchError::EngineClient(engine, message) => bundle.translate_with_args(
locale,
"search-error-engine-client",
&[
("engine", engine.as_str().to_string()),
("message", message.as_str().to_string()),
],
),
SearchError::BadHttpStatus(engine, status) => bundle.translate_with_args(
locale,
"search-error-bad-http-status",
&[
("engine", engine.as_str().to_string()),
("status", (*status as i64).to_string()),
],
),
SearchError::RateLimited(reason) => bundle.translate_with_args(
locale,
"search-error-rate-limited",
&[("message", reason.as_str().to_string())],
),
SearchError::Captcha(engine) => bundle.translate_with_args(
locale,
"search-error-captcha",
&[("engine", engine.as_str().to_string())],
),
SearchError::InsufficientContent(engine, message) => bundle.translate_with_args(
locale,
"search-error-insufficient-content",
&[
("engine", engine.as_str().to_string()),
("message", message.as_str().to_string()),
],
),
SearchError::AllEnginesFailed => {
bundle.translate(locale, "search-error-all-engines-failed")
}
SearchError::EngineFailed(engine) => bundle.translate_with_args(
locale,
"search-error-engine-failed",
&[("engine", engine.as_str().to_string())],
),
SearchError::SmartRoutingFailed(message) => bundle.translate_with_args(
locale,
"search-error-smart-routing-failed",
&[("message", message.as_str().to_string())],
),
SearchError::SmartRoutingTimeout(seconds) => bundle.translate_with_args(
locale,
"search-error-smart-routing-timeout",
&[("seconds", (*seconds as i64).to_string())],
),
SearchError::EngineCreationFailed(message) => bundle.translate_with_args(
locale,
"search-error-engine-creation-failed",
&[("message", message.as_str().to_string())],
),
SearchError::CircuitOpen(message) => bundle.translate_with_args(
locale,
"search-error-circuit-open",
&[("message", message.as_str().to_string())],
),
SearchError::NoEngineAvailable => {
bundle.translate(locale, "search-error-no-engine-available")
}
}
}
}
#[cfg(test)]
mod tests {
use super::*;
fn test_bundle() -> I18nBundle {
I18nBundle::load("en-US", &["en-US", "zh-CN"]).unwrap()
}
#[test]
fn test_display_english_canonical() {
let err = SearchError::NoEngineAvailable;
assert_eq!(err.to_string(), "No available search engine.");
let err = SearchError::BadHttpStatus("bing".to_string(), 503);
assert_eq!(
err.to_string(),
"Engine bing returned HTTP error status: 503"
);
}
#[test]
fn test_user_message_locale_en() {
let bundle = test_bundle();
let locale: Locale = "en-US".parse().unwrap();
let err = SearchError::Captcha("sogou".to_string());
let msg = err.user_message_locale(&locale, &bundle);
assert!(msg.starts_with("Engine "), "got: {msg}");
assert!(msg.contains("sogou"), "got: {msg}");
assert!(msg.ends_with("returned a CAPTCHA page"), "got: {msg}");
}
#[test]
fn test_user_message_locale_zh() {
let bundle = test_bundle();
let locale: Locale = "zh-CN".parse().unwrap();
let err = SearchError::AllEnginesFailed;
assert_eq!(
err.user_message_locale(&locale, &bundle),
"所有搜索引擎都失败。"
);
}
#[test]
fn test_user_message_locale_covers_all_constructible_variants() {
let bundle = test_bundle();
let en: Locale = "en-US".parse().unwrap();
let zh: Locale = "zh-CN".parse().unwrap();
let variants = vec![
SearchError::Parse("p".into()),
SearchError::ContentParsing("c".into()),
SearchError::EngineClient("bing".into(), "boom".into()),
SearchError::BadHttpStatus("bing".into(), 500),
SearchError::RateLimited("slow".into()),
SearchError::Captcha("sogou".into()),
SearchError::InsufficientContent("bing".into(), "too short".into()),
SearchError::AllEnginesFailed,
SearchError::EngineFailed("bing".into()),
SearchError::SmartRoutingFailed("retry exhausted".into()),
SearchError::SmartRoutingTimeout(30),
SearchError::EngineCreationFailed("cfg missing".into()),
SearchError::CircuitOpen("open".into()),
SearchError::NoEngineAvailable,
];
for v in &variants {
assert!(
!v.user_message_locale(&en, &bundle).is_empty(),
"en empty: {v:?}"
);
assert!(
!v.user_message_locale(&zh, &bundle).is_empty(),
"zh empty: {v:?}"
);
assert!(!v.to_string().is_empty(), "display empty: {v:?}");
}
assert_eq!(
SearchError::BadHttpStatus("bing".into(), 503).user_message_locale(&en, &bundle),
bundle.translate_with_args(
&en,
"search-error-bad-http-status",
&[
("engine", "bing".to_string()),
("status", 503_i64.to_string()),
],
)
);
}
}