chore: support custom message size (#1445)

Author: appflowy

libs/collab-rt-entity/src/message.rs

@@ -12,13 +12,18 @@ use serde::{Deserialize, Serialize};
 use std::fmt::{Display, Formatter};
 use std::ops::{Deref, DerefMut};
 
-/// Maximum allowable size for a realtime message.
+pub const MAXIMUM_REALTIME_MESSAGE_SIZE: usize = 10 * 1024 * 1024; // 10 MB
+
+/// Get the maximum realtime message size from environment variable or use default.
 ///
-/// This sets the largest size a message can be for server processing in real-time communications.
-/// If a message goes over this size, it won't be processed and will trigger a parser error.
-/// This limit helps prevent server issues like overloads and denial-of-service attacks by rejecting
-/// overly large messages.
-pub const MAXIMUM_REALTIME_MESSAGE_SIZE: u64 = 1024 * 1024; // 1 MB
+/// Reads from the `APPFLOWY_REALTIME_MESSAGE_SIZE` environment variable.
+/// If not set or invalid, falls back to `MAXIMUM_REALTIME_MESSAGE_SIZE`.
+pub fn max_sync_message_size() -> usize {
+  std::env::var("APPFLOWY_REALTIME_MESSAGE_SIZE")
+    .ok()
+    .and_then(|s| s.parse().ok())
+    .unwrap_or(MAXIMUM_REALTIME_MESSAGE_SIZE)
+}
 
 #[derive(Debug, Default, Clone, Serialize, Deserialize)]
 pub struct MessageByObjectId(pub HashMap<String, Vec<ClientCollabMessage>>);
@@ -105,7 +110,7 @@ impl RealtimeMessage {
     let data = DefaultOptions::new()
       .with_fixint_encoding()
       .allow_trailing_bytes()
-      .with_limit(MAXIMUM_REALTIME_MESSAGE_SIZE)
+      .with_limit(max_sync_message_size() as u64)
       .serialize(self)
       .map_err(|e| {
         anyhow!(
@@ -121,7 +126,7 @@ impl RealtimeMessage {
     let message = DefaultOptions::new()
       .with_fixint_encoding()
       .allow_trailing_bytes()
-      .with_limit(MAXIMUM_REALTIME_MESSAGE_SIZE)
+      .with_limit(max_sync_message_size() as u64)
       .deserialize(data)?;
     Ok(message)
   }

src/api/ws.rs

@@ -16,7 +16,7 @@ use appflowy_collaborate::collab::storage::CollabAccessControlStorage;
 use appflowy_collaborate::ws2::{SessionInfo, WsSession};
 use appflowy_proto::{ServerMessage, WorkspaceNotification};
 use collab_rt_entity::user::{AFUserChange, RealtimeUser, UserMessage};
-use collab_rt_entity::RealtimeMessage;
+use collab_rt_entity::{max_sync_message_size, RealtimeMessage};
 use collab_stream::model::MessageId;
 use secrecy::Secret;
 use semver::Version;
@@ -156,7 +156,7 @@ pub async fn establish_ws_connection_v2(
     &request,
     payload,
   )
-  .frame_size(10 * 1024 * 1024)
+  .frame_size(max_sync_message_size())
   .start()
 }
 

tests/collab/single_device_edit.rs

@@ -124,7 +124,7 @@ async fn write_big_chunk_data_init_sync_test() {
   let mut test_client = TestClient::new_user().await;
   let workspace_id = test_client.workspace_id().await;
   let object_id = Uuid::new_v4();
-  let big_text = generate_random_string((MAXIMUM_REALTIME_MESSAGE_SIZE / 2) as usize);
+  let big_text = generate_random_string(MAXIMUM_REALTIME_MESSAGE_SIZE / 2);
   let collab_type = CollabType::Unknown;
   let doc_state = make_collab_with_key_value(&object_id, "text", big_text.clone());