add docs

Signed-off-by: Bugen Zhao <[email protected]>

src/common/src/config.rs

@@ -37,7 +37,7 @@ use crate::hash::VirtualNode;
 
 /// Use the maximum value for HTTP/2 connection window size to avoid deadlock among multiplexed
 /// streams on the same connection.
-pub const MAX_CONNECTION_WINDOW_SIZE: u32 = (1 << 31) - 2;
+pub const MAX_CONNECTION_WINDOW_SIZE: u32 = (1 << 31) - 1;
 /// Use a large value for HTTP/2 stream window size to improve the performance of remote exchange,
 /// as we don't rely on this for back-pressure.
 pub const STREAM_WINDOW_SIZE: u32 = 32 * 1024 * 1024; // 32 MB

src/meta/node/src/server.rs

@@ -495,7 +495,7 @@ pub async fn start_service_as_election_leader(
             prometheus_client,
             prometheus_selector,
             metadata_manager: metadata_manager.clone(),
-            compute_clients: ComputeClientPool::adhoc(), // TODO
+            compute_clients: ComputeClientPool::adhoc(),
             diagnose_command,
             trace_state,
         };

src/meta/src/manager/env.rs

@@ -388,7 +388,7 @@ impl MetaSrvEnv {
         meta_store_impl: MetaStoreImpl,
     ) -> MetaResult<Self> {
         let idle_manager = Arc::new(IdleManager::new(opts.max_idle_ms));
-        let stream_client_pool = Arc::new(StreamClientPool::adhoc()); // TODO
+        let stream_client_pool = Arc::new(StreamClientPool::adhoc());
         let event_log_manager = Arc::new(start_event_log_manager(
             opts.event_log_enabled,
             opts.event_log_channel_max_size,

src/rpc_client/src/lib.rs

@@ -98,23 +98,28 @@ impl<S> std::fmt::Debug for RpcClientPool<S> {
     }
 }
 
+/// Intentionally not implementing `Default` to let callers be explicit about the pool size.
 impl<S> !Default for RpcClientPool<S> {}
 
 impl<S> RpcClientPool<S>
 where
     S: RpcClient,
 {
+    /// Create a new pool with the given `connection_pool_size`, which is the number of
+    /// connections to each node that will be reused.
     pub fn new(connection_pool_size: u16) -> Self {
         Self {
             connection_pool_size,
             clients: Cache::new(u64::MAX),
         }
     }
 
+    /// Create a pool for testing purposes. Same as [`Self::adhoc`].
     pub fn for_test() -> Self {
         Self::adhoc()
     }
 
+    /// Create a pool for ad-hoc usage, where the number of connections to each node is 1.
     pub fn adhoc() -> Self {
         Self::new(1)
     }