-
Notifications
You must be signed in to change notification settings - Fork 316
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: add decolorize processor (#5065)
* feat: add decolorize processor Signed-off-by: Ruihang Xia <waynestxia@gmail.com> * Update src/pipeline/src/etl/processor/cmcd.rs * add crate level integration test Signed-off-by: Ruihang Xia <waynestxia@gmail.com> --------- Signed-off-by: Ruihang Xia <waynestxia@gmail.com>
- Loading branch information
Showing
6 changed files
with
239 additions
and
26 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,195 @@ | ||
| // Copyright 2023 Greptime Team | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
|
|
||
| //! Removes ANSI color control codes from the input text. | ||
| //! | ||
| //! Similar to [`decolorize`](https://grafana.com/docs/loki/latest/query/log_queries/#removing-color-codes) | ||
| //! from Grafana Loki and [`strip_ansi_escape_codes`](https://vector.dev/docs/reference/vrl/functions/#strip_ansi_escape_codes) | ||
| //! from Vector VRL. | ||
|
|
||
| use ahash::HashSet; | ||
| use once_cell::sync::Lazy; | ||
| use regex::Regex; | ||
| use snafu::OptionExt; | ||
|
|
||
| use crate::etl::error::{ | ||
| Error, KeyMustBeStringSnafu, ProcessorExpectStringSnafu, ProcessorMissingFieldSnafu, Result, | ||
| }; | ||
| use crate::etl::field::{Fields, OneInputOneOutputField}; | ||
| use crate::etl::processor::{ | ||
| yaml_bool, yaml_new_field, yaml_new_fields, ProcessorBuilder, ProcessorKind, FIELDS_NAME, | ||
| FIELD_NAME, IGNORE_MISSING_NAME, | ||
| }; | ||
| use crate::etl::value::Value; | ||
|
|
||
| pub(crate) const PROCESSOR_DECOLORIZE: &str = "decolorize"; | ||
|
|
||
| static RE: Lazy<Regex> = Lazy::new(|| Regex::new(r"\x1b\[[0-9;]*m").unwrap()); | ||
|
|
||
| #[derive(Debug, Default)] | ||
| pub struct DecolorizeProcessorBuilder { | ||
| fields: Fields, | ||
| ignore_missing: bool, | ||
| } | ||
|
|
||
| impl ProcessorBuilder for DecolorizeProcessorBuilder { | ||
| fn output_keys(&self) -> HashSet<&str> { | ||
| self.fields | ||
| .iter() | ||
| .map(|f| f.target_or_input_field()) | ||
| .collect() | ||
| } | ||
|
|
||
| fn input_keys(&self) -> HashSet<&str> { | ||
| self.fields.iter().map(|f| f.input_field()).collect() | ||
| } | ||
|
|
||
| fn build(self, intermediate_keys: &[String]) -> Result<ProcessorKind> { | ||
| self.build(intermediate_keys).map(ProcessorKind::Decolorize) | ||
| } | ||
| } | ||
|
|
||
| impl DecolorizeProcessorBuilder { | ||
| fn build(self, intermediate_keys: &[String]) -> Result<DecolorizeProcessor> { | ||
| let mut real_fields = vec![]; | ||
| for field in self.fields.into_iter() { | ||
| let input = OneInputOneOutputField::build( | ||
| "decolorize", | ||
| intermediate_keys, | ||
| field.input_field(), | ||
| field.target_or_input_field(), | ||
| )?; | ||
| real_fields.push(input); | ||
| } | ||
| Ok(DecolorizeProcessor { | ||
| fields: real_fields, | ||
| ignore_missing: self.ignore_missing, | ||
| }) | ||
| } | ||
| } | ||
|
|
||
| /// Remove ANSI color control codes from the input text. | ||
| #[derive(Debug, Default)] | ||
| pub struct DecolorizeProcessor { | ||
| fields: Vec<OneInputOneOutputField>, | ||
| ignore_missing: bool, | ||
| } | ||
|
|
||
| impl DecolorizeProcessor { | ||
| fn process_string(&self, val: &str) -> Result<Value> { | ||
| Ok(Value::String(RE.replace_all(val, "").into_owned())) | ||
| } | ||
|
|
||
| fn process(&self, val: &Value) -> Result<Value> { | ||
| match val { | ||
| Value::String(val) => self.process_string(val), | ||
| _ => ProcessorExpectStringSnafu { | ||
| processor: PROCESSOR_DECOLORIZE, | ||
| v: val.clone(), | ||
| } | ||
| .fail(), | ||
| } | ||
| } | ||
| } | ||
|
|
||
| impl TryFrom<&yaml_rust::yaml::Hash> for DecolorizeProcessorBuilder { | ||
| type Error = Error; | ||
|
|
||
| fn try_from(value: &yaml_rust::yaml::Hash) -> Result<Self> { | ||
| let mut fields = Fields::default(); | ||
| let mut ignore_missing = false; | ||
|
|
||
| for (k, v) in value.iter() { | ||
| let key = k | ||
| .as_str() | ||
| .with_context(|| KeyMustBeStringSnafu { k: k.clone() })?; | ||
|
|
||
| match key { | ||
| FIELD_NAME => { | ||
| fields = Fields::one(yaml_new_field(v, FIELD_NAME)?); | ||
| } | ||
| FIELDS_NAME => { | ||
| fields = yaml_new_fields(v, FIELDS_NAME)?; | ||
| } | ||
| IGNORE_MISSING_NAME => { | ||
| ignore_missing = yaml_bool(v, IGNORE_MISSING_NAME)?; | ||
| } | ||
| _ => {} | ||
| } | ||
| } | ||
|
|
||
| Ok(DecolorizeProcessorBuilder { | ||
| fields, | ||
| ignore_missing, | ||
| }) | ||
| } | ||
| } | ||
|
|
||
| impl crate::etl::processor::Processor for DecolorizeProcessor { | ||
| fn kind(&self) -> &str { | ||
| PROCESSOR_DECOLORIZE | ||
| } | ||
|
|
||
| fn ignore_missing(&self) -> bool { | ||
| self.ignore_missing | ||
| } | ||
|
|
||
| fn exec_mut(&self, val: &mut Vec<Value>) -> Result<()> { | ||
| for field in self.fields.iter() { | ||
| let index = field.input_index(); | ||
| match val.get(index) { | ||
| Some(Value::Null) | None => { | ||
| if !self.ignore_missing { | ||
| return ProcessorMissingFieldSnafu { | ||
| processor: self.kind(), | ||
| field: field.input_name(), | ||
| } | ||
| .fail(); | ||
| } | ||
| } | ||
| Some(v) => { | ||
| let result = self.process(v)?; | ||
| let output_index = field.output_index(); | ||
| val[output_index] = result; | ||
| } | ||
| } | ||
| } | ||
| Ok(()) | ||
| } | ||
| } | ||
|
|
||
| #[cfg(test)] | ||
| mod tests { | ||
| use super::*; | ||
|
|
||
| #[test] | ||
| fn test_decolorize_processor() { | ||
| let processor = DecolorizeProcessor { | ||
| fields: vec![], | ||
| ignore_missing: false, | ||
| }; | ||
|
|
||
| let val = Value::String("\x1b[32mGreen\x1b[0m".to_string()); | ||
| let result = processor.process(&val).unwrap(); | ||
| assert_eq!(result, Value::String("Green".to_string())); | ||
|
|
||
| let val = Value::String("Plain text".to_string()); | ||
| let result = processor.process(&val).unwrap(); | ||
| assert_eq!(result, Value::String("Plain text".to_string())); | ||
|
|
||
| let val = Value::String("\x1b[46mfoo\x1b[0m bar".to_string()); | ||
| let result = processor.process(&val).unwrap(); | ||
| assert_eq!(result, Value::String("foo bar".to_string())); | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters