fix: do not attempt db connection if jsonc section is missing (#375)

* fix: do not attempt db connection if jsonc section is missing

* comment

* comment

* whoopsndoopsn

* whoopsndoopsn2

* whoopsndoopsn 3

* ok

* ok

* just readied

* Update postgrestools.jsonc

* ok

* finally

Author: juleswritescode

crates/pgt_cli/src/cli_options.rs

@@ -18,10 +18,6 @@ pub struct CliOptions {
     #[bpaf(long("use-server"), switch, fallback(false))]
     pub use_server: bool,
 
-    /// Skip connecting to the database and only run checks that don't require a database connection.
-    #[bpaf(long("skip-db"), switch, fallback(false))]
-    pub skip_db: bool,
-
     /// Print additional diagnostics, and some diagnostics show more information. Also, print out what files were processed and which ones were modified.
     #[bpaf(long("verbose"), switch, fallback(false))]
     pub verbose: bool,

crates/pgt_cli/src/commands/mod.rs

@@ -307,7 +307,6 @@ pub(crate) trait CommandRunner: Sized {
             configuration,
             vcs_base_path,
             gitignore_matches,
-            skip_db: cli_options.skip_db,
         })?;
 
         let execution = self.get_execution(cli_options, console, workspace)?;

crates/pgt_configuration/src/database.rs

@@ -10,6 +10,8 @@ use serde::{Deserialize, Serialize};
 #[partial(serde(rename_all = "camelCase", default, deny_unknown_fields))]
 pub struct DatabaseConfiguration {
     /// The host of the database.
+    /// Required if you want database-related features.
+    /// All else falls back to sensible defaults.
     #[partial(bpaf(long("host")))]
     pub host: String,
 
@@ -35,11 +37,17 @@ pub struct DatabaseConfiguration {
     /// The connection timeout in seconds.
     #[partial(bpaf(long("conn_timeout_secs"), fallback(Some(10)), debug_fallback))]
     pub conn_timeout_secs: u16,
+
+    /// Actively disable all database-related features.
+    #[partial(bpaf(long("disable-db"), switch, fallback(Some(false))))]
+    #[partial(cfg_attr(feature = "schema", schemars(skip)))]
+    pub disable_connection: bool,
 }
 
 impl Default for DatabaseConfiguration {
     fn default() -> Self {
         Self {
+            disable_connection: false,
             host: "127.0.0.1".to_string(),
             port: 5432,
             username: "postgres".to_string(),

crates/pgt_configuration/src/lib.rs

@@ -110,8 +110,9 @@ impl PartialConfiguration {
                 username: Some("postgres".to_string()),
                 password: Some("postgres".to_string()),
                 database: Some("postgres".to_string()),
-                conn_timeout_secs: Some(10),
                 allow_statement_executions_against: Default::default(),
+                conn_timeout_secs: Some(10),
+                disable_connection: Some(false),
             }),
         }
     }

crates/pgt_lsp/src/session.rs

@@ -449,7 +449,6 @@ impl Session {
                             configuration: fs_configuration,
                             vcs_base_path,
                             gitignore_matches,
-                            skip_db: false,
                         });
 
                         if let Err(error) = result {

crates/pgt_lsp/tests/server.rs

@@ -773,14 +773,15 @@ async fn test_execute_statement() -> Result<()> {
         .to_string();
     let host = test_db.connect_options().get_host().to_string();
 
-    let conf = PartialConfiguration {
+    let mut conf = PartialConfiguration::init();
+    conf.merge_with(PartialConfiguration {
         db: Some(PartialDatabaseConfiguration {
             database: Some(database),
             host: Some(host),
             ..Default::default()
         }),
         ..Default::default()
-    };
+    });
 
     fs.insert(
         url!("postgrestools.jsonc").to_file_path().unwrap(),

crates/pgt_workspace/src/settings.rs

@@ -268,6 +268,7 @@ impl Default for LinterSettings {
 /// Database settings for the entire workspace
 #[derive(Debug)]
 pub struct DatabaseSettings {
+    pub enable_connection: bool,
     pub host: String,
     pub port: u16,
     pub username: String,
@@ -280,6 +281,7 @@ pub struct DatabaseSettings {
 impl Default for DatabaseSettings {
     fn default() -> Self {
         Self {
+            enable_connection: false,
             host: "127.0.0.1".to_string(),
             port: 5432,
             username: "postgres".to_string(),
@@ -295,6 +297,13 @@ impl From<PartialDatabaseConfiguration> for DatabaseSettings {
     fn from(value: PartialDatabaseConfiguration) -> Self {
         let d = DatabaseSettings::default();
 
+        // "host" is the minimum required setting for database features
+        // to be enabled.
+        let enable_connection = value
+            .host
+            .as_ref()
+            .is_some_and(|_| value.disable_connection.is_none_or(|disabled| !disabled));
+
         let database = value.database.unwrap_or(d.database);
         let host = value.host.unwrap_or(d.host);
 
@@ -312,6 +321,8 @@ impl From<PartialDatabaseConfiguration> for DatabaseSettings {
             .unwrap_or(false);
 
         Self {
+            enable_connection,
+
             port: value.port.unwrap_or(d.port),
             username: value.username.unwrap_or(d.username),
             password: value.password.unwrap_or(d.password),

crates/pgt_workspace/src/workspace.rs

@@ -73,7 +73,6 @@ pub struct UpdateSettingsParams {
     pub vcs_base_path: Option<PathBuf>,
     pub gitignore_matches: Vec<String>,
     pub workspace_directory: Option<PathBuf>,
-    pub skip_db: bool,
 }
 
 #[derive(Debug, serde::Serialize, serde::Deserialize)]

crates/pgt_workspace/src/workspace/server.rs

@@ -168,12 +168,10 @@ impl Workspace for WorkspaceServer {
 
         tracing::info!("Updated settings in workspace");
 
-        if !params.skip_db {
-            self.connection
-                .write()
-                .unwrap()
-                .set_conn_settings(&self.settings().as_ref().db);
-        }
+        self.connection
+            .write()
+            .unwrap()
+            .set_conn_settings(&self.settings().as_ref().db);
 
         tracing::info!("Updated Db connection settings");
 

crates/pgt_workspace/src/workspace/server/db_connection.rs

@@ -16,6 +16,11 @@ impl DbConnection {
     }
 
     pub(crate) fn set_conn_settings(&mut self, settings: &DatabaseSettings) {
+        if !settings.enable_connection {
+            tracing::info!("Database connection disabled.");
+            return;
+        }
+
         let config = PgConnectOptions::new()
             .host(&settings.host)
             .port(settings.port)