nightly rustfmt

Author: reivilibre

crates/cli/src/commands/syn2mas.rs

@@ -12,43 +12,51 @@ use tracing::{error, warn};
 
 use crate::util::database_connection_from_config;
 
-/// The exit code used by `syn2mas check` and `syn2mas migrate` when there are errors preventing migration.
+/// The exit code used by `syn2mas check` and `syn2mas migrate` when there are
+/// errors preventing migration.
 const EXIT_CODE_CHECK_ERRORS: u8 = 10;
 
-/// The exit code used by `syn2mas check` when there are warnings which should be considered prior to migration.
+/// The exit code used by `syn2mas check` when there are warnings which should
+/// be considered prior to migration.
 const EXIT_CODE_CHECK_WARNINGS: u8 = 11;
 
 #[derive(Parser, Debug)]
 pub(super) struct Options {
     #[command(subcommand)]
     subcommand: Subcommand,
 
-    /// This version of the syn2mas tool is EXPERIMENTAL and INCOMPLETE. It is only suitable for TESTING.
-    /// If you want to use this tool anyway, please pass this argument.
+    /// This version of the syn2mas tool is EXPERIMENTAL and INCOMPLETE. It is
+    /// only suitable for TESTING. If you want to use this tool anyway,
+    /// please pass this argument.
     ///
-    /// If you want to migrate from Synapse to MAS today, please use the Node.js-based tool in the MAS repository.
+    /// If you want to migrate from Synapse to MAS today, please use the
+    /// Node.js-based tool in the MAS repository.
     #[clap(long = "i-swear-i-am-just-testing-in-a-staging-environment")]
     experimental_accepted: bool,
 
     /// Path to the Synapse configuration (in YAML format).
-    /// May be specified multiple times if multiple Synapse configuration files are in use.
+    /// May be specified multiple times if multiple Synapse configuration files
+    /// are in use.
     #[clap(long = "synapse-config")]
     synapse_configuration_files: Vec<Utf8PathBuf>,
 
     /// Override the Synapse database URI.
-    /// syn2mas normally loads the Synapse database connection details from the Synapse configuration.
-    /// However, it may sometimes be necessary to override the database URI and in that case this flag can be used.
+    /// syn2mas normally loads the Synapse database connection details from the
+    /// Synapse configuration. However, it may sometimes be necessary to
+    /// override the database URI and in that case this flag can be used.
     ///
     /// Should be a connection URI of the following general form:
     /// ```text
     /// postgresql://[user[:password]@][host][:port][/dbname][?param1=value1&...]
     /// ```
-    /// To use a UNIX socket at a custom path, the host should be a path to a socket, but in the URI string
-    /// it must be URI-encoded by replacing `/` with `%2F`.
+    /// To use a UNIX socket at a custom path, the host should be a path to a
+    /// socket, but in the URI string it must be URI-encoded by replacing
+    /// `/` with `%2F`.
     ///
-    /// Finally, any missing values will be loaded from the libpq-compatible environment variables
-    /// `PGHOST`, `PGPORT`, `PGUSER`, `PGDATABASE`, `PGPASSWORD`, etc.
-    /// It is valid to specify the URL `postgresql:` and configure all values through those environment variables.
+    /// Finally, any missing values will be loaded from the libpq-compatible
+    /// environment variables `PGHOST`, `PGPORT`, `PGUSER`, `PGDATABASE`,
+    /// `PGPASSWORD`, etc. It is valid to specify the URL `postgresql:` and
+    /// configure all values through those environment variables.
     #[clap(long = "synapse-database-uri")]
     synapse_database_uri: Option<PgConnectOptions>,
 }

crates/syn2mas/src/lib.rs

@@ -8,11 +8,13 @@ mod synapse_reader;
 
 mod migration;
 
