refactor(tenant): use tenant id type (#6643)

Co-authored-by: hyperswitch-bot[bot] <148525504+hyperswitch-bot[bot]@users.noreply.github.com>

crates/common_utils/src/id_type.rs

@@ -12,6 +12,7 @@ mod payment;
 mod profile;
 mod refunds;
 mod routing;
+mod tenant;
 
 #[cfg(feature = "v2")]
 mod global_id;
@@ -40,6 +41,7 @@ pub use profile::ProfileId;
 pub use refunds::RefundReferenceId;
 pub use routing::RoutingId;
 use serde::{Deserialize, Serialize};
+pub use tenant::TenantId;
 use thiserror::Error;
 
 use crate::{fp_utils::when, generate_id_with_default_len};

crates/common_utils/src/id_type/organization.rs

@@ -18,7 +18,7 @@ crate::impl_to_sql_from_sql_id_type!(OrganizationId);
 
 impl OrganizationId {
     /// Get an organization id from String
-    pub fn wrap(org_id: String) -> CustomResult<Self, ValidationError> {
+    pub fn try_from_string(org_id: String) -> CustomResult<Self, ValidationError> {
         Self::try_from(std::borrow::Cow::from(org_id))
     }
 }

crates/common_utils/src/id_type/tenant.rs

@@ -0,0 +1,22 @@
+use crate::errors::{CustomResult, ValidationError};
+
+crate::id_type!(
+    TenantId,
+    "A type for tenant_id that can be used for unique identifier for a tenant"
+);
+crate::impl_id_type_methods!(TenantId, "tenant_id");
+
+// This is to display the `TenantId` as TenantId(abcd)
+crate::impl_debug_id_type!(TenantId);
+crate::impl_try_from_cow_str_id_type!(TenantId, "tenant_id");
+
+crate::impl_serializable_secret_id_type!(TenantId);
+crate::impl_queryable_id_type!(TenantId);
+crate::impl_to_sql_from_sql_id_type!(TenantId);
+
+impl TenantId {
+    /// Get tenant id from String
+    pub fn try_from_string(tenant_id: String) -> CustomResult<Self, ValidationError> {
+        Self::try_from(std::borrow::Cow::from(tenant_id))
+    }
+}

crates/common_utils/src/types/theme.rs

@@ -12,24 +12,24 @@ pub enum ThemeLineage {
     // },
     /// Org lineage variant
     Organization {
-        /// tenant_id: String
-        tenant_id: String,
+        /// tenant_id: TenantId
+        tenant_id: id_type::TenantId,
         /// org_id: OrganizationId
         org_id: id_type::OrganizationId,
     },
     /// Merchant lineage variant
     Merchant {
-        /// tenant_id: String
-        tenant_id: String,
+        /// tenant_id: TenantId
+        tenant_id: id_type::TenantId,
         /// org_id: OrganizationId
         org_id: id_type::OrganizationId,
         /// merchant_id: MerchantId
         merchant_id: id_type::MerchantId,
     },
     /// Profile lineage variant
     Profile {
-        /// tenant_id: String
-        tenant_id: String,
+        /// tenant_id: TenantId
+        tenant_id: id_type::TenantId,
         /// org_id: OrganizationId
         org_id: id_type::OrganizationId,
         /// merchant_id: MerchantId

crates/diesel_models/src/user/theme.rs

@@ -9,7 +9,7 @@ use crate::schema::themes;
 #[diesel(table_name = themes, primary_key(theme_id), check_for_backend(diesel::pg::Pg))]
 pub struct Theme {
     pub theme_id: String,
-    pub tenant_id: String,
+    pub tenant_id: id_type::TenantId,
     pub org_id: Option<id_type::OrganizationId>,
     pub merchant_id: Option<id_type::MerchantId>,
     pub profile_id: Option<id_type::ProfileId>,
@@ -23,7 +23,7 @@ pub struct Theme {
 #[diesel(table_name = themes)]
 pub struct ThemeNew {
     pub theme_id: String,
-    pub tenant_id: String,
+    pub tenant_id: id_type::TenantId,
     pub org_id: Option<id_type::OrganizationId>,
     pub merchant_id: Option<id_type::MerchantId>,
     pub profile_id: Option<id_type::ProfileId>,

crates/diesel_models/src/user_role.rs

@@ -24,7 +24,7 @@ pub struct UserRole {
     pub entity_id: Option<String>,
     pub entity_type: Option<EntityType>,
     pub version: enums::UserRoleVersion,
-    pub tenant_id: String,
+    pub tenant_id: id_type::TenantId,
 }
 
 impl UserRole {
@@ -88,7 +88,7 @@ pub struct UserRoleNew {
     pub entity_id: Option<String>,
     pub entity_type: Option<EntityType>,
     pub version: enums::UserRoleVersion,
-    pub tenant_id: String,
+    pub tenant_id: id_type::TenantId,
 }
 
 #[derive(Clone, Debug, AsChangeset, router_derive::DebugAsDisplay)]

crates/drainer/src/handler.rs

@@ -3,6 +3,7 @@ use std::{
     sync::{atomic, Arc},
 };
 
+use common_utils::id_type;
 use router_env::tracing::Instrument;
 use tokio::{
     sync::{mpsc, oneshot},
@@ -34,12 +35,15 @@ pub struct HandlerInner {
     loop_interval: Duration,
     active_tasks: Arc<atomic::AtomicU64>,
     conf: DrainerSettings,
-    stores: HashMap<String, Arc<Store>>,
+    stores: HashMap<id_type::TenantId, Arc<Store>>,
     running: Arc<atomic::AtomicBool>,
 }
 
 impl Handler {
-    pub fn from_conf(conf: DrainerSettings, stores: HashMap<String, Arc<Store>>) -> Self {
+    pub fn from_conf(
+        conf: DrainerSettings,
+        stores: HashMap<id_type::TenantId, Arc<Store>>,
+    ) -> Self {
         let shutdown_interval = Duration::from_millis(conf.shutdown_interval.into());
         let loop_interval = Duration::from_millis(conf.loop_interval.into());
 

crates/drainer/src/health_check.rs

@@ -2,7 +2,7 @@ use std::{collections::HashMap, sync::Arc};
 
 use actix_web::{web, Scope};
 use async_bb8_diesel::{AsyncConnection, AsyncRunQueryDsl};
-use common_utils::errors::CustomResult;
+use common_utils::{errors::CustomResult, id_type};
 use diesel_models::{Config, ConfigNew};
 use error_stack::ResultExt;
 use router_env::{instrument, logger, tracing};
@@ -20,7 +20,7 @@ pub const TEST_STREAM_DATA: &[(&str, &str)] = &[("data", "sample_data")];
 pub struct Health;
 
 impl Health {
-    pub fn server(conf: Settings, stores: HashMap<String, Arc<Store>>) -> Scope {
+    pub fn server(conf: Settings, stores: HashMap<id_type::TenantId, Arc<Store>>) -> Scope {
         web::scope("health")
             .app_data(web::Data::new(conf))
             .app_data(web::Data::new(stores))

crates/drainer/src/lib.rs

@@ -14,7 +14,7 @@ use std::{collections::HashMap, sync::Arc};
 mod secrets_transformers;
 
 use actix_web::dev::Server;
-use common_utils::signals::get_allowed_signals;
+use common_utils::{id_type, signals::get_allowed_signals};
 use diesel_models::kv;
 use error_stack::ResultExt;
 use hyperswitch_interfaces::secrets_interface::secret_state::RawSecret;
@@ -31,7 +31,7 @@ use crate::{
 };
 
 pub async fn start_drainer(
-    stores: HashMap<String, Arc<Store>>,
+    stores: HashMap<id_type::TenantId, Arc<Store>>,
     conf: DrainerSettings,
 ) -> errors::DrainerResult<()> {
     let drainer_handler = handler::Handler::from_conf(conf, stores);
@@ -62,7 +62,7 @@ pub async fn start_drainer(
 
 pub async fn start_web_server(
     conf: Settings,
-    stores: HashMap<String, Arc<Store>>,
+    stores: HashMap<id_type::TenantId, Arc<Store>>,
 ) -> Result<Server, errors::DrainerError> {
     let server = conf.server.clone();
     let web_server = actix_web::HttpServer::new(move || {

crates/drainer/src/settings.rs

@@ -1,6 +1,6 @@
 use std::{collections::HashMap, path::PathBuf, sync::Arc};
 
-use common_utils::{ext_traits::ConfigExt, DbConnectionParams};
+use common_utils::{ext_traits::ConfigExt, id_type, DbConnectionParams};
 use config::{Environment, File};
 use external_services::managers::{
     encryption_management::EncryptionManagementConfig, secrets_management::SecretsManagementConfig,
@@ -122,23 +122,23 @@ pub struct Multitenancy {
     pub tenants: TenantConfig,
 }
 impl Multitenancy {
-    pub fn get_tenants(&self) -> &HashMap<String, Tenant> {
+    pub fn get_tenants(&self) -> &HashMap<id_type::TenantId, Tenant> {
         &self.tenants.0
     }
-    pub fn get_tenant_ids(&self) -> Vec<String> {
+    pub fn get_tenant_ids(&self) -> Vec<id_type::TenantId> {
         self.tenants
             .0
             .values()
             .map(|tenant| tenant.tenant_id.clone())
             .collect()
     }
-    pub fn get_tenant(&self, tenant_id: &str) -> Option<&Tenant> {
+    pub fn get_tenant(&self, tenant_id: &id_type::TenantId) -> Option<&Tenant> {
         self.tenants.0.get(tenant_id)
     }
 }
 
 #[derive(Debug, Clone, Default)]
-pub struct TenantConfig(pub HashMap<String, Tenant>);
+pub struct TenantConfig(pub HashMap<id_type::TenantId, Tenant>);
 
 impl<'de> Deserialize<'de> for TenantConfig {
     fn deserialize<D: serde::Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error> {
@@ -150,7 +150,7 @@ impl<'de> Deserialize<'de> for TenantConfig {
             clickhouse_database: String,
         }
 
-        let hashmap = <HashMap<String, Inner>>::deserialize(deserializer)?;
+        let hashmap = <HashMap<id_type::TenantId, Inner>>::deserialize(deserializer)?;
 
         Ok(Self(
             hashmap
@@ -172,9 +172,9 @@ impl<'de> Deserialize<'de> for TenantConfig {
     }
 }
 
-#[derive(Debug, Deserialize, Clone, Default)]
+#[derive(Debug, Deserialize, Clone)]
 pub struct Tenant {
-    pub tenant_id: String,
+    pub tenant_id: id_type::TenantId,
     pub base_url: String,
     pub schema: String,
     pub redis_key_prefix: String,

crates/router/src/configs/settings.rs

@@ -6,7 +6,7 @@ use std::{
 #[cfg(feature = "olap")]
 use analytics::{opensearch::OpenSearchConfig, ReportConfig};
 use api_models::{enums, payment_methods::RequiredFieldInfo};
-use common_utils::ext_traits::ConfigExt;
+use common_utils::{ext_traits::ConfigExt, id_type};
 use config::{Environment, File};
 use error_stack::ResultExt;
 #[cfg(feature = "email")]
@@ -138,17 +138,17 @@ pub struct Multitenancy {
 }
 
 impl Multitenancy {
-    pub fn get_tenants(&self) -> &HashMap<String, Tenant> {
+    pub fn get_tenants(&self) -> &HashMap<id_type::TenantId, Tenant> {
         &self.tenants.0
     }
-    pub fn get_tenant_ids(&self) -> Vec<String> {
+    pub fn get_tenant_ids(&self) -> Vec<id_type::TenantId> {
         self.tenants
             .0
             .values()
             .map(|tenant| tenant.tenant_id.clone())
             .collect()
     }
-    pub fn get_tenant(&self, tenant_id: &str) -> Option<&Tenant> {
+    pub fn get_tenant(&self, tenant_id: &id_type::TenantId) -> Option<&Tenant> {
         self.tenants.0.get(tenant_id)
     }
 }
@@ -159,11 +159,11 @@ pub struct DecisionConfig {
 }
 
 #[derive(Debug, Clone, Default)]
-pub struct TenantConfig(pub HashMap<String, Tenant>);
+pub struct TenantConfig(pub HashMap<id_type::TenantId, Tenant>);
 
-#[derive(Debug, Clone, Default)]
+#[derive(Debug, Clone)]
 pub struct Tenant {
-    pub tenant_id: String,
+    pub tenant_id: id_type::TenantId,
     pub base_url: String,
     pub schema: String,
     pub redis_key_prefix: String,
@@ -743,8 +743,7 @@ pub struct LockerBasedRecipientConnectorList {
 
 #[derive(Debug, Deserialize, Clone, Default)]
 pub struct ConnectorRequestReferenceIdConfig {
-    pub merchant_ids_send_payment_id_as_connector_request_id:
-        HashSet<common_utils::id_type::MerchantId>,
+    pub merchant_ids_send_payment_id_as_connector_request_id: HashSet<id_type::MerchantId>,
 }
 
 #[derive(Debug, Deserialize, Clone, Default)]
@@ -970,7 +969,7 @@ pub struct ServerTls {
 #[cfg(feature = "v2")]
 #[derive(Debug, Clone, Deserialize, PartialEq, Eq)]
 pub struct CellInformation {
-    pub id: common_utils::id_type::CellId,
+    pub id: id_type::CellId,
 }
 
 #[cfg(feature = "v2")]
@@ -981,8 +980,8 @@ impl Default for CellInformation {
         // around the time of deserializing application settings.
         // And a panic at application startup is considered acceptable.
         #[allow(clippy::expect_used)]
-        let cell_id = common_utils::id_type::CellId::from_string("defid")
-            .expect("Failed to create a default for Cell Id");
+        let cell_id =
+            id_type::CellId::from_string("defid").expect("Failed to create a default for Cell Id");
         Self { id: cell_id }
     }
 }
@@ -1120,7 +1119,7 @@ impl<'de> Deserialize<'de> for TenantConfig {
             clickhouse_database: String,
         }
 
-        let hashmap = <HashMap<String, Inner>>::deserialize(deserializer)?;
+        let hashmap = <HashMap<id_type::TenantId, Inner>>::deserialize(deserializer)?;
 
         Ok(Self(
             hashmap