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.

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

fix: coerce_primitive for serde decoded data #5101

Merged
merged 4 commits into from
Nov 21, 2023
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
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
38 changes: 37 additions & 1 deletion arrow-json/src/reader/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -717,7 +717,9 @@ mod tests {

use arrow_array::cast::AsArray;
use arrow_array::types::Int32Type;
use arrow_array::{make_array, Array, BooleanArray, ListArray, StringArray, StructArray};
use arrow_array::{
make_array, Array, BooleanArray, Float64Array, ListArray, StringArray, StructArray,
};
use arrow_buffer::{ArrowNativeType, Buffer};
use arrow_cast::display::{ArrayFormatter, FormatOptions};
use arrow_data::ArrayDataBuilder;
Expand Down Expand Up @@ -2259,4 +2261,38 @@ mod tests {
.values();
assert_eq!(values, &[1699148028689, 2, 3, 4]);
}

#[test]
fn test_coercing_primitive_into_string_decoder() {
let buf = r#"[
{"a": 1, "b": "A", "c": "T"},
{"a": 2, "b": "BB", "c": "F"},
{"a": 3, "b": 123, "c": false}
]"#;
Copy link
Contributor

@tustvold tustvold Nov 20, 2023

Choose a reason for hiding this comment

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

Perhaps we could test with some numbers that are larger than i32::MAX, i.e. require i64

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Perhaps we could test with some numbers that are larger than i32::MAX, i.e. require i64

done, add i32::MAX and like i64::MAX tests.

let schema = Schema::new(vec![
Field::new("a", DataType::Float64, true),
Field::new("b", DataType::Utf8, true),
Field::new("c", DataType::Utf8, true),
]);
let json_array: Vec<serde_json::Value> = serde_json::from_str(buf).unwrap();
let schema_ref = Arc::new(schema);

// read record batches
let reader = ReaderBuilder::new(schema_ref.clone()).with_coerce_primitive(true);
let mut decoder = reader.build_decoder().unwrap();
decoder.serialize(json_array.as_slice()).unwrap();
let batch = decoder.flush().unwrap().unwrap();
assert_eq!(
batch,
RecordBatch::try_new(
schema_ref,
vec![
Arc::new(Float64Array::from(vec![1.0, 2.0, 3.0])),
Arc::new(StringArray::from(vec!["A", "BB", "0"])),
Arc::new(StringArray::from(vec!["T", "F", "false"])),
]
)
.unwrap()
);
}
}
16 changes: 15 additions & 1 deletion arrow-json/src/reader/string_array.rs
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,15 @@ impl<O: OffsetSizeTrait> ArrayDecoder for StringArrayDecoder<O> {
TapeElement::Number(idx) if coerce_primitive => {
data_capacity += tape.get_string(idx).len();
}
_ => return Err(tape.error(*p, "string")),
TapeElement::I64(n) | TapeElement::I32(n) if coerce_primitive => {
data_capacity += n.to_string().len();
}
TapeElement::F32(n) | TapeElement::F64(n) if coerce_primitive => {
data_capacity += n.to_string().len();
}
Copy link
Contributor

@tustvold tustvold Nov 20, 2023

Choose a reason for hiding this comment

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

Suggested change
TapeElement::I64(n) | TapeElement::I32(n) if coerce_primitive => {
data_capacity += n.to_string().len();
}
TapeElement::F32(n) | TapeElement::F64(n) if coerce_primitive => {
data_capacity += n.to_string().len();
}
TapeElement::I64(n) | TapeElement::I32(n) | TapeElement::F32(n) | TapeElement::F64(n) => {
data_capacity += 10; // An arbitrary estimate
}

This avoids serializing to a string multiple times, this could be improved if it becomes a bottleneck, but this is probably good enough

Copy link
Contributor Author

Choose a reason for hiding this comment

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

This improvement looks good.

_ => {
return Err(tape.error(*p, "string"));
}
}
}

Expand Down Expand Up @@ -89,6 +97,12 @@ impl<O: OffsetSizeTrait> ArrayDecoder for StringArrayDecoder<O> {
TapeElement::Number(idx) if coerce_primitive => {
builder.append_value(tape.get_string(idx));
}
TapeElement::I64(n) | TapeElement::I32(n) if coerce_primitive => {
Copy link
Contributor

Choose a reason for hiding this comment

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

The handling of I64 is incorrect here, this will only use the low bits. There are some examples elsewhere in how to interpret this tape element

Copy link
Contributor Author

Choose a reason for hiding this comment

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

The handling of I64 is incorrect here, this will only use the low bits. There are some examples elsewhere in how to interpret this tape element

I'm a little confused about the design here. Why we don't use a i64 to save the value?

Copy link
Contributor

@tustvold tustvold Nov 20, 2023

Choose a reason for hiding this comment

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

Because the TapeElement would then need to increase in size from the current 64-bits to 128-bits (for alignment reasons), tape decoding is exceptionally hot and so concerns like this actually matter 😅

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Because the TapeElement would then need to increase in size from the current 64-bits to 128-bits (for alignment reasons), tape decoding is exceptionally hot and so concerns like this actually matter 😅

I get it. Just for performance. 😺

builder.append_value(n.to_string());
}
TapeElement::F32(n) | TapeElement::F64(n) if coerce_primitive => {
Copy link
Contributor

Choose a reason for hiding this comment

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

Can you do the same for f64 please 😄

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Can you do the same for f64 please 😄

done.

builder.append_value(n.to_string());
}
_ => unreachable!(),
}
}
Expand Down
Loading