executor: disable runtime filter on join key type mismatch

[ChangRui-Ryan]

What problem does this PR solve?

Issue Number: close #10699

Problem Summary:

What is changed and how it works?

Check List

Tests

• Unit test
• Integration test
• Manual test (add detailed scripts or steps below)
• No code

Side effects

• Performance regression: Consumes more CPU
• Performance regression: Consumes more Memory
• Breaking backward compatibility

Documentation

• Affects user behaviors
• Contains syntax changes
• Contains variable changes
• Contains experimental features
• Changes MySQL compatibility

Release note

None

Summary by CodeRabbit

• Bug Fixes

  • Runtime filters are now conservatively disabled when join key field types differ or signed/unsigned flags conflict; an informational log records the reason and empty filter lists are used to avoid incorrect pruning and preserve correct join results.

• Tests

  • Added tests validating runtime filters are disabled for several join key type-mismatch scenarios across execution modes, confirming unchanged plans and results.

[ti-chi-bot]

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign schrodingerzhu for approval. For more information see the Code Review Process.
Please ensure that each of them provides their approval before proceeding.

The full list of commands accepted by this bot can be found here.

Details

Needs approval from an approver in each of these files:

• OWNERS

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

[coderabbitai]

📝 Walkthrough

Walkthrough

Adds a conservative compatibility check that disables generation of join runtime filters when join key protobuf field types or integer signed/unsigned flags differ; runtime_filter_list is generated only when compatible (otherwise an empty list). Adds tests validating runtime filters are disabled for type-mismatch scenarios.

Changes

Cohort / File(s)	Summary
Runtime Filter Type Guard dbms/src/Flash/Planner/Plans/PhysicalJoin.cpp	Add is_join_key_field_type_compatible lambda to compare protobuf field types and signed/unsigned for integer-like types; conditionally call genRuntimeFilterList only when compatible. Use an empty runtime_filter_list when incompatible and emit an informational log. Add #include <Flash/Coprocessor/DAGUtils.h>.
Runtime Filter Type Mismatch Tests dbms/src/Flash/tests/gtest_runtime_filter_disable_on_type_mismatch.cpp	Add GoogleTest suite RuntimeFilterDisableOnTypeMismatchTestRunner (deriving from ExecutorTest) and three tests: baseline, Int32 vs Int64 mismatch, Int32 vs UInt32 (signed/unsigned) mismatch. Each asserts runtime filters are disabled on mismatch and results match baseline.

Sequence Diagram(s)

(Skipped)

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~25 minutes

Poem

🐇 I sniffed the left and sniffed the right,

When types or signs gave me a fright,
I paused my leap and left things be,
No filters jumping where they shouldn't be,
A cautious hop keeps joins error-free.

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 50.00% which is insufficient. The required threshold is 80.00%.	Write docstrings for the functions missing them to satisfy the coverage threshold.

✅ Passed checks (4 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title clearly and concisely summarizes the main change: disabling runtime filters when join key types mismatch.
Description check	✅ Passed	The description follows the repository template with required sections completed: issue number provided, checklist selections made, and release note included. However, the commit-message section is empty.
Linked Issues check	✅ Passed	The code changes directly address the linked issue #10699 by adding runtime filter disablement logic for join key type mismatches and comprehensive test coverage validating the fix.
Out of Scope Changes check	✅ Passed	All changes are directly related to the stated objective: modifying runtime filter behavior for type mismatches and adding tests to validate the fix. No unrelated changes detected.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing touches

• 📝 Generate docstrings

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 1

🤖 Fix all issues with AI agents

In `@dbms/src/Flash/Planner/Plans/PhysicalJoin.cpp`:
- Around line 173-212: Rename the snake_case local symbols to camelCase: change
the lambda is_join_key_field_type_compatible to isJoinKeyFieldTypeCompatible,
the bool enable_runtime_filter to enableRuntimeFilter, and runtime_filter_list
to runtimeFilterList; update the lambda invocation and its use sites (the const
bool assignment and the ternary that builds runtimeFilterList using
tiflash_join.genRuntimeFilterList) so all references match the new camelCase
names and keep behavior unchanged.

[coderabbitai]

Actionable comments posted: 1

🤖 Fix all issues with AI agents

In `@dbms/src/Flash/tests/gtest_runtime_filter_disable_on_type_mismatch.cpp`:
- Around line 43-49: The loop variable name in the WrapForRuntimeFilterTestBegin
macro is declared as enablePipeline but the test code uses enable_pipeline,
causing a compile error; fix by making the identifier consistent—either change
the macro's loop variable to enable_pipeline or update all references (the
usages currently named enable_pipeline) to enablePipeline so the symbol matches,
ensuring WrapForRuntimeFilterTestBegin and all occurrences use the same
identifier.

