tarzi 0.2.1

Rust-native lite search for AI applications
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
use super::access::{resolve_access, resolve_api_key};
use super::api::{search_brave_api, search_serper_api};
use super::parser::ParserFactory;
use super::types::{AccessMethod, SearchEngineType, SearchMode, SearchResult};
use crate::Result;
use crate::error::TarziError;
use crate::fetcher::{FetchMode, WebFetcher};
use async_trait::async_trait;
use tracing::{info, warn};

/// Provider configuration for search
#[derive(Debug)]
pub struct ProviderConfig {
    pub fetcher: Box<WebFetcher>,
    pub search_mode: SearchMode,
    pub api_key: Option<String>,
}

impl ProviderConfig {
    pub fn new(fetcher: WebFetcher) -> Self {
        Self {
            fetcher: Box::new(fetcher),
            search_mode: SearchMode::Auto,
            api_key: None,
        }
    }
}

/// Unified interface for all search providers
#[async_trait]
pub trait SearchProvider: Send + Sync {
    /// Associated type for the provider's configuration
    type Config;

    /// Create a new provider instance with the given configuration
    fn new(config: Self::Config) -> Self
    where
        Self: Sized;

    /// Perform a search using the provider
    async fn search(&mut self, query: &str, limit: usize) -> Result<Vec<SearchResult>>;

    /// Check if the provider is healthy/available
    fn is_healthy(&self) -> bool;

    /// Get the search engine type this provider represents
    fn get_engine_type(&self) -> SearchEngineType;
}

/// Shared cascade used by all providers.
async fn provider_search_cascade(
    fetcher: &mut WebFetcher,
    engine_type: SearchEngineType,
    search_mode: SearchMode,
    api_key: &Option<String>,
    query: &str,
    limit: usize,
) -> Result<Vec<SearchResult>> {
    let resolved_key = resolve_api_key(engine_type, api_key);
    let has_key = resolved_key.is_some();
    let methods = resolve_access(engine_type, search_mode, has_key)?;
    let allow_fallback = matches!(search_mode, SearchMode::Auto | SearchMode::WebQuery);
    let mut last_error: Option<TarziError> = None;

    for method in methods {
        let outcome = match method {
            AccessMethod::Api => {
                let key = resolved_key
                    .as_deref()
                    .ok_or_else(|| TarziError::Search("API key required".to_string()))?;
                match engine_type {
                    SearchEngineType::BraveSearch => {
                        search_brave_api(fetcher, query, limit, key).await
                    }
                    SearchEngineType::GoogleSerper => {
                        search_serper_api(fetcher, query, limit, key).await
                    }
                    other => Err(TarziError::Search(format!(
                        "Engine {other:?} does not support API access"
                    ))),
                }
            }
            AccessMethod::PlainHttp => {
                web_search(
                    fetcher,
                    engine_type,
                    query,
                    limit,
                    FetchMode::PlainRequest,
                    true,
                )
                .await
            }
            AccessMethod::Browser => {
                web_search(
                    fetcher,
                    engine_type,
                    query,
                    limit,
                    FetchMode::BrowserHeadless,
                    false,
                )
                .await
            }
        };

        match outcome {
            Ok(results) if !results.is_empty() => {
                info!("Provider search succeeded via {:?}", method);
                return Ok(results);
            }
            Ok(_) => {
                let msg = format!("Provider search via {method:?} returned no results");
                warn!("{}", msg);
                last_error = Some(TarziError::Search(msg));
                if !allow_fallback {
                    break;
                }
            }
            Err(e) => {
                warn!("Provider search via {:?} failed: {}", method, e);
                last_error = Some(e);
                if !allow_fallback {
                    break;
                }
            }
        }
    }

    Err(last_error.unwrap_or_else(|| {
        TarziError::Search("All provider search access methods failed".to_string())
    }))
}

async fn web_search(
    fetcher: &mut WebFetcher,
    engine_type: SearchEngineType,
    query: &str,
    limit: usize,
    fetch_mode: FetchMode,
    use_plain_pattern: bool,
) -> Result<Vec<SearchResult>> {
    if !engine_type.supports_web() {
        return Err(TarziError::Search(format!(
            "Engine {engine_type:?} does not support web query"
        )));
    }

    let pattern = if use_plain_pattern {
        engine_type.plain_query_pattern()
    } else {
        engine_type.browser_query_pattern()
    };
    let search_url = pattern.replace("{query}", &urlencoding::encode(query));
    info!("Provider web search: {}", search_url);

    let content = fetcher.fetch_raw(&search_url, fetch_mode).await?;
    let parser = ParserFactory::new().get_parser(&engine_type);
    parser.parse(&content, limit)
}

