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

feat: Check flags field of ArrowSchema on ArrowSchemaViewInit #368

Merged
merged 4 commits into from
Jan 26, 2024
Merged
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
Next Next commit
check flags on schema view init
paleolimbot committed Jan 25, 2024
commit 3db47c22d776e837c48b498b17b33f0fbe342e64
32 changes: 24 additions & 8 deletions src/nanoarrow/schema.c
Original file line number Diff line number Diff line change
@@ -1178,16 +1178,32 @@ ArrowErrorCode ArrowSchemaViewInit(struct ArrowSchemaView* schema_view,
schema_view->type = NANOARROW_TYPE_DICTIONARY;
}

result = ArrowSchemaViewValidate(schema_view, schema_view->storage_type, error);
if (result != NANOARROW_OK) {
return result;
}
NANOARROW_RETURN_NOT_OK(
ArrowSchemaViewValidate(schema_view, schema_view->storage_type, error));

if (schema_view->storage_type != schema_view->type) {
result = ArrowSchemaViewValidate(schema_view, schema_view->type, error);
if (result != NANOARROW_OK) {
return result;
}
NANOARROW_RETURN_NOT_OK(
ArrowSchemaViewValidate(schema_view, schema_view->type, error));
}

int64_t unknown_flags = schema->flags & ~ARROW_FLAG_DICTIONARY_ORDERED &
Copy link
Member

Choose a reason for hiding this comment

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

Would this be better as a macro or #define that is defined next to these other #defines? From a maintenance perspective, I'm mainly considering what happens if someone adds a new flag and forgets to update this part of the code.

Copy link
Member Author

Choose a reason for hiding this comment

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

Great idea!

~ARROW_FLAG_NULLABLE & ~ARROW_FLAG_MAP_KEYS_SORTED;
if (unknown_flags != 0) {
ArrowErrorSet(error, "Unknown ArrowSchema flag");
return EINVAL;
}

if (schema->flags & ARROW_FLAG_DICTIONARY_ORDERED &&
schema_view->type != NANOARROW_TYPE_DICTIONARY) {
ArrowErrorSet(error,
"ARROW_FLAG_DICTIONARY_ORDERED is only relevant for dictionaries");
return EINVAL;
}

if (schema->flags & ARROW_FLAG_MAP_KEYS_SORTED &&
schema_view->type != NANOARROW_TYPE_MAP) {
ArrowErrorSet(error, "ARROW_FLAG_MAP_KEYS_SORTED is only relevant for a map type");
return EINVAL;
}

ArrowLayoutInit(&schema_view->layout, schema_view->storage_type);
18 changes: 18 additions & 0 deletions src/nanoarrow/schema_test.cc
Original file line number Diff line number Diff line change
@@ -574,6 +574,24 @@ TEST(SchemaViewTest, SchemaViewInitErrors) {
EXPECT_STREQ(ArrowErrorMessage(&error),
"Error parsing schema->format 'n*': parsed 1/2 characters");

ASSERT_EQ(ArrowSchemaSetFormat(&schema, "n"), NANOARROW_OK);
schema.flags = 0;
schema.flags |= ARROW_FLAG_DICTIONARY_ORDERED;
EXPECT_EQ(ArrowSchemaViewInit(&schema_view, &schema, &error), EINVAL);
EXPECT_STREQ(ArrowErrorMessage(&error),
"ARROW_FLAG_DICTIONARY_ORDERED is only relevant for dictionaries");

schema.flags = 0;
schema.flags |= ARROW_FLAG_MAP_KEYS_SORTED;
EXPECT_EQ(ArrowSchemaViewInit(&schema_view, &schema, &error), EINVAL);
EXPECT_STREQ(ArrowErrorMessage(&error),
"ARROW_FLAG_MAP_KEYS_SORTED is only relevant for a map type");

schema.flags = 0;
schema.flags |= (ARROW_FLAG_MAP_KEYS_SORTED << 1);
Copy link
Member

Choose a reason for hiding this comment

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

We could use the new macro/define here to guarantee we always get an undefined value.

EXPECT_EQ(ArrowSchemaViewInit(&schema_view, &schema, &error), EINVAL);
EXPECT_STREQ(ArrowErrorMessage(&error), "Unknown ArrowSchema flag");

ArrowSchemaRelease(&schema);
}