Bring projects, wikis, and teams together with AI. AppFlowy is the AI collaborative workspace where you achieve more without losing control of your data. The leading open source Notion alternative.
Dart blogconfluence-alternativecontent-managementcontent-servicesdocumentationflutternote-takingnotion-alternativeproject-managementtask-managementteam-collaborationwiki
refactor: extract chat plugin to new repo (#5699)
Nathan.fooo521fffd97c42
diff --git a/frontend/appflowy_flutter/lib/plugins/ai_chat/application/chat_bloc.dart b/frontend/appflowy_flutter/lib/plugins/ai_chat/application/chat_bloc.dartindex 92bcbddfee..8f3b5a14f8 100644--- a/frontend/appflowy_flutter/lib/plugins/ai_chat/application/chat_bloc.dart+++ b/frontend/appflowy_flutter/lib/plugins/ai_chat/application/chat_bloc.dart@@ -119,7 +119,6 @@ class ChatBloc extends Bloc<ChatEvent, ChatState> {final uniqueMessages = {...allMessages, ...messages}.toList()..sort((a, b) => b.id.compareTo(a.id));uniqueMessages.insertAll(0, onetimeMessages);-emit(state.copyWith(messages: uniqueMessages,@@ -380,7 +379,8 @@ class ChatBloc extends Bloc<ChatEvent, ChatState> {}Message _createStreamMessage(AnswerStream stream, Int64 questionMessageId) {- final streamMessageId = nanoid();+ final streamMessageId = (questionMessageId + 1).toString();+lastStreamMessageId = streamMessageId;return TextMessage(diff --git a/frontend/appflowy_flutter/lib/workspace/presentation/settings/pages/settings_ai_view.dart b/frontend/appflowy_flutter/lib/workspace/presentation/settings/pages/settings_ai_view.dartindex a64f602bbe..1fba43b3dc 100644--- a/frontend/appflowy_flutter/lib/workspace/presentation/settings/pages/settings_ai_view.dart+++ b/frontend/appflowy_flutter/lib/workspace/presentation/settings/pages/settings_ai_view.dart@@ -53,7 +53,7 @@ class SettingsAIView extends StatelessWidget {AIModelSelection(),_AISearchToggle(value: false),// Disable local AI configuration for now. It's not ready for production.- // LocalAIConfiguration(),+ LocalAIConfiguration(),],);},diff --git a/frontend/appflowy_tauri/src-tauri/Cargo.lock b/frontend/appflowy_tauri/src-tauri/Cargo.lockindex 0aae7ac784..a5e79afdd4 100644--- a/frontend/appflowy_tauri/src-tauri/Cargo.lock+++ b/frontend/appflowy_tauri/src-tauri/Cargo.lock@@ -203,6 +203,40 @@ dependencies = ["thiserror",]+[[package]]+name = "appflowy-local-ai"+version = "0.1.0"+source = "git+https://github.com/AppFlowy-IO/AppFlowy-LocalAI?rev=0820a0d23f7b813dee505e7e29e88a8561699fe8#0820a0d23f7b813dee505e7e29e88a8561699fe8"+dependencies = [+ "anyhow",+ "appflowy-plugin",+ "bytes",+ "serde",+ "serde_json",+ "tokio",+ "tokio-stream",+ "tracing",+]++[[package]]+name = "appflowy-plugin"+version = "0.1.0"+source = "git+https://github.com/AppFlowy-IO/AppFlowy-LocalAI?rev=0820a0d23f7b813dee505e7e29e88a8561699fe8#0820a0d23f7b813dee505e7e29e88a8561699fe8"+dependencies = [+ "anyhow",+ "cfg-if",+ "crossbeam-utils",+ "log",+ "once_cell",+ "parking_lot 0.12.1",+ "serde",+ "serde_json",+ "thiserror",+ "tokio",+ "tokio-stream",+ "tracing",+]+[[package]]name = "appflowy_tauri"version = "0.0.0"@@ -1341,7 +1375,7 @@ dependencies = ["cssparser-macros","dtoa-short","itoa 1.0.6",- "phf 0.8.0",+ "phf 0.11.2","smallvec",]@@ -1847,6 +1881,8 @@ version = "0.1.0"dependencies = ["allo-isolate","anyhow",+ "appflowy-local-ai",+ "appflowy-plugin","bytes","dashmap","flowy-chat-pub",@@ -1854,7 +1890,6 @@ dependencies = ["flowy-derive","flowy-error","flowy-notification",- "flowy-sidecar","flowy-sqlite","futures","lib-dispatch",@@ -2136,7 +2171,6 @@ dependencies = ["fancy-regex 0.11.0","flowy-codegen","flowy-derive",- "flowy-sidecar","flowy-sqlite","lib-dispatch","protobuf",@@ -2323,24 +2357,6 @@ dependencies = ["serde_repr",]-[[package]]-name = "flowy-sidecar"-version = "0.1.0"-dependencies = [- "anyhow",- "crossbeam-utils",- "lib-infra",- "log",- "once_cell",- "parking_lot 0.12.1",- "serde",- "serde_json",- "thiserror",- "tokio",- "tokio-stream",- "tracing",-]-[[package]]name = "flowy-sqlite"version = "0.1.0"@@ -4878,7 +4894,7 @@ checksum = "c55e02e35260070b6f716a2423c2ff1c3bb1642ddca6f99e1f26d06268a0e2d2"dependencies = ["bytes","heck 0.4.1",- "itertools 0.10.5",+ "itertools 0.11.0","log","multimap","once_cell",@@ -4899,7 +4915,7 @@ source = "registry+https://github.com/rust-lang/crates.io-index"checksum = "efb6c9a1dd1def8e2124d17e83a20af56f1570d6c2d2bd9e266ccb768df3840e"dependencies = ["anyhow",- "itertools 0.10.5",+ "itertools 0.11.0","proc-macro2","quote","syn 2.0.47",diff --git a/frontend/appflowy_tauri/src-tauri/Cargo.toml b/frontend/appflowy_tauri/src-tauri/Cargo.tomlindex eec5698341..ce2c1ab729 100644--- a/frontend/appflowy_tauri/src-tauri/Cargo.toml+++ b/frontend/appflowy_tauri/src-tauri/Cargo.toml@@ -106,6 +106,15 @@ default = ["custom-protocol"]custom-protocol = ["tauri/custom-protocol"][patch.crates-io]+# Please use the following script to update collab.+# Working directory: frontend+#+# To update the commit ID, run:+# scripts/tool/update_collab_rev.sh new_rev_id+#+# To switch to the local path, run:+# scripts/tool/update_collab_source.sh+# ⚠️⚠️⚠️️collab = { version = "0.2", git = "https://github.com/AppFlowy-IO/AppFlowy-Collab", rev = "5048762" }collab-entity = { version = "0.2", git = "https://github.com/AppFlowy-IO/AppFlowy-Collab", rev = "5048762" }collab-folder = { version = "0.2", git = "https://github.com/AppFlowy-IO/AppFlowy-Collab", rev = "5048762" }@@ -113,3 +122,10 @@ collab-document = { version = "0.2", git = "https://github.com/AppFlowy-IO/AppFlcollab-database = { version = "0.2", git = "https://github.com/AppFlowy-IO/AppFlowy-Collab", rev = "5048762" }collab-plugins = { version = "0.2", git = "https://github.com/AppFlowy-IO/AppFlowy-Collab", rev = "5048762" }collab-user = { version = "0.2", git = "https://github.com/AppFlowy-IO/AppFlowy-Collab", rev = "5048762" }++# Working directory: frontend+# To update the commit ID, run:+# scripts/tool/update_local_ai_rev.sh new_rev_id+# ⚠️⚠️⚠️️+appflowy-local-ai = { version = "0.1", git = "https://github.com/AppFlowy-IO/AppFlowy-LocalAI", rev = "0820a0d23f7b813dee505e7e29e88a8561699fe8" }+appflowy-plugin = { version = "0.1", git = "https://github.com/AppFlowy-IO/AppFlowy-LocalAI", rev = "0820a0d23f7b813dee505e7e29e88a8561699fe8" }diff --git a/frontend/appflowy_web_app/src-tauri/Cargo.lock b/frontend/appflowy_web_app/src-tauri/Cargo.lockindex 385d1c881d..9ed5393c3f 100644--- a/frontend/appflowy_web_app/src-tauri/Cargo.lock+++ b/frontend/appflowy_web_app/src-tauri/Cargo.lock@@ -194,6 +194,40 @@ dependencies = ["thiserror",]+[[package]]+name = "appflowy-local-ai"+version = "0.1.0"+source = "git+https://github.com/AppFlowy-IO/AppFlowy-LocalAI?rev=0820a0d23f7b813dee505e7e29e88a8561699fe8#0820a0d23f7b813dee505e7e29e88a8561699fe8"+dependencies = [+ "anyhow",+ "appflowy-plugin",+ "bytes",+ "serde",+ "serde_json",+ "tokio",+ "tokio-stream",+ "tracing",+]++[[package]]+name = "appflowy-plugin"+version = "0.1.0"+source = "git+https://github.com/AppFlowy-IO/AppFlowy-LocalAI?rev=0820a0d23f7b813dee505e7e29e88a8561699fe8#0820a0d23f7b813dee505e7e29e88a8561699fe8"+dependencies = [+ "anyhow",+ "cfg-if",+ "crossbeam-utils",+ "log",+ "once_cell",+ "parking_lot 0.12.1",+ "serde",+ "serde_json",+ "thiserror",+ "tokio",+ "tokio-stream",+ "tracing",+]+[[package]]name = "appflowy_tauri"version = "0.0.0"@@ -1331,7 +1365,7 @@ dependencies = ["cssparser-macros","dtoa-short","itoa 1.0.10",- "phf 0.8.0",+ "phf 0.11.2","smallvec",]@@ -1887,6 +1921,8 @@ version = "0.1.0"dependencies = ["allo-isolate","anyhow",+ "appflowy-local-ai",+ "appflowy-plugin","bytes","dashmap","flowy-chat-pub",@@ -1894,7 +1930,6 @@ dependencies = ["flowy-derive","flowy-error","flowy-notification",- "flowy-sidecar","flowy-sqlite","futures","lib-dispatch",@@ -2176,7 +2211,6 @@ dependencies = ["fancy-regex 0.11.0","flowy-codegen","flowy-derive",- "flowy-sidecar","flowy-sqlite","lib-dispatch","protobuf",@@ -2363,24 +2397,6 @@ dependencies = ["serde_repr",]-[[package]]-name = "flowy-sidecar"-version = "0.1.0"-dependencies = [- "anyhow",- "crossbeam-utils",- "lib-infra",- "log",- "once_cell",- "parking_lot 0.12.1",- "serde",- "serde_json",- "thiserror",- "tokio",- "tokio-stream",- "tracing",-]-[[package]]name = "flowy-sqlite"version = "0.1.0"@@ -4962,7 +4978,7 @@ checksum = "c55e02e35260070b6f716a2423c2ff1c3bb1642ddca6f99e1f26d06268a0e2d2"dependencies = ["bytes","heck 0.4.1",- "itertools 0.10.5",+ "itertools 0.11.0","log","multimap","once_cell",@@ -4983,7 +4999,7 @@ source = "registry+https://github.com/rust-lang/crates.io-index"checksum = "efb6c9a1dd1def8e2124d17e83a20af56f1570d6c2d2bd9e266ccb768df3840e"dependencies = ["anyhow",- "itertools 0.10.5",+ "itertools 0.11.0","proc-macro2","quote","syn 2.0.55",diff --git a/frontend/appflowy_web_app/src-tauri/Cargo.toml b/frontend/appflowy_web_app/src-tauri/Cargo.tomlindex 419317f66f..9a95bc584a 100644--- a/frontend/appflowy_web_app/src-tauri/Cargo.toml+++ b/frontend/appflowy_web_app/src-tauri/Cargo.toml@@ -107,6 +107,15 @@ default = ["custom-protocol"]custom-protocol = ["tauri/custom-protocol"][patch.crates-io]+# Please use the following script to update collab.+# Working directory: frontend+#+# To update the commit ID, run:+# scripts/tool/update_collab_rev.sh new_rev_id+#+# To switch to the local path, run:+# scripts/tool/update_collab_source.sh+# ⚠️⚠️⚠️️collab = { version = "0.2", git = "https://github.com/AppFlowy-IO/AppFlowy-Collab", rev = "5048762" }collab-entity = { version = "0.2", git = "https://github.com/AppFlowy-IO/AppFlowy-Collab", rev = "5048762" }collab-folder = { version = "0.2", git = "https://github.com/AppFlowy-IO/AppFlowy-Collab", rev = "5048762" }@@ -114,3 +123,11 @@ collab-document = { version = "0.2", git = "https://github.com/AppFlowy-IO/AppFlcollab-database = { version = "0.2", git = "https://github.com/AppFlowy-IO/AppFlowy-Collab", rev = "5048762" }collab-plugins = { version = "0.2", git = "https://github.com/AppFlowy-IO/AppFlowy-Collab", rev = "5048762" }collab-user = { version = "0.2", git = "https://github.com/AppFlowy-IO/AppFlowy-Collab", rev = "5048762" }++# Working directory: frontend+# To update the commit ID, run:+# scripts/tool/update_local_ai_rev.sh new_rev_id+# ⚠️⚠️⚠️️+appflowy-local-ai = { version = "0.1", git = "https://github.com/AppFlowy-IO/AppFlowy-LocalAI", rev = "0820a0d23f7b813dee505e7e29e88a8561699fe8" }+appflowy-plugin = { version = "0.1", git = "https://github.com/AppFlowy-IO/AppFlowy-LocalAI", rev = "0820a0d23f7b813dee505e7e29e88a8561699fe8" }+diff --git a/frontend/rust-lib/Cargo.lock b/frontend/rust-lib/Cargo.lockindex 41028d6aba..b84e18e1db 100644--- a/frontend/rust-lib/Cargo.lock+++ b/frontend/rust-lib/Cargo.lock@@ -194,6 +194,40 @@ dependencies = ["thiserror",]+[[package]]+name = "appflowy-local-ai"+version = "0.1.0"+source = "git+https://github.com/AppFlowy-IO/AppFlowy-LocalAI?rev=0820a0d23f7b813dee505e7e29e88a8561699fe8#0820a0d23f7b813dee505e7e29e88a8561699fe8"+dependencies = [+ "anyhow",+ "appflowy-plugin",+ "bytes",+ "serde",+ "serde_json",+ "tokio",+ "tokio-stream",+ "tracing",+]++[[package]]+name = "appflowy-plugin"+version = "0.1.0"+source = "git+https://github.com/AppFlowy-IO/AppFlowy-LocalAI?rev=0820a0d23f7b813dee505e7e29e88a8561699fe8#0820a0d23f7b813dee505e7e29e88a8561699fe8"+dependencies = [+ "anyhow",+ "cfg-if",+ "crossbeam-utils",+ "log",+ "once_cell",+ "parking_lot 0.12.1",+ "serde",+ "serde_json",+ "thiserror",+ "tokio",+ "tokio-stream",+ "tracing",+]+[[package]]name = "arc-swap"version = "1.7.1"@@ -1667,6 +1701,8 @@ version = "0.1.0"dependencies = ["allo-isolate","anyhow",+ "appflowy-local-ai",+ "appflowy-plugin","bytes","dashmap","dotenv",@@ -1675,7 +1711,6 @@ dependencies = ["flowy-derive","flowy-error","flowy-notification",- "flowy-sidecar","flowy-sqlite","futures","lib-dispatch",@@ -1685,6 +1720,7 @@ dependencies = ["protobuf","serde","serde_json",+ "simsimd","strum_macros 0.21.1","tokio","tokio-stream",@@ -1962,7 +1998,6 @@ dependencies = ["fancy-regex 0.11.0","flowy-codegen","flowy-derive",- "flowy-sidecar","flowy-sqlite","lib-dispatch","protobuf",@@ -2153,24 +2188,6 @@ dependencies = ["serde_repr",]-[[package]]-name = "flowy-sidecar"-version = "0.1.0"-dependencies = [- "anyhow",- "crossbeam-utils",- "lib-infra",- "log",- "once_cell",- "parking_lot 0.12.1",- "serde",- "serde_json",- "thiserror",- "tokio",- "tokio-stream",- "tracing",-]-[[package]]name = "flowy-sqlite"version = "0.1.0"@@ -5145,6 +5162,15 @@ dependencies = ["time",]+[[package]]+name = "simsimd"+version = "4.4.0"+source = "registry+https://github.com/rust-lang/crates.io-index"+checksum = "efc843bc8f12d9c8e6b734a0fe8918fc497b42f6ae0f347dbfdad5b5138ab9b4"+dependencies = [+ "cc",+]+[[package]]name = "siphasher"version = "0.3.11"diff --git a/frontend/rust-lib/Cargo.toml b/frontend/rust-lib/Cargo.tomlindex 95402906de..acae7d44cd 100644--- a/frontend/rust-lib/Cargo.toml+++ b/frontend/rust-lib/Cargo.toml@@ -32,7 +32,6 @@ members = ["flowy-chat","flowy-chat-pub","flowy-storage-pub",- "flowy-sidecar",]resolver = "2"@@ -68,7 +67,6 @@ collab-integrate = { workspace = true, path = "collab-integrate" }flowy-date = { workspace = true, path = "flowy-date" }flowy-chat = { workspace = true, path = "flowy-chat" }flowy-chat-pub = { workspace = true, path = "flowy-chat-pub" }-flowy-sidecar = { workspace = true, path = "flowy-sidecar" }anyhow = "1.0"tracing = "0.1.40"bytes = "1.5.0"@@ -146,3 +144,10 @@ collab-document = { version = "0.2", git = "https://github.com/AppFlowy-IO/AppFlcollab-database = { version = "0.2", git = "https://github.com/AppFlowy-IO/AppFlowy-Collab", rev = "5048762" }collab-plugins = { version = "0.2", git = "https://github.com/AppFlowy-IO/AppFlowy-Collab", rev = "5048762" }collab-user = { version = "0.2", git = "https://github.com/AppFlowy-IO/AppFlowy-Collab", rev = "5048762" }++# Working directory: frontend+# To update the commit ID, run:+# scripts/tool/update_local_ai_rev.sh new_rev_id+# ⚠️⚠️⚠️️+appflowy-local-ai = { version = "0.1", git = "https://github.com/AppFlowy-IO/AppFlowy-LocalAI", rev = "0820a0d23f7b813dee505e7e29e88a8561699fe8" }+appflowy-plugin = { version = "0.1", git = "https://github.com/AppFlowy-IO/AppFlowy-LocalAI", rev = "0820a0d23f7b813dee505e7e29e88a8561699fe8" }diff --git a/frontend/rust-lib/flowy-chat/Cargo.toml b/frontend/rust-lib/flowy-chat/Cargo.tomlindex 879b707c1a..a782708330 100644--- a/frontend/rust-lib/flowy-chat/Cargo.toml+++ b/frontend/rust-lib/flowy-chat/Cargo.toml@@ -12,7 +12,6 @@ flowy-error = { path = "../flowy-error", features = ["impl_from_dispatch_error","impl_from_collab_folder","impl_from_sqlite",- "impl_from_sidecar"] }lib-dispatch = { workspace = true }tracing.workspace = true@@ -29,17 +28,19 @@ tokio.workspace = truefutures.workspace = trueallo-isolate = { version = "^0.1", features = ["catch-unwind"] }log = "0.4.21"-flowy-sidecar = { workspace = true, features = ["verbose"] }serde = { workspace = true, features = ["derive"] }serde_json = { workspace = true }anyhow = "1.0.86"tokio-stream = "0.1.15"parking_lot.workspace = true+appflowy-local-ai = { version = "0.1.0", features = ["verbose"] }+appflowy-plugin = { version = "0.1.0", features = ["verbose"] }[dev-dependencies]dotenv = "0.15.0"uuid.workspace = truetracing-subscriber = { version = "0.3.17", features = ["registry", "env-filter", "ansi", "json"] }+simsimd = "4.4.0"[build-dependencies]flowy-codegen.workspace = truediff --git a/frontend/rust-lib/flowy-chat/src/chat.rs b/frontend/rust-lib/flowy-chat/src/chat.rsindex 6c5e06d7a8..def485326e 100644--- a/frontend/rust-lib/flowy-chat/src/chat.rs+++ b/frontend/rust-lib/flowy-chat/src/chat.rs@@ -1,8 +1,8 @@use crate::chat_manager::ChatUserService;-use crate::chat_service_impl::ChatService;use crate::entities::{ChatMessageErrorPB, ChatMessageListPB, ChatMessagePB, RepeatedRelatedQuestionPB,};+use crate::middleware::chat_service_mw::ChatService;use crate::notification::{send_notification, ChatNotification};use crate::persistence::{insert_chat_messages, select_chat_messages, ChatMessageTable};use allo_isolate::Isolate;diff --git a/frontend/rust-lib/flowy-chat/src/chat_manager.rs b/frontend/rust-lib/flowy-chat/src/chat_manager.rsindex 20fd340698..b900eb3e5c 100644--- a/frontend/rust-lib/flowy-chat/src/chat_manager.rs+++ b/frontend/rust-lib/flowy-chat/src/chat_manager.rs@@ -1,12 +1,12 @@use crate::chat::Chat;-use crate::chat_service_impl::ChatService;use crate::entities::{ChatMessageListPB, ChatMessagePB, RepeatedRelatedQuestionPB};-use crate::local_ai::llm_chat::{LocalChatLLMChat, LocalLLMSetting};+use crate::middleware::chat_service_mw::ChatService;use crate::persistence::{insert_chat, ChatTable};+use appflowy_local_ai::llm_chat::{LocalChatLLMChat, LocalLLMSetting};+use appflowy_plugin::manager::PluginManager;use dashmap::DashMap;use flowy_chat_pub::cloud::{ChatCloudService, ChatMessageType};use flowy_error::{FlowyError, FlowyResult};-use flowy_sidecar::manager::SidecarManager;use flowy_sqlite::kv::KVStorePreferences;use flowy_sqlite::DBConnection;use lib_infra::util::timestamp;@@ -38,10 +38,10 @@ impl ChatManager {let local_ai_setting = store_preferences.get_object::<LocalLLMSetting>(LOCAL_AI_SETTING_KEY).unwrap_or_default();- let sidecar_manager = Arc::new(SidecarManager::new());+ let plugin_manager = Arc::new(PluginManager::new());// setup local AI chat plugin- let local_llm_ctrl = Arc::new(LocalChatLLMChat::new(sidecar_manager));+ let local_llm_ctrl = Arc::new(LocalChatLLMChat::new(plugin_manager));// setup local chat servicelet chat_service = Arc::new(ChatService::new(user_service.clone(),diff --git a/frontend/rust-lib/flowy-chat/src/entities.rs b/frontend/rust-lib/flowy-chat/src/entities.rsindex bf7f9227ed..da4dcba029 100644--- a/frontend/rust-lib/flowy-chat/src/entities.rs+++ b/frontend/rust-lib/flowy-chat/src/entities.rs@@ -1,4 +1,4 @@-use crate::local_ai::llm_chat::LocalLLMSetting;+use appflowy_local_ai::llm_chat::LocalLLMSetting;use flowy_chat_pub::cloud::{ChatMessage, RelatedQuestion, RepeatedChatMessage, RepeatedRelatedQuestion,};@@ -267,3 +267,19 @@ pub enum CompletionTypePB {MakeLonger = 4,ContinueWriting = 5,}++#[derive(Default, ProtoBuf, Clone, Debug)]+pub struct ChatStatePB {+ #[pb(index = 1)]+ pub model_type: ModelTypePB,++ #[pb(index = 2)]+ pub available: bool,+}++#[derive(Clone, Debug, ProtoBuf_Enum, Default)]+pub enum ModelTypePB {+ LocalAI = 0,+ #[default]+ RemoteAI = 1,+}diff --git a/frontend/rust-lib/flowy-chat/src/lib.rs b/frontend/rust-lib/flowy-chat/src/lib.rsindex c0371ef053..ca5e9b1f24 100644--- a/frontend/rust-lib/flowy-chat/src/lib.rs+++ b/frontend/rust-lib/flowy-chat/src/lib.rs@@ -3,9 +3,8 @@ pub mod event_map;mod chat;pub mod chat_manager;-mod chat_service_impl;pub mod entities;-pub mod local_ai;+mod middleware;pub mod notification;mod persistence;mod protobuf;diff --git a/frontend/rust-lib/flowy-chat/src/local_ai/chat_plugin.rs b/frontend/rust-lib/flowy-chat/src/local_ai/chat_plugin.rsdeleted file mode 100644index 8287e86c8b..0000000000--- a/frontend/rust-lib/flowy-chat/src/local_ai/chat_plugin.rs+++ /dev/null@@ -1,129 +0,0 @@-use anyhow::anyhow;-use bytes::Bytes;-use flowy_error::FlowyError;-use flowy_sidecar::core::parser::{DefaultResponseParser, ResponseParser};-use flowy_sidecar::core::plugin::Plugin;-use flowy_sidecar::error::{RemoteError, SidecarError};-use serde_json::json;-use serde_json::Value as JsonValue;-use std::sync::Weak;-use tokio_stream::wrappers::ReceiverStream;-use tracing::instrument;--pub struct ChatPluginOperation {- plugin: Weak<Plugin>,-}--impl ChatPluginOperation {- pub fn new(plugin: Weak<Plugin>) -> Self {- ChatPluginOperation { plugin }- }-- fn get_plugin(&self) -> Result<std::sync::Arc<Plugin>, SidecarError> {- self- .plugin- .upgrade()- .ok_or_else(|| SidecarError::Internal(anyhow!("Plugin is dropped")))- }-- async fn send_request<T: ResponseParser>(- &self,- method: &str,- params: JsonValue,- ) -> Result<T::ValueType, SidecarError> {- let plugin = self.get_plugin()?;- let mut request = json!({ "method": method });- request- .as_object_mut()- .unwrap()- .extend(params.as_object().unwrap().clone());- plugin.async_request::<T>("handle", &request).await- }-- pub async fn create_chat(&self, chat_id: &str) -> Result<(), SidecarError> {- self- .send_request::<DefaultResponseParser>("create_chat", json!({ "chat_id": chat_id }))- .await- }-- pub async fn close_chat(&self, chat_id: &str) -> Result<(), SidecarError> {- self- .send_request::<DefaultResponseParser>("close_chat", json!({ "chat_id": chat_id }))- .await- }-- pub async fn send_message(&self, chat_id: &str, message: &str) -> Result<String, SidecarError> {- self- .send_request::<ChatResponseParser>(- "answer",- json!({ "chat_id": chat_id, "params": { "content": message } }),- )- .await- }-- #[instrument(level = "debug", skip(self), err)]- pub async fn stream_message(- &self,- chat_id: &str,- message: &str,- ) -> Result<ReceiverStream<Result<Bytes, SidecarError>>, FlowyError> {- let plugin = self- .get_plugin()- .map_err(|err| FlowyError::internal().with_context(err.to_string()))?;- let params = json!({- "chat_id": chat_id,- "method": "stream_answer",- "params": { "content": message }- });- plugin- .stream_request::<ChatStreamResponseParser>("handle", ¶ms)- .map_err(|err| FlowyError::internal().with_context(err.to_string()))- }-- pub async fn get_related_questions(&self, chat_id: &str) -> Result<Vec<JsonValue>, SidecarError> {- self- .send_request::<ChatRelatedQuestionsResponseParser>(- "related_question",- json!({ "chat_id": chat_id }),- )- .await- }-}--pub struct ChatResponseParser;-impl ResponseParser for ChatResponseParser {- type ValueType = String;-- fn parse_json(json: JsonValue) -> Result<Self::ValueType, RemoteError> {- json- .get("data")- .and_then(|data| data.as_str())- .map(String::from)- .ok_or(RemoteError::ParseResponse(json))- }-}--pub struct ChatStreamResponseParser;-impl ResponseParser for ChatStreamResponseParser {- type ValueType = Bytes;-- fn parse_json(json: JsonValue) -> Result<Self::ValueType, RemoteError> {- json- .as_str()- .map(|message| Bytes::from(message.to_string()))- .ok_or(RemoteError::ParseResponse(json))- }-}--pub struct ChatRelatedQuestionsResponseParser;-impl ResponseParser for ChatRelatedQuestionsResponseParser {- type ValueType = Vec<JsonValue>;-- fn parse_json(json: JsonValue) -> Result<Self::ValueType, RemoteError> {- json- .get("data")- .and_then(|data| data.as_array())- .cloned()- .ok_or(RemoteError::ParseResponse(json))- }-}diff --git a/frontend/rust-lib/flowy-chat/src/local_ai/embedding_plugin.rs b/frontend/rust-lib/flowy-chat/src/local_ai/embedding_plugin.rsdeleted file mode 100644index beb0bf75a9..0000000000--- a/frontend/rust-lib/flowy-chat/src/local_ai/embedding_plugin.rs+++ /dev/null@@ -1,50 +0,0 @@-use anyhow::anyhow;-use flowy_sidecar::core::parser::ResponseParser;-use flowy_sidecar::core::plugin::Plugin;-use flowy_sidecar::error::{RemoteError, SidecarError};-use serde_json::json;-use serde_json::Value as JsonValue;-use std::sync::Weak;--pub struct EmbeddingPluginOperation {- plugin: Weak<Plugin>,-}--impl EmbeddingPluginOperation {- pub fn new(plugin: Weak<Plugin>) -> Self {- EmbeddingPluginOperation { plugin }- }-- pub async fn calculate_similarity(- &self,- message1: &str,- message2: &str,- ) -> Result<f64, SidecarError> {- let plugin = self- .plugin- .upgrade()- .ok_or(SidecarError::Internal(anyhow!("Plugin is dropped")))?;- let params =- json!({"method": "calculate_similarity", "params": {"src": message1, "dest": message2}});- plugin- .async_request::<SimilarityResponseParser>("handle", ¶ms)- .await- }-}--pub struct SimilarityResponseParser;-impl ResponseParser for SimilarityResponseParser {- type ValueType = f64;-- fn parse_json(json: JsonValue) -> Result<Self::ValueType, RemoteError> {- if json.is_object() {- if let Some(data) = json.get("data") {- if let Some(score) = data.get("score").and_then(|v| v.as_f64()) {- return Ok(score);- }- }- }-- Err(RemoteError::ParseResponse(json))- }-}diff --git a/frontend/rust-lib/flowy-chat/src/local_ai/llm_chat.rs b/frontend/rust-lib/flowy-chat/src/local_ai/llm_chat.rsdeleted file mode 100644index ac59507ab7..0000000000--- a/frontend/rust-lib/flowy-chat/src/local_ai/llm_chat.rs+++ /dev/null@@ -1,315 +0,0 @@-use crate::local_ai::chat_plugin::ChatPluginOperation;-use bytes::Bytes;-use flowy_error::{FlowyError, FlowyResult};-use flowy_sidecar::core::plugin::{Plugin, PluginId, PluginInfo};-use flowy_sidecar::error::SidecarError;-use flowy_sidecar::manager::SidecarManager;-use log::error;-use serde::{Deserialize, Serialize};-use std::path::PathBuf;-use std::sync::{Arc, Weak};-use std::time::Duration;-use tokio::sync::RwLock;-use tokio::time::timeout;-use tokio_stream::wrappers::ReceiverStream;-use tracing::{info, instrument, trace};--#[derive(Debug, Clone, Serialize, Deserialize, Default)]-pub struct LocalLLMSetting {- pub chat_bin_path: String,- pub chat_model_path: String,- pub enabled: bool,-}--impl LocalLLMSetting {- pub fn validate(&self) -> FlowyResult<()> {- ChatPluginConfig::new(&self.chat_bin_path, &self.chat_model_path)?;- Ok(())- }- pub fn chat_config(&self) -> FlowyResult<ChatPluginConfig> {- let config = ChatPluginConfig::new(&self.chat_bin_path, &self.chat_model_path)?;- Ok(config)- }-}--pub struct LocalChatLLMChat {- sidecar_manager: Arc<SidecarManager>,- state: RwLock<LLMState>,- state_notify: tokio::sync::broadcast::Sender<LLMState>,- plugin_config: RwLock<Option<ChatPluginConfig>>,-}--impl LocalChatLLMChat {- pub fn new(sidecar_manager: Arc<SidecarManager>) -> Self {- let (state_notify, _) = tokio::sync::broadcast::channel(10);- Self {- sidecar_manager,- state: RwLock::new(LLMState::Loading),- state_notify,- plugin_config: Default::default(),- }- }-- async fn update_state(&self, state: LLMState) {- *self.state.write().await = state.clone();- let _ = self.state_notify.send(state);- }-- /// Waits for the plugin to be ready.- ///- /// The wait_plugin_ready method is an asynchronous function designed to ensure that the chat- /// plugin is in a ready state before allowing further operations. This is crucial for maintaining- /// the correct sequence of operations and preventing errors that could occur if operations are- /// attempted on an unready plugin.- ///- /// # Returns- ///- /// A `FlowyResult<()>` indicating success or failure.- async fn wait_plugin_ready(&self) -> FlowyResult<()> {- let is_loading = self.state.read().await.is_loading();- if !is_loading {- return Ok(());- }- info!("[Chat Plugin] wait for chat plugin to be ready");- let mut rx = self.state_notify.subscribe();- let timeout_duration = Duration::from_secs(30);- let result = timeout(timeout_duration, async {- while let Ok(state) = rx.recv().await {- if state.is_ready() {- break;- }- }- })- .await;-- match result {- Ok(_) => {- trace!("[Chat Plugin] chat plugin is ready");- Ok(())- },- Err(_) => Err(- FlowyError::local_ai().with_context("Timeout while waiting for chat plugin to be ready"),- ),- }- }-- /// Retrieves the chat plugin.- ///- /// # Returns- ///- /// A `FlowyResult<Weak<Plugin>>` containing a weak reference to the plugin.- async fn get_chat_plugin(&self) -> FlowyResult<Weak<Plugin>> {- let plugin_id = self.state.read().await.plugin_id()?;- let plugin = self.sidecar_manager.get_plugin(plugin_id).await?;- Ok(plugin)- }-- /// Creates a new chat session.- ///- /// # Arguments- ///- /// * `chat_id` - A string slice containing the unique identifier for the chat session.- ///- /// # Returns- ///- /// A `FlowyResult<()>` indicating success or failure.- pub async fn create_chat(&self, chat_id: &str) -> FlowyResult<()> {- trace!("[Chat Plugin] create chat: {}", chat_id);- self.wait_plugin_ready().await?;-- let plugin = self.get_chat_plugin().await?;- let operation = ChatPluginOperation::new(plugin);- operation.create_chat(chat_id).await?;- Ok(())- }-- /// Closes an existing chat session.- ///- /// # Arguments- ///- /// * `chat_id` - A string slice containing the unique identifier for the chat session to close.- ///- /// # Returns- ///- /// A `FlowyResult<()>` indicating success or failure.- pub async fn close_chat(&self, chat_id: &str) -> FlowyResult<()> {- trace!("[Chat Plugin] close chat: {}", chat_id);- let plugin = self.get_chat_plugin().await?;- let operation = ChatPluginOperation::new(plugin);- operation.close_chat(chat_id).await?;- Ok(())- }-- /// Asks a question and returns a stream of responses.- ///- /// # Arguments- ///- /// * `chat_id` - A string slice containing the unique identifier for the chat session.- /// * `message` - A string slice containing the question or message to send.- ///- /// # Returns- ///- /// A `FlowyResult<ReceiverStream<anyhow::Result<Bytes, SidecarError>>>` containing a stream of responses.- pub async fn ask_question(- &self,- chat_id: &str,- message: &str,- ) -> FlowyResult<ReceiverStream<anyhow::Result<Bytes, SidecarError>>> {- trace!("[Chat Plugin] ask question: {}", message);- self.wait_plugin_ready().await?;- let plugin = self.get_chat_plugin().await?;- let operation = ChatPluginOperation::new(plugin);- let stream = operation.stream_message(chat_id, message).await?;- Ok(stream)- }-- /// Generates a complete answer for a given message.- ///- /// # Arguments- ///- /// * `chat_id` - A string slice containing the unique identifier for the chat session.- /// * `message` - A string slice containing the message to generate an answer for.- ///- /// # Returns- ///- /// A `FlowyResult<String>` containing the generated answer.- pub async fn generate_answer(&self, chat_id: &str, message: &str) -> FlowyResult<String> {- let plugin = self.get_chat_plugin().await?;- let operation = ChatPluginOperation::new(plugin);- let answer = operation.send_message(chat_id, message).await?;- Ok(answer)- }-- #[instrument(skip_all, err)]- pub async fn destroy_chat_plugin(&self) -> FlowyResult<()> {- if let Ok(plugin_id) = self.state.read().await.plugin_id() {- if let Err(err) = self.sidecar_manager.remove_plugin(plugin_id).await {- error!("remove plugin failed: {:?}", err);- }- }-- self.update_state(LLMState::Uninitialized).await;- Ok(())- }-- #[instrument(skip_all, err)]- pub async fn init_chat_plugin(&self, config: ChatPluginConfig) -> FlowyResult<()> {- if self.state.read().await.is_ready() {- if let Some(existing_config) = self.plugin_config.read().await.as_ref() {- if existing_config == &config {- trace!("[Chat Plugin] chat plugin already initialized with the same config");- return Ok(());- } else {- trace!(- "[Chat Plugin] existing config: {:?}, new config:{:?}",- existing_config,- config- );- }- }- }-- // Initialize chat plugin if the config is different- // If the chat_bin_path is different, remove the old plugin- if let Err(err) = self.destroy_chat_plugin().await {- error!("[Chat Plugin] failed to destroy plugin: {:?}", err);- }- self.update_state(LLMState::Loading).await;-- // create new plugin- trace!("[Chat Plugin] create chat plugin: {:?}", config);- let plugin_info = PluginInfo {- name: "chat_plugin".to_string(),- exec_path: config.chat_bin_path.clone(),- };- let plugin_id = self.sidecar_manager.create_plugin(plugin_info).await?;-- // init plugin- trace!("[Chat Plugin] init chat plugin model: {:?}", plugin_id);- let model_path = config.chat_model_path.clone();- let plugin = self.sidecar_manager.init_plugin(- plugin_id,- serde_json::json!({- "absolute_chat_model_path": model_path,- }),- )?;-- info!("[Chat Plugin] {} setup success", plugin);- self.plugin_config.write().await.replace(config);- self.update_state(LLMState::Ready { plugin_id }).await;- Ok(())- }-}--#[derive(Eq, PartialEq, Debug, Clone)]-pub struct ChatPluginConfig {- chat_bin_path: PathBuf,- chat_model_path: PathBuf,-}--impl ChatPluginConfig {- pub fn new(chat_bin: &str, chat_model_path: &str) -> FlowyResult<Self> {- let chat_bin_path = PathBuf::from(chat_bin);- if !chat_bin_path.exists() {- return Err(FlowyError::invalid_data().with_context(format!(- "Chat binary path does not exist: {:?}",- chat_bin_path- )));- }- if !chat_bin_path.is_file() {- return Err(FlowyError::invalid_data().with_context(format!(- "Chat binary path is not a file: {:?}",- chat_bin_path- )));- }-- // Check if local_model_dir exists and is a directory- let chat_model_path = PathBuf::from(&chat_model_path);- if !chat_model_path.exists() {- return Err(- FlowyError::invalid_data()- .with_context(format!("Local model does not exist: {:?}", chat_model_path)),- );- }- if !chat_model_path.is_file() {- return Err(- FlowyError::invalid_data()- .with_context(format!("Local model is not a file: {:?}", chat_model_path)),- );- }-- Ok(Self {- chat_bin_path,- chat_model_path,- })- }-}--#[derive(Debug, Clone)]-pub enum LLMState {- Uninitialized,- Loading,- Ready { plugin_id: PluginId },-}--impl LLMState {- fn plugin_id(&self) -> FlowyResult<PluginId> {- match self {- LLMState::Ready { plugin_id } => Ok(*plugin_id),- _ => Err(FlowyError::local_ai().with_context("chat plugin is not ready")),- }- }-- fn is_loading(&self) -> bool {- matches!(self, LLMState::Loading)- }-- #[allow(dead_code)]- fn is_uninitialized(&self) -> bool {- matches!(self, LLMState::Uninitialized)- }-- fn is_ready(&self) -> bool {- matches!(self, LLMState::Ready { .. })- }-}diff --git a/frontend/rust-lib/flowy-chat/src/local_ai/mod.rs b/frontend/rust-lib/flowy-chat/src/local_ai/mod.rsdeleted file mode 100644index f2f3ae9393..0000000000--- a/frontend/rust-lib/flowy-chat/src/local_ai/mod.rs+++ /dev/null@@ -1,4 +0,0 @@-pub mod chat_plugin;-pub mod llm_chat;--pub mod embedding_plugin;diff --git a/frontend/rust-lib/flowy-chat/src/chat_service_impl.rs b/frontend/rust-lib/flowy-chat/src/middleware/chat_service_mw.rssimilarity index 69%rename from frontend/rust-lib/flowy-chat/src/chat_service_impl.rsrename to frontend/rust-lib/flowy-chat/src/middleware/chat_service_mw.rsindex 59dd810dd8..e3b42a8904 100644--- a/frontend/rust-lib/flowy-chat/src/chat_service_impl.rs+++ b/frontend/rust-lib/flowy-chat/src/middleware/chat_service_mw.rs@@ -1,12 +1,16 @@use crate::chat_manager::ChatUserService;-use crate::local_ai::llm_chat::{LocalChatLLMChat, LocalLLMSetting};+use crate::entities::{ChatStatePB, ModelTypePB};+use crate::notification::{send_notification, ChatNotification};use crate::persistence::select_single_message;+use appflowy_local_ai::llm_chat::{LocalChatLLMChat, LocalLLMSetting};+use appflowy_plugin::error::PluginError;+use appflowy_plugin::util::is_apple_silicon;use flowy_chat_pub::cloud::{ChatCloudService, ChatMessage, ChatMessageType, CompletionType, MessageCursor,RepeatedChatMessage, RepeatedRelatedQuestion, StreamAnswer, StreamComplete,};use flowy_error::{FlowyError, FlowyResult};-use futures::{StreamExt, TryStreamExt};+use futures::{stream, StreamExt, TryStreamExt};use lib_infra::async_trait::async_trait;use lib_infra::future::FutureResult;use parking_lot::RwLock;@@ -31,6 +35,13 @@ impl ChatService {setup_local_chat(&local_llm_setting, local_llm_ctrl.clone());}+ let mut rx = local_llm_ctrl.subscribe_running_state();+ tokio::spawn(async move {+ while let Ok(state) = rx.recv().await {+ info!("[Chat Plugin] state: {:?}", state);+ }+ });+Self {user_service,cloud_service,@@ -92,6 +103,20 @@ impl ChatService {Ok(content)}++ fn handle_plugin_error(&self, err: PluginError) {+ if matches!(+ err,+ PluginError::PluginNotConnected | PluginError::PeerDisconnect+ ) {+ send_notification("appflowy_chat_plugin", ChatNotification::ChatStateUpdated).payload(+ ChatStatePB {+ model_type: ModelTypePB::LocalAI,+ available: false,+ },+ );+ }+ }}#[async_trait]@@ -137,12 +162,17 @@ impl ChatCloudService for ChatService {) -> Result<StreamAnswer, FlowyError> {if self.local_llm_setting.read().enabled {let content = self.get_message_content(message_id)?;- let stream = self- .local_llm_chat- .ask_question(chat_id, &content)- .await?- .map_err(FlowyError::from);- Ok(stream.boxed())+ match self.local_llm_chat.stream_question(chat_id, &content).await {+ Ok(stream) => Ok(+ stream+ .map_err(|err| FlowyError::local_ai().with_context(err))+ .boxed(),+ ),+ Err(err) => {+ self.handle_plugin_error(err);+ Ok(stream::once(async { Err(FlowyError::local_ai_unavailable()) }).boxed())+ },+ }} else {self.cloud_service@@ -159,11 +189,19 @@ impl ChatCloudService for ChatService {) -> Result<ChatMessage, FlowyError> {if self.local_llm_setting.read().enabled {let content = self.get_message_content(question_message_id)?;- let _answer = self- .local_llm_chat- .generate_answer(chat_id, &content)- .await?;- todo!()+ match self.local_llm_chat.ask_question(chat_id, &content).await {+ Ok(answer) => {+ let message = self+ .cloud_service+ .save_answer(workspace_id, chat_id, &answer, question_message_id)+ .await?;+ Ok(message)+ },+ Err(err) => {+ self.handle_plugin_error(err);+ Err(FlowyError::local_ai_unavailable())+ },+ }} else {self.cloud_service@@ -223,12 +261,35 @@ impl ChatCloudService for ChatService {fn setup_local_chat(local_llm_setting: &LocalLLMSetting, llm_chat_ctrl: Arc<LocalChatLLMChat>) {if local_llm_setting.enabled {- if let Ok(config) = local_llm_setting.chat_config() {+ if let Ok(mut config) = local_llm_setting.chat_config() {tokio::spawn(async move {trace!("[Chat Plugin] setup local chat: {:?}", config);+ if is_apple_silicon().await.unwrap_or(false) {+ config = config.with_device("gpu");+ }++ if cfg!(debug_assertions) {+ config = config.with_verbose(true);+ }- if let Err(err) = llm_chat_ctrl.init_chat_plugin(config).await {- error!("[Chat Plugin] failed to setup plugin: {:?}", err);+ match llm_chat_ctrl.init_chat_plugin(config).await {+ Ok(_) => {+ send_notification("appflowy_chat_plugin", ChatNotification::ChatStateUpdated).payload(+ ChatStatePB {+ model_type: ModelTypePB::LocalAI,+ available: true,+ },+ );+ },+ Err(err) => {+ send_notification("appflowy_chat_plugin", ChatNotification::ChatStateUpdated).payload(+ ChatStatePB {+ model_type: ModelTypePB::LocalAI,+ available: false,+ },+ );+ error!("[Chat Plugin] failed to setup plugin: {:?}", err);+ },}});}diff --git a/frontend/rust-lib/flowy-chat/src/middleware/mod.rs b/frontend/rust-lib/flowy-chat/src/middleware/mod.rsnew file mode 100644index 0000000000..0965215e71--- /dev/null+++ b/frontend/rust-lib/flowy-chat/src/middleware/mod.rs@@ -0,0 +1 @@+pub mod chat_service_mw;diff --git a/frontend/rust-lib/flowy-chat/src/notification.rs b/frontend/rust-lib/flowy-chat/src/notification.rsindex 12f0470784..10101027ae 100644--- a/frontend/rust-lib/flowy-chat/src/notification.rs+++ b/frontend/rust-lib/flowy-chat/src/notification.rs@@ -12,6 +12,7 @@ pub enum ChatNotification {DidReceiveChatMessage = 3,StreamChatMessageError = 4,FinishStreaming = 5,+ ChatStateUpdated = 6,}impl std::convert::From<ChatNotification> for i32 {@@ -27,6 +28,7 @@ impl std::convert::From<i32> for ChatNotification {3 => ChatNotification::DidReceiveChatMessage,4 => ChatNotification::StreamChatMessageError,5 => ChatNotification::FinishStreaming,+ 6 => ChatNotification::ChatStateUpdated,_ => ChatNotification::Unknown,}}diff --git a/frontend/rust-lib/flowy-chat/tests/chat_test/mod.rs b/frontend/rust-lib/flowy-chat/tests/chat_test/mod.rsdeleted file mode 100644index 2730bf96d5..0000000000--- a/frontend/rust-lib/flowy-chat/tests/chat_test/mod.rs+++ /dev/null@@ -1,41 +0,0 @@-use crate::util::LocalAITest;-use tokio_stream::StreamExt;--#[tokio::test]-async fn load_chat_model_test() {- if let Ok(test) = LocalAITest::new() {- let plugin_id = test.init_chat_plugin().await;- let chat_id = uuid::Uuid::new_v4().to_string();- let resp = test- .send_chat_message(&chat_id, plugin_id, "hello world")- .await;- eprintln!("chat response: {:?}", resp);-- let embedding_plugin_id = test.init_embedding_plugin().await;- let score = test.calculate_similarity(embedding_plugin_id, &resp, "Hello! How can I help you today? Is there something specific you would like to know or discuss").await;- assert!(score > 0.8);-- // let questions = test.related_question(&chat_id, plugin_id).await;- // assert_eq!(questions.len(), 3);- // eprintln!("related questions: {:?}", questions);- }-}-#[tokio::test]-async fn stream_local_model_test() {- if let Ok(test) = LocalAITest::new() {- let plugin_id = test.init_chat_plugin().await;- let chat_id = uuid::Uuid::new_v4().to_string();-- let mut resp = test- .stream_chat_message(&chat_id, plugin_id, "hello world")- .await;- let mut list = vec![];- while let Some(s) = resp.next().await {- list.push(String::from_utf8(s.unwrap().to_vec()).unwrap());- }-- let answer = list.join("");- eprintln!("chat response: {:?}", answer);- tokio::time::sleep(tokio::time::Duration::from_secs(5)).await;- }-}diff --git a/frontend/rust-lib/flowy-chat/tests/main.rs b/frontend/rust-lib/flowy-chat/tests/main.rsdeleted file mode 100644index 8a6b230211..0000000000--- a/frontend/rust-lib/flowy-chat/tests/main.rs+++ /dev/null@@ -1,2 +0,0 @@-pub mod chat_test;-pub mod util;diff --git a/frontend/rust-lib/flowy-chat/tests/util.rs b/frontend/rust-lib/flowy-chat/tests/util.rsdeleted file mode 100644index a1f9e51d1e..0000000000--- a/frontend/rust-lib/flowy-chat/tests/util.rs+++ /dev/null@@ -1,170 +0,0 @@-use anyhow::Result;-use bytes::Bytes;-use flowy_sidecar::manager::SidecarManager;-use serde_json::json;-use std::path::PathBuf;-use std::sync::Once;-use tokio_stream::wrappers::ReceiverStream;--use flowy_chat::local_ai::chat_plugin::ChatPluginOperation;-use flowy_chat::local_ai::embedding_plugin::EmbeddingPluginOperation;-use flowy_sidecar::core::plugin::{PluginId, PluginInfo};-use flowy_sidecar::error::SidecarError;-use tracing_subscriber::fmt::Subscriber;-use tracing_subscriber::util::SubscriberInitExt;-use tracing_subscriber::EnvFilter;--pub struct LocalAITest {- config: LocalAIConfiguration,- manager: SidecarManager,-}--impl LocalAITest {- pub fn new() -> Result<Self> {- let config = LocalAIConfiguration::new()?;- let manager = SidecarManager::new();-- Ok(Self { config, manager })- }- pub async fn init_chat_plugin(&self) -> PluginId {- let info = PluginInfo {- name: "chat".to_string(),- exec_path: self.config.chat_bin_path.clone(),- };- let plugin_id = self.manager.create_plugin(info).await.unwrap();- self- .manager- .init_plugin(- plugin_id,- json!({- "absolute_chat_model_path":self.config.chat_model_absolute_path(),- }),- )- .unwrap();-- plugin_id- }-- pub async fn init_embedding_plugin(&self) -> PluginId {- let info = PluginInfo {- name: "embedding".to_string(),- exec_path: self.config.embedding_bin_path.clone(),- };- let plugin_id = self.manager.create_plugin(info).await.unwrap();- let embedding_model_path = self.config.embedding_model_absolute_path();- self- .manager- .init_plugin(- plugin_id,- json!({- "absolute_model_path":embedding_model_path,- }),- )- .unwrap();- plugin_id- }-- pub async fn send_chat_message(- &self,- chat_id: &str,- plugin_id: PluginId,- message: &str,- ) -> String {- let plugin = self.manager.get_plugin(plugin_id).await.unwrap();- let operation = ChatPluginOperation::new(plugin);-- operation.send_message(chat_id, message).await.unwrap()- }-- pub async fn stream_chat_message(- &self,- chat_id: &str,- plugin_id: PluginId,- message: &str,- ) -> ReceiverStream<Result<Bytes, SidecarError>> {- let plugin = self.manager.get_plugin(plugin_id).await.unwrap();- let operation = ChatPluginOperation::new(plugin);- operation.stream_message(chat_id, message).await.unwrap()- }-- pub async fn related_question(- &self,- chat_id: &str,- plugin_id: PluginId,- ) -> Vec<serde_json::Value> {- let plugin = self.manager.get_plugin(plugin_id).await.unwrap();- let operation = ChatPluginOperation::new(plugin);-- operation.get_related_questions(chat_id).await.unwrap()- }-- pub async fn calculate_similarity(- &self,- plugin_id: PluginId,- message1: &str,- message2: &str,- ) -> f64 {- let plugin = self.manager.get_plugin(plugin_id).await.unwrap();- let operation = EmbeddingPluginOperation::new(plugin);- operation- .calculate_similarity(message1, message2)- .await- .unwrap()- }-}--pub struct LocalAIConfiguration {- model_dir: String,- chat_bin_path: PathBuf,- chat_model_name: String,- embedding_bin_path: PathBuf,- embedding_model_name: String,-}--impl LocalAIConfiguration {- pub fn new() -> Result<Self> {- dotenv::dotenv().ok();- setup_log();-- // load from .env- let model_dir = dotenv::var("LOCAL_AI_MODEL_DIR")?;- let chat_bin_path = PathBuf::from(dotenv::var("CHAT_BIN_PATH")?);- let chat_model_name = dotenv::var("LOCAL_AI_CHAT_MODEL_NAME")?;-- let embedding_bin_path = PathBuf::from(dotenv::var("EMBEDDING_BIN_PATH")?);- let embedding_model_name = dotenv::var("LOCAL_AI_EMBEDDING_MODEL_NAME")?;-- Ok(Self {- model_dir,- chat_bin_path,- chat_model_name,- embedding_bin_path,- embedding_model_name,- })- }-- pub fn chat_model_absolute_path(&self) -> String {- format!("{}/{}", self.model_dir, self.chat_model_name)- }-- pub fn embedding_model_absolute_path(&self) -> String {- format!("{}/{}", self.model_dir, self.embedding_model_name)- }-}--pub fn setup_log() {- static START: Once = Once::new();- START.call_once(|| {- let level = "trace";- let mut filters = vec![];- filters.push(format!("flowy_sidecar={}", level));- std::env::set_var("RUST_LOG", filters.join(","));-- let subscriber = Subscriber::builder()- .with_env_filter(EnvFilter::from_default_env())- .with_line_number(true)- .with_ansi(true)- .finish();- subscriber.try_init().unwrap();- });-}diff --git a/frontend/rust-lib/flowy-core/src/integrate/log.rs b/frontend/rust-lib/flowy-core/src/integrate/log.rsindex f980827428..18d3a6db86 100644--- a/frontend/rust-lib/flowy-core/src/integrate/log.rs+++ b/frontend/rust-lib/flowy-core/src/integrate/log.rs@@ -57,8 +57,8 @@ pub fn create_log_filter(filters.push(format!("lib_infra={}", level));filters.push(format!("flowy_search={}", level));filters.push(format!("flowy_chat={}", level));- filters.push(format!("flowy_chat={}", level));- filters.push(format!("flowy_sidecar={}", level));+ filters.push(format!("appflowy_local_ai={}", level));+ filters.push(format!("appflowy_plugin={}", level));filters.push(format!("flowy_ai={}", level));// Enable the frontend logs. DO NOT DISABLE.// These logs are essential for debugging and verifying frontend behavior.diff --git a/frontend/rust-lib/flowy-error/Cargo.toml b/frontend/rust-lib/flowy-error/Cargo.tomlindex 1699dadb7d..cb3864c93c 100644--- a/frontend/rust-lib/flowy-error/Cargo.toml+++ b/frontend/rust-lib/flowy-error/Cargo.toml@@ -33,7 +33,6 @@ collab-plugins = { workspace = true, optional = true }collab-folder = { workspace = true, optional = true }client-api = { workspace = true, optional = true }tantivy = { version = "0.21.1", optional = true }-flowy-sidecar = { workspace = true, optional = true }[features]impl_from_dispatch_error = ["lib-dispatch"]@@ -49,7 +48,6 @@ impl_from_collab_folder = ["collab-folder"]impl_from_collab_database = ["collab-database"]impl_from_url = ["url"]impl_from_tantivy = ["tantivy"]-impl_from_sidecar = ["flowy-sidecar"]impl_from_sqlite = ["flowy-sqlite", "r2d2"]impl_from_appflowy_cloud = ["client-api"]diff --git a/frontend/rust-lib/flowy-error/src/code.rs b/frontend/rust-lib/flowy-error/src/code.rsindex b6b557b80c..c36c5df211 100644--- a/frontend/rust-lib/flowy-error/src/code.rs+++ b/frontend/rust-lib/flowy-error/src/code.rs@@ -283,6 +283,9 @@ pub enum ErrorCode {#[error("Local AI error")]LocalAIError = 98,++ #[error("Local AI unavailable")]+ LocalAIUnavailable = 99,}impl ErrorCode {diff --git a/frontend/rust-lib/flowy-error/src/errors.rs b/frontend/rust-lib/flowy-error/src/errors.rsindex 2cd5ef7dd0..e7c6f5a9a6 100644--- a/frontend/rust-lib/flowy-error/src/errors.rs+++ b/frontend/rust-lib/flowy-error/src/errors.rs@@ -119,6 +119,7 @@ impl FlowyError {);static_flowy_error!(workspace_data_not_match, ErrorCode::WorkspaceDataNotMatch);static_flowy_error!(local_ai, ErrorCode::LocalAIError);+ static_flowy_error!(local_ai_unavailable, ErrorCode::LocalAIUnavailable);}impl std::convert::From<ErrorCode> for FlowyError {diff --git a/frontend/rust-lib/flowy-error/src/impl_from/mod.rs b/frontend/rust-lib/flowy-error/src/impl_from/mod.rsindex 769aeacbb4..b3d0351cd4 100644--- a/frontend/rust-lib/flowy-error/src/impl_from/mod.rs+++ b/frontend/rust-lib/flowy-error/src/impl_from/mod.rs@@ -25,7 +25,5 @@ mod cloud;#[cfg(feature = "impl_from_url")]mod url;-#[cfg(feature = "impl_from_sidecar")]-mod sidecar;#[cfg(feature = "impl_from_tantivy")]mod tantivy;diff --git a/frontend/rust-lib/flowy-error/src/impl_from/sidecar.rs b/frontend/rust-lib/flowy-error/src/impl_from/sidecar.rsdeleted file mode 100644index 719d5becbf..0000000000--- a/frontend/rust-lib/flowy-error/src/impl_from/sidecar.rs+++ /dev/null@@ -1,8 +0,0 @@-use crate::{ErrorCode, FlowyError};-use flowy_sidecar::error::SidecarError;--impl std::convert::From<SidecarError> for FlowyError {- fn from(error: SidecarError) -> Self {- FlowyError::new(ErrorCode::LocalAIError, error)- }-}diff --git a/frontend/rust-lib/flowy-sidecar/Cargo.toml b/frontend/rust-lib/flowy-sidecar/Cargo.tomldeleted file mode 100644index 0c7ad87141..0000000000--- a/frontend/rust-lib/flowy-sidecar/Cargo.toml+++ /dev/null@@ -1,23 +0,0 @@-[package]-name = "flowy-sidecar"-version = "0.1.0"-edition = "2021"--# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html--[dependencies]-anyhow = { version = "1.0" }-serde = { version = "1.0", features = ["derive"] }-tokio = { version = "1.0", features = ["full"] }-once_cell = "1.19.0"-thiserror = "1.0"-serde_json = "1.0.117"-tracing.workspace = true-crossbeam-utils = "0.8.20"-log = "0.4.21"-parking_lot.workspace = true-tokio-stream = "0.1.15"-lib-infra.workspace = true--[features]-verbose = []\ No newline at end of filediff --git a/frontend/rust-lib/flowy-sidecar/src/core/mod.rs b/frontend/rust-lib/flowy-sidecar/src/core/mod.rsdeleted file mode 100644index cc28539a86..0000000000--- a/frontend/rust-lib/flowy-sidecar/src/core/mod.rs+++ /dev/null@@ -1,5 +0,0 @@-pub mod parser;-pub mod plugin;-pub mod rpc_loop;-mod rpc_object;-pub mod rpc_peer;diff --git a/frontend/rust-lib/flowy-sidecar/src/core/parser.rs b/frontend/rust-lib/flowy-sidecar/src/core/parser.rsdeleted file mode 100644index 18c6d86fef..0000000000--- a/frontend/rust-lib/flowy-sidecar/src/core/parser.rs+++ /dev/null@@ -1,71 +0,0 @@-use crate::core::rpc_object::RpcObject;--use crate::error::{ReadError, RemoteError};-use serde_json::{json, Value as JsonValue};-use std::io::BufRead;--#[derive(Debug, Default)]-pub struct MessageReader(String);--impl MessageReader {- /// Attempts to read the next line from the stream and parse it as- /// an RPC object.- ///- /// # Errors- ///- /// This function will return an error if there is an underlying- /// I/O error, if the stream is closed, or if the message is not- /// a valid JSON object.- pub fn next<R: BufRead>(&mut self, reader: &mut R) -> Result<RpcObject, ReadError> {- self.0.clear();- let _ = reader.read_line(&mut self.0)?;- if self.0.is_empty() {- Err(ReadError::Disconnect)- } else {- self.parse(&self.0)- }- }-- /// Attempts to parse a &str as an RPC Object.- ///- /// This should not be called directly unless you are writing tests.- #[doc(hidden)]- pub fn parse(&self, s: &str) -> Result<RpcObject, ReadError> {- match serde_json::from_str::<JsonValue>(s) {- Ok(val) => {- if !val.is_object() {- Err(ReadError::NotObject(s.to_string()))- } else {- Ok(val.into())- }- },- Err(_) => Ok(RpcObject(json!({"message": s.to_string()}))),- }- }-}--pub type RequestId = u64;-#[derive(Debug, Clone)]-/// An RPC call, which may be either a notification or a request.-pub enum Call<R> {- Message(JsonValue),- /// An id and an RPC Request- Request(RequestId, R),- /// A malformed request: the request contained an id, but could- /// not be parsed. The client will receive an error.- InvalidRequest(RequestId, RemoteError),-}--pub trait ResponseParser {- type ValueType: Send + Sync + 'static;- fn parse_json(payload: JsonValue) -> Result<Self::ValueType, RemoteError>;-}--pub struct DefaultResponseParser;-impl ResponseParser for DefaultResponseParser {- type ValueType = ();-- fn parse_json(_payload: JsonValue) -> Result<Self::ValueType, RemoteError> {- Ok(())- }-}diff --git a/frontend/rust-lib/flowy-sidecar/src/core/plugin.rs b/frontend/rust-lib/flowy-sidecar/src/core/plugin.rsdeleted file mode 100644index 81e7a8139a..0000000000--- a/frontend/rust-lib/flowy-sidecar/src/core/plugin.rs+++ /dev/null@@ -1,205 +0,0 @@-use crate::error::SidecarError;-use crate::manager::WeakSidecarState;-use std::fmt::{Display, Formatter};--use crate::core::parser::ResponseParser;-use crate::core::rpc_loop::RpcLoop;-use crate::core::rpc_peer::{CloneableCallback, OneShotCallback};-use anyhow::anyhow;-use serde::{Deserialize, Serialize};-use serde_json::{json, Value as JsonValue};-use std::io::BufReader;-use std::path::PathBuf;-use std::process::{Child, Stdio};-use std::sync::Arc;-use std::thread;-use std::time::Instant;-use tokio_stream::wrappers::ReceiverStream;--use tracing::{error, info};--#[derive(- Default, Debug, Clone, Copy, Hash, PartialEq, Eq, PartialOrd, Ord, Serialize, Deserialize,-)]-pub struct PluginId(pub(crate) i64);--impl From<i64> for PluginId {- fn from(id: i64) -> Self {- PluginId(id)- }-}--/// The `Peer` trait defines the interface for the opposite side of the RPC channel,-/// designed to be used behind a pointer or as a trait object.-pub trait Peer: Send + Sync + 'static {- /// Clones the peer into a boxed trait object.- fn box_clone(&self) -> Arc<dyn Peer>;-- /// Sends an RPC notification to the peer with the specified method and parameters.- fn send_rpc_notification(&self, method: &str, params: &JsonValue);-- fn stream_rpc_request(&self, method: &str, params: &JsonValue, f: CloneableCallback);-- fn async_send_rpc_request(&self, method: &str, params: &JsonValue, f: Box<dyn OneShotCallback>);- /// Sends a synchronous RPC request to the peer and waits for the result.- /// Returns the result of the request or an error.- fn send_rpc_request(&self, method: &str, params: &JsonValue) -> Result<JsonValue, SidecarError>;-- /// Checks if there is an incoming request pending, intended to reduce latency for bulk operations done in the background.- fn request_is_pending(&self) -> bool;-- /// Schedules a timer to execute the handler's `idle` function after the specified `Instant`.- /// Note: This is not a high-fidelity timer. Regular RPC messages will always take priority over idle tasks.- fn schedule_timer(&self, after: Instant, token: usize);-}--/// The `Peer` trait object.-pub type RpcPeer = Arc<dyn Peer>;--pub struct RpcCtx {- pub peer: RpcPeer,-}--#[derive(Clone)]-pub struct Plugin {- peer: RpcPeer,- pub(crate) id: PluginId,- pub(crate) name: String,- #[allow(dead_code)]- pub(crate) process: Arc<Child>,-}--impl Display for Plugin {- fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {- write!(- f,- "{}, plugin id: {:?}, process id: {}",- self.name,- self.id,- self.process.id()- )- }-}--impl Plugin {- pub fn initialize(&self, value: JsonValue) -> Result<(), SidecarError> {- self.peer.send_rpc_request("initialize", &value)?;- Ok(())- }-- pub fn request(&self, method: &str, params: &JsonValue) -> Result<JsonValue, SidecarError> {- self.peer.send_rpc_request(method, params)- }-- pub async fn async_request<P: ResponseParser>(- &self,- method: &str,- params: &JsonValue,- ) -> Result<P::ValueType, SidecarError> {- let (tx, rx) = tokio::sync::oneshot::channel();- self.peer.async_send_rpc_request(- method,- params,- Box::new(move |result| {- let _ = tx.send(result);- }),- );- let value = rx.await.map_err(|err| {- SidecarError::Internal(anyhow!("error waiting for async response: {:?}", err))- })??;- let value = P::parse_json(value)?;- Ok(value)- }-- pub fn stream_request<P: ResponseParser>(- &self,- method: &str,- params: &JsonValue,- ) -> Result<ReceiverStream<Result<P::ValueType, SidecarError>>, SidecarError> {- let (tx, stream) = tokio::sync::mpsc::channel(100);- let stream = ReceiverStream::new(stream);- let callback = CloneableCallback::new(move |result| match result {- Ok(json) => {- let result = P::parse_json(json).map_err(SidecarError::from);- let _ = tx.blocking_send(result);- },- Err(err) => {- let _ = tx.blocking_send(Err(err));- },- });- self.peer.stream_rpc_request(method, params, callback);- Ok(stream)- }-- pub fn shutdown(&self) {- match self.peer.send_rpc_request("shutdown", &json!({})) {- Ok(_) => {- info!("shutting down plugin {}", self);- },- Err(err) => {- error!("error sending shutdown to plugin {}: {:?}", self, err);- },- }- }-}--pub struct PluginInfo {- pub name: String,- pub exec_path: PathBuf,-}--pub(crate) async fn start_plugin_process(- plugin_info: PluginInfo,- id: PluginId,- state: WeakSidecarState,-) -> Result<(), anyhow::Error> {- let (tx, rx) = tokio::sync::oneshot::channel();- let spawn_result = thread::Builder::new()- .name(format!("<{}> core host thread", &plugin_info.name))- .spawn(move || {- info!("Load {} plugin", &plugin_info.name);- let child = std::process::Command::new(&plugin_info.exec_path)- .stdin(Stdio::piped())- .stdout(Stdio::piped())- .spawn();-- match child {- Ok(mut child) => {- let child_stdin = child.stdin.take().unwrap();- let child_stdout = child.stdout.take().unwrap();- let mut looper = RpcLoop::new(child_stdin);- let peer: RpcPeer = Arc::new(looper.get_raw_peer());- let name = plugin_info.name.clone();- peer.send_rpc_notification("ping", &JsonValue::Array(Vec::new()));-- let plugin = Plugin {- peer,- process: Arc::new(child),- name,- id,- };-- state.plugin_connect(Ok(plugin));- let _ = tx.send(());- let mut state = state;- let err = looper.mainloop(- &plugin_info.name,- || BufReader::new(child_stdout),- &mut state,- );- state.plugin_exit(id, err);- },- Err(err) => {- let _ = tx.send(());- state.plugin_connect(Err(err))- },- }- });-- if let Err(err) = spawn_result {- error!("[RPC] thread spawn failed for {:?}, {:?}", id, err);- return Err(err.into());- }- rx.await?;- Ok(())-}diff --git a/frontend/rust-lib/flowy-sidecar/src/core/rpc_loop.rs b/frontend/rust-lib/flowy-sidecar/src/core/rpc_loop.rsdeleted file mode 100644index e0a1f66402..0000000000--- a/frontend/rust-lib/flowy-sidecar/src/core/rpc_loop.rs+++ /dev/null@@ -1,269 +0,0 @@-use crate::core::parser::{Call, MessageReader};-use crate::core::plugin::RpcCtx;-use crate::core::rpc_object::RpcObject;-use crate::core::rpc_peer::{RawPeer, ResponsePayload, RpcState};-use crate::error::{ReadError, RemoteError, SidecarError};-use serde::de::DeserializeOwned;--use std::io::{BufRead, Write};-use std::sync::Arc;-use std::thread;-use std::time::Duration;-use tracing::{error, trace};--const MAX_IDLE_WAIT: Duration = Duration::from_millis(5);--pub trait Handler {- type Request: DeserializeOwned;- fn handle_request(- &mut self,- ctx: &RpcCtx,- rpc: Self::Request,- ) -> Result<ResponsePayload, RemoteError>;- #[allow(unused_variables)]- fn idle(&mut self, ctx: &RpcCtx, token: usize) {}-}--/// A helper type which shuts down the runloop if a panic occurs while-/// handling an RPC.-struct PanicGuard<'a, W: Write + 'static>(&'a RawPeer<W>);--impl<'a, W: Write + 'static> Drop for PanicGuard<'a, W> {- /// Implements the cleanup behavior when the guard is dropped.- ///- /// This method is automatically called when the `PanicGuard` goes out of scope.- /// It checks if a panic is occurring and, if so, logs an error message and- /// disconnects the peer.- fn drop(&mut self) {- // - If no panic is occurring, this method does nothing.- // - If a panic is detected:- // 1. An error message is logged.- // 2. The `disconnect()` method is called on the peer.- if thread::panicking() {- error!("[RPC] panic guard hit, closing run loop");- self.0.disconnect();- }- }-}--/// A structure holding the state of a main loop for handling RPC's.-pub struct RpcLoop<W: Write + 'static> {- reader: MessageReader,- peer: RawPeer<W>,-}--impl<W: Write + Send> RpcLoop<W> {- /// Creates a new `RpcLoop` with the given output stream (which is used for- /// sending requests and notifications, as well as responses).- pub fn new(writer: W) -> Self {- let rpc_peer = RawPeer(Arc::new(RpcState::new(writer)));- RpcLoop {- reader: MessageReader::default(),- peer: rpc_peer,- }- }-- /// Gets a reference to the peer.- pub fn get_raw_peer(&self) -> RawPeer<W> {- self.peer.clone()- }-- /// Starts the event loop, reading lines from the reader until EOF or an error occurs.- ///- /// Returns `Ok()` if EOF is reached, otherwise returns the underlying `ReadError`.- ///- /// # Note:- /// The reader is provided via a closure to avoid needing `Send`. The main loop runs on a separate I/O thread that calls this closure at startup.- /// Calls to the handler occur on the caller's thread and maintain the order from the channel. Currently, there can only be one outstanding incoming request.-- /// Starts and manages the main event loop for processing RPC messages.- ///- /// This function is the core of the RPC system, handling incoming messages,- /// dispatching requests to the appropriate handler, and managing the overall- /// lifecycle of the RPC communication.- ///- /// # Arguments- ///- /// * `&mut self` - A mutable reference to the `RpcLoop` instance.- /// * `_plugin_name: &str` - The name of the plugin (currently unused in the function body).- /// * `buffer_read_fn: BufferReadFn` - A closure that returns a `BufRead` instance for reading input.- /// * `handler: &mut H` - A mutable reference to the handler implementing the `Handler` trait.- ///- /// # Type Parameters- ///- /// * `R: BufRead` - The type returned by `buffer_read_fn`, must implement `BufRead`.- /// * `BufferReadFn: Send + FnOnce() -> R` - The type of the closure that provides the input reader.- /// * `H: Handler` - The type of the handler, must implement the `Handler` trait.- ///- /// # Returns- ///- /// * `Result<(), ReadError>` - Returns `Ok(())` if the loop exits normally (EOF),- /// or an error if an unrecoverable error occurs.- ///- /// # Behavior- ///- /// 1. Creates a new `RpcCtx` with a clone of the `RawPeer`.- /// 2. Spawns a separate thread for reading input using `crossbeam_utils::thread::scope`.- /// 3. In the reading thread:- /// - Continuously reads and parses JSON messages from the input.- /// - Handles responses by calling `handle_response` on the peer.- /// - Puts other messages into the peer's queue using `put_rpc_object`.- /// 4. In the main thread:- /// - Retrieves messages using `next_read`.- /// - Processes requests by calling the handler's `handle_request` method.- /// - Sends responses back using the peer's `respond` method.- /// 5. Continues looping until an error occurs or the peer is disconnected.- pub fn mainloop<R, BufferReadFn, H>(- &mut self,- _plugin_name: &str,- buffer_read_fn: BufferReadFn,- handler: &mut H,- ) -> Result<(), ReadError>- where- R: BufRead,- BufferReadFn: Send + FnOnce() -> R,- H: Handler,- {- // uses `crossbeam_utils::thread::scope` for thread management,- // which offers several advantages over `std::thread`:- // 1. Scoped Threads: Guarantees thread termination when the scope ends,- // preventing resource leaks.- // 2. Simplified Lifetime Management: Allows threads to borrow data from- // their parent stack frame, enabling more ergonomic code.- // 3. Improved Safety: Prevents threads from outliving the data they operate on,- // reducing risks of data races and use-after-free errors.- // 4. Efficiency: Potentially more efficient due to known thread lifetimes,- // leading to better resource management.- // 5. Error Propagation: Simplifies propagating errors from spawned threads- // back to the parent thread.- // 6. Consistency with Rust's Ownership Model: Aligns well with Rust's- // ownership and borrowing rules.- // 7. Automatic Thread Joining: No need for manual thread joining, reducing- // the risk of thread management errors.- let exit = crossbeam_utils::thread::scope(|scope| {- let peer = self.get_raw_peer();- peer.reset_needs_exit();-- let ctx = RpcCtx {- peer: Arc::new(peer.clone()),- };-- // 1. Spawn a new thread for reading data from a stream.- // 2. Continuously read data from the stream.- // 3. Parse the data as JSON.- // 4. Handle the JSON data as either a response or another type of JSON object.- // 5. Manage errors and connection status.- scope.spawn(move |_| {- let mut stream = buffer_read_fn();- loop {- if self.peer.needs_exit() {- trace!("read loop exit");- break;- }- let json = match self.reader.next(&mut stream) {- Ok(json) => json,- Err(err) => {- if self.peer.0.is_blocking() {- self.peer.disconnect();- }- self.peer.put_rpc_object(Err(err));- break;- },- };- if json.is_response() {- let request_id = json.get_id().unwrap();- match json.into_response() {- Ok(resp) => {- let resp = resp.map_err(SidecarError::from);- self.peer.handle_response(request_id, resp);- },- Err(msg) => {- error!("[RPC] failed to parse response: {}", msg);- self- .peer- .handle_response(request_id, Err(SidecarError::InvalidResponse));- },- }- } else {- self.peer.put_rpc_object(Ok(json));- }- }- });-- // Main processing loop- loop {- // `PanicGuard` is a critical safety mechanism in the RPC system. It's designed to detect- // panics that occur during RPC request handling and ensure that the system shuts down- // gracefully, preventing resource leaks and maintaining system integrity.- //- let _guard = PanicGuard(&peer);- let read_result = next_read(&peer, &ctx);- let json = match read_result {- Ok(json) => json,- Err(err) => {- peer.disconnect();- return err;- },- };-- match json.into_rpc::<H::Request>() {- Ok(Call::Request(id, cmd)) => {- // Handle request sent from the client. For example from python executable.- trace!("[RPC] received request: {}", id);- let result = handler.handle_request(&ctx, cmd);- peer.respond(result, id);- },- Ok(Call::InvalidRequest(id, err)) => {- trace!("[RPC] received invalid request: {}", id);- peer.respond(Err(err), id)- },- Err(err) => {- error!("[RPC] error parsing message: {:?}", err);- peer.disconnect();- return ReadError::UnknownRequest(err);- },- Ok(Call::Message(_msg)) => {- #[cfg(feature = "verbose")]- trace!("[RPC {}]: {}", _plugin_name, _msg);- },- }- }- })- .unwrap();-- if exit.is_disconnect() {- Ok(())- } else {- Err(exit)- }- }-}--/// retrieves the next available read result from a peer, performing idle work if no result is-/// immediately available.-fn next_read<W>(peer: &RawPeer<W>, _ctx: &RpcCtx) -> Result<RpcObject, ReadError>-where- W: Write + Send,-{- loop {- // Continuously checks if there is a result available from the peer using- if let Some(result) = peer.try_get_rx() {- return result;- }-- let time_to_next_timer = match peer.check_timers() {- Some(Ok(_token)) => continue,- Some(Err(duration)) => Some(duration),- None => None,- };-- // Ensures the function does not block indefinitely by setting a maximum wait time- let idle_timeout = time_to_next_timer- .unwrap_or(MAX_IDLE_WAIT)- .min(MAX_IDLE_WAIT);-- if let Some(result) = peer.get_rx_timeout(idle_timeout) {- return result;- }- }-}diff --git a/frontend/rust-lib/flowy-sidecar/src/core/rpc_object.rs b/frontend/rust-lib/flowy-sidecar/src/core/rpc_object.rsdeleted file mode 100644index 7f4e46864c..0000000000--- a/frontend/rust-lib/flowy-sidecar/src/core/rpc_object.rs+++ /dev/null@@ -1,111 +0,0 @@-use crate::core::parser::{Call, RequestId};-use crate::core::rpc_peer::{Response, ResponsePayload};--use serde::de::{DeserializeOwned, Error};-use serde_json::Value;--#[derive(Debug, Clone)]-pub struct RpcObject(pub Value);--impl RpcObject {- /// Returns the 'id' of the underlying object, if present.- pub fn get_id(&self) -> Option<RequestId> {- self.0.get("id").and_then(Value::as_u64)- }-- /// Returns the 'method' field of the underlying object, if present.- pub fn get_method(&self) -> Option<&str> {- self.0.get("method").and_then(Value::as_str)- }-- /// Returns `true` if this object looks like an RPC response;- /// that is, if it has an 'id' field and does _not_ have a 'method'- /// field.- pub fn is_response(&self) -> bool {- self.0.get("id").is_some() && self.0.get("method").is_none()- }-- /// Converts a JSON-RPC response into a structured `Response` object.- ///- /// This function validates and parses a JSON-RPC response, ensuring it contains the necessary fields,- /// and then transforms it into a structured `Response` object. The response must contain either a- /// "result" or an "error" field, but not both. If the response contains a "result" field, it may also- /// include streaming data, indicated by a nested "stream" field.- ///- /// # Errors- ///- /// This function will return an error if:- /// - The "id" field is missing.- /// - The response contains both "result" and "error" fields, or neither.- /// - The "stream" field within the "result" is missing "type" or "data" fields.- /// - The "stream" type is invalid (i.e., not "streaming" or "end").- ///- /// # Returns- ///- /// - `Ok(Ok(ResponsePayload::Json(result)))`: If the response contains a valid "result".- /// - `Ok(Ok(ResponsePayload::Streaming(data)))`: If the response contains streaming data of type "streaming".- /// - `Ok(Ok(ResponsePayload::StreamEnd(json!({}))))`: If the response contains streaming data of type "end".- /// - `Err(String)`: If any validation or parsing errors occur.- ///.- pub fn into_response(mut self) -> Result<Response, String> {- // Ensure 'id' field is present- self- .get_id()- .ok_or_else(|| "Response requires 'id' field.".to_string())?;-- // Ensure the response contains exactly one of 'result' or 'error'- let has_result = self.0.get("result").is_some();- let has_error = self.0.get("error").is_some();- if has_result == has_error {- return Err("RPC response must contain exactly one of 'error' or 'result' fields.".into());- }-- // Handle the 'result' field if present- if let Some(mut result) = self.0.as_object_mut().and_then(|obj| obj.remove("result")) {- if let Some(mut stream) = result.as_object_mut().and_then(|obj| obj.remove("stream")) {- if let Some((has_more, data)) = stream.as_object_mut().and_then(|obj| {- let has_more = obj.remove("has_more")?.as_bool().unwrap_or(false);- let data = obj.remove("data")?;- Some((has_more, data))- }) {- return match has_more {- true => Ok(Ok(ResponsePayload::Streaming(data))),- false => Ok(Ok(ResponsePayload::StreamEnd(data))),- };- } else {- return Err("Stream response must contain 'type' and 'data' fields.".into());- }- }-- Ok(Ok(ResponsePayload::Json(result)))- } else {- // Handle the 'error' field- let error = self.0.as_object_mut().unwrap().remove("error").unwrap();- Err(format!("Error handling response: {:?}", error))- }- }-- /// Converts the underlying `Value` into either an RPC notification or request.- pub fn into_rpc<R>(self) -> Result<Call<R>, serde_json::Error>- where- R: DeserializeOwned,- {- let id = self.get_id();- match id {- Some(id) => match serde_json::from_value::<R>(self.0) {- Ok(resp) => Ok(Call::Request(id, resp)),- Err(err) => Ok(Call::InvalidRequest(id, err.into())),- },- None => match self.0.get("message").and_then(|value| value.as_str()) {- None => Err(serde_json::Error::missing_field("message")),- Some(s) => Ok(Call::Message(s.to_string().into())),- },- }- }-}--impl From<Value> for RpcObject {- fn from(v: Value) -> RpcObject {- RpcObject(v)- }-}diff --git a/frontend/rust-lib/flowy-sidecar/src/core/rpc_peer.rs b/frontend/rust-lib/flowy-sidecar/src/core/rpc_peer.rsdeleted file mode 100644index db53362615..0000000000--- a/frontend/rust-lib/flowy-sidecar/src/core/rpc_peer.rs+++ /dev/null@@ -1,500 +0,0 @@-use crate::core::plugin::{Peer, PluginId};-use crate::core::rpc_object::RpcObject;-use crate::error::{ReadError, RemoteError, SidecarError};-use parking_lot::{Condvar, Mutex};-use serde::{de, ser, Deserialize, Deserializer, Serialize, Serializer};-use serde_json::{json, Value as JsonValue};-use std::collections::{BTreeMap, BinaryHeap, VecDeque};-use std::fmt::Display;-use std::io::Write;--use std::sync::atomic::{AtomicBool, AtomicUsize, Ordering};-use std::sync::{mpsc, Arc};-use std::time::{Duration, Instant};-use std::{cmp, io};-use tokio_stream::Stream;-use tracing::{error, trace, warn};--pub struct PluginCommand<T> {- pub plugin_id: PluginId,- pub cmd: T,-}--impl<T: Serialize> Serialize for PluginCommand<T> {- fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>- where- S: Serializer,- {- let mut v = serde_json::to_value(&self.cmd).map_err(ser::Error::custom)?;- v["params"]["plugin_id"] = json!(self.plugin_id);- v.serialize(serializer)- }-}--impl<'de, T: Deserialize<'de>> Deserialize<'de> for PluginCommand<T> {- fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>- where- D: Deserializer<'de>,- {- #[derive(Deserialize)]- struct PluginIdHelper {- plugin_id: PluginId,- }- let v = JsonValue::deserialize(deserializer)?;- let plugin_id = PluginIdHelper::deserialize(&v)- .map_err(de::Error::custom)?- .plugin_id;- let cmd = T::deserialize(v).map_err(de::Error::custom)?;- Ok(PluginCommand { plugin_id, cmd })- }-}--pub struct RpcState<W: Write> {- rx_queue: Mutex<VecDeque<Result<RpcObject, ReadError>>>,- rx_cvar: Condvar,- writer: Mutex<W>,- id: AtomicUsize,- pending: Mutex<BTreeMap<usize, ResponseHandler>>,- timers: Mutex<BinaryHeap<Timer>>,- needs_exit: AtomicBool,- is_blocking: AtomicBool,-}--impl<W: Write> RpcState<W> {- /// Creates a new `RawPeer` instance.- ///- /// # Arguments- ///- /// * `writer` - An object implementing the `Write` trait, used for sending messages.- ///- /// # Returns- ///- /// A new `RawPeer` instance wrapped in an `Arc`.- pub fn new(writer: W) -> Self {- RpcState {- rx_queue: Mutex::new(VecDeque::new()),- rx_cvar: Condvar::new(),- writer: Mutex::new(writer),- id: AtomicUsize::new(0),- pending: Mutex::new(BTreeMap::new()),- timers: Mutex::new(BinaryHeap::new()),- needs_exit: AtomicBool::new(false),- is_blocking: Default::default(),- }- }-- pub fn is_blocking(&self) -> bool {- self.is_blocking.load(Ordering::Acquire)- }-}--pub struct RawPeer<W: Write + 'static>(pub(crate) Arc<RpcState<W>>);--impl<W: Write + Send + 'static> Peer for RawPeer<W> {- fn box_clone(&self) -> Arc<dyn Peer> {- Arc::new((*self).clone())- }- fn send_rpc_notification(&self, method: &str, params: &JsonValue) {- if let Err(e) = self.send(&json!({- "method": method,- "params": params,- })) {- error!(- "send error on send_rpc_notification method {}: {}",- method, e- );- }- }-- fn stream_rpc_request(&self, method: &str, params: &JsonValue, f: CloneableCallback) {- self.send_rpc(method, params, ResponseHandler::StreamCallback(Arc::new(f)));- }-- fn async_send_rpc_request(&self, method: &str, params: &JsonValue, f: Box<dyn OneShotCallback>) {- self.send_rpc(method, params, ResponseHandler::Callback(f));- }-- fn send_rpc_request(&self, method: &str, params: &JsonValue) -> Result<JsonValue, SidecarError> {- let (tx, rx) = mpsc::channel();- self.0.is_blocking.store(true, Ordering::Release);- self.send_rpc(method, params, ResponseHandler::Chan(tx));- rx.recv().unwrap_or(Err(SidecarError::PeerDisconnect))- }-- fn request_is_pending(&self) -> bool {- let queue = self.0.rx_queue.lock();- !queue.is_empty()- }-- fn schedule_timer(&self, after: Instant, token: usize) {- self.0.timers.lock().push(Timer {- fire_after: after,- token,- });- }-}--impl<W: Write> RawPeer<W> {- /// Sends a JSON value to the peer.- ///- /// # Arguments- ///- /// * `json` - A reference to a `JsonValue` to be sent.- ///- /// # Returns- ///- /// A `Result` indicating success or an `io::Error` if the write operation fails.- ///- /// # Notes- ///- /// This function serializes the JSON value, appends a newline, and writes it to the underlying writer.- fn send(&self, json: &JsonValue) -> Result<(), io::Error> {- let mut s = serde_json::to_string(json).unwrap();- s.push('\n');- self.0.writer.lock().write_all(s.as_bytes())- }-- /// Sends a response to a previous RPC request.- ///- /// # Arguments- ///- /// * `result` - The `Response` to be sent.- /// * `id` - The ID of the request being responded to.- ///- /// # Notes- ///- /// This function constructs a JSON response and sends it using the `send` method.- /// It handles both successful results and errors.- pub(crate) fn respond(&self, result: Response, id: u64) {- let mut response = json!({ "id": id });- match result {- Ok(result) => match result {- ResponsePayload::Json(value) => response["result"] = value,- ResponsePayload::Streaming(_) | ResponsePayload::StreamEnd(_) => {- error!("stream response not supported")- },- },- Err(error) => response["error"] = json!(error),- };- if let Err(e) = self.send(&response) {- error!("[RPC] error {} sending response to RPC {:?}", e, id);- }- }-- /// Sends an RPC request.- ///- /// # Arguments- ///- /// * `method` - The name of the RPC method to be called.- /// * `params` - The parameters for the RPC call.- /// * `response_handler` - A `ResponseHandler` to handle the response.- ///- /// # Notes- ///- /// This function generates a unique ID for the request, stores the response handler,- /// and sends the RPC request. If sending fails, it immediately invokes the response handler with an error.- fn send_rpc(&self, method: &str, params: &JsonValue, response_handler: ResponseHandler) {- trace!("[RPC] call method: {} params: {:?}", method, params);- let id = self.0.id.fetch_add(1, Ordering::Relaxed);- {- let mut pending = self.0.pending.lock();- pending.insert(id, response_handler);- }-- // Call the ResponseHandler if the send fails. Otherwise, the response will be- // called in handle_response.- if let Err(e) = self.send(&json!({- "id": id,- "method": method,- "params": params,- })) {- let mut pending = self.0.pending.lock();- if let Some(rh) = pending.remove(&id) {- rh.invoke(Err(SidecarError::Io(e)));- }- }- }-- /// Processes an incoming response to an RPC request.- ///- /// This function is responsible for handling responses received from the peer, matching them- /// to their corresponding requests, and invoking the appropriate callbacks. It supports both- /// one-time responses and streaming responses.- ///- /// # Arguments- ///- /// * `&self` - A reference to the `RawPeer` instance.- /// * `request_id: u64` - The unique identifier of the request to which this is a response.- /// * `resp: Result<ResponsePayload, SidecarError>` - The response payload or an error.- ///- /// # Behavior- ///- /// 1. Retrieves and removes the response handler for the given `request_id` from the pending requests.- /// 2. Determines if the response is part of a stream.- /// 3. For streaming responses:- /// - If it's not the end of the stream, re-inserts the stream callback for future messages.- /// - If it's the end of the stream, logs this information.- /// 4. Converts the response payload to JSON.- /// 5. Invokes the response handler with the JSON data or error.- ///- /// # Concurrency- ///- /// This function uses mutex locks to ensure thread-safe access to shared data structures.- /// It's designed to be called from multiple threads safely.- ///- /// # Error Handling- ///- /// - If no handler is found for the `request_id`, an error is logged.- /// - If a non-stream response payload is `None`, a warning is logged.- /// - Errors in the response are propagated to the response handler.- pub(crate) fn handle_response(- &self,- request_id: u64,- resp: Result<ResponsePayload, SidecarError>,- ) {- let request_id = request_id as usize;- let handler = {- let mut pending = self.0.pending.lock();- pending.remove(&request_id)- };- let is_stream = resp.as_ref().map(|resp| resp.is_stream()).unwrap_or(false);- match handler {- Some(response_handler) => {- if is_stream {- let is_stream_end = resp- .as_ref()- .map(|resp| resp.is_stream_end())- .unwrap_or(false);- if !is_stream_end {- // when steam is not end, we need to put the stream callback back to pending in order to- // receive the next stream message.- if let Some(callback) = response_handler.get_stream_callback() {- let mut pending = self.0.pending.lock();- pending.insert(request_id, ResponseHandler::StreamCallback(callback));- }- } else {- trace!("[RPC] {} stream end", request_id);- }- }- let json = resp.map(|resp| resp.into_json());- match json {- Ok(Some(json)) => {- response_handler.invoke(Ok(json));- },- Ok(None) => {- if !is_stream {- warn!("[RPC] only stream response can be None");- }- },- Err(err) => {- response_handler.invoke(Err(err));- },- }- },- None => error!("[RPC] id {}'s handle not found", request_id),- }- }-- /// Get a message from the receive queue if available.- pub(crate) fn try_get_rx(&self) -> Option<Result<RpcObject, ReadError>> {- let mut queue = self.0.rx_queue.lock();- queue.pop_front()- }-- /// Get a message from the receive queue, waiting for at most `Duration`- /// and returning `None` if no message is available.- pub(crate) fn get_rx_timeout(&self, dur: Duration) -> Option<Result<RpcObject, ReadError>> {- let mut queue = self.0.rx_queue.lock();- let result = self.0.rx_cvar.wait_for(&mut queue, dur);- if result.timed_out() {- return None;- }- queue.pop_front()- }-- /// Adds a message to the receive queue. The message should only- /// be `None` if the read thread is exiting.- pub(crate) fn put_rpc_object(&self, json: Result<RpcObject, ReadError>) {- let mut queue = self.0.rx_queue.lock();- queue.push_back(json);- self.0.rx_cvar.notify_one();- }-- /// Checks the status of the most imminent timer.- ///- /// # Returns- ///- /// - `Some(Ok(usize))`: If the most imminent timer has expired, returns its token.- /// - `Some(Err(Duration))`: If the most imminent timer has not yet expired, returns the time until it expires.- /// - `None`: If no timers are registered.- pub(crate) fn check_timers(&self) -> Option<Result<usize, Duration>> {- let mut timers = self.0.timers.lock();- match timers.peek() {- None => return None,- Some(t) => {- let now = Instant::now();- if t.fire_after > now {- return Some(Err(t.fire_after - now));- }- },- }- Some(Ok(timers.pop().unwrap().token))- }-- /// send disconnect error to pending requests.- pub(crate) fn disconnect(&self) {- trace!("[RPC] disconnecting peer");- let mut pending = self.0.pending.lock();- let ids = pending.keys().cloned().collect::<Vec<_>>();- for id in &ids {- let callback = pending.remove(id).unwrap();- callback.invoke(Err(SidecarError::PeerDisconnect));- }- self.0.needs_exit.store(true, Ordering::Relaxed);- }-- /// Checks if the RPC system needs to exit.- pub(crate) fn needs_exit(&self) -> bool {- self.0.needs_exit.load(Ordering::Relaxed)- }-- pub(crate) fn reset_needs_exit(&self) {- self.0.needs_exit.store(false, Ordering::SeqCst);- }-}--impl<W: Write> Clone for RawPeer<W> {- fn clone(&self) -> Self {- RawPeer(self.0.clone())- }-}--#[derive(Clone, Debug)]-pub enum ResponsePayload {- Json(JsonValue),- Streaming(JsonValue),- StreamEnd(JsonValue),-}--impl ResponsePayload {- pub fn empty_json() -> Self {- ResponsePayload::Json(json!({}))- }-- pub fn is_stream(&self) -> bool {- matches!(- self,- ResponsePayload::Streaming(_) | ResponsePayload::StreamEnd(_)- )- }-- pub fn is_stream_end(&self) -> bool {- matches!(self, ResponsePayload::StreamEnd(_))- }-- pub fn into_json(self) -> Option<JsonValue> {- match self {- ResponsePayload::Json(v) => Some(v),- ResponsePayload::Streaming(v) => Some(v),- ResponsePayload::StreamEnd(_) => None,- }- }-}--impl Display for ResponsePayload {- fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {- match self {- ResponsePayload::Json(v) => write!(f, "{}", v),- ResponsePayload::Streaming(_) => write!(f, "stream start"),- ResponsePayload::StreamEnd(_) => write!(f, "stream end"),- }- }-}--pub type Response = Result<ResponsePayload, RemoteError>;--pub trait ResponseStream: Stream<Item = Result<JsonValue, SidecarError>> + Unpin + Send {}--impl<T> ResponseStream for T where T: Stream<Item = Result<JsonValue, SidecarError>> + Unpin + Send {}--enum ResponseHandler {- Chan(mpsc::Sender<Result<JsonValue, SidecarError>>),- Callback(Box<dyn OneShotCallback>),- StreamCallback(Arc<CloneableCallback>),-}--impl ResponseHandler {- pub fn get_stream_callback(&self) -> Option<Arc<CloneableCallback>> {- match self {- ResponseHandler::StreamCallback(cb) => Some(cb.clone()),- _ => None,- }- }-}--pub trait OneShotCallback: Send {- fn call(self: Box<Self>, result: Result<JsonValue, SidecarError>);-}--impl<F: Send + FnOnce(Result<JsonValue, SidecarError>)> OneShotCallback for F {- fn call(self: Box<Self>, result: Result<JsonValue, SidecarError>) {- (self)(result)- }-}--pub trait Callback: Send + Sync {- fn call(&self, result: Result<JsonValue, SidecarError>);-}--impl<F: Send + Sync + Fn(Result<JsonValue, SidecarError>)> Callback for F {- fn call(&self, result: Result<JsonValue, SidecarError>) {- (*self)(result)- }-}--#[derive(Clone)]-pub struct CloneableCallback {- callback: Arc<dyn Callback>,-}-impl CloneableCallback {- pub fn new<C: Callback + 'static>(callback: C) -> Self {- CloneableCallback {- callback: Arc::new(callback),- }- }-- pub fn call(&self, result: Result<JsonValue, SidecarError>) {- self.callback.call(result)- }-}--impl ResponseHandler {- fn invoke(self, result: Result<JsonValue, SidecarError>) {- match self {- ResponseHandler::Chan(tx) => {- let _ = tx.send(result);- },- ResponseHandler::StreamCallback(cb) => {- cb.call(result);- },- ResponseHandler::Callback(f) => f.call(result),- }- }-}-#[derive(Debug, PartialEq, Eq)]-struct Timer {- fire_after: Instant,- token: usize,-}--impl Ord for Timer {- fn cmp(&self, other: &Timer) -> cmp::Ordering {- other.fire_after.cmp(&self.fire_after)- }-}--impl PartialOrd for Timer {- fn partial_cmp(&self, other: &Timer) -> Option<cmp::Ordering> {- Some(self.cmp(other))- }-}diff --git a/frontend/rust-lib/flowy-sidecar/src/error.rs b/frontend/rust-lib/flowy-sidecar/src/error.rsdeleted file mode 100644index fb7f7b6a52..0000000000--- a/frontend/rust-lib/flowy-sidecar/src/error.rs+++ /dev/null@@ -1,174 +0,0 @@-use serde::{Deserialize, Deserializer, Serialize, Serializer};-use serde_json::{json, Value as JsonValue};-use std::{fmt, io};--/// The error type of `tauri-utils`.-#[derive(Debug, thiserror::Error)]-pub enum SidecarError {- /// An IO error occurred on the underlying communication channel.- #[error(transparent)]- Io(#[from] io::Error),- /// The peer returned an error.- #[error("Remote error: {0}")]- RemoteError(RemoteError),- /// The peer closed the connection.- #[error("Peer closed the connection.")]- PeerDisconnect,- /// The peer sent a response containing the id, but was malformed.- #[error("Invalid response.")]- InvalidResponse,-- #[error(transparent)]- Internal(#[from] anyhow::Error),-}--#[derive(Debug)]-pub enum ReadError {- /// An error occurred in the underlying stream- Io(io::Error),- /// The message was not valid JSON.- Json(serde_json::Error),- /// The message was not a JSON object.- NotObject(String),- /// The the method and params were not recognized by the handler.- UnknownRequest(serde_json::Error),- /// The peer closed the connection.- Disconnect,-}--#[derive(Debug, Clone, thiserror::Error)]-pub enum RemoteError {- /// The JSON was valid, but was not a correctly formed request.- ///- /// This Error is used internally, and should not be returned by- /// clients.- #[error("Invalid request: {0:?}")]- InvalidRequest(Option<JsonValue>),-- #[error("Invalid response: {0}")]- InvalidResponse(JsonValue),-- #[error("Parse response: {0}")]- ParseResponse(JsonValue),- /// A custom error, defined by the client.- #[error("Custom error: {message}")]- Custom {- code: i64,- message: String,- data: Option<JsonValue>,- },- /// An error that cannot be represented by an error object.- ///- /// This error is intended to accommodate clients that return arbitrary- /// error values. It should not be used for new errors.- #[error("Unknown error: {0}")]- Unknown(JsonValue),-}--impl ReadError {- /// Returns `true` iff this is the `ReadError::Disconnect` variant.- pub fn is_disconnect(&self) -> bool {- matches!(*self, ReadError::Disconnect)- }-}--impl fmt::Display for ReadError {- fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {- match self {- ReadError::Io(ref err) => write!(f, "I/O Error: {:?}", err),- ReadError::Json(ref err) => write!(f, "JSON Error: {:?}", err),- ReadError::NotObject(s) => write!(f, "Expected JSON object, found: {}", s),- ReadError::UnknownRequest(ref err) => write!(f, "Unknown request: {:?}", err),- ReadError::Disconnect => write!(f, "Peer closed the connection."),- }- }-}--impl From<serde_json::Error> for ReadError {- fn from(err: serde_json::Error) -> ReadError {- ReadError::Json(err)- }-}--impl From<io::Error> for ReadError {- fn from(err: io::Error) -> ReadError {- ReadError::Io(err)- }-}--impl From<serde_json::Error> for RemoteError {- fn from(err: serde_json::Error) -> RemoteError {- RemoteError::InvalidRequest(Some(json!(err.to_string())))- }-}--impl From<RemoteError> for SidecarError {- fn from(err: RemoteError) -> SidecarError {- SidecarError::RemoteError(err)- }-}--#[derive(Deserialize, Serialize)]-struct ErrorHelper {- code: i64,- message: String,- #[serde(skip_serializing_if = "Option::is_none")]- data: Option<JsonValue>,-}--impl<'de> Deserialize<'de> for RemoteError {- fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>- where- D: Deserializer<'de>,- {- let v = JsonValue::deserialize(deserializer)?;- let resp = match ErrorHelper::deserialize(&v) {- Ok(resp) => resp,- Err(_) => return Ok(RemoteError::Unknown(v)),- };-- Ok(match resp.code {- -32600 => RemoteError::InvalidRequest(resp.data),- _ => RemoteError::Custom {- code: resp.code,- message: resp.message,- data: resp.data,- },- })- }-}--impl Serialize for RemoteError {- fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>- where- S: Serializer,- {- let (code, message, data) = match self {- RemoteError::InvalidRequest(ref d) => (-32600, "Invalid request".to_string(), d.clone()),- RemoteError::Custom {- code,- ref message,- ref data,- } => (*code, message.clone(), data.clone()),- RemoteError::Unknown(_) => {- panic!("The 'Unknown' error variant is not intended for client use.")- },- RemoteError::InvalidResponse(resp) => (- -1,- "Invalid response".to_string(),- Some(json!(resp.to_string())),- ),- RemoteError::ParseResponse(resp) => (- -1,- "Invalid response".to_string(),- Some(json!(resp.to_string())),- ),- };- let err = ErrorHelper {- code,- message,- data,- };- err.serialize(serializer)- }-}diff --git a/frontend/rust-lib/flowy-sidecar/src/lib.rs b/frontend/rust-lib/flowy-sidecar/src/lib.rsdeleted file mode 100644index 3eabd6918a..0000000000--- a/frontend/rust-lib/flowy-sidecar/src/lib.rs+++ /dev/null@@ -1,3 +0,0 @@-pub mod core;-pub mod error;-pub mod manager;diff --git a/frontend/rust-lib/flowy-sidecar/src/manager.rs b/frontend/rust-lib/flowy-sidecar/src/manager.rsdeleted file mode 100644index 1c90982a42..0000000000--- a/frontend/rust-lib/flowy-sidecar/src/manager.rs+++ /dev/null@@ -1,201 +0,0 @@-use crate::core::parser::ResponseParser;-use crate::core::plugin::{start_plugin_process, Plugin, PluginId, PluginInfo, RpcCtx};-use crate::core::rpc_loop::Handler;-use crate::core::rpc_peer::{PluginCommand, ResponsePayload};-use crate::error::{ReadError, RemoteError, SidecarError};-use anyhow::anyhow;-use lib_infra::util::{get_operating_system, OperatingSystem};-use parking_lot::Mutex;-use serde_json::Value;-use std::io;--use std::sync::atomic::{AtomicI64, Ordering};-use std::sync::{Arc, Weak};-use tracing::{error, info, instrument, trace, warn};--pub struct SidecarManager {- state: Arc<Mutex<SidecarState>>,- plugin_id_counter: Arc<AtomicI64>,- operating_system: OperatingSystem,-}--impl Default for SidecarManager {- fn default() -> Self {- Self::new()- }-}--impl SidecarManager {- pub fn new() -> Self {- SidecarManager {- state: Arc::new(Mutex::new(SidecarState {- plugins: Vec::new(),- })),- plugin_id_counter: Arc::new(Default::default()),- operating_system: get_operating_system(),- }- }-- pub async fn create_plugin(&self, plugin_info: PluginInfo) -> Result<PluginId, SidecarError> {- if self.operating_system.is_not_desktop() {- return Err(SidecarError::Internal(anyhow!(- "plugin not supported on this platform"- )));- }- let plugin_id = PluginId::from(self.plugin_id_counter.fetch_add(1, Ordering::SeqCst));- let weak_state = WeakSidecarState(Arc::downgrade(&self.state));- start_plugin_process(plugin_info, plugin_id, weak_state).await?;- Ok(plugin_id)- }-- pub async fn get_plugin(&self, plugin_id: PluginId) -> Result<Weak<Plugin>, SidecarError> {- let state = self.state.lock();- let plugin = state- .plugins- .iter()- .find(|p| p.id == plugin_id)- .ok_or(anyhow!("plugin not found"))?;- Ok(Arc::downgrade(plugin))- }-- #[instrument(skip(self), err)]- pub async fn remove_plugin(&self, id: PluginId) -> Result<(), SidecarError> {- if self.operating_system.is_not_desktop() {- return Err(SidecarError::Internal(anyhow!(- "plugin not supported on this platform"- )));- }-- info!("[RPC] removing plugin {:?}", id);- self.state.lock().plugin_disconnect(id, Ok(()));- Ok(())- }-- pub fn init_plugin(&self, id: PluginId, init_params: Value) -> Result<Arc<Plugin>, SidecarError> {- if self.operating_system.is_not_desktop() {- return Err(SidecarError::Internal(anyhow!(- "plugin not supported on this platform"- )));- }-- let state = self.state.lock();- let plugin = state- .plugins- .iter()- .find(|p| p.id == id)- .ok_or(anyhow!("plugin not found"))?;- plugin.initialize(init_params)?;-- Ok(plugin.clone())- }-- pub fn send_request<P: ResponseParser>(- &self,- id: PluginId,- method: &str,- request: Value,- ) -> Result<P::ValueType, SidecarError> {- let state = self.state.lock();- let plugin = state- .plugins- .iter()- .find(|p| p.id == id)- .ok_or(anyhow!("plugin not found"))?;- let resp = plugin.request(method, &request)?;- let value = P::parse_json(resp)?;- Ok(value)- }-- pub async fn async_send_request<P: ResponseParser>(- &self,- id: PluginId,- method: &str,- request: Value,- ) -> Result<P::ValueType, SidecarError> {- let plugin = self- .state- .lock()- .plugins- .iter()- .find(|p| p.id == id)- .ok_or(anyhow!("plugin not found"))- .cloned()?;- let value = plugin.async_request::<P>(method, &request).await?;- Ok(value)- }-}--pub struct SidecarState {- plugins: Vec<Arc<Plugin>>,-}--impl SidecarState {- pub fn plugin_connect(&mut self, plugin: Result<Plugin, io::Error>) {- match plugin {- Ok(plugin) => {- info!("[RPC] {} connected", plugin);- self.plugins.push(Arc::new(plugin));- },- Err(err) => {- warn!("plugin failed to connect: {:?}", err);- },- }- }-- pub fn plugin_disconnect(- &mut self,- id: PluginId,- error: Result<(), ReadError>,- ) -> Option<Arc<Plugin>> {- if let Err(err) = error {- error!("[RPC] plugin {:?} exited with result {:?}", id, err)- }-- let running_idx = self.plugins.iter().position(|p| p.id == id);- match running_idx {- Some(idx) => {- let plugin = self.plugins.remove(idx);- plugin.shutdown();- Some(plugin)- },- None => {- warn!("[RPC] plugin {:?} not found", id);- None- },- }- }-}--#[derive(Clone)]-pub struct WeakSidecarState(Weak<Mutex<SidecarState>>);--impl WeakSidecarState {- pub fn upgrade(&self) -> Option<Arc<Mutex<SidecarState>>> {- self.0.upgrade()- }-- pub fn plugin_connect(&self, plugin: Result<Plugin, io::Error>) {- if let Some(state) = self.upgrade() {- state.lock().plugin_connect(plugin)- }- }-- pub fn plugin_exit(&self, plugin: PluginId, error: Result<(), ReadError>) {- if let Some(core) = self.upgrade() {- core.lock().plugin_disconnect(plugin, error);- }- }-}--impl Handler for WeakSidecarState {- type Request = PluginCommand<String>;-- fn handle_request(- &mut self,- _ctx: &RpcCtx,- rpc: Self::Request,- ) -> Result<ResponsePayload, RemoteError> {- trace!("handling request: {:?}", rpc.cmd);- Ok(ResponsePayload::empty_json())- }-}diff --git a/frontend/scripts/tool/update_local_ai_rev.sh b/frontend/scripts/tool/update_local_ai_rev.shnew file mode 100755index 0000000000..5f5e892a3f--- /dev/null+++ b/frontend/scripts/tool/update_local_ai_rev.sh@@ -0,0 +1,37 @@+#!/bin/bash++# Ensure a new revision ID is provided+if [ "$#" -ne 1 ]; then+ echo "Usage: $0 <new_revision_id>"+ exit 1+fi++NEW_REV="$1"+echo "New revision: $NEW_REV"+directories=("rust-lib" "appflowy_tauri/src-tauri" "appflowy_web_app/src-tauri")++for dir in "${directories[@]}"; do+ echo "Updating $dir"+ pushd "$dir" > /dev/null++ # Define the crates to update+ crates=("appflowy-local-ai" "appflowy-plugin")++ for crate in "${crates[@]}"; do+ sed -i.bak "/^${crate}[[:alnum:]-]*[[:space:]]*=/s/rev = \"[a-fA-F0-9]\{6,40\}\"/rev = \"$NEW_REV\"/g" Cargo.toml+ done++ # Construct the crates_to_update variable+ crates_to_update=""+ for crate in "${crates[@]}"; do+ crates_to_update="$crates_to_update -p $crate"+ done++ # Update all the specified crates at once+ if [ -n "$crates_to_update" ]; then+ echo "Updating crates: $crates_to_update"+ cargo update $crates_to_update+ fi++ popd > /dev/null+done