🧹 Nitpick comments (2)

dbms/src/Flash/Planner/Plans/PhysicalJoin.cpp (1)

161-199: Conservative guard logic looks correct; minor style nit on redundant continue.

The lambda correctly checks:

1. Equal number of join keys
2. Both keys have valid field types
3. Same protobuf type (tp())
4. Same unsigned flag

One minor observation: the continue; on line 196 is redundant as it's at the end of the for-loop body.

🧹 Optional: remove redundant continue

             // Otherwise keep conservative: if we got here (same tp + same unsigned flag), treat as compatible.
-            continue;
         }
         return true;
     };

dbms/src/Flash/tests/gtest_runtime_filter_disable_on_type_mismatch.cpp (1)

43-49: Use the existing WRAP_FOR_TEST_BEGIN and WRAP_FOR_TEST_END macros from ExecutorTestUtils.h.

The file already imports ExecutorTestUtils.h and extends ExecutorTest, making it an executor test that should follow the established pattern. The custom WrapForRuntimeFilterTestBegin/End macros duplicate the existing WRAP_FOR_TEST_BEGIN/END macros and are already used consistently throughout other executor tests in dbms/src/Flash/tests/. Replace lines 43-49 with the standard macros to maintain consistency with the codebase pattern.

[coderabbitai]

⚠️ Potential issue | 🔴 Critical

Variable name mismatch will cause compilation error.

The macro defines loop variable enablePipeline (camelCase), but lines 87, 102, and 117 reference enable_pipeline (snake_case). This will fail to compile.

🐛 Proposed fix

 `#define` WrapForRuntimeFilterTestBegin             \
-    std::vector<bool> pipelineBools{false, true}; \
-    for (auto enablePipeline : pipelineBools)     \
+    std::vector<bool> pipeline_bools{false, true}; \
+    for (auto enable_pipeline : pipeline_bools)     \
     {                                             \
-        enablePipeline(enablePipeline);
+        enablePipeline(enable_pipeline);

Alternatively, update references at lines 87, 102, and 117 to use enablePipeline:

-            {"table_scan_0", {3, enable_pipeline ? concurrency : 1}},
+            {"table_scan_0", {3, enablePipeline ? concurrency : 1}},

Also applies to: 87-87

🤖 Prompt for AI Agents

In `@dbms/src/Flash/tests/gtest_runtime_filter_disable_on_type_mismatch.cpp`
around lines 43 - 49, The loop variable name in the
WrapForRuntimeFilterTestBegin macro is declared as enablePipeline but the test
code uses enable_pipeline, causing a compile error; fix by making the identifier
consistent—either change the macro's loop variable to enable_pipeline or update
all references (the usages currently named enable_pipeline) to enablePipeline so
the symbol matches, ensuring WrapForRuntimeFilterTestBegin and all occurrences
use the same identifier.

[ti-chi-bot]

@ChangRui-Ryan: The following tests failed, say /retest to rerun all failed tests or /retest-required to rerun all mandatory failed tests:

Test name	Commit	Details	Required	Rerun command
pull-unit-next-gen	12f0add	link	true	/test pull-unit-next-gen
pull-unit-test	12f0add	link	true	/test pull-unit-test

Full PR test history. Your PR dashboard.

Details

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here.