Skip to content

Conversation

@2010YOUY01
Copy link
Contributor

Which issue does this PR close?

Rationale for this change

See issue for the rationale and example.

This PR introduces the following macros to make invariant checks and throwing internal errors easier, and also let the error message include more assertion details if it failed (what's the expected/actual value), to make debugging easier.

  • assert_or_internal_err!()
  • assert_eq_or_internal_err!()
  • assert_ne_or_internal_err!()
// before
if field.name() != expected.name() {
    return internal_err!(
        "Field name mismatch at index {}: expected '{}', found '{}'",
        idx,
        expected.name(),
        field.name()
    );
}

// after
assert_eq_or_internal_err!(
    field.name(),
    expected.name(),
    "Field name mismatch at index {}",
    idx
);

If the assertion fails, the error now reads:

Internal error: Assertion failed: field.name() == expected.name() (left: "foo", right: "bar"): Field name mismatch at index 3.

What changes are included in this PR?

  1. Add macros and UTs to test
  2. Updated a few internal error patterns that are applicable for this macro

Are these changes tested?

UTs

Are there any user-facing changes?

No

@github-actions github-actions bot added core Core DataFusion crate common Related to common crate labels Nov 6, 2025
Copy link
Contributor

@alamb alamb left a comment

Choose a reason for hiding this comment

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

Thanks @2010YOUY01 -- this looks like an improvement to me ❤️

Copy link
Member

@Weijun-H Weijun-H left a comment

Choose a reason for hiding this comment

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

LGTM! Thanks @2010YOUY01

2010YOUY01 and others added 2 commits November 9, 2025 09:41
Co-authored-by: Alex Huang <huangweijun1001@gmail.com>
@2010YOUY01
Copy link
Contributor Author

Thanks @alamb and @Weijun-H, I'll open issues for refactoring with this macro soon.

@2010YOUY01 2010YOUY01 added this pull request to the merge queue Nov 9, 2025
Merged via the queue into apache:main with commit c728d54 Nov 9, 2025
28 checks passed
codetyri0n pushed a commit to codetyri0n/datafusion that referenced this pull request Nov 11, 2025
…rnal invariant checks (apache#18511)

## Which issue does this PR close?

<!--
We generally require a GitHub issue to be filed for all bug fixes and
enhancements and this helps us generate change logs for our releases.
You can link an issue to this PR using the GitHub syntax. For example
`Closes apache#123` indicates that this PR will close issue apache#123.
-->

- Closes apache#15492

## Rationale for this change

<!--
Why are you proposing this change? If this is already explained clearly
in the issue then this section is not needed.
Explaining clearly why changes are proposed helps reviewers understand
your changes and offer better suggestions for fixes.
-->
See issue for the rationale and example.

This PR introduces the following macros to make invariant checks and
throwing internal errors easier, and also let the error message include
more assertion details if it failed (what's the expected/actual value),
to make debugging easier.
- `assert_or_internal_err!()`
- `assert_eq_or_internal_err!()`
- `assert_ne_or_internal_err!()`

```rust
// before
if field.name() != expected.name() {
    return internal_err!(
        "Field name mismatch at index {}: expected '{}', found '{}'",
        idx,
        expected.name(),
        field.name()
    );
}

// after
assert_eq_or_internal_err!(
    field.name(),
    expected.name(),
    "Field name mismatch at index {}",
    idx
);
```
If the assertion fails, the error now reads:

```
Internal error: Assertion failed: field.name() == expected.name() (left: "foo", right: "bar"): Field name mismatch at index 3.
```


## What changes are included in this PR?

<!--
There is no need to duplicate the description in the issue here but it
is sometimes worth providing a summary of the individual changes in this
PR.
-->
1. Add macros and UTs to test
2. Updated a few internal error patterns that are applicable for this
macro

## Are these changes tested?

<!--
We typically require tests for all PRs in order to:
1. Prevent the code from being accidentally broken by subsequent changes
3. Serve as another way to document the expected behavior of the code

If tests are not included in your PR, please explain why (for example,
are they covered by existing tests)?
-->
UTs

## Are there any user-facing changes?
No
<!--
If there are user-facing changes then we may require documentation to be
updated before approving the PR.
-->

<!--
If there are any breaking changes to public APIs, please add the `api
change` label.
-->

---------

Co-authored-by: Alex Huang <huangweijun1001@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

common Related to common crate core Core DataFusion crate

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Support macro ensure_or_internal_err to clean up repeated sanity checks

3 participants