/// Macro to generate search provider implementations
macro_rules! impl_search_provider {
    ($provider_name:ident, $engine_type:expr) => {
        #[derive(Debug)]
        pub struct $provider_name {
            fetcher: WebFetcher,
            search_mode: SearchMode,
            api_key: Option<String>,
        }

        impl $provider_name {
            pub fn new_web(fetcher: WebFetcher) -> Self {
                Self {
                    fetcher,
                    search_mode: SearchMode::Auto,
                    api_key: None,
                }
            }

            pub fn with_options(
                fetcher: WebFetcher,
                search_mode: SearchMode,
                api_key: Option<String>,
            ) -> Self {
                Self {
                    fetcher,
                    search_mode,
                    api_key,
                }
            }
        }

        #[async_trait]
        impl SearchProvider for $provider_name {
            type Config = crate::fetcher::WebFetcher;

            fn new(config: Self::Config) -> Self {
                Self::new_web(config)
            }

            async fn search(&mut self, query: &str, limit: usize) -> Result<Vec<SearchResult>> {
                provider_search_cascade(
                    &mut self.fetcher,
                    $engine_type,
                    self.search_mode,
                    &self.api_key,
                    query,
                    limit,
                )
                .await
            }

            fn is_healthy(&self) -> bool {
                true
            }

            fn get_engine_type(&self) -> SearchEngineType {
                $engine_type
            }
        }
    };
}

impl_search_provider!(GoogleSearchProvider, SearchEngineType::Google);
impl_search_provider!(GoogleSerperProvider, SearchEngineType::GoogleSerper);
impl_search_provider!(BingSearchProvider, SearchEngineType::Bing);
impl_search_provider!(DuckDuckGoProvider, SearchEngineType::DuckDuckGo);
impl_search_provider!(BraveSearchProvider, SearchEngineType::BraveSearch);
impl_search_provider!(BaiduSearchProvider, SearchEngineType::Baidu);
impl_search_provider!(SougouWeixinProvider, SearchEngineType::SougouWeixin);

/// Provider variant enum for different search engines
#[derive(Debug)]
pub enum ProviderVariant {
    Google(GoogleSearchProvider),
    GoogleSerper(GoogleSerperProvider),
    Bing(BingSearchProvider),
    DuckDuckGo(DuckDuckGoProvider),
    BraveSearch(BraveSearchProvider),
    Baidu(BaiduSearchProvider),
    SougouWeixin(SougouWeixinProvider),
}

impl ProviderVariant {
    /// Create a provider variant from engine type and configuration
    pub fn from_engine_type(engine_type: SearchEngineType, config: ProviderConfig) -> Result<Self> {
        let ProviderConfig {
            fetcher,
            search_mode,
            api_key,
        } = config;
        let fetcher = *fetcher;

        Ok(match engine_type {
            SearchEngineType::Google => ProviderVariant::Google(
                GoogleSearchProvider::with_options(fetcher, search_mode, api_key),
            ),
            SearchEngineType::GoogleSerper => ProviderVariant::GoogleSerper(
                GoogleSerperProvider::with_options(fetcher, search_mode, api_key),
            ),
            SearchEngineType::Bing => ProviderVariant::Bing(BingSearchProvider::with_options(
                fetcher,
                search_mode,
                api_key,
            )),
            SearchEngineType::DuckDuckGo => ProviderVariant::DuckDuckGo(
                DuckDuckGoProvider::with_options(fetcher, search_mode, api_key),
            ),
            SearchEngineType::BraveSearch => ProviderVariant::BraveSearch(
                BraveSearchProvider::with_options(fetcher, search_mode, api_key),
            ),
            SearchEngineType::Baidu => ProviderVariant::Baidu(BaiduSearchProvider::with_options(
                fetcher,
                search_mode,
                api_key,
            )),
            SearchEngineType::SougouWeixin => ProviderVariant::SougouWeixin(
                SougouWeixinProvider::with_options(fetcher, search_mode, api_key),
            ),
        })
    }

