chore(config): remove use of once_cell (to match main)

abonander · abonander · commit 243d810f45b7 · 2025-06-30T16:18:46.000-07:00
diff --git a/sqlx-cli/src/lib.rs b/sqlx-cli/src/lib.rs
@@ -66,10 +66,10 @@ async fn do_run(opt: Opt) -> anyhow::Result<()> {
             } => {
                 let config = config.load_config().await?;
 
-                connect_opts.populate_db_url(config)?;
+                connect_opts.populate_db_url(&config)?;
 
                 migrate::run(
-                    config,
+                    &config,
                     &source,
                     &connect_opts,
                     dry_run,
@@ -88,10 +88,10 @@ async fn do_run(opt: Opt) -> anyhow::Result<()> {
             } => {
                 let config = config.load_config().await?;
 
-                connect_opts.populate_db_url(config)?;
+                connect_opts.populate_db_url(&config)?;
 
                 migrate::revert(
-                    config,
+                    &config,
                     &source,
                     &connect_opts,
                     dry_run,
@@ -107,9 +107,9 @@ async fn do_run(opt: Opt) -> anyhow::Result<()> {
             } => {
                 let config = config.load_config().await?;
 
-                connect_opts.populate_db_url(config)?;
+                connect_opts.populate_db_url(&config)?;
 
-                migrate::info(config, &source, &connect_opts).await?
+                migrate::info(&config, &source, &connect_opts).await?
             }
             MigrateCommand::BuildScript {
                 source,
@@ -118,7 +118,7 @@ async fn do_run(opt: Opt) -> anyhow::Result<()> {
             } => {
                 let config = config.load_config().await?;
 
-                migrate::build_script(config, &source, force)?
+                migrate::build_script(&config, &source, force)?
             }
         },
 
@@ -129,7 +129,7 @@ async fn do_run(opt: Opt) -> anyhow::Result<()> {
             } => {
                 let config = config.load_config().await?;
 
-                connect_opts.populate_db_url(config)?;
+                connect_opts.populate_db_url(&config)?;
                 database::create(&connect_opts).await?
             }
             DatabaseCommand::Drop {
@@ -140,7 +140,7 @@ async fn do_run(opt: Opt) -> anyhow::Result<()> {
             } => {
                 let config = config.load_config().await?;
 
-                connect_opts.populate_db_url(config)?;
+                connect_opts.populate_db_url(&config)?;
                 database::drop(&connect_opts, !confirmation.yes, force).await?
             }
             DatabaseCommand::Reset {
@@ -152,8 +152,8 @@ async fn do_run(opt: Opt) -> anyhow::Result<()> {
             } => {
                 let config = config.load_config().await?;
 
-                connect_opts.populate_db_url(config)?;
-                database::reset(config, &source, &connect_opts, !confirmation.yes, force).await?
+                connect_opts.populate_db_url(&config)?;
+                database::reset(&config, &source, &connect_opts, !confirmation.yes, force).await?
             }
             DatabaseCommand::Setup {
                 source,
@@ -162,8 +162,8 @@ async fn do_run(opt: Opt) -> anyhow::Result<()> {
             } => {
                 let config = config.load_config().await?;
 
-                connect_opts.populate_db_url(config)?;
-                database::setup(config, &source, &connect_opts).await?
+                connect_opts.populate_db_url(&config)?;
+                database::setup(&config, &source, &connect_opts).await?
             }
         },
 
@@ -176,7 +176,7 @@ async fn do_run(opt: Opt) -> anyhow::Result<()> {
             config,
         } => {
             let config = config.load_config().await?;
-            connect_opts.populate_db_url(config)?;
+            connect_opts.populate_db_url(&config)?;
             prepare::run(check, all, workspace, connect_opts, args).await?
         }
 
diff --git a/sqlx-cli/src/migrate.rs b/sqlx-cli/src/migrate.rs
@@ -14,15 +14,15 @@ use std::time::Duration;
 pub async fn add(opts: AddMigrationOpts) -> anyhow::Result<()> {
     let config = opts.config.load_config().await?;
 
-    let source = opts.source.resolve_path(config);
+    let source = opts.source.resolve_path(&config);
 
     fs::create_dir_all(source).context("Unable to create migrations directory")?;
 
-    let migrator = opts.source.resolve(config).await?;
+    let migrator = opts.source.resolve(&config).await?;
 
-    let version_prefix = opts.version_prefix(config, &migrator);
+    let version_prefix = opts.version_prefix(&config, &migrator);
 
-    if opts.reversible(config, &migrator) {
+    if opts.reversible(&config, &migrator) {
         create_file(
             source,
             &version_prefix,
diff --git a/sqlx-cli/src/opt.rs b/sqlx-cli/src/opt.rs
@@ -455,7 +455,7 @@ impl ConnectOpts {
 }
 
 impl ConfigOpt {
-    pub async fn load_config(&self) -> anyhow::Result<&'static Config> {
+    pub async fn load_config(&self) -> anyhow::Result<Config> {
         let path = self.config.clone();
 
         // Tokio does file I/O on a background task anyway
@@ -470,7 +470,7 @@ impl ConfigOpt {
                     eprintln!("Found `sqlx.toml` in current directory; reading...");
                     Ok(Config::try_from_path(path)?)
                 } else {
-                    Ok(Config::get_or_default())
+                    Ok(Config::default())
                 }
             }
         })
diff --git a/sqlx-core/src/config/mod.rs b/sqlx-core/src/config/mod.rs
@@ -16,10 +16,6 @@ use std::fmt::Debug;
 use std::io;
 use std::path::{Path, PathBuf};
 
-// `std::sync::OnceLock` doesn't have a stable `.get_or_try_init()`
-// because it's blocked on a stable `Try` trait.
-use once_cell::sync::OnceCell;
-
 /// Configuration shared by multiple components.
 ///
 /// See [`common::Config`] for details.
@@ -145,8 +141,6 @@ impl ConfigError {
     }
 }
 
-static CACHE: OnceCell<Config> = OnceCell::new();
-
 /// Internal methods for loading a `Config`.
 #[allow(clippy::result_large_err)]
 impl Config {
@@ -157,34 +151,13 @@ impl Config {
     /// Errors if `CARGO_MANIFEST_DIR` is not set, or if the config file could not be read.
     ///
     /// If the file does not exist, the cache is populated with `Config::default()`.
-    pub fn try_from_crate_or_default() -> Result<&'static Self, ConfigError> {
-        CACHE.get_or_try_init(|| {
-            Self::read_from(get_crate_path()?).or_else(|e| {
-                if let ConfigError::NotFound { .. } = e {
-                    Ok(Config::default())
-                } else {
-                    Err(e)
-                }
-            })
-        })
-    }
-
-    /// Get the cached config, or read `$CARGO_MANIFEST_DIR/sqlx.toml`.
-    ///
-    /// On success, the config is cached in a `static` and returned by future calls.
-    ///
-    /// Errors if `CARGO_MANIFEST_DIR` is not set, or if the config file could not be read.
-    ///
-    /// If the file does not exist, the cache is populated with `Config::default()`.
-    pub fn try_from_crate_or_default() -> Result<&'static Self, ConfigError> {
-        CACHE.get_or_try_init(|| {
-            Self::read_from(get_crate_path()?).or_else(|e| {
-                if let ConfigError::NotFound { .. } = e {
-                    Ok(Config::default())
-                } else {
-                    Err(e)
-                }
-            })
+    pub fn try_from_crate_or_default() -> Result<Self, ConfigError> {
+        Self::read_from(get_crate_path()?).or_else(|e| {
+            if let ConfigError::NotFound { .. } = e {
+                Ok(Config::default())
+            } else {
+                Err(e)
+            }
         })
     }
 
@@ -193,13 +166,8 @@ impl Config {
     /// On success, the config is cached in a `static` and returned by future calls.
     ///
     /// Errors if the config file does not exist, or could not be read.
-    pub fn try_from_path(path: PathBuf) -> Result<&'static Self, ConfigError> {
-        CACHE.get_or_try_init(|| Self::read_from(path))
-    }
-
-    /// Get the cached config, or return the default.
-    pub fn get_or_default() -> &'static Self {
-        CACHE.get_or_init(Config::default)
+    pub fn try_from_path(path: PathBuf) -> Result<Self, ConfigError> {
+        Self::read_from(path)
     }
 
     #[cfg(feature = "sqlx-toml")]
@@ -225,8 +193,8 @@ impl Config {
     #[cfg(not(feature = "sqlx-toml"))]
     fn read_from(path: PathBuf) -> Result<Self, ConfigError> {
         match path.try_exists() {
-            Ok(true) => Err(ConfigError::ParseDisabled { path: path.into() }),
-            Ok(false) => Err(ConfigError::NotFound { path: path.into() }),
+            Ok(true) => Err(ConfigError::ParseDisabled { path }),
+            Ok(false) => Err(ConfigError::NotFound { path }),
             Err(e) => Err(ConfigError::from_io(path, e)),
         }
     }
diff --git a/sqlx-macros-core/src/migrate.rs b/sqlx-macros-core/src/migrate.rs
@@ -96,10 +96,10 @@ pub fn expand(path_arg: Option<LitStr>) -> crate::Result<TokenStream> {
 
     let path = match path_arg {
         Some(path_arg) => crate::common::resolve_path(path_arg.value(), path_arg.span())?,
-        None => { crate::common::resolve_path(default_path(config), Span::call_site()) }?,
+        None => { crate::common::resolve_path(default_path(&config), Span::call_site()) }?,
     };
 
-    expand_with_path(config, &path)
+    expand_with_path(&config, &path)
 }
 
 pub fn expand_with_path(config: &Config, path: &Path) -> crate::Result<TokenStream> {
diff --git a/sqlx-macros-core/src/query/mod.rs b/sqlx-macros-core/src/query/mod.rs
@@ -27,7 +27,7 @@ mod output;
 pub struct QueryDriver {
     db_name: &'static str,
     url_schemes: &'static [&'static str],
-    expand: fn(QueryMacroInput, QueryDataSource) -> crate::Result<TokenStream>,
+    expand: fn(&Config, QueryMacroInput, QueryDataSource) -> crate::Result<TokenStream>,
 }
 
 impl QueryDriver {
@@ -75,6 +75,7 @@ struct Metadata {
     offline: bool,
     database_url: Option<String>,
     offline_dir: Option<String>,
+    config: Config,
     workspace_root: Arc<Mutex<Option<PathBuf>>>,
 }
 
@@ -123,17 +124,16 @@ fn init_metadata(manifest_dir: &String) -> crate::Result<Metadata> {
         .map(|s| s.eq_ignore_ascii_case("true") || s == "1")
         .unwrap_or(false);
 
-    let var_name = Config::try_from_crate_or_default()?
-        .common
-        .database_url_var();
+    let config = Config::try_from_crate_or_default()?;
 
-    let database_url = env(var_name).ok().or(database_url);
+    let database_url = env(config.common.database_url_var()).ok().or(database_url);
 
     Ok(Metadata {
         manifest_dir,
         offline,
         database_url,
         offline_dir,
+        config,
         workspace_root: Arc::new(Mutex::new(None)),
     })
 }
@@ -197,7 +197,7 @@ pub fn expand_input<'a>(
 
     for driver in drivers {
         if data_source.matches_driver(driver) {
-            return (driver.expand)(input, data_source);
+            return (driver.expand)(&metadata.config, input, data_source);
         }
     }
 
@@ -219,6 +219,7 @@ pub fn expand_input<'a>(
 }
 
 fn expand_with<DB: DatabaseExt>(
+    config: &Config,
     input: QueryMacroInput,
     data_source: QueryDataSource,
 ) -> crate::Result<TokenStream>
@@ -233,7 +234,7 @@ where
         }
     };
 
-    expand_with_data(input, query_data, offline)
+    expand_with_data(config, input, query_data, offline)
 }
 
 // marker trait for `Describe` that lets us conditionally require it to be `Serialize + Deserialize`
@@ -251,15 +252,14 @@ struct Warnings {
 }
 
 fn expand_with_data<DB: DatabaseExt>(
+    config: &Config,
     input: QueryMacroInput,
     data: QueryData<DB>,
     offline: bool,
 ) -> crate::Result<TokenStream>
 where
     Describe<DB>: DescribeExt,
 {
-    let config = Config::try_from_crate_or_default()?;
-
     // validate at the minimum that our args match the query's input parameters
     let num_parameters = match data.describe.parameters() {
         Some(Either::Left(params)) => Some(params.len()),
diff --git a/sqlx-macros-core/src/test_attr.rs b/sqlx-macros-core/src/test_attr.rs
@@ -149,12 +149,12 @@ fn expand_advanced(args: AttributeArgs, input: syn::ItemFn) -> crate::Result<Tok
             quote! { args.migrator(&#migrator); }
         }
         MigrationsOpt::InferredPath if !inputs.is_empty() => {
-            let path = crate::migrate::default_path(config);
+            let path = crate::migrate::default_path(&config);
 
             let resolved_path = crate::common::resolve_path(path, proc_macro2::Span::call_site())?;
 
             if resolved_path.is_dir() {
-                let migrator = crate::migrate::expand_with_path(config, &resolved_path)?;
+                let migrator = crate::migrate::expand_with_path(&config, &resolved_path)?;
                 quote! { args.migrator(&#migrator); }
             } else {
                 quote! {}

Original file line number	Diff line number	Diff line change
`@@ -455,7 +455,7 @@ impl ConnectOpts {`
`455`	`455`	`}`
`456`	`456`
`457`	`457`	`impl ConfigOpt {`
`458`		`- pub async fn load_config(&self) -> anyhow::Result<&'static Config> {`
	`458`	`+ pub async fn load_config(&self) -> anyhow::Result<Config> {`
`459`	`459`	`let path = self.config.clone();`
`460`	`460`
`461`	`461`	`// Tokio does file I/O on a background task anyway`
`@@ -470,7 +470,7 @@ impl ConfigOpt {`
`470`	`470`	eprintln!("Found `sqlx.toml` in current directory; reading...");
`471`	`471`	`Ok(Config::try_from_path(path)?)`
`472`	`472`	`} else {`
`473`		`- Ok(Config::get_or_default())`
	`473`	`+ Ok(Config::default())`
`474`	`474`	`}`
`475`	`475`	`}`
`476`	`476`	`})`