Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

enhancement: Add pretty parameter for encode_json #370

Merged
merged 3 commits into from
Aug 7, 2023
Merged

enhancement: Add pretty parameter for encode_json #370

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5d467a9
enhancement: Add `pretty` parameter for `encode_json`
Hexta Aug 4, 2023
718cce6
Merge branch 'main' into encode_json-pretty
pront Aug 7, 2023
82741f2
update changelog
Hexta Aug 7, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
116 changes: 102 additions & 14 deletions src/stdlib/encode_json.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,15 @@
use crate::compiler::prelude::*;

fn encode_json(value: Value) -> Resolved {
fn encode_json(value: Value, pretty: bool) -> Resolved {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It is a good practice to avoid bool parameters. There are many ways to refactor:

  • an options struct
  • enum instead of bool
  • extract implementation details and split encode_json into two functions

// With `vrl::Value` it should not be possible to get `Err`.
match serde_json::to_string(&value) {

let result = if pretty {
serde_json::to_string_pretty(&value)
} else {
serde_json::to_string(&value)
};

match result {
Ok(value) => Ok(value.into()),
Err(error) => unreachable!("unable encode to json: {}", error),
}
Expand All @@ -17,11 +24,18 @@ impl Function for EncodeJson {
}

fn parameters(&self) -> &'static [Parameter] {
&[Parameter {
keyword: "value",
kind: kind::ANY,
required: true,
}]
&[
Parameter {
keyword: "value",
kind: kind::ANY,
required: true,
},
Parameter {
keyword: "pretty",
kind: kind::BOOLEAN,
required: false,
},
]
}

fn compile(
Expand All @@ -31,28 +45,43 @@ impl Function for EncodeJson {
arguments: ArgumentList,
) -> Compiled {
let value = arguments.required("value");
let pretty = arguments.optional("pretty");

Ok(EncodeJsonFn { value }.as_expr())
Ok(EncodeJsonFn { value, pretty }.as_expr())
}

fn examples(&self) -> &'static [Example] {
&[Example {
title: "encode object",
source: r#"encode_json({"field": "value", "another": [1,2,3]})"#,
result: Ok(r#"s'{"another":[1,2,3],"field":"value"}'"#),
}]
&[
Example {
title: "encode object",
source: r#"encode_json({"field": "value", "another": [1,2,3]})"#,
result: Ok(r#"s'{"another":[1,2,3],"field":"value"}'"#),
},
Example {
title: "encode object as a pretty-printed JSON",
source: r#"encode_json({"field": "value", "another": [1,2,3]}, true)"#,
result: Ok(
r#""{\n \"another\": [\n 1,\n 2,\n 3\n ],\n \"field\": \"value\"\n}""#,
),
},
]
}
}

#[derive(Clone, Debug)]
struct EncodeJsonFn {
value: Box<dyn Expression>,
pretty: Option<Box<dyn Expression>>,
}

impl FunctionExpression for EncodeJsonFn {
fn resolve(&self, ctx: &mut Context) -> Resolved {
let value = self.value.resolve(ctx)?;
encode_json(value)
let pretty = match &self.pretty {
Some(pretty) => pretty.resolve(ctx)?.try_boolean()?,
None => false,
};
encode_json(value, pretty)
}

fn type_def(&self, _: &state::TypeState) -> TypeDef {
Expand All @@ -77,36 +106,72 @@ mod tests {
tdef: TypeDef::bytes().infallible(),
}

bytes_pretty {
args: func_args![value: r#"hello"#, pretty: true],
want: Ok(r#""hello""#),
tdef: TypeDef::bytes().infallible(),
}

integer {
args: func_args![value: 42],
want: Ok("42"),
tdef: TypeDef::bytes().infallible(),
}

integer_pretty {
args: func_args![value: 42, pretty: true],
want: Ok("42"),
tdef: TypeDef::bytes().infallible(),
}

float {
args: func_args![value: 42f64],
want: Ok("42.0"),
tdef: TypeDef::bytes().infallible(),
}

float_pretty {
args: func_args![value: 42f64, pretty: true],
want: Ok("42.0"),
tdef: TypeDef::bytes().infallible(),
}

boolean {
args: func_args![value: false],
want: Ok("false"),
tdef: TypeDef::bytes().infallible(),
}

boolean_pretty {
args: func_args![value: false, pretty: true],
want: Ok("false"),
tdef: TypeDef::bytes().infallible(),
}

map {
args: func_args![value: Value::from(BTreeMap::from([(String::from("field"), Value::from("value"))]))],
want: Ok(r#"{"field":"value"}"#),
tdef: TypeDef::bytes().infallible(),
}

map_pretty {
args: func_args![value: Value::from(BTreeMap::from([(String::from("field"), Value::from("value"))])), pretty: true],
want: Ok("{\n \"field\": \"value\"\n}"),
tdef: TypeDef::bytes().infallible(),
}

array {
args: func_args![value: vec![1, 2, 3]],
want: Ok("[1,2,3]"),
tdef: TypeDef::bytes().infallible(),
}

array_pretty {
args: func_args![value: vec![1, 2, 3], pretty: true],
want: Ok("[\n 1,\n 2,\n 3\n]"),
tdef: TypeDef::bytes().infallible(),
}

timestamp {
args: func_args![
value: DateTime::parse_from_str("1983 Apr 13 12:09:14.274 +0000", "%Y %b %d %H:%M:%S%.3f %z")
Expand All @@ -117,16 +182,39 @@ mod tests {
tdef: TypeDef::bytes().infallible(),
}

timestamp_pretty {
args: func_args![
value: DateTime::parse_from_str("1983 Apr 13 12:09:14.274 +0000", "%Y %b %d %H:%M:%S%.3f %z")
.unwrap()
.with_timezone(&Utc),
pretty: true
],
want: Ok(r#""1983-04-13T12:09:14.274Z""#),
tdef: TypeDef::bytes().infallible(),
}

regex {
args: func_args![value: Regex::new("^a\\d+$").unwrap()],
want: Ok(r#""^a\\d+$""#),
tdef: TypeDef::bytes().infallible(),
}

regex_pretty {
args: func_args![value: Regex::new("^a\\d+$").unwrap(), pretty: true],
want: Ok(r#""^a\\d+$""#),
tdef: TypeDef::bytes().infallible(),
}

null {
args: func_args![value: Value::Null],
want: Ok("null"),
tdef: TypeDef::bytes().infallible(),
}

null_pretty {
args: func_args![value: Value::Null, pretty: true],
want: Ok("null"),
tdef: TypeDef::bytes().infallible(),
}
];
}