X-Git-Url: http://these/git/?a=blobdiff_plain;f=crates%2Fdb_schema%2Fsrc%2Futils.rs;h=7e8204de9a7844154d8c3f919f71de6640f6547d;hb=3471f3533cb724b2cf6953d563aadfcc9f66c1d2;hp=f8a6f7db01f294d9bf248b89680c6962462db8f5;hpb=5d837780f5d149cb8d3b861c63a7dc4466a7cbf1;p=lemmy.git diff --git a/crates/db_schema/src/utils.rs b/crates/db_schema/src/utils.rs index f8a6f7db..7e8204de 100644 --- a/crates/db_schema/src/utils.rs +++ b/crates/db_schema/src/utils.rs @@ -3,41 +3,149 @@ use crate::{ diesel_migrations::MigrationHarness, newtypes::DbUrl, CommentSortType, + PersonSortType, SortType, }; -use activitypub_federation::{core::object_id::ObjectId, traits::ApubObject}; -use bb8::PooledConnection; +use activitypub_federation::{fetch::object_id::ObjectId, traits::Object}; use chrono::NaiveDateTime; +use deadpool::Runtime; use diesel::{ backend::Backend, deserialize::FromSql, pg::Pg, - result::{Error as DieselError, Error::QueryBuilderError}, + result::{ConnectionError, ConnectionResult, Error as DieselError, Error::QueryBuilderError}, serialize::{Output, ToSql}, sql_types::Text, PgConnection, }; use diesel_async::{ pg::AsyncPgConnection, - pooled_connection::{bb8::Pool, AsyncDieselConnectionManager}, + pooled_connection::{ + deadpool::{Object as PooledConnection, Pool}, + AsyncDieselConnectionManager, + }, }; use diesel_migrations::EmbeddedMigrations; -use lemmy_utils::{error::LemmyError, settings::structs::Settings}; +use futures_util::{future::BoxFuture, FutureExt}; +use lemmy_utils::{ + error::{LemmyError, LemmyErrorExt, LemmyErrorType}, + settings::structs::Settings, +}; use once_cell::sync::Lazy; use regex::Regex; -use std::{env, env::VarError}; +use rustls::{ + client::{ServerCertVerified, ServerCertVerifier}, + ServerName, +}; +use std::{ + env, + env::VarError, + ops::{Deref, DerefMut}, + sync::Arc, + time::{Duration, SystemTime}, +}; +use tracing::{error, info}; use url::Url; const FETCH_LIMIT_DEFAULT: i64 = 10; pub const FETCH_LIMIT_MAX: i64 = 50; +const POOL_TIMEOUT: Option = Some(Duration::from_secs(5)); + +pub type ActualDbPool = Pool; + +/// References a pool or connection. Functions must take `&mut DbPool<'_>` to allow implicit reborrowing. +/// +/// https://github.com/rust-lang/rfcs/issues/1403 +pub enum DbPool<'a> { + Pool(&'a ActualDbPool), + Conn(&'a mut AsyncPgConnection), +} + +pub enum DbConn<'a> { + Pool(PooledConnection), + Conn(&'a mut AsyncPgConnection), +} + +pub async fn get_conn<'a, 'b: 'a>(pool: &'a mut DbPool<'b>) -> Result, DieselError> { + Ok(match pool { + DbPool::Pool(pool) => DbConn::Pool(pool.get().await.map_err(|e| QueryBuilderError(e.into()))?), + DbPool::Conn(conn) => DbConn::Conn(conn), + }) +} + +impl<'a> Deref for DbConn<'a> { + type Target = AsyncPgConnection; + + fn deref(&self) -> &Self::Target { + match self { + DbConn::Pool(conn) => conn.deref(), + DbConn::Conn(conn) => conn.deref(), + } + } +} -pub type DbPool = Pool; +impl<'a> DerefMut for DbConn<'a> { + fn deref_mut(&mut self) -> &mut Self::Target { + match self { + DbConn::Pool(conn) => conn.deref_mut(), + DbConn::Conn(conn) => conn.deref_mut(), + } + } +} -pub async fn get_conn( - pool: &DbPool, -) -> Result>, DieselError> { - // TODO Maybe find a better diesel error for this - pool.get().await.map_err(|_| DieselError::NotInTransaction) +// Allows functions that take `DbPool<'_>` to be called in a transaction by passing `&mut conn.into()` +impl<'a> From<&'a mut AsyncPgConnection> for DbPool<'a> { + fn from(value: &'a mut AsyncPgConnection) -> Self { + DbPool::Conn(value) + } +} + +impl<'a, 'b: 'a> From<&'a mut DbConn<'b>> for DbPool<'a> { + fn from(value: &'a mut DbConn<'b>) -> Self { + DbPool::Conn(value.deref_mut()) + } +} + +impl<'a> From<&'a ActualDbPool> for DbPool<'a> { + fn from(value: &'a ActualDbPool) -> Self { + DbPool::Pool(value) + } +} + +/// Runs multiple async functions that take `&mut DbPool<'_>` as input and return `Result`. Only works when the `futures` crate is listed in `Cargo.toml`. +/// +/// `$pool` is the value given to each function. +/// +/// A `Result` is returned (not in a `Future`, so don't use `.await`). The `Ok` variant contains a tuple with the values returned by the given functions. +/// +/// The functions run concurrently if `$pool` has the `DbPool::Pool` variant. +#[macro_export] +macro_rules! try_join_with_pool { + ($pool:ident => ($($func:expr),+)) => {{ + // Check type + let _: &mut $crate::utils::DbPool<'_> = $pool; + + match $pool { + // Run concurrently with `try_join` + $crate::utils::DbPool::Pool(__pool) => ::futures::try_join!( + $(async { + let mut __dbpool = $crate::utils::DbPool::Pool(__pool); + ($func)(&mut __dbpool).await + }),+ + ), + // Run sequentially + $crate::utils::DbPool::Conn(__conn) => async { + Ok(($({ + let mut __dbpool = $crate::utils::DbPool::Conn(__conn); + // `?` prevents the error type from being inferred in an `async` block, so `match` is used instead + match ($func)(&mut __dbpool).await { + ::core::result::Result::Ok(__v) => __v, + ::core::result::Result::Err(__v) => return ::core::result::Result::Err(__v), + } + }),+)) + }.await, + } + }}; } pub fn get_database_url_from_env() -> Result { @@ -46,7 +154,7 @@ pub fn get_database_url_from_env() -> Result { pub fn fuzzy_search(q: &str) -> String { let replaced = q.replace('%', "\\%").replace('_', "\\_").replace(' ', "%"); - format!("%{}%", replaced) + format!("%{replaced}%") } pub fn limit_and_offset( @@ -67,7 +175,7 @@ pub fn limit_and_offset( Some(limit) => { if !(1..=FETCH_LIMIT_MAX).contains(&limit) { return Err(QueryBuilderError( - format!("Fetch limit is > {}", FETCH_LIMIT_MAX).into(), + format!("Fetch limit is > {FETCH_LIMIT_MAX}").into(), )); } else { limit @@ -89,12 +197,12 @@ pub fn is_email_regex(test: &str) -> bool { EMAIL_REGEX.is_match(test) } -pub fn diesel_option_overwrite(opt: &Option) -> Option> { +pub fn diesel_option_overwrite(opt: Option) -> Option> { match opt { // An empty string is an erase Some(unwrapped) => { if !unwrapped.eq("") { - Some(Some(unwrapped.to_owned())) + Some(Some(unwrapped)) } else { Some(None) } @@ -106,13 +214,12 @@ pub fn diesel_option_overwrite(opt: &Option) -> Option> { pub fn diesel_option_overwrite_to_url( opt: &Option, ) -> Result>, LemmyError> { - match opt.as_ref().map(|s| s.as_str()) { + match opt.as_ref().map(String::as_str) { // An empty string is an erase Some("") => Ok(Some(None)), - Some(str_url) => match Url::parse(str_url) { - Ok(url) => Ok(Some(Some(url.into()))), - Err(e) => Err(LemmyError::from_error_message(e, "invalid_url")), - }, + Some(str_url) => Url::parse(str_url) + .map(|u| Some(Some(u.into()))) + .with_lemmy_type(LemmyErrorType::InvalidUrl), None => Ok(None), } } @@ -120,26 +227,37 @@ pub fn diesel_option_overwrite_to_url( pub fn diesel_option_overwrite_to_url_create( opt: &Option, ) -> Result, LemmyError> { - match opt.as_ref().map(|s| s.as_str()) { + match opt.as_ref().map(String::as_str) { // An empty string is nothing Some("") => Ok(None), - Some(str_url) => match Url::parse(str_url) { - Ok(url) => Ok(Some(url.into())), - Err(e) => Err(LemmyError::from_error_message(e, "invalid_url")), - }, + Some(str_url) => Url::parse(str_url) + .map(|u| Some(u.into())) + .with_lemmy_type(LemmyErrorType::InvalidUrl), None => Ok(None), } } -async fn build_db_pool_settings_opt(settings: Option<&Settings>) -> Result { +async fn build_db_pool_settings_opt( + settings: Option<&Settings>, +) -> Result { let db_url = get_database_url(settings); let pool_size = settings.map(|s| s.database.pool_size).unwrap_or(5); - let manager = AsyncDieselConnectionManager::::new(&db_url); - let pool = Pool::builder() + // We only support TLS with sslmode=require currently + let tls_enabled = db_url.contains("sslmode=require"); + let manager = if tls_enabled { + // diesel-async does not support any TLS connections out of the box, so we need to manually + // provide a setup function which handles creating the connection + AsyncDieselConnectionManager::::new_with_setup(&db_url, establish_connection) + } else { + AsyncDieselConnectionManager::::new(&db_url) + }; + let pool = Pool::builder(manager) .max_size(pool_size) - .min_idle(Some(1)) - .build(manager) - .await?; + .wait_timeout(POOL_TIMEOUT) + .create_timeout(POOL_TIMEOUT) + .recycle_timeout(POOL_TIMEOUT) + .runtime(Runtime::Tokio1) + .build()?; // If there's no settings, that means its a unit test, and migrations need to be run if settings.is_none() { @@ -149,22 +267,62 @@ async fn build_db_pool_settings_opt(settings: Option<&Settings>) -> Result BoxFuture> { + let fut = async { + let rustls_config = rustls::ClientConfig::builder() + .with_safe_defaults() + .with_custom_certificate_verifier(Arc::new(NoCertVerifier {})) + .with_no_client_auth(); + + let tls = tokio_postgres_rustls::MakeRustlsConnect::new(rustls_config); + let (client, conn) = tokio_postgres::connect(config, tls) + .await + .map_err(|e| ConnectionError::BadConnection(e.to_string()))?; + tokio::spawn(async move { + if let Err(e) = conn.await { + error!("Database connection failed: {e}"); + } + }); + AsyncPgConnection::try_from(client).await + }; + fut.boxed() +} + +struct NoCertVerifier {} + +impl ServerCertVerifier for NoCertVerifier { + fn verify_server_cert( + &self, + _end_entity: &rustls::Certificate, + _intermediates: &[rustls::Certificate], + _server_name: &ServerName, + _scts: &mut dyn Iterator, + _ocsp_response: &[u8], + _now: SystemTime, + ) -> Result { + // Will verify all (even invalid) certs without any checks (sslmode=require) + Ok(ServerCertVerified::assertion()) + } +} + pub const MIGRATIONS: EmbeddedMigrations = embed_migrations!(); pub fn run_migrations(db_url: &str) { // Needs to be a sync connection let mut conn = - PgConnection::establish(db_url).unwrap_or_else(|_| panic!("Error connecting to {}", db_url)); + PgConnection::establish(db_url).unwrap_or_else(|e| panic!("Error connecting to {db_url}: {e}")); + info!("Running Database migrations (This may take a long time)..."); let _ = &mut conn .run_pending_migrations(MIGRATIONS) - .unwrap_or_else(|_| panic!("Couldn't run DB Migrations")); + .unwrap_or_else(|e| panic!("Couldn't run DB Migrations: {e}")); + info!("Database migrations complete."); } -pub async fn build_db_pool(settings: &Settings) -> Result { +pub async fn build_db_pool(settings: &Settings) -> Result { build_db_pool_settings_opt(Some(settings)).await } -pub async fn build_db_pool_for_tests() -> DbPool { +pub async fn build_db_pool_for_tests() -> ActualDbPool { build_db_pool_settings_opt(None) .await .expect("db pool missing") @@ -176,10 +334,7 @@ pub fn get_database_url(settings: Option<&Settings>) -> String { Ok(url) => url, Err(e) => match settings { Some(settings) => settings.get_database_url(), - None => panic!( - "Failed to read database URL from env var LEMMY_DATABASE_URL: {}", - e - ), + None => panic!("Failed to read database URL from env var LEMMY_DATABASE_URL: {e}"), }, } } @@ -193,11 +348,28 @@ pub fn post_to_comment_sort_type(sort: SortType) -> CommentSortType { SortType::Active | SortType::Hot => CommentSortType::Hot, SortType::New | SortType::NewComments | SortType::MostComments => CommentSortType::New, SortType::Old => CommentSortType::Old, - SortType::TopDay + SortType::Controversial => CommentSortType::Controversial, + SortType::TopHour + | SortType::TopSixHour + | SortType::TopTwelveHour + | SortType::TopDay | SortType::TopAll | SortType::TopWeek | SortType::TopYear - | SortType::TopMonth => CommentSortType::Top, + | SortType::TopMonth + | SortType::TopThreeMonths + | SortType::TopSixMonths + | SortType::TopNineMonths => CommentSortType::Top, + } +} + +pub fn post_to_person_sort_type(sort: SortType) -> PersonSortType { + match sort { + SortType::Active | SortType::Hot | SortType::Controversial => PersonSortType::CommentScore, + SortType::New | SortType::NewComments => PersonSortType::New, + SortType::MostComments => PersonSortType::MostComments, + SortType::Old => PersonSortType::Old, + _ => PersonSortType::CommentScore, } } @@ -207,15 +379,21 @@ static EMAIL_REGEX: Lazy = Lazy::new(|| { }); pub mod functions { - use diesel::sql_types::*; + use diesel::sql_types::{BigInt, Text, Timestamp}; sql_function! { fn hot_rank(score: BigInt, time: Timestamp) -> Integer; } + sql_function! { + fn controversy_rank(upvotes: BigInt, downvotes: BigInt, score: BigInt) -> Double; + } + sql_function!(fn lower(x: Text) -> Text); } +pub const DELETED_REPLACEMENT_TEXT: &str = "*Permanently Deleted*"; + impl ToSql for DbUrl { fn to_sql(&self, out: &mut Output) -> diesel::serialize::Result { >::to_sql(&self.0.to_string(), &mut out.reborrow()) @@ -226,24 +404,27 @@ impl FromSql for DbUrl where String: FromSql, { - fn from_sql(value: diesel::backend::RawValue<'_, DB>) -> diesel::deserialize::Result { + fn from_sql(value: DB::RawValue<'_>) -> diesel::deserialize::Result { let str = String::from_sql(value)?; - Ok(DbUrl(Url::parse(&str)?)) + Ok(DbUrl(Box::new(Url::parse(&str)?))) } } impl From> for DbUrl where - Kind: ApubObject + Send + 'static, - for<'de2> ::ApubType: serde::Deserialize<'de2>, + Kind: Object + Send + 'static, + for<'de2> ::Kind: serde::Deserialize<'de2>, { fn from(id: ObjectId) -> Self { - DbUrl(id.into()) + DbUrl(Box::new(id.into())) } } #[cfg(test)] mod tests { + #![allow(clippy::unwrap_used)] + #![allow(clippy::indexing_slicing)] + use super::{fuzzy_search, *}; use crate::utils::is_email_regex; @@ -264,10 +445,10 @@ mod tests { #[test] fn test_diesel_option_overwrite() { - assert_eq!(diesel_option_overwrite(&None), None); - assert_eq!(diesel_option_overwrite(&Some("".to_string())), Some(None)); + assert_eq!(diesel_option_overwrite(None), None); + assert_eq!(diesel_option_overwrite(Some(String::new())), Some(None)); assert_eq!( - diesel_option_overwrite(&Some("test".to_string())), + diesel_option_overwrite(Some("test".to_string())), Some(Some("test".to_string())) ); } @@ -276,13 +457,10 @@ mod tests { fn test_diesel_option_overwrite_to_url() { assert!(matches!(diesel_option_overwrite_to_url(&None), Ok(None))); assert!(matches!( - diesel_option_overwrite_to_url(&Some("".to_string())), + diesel_option_overwrite_to_url(&Some(String::new())), Ok(Some(None)) )); - assert!(matches!( - diesel_option_overwrite_to_url(&Some("invalid_url".to_string())), - Err(_) - )); + assert!(diesel_option_overwrite_to_url(&Some("invalid_url".to_string())).is_err()); let example_url = "https://example.com"; assert!(matches!( diesel_option_overwrite_to_url(&Some(example_url.to_string())),