backups/grapevine
1
0
Fork 0
mirror of https://gitlab.computer.surgery/matrix/grapevine.git synced 2025-12-17 07:41:23 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

generalize documentation, make the name shorter

Browse source 
It's more useful than just *debug* logs, but yes, should not be relied
upon for logic reasons.
This commit is contained in:
Charles Hall 2024-06-23 19:59:06 -07:00
parent 08cd8f19e3
commit 6aca128547
No known key found for this signature in database
GPG key ID: 7B8E0645816E07CF
2 changed files with 16 additions and 22 deletions
Download patch file Download diff file Expand all files Collapse all files

8
src/service/admin.rs
View file

@ -34,7 +34,7 @@ use super::pdu::PduBuilder;
use crate::{ use crate::{
api::client_server::{leave_all_rooms, AUTO_GEN_PASSWORD_LENGTH}, api::client_server::{leave_all_rooms, AUTO_GEN_PASSWORD_LENGTH},
services, services,
utils::{self, truncate_str_for_debug}, utils::{self, dbg_truncate_str},
Error, PduEvent, Result, Error, PduEvent, Result,
}; };
@ -287,7 +287,7 @@ impl Service {
#[tracing::instrument( #[tracing::instrument(
skip(self, room_message), skip(self, room_message),
fields( fields(
room_message = truncate_str_for_debug(&room_message, 50).as_ref(), room_message = dbg_truncate_str(&room_message, 50).as_ref(),
), ),
)] )]
pub(crate) fn process_message(&self, room_message: String) { pub(crate) fn process_message(&self, room_message: String) {
@ -306,7 +306,7 @@ impl Service {
#[tracing::instrument( #[tracing::instrument(
skip(self, room_message), skip(self, room_message),
fields( fields(
room_message = truncate_str_for_debug(&room_message, 50).as_ref(), room_message = dbg_truncate_str(&room_message, 50).as_ref(),
), ),
)] )]
async fn process_admin_message( async fn process_admin_message(
@ -357,7 +357,7 @@ impl Service {
#[tracing::instrument( #[tracing::instrument(
skip(command_line), skip(command_line),
fields( fields(
command_line = truncate_str_for_debug(command_line, 50).as_ref(), command_line = dbg_truncate_str(command_line, 50).as_ref(),
), ),
)] )]
fn parse_admin_command( fn parse_admin_command(

30
src/utils.rs
View file

@ -228,11 +228,8 @@ pub(crate) fn debug_slice_truncated<T: fmt::Debug>(
/// Truncates a string to an approximate maximum length, replacing any extra /// Truncates a string to an approximate maximum length, replacing any extra
/// text with an ellipsis. /// text with an ellipsis.
/// ///
/// Only to be used for debug logging, exact semantics are unspecified. /// Only to be used for informational purposes, exact semantics are unspecified.
pub(crate) fn truncate_str_for_debug( pub(crate) fn dbg_truncate_str(s: &str, mut max_len: usize) -> Cow<'_, str> {
s: &str,
mut max_len: usize,
) -> Cow<'_, str> {
while max_len < s.len() && !s.is_char_boundary(max_len) { while max_len < s.len() && !s.is_char_boundary(max_len) {
max_len += 1; max_len += 1;
} }
@ -247,21 +244,18 @@ pub(crate) fn truncate_str_for_debug(
#[cfg(test)] #[cfg(test)]
mod tests { mod tests {
use crate::utils::truncate_str_for_debug; use crate::utils::dbg_truncate_str;
#[test] #[test]
fn test_truncate_str_for_debug() { fn test_truncate_str() {
assert_eq!(truncate_str_for_debug("short", 10), "short"); assert_eq!(dbg_truncate_str("short", 10), "short");
assert_eq!( assert_eq!(dbg_truncate_str("very long string", 10), "very long ...");
truncate_str_for_debug("very long string", 10), assert_eq!(dbg_truncate_str("no info, only dots", 0), "...");
"very long ..." assert_eq!(dbg_truncate_str("", 0), "");
); assert_eq!(dbg_truncate_str("unicöde", 5), "unicö...");
assert_eq!(truncate_str_for_debug("no info, only dots", 0), "...");
assert_eq!(truncate_str_for_debug("", 0), "");
assert_eq!(truncate_str_for_debug("unicöde", 5), "unicö...");
let ok_hand = "👌🏽"; let ok_hand = "👌🏽";
assert_eq!(truncate_str_for_debug(ok_hand, 1), "👌..."); assert_eq!(dbg_truncate_str(ok_hand, 1), "👌...");
assert_eq!(truncate_str_for_debug(ok_hand, ok_hand.len() - 1), "👌🏽"); assert_eq!(dbg_truncate_str(ok_hand, ok_hand.len() - 1), "👌🏽");
assert_eq!(truncate_str_for_debug(ok_hand, ok_hand.len()), "👌🏽"); assert_eq!(dbg_truncate_str(ok_hand, ok_hand.len()), "👌🏽");
} }
} }