0
0
mirror of https://github.com/neon-mmd/websurfx.git synced 2024-11-25 15:38:21 -05:00

Compare commits

..

7 Commits

Author SHA1 Message Date
mergify[bot]
cb246419df
Merge branch 'rolling' into FEAT/394_clear-button-for-the-search-bar 2024-10-02 08:25:21 +00:00
dependabot[bot]
913ca1b075
build(deps): bump tempfile from 3.12.0 to 3.13.0 (#612) 2024-10-02 08:24:27 +00:00
dependabot[bot]
5d59a2c7be
build(deps): bump error-stack from 0.4.1 to 0.5.0 (#611) 2024-10-02 04:50:58 +00:00
dependabot[bot]
ecc6875a21
build(deps): bump actix-governor from 0.5.0 to 0.6.0 (#609) 2024-10-02 04:45:58 +00:00
dependabot[bot]
d75693ce4e
build(deps): bump regex from 1.10.6 to 1.11.0 (#610) 2024-10-02 02:09:30 +00:00
dependabot[bot]
e7efca4a4e
build(deps): bump redis from 0.25.4 to 0.27.2 (#613) 2024-10-02 02:04:26 +00:00
Kekma
2a4dd07752
feat: config option to configure the number of connections to have in the reqwest pool (#552)
* 🔧 Config: Updated `number_of_https_connections` for the HTTPS connection pool.

* (feat) : added the max idle pool per host option

* 📝 docs(config): add documentation back to the `http_adaptive_window_size` option (#532)

---------

Co-authored-by: neon_arch <mustafadhuleb53@gmail.com>
Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
2024-09-30 15:22:25 +03:00
12 changed files with 56 additions and 28 deletions

32
Cargo.lock generated
View File

@ -59,9 +59,9 @@ dependencies = [
[[package]] [[package]]
name = "actix-governor" name = "actix-governor"
version = "0.5.0" version = "0.6.0"
source = "registry+https://github.com/rust-lang/crates.io-index" source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "a2e7b88f3804e01bd4191fdb08650430bbfcb43d3d9b2890064df3551ec7d25b" checksum = "0954b0f27aabd8f56bb03f2a77b412ddf3f8c034a3c27b2086c1fc75415760df"
dependencies = [ dependencies = [
"actix-http", "actix-http",
"actix-web", "actix-web",
@ -1174,9 +1174,9 @@ dependencies = [
[[package]] [[package]]
name = "error-stack" name = "error-stack"
version = "0.4.1" version = "0.5.0"
source = "registry+https://github.com/rust-lang/crates.io-index" source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "27a72baa257b5e0e2de241967bc5ee8f855d6072351042688621081d66b2a76b" checksum = "fe413319145d1063f080f27556fd30b1d70b01e2ba10c2a6e40d4be982ffc5d1"
dependencies = [ dependencies = [
"anyhow", "anyhow",
"rustc_version 0.4.1", "rustc_version 0.4.1",
@ -2395,12 +2395,31 @@ version = "0.3.0"
source = "registry+https://github.com/rust-lang/crates.io-index" source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "38bf9645c8b145698bb0b18a4637dcacbc421ea49bef2317e4fd8065a387cf21" checksum = "38bf9645c8b145698bb0b18a4637dcacbc421ea49bef2317e4fd8065a387cf21"
[[package]]
name = "num-bigint"
version = "0.4.6"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "a5e44f723f1133c9deac646763579fdb3ac745e418f2a7af9cd0c431da1f20b9"
dependencies = [
"num-integer",
"num-traits",
]
[[package]] [[package]]
name = "num-conv" name = "num-conv"
version = "0.1.0" version = "0.1.0"
source = "registry+https://github.com/rust-lang/crates.io-index" source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "51d515d32fb182ee37cda2ccdcb92950d6a3c2893aa280e540671c2cd0f3b1d9" checksum = "51d515d32fb182ee37cda2ccdcb92950d6a3c2893aa280e540671c2cd0f3b1d9"
[[package]]
name = "num-integer"
version = "0.1.46"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "7969661fd2958a5cb096e56c8e1ad0444ac2bbcd0061bd28660485a44879858f"
dependencies = [
"num-traits",
]
[[package]] [[package]]
name = "num-traits" name = "num-traits"
version = "0.2.19" version = "0.2.19"
@ -3114,9 +3133,9 @@ dependencies = [
[[package]] [[package]]
name = "redis" name = "redis"
version = "0.25.4" version = "0.27.2"
source = "registry+https://github.com/rust-lang/crates.io-index" source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "e0d7a6955c7511f60f3ba9e86c6d02b3c3f144f8c24b288d1f4e18074ab8bbec" checksum = "a7e86f5670bd8b028edfb240f0616cad620705b31ec389d55e4f3da2c38dcd48"
dependencies = [ dependencies = [
"arc-swap", "arc-swap",
"async-trait", "async-trait",
@ -3125,6 +3144,7 @@ dependencies = [
"futures 0.3.30", "futures 0.3.30",
"futures-util", "futures-util",
"itoa 1.0.11", "itoa 1.0.11",
"num-bigint",
"percent-encoding 2.3.1", "percent-encoding 2.3.1",
"pin-project-lite", "pin-project-lite",
"ryu", "ryu",

View File

@ -46,22 +46,22 @@ mlua = { version = "0.9.9", features = [
"luajit", "luajit",
"vendored", "vendored",
], default-features = false } ], default-features = false }
redis = { version = "0.25.4", features = [ redis = { version = "0.27.2", features = [
"tokio-comp", "tokio-comp",
"connection-manager", "connection-manager",
"tcp_nodelay" "tcp_nodelay"
], default-features = false, optional = true } ], default-features = false, optional = true }
blake3 = { version = "1.5.4", default-features = false } blake3 = { version = "1.5.4", default-features = false }
error-stack = { version = "0.4.0", default-features = false, features = [ error-stack = { version = "0.5.0", default-features = false, features = [
"std", "std",
] } ] }
async-trait = { version = "0.1.80", default-features = false } async-trait = { version = "0.1.80", default-features = false }
regex = { version = "1.9.4", features = ["perf"], default-features = false } regex = { version = "1.11.0", features = ["perf"], default-features = false }
futures = { version = "0.3.30", default-features = false, features = ["alloc"] } futures = { version = "0.3.30", default-features = false, features = ["alloc"] }
dhat = { version = "0.3.2", optional = true, default-features = false } dhat = { version = "0.3.2", optional = true, default-features = false }
mimalloc = { version = "0.1.43", default-features = false } mimalloc = { version = "0.1.43", default-features = false }
async-once-cell = { version = "0.5.3", default-features = false } async-once-cell = { version = "0.5.3", default-features = false }
actix-governor = { version = "0.5.0", default-features = false } actix-governor = { version = "0.6.0", default-features = false }
moka = { version = "0.12.8", optional = true, default-features = false, features = [ moka = { version = "0.12.8", optional = true, default-features = false, features = [
"future", "future",
] } ] }
@ -91,7 +91,7 @@ itertools = {version = "0.13.0", default-features = false}
[dev-dependencies] [dev-dependencies]
rusty-hook = { version = "^0.11.2", default-features = false } rusty-hook = { version = "^0.11.2", default-features = false }
criterion = { version = "0.5.1", default-features = false } criterion = { version = "0.5.1", default-features = false }
tempfile = { version = "3.10.1", default-features = false } tempfile = { version = "3.13.0", default-features = false }
[build-dependencies] [build-dependencies]
lightningcss = { version = "1.0.0-alpha.57", default-features = false, features = [ lightningcss = { version = "1.0.0-alpha.57", default-features = false, features = [

6
src/cache/cacher.rs vendored
View File

@ -546,7 +546,7 @@ impl SharedCache {
/// # Arguments /// # Arguments
/// ///
/// * `url` - It takes the search url as an argument which will be used as the key to fetch the /// * `url` - It takes the search url as an argument which will be used as the key to fetch the
/// cached results from the cache. /// cached results from the cache.
/// ///
/// # Error /// # Error
/// ///
@ -563,9 +563,9 @@ impl SharedCache {
/// # Arguments /// # Arguments
/// ///
/// * `search_results` - It takes the `SearchResults` as an argument which are results that /// * `search_results` - It takes the `SearchResults` as an argument which are results that
/// needs to be cached. /// needs to be cached.
/// * `url` - It takes the search url as an argument which will be used as the key for storing /// * `url` - It takes the search url as an argument which will be used as the key for storing
/// results in the cache. /// results in the cache.
/// ///
/// # Error /// # Error
/// ///

View File

@ -48,6 +48,8 @@ pub struct Config {
pub tcp_connection_keep_alive: u8, pub tcp_connection_keep_alive: u8,
/// It stores the pool idle connection timeout in seconds. /// It stores the pool idle connection timeout in seconds.
pub pool_idle_connection_timeout: u8, pub pool_idle_connection_timeout: u8,
/// It stores the number of https connections to keep in the pool.
pub number_of_https_connections: u8,
} }
impl Config { impl Config {
@ -57,7 +59,7 @@ impl Config {
/// # Arguments /// # Arguments
/// ///
/// * `logging_initialized` - It takes a boolean which ensures that the logging doesn't get /// * `logging_initialized` - It takes a boolean which ensures that the logging doesn't get
/// initialized twice. Pass false if the logger has not yet been initialized. /// initialized twice. Pass false if the logger has not yet been initialized.
/// ///
/// # Error /// # Error
/// ///
@ -139,6 +141,7 @@ impl Config {
request_timeout: globals.get::<_, u8>("request_timeout")?, request_timeout: globals.get::<_, u8>("request_timeout")?,
tcp_connection_keep_alive: globals.get::<_, u8>("tcp_connection_keep_alive")?, tcp_connection_keep_alive: globals.get::<_, u8>("tcp_connection_keep_alive")?,
pool_idle_connection_timeout: globals.get::<_, u8>("pool_idle_connection_timeout")?, pool_idle_connection_timeout: globals.get::<_, u8>("pool_idle_connection_timeout")?,
number_of_https_connections: globals.get::<_, u8>("number_of_https_connections")?,
threads, threads,
client_connection_keep_alive: globals.get::<_, u8>("client_connection_keep_alive")?, client_connection_keep_alive: globals.get::<_, u8>("client_connection_keep_alive")?,
rate_limiter: RateLimiter { rate_limiter: RateLimiter {

View File

@ -11,7 +11,9 @@ use thesaurus::synonyms;
/// A named struct to store the raw scraped search results scraped search results from the /// A named struct to store the raw scraped search results scraped search results from the
/// upstream search engines before aggregating it.It derives the Clone trait which is needed /// upstream search engines before aggregating it.It derives the Clone trait which is needed
/// to write idiomatic rust using `Iterators`. /// to write idiomatic rust using `Iterators`.
/// (href url in html in simple words). ///
/// (href url in html in simple words).
///
#[derive(Clone, Serialize, Deserialize)] #[derive(Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")] #[serde(rename_all = "camelCase")]
pub struct SearchResult { pub struct SearchResult {
@ -34,7 +36,7 @@ impl SearchResult {
/// ///
/// * `title` - The title of the search result. /// * `title` - The title of the search result.
/// * `url` - The url which is accessed when clicked on it /// * `url` - The url which is accessed when clicked on it
/// (href url in html in simple words). /// (href url in html in simple words).
/// * `description` - The description of the search result. /// * `description` - The description of the search result.
/// * `engine` - The names of the upstream engines from which this results were provided. /// * `engine` - The names of the upstream engines from which this results were provided.
pub fn new(title: &str, url: &str, description: &str, engine: &[&str]) -> Self { pub fn new(title: &str, url: &str, description: &str, engine: &[&str]) -> Self {
@ -124,7 +126,7 @@ impl EngineErrorInfo {
/// # Arguments /// # Arguments
/// ///
/// * `error` - It takes the error type which occured while fetching the result from a particular /// * `error` - It takes the error type which occured while fetching the result from a particular
/// search engine. /// search engine.
/// * `engine` - It takes the name of the engine that failed to provide the requested search results. /// * `engine` - It takes the name of the engine that failed to provide the requested search results.
pub fn new(error: &EngineError, engine: &str) -> Self { pub fn new(error: &EngineError, engine: &str) -> Self {
Self { Self {
@ -177,11 +179,11 @@ impl SearchResults {
/// # Arguments /// # Arguments
/// ///
/// * `results` - Takes an argument of individual serializable `SearchResult` struct /// * `results` - Takes an argument of individual serializable `SearchResult` struct
/// and stores it into a vector of `SearchResult` structs. /// and stores it into a vector of `SearchResult` structs.
/// * `page_query` - Takes an argument of current page`s search query `q` provided in /// * `page_query` - Takes an argument of current page`s search query `q` provided in
/// the search url. /// the search url.
/// * `engine_errors_info` - Takes an array of structs which contains information regarding /// * `engine_errors_info` - Takes an array of structs which contains information regarding
/// which engines failed with their names, reason and their severity color name. /// which engines failed with their names, reason and their severity color name.
pub fn new(results: Box<[SearchResult]>, engine_errors_info: Box<[EngineErrorInfo]>) -> Self { pub fn new(results: Box<[SearchResult]>, engine_errors_info: Box<[EngineErrorInfo]>) -> Self {
Self { Self {
results, results,

View File

@ -29,7 +29,7 @@ impl Style {
/// ///
/// * `theme` - It takes the parsed theme option used to set a theme for the website. /// * `theme` - It takes the parsed theme option used to set a theme for the website.
/// * `colorscheme` - It takes the parsed colorscheme option used to set a colorscheme /// * `colorscheme` - It takes the parsed colorscheme option used to set a colorscheme
/// for the theme being used. /// for the theme being used.
pub fn new(theme: String, colorscheme: String, animation: Option<String>) -> Self { pub fn new(theme: String, colorscheme: String, animation: Option<String>) -> Self {
Style { Style {
theme, theme,

View File

@ -60,7 +60,7 @@ type FutureVec =
/// * `debug` - Accepts a boolean value to enable or disable debug mode option. /// * `debug` - Accepts a boolean value to enable or disable debug mode option.
/// * `upstream_search_engines` - Accepts a vector of search engine names which was selected by the /// * `upstream_search_engines` - Accepts a vector of search engine names which was selected by the
/// * `request_timeout` - Accepts a time (secs) as a value which controls the server request timeout. /// * `request_timeout` - Accepts a time (secs) as a value which controls the server request timeout.
/// user through the UI or the config file. /// user through the UI or the config file.
/// ///
/// # Error /// # Error
/// ///
@ -81,6 +81,7 @@ pub async fn aggregate(
config.pool_idle_connection_timeout as u64, config.pool_idle_connection_timeout as u64,
)) ))
.tcp_keepalive(Duration::from_secs(config.tcp_connection_keep_alive as u64)) .tcp_keepalive(Duration::from_secs(config.tcp_connection_keep_alive as u64))
.pool_max_idle_per_host(config.number_of_https_connections as usize)
.connect_timeout(Duration::from_secs(config.request_timeout as u64)) // Add timeout to request to avoid DDOSing the server .connect_timeout(Duration::from_secs(config.request_timeout as u64)) // Add timeout to request to avoid DDOSing the server
.https_only(true) .https_only(true)
.gzip(true) .gzip(true)

View File

@ -146,7 +146,7 @@ pub async fn search(
/// # Arguments /// # Arguments
/// ///
/// * `url` - It takes the url of the current page that requested the search results for a /// * `url` - It takes the url of the current page that requested the search results for a
/// particular search query. /// particular search query.
/// * `config` - It takes a parsed config struct. /// * `config` - It takes a parsed config struct.
/// * `query` - It takes the page number as u32 value. /// * `query` - It takes the page number as u32 value.
/// * `req` - It takes the `HttpRequest` struct as a value. /// * `req` - It takes the `HttpRequest` struct as a value.

View File

@ -12,7 +12,7 @@ const SAFE_SEARCH_LEVELS_NAME: [&str; 3] = ["None", "Low", "Moderate"];
/// # Arguments /// # Arguments
/// ///
/// * `engine_errors_info` - It takes the engine errors list containing errors for each upstream /// * `engine_errors_info` - It takes the engine errors list containing errors for each upstream
/// search engine which failed to provide results as an argument. /// search engine which failed to provide results as an argument.
/// * `safe_search_level` - It takes the safe search level with values from 0-2 as an argument. /// * `safe_search_level` - It takes the safe search level with values from 0-2 as an argument.
/// * `query` - It takes the current search query provided by user as an argument. /// * `query` - It takes the current search query provided by user as an argument.
/// ///

View File

@ -9,7 +9,7 @@ use maud::{html, Markup};
/// # Arguments /// # Arguments
/// ///
/// * `engine_names` - It takes the key value pair list of all available engine names and there corresponding /// * `engine_names` - It takes the key value pair list of all available engine names and there corresponding
/// selected (enabled/disabled) value as an argument. /// selected (enabled/disabled) value as an argument.
/// ///
/// # Returns /// # Returns
/// ///

View File

@ -11,9 +11,9 @@ use std::fs::read_dir;
/// # Arguments /// # Arguments
/// ///
/// * `style_type` - It takes the style type of the values `theme` and `colorscheme` as an /// * `style_type` - It takes the style type of the values `theme` and `colorscheme` as an
/// argument. /// argument.
/// * `selected_style` - It takes the currently selected style value provided via the config file /// * `selected_style` - It takes the currently selected style value provided via the config file
/// as an argument. /// as an argument.
/// ///
/// # Error /// # Error
/// ///

View File

@ -18,6 +18,8 @@ rate_limiter = {
} }
-- Set whether the server will use an adaptive/dynamic HTTPS window size, see https://httpwg.org/specs/rfc9113.html#fc-principles -- Set whether the server will use an adaptive/dynamic HTTPS window size, see https://httpwg.org/specs/rfc9113.html#fc-principles
https_adaptive_window_size = false https_adaptive_window_size = false
number_of_https_connections = 10 -- the number of https connections that should be available in the connection pool.
-- Set keep-alive timer in seconds; keeps clients connected to the HTTP server, different from the connection to upstream search engines -- Set keep-alive timer in seconds; keeps clients connected to the HTTP server, different from the connection to upstream search engines
client_connection_keep_alive = 120 client_connection_keep_alive = 120