824 lines · 25.2 KB · Rust
RawDownload
mod ids;mod queries;mod tables;#[cfg(test)]pub mod tests; use crate::{executor::Executor, Error, Result};use anyhow::anyhow;use collections::{BTreeMap, HashMap, HashSet};use dashmap::DashMap;use futures::StreamExt;use rand::{prelude::StdRng, Rng, SeedableRng};use rpc::{    proto::{self},    ConnectionId, ExtensionMetadata,};use sea_orm::{    entity::prelude::*,    sea_query::{Alias, Expr, OnConflict},    ActiveValue, Condition, ConnectionTrait, DatabaseConnection, DatabaseTransaction, DbErr,    FromQueryResult, IntoActiveModel, IsolationLevel, JoinType, QueryOrder, QuerySelect, Statement,    TransactionTrait,};use semantic_version::SemanticVersion;use serde::{Deserialize, Serialize};use sqlx::{    migrate::{Migrate, Migration, MigrationSource},    Connection,};use std::ops::RangeInclusive;use std::{    fmt::Write as _,    future::Future,    marker::PhantomData,    ops::{Deref, DerefMut},    path::Path,    rc::Rc,    sync::Arc,    time::Duration,};use time::PrimitiveDateTime;use tokio::sync::{Mutex, OwnedMutexGuard}; #[cfg(test)]pub use tests::TestDb; pub use ids::*;pub use queries::contributors::ContributorSelector;pub use sea_orm::ConnectOptions;pub use tables::user::Model as User;pub use tables::*; /// Database gives you a handle that lets you access the database./// It handles pooling internally.pub struct Database {    options: ConnectOptions,    pool: DatabaseConnection,    rooms: DashMap<RoomId, Arc<Mutex<()>>>,    projects: DashMap<ProjectId, Arc<Mutex<()>>>,    rng: Mutex<StdRng>,    executor: Executor,    notification_kinds_by_id: HashMap<NotificationKindId, &'static str>,    notification_kinds_by_name: HashMap<String, NotificationKindId>,    #[cfg(test)]    runtime: Option<tokio::runtime::Runtime>,} // The `Database` type has so many methods that its impl blocks are split into// separate files in the `queries` folder.impl Database {    /// Connects to the database with the given options    pub async fn new(options: ConnectOptions, executor: Executor) -> Result<Self> {        sqlx::any::install_default_drivers();        Ok(Self {            options: options.clone(),            pool: sea_orm::Database::connect(options).await?,            rooms: DashMap::with_capacity(16384),            projects: DashMap::with_capacity(16384),            rng: Mutex::new(StdRng::seed_from_u64(0)),            notification_kinds_by_id: HashMap::default(),            notification_kinds_by_name: HashMap::default(),            executor,            #[cfg(test)]            runtime: None,        })    }     #[cfg(test)]    pub fn reset(&self) {        self.rooms.clear();        self.projects.clear();    }     /// Runs the database migrations.    pub async fn migrate(        &self,        migrations_path: &Path,        ignore_checksum_mismatch: bool,    ) -> anyhow::Result<Vec<(Migration, Duration)>> {        let migrations = MigrationSource::resolve(migrations_path)            .await            .map_err(|err| anyhow!("failed to load migrations: {err:?}"))?;         let mut connection = sqlx::AnyConnection::connect(self.options.get_url()).await?;         connection.ensure_migrations_table().await?;        let applied_migrations: HashMap<_, _> = connection            .list_applied_migrations()            .await?            .into_iter()            .map(|m| (m.version, m))            .collect();         let mut new_migrations = Vec::new();        for migration in migrations {            match applied_migrations.get(&migration.version) {                Some(applied_migration) => {                    if migration.checksum != applied_migration.checksum && !ignore_checksum_mismatch                    {                        Err(anyhow!(                            "checksum mismatch for applied migration {}",                            migration.description                        ))?;                    }                }                None => {                    let elapsed = connection.apply(&migration).await?;                    new_migrations.push((migration, elapsed));                }            }        }         Ok(new_migrations)    }     /// Transaction runs things in a transaction. If you want to call other methods    /// and pass the transaction around you need to reborrow the transaction at each    /// call site with: `&*tx`.    pub async fn transaction<F, Fut, T>(&self, f: F) -> Result<T>    where        F: Send + Fn(TransactionHandle) -> Fut,        Fut: Send + Future<Output = Result<T>>,    {        let body = async {            let mut i = 0;            loop {                let (tx, result) = self.with_transaction(&f).await?;                match result {                    Ok(result) => match tx.commit().await.map_err(Into::into) {                        Ok(()) => return Ok(result),                        Err(error) => {                            if !self.retry_on_serialization_error(&error, i).await {                                return Err(error);                            }                        }                    },                    Err(error) => {                        tx.rollback().await?;                        if !self.retry_on_serialization_error(&error, i).await {                            return Err(error);                        }                    }                }                i += 1;            }        };         self.run(body).await    }     pub async fn weak_transaction<F, Fut, T>(&self, f: F) -> Result<T>    where        F: Send + Fn(TransactionHandle) -> Fut,        Fut: Send + Future<Output = Result<T>>,    {        let body = async {            let (tx, result) = self.with_weak_transaction(&f).await?;            match result {                Ok(result) => match tx.commit().await.map_err(Into::into) {                    Ok(()) => return Ok(result),                    Err(error) => {                        return Err(error);                    }                },                Err(error) => {                    tx.rollback().await?;                    return Err(error);                }            }        };         self.run(body).await    }     /// The same as room_transaction, but if you need to only optionally return a Room.    async fn optional_room_transaction<F, Fut, T>(        &self,        f: F,    ) -> Result<Option<TransactionGuard<T>>>    where        F: Send + Fn(TransactionHandle) -> Fut,        Fut: Send + Future<Output = Result<Option<(RoomId, T)>>>,    {        let body = async {            let mut i = 0;            loop {                let (tx, result) = self.with_transaction(&f).await?;                match result {                    Ok(Some((room_id, data))) => {                        let lock = self.rooms.entry(room_id).or_default().clone();                        let _guard = lock.lock_owned().await;                        match tx.commit().await.map_err(Into::into) {                            Ok(()) => {                                return Ok(Some(TransactionGuard {                                    data,                                    _guard,                                    _not_send: PhantomData,                                }));                            }                            Err(error) => {                                if !self.retry_on_serialization_error(&error, i).await {                                    return Err(error);                                }                            }                        }                    }                    Ok(None) => match tx.commit().await.map_err(Into::into) {                        Ok(()) => return Ok(None),                        Err(error) => {                            if !self.retry_on_serialization_error(&error, i).await {                                return Err(error);                            }                        }                    },                    Err(error) => {                        tx.rollback().await?;                        if !self.retry_on_serialization_error(&error, i).await {                            return Err(error);                        }                    }                }                i += 1;            }        };         self.run(body).await    }     async fn project_transaction<F, Fut, T>(        &self,        project_id: ProjectId,        f: F,    ) -> Result<TransactionGuard<T>>    where        F: Send + Fn(TransactionHandle) -> Fut,        Fut: Send + Future<Output = Result<T>>,    {        let room_id = Database::room_id_for_project(&self, project_id).await?;        let body = async {            let mut i = 0;            loop {                let lock = if let Some(room_id) = room_id {                    self.rooms.entry(room_id).or_default().clone()                } else {                    self.projects.entry(project_id).or_default().clone()                };                let _guard = lock.lock_owned().await;                let (tx, result) = self.with_transaction(&f).await?;                match result {                    Ok(data) => match tx.commit().await.map_err(Into::into) {                        Ok(()) => {                            return Ok(TransactionGuard {                                data,                                _guard,                                _not_send: PhantomData,                            });                        }                        Err(error) => {                            if !self.retry_on_serialization_error(&error, i).await {                                return Err(error);                            }                        }                    },                    Err(error) => {                        tx.rollback().await?;                        if !self.retry_on_serialization_error(&error, i).await {                            return Err(error);                        }                    }                }                i += 1;            }        };         self.run(body).await    }     /// room_transaction runs the block in a transaction. It returns a RoomGuard, that keeps    /// the database locked until it is dropped. This ensures that updates sent to clients are    /// properly serialized with respect to database changes.    async fn room_transaction<F, Fut, T>(        &self,        room_id: RoomId,        f: F,    ) -> Result<TransactionGuard<T>>    where        F: Send + Fn(TransactionHandle) -> Fut,        Fut: Send + Future<Output = Result<T>>,    {        let body = async {            let mut i = 0;            loop {                let lock = self.rooms.entry(room_id).or_default().clone();                let _guard = lock.lock_owned().await;                let (tx, result) = self.with_transaction(&f).await?;                match result {                    Ok(data) => match tx.commit().await.map_err(Into::into) {                        Ok(()) => {                            return Ok(TransactionGuard {                                data,                                _guard,                                _not_send: PhantomData,                            });                        }                        Err(error) => {                            if !self.retry_on_serialization_error(&error, i).await {                                return Err(error);                            }                        }                    },                    Err(error) => {                        tx.rollback().await?;                        if !self.retry_on_serialization_error(&error, i).await {                            return Err(error);                        }                    }                }                i += 1;            }        };         self.run(body).await    }     async fn with_transaction<F, Fut, T>(&self, f: &F) -> Result<(DatabaseTransaction, Result<T>)>    where        F: Send + Fn(TransactionHandle) -> Fut,        Fut: Send + Future<Output = Result<T>>,    {        let tx = self            .pool            .begin_with_config(Some(IsolationLevel::Serializable), None)            .await?;         let mut tx = Arc::new(Some(tx));        let result = f(TransactionHandle(tx.clone())).await;        let Some(tx) = Arc::get_mut(&mut tx).and_then(|tx| tx.take()) else {            return Err(anyhow!(                "couldn't complete transaction because it's still in use"            ))?;        };         Ok((tx, result))    }     async fn with_weak_transaction<F, Fut, T>(        &self,        f: &F,    ) -> Result<(DatabaseTransaction, Result<T>)>    where        F: Send + Fn(TransactionHandle) -> Fut,        Fut: Send + Future<Output = Result<T>>,    {        let tx = self            .pool            .begin_with_config(Some(IsolationLevel::ReadCommitted), None)            .await?;         let mut tx = Arc::new(Some(tx));        let result = f(TransactionHandle(tx.clone())).await;        let Some(tx) = Arc::get_mut(&mut tx).and_then(|tx| tx.take()) else {            return Err(anyhow!(                "couldn't complete transaction because it's still in use"            ))?;        };         Ok((tx, result))    }     async fn run<F, T>(&self, future: F) -> Result<T>    where        F: Future<Output = Result<T>>,    {        #[cfg(test)]        {            if let Executor::Deterministic(executor) = &self.executor {                executor.simulate_random_delay().await;            }             self.runtime.as_ref().unwrap().block_on(future)        }         #[cfg(not(test))]        {            future.await        }    }     async fn retry_on_serialization_error(&self, error: &Error, prev_attempt_count: usize) -> bool {        // If the error is due to a failure to serialize concurrent transactions, then retry        // this transaction after a delay. With each subsequent retry, double the delay duration.        // Also vary the delay randomly in order to ensure different database connections retry        // at different times.        const SLEEPS: [f32; 10] = [10., 20., 40., 80., 160., 320., 640., 1280., 2560., 5120.];        if is_serialization_error(error) && prev_attempt_count < SLEEPS.len() {            let base_delay = SLEEPS[prev_attempt_count];            let randomized_delay = base_delay * self.rng.lock().await.gen_range(0.5..=2.0);            log::warn!(                "retrying transaction after serialization error. delay: {} ms.",                randomized_delay            );            self.executor                .sleep(Duration::from_millis(randomized_delay as u64))                .await;            true        } else {            false        }    }} fn is_serialization_error(error: &Error) -> bool {    const SERIALIZATION_FAILURE_CODE: &str = "40001";    match error {        Error::Database(            DbErr::Exec(sea_orm::RuntimeErr::SqlxError(error))            | DbErr::Query(sea_orm::RuntimeErr::SqlxError(error)),        ) if error            .as_database_error()            .and_then(|error| error.code())            .as_deref()            == Some(SERIALIZATION_FAILURE_CODE) =>        {            true        }        _ => false,    }} /// A handle to a [`DatabaseTransaction`].pub struct TransactionHandle(Arc<Option<DatabaseTransaction>>); impl Deref for TransactionHandle {    type Target = DatabaseTransaction;     fn deref(&self) -> &Self::Target {        self.0.as_ref().as_ref().unwrap()    }} /// [`TransactionGuard`] keeps a database transaction alive until it is dropped./// It wraps data that depends on the state of the database and prevents an additional/// transaction from starting that would invalidate that data.pub struct TransactionGuard<T> {    data: T,    _guard: OwnedMutexGuard<()>,    _not_send: PhantomData<Rc<()>>,} impl<T> Deref for TransactionGuard<T> {    type Target = T;     fn deref(&self) -> &T {        &self.data    }} impl<T> DerefMut for TransactionGuard<T> {    fn deref_mut(&mut self) -> &mut T {        &mut self.data    }} impl<T> TransactionGuard<T> {    /// Returns the inner value of the guard.    pub fn into_inner(self) -> T {        self.data    }} #[derive(Clone, Debug, PartialEq, Eq)]pub enum Contact {    Accepted { user_id: UserId, busy: bool },    Outgoing { user_id: UserId },    Incoming { user_id: UserId },} impl Contact {    pub fn user_id(&self) -> UserId {        match self {

Lines 1–500 of 824.