    /// Get the engine type for this provider variant
    pub fn engine_type(&self) -> SearchEngineType {
        match self {
            ProviderVariant::Google(_) => SearchEngineType::Google,
            ProviderVariant::GoogleSerper(_) => SearchEngineType::GoogleSerper,
            ProviderVariant::Bing(_) => SearchEngineType::Bing,
            ProviderVariant::DuckDuckGo(_) => SearchEngineType::DuckDuckGo,
            ProviderVariant::BraveSearch(_) => SearchEngineType::BraveSearch,
            ProviderVariant::Baidu(_) => SearchEngineType::Baidu,
            ProviderVariant::SougouWeixin(_) => SearchEngineType::SougouWeixin,
        }
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::fetcher::WebFetcher;

    #[test]
    fn test_google_search_provider() {
        let fetcher = WebFetcher::new();
        let provider = GoogleSearchProvider::new_web(fetcher);

        assert_eq!(provider.get_engine_type(), SearchEngineType::Google);
        assert!(provider.is_healthy());
    }

    #[test]
    fn test_google_serper_provider() {
        let fetcher = WebFetcher::new();
        let provider = GoogleSerperProvider::new_web(fetcher);

        assert_eq!(provider.get_engine_type(), SearchEngineType::GoogleSerper);
        assert!(provider.is_healthy());
    }

    #[test]
    fn test_bing_search_provider() {
        let fetcher = WebFetcher::new();
        let provider = BingSearchProvider::new_web(fetcher);

        assert_eq!(provider.get_engine_type(), SearchEngineType::Bing);
        assert!(provider.is_healthy());
    }

    #[test]
    fn test_duckduckgo_provider() {
        let fetcher = WebFetcher::new();
        let provider = DuckDuckGoProvider::new_web(fetcher);

        assert_eq!(provider.get_engine_type(), SearchEngineType::DuckDuckGo);
        assert!(provider.is_healthy());
    }

    #[test]
    fn test_brave_search_provider() {
        let fetcher = WebFetcher::new();
        let provider = BraveSearchProvider::new_web(fetcher);

        assert_eq!(provider.get_engine_type(), SearchEngineType::BraveSearch);
        assert!(provider.is_healthy());
    }

    #[test]
    fn test_baidu_search_provider() {
        let fetcher = WebFetcher::new();
        let provider = BaiduSearchProvider::new_web(fetcher);

        assert_eq!(provider.get_engine_type(), SearchEngineType::Baidu);
        assert!(provider.is_healthy());
    }

    #[test]
    fn test_provider_variant_from_engine_type() {
        let google_variant = ProviderVariant::from_engine_type(
            SearchEngineType::Google,
            ProviderConfig::new(WebFetcher::new()),
        )
        .unwrap();
        assert_eq!(google_variant.engine_type(), SearchEngineType::Google);

        let serper_variant = ProviderVariant::from_engine_type(
            SearchEngineType::GoogleSerper,
            ProviderConfig::new(WebFetcher::new()),
        )
        .unwrap();
        assert_eq!(serper_variant.engine_type(), SearchEngineType::GoogleSerper);

        let bing_variant = ProviderVariant::from_engine_type(
            SearchEngineType::Bing,
            ProviderConfig::new(WebFetcher::new()),
        )
        .unwrap();
        assert_eq!(bing_variant.engine_type(), SearchEngineType::Bing);
    }

    #[test]
    fn test_all_engine_types_supported() {
        let engine_types = vec![
            SearchEngineType::Google,
            SearchEngineType::GoogleSerper,
            SearchEngineType::Bing,
            SearchEngineType::DuckDuckGo,
            SearchEngineType::BraveSearch,
            SearchEngineType::Baidu,
            SearchEngineType::SougouWeixin,
        ];

        for engine_type in engine_types {
            let variant = ProviderVariant::from_engine_type(
                engine_type,
                ProviderConfig::new(WebFetcher::new()),
            );
            assert!(
                variant.is_ok(),
                "Engine type {engine_type:?} should be supported"
            );
            if let Ok(provider) = variant {
                assert_eq!(provider.engine_type(), engine_type);
            }
        }
    }

    #[test]
    fn test_search_provider_trait_functionality() {
        let google_provider = GoogleSearchProvider::new(WebFetcher::new());
        assert_eq!(google_provider.get_engine_type(), SearchEngineType::Google);
        assert!(google_provider.is_healthy());

        let bing_provider = BingSearchProvider::new(WebFetcher::new());
        assert_eq!(bing_provider.get_engine_type(), SearchEngineType::Bing);
        assert!(bing_provider.is_healthy());
    }
}