Merge pull request #9118 from RinChanNOWWW/global-config

chore: make inner `Config` in crate `databend-query` as a global singeleton.

Author: mergify[bot]

Cargo.lock

@@ -124,7 +124,7 @@ async fn main_entrypoint() -> Result<()> {
         let hostname = conf.query.clickhouse_http_handler_host.clone();
         let listening = format!("{}:{}", hostname, conf.query.clickhouse_http_handler_port);
 
-        let mut srv = HttpHandler::create(HttpHandlerKind::Clickhouse, conf.clone())?;
+        let mut srv = HttpHandler::create(HttpHandlerKind::Clickhouse)?;
         let listening = srv.start(listening.parse()?).await?;
         shutdown_handle.add_service(srv);
 
@@ -140,7 +140,7 @@ async fn main_entrypoint() -> Result<()> {
         let hostname = conf.query.http_handler_host.clone();
         let listening = format!("{}:{}", hostname, conf.query.http_handler_port);
 
-        let mut srv = HttpHandler::create(HttpHandlerKind::Query, conf.clone())?;
+        let mut srv = HttpHandler::create(HttpHandlerKind::Query)?;
         let listening = srv.start(listening.parse()?).await?;
         shutdown_handle.add_service(srv);
 

src/binaries/query/main.rs

@@ -10,7 +10,6 @@ test = false
 
 [dependencies]
 common-base = { path = "../../common/base" }
-common-config = { path = "../config" }
 common-datablocks = { path = "../datablocks" }
 common-datavalues = { path = "../datavalues" }
 common-exception = { path = "../../common/exception" }

src/query/catalog/Cargo.toml

@@ -19,7 +19,6 @@ use std::time::SystemTime;
 
 use common_base::base::Progress;
 use common_base::base::ProgressValues;
-use common_config::Config;
 use common_datablocks::DataBlock;
 use common_exception::Result;
 use common_functions::scalars::FunctionContext;
@@ -77,7 +76,6 @@ pub trait TableContext: Send + Sync {
     fn get_current_catalog(&self) -> String;
     fn get_aborting(&self) -> Arc<AtomicBool>;
     fn get_current_database(&self) -> String;
-    fn get_config(&self) -> Config;
     fn get_current_user(&self) -> Result<UserInfo>;
     fn get_current_role(&self) -> Option<RoleInfo>;
     fn get_fuse_version(&self) -> String;

src/query/catalog/src/table_context.rs

@@ -0,0 +1,40 @@
+// Copyright 2022 Datafuse Labs.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+use std::sync::Arc;
+
+use common_base::base::Singleton;
+use common_exception::Result;
+use once_cell::sync::OnceCell;
+
+use crate::Config;
+
+pub struct GlobalConfig;
+
+static GLOBAL_CONFIG: OnceCell<Singleton<Arc<Config>>> = OnceCell::new();
+
+impl GlobalConfig {
+    pub fn init(config: Config, v: Singleton<Arc<Config>>) -> Result<()> {
+        v.init(Arc::new(config))?;
+        GLOBAL_CONFIG.set(v).ok();
+        Ok(())
+    }
+
+    pub fn instance() -> Arc<Config> {
+        match GLOBAL_CONFIG.get() {
+            None => panic!("GlobalConfig is not init"),
+            Some(config) => config.get(),
+        }
+    }
+}

src/query/config/src/global.rs

@@ -18,15 +18,18 @@
 ///
 /// - [`inner::Config`] which will be exposed as [`crate::Config`] will be used in all business logic.
 /// - [`outer_v0::Config`] is the outer config for [`inner::Config`] which will be exposed to end-users.
+/// - [`global::GlobalConfig`] is a global config singleton of [`crate::Config`].
 ///
 /// It's safe to refactor [`inner::Config`] in anyway, as long as it satisfied the following traits
 ///
 /// - `TryInto<inner::Config> for outer_v0::Config`
 /// - `From<inner::Config> for outer_v0::Config`
+mod global;
 mod inner;
 mod outer_v0;
 mod version;
 
+pub use global::GlobalConfig;
 pub use inner::CatalogConfig;
 pub use inner::CatalogHiveConfig;
 pub use inner::Config;

src/query/config/src/lib.rs

@@ -0,0 +1,71 @@
+// Copyright 2022 Datafuse Labs.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+use std::cell::UnsafeCell;
+use std::sync::Arc;
+
+use common_base::base::SingletonImpl;
+use common_config::Config;
+use common_config::GlobalConfig;
+use common_exception::Result;
+use once_cell::sync::OnceCell;
+
+struct ConfigSingleton {
+    config: UnsafeCell<Option<Arc<Config>>>,
+}
+
+unsafe impl Send for ConfigSingleton {}
+
+unsafe impl Sync for ConfigSingleton {}
+
+static GLOBAL: OnceCell<Arc<ConfigSingleton>> = OnceCell::new();
+
+impl SingletonImpl<Arc<Config>> for ConfigSingleton {
+    fn get(&self) -> Arc<Config> {
+        unsafe {
+            match &*self.config.get() {
+                None => panic!("GlobalConfig is not init"),
+                Some(config) => config.clone(),
+            }
+        }
+    }
+
+    fn init(&self, value: Arc<Config>) -> Result<()> {
+        unsafe {
+            *(self.config.get() as *mut Option<Arc<Config>>) = Some(value);
+            Ok(())
+        }
+    }
+}
+
+#[test]
+fn test_global_config() -> Result<()> {
+    let config_singleton = GLOBAL.get_or_init(|| {
+        Arc::new(ConfigSingleton {
+            config: UnsafeCell::new(None),
+        })
+    });
+
+    let mut config = Config::default();
+
+    GlobalConfig::init(config.clone(), config_singleton.clone())?;
+    assert_eq!(GlobalConfig::instance().as_ref(), &config);
+
+    config.cmd = "test".to_string();
+
+    GlobalConfig::init(config.clone(), config_singleton.clone())?;
+    assert_eq!(GlobalConfig::instance().as_ref(), &config);
+
+    Ok(())
+}

src/query/config/tests/it/global.rs

@@ -0,0 +1,15 @@
+// Copyright 2022 Datafuse Labs.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+mod global;

src/query/config/tests/it/main.rs

@@ -12,12 +12,11 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
+use common_config::GlobalConfig;
 use poem::web::Json;
 use poem::IntoResponse;
 
-use crate::sessions::SessionManager;
-
 #[poem::handler]
 pub async fn config_handler() -> poem::Result<impl IntoResponse> {
-    Ok(Json(SessionManager::instance().get_conf().into_outer()))
+    Ok(Json(GlobalConfig::instance().as_ref().clone().into_outer()))
 }

src/query/service/src/api/http/v1/config.rs

@@ -16,15 +16,14 @@ use chrono::DateTime;
 use chrono::Utc;
 use common_catalog::catalog::CatalogManager;
 use common_catalog::catalog_kind::CATALOG_DEFAULT;
+use common_config::GlobalConfig;
 use common_exception::Result;
 use poem::web::Json;
 use poem::web::Path;
 use poem::IntoResponse;
 use serde::Deserialize;
 use serde::Serialize;
 
-use crate::sessions::SessionManager;
-
 #[derive(Serialize, Deserialize, Eq, PartialEq, Debug, Default)]
 pub struct TenantTablesResponse {
     pub tables: Vec<TenantTableInfo>,
@@ -82,8 +81,7 @@ pub async fn list_tenant_tables_handler(
 // This handler returns the statistics about the tables of the current tenant.
 #[poem::handler]
 pub async fn list_tables_handler() -> poem::Result<impl IntoResponse> {
-    let session_mgr = SessionManager::instance();
-    let tenant = &session_mgr.get_conf().query.tenant_id;
+    let tenant = &GlobalConfig::instance().query.tenant_id;
     if tenant.is_empty() {
         return Ok(Json(TenantTablesResponse { tables: vec![] }));
     }