Restrict debug output size for the Any type

Author: yoshidan

modules/types/src/any.rs

@@ -1,10 +1,13 @@
 use crate::errors::TypeError;
 use crate::prelude::*;
+use core::fmt::{Debug, Formatter, Result as DebugResult};
 use core::ops::Deref;
 use lcp_proto::{google::protobuf::Any as ProtoAny, protobuf::Protobuf};
 use serde::{Deserialize, Serialize};
 
-#[derive(Default, Clone, Debug, PartialEq, Serialize, Deserialize)]
+const MAX_VALUE_LENGTH_FOR_DEBUG: usize = 1024;
+
+#[derive(Default, Clone, PartialEq, Serialize, Deserialize)]
 #[serde(transparent)]
 pub struct Any(#[serde(with = "ProtoAnyDef")] ProtoAny);
 
@@ -18,6 +21,24 @@ impl Any {
     }
 }
 
+impl Debug for Any {
+    fn fmt(&self, f: &mut Formatter<'_>) -> DebugResult {
+        let mut debug = f.debug_struct("Any");
+        debug.field("type_url", &self.type_url);
+        if self.value.len() > MAX_VALUE_LENGTH_FOR_DEBUG {
+            debug
+                .field("total_value_size", &self.value.len())
+                .field(
+                    &format!("first_{}_value", MAX_VALUE_LENGTH_FOR_DEBUG),
+                    &&self.value[..MAX_VALUE_LENGTH_FOR_DEBUG],
+                );
+        } else {
+            debug.field("value", &self.value);
+        }
+        debug.finish()
+    }
+}
+
 impl Deref for Any {
     type Target = ProtoAny;
 
@@ -111,4 +132,42 @@ mod tests {
             assert_eq!(any1, any3);
         }
     }
+
+    #[test]
+    fn test_debug_any() {
+        let type_url = "type_url".to_string();
+        let base = Any::new(type_url.clone(), [0u8; MAX_VALUE_LENGTH_FOR_DEBUG].to_vec());
+        let base_str = format!("{:?}", base);
+        {
+            let value = [0u8; MAX_VALUE_LENGTH_FOR_DEBUG + 1].to_vec();
+            let value_str = format!("{:?}", Any::new(type_url.clone(), value));
+            let expected_str = base_str.replace(
+                "value",
+                &format!(
+                    "total_value_size: {}, first_{}_value",
+                    MAX_VALUE_LENGTH_FOR_DEBUG + 1,
+                    MAX_VALUE_LENGTH_FOR_DEBUG
+                ),
+            );
+            assert_eq!(value_str, expected_str);
+        }
+        {
+            let value = [0u8; MAX_VALUE_LENGTH_FOR_DEBUG].to_vec();
+            assert_eq!(base_str, format!("{:?}", Any::new(type_url.clone(), value)));
+        }
+        {
+            let value = [0u8; MAX_VALUE_LENGTH_FOR_DEBUG - 1].to_vec();
+            let value_str = format!("{:?}", Any::new(type_url.clone(), value));
+            let unexpected_str = base_str.replace(
+                "value",
+                &format!(
+                    "total_value_size: {}, first_{}_value",
+                    MAX_VALUE_LENGTH_FOR_DEBUG - 1,
+                    MAX_VALUE_LENGTH_FOR_DEBUG
+                ),
+            );
+            assert_ne!(base_str, value_str);
+            assert_ne!(value_str, unexpected_str);
+        }
+    }
 }