-pub use self::mas_writer::locking::LockedMasDatabase;
-pub use self::mas_writer::{checks::mas_pre_migration_checks, MasWriter};
-pub use self::migration::migrate;
-pub use self::synapse_reader::checks::{
-    synapse_config_check, synapse_config_check_against_mas_config, synapse_database_check,
+pub use self::{
+    mas_writer::{checks::mas_pre_migration_checks, locking::LockedMasDatabase, MasWriter},
+    migration::migrate,
+    synapse_reader::{
+        checks::{
+            synapse_config_check, synapse_config_check_against_mas_config, synapse_database_check,
+        },
+        config as synapse_config, SynapseReader,
+    },
 };
-pub use self::synapse_reader::config as synapse_config;
-pub use self::synapse_reader::SynapseReader;

crates/syn2mas/src/mas_writer/checks.rs

@@ -5,7 +5,8 @@
 
 //! # MAS Database Checks
 //!
-//! This module provides safety checks to run against a MAS database before running the Synapse-to-MAS migration.
+//! This module provides safety checks to run against a MAS database before
+//! running the Synapse-to-MAS migration.
 
 use thiserror::Error;
 use thiserror_ext::ContextInto;
@@ -43,7 +44,8 @@ pub enum Error {
 ///
 /// - If any database access error occurs.
 /// - If any MAS tables involved in the migration are not empty.
-/// - If we can't check whether syn2mas is already in progress on this database or not.
+/// - If we can't check whether syn2mas is already in progress on this database
+///   or not.
 #[tracing::instrument(skip_all)]
 pub async fn mas_pre_migration_checks<'a>(
     mas_connection: &mut LockedMasDatabase<'a>,
@@ -56,7 +58,8 @@ pub async fn mas_pre_migration_checks<'a>(
         return Ok(());
     }
 
-    // Check that the database looks like a MAS database and that it is also an empty database.
+    // Check that the database looks like a MAS database and that it is also an
+    // empty database.
 
     for &table in MAS_TABLES_AFFECTED_BY_MIGRATION {
         let row_present = sqlx::query(&format!("SELECT 1 AS dummy FROM {table} LIMIT 1"))

crates/syn2mas/src/mas_writer/locking.rs

@@ -13,17 +13,19 @@ use sqlx::{
 static SYN2MAS_ADVISORY_LOCK: LazyLock<PgAdvisoryLock> =
     LazyLock::new(|| PgAdvisoryLock::new("syn2mas-maswriter"));
 
-/// A wrapper around a Postgres connection which holds a session-wide advisory lock
-/// preventing concurrent access by other syn2mas instances.
+/// A wrapper around a Postgres connection which holds a session-wide advisory
+/// lock preventing concurrent access by other syn2mas instances.
 pub struct LockedMasDatabase<'conn> {
     inner: PgAdvisoryLockGuard<'static, &'conn mut PgConnection>,
 }
 
 impl<'conn> LockedMasDatabase<'conn> {
-    /// Attempts to lock the MAS database against concurrent access by other syn2mas instances.
+    /// Attempts to lock the MAS database against concurrent access by other
+    /// syn2mas instances.
     ///
     /// If the lock can be acquired, returns a `LockedMasDatabase`.
-    /// If the lock cannot be acquired, returns the connection back to the caller wrapped in `Either::Right`.
+    /// If the lock cannot be acquired, returns the connection back to the
+    /// caller wrapped in `Either::Right`.
     ///
     /// # Errors
     ///

crates/syn2mas/src/mas_writer/mod.rs

@@ -146,7 +146,8 @@ impl WriterConnectionPool {
     ///
     /// # Panics
     ///
-    /// - If connections were not returned to the pool. (This indicates a serious bug.)
+    /// - If connections were not returned to the pool. (This indicates a
+    ///   serious bug.)
     pub async fn finish(self) -> Result<(), Vec<Error>> {
         let mut errors = Vec::new();
 
@@ -221,8 +222,8 @@ pub struct MasNewUnsupportedThreepid {
     pub created_at: DateTime<Utc>,
 }
 
-/// The 'version' of the password hashing scheme used for passwords when they are
-/// migrated from Synapse to MAS.
+/// The 'version' of the password hashing scheme used for passwords when they
+/// are migrated from Synapse to MAS.
 /// This is version 1, as in the previous syn2mas script.
 // TODO hardcoding version to `1` may not be correct long-term?
 pub const MIGRATED_PASSWORD_VERSION: u16 = 1;
@@ -246,8 +247,8 @@ pub const MAS_TABLES_AFFECTED_BY_MIGRATION: &[&str] = &[
 /// Errors are returned under the following circumstances:
 ///
 /// - If any database error occurs whilst querying the database.
-/// - If some, but not all, syn2mas restoration tables are present.
-///   (This shouldn't be possible without syn2mas having been sabotaged!)
+/// - If some, but not all, syn2mas restoration tables are present. (This
+///   shouldn't be possible without syn2mas having been sabotaged!)
 pub async fn is_syn2mas_in_progress(conn: &mut PgConnection) -> Result<bool, Error> {
     // Names of tables used for syn2mas resumption
     // Must be `String`s, not just `&str`, for the query.
@@ -476,7 +477,8 @@ impl<'conn> MasWriter<'conn> {
             .await
             .map_err(|errors| Error::Multiple(MultipleErrors::from(errors)))?;
 
-        // Now all the data has been migrated, finish off by restoring indices and constraints!
+        // Now all the data has been migrated, finish off by restoring indices and
+        // constraints!
 
         query("BEGIN TRANSACTION ISOLATION LEVEL READ COMMITTED;")
             .execute(self.conn.as_mut())
@@ -718,10 +720,11 @@ impl<'conn> MasWriter<'conn> {
     }
 }
 
-// How many entries to buffer at once, before writing a batch of rows to the database.
-// TODO tune: didn't see that much difference between 4k and 64k
-// (4k: 13.5~14, 64k: 12.5~13s — streaming the whole way would be better, especially for DB latency, but probably fiiine
-// and also we won't be able to stream to two tables at once...)
+// How many entries to buffer at once, before writing a batch of rows to the
+// database. TODO tune: didn't see that much difference between 4k and 64k
+// (4k: 13.5~14, 64k: 12.5~13s — streaming the whole way would be better,
+// especially for DB latency, but probably fiiine and also we won't be able to
+// stream to two tables at once...)
 const WRITE_BUFFER_BATCH_SIZE: usize = 4096;
 
 pub struct MasUserWriteBuffer<'writer, 'conn> {
@@ -846,7 +849,6 @@ mod test {
 
     use chrono::DateTime;
     use futures_util::TryStreamExt;
-
     use serde::Serialize;
     use sqlx::{Column, PgConnection, PgPool, Row};
     use uuid::Uuid;
@@ -877,9 +879,11 @@ mod test {
 
     const SKIPPED_TABLES: &[&str] = &["_sqlx_migrations"];
 
-    /// Produces a serialisable snapshot of a database, usable for snapshot testing
+    /// Produces a serialisable snapshot of a database, usable for snapshot
+    /// testing
     ///
-    /// For brevity, empty tables, as well as [`SKIPPED_TABLES`], will not be included in the snapshot.
+    /// For brevity, empty tables, as well as [`SKIPPED_TABLES`], will not be
+    /// included in the snapshot.
     async fn snapshot_database(conn: &mut PgConnection) -> DatabaseSnapshot {
         let mut out = DatabaseSnapshot::default();
         let table_names: Vec<String> = sqlx::query_scalar(

crates/syn2mas/src/migration.rs

@@ -5,9 +5,11 @@
 
 //! # Migration
 //!
-//! This module provides the high-level logic for performing the Synapse-to-MAS database migration.
+//! This module provides the high-level logic for performing the Synapse-to-MAS
+//! database migration.
 //!
-//! This module does not implement any of the safety checks that should be run *before* the migration.
+//! This module does not implement any of the safety checks that should be run
+//! *before* the migration.
 
 use std::{collections::HashMap, pin::pin};
 

crates/syn2mas/src/synapse_reader/checks.rs

@@ -5,7 +5,8 @@
 
 //! # Synapse Checks
 //!
-//! This module provides safety checks to run against a Synapse database before running the Synapse-to-MAS migration.
+//! This module provides safety checks to run against a Synapse database before
+//! running the Synapse-to-MAS migration.
 
 use figment::Figment;
 use mas_config::{
@@ -15,9 +16,8 @@ use mas_config::{
 use sqlx::{prelude::FromRow, query_as, query_scalar, PgConnection};
 use thiserror::Error;
 
-use crate::mas_writer::MIGRATED_PASSWORD_VERSION;
-
 use super::config::Config;
+use crate::mas_writer::MIGRATED_PASSWORD_VERSION;
 
 #[derive(Debug, Error)]
 pub enum Error {
@@ -31,7 +31,8 @@ pub enum Error {
     MasPasswordConfig(#[source] anyhow::Error),
 }
 
-/// An error found whilst checking the Synapse database, that should block a migration.
+/// An error found whilst checking the Synapse database, that should block a
+/// migration.
 #[derive(Debug, Error)]
 pub enum CheckError {
     #[error("MAS config is missing a password hashing scheme with version '1'")]
@@ -74,8 +75,9 @@ pub enum CheckError {
     },
 }
 
-/// A potential hazard found whilst checking the Synapse database, that should be presented
-/// to the operator to check they are aware of a caveat before proceeding with the migration.
+/// A potential hazard found whilst checking the Synapse database, that should
+/// be presented to the operator to check they are aware of a caveat before
+/// proceeding with the migration.
 #[derive(Debug, Error)]
 pub enum CheckWarning {
     #[error("Synapse config contains OIDC auth configuration (issuer: {issuer:?}) which will need to be manually mapped to an upstream OpenID Connect Provider during migration.")]
@@ -148,12 +150,14 @@ pub fn synapse_config_check(synapse_config: &Config) -> (Vec<CheckWarning>, Vec<
     (warnings, errors)
 }
 
-/// Check that the given Synapse configuration is sane for migration to a MAS with the given MAS configuration.
+/// Check that the given Synapse configuration is sane for migration to a MAS
+/// with the given MAS configuration.
 ///
 /// # Errors
 ///
 /// - If any necessary section of MAS config cannot be parsed.
-/// - If the MAS password configuration (including any necessary secrets) can't be loaded.
+/// - If the MAS password configuration (including any necessary secrets) can't
+///   be loaded.
 pub async fn synapse_config_check_against_mas_config(
     synapse: &Config,
     mas: &Figment,
@@ -169,8 +173,9 @@ pub async fn synapse_config_check_against_mas_config(
 
     let mas_matrix = MatrixConfig::extract(mas)?;
 
-    // Look for the MAS password hashing scheme that will be used for imported Synapse passwords,
-    // then check the configuration matches so that Synapse passwords will be compatible with MAS.
+    // Look for the MAS password hashing scheme that will be used for imported
+    // Synapse passwords, then check the configuration matches so that Synapse
+    // passwords will be compatible with MAS.
     if let Some((_, algorithm, _, secret)) = mas_password_schemes
         .iter()
         .find(|(version, _, _, _)| *version == MIGRATED_PASSWORD_VERSION)
@@ -215,11 +220,13 @@ pub async fn synapse_config_check_against_mas_config(
     Ok((warnings, errors))
 }
 
-/// Check that the Synapse database is sane for migration. Returns a list of warnings and errors.
+/// Check that the Synapse database is sane for migration. Returns a list of
+/// warnings and errors.
 ///
 /// # Errors
 ///
-/// - If there is some database connection error, or the given database is not a Synapse database.
+/// - If there is some database connection error, or the given database is not a
+///   Synapse database.
 /// - If the OAuth2 section of the MAS configuration could not be parsed.
 #[tracing::instrument(skip_all)]
 pub async fn synapse_database_check(