feat(cat-gateway): dynamic postgres config (#2281)

* feat(dynamic config): postgres

max conns
max idle
conn timeout
min idle

* refactor(env var settings and cleanup): event db

* refactor(env var settings and cleanup): event db

Author: cong-or

catalyst-gateway/bin/src/db/event/mod.rs

@@ -240,7 +240,8 @@ impl EventDB {
 /// The env var "`DATABASE_URL`" can be set directly as an anv var, or in a
 /// `.env` file.
 pub fn establish_connection() {
-    let (url, user, pass) = Settings::event_db_settings();
+    let (url, user, pass, max_connections, max_lifetime, min_idle, connection_timeout) =
+        Settings::event_db_settings();
 
     // This was pre-validated and can't fail, but provide default in the impossible case it
     // does.
@@ -257,7 +258,12 @@ pub fn establish_connection() {
 
     let pg_mgr = PostgresConnectionManager::new(config, tokio_postgres::NoTls);
 
-    let pool = Pool::builder().build_unchecked(pg_mgr);
+    let pool = Pool::builder()
+        .max_size(max_connections)
+        .max_lifetime(Some(core::time::Duration::from_secs(max_lifetime.into())))
+        .min_idle(min_idle)
+        .connection_timeout(core::time::Duration::from_secs(connection_timeout.into()))
+        .build_unchecked(pg_mgr);
 
     if EVENT_DB_POOL.set(Arc::new(pool)).is_err() {
         error!("Failed to set event db pool. Called Twice?");

catalyst-gateway/bin/src/settings/event_db.rs

@@ -0,0 +1,82 @@
+//! Command line and environment variable settings for the service
+
+use super::str_env_var::StringEnvVar;
+
+/// Sets the maximum number of connections managed by the pool.
+/// Defaults to 100.
+const EVENT_DB_MAX_CONNECTIONS: u32 = 100;
+
+/// Sets the maximum lifetime of connections in the pool.
+/// Defaults to 30 minutes.
+const EVENT_DB_MAX_LIFETIME: u32 = 30;
+
+/// Sets the minimum idle connection count maintained by the pool.
+/// Defaults to 0.
+const EVENT_DB_MIN_IDLE: u32 = 0;
+
+/// Sets the connection timeout used by the pool.
+/// Defaults to 300 seconds.
+const EVENT_DB_CONN_TIMEOUT: u32 = 300;
+
+/// Default Event DB URL.
+const EVENT_DB_URL_DEFAULT: &str =
+    "postgresql://postgres:postgres@localhost/catalyst_events?sslmode=disable";
+
+/// Configuration for event db.
+#[derive(Clone)]
+pub(crate) struct EnvVars {
+    /// The Address of the Event DB.
+    pub(crate) url: StringEnvVar,
+
+    /// The `UserName` to use for the Event DB.
+    pub(crate) username: Option<StringEnvVar>,
+
+    /// The Address of the Event DB.
+    pub(crate) password: Option<StringEnvVar>,
+
+    /// Sets the maximum number of connections managed by the pool.
+    /// Defaults to 10.
+    pub(crate) max_connections: u32,
+
+    /// Sets the maximum lifetime of connections in the pool.
+    /// Defaults to 30 minutes.
+    pub(crate) max_lifetime: u32,
+
+    /// Sets the minimum idle connection count maintained by the pool.
+    /// Defaults to None.
+    pub(crate) min_idle: u32,
+
+    /// Sets the connection timeout used by the pool.
+    /// Defaults to 30 seconds.
+    pub(crate) connection_timeout: u32,
+}
+
+impl EnvVars {
+    /// Create a config for event db.
+    pub(super) fn new() -> Self {
+        Self {
+            url: StringEnvVar::new("EVENT_DB_URL", EVENT_DB_URL_DEFAULT.into()),
+            username: StringEnvVar::new_optional("EVENT_DB_USERNAME", false),
+            password: StringEnvVar::new_optional("EVENT_DB_PASSWORD", true),
+            max_connections: StringEnvVar::new_as_int(
+                "EVENT_DB_MAX_CONNECTIONS",
+                EVENT_DB_MAX_CONNECTIONS,
+                0,
+                u32::MAX,
+            ),
+            max_lifetime: StringEnvVar::new_as_int(
+                "EVENT_DB_MAX_LIFETIME",
+                EVENT_DB_MAX_LIFETIME,
+                0,
+                u32::MAX,
+            ),
+            min_idle: StringEnvVar::new_as_int("EVENT_DB_MIN_IDLE", EVENT_DB_MIN_IDLE, 0, u32::MAX),
+            connection_timeout: StringEnvVar::new_as_int(
+                "EVENT_DB_CONN_TIMEOUT",
+                EVENT_DB_CONN_TIMEOUT,
+                0,
+                u32::MAX,
+            ),
+        }
+    }
+}

catalyst-gateway/bin/src/settings/mod.rs

@@ -23,6 +23,7 @@ use crate::{
 
 pub(crate) mod cassandra_db;
 pub(crate) mod chain_follower;
+pub(crate) mod event_db;
 pub(crate) mod signed_doc;
 mod str_env_var;
 
@@ -53,10 +54,6 @@ const METRICS_MEMORY_INTERVAL_DEFAULT: Duration = Duration::from_secs(1);
 /// Default `METRICS_FOLLOWER_INTERVAL`, 1 second.
 const METRICS_FOLLOWER_INTERVAL_DEFAULT: Duration = Duration::from_secs(1);
 
-/// Default Event DB URL.
-const EVENT_DB_URL_DEFAULT: &str =
-    "postgresql://postgres:postgres@localhost/catalyst_events?sslmode=disable";
-
 /// Default number of slots used as overlap when purging Live Index data.
 const PURGE_BACKWARD_SLOT_BUFFER_DEFAULT: u64 = 100;
 
@@ -119,15 +116,6 @@ struct EnvVars {
     /// The base path the API is served at.
     api_url_prefix: StringEnvVar,
 
-    /// The Address of the Event DB.
-    event_db_url: StringEnvVar,
-
-    /// The `UserName` to use for the Event DB.
-    event_db_username: Option<StringEnvVar>,
-
-    /// The Address of the Event DB.
-    event_db_password: Option<StringEnvVar>,
-
     /// The Config of the Persistent Cassandra DB.
     cassandra_persistent_db: cassandra_db::EnvVars,
 
@@ -137,6 +125,9 @@ struct EnvVars {
     /// The Chain Follower configuration
     chain_follower: chain_follower::EnvVars,
 
+    /// The event db configuration
+    event_db: event_db::EnvVars,
+
     /// The Catalyst Signed Documents configuration
     signed_doc: signed_doc::EnvVars,
 
@@ -203,9 +194,7 @@ static ENV_VARS: LazyLock<EnvVars> = LazyLock::new(|| {
         client_id_key: StringEnvVar::new("CLIENT_ID_KEY", CLIENT_ID_KEY_DEFAULT.into()),
         api_host_names: StringEnvVar::new_optional("API_HOST_NAMES", false),
         api_url_prefix: StringEnvVar::new("API_URL_PREFIX", API_URL_PREFIX_DEFAULT.into()),
-        event_db_url: StringEnvVar::new("EVENT_DB_URL", EVENT_DB_URL_DEFAULT.into()),
-        event_db_username: StringEnvVar::new_optional("EVENT_DB_USERNAME", false),
-        event_db_password: StringEnvVar::new_optional("EVENT_DB_PASSWORD", true),
+
         cassandra_persistent_db: cassandra_db::EnvVars::new(
             cassandra_db::PERSISTENT_URL_DEFAULT,
             cassandra_db::PERSISTENT_NAMESPACE_DEFAULT,
@@ -215,6 +204,7 @@ static ENV_VARS: LazyLock<EnvVars> = LazyLock::new(|| {
             cassandra_db::VOLATILE_NAMESPACE_DEFAULT,
         ),
         chain_follower: chain_follower::EnvVars::new(),
+        event_db: event_db::EnvVars::new(),
         signed_doc: signed_doc::EnvVars::new(),
         internal_api_key: StringEnvVar::new_optional("INTERNAL_API_KEY", true),
         check_config_tick: StringEnvVar::new_as_duration(
@@ -248,7 +238,7 @@ impl EnvVars {
     pub(crate) fn validate() -> anyhow::Result<()> {
         let mut status = Ok(());
 
-        let url = ENV_VARS.event_db_url.as_str();
+        let url = ENV_VARS.event_db.url.as_str();
         if let Err(error) = tokio_postgres::config::Config::from_str(url) {
             error!(error=%error, url=url, "Invalid Postgres DB URL.");
             status = Err(anyhow!("Environment Variable Validation Error."));
@@ -284,19 +274,44 @@ impl Settings {
     }
 
     /// Get the current Event DB settings for this service.
-    pub(crate) fn event_db_settings() -> (&'static str, Option<&'static str>, Option<&'static str>)
-    {
-        let url = ENV_VARS.event_db_url.as_str();
+    pub(crate) fn event_db_settings() -> (
+        &'static str,
+        Option<&'static str>,
+        Option<&'static str>,
+        u32,
+        u32,
+        u32,
+        u32,
+    ) {
+        let url = ENV_VARS.event_db.url.as_str();
         let user = ENV_VARS
-            .event_db_username
+            .event_db
+            .username
             .as_ref()
             .map(StringEnvVar::as_str);
         let pass = ENV_VARS
-            .event_db_password
+            .event_db
+            .password
             .as_ref()
             .map(StringEnvVar::as_str);
 
-        (url, user, pass)
+        let max_connections = ENV_VARS.event_db.max_connections;
+
+        let max_lifetime = ENV_VARS.event_db.max_lifetime;
+
+        let min_idle = ENV_VARS.event_db.min_idle;
+
+        let connection_timeout = ENV_VARS.event_db.connection_timeout;
+
+        (
+            url,
+            user,
+            pass,
+            max_connections,
+            max_lifetime,
+            min_idle,
+            connection_timeout,
+        )
     }
 
     /// Get the Persistent & Volatile Cassandra DB config for this service.

catalyst-gateway/blueprint.cue

@@ -87,6 +87,30 @@ project: {
 										key:  "url"
 									}
 								}
+								"EVENT_DB_MAX_CONNECTIONS_SIZE": {
+									secret: {
+										name: "db-max-connections"
+										key:  "max-connections"
+									}
+								}
+								"EVENT_DB_MAX_LIFETIME": {
+									secret: {
+										name: "db-max-lifetime"
+										key:  "max-lifetime"
+									}
+								}
+								"EVENT_DB_MIN_IDLE": {
+									secret: {
+										name: "db-min-idle"
+										key:  "min-idle"
+									}
+								}
+								"EVENT_DB_CONNECTION_TIMEOUT": {
+									secret: {
+										name: "db-connection-timeout"
+										key:  "connection-timeout"
+									}
+								}
 								"INTERNAL_API_KEY": {
 									secret: {
 										name: "gateway"