refactor(web): Refactor web logic to extract reusable remote client management module (#1465)

easytier-web/src/db/entity/user_running_network_configs.rs

@@ -1,5 +1,6 @@
 //! `SeaORM` Entity, @generated by sea-orm-codegen 1.1.0
 
+use easytier::rpc_service::remote_client::PersistentConfig;
 use sea_orm::entity::prelude::*;
 use serde::{Deserialize, Serialize};
 
@@ -39,3 +40,12 @@ impl Related<super::users::Entity> for Entity {
 }
 
 impl ActiveModelBehavior for ActiveModel {}
+
+impl PersistentConfig for Model {
+    fn get_network_inst_id(&self) -> &str {
+        &self.network_instance_id
+    }
+    fn get_network_config(&self) -> &str {
+        &self.network_config
+    }
+}

easytier-web/src/db/mod.rs

@@ -2,6 +2,7 @@
 #[allow(unused_imports)]
 pub mod entity;
 
+use easytier::rpc_service::remote_client::{ListNetworkProps, Storage};
 use entity::user_running_network_configs;
 use sea_orm::{
     prelude::Expr, sea_query::OnConflict, ColumnTrait as _, DatabaseConnection, DbErr, EntityTrait,
@@ -9,17 +10,13 @@ use sea_orm::{
 };
 use sea_orm_migration::MigratorTrait as _;
 use sqlx::{migrate::MigrateDatabase as _, types::chrono, Sqlite, SqlitePool};
+use uuid::Uuid;
 
 use crate::migrator;
+use async_trait::async_trait;
 
 pub type UserIdInDb = i32;
 
-pub enum ListNetworkProps {
-    All,
-    EnabledOnly,
-    DisabledOnly,
-}
-
 #[derive(Debug, Clone)]
 pub struct Db {
     db_path: String,
@@ -68,12 +65,36 @@ impl Db {
         &self.orm_db
     }
 
-    pub async fn insert_or_update_user_network_config<T: ToString>(
+    pub async fn get_user_id<T: ToString>(
         &self,
-        user_id: UserIdInDb,
-        device_id: uuid::Uuid,
-        network_inst_id: uuid::Uuid,
-        network_config: T,
+        user_name: T,
+    ) -> Result<Option<UserIdInDb>, DbErr> {
+        use entity::users as u;
+
+        let user = u::Entity::find()
+            .filter(u::Column::Username.eq(user_name.to_string()))
+            .one(self.orm_db())
+            .await?;
+
+        Ok(user.map(|u| u.id))
+    }
+
+    // TODO: currently we don't have a token system, so we just use the user name as token
+    pub async fn get_user_id_by_token<T: ToString>(
+        &self,
+        token: T,
+    ) -> Result<Option<UserIdInDb>, DbErr> {
+        self.get_user_id(token).await
+    }
+}
+
+#[async_trait]
+impl Storage<(UserIdInDb, Uuid), user_running_network_configs::Model, DbErr> for Db {
+    async fn insert_or_update_user_network_config(
+        &self,
+        (user_id, device_id): (UserIdInDb, Uuid),
+        network_inst_id: Uuid,
+        network_config: impl ToString + Send,
     ) -> Result<(), DbErr> {
         let txn = self.orm_db().begin().await?;
 
@@ -105,10 +126,10 @@ impl Db {
         txn.commit().await
     }
 
-    pub async fn delete_network_config(
+    async fn delete_network_config(
         &self,
-        user_id: UserIdInDb,
-        network_inst_id: uuid::Uuid,
+        (user_id, _): (UserIdInDb, Uuid),
+        network_inst_id: Uuid,
     ) -> Result<(), DbErr> {
         use entity::user_running_network_configs as urnc;
 
@@ -121,12 +142,12 @@ impl Db {
         Ok(())
     }
 
-    pub async fn update_network_config_state(
+    async fn update_network_config_state(
         &self,
-        user_id: UserIdInDb,
-        network_inst_id: uuid::Uuid,
+        (user_id, _): (UserIdInDb, Uuid),
+        network_inst_id: Uuid,
         disabled: bool,
-    ) -> Result<entity::user_running_network_configs::Model, DbErr> {
+    ) -> Result<user_running_network_configs::Model, DbErr> {
         use entity::user_running_network_configs as urnc;
 
         urnc::Entity::update_many()
@@ -151,10 +172,9 @@ impl Db {
             )))
     }
 
-    pub async fn list_network_configs(
+    async fn list_network_configs(
         &self,
-        user_id: UserIdInDb,
-        device_id: Option<uuid::Uuid>,
+        (user_id, device_id): (UserIdInDb, Uuid),
         props: ListNetworkProps,
     ) -> Result<Vec<user_running_network_configs::Model>, DbErr> {
         use entity::user_running_network_configs as urnc;
@@ -169,7 +189,7 @@ impl Db {
         } else {
             configs
         };
-        let configs = if let Some(device_id) = device_id {
+        let configs = if !device_id.is_nil() {
             configs.filter(urnc::Column::DeviceId.eq(device_id.to_string()))
         } else {
             configs
@@ -180,11 +200,10 @@ impl Db {
         Ok(configs)
     }
 
-    pub async fn get_network_config(
+    async fn get_network_config(
         &self,
-        user_id: UserIdInDb,
-        device_id: &uuid::Uuid,
-        network_inst_id: &String,
+        (user_id, device_id): (UserIdInDb, Uuid),
+        network_inst_id: &str,
     ) -> Result<Option<user_running_network_configs::Model>, DbErr> {
         use entity::user_running_network_configs as urnc;
 
@@ -197,32 +216,11 @@ impl Db {
 
         Ok(config)
     }
-
-    pub async fn get_user_id<T: ToString>(
-        &self,
-        user_name: T,
-    ) -> Result<Option<UserIdInDb>, DbErr> {
-        use entity::users as u;
-
-        let user = u::Entity::find()
-            .filter(u::Column::Username.eq(user_name.to_string()))
-            .one(self.orm_db())
-            .await?;
-
-        Ok(user.map(|u| u.id))
-    }
-
-    // TODO: currently we don't have a token system, so we just use the user name as token
-    pub async fn get_user_id_by_token<T: ToString>(
-        &self,
-        token: T,
-    ) -> Result<Option<UserIdInDb>, DbErr> {
-        self.get_user_id(token).await
-    }
 }
 
 #[cfg(test)]
 mod tests {
+    use easytier::rpc_service::remote_client::Storage;
     use sea_orm::{ColumnTrait, EntityTrait, QueryFilter as _};
 
     use crate::db::{entity::user_running_network_configs, Db, ListNetworkProps};
@@ -235,7 +233,7 @@ mod tests {
         let inst_id = uuid::Uuid::new_v4();
         let device_id = uuid::Uuid::new_v4();
 
-        db.insert_or_update_user_network_config(user_id, device_id, inst_id, network_config)
+        db.insert_or_update_user_network_config((user_id, device_id), inst_id, network_config)
             .await
             .unwrap();
 
@@ -250,7 +248,7 @@ mod tests {
 
         // overwrite the config
         let network_config = "test_config2";
-        db.insert_or_update_user_network_config(user_id, device_id, inst_id, network_config)
+        db.insert_or_update_user_network_config((user_id, device_id), inst_id, network_config)
             .await
             .unwrap();
 
@@ -267,14 +265,16 @@ mod tests {
         assert_ne!(result.update_time, result2.update_time);
 
         assert_eq!(
-            db.list_network_configs(user_id, Some(device_id), ListNetworkProps::All)
+            db.list_network_configs((user_id, device_id), ListNetworkProps::All)
                 .await
                 .unwrap()
                 .len(),
             1
         );
 
-        db.delete_network_config(user_id, inst_id).await.unwrap();
+        db.delete_network_config((user_id, device_id), inst_id)
+            .await
+            .unwrap();
         let result3 = user_running_network_configs::Entity::find()
             .filter(user_running_network_configs::Column::UserId.eq(user_id))
             .one(db.orm_db())