Improve gateway reliability and dashboard docs

clients/rust/src/session.rs

@@ -1,5 +1,5 @@
 use crate::client::{EventStream, GatewayClient};
-use crate::error::Error;
+use crate::error::{ensure_protocol_success, Error};
 use crate::generated::mxaccess_gateway::v1::mx_command::Payload;
 use crate::generated::mxaccess_gateway::v1::mx_command_reply;
 use crate::generated::mxaccess_gateway::v1::{
@@ -11,6 +11,8 @@ use crate::generated::mxaccess_gateway::v1::{
 };
 use crate::value::MxValue;
 
+const MAX_BULK_ITEMS: usize = 1_000;
+
 /// Session identifier returned by the gateway.
 #[derive(Clone)]
 pub struct Session {
@@ -40,12 +42,14 @@ impl Session {
     }
 
     pub async fn close(&self) -> Result<(), Error> {
-        self.client
+        let reply = self
+            .client
             .close_session_raw(CloseSessionRequest {
                 session_id: self.id.clone(),
                 client_correlation_id: "rust-client-close-session".to_owned(),
             })
             .await?;
+        ensure_protocol_success("close session", reply.protocol_status.as_ref())?;
         Ok(())
     }
 
@@ -137,6 +141,7 @@ impl Session {
         server_handle: i32,
         tag_addresses: Vec<String>,
     ) -> Result<Vec<SubscribeResult>, Error> {
+        ensure_bulk_size("tag_addresses", tag_addresses.len())?;
         let reply = self
             .invoke(
                 MxCommandKind::AddItemBulk,
@@ -155,6 +160,7 @@ impl Session {
         server_handle: i32,
         item_handles: Vec<i32>,
     ) -> Result<Vec<SubscribeResult>, Error> {
+        ensure_bulk_size("item_handles", item_handles.len())?;
         let reply = self
             .invoke(
                 MxCommandKind::AdviseItemBulk,
@@ -173,6 +179,7 @@ impl Session {
         server_handle: i32,
         item_handles: Vec<i32>,
     ) -> Result<Vec<SubscribeResult>, Error> {
+        ensure_bulk_size("item_handles", item_handles.len())?;
         let reply = self
             .invoke(
                 MxCommandKind::RemoveItemBulk,
@@ -191,6 +198,7 @@ impl Session {
         server_handle: i32,
         item_handles: Vec<i32>,
     ) -> Result<Vec<SubscribeResult>, Error> {
+        ensure_bulk_size("item_handles", item_handles.len())?;
         let reply = self
             .invoke(
                 MxCommandKind::UnAdviseItemBulk,
@@ -209,6 +217,7 @@ impl Session {
         server_handle: i32,
         tag_addresses: Vec<String>,
     ) -> Result<Vec<SubscribeResult>, Error> {
+        ensure_bulk_size("tag_addresses", tag_addresses.len())?;
         let reply = self
             .invoke(
                 MxCommandKind::SubscribeBulk,
@@ -227,6 +236,7 @@ impl Session {
         server_handle: i32,
         item_handles: Vec<i32>,
     ) -> Result<Vec<SubscribeResult>, Error> {
+        ensure_bulk_size("item_handles", item_handles.len())?;
         let reply = self
             .invoke(
                 MxCommandKind::UnsubscribeBulk,
@@ -327,6 +337,17 @@ impl Session {
     }
 }
 
+fn ensure_bulk_size(name: &'static str, len: usize) -> Result<(), Error> {
+    if len > MAX_BULK_ITEMS {
+        Err(Error::InvalidArgument {
+            name: name.to_owned(),
+            detail: format!("bulk commands are limited to {MAX_BULK_ITEMS} item(s)"),
+        })
+    } else {
+        Ok(())
+    }
+}
+
 fn register_server_handle(reply: &MxCommandReply) -> i32 {
     match reply.payload.as_ref() {
         Some(mx_command_reply::Payload::Register(register)) => register.server_handle,