From 6b1a612efceda03d1cc23fed33ee1b0befe31dc8 Mon Sep 17 00:00:00 2001
From: Ammar Abou Zor <ammar.abou.zor@accenture.com>
Date: Wed, 5 Feb 2025 11:19:10 +0100
Subject: [PATCH] Chipmunk CLI: Text formatter generic + improvements

* Make text formatter independent from parser by introducing fields for
  the original separator that must be provided by initializing an
  instance of it.
* Add more documentation for this part and leave a TODO to revisit this
  temp solution in the future.
* Avoid index checking to determine if separator should be printed.
* Use direct methods on string buffer instead of write macros.
---
 cli/chipmunk-cli/src/lib.rs                 |  9 ++-
 cli/chipmunk-cli/src/session/format/text.rs | 67 ++++++++++++++-------
 2 files changed, 53 insertions(+), 23 deletions(-)

diff --git a/cli/chipmunk-cli/src/lib.rs b/cli/chipmunk-cli/src/lib.rs
index b7316dd0f..9b1341b77 100644
--- a/cli/chipmunk-cli/src/lib.rs
+++ b/cli/chipmunk-cli/src/lib.rs
@@ -49,8 +49,13 @@ pub async fn run_app(cancel_token: CancellationToken) -> anyhow::Result<()> {
                     .await?;
                 }
                 OutputFormat::Text => {
-                    let text_formatter =
-                        MsgTextFormatter::new(cli.text_columns_separator, cli.text_args_separator);
+                    use parsers::dlt::fmt;
+                    let text_formatter = MsgTextFormatter::new(
+                        fmt::DLT_COLUMN_SENTINAL,
+                        fmt::DLT_ARGUMENT_SENTINAL,
+                        cli.text_columns_separator,
+                        cli.text_args_separator,
+                    );
 
                     start_session(parser, input, text_formatter, cli.output_path, cancel_token)
                         .await?;
diff --git a/cli/chipmunk-cli/src/session/format/text.rs b/cli/chipmunk-cli/src/session/format/text.rs
index 0f72af369..412b50eb9 100644
--- a/cli/chipmunk-cli/src/session/format/text.rs
+++ b/cli/chipmunk-cli/src/session/format/text.rs
@@ -4,13 +4,7 @@ use std::fmt::Write as _;
 
 use anyhow::Context;
 
-use parsers::{
-    dlt::fmt::{
-        DLT_ARGUMENT_SENTINAL as INEXER_DLT_ARGUMENT_SENTINAL,
-        DLT_COLUMN_SENTINAL as INEXER_DLT_COLUMN_SENTINAL,
-    },
-    LogMessage,
-};
+use parsers::LogMessage;
 
 use super::MessageFormatter;
 
@@ -28,22 +22,48 @@ const WRITE_ERROR_MSG: &str = "Error while writing parsed message to buffer";
 /// the performance assuming it will be called inside a hot loop.
 ///
 /// # Note:
-/// Struct currently have support for DLT-messages only.
+/// Formatting needs the columns and arguments separators used originally in each parser
+/// to avoid any changes in indexer libraries before the implementation of this tool is
+/// stabilized.
+// TODO: Revisit this part once the UI part of this CLI tool is implemented.
 #[derive(Debug, Clone)]
 pub struct MsgTextFormatter {
     origin_msg_buffer: String,
     replaced_msg_buffer: String,
+    /// The separator used for message columns in the parser used in indexer crates originally.
+    indexer_cols_sep: char,
+    /// The separator used for message payload arguments in the parser used in indexer
+    /// crates originally.
+    indexer_args_sep: char,
+    /// The separator to be used for message columns in the output of this session.
     columns_separator: String,
+    /// The separator to be used for message payload arguments in the output of this session.
     argument_separator: String,
 }
 
 impl MsgTextFormatter {
-    pub fn new(columns_separator: String, argument_separator: String) -> Self {
+    /// Creates a new instance with the given arguments.
+    ///
+    /// * `indexer_cols_sep`: Separator used for message columns in the parser used in indexer
+    ///   crates originally.
+    /// * `indexer_args_sep`: Separator used for message payload arguments in the parser used
+    ///   in indexer crates originally
+    /// * `columns_separator`: Separator to be used for message columns in the output of this session.
+    /// * `argument_separator`: Separator to be used for message payload arguments in the output of
+    ///   this session.
+    pub fn new(
+        indexer_cols_sep: char,
+        indexer_args_sep: char,
+        columns_separator: String,
+        argument_separator: String,
+    ) -> Self {
         Self {
             origin_msg_buffer: String::new(),
             replaced_msg_buffer: String::new(),
             columns_separator,
             argument_separator,
+            indexer_cols_sep,
+            indexer_args_sep,
         }
     }
 }
@@ -63,23 +83,28 @@ impl MessageFormatter for MsgTextFormatter {
 
         let rep_buff = &mut self.replaced_msg_buffer;
 
-        for (idx, main) in self
+        for (idx, cols) in self
             .origin_msg_buffer
-            .split(INEXER_DLT_COLUMN_SENTINAL)
+            .split(self.indexer_cols_sep)
             .enumerate()
         {
             if idx != 0 {
-                write!(rep_buff, "{}", self.columns_separator).context(WRITE_ERROR_MSG)?;
+                rep_buff.push_str(&self.columns_separator);
             }
-            for (jdx, argument) in main
-                .split(INEXER_DLT_ARGUMENT_SENTINAL)
-                .filter(|e| !e.trim().is_empty())
-                .enumerate()
-            {
-                if jdx != 0 {
-                    write!(rep_buff, "{}", self.argument_separator).context(WRITE_ERROR_MSG)?;
-                }
-                write!(rep_buff, "{argument}").context(WRITE_ERROR_MSG)?;
+
+            let mut main_iter = cols
+                .split(self.indexer_args_sep)
+                .filter(|e| !e.trim().is_empty());
+
+            let Some(first) = main_iter.next() else {
+                continue;
+            };
+
+            rep_buff.push_str(first);
+
+            for argument in main_iter {
+                rep_buff.push_str(&self.argument_separator);
+                rep_buff.push_str(argument);
             }
         }