Skip to content

Fix validation for offsets of StructArrays #942

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

Merged
merged 2 commits into from
Nov 12, 2021
Merged

Fix validation for offsets of StructArrays #942

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2152220
reproduce validation error
bjchambers Nov 10, 2021
d565095
Fix validation bug
alamb Nov 11, 2021
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
108 changes: 103 additions & 5 deletions arrow/src/array/data.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -790,12 +790,11 @@ impl ArrayData {
for (i, field) in fields.iter().enumerate() {
let field_data = self.get_valid_child_data(i, field.data_type())?;

// C++ does this check, but it is not clear why
// field_data checks only len, but self checks len+offset
if field_data.len < (self.len + self.offset) {
// Ensure child field has sufficient size
if field_data.len < self.len {
return Err(ArrowError::InvalidArgumentError(format!(
"{} child array #{} for field {} has length smaller than expected for struct array ({} < {})",
self.data_type, i, field.name(), field_data.len, self.len + self.offset
self.data_type, i, field.name(), field_data.len, self.len
)));
}
}
Expand Down Expand Up @@ -1114,7 +1113,9 @@ impl ArrayDataBuilder {
mod tests {
use super::*;

use crate::array::{Array, Int32Array, StringArray};
use crate::array::{
Array, BooleanBuilder, Int32Array, Int32Builder, StringArray, StructBuilder,
};
use crate::buffer::Buffer;
use crate::datatypes::Field;
use crate::util::bit_util;
Expand Down Expand Up @@ -1640,4 +1641,101 @@ mod tests {
fn make_f32_buffer(n: usize) -> Buffer {
Buffer::from_slice_ref(&vec![42f32; n])
}

#[test]
fn test_try_new_sliced_struct() {
let mut builder = StructBuilder::new(
vec![
Field::new("a", DataType::Int32, true),
Field::new("b", DataType::Boolean, true),
],
vec![
Box::new(Int32Builder::new(5)),
Box::new(BooleanBuilder::new(5)),
],
);

// struct[0] = { a: 10, b: true }
builder
.field_builder::<Int32Builder>(0)
.unwrap()
.append_option(Some(10))
.unwrap();
builder
.field_builder::<BooleanBuilder>(1)
.unwrap()
.append_option(Some(true))
.unwrap();
builder.append(true).unwrap();

// struct[1] = null
builder
.field_builder::<Int32Builder>(0)
.unwrap()
.append_option(None)
.unwrap();
builder
.field_builder::<BooleanBuilder>(1)
.unwrap()
.append_option(None)
.unwrap();
builder.append(false).unwrap();

// struct[2] = { a: null, b: false }
builder
.field_builder::<Int32Builder>(0)
.unwrap()
.append_option(None)
.unwrap();
builder
.field_builder::<BooleanBuilder>(1)
.unwrap()
.append_option(Some(false))
.unwrap();
builder.append(true).unwrap();

// struct[3] = { a: 21, b: null }
builder
.field_builder::<Int32Builder>(0)
.unwrap()
.append_option(Some(21))
.unwrap();
builder
.field_builder::<BooleanBuilder>(1)
.unwrap()
.append_option(None)
.unwrap();
builder.append(true).unwrap();

// struct[4] = { a: 18, b: false }
builder
.field_builder::<Int32Builder>(0)
.unwrap()
.append_option(Some(18))
.unwrap();
builder
.field_builder::<BooleanBuilder>(1)
.unwrap()
.append_option(Some(false))
.unwrap();
builder.append(true).unwrap();

let struct_array = builder.finish();
let struct_array_slice = struct_array.slice(1, 3);
let struct_array_data = struct_array_slice.data();

let cloned_data = ArrayData::try_new(
struct_array_slice.data_type().clone(),
struct_array_slice.len(),
None, // force new to compute the number of null bits
struct_array_data.null_buffer().cloned(),
struct_array_slice.offset(),
struct_array_data.buffers().to_vec(),
struct_array_data.child_data().to_vec(),
)
.unwrap();
let cloned = crate::array::make_array(cloned_data);

assert_eq!(&struct_array_slice, &cloned);
}
}