Skip to content

planner: fix NATURAL JOIN column resolution through LogicalApply#66811

Open
qw4990 wants to merge 5 commits intopingcap:masterfrom
qw4990:fix-60602
Open

planner: fix NATURAL JOIN column resolution through LogicalApply#66811
qw4990 wants to merge 5 commits intopingcap:masterfrom
qw4990:fix-60602

Conversation

@qw4990
Copy link
Contributor

@qw4990 qw4990 commented Mar 9, 2026

What problem does this PR solve?

Issue Number: close #60602

Problem Summary: planner: fix NATURAL JOIN column resolution through LogicalApply

What changed and how does it work?

The correlated scalar subquery causes the plan builder to wrap the NATURAL JOIN inside a LogicalApply node. Two functions that resolve qualified columns from a NATURAL JOIN's FullSchema/FullNames — findFieldNameFromNaturalUsingJoin and findColFromNaturalUsingJoin — only handle *LogicalJoin in their type switches. Since LogicalApply is a distinct Go type (even though it embeds LogicalJoin), the switch falls through, failing to resolve the column and causing either an "unknown column" error or a nil-pointer panic.

Check List

Tests

  • Unit test
  • Integration test
  • Manual test (add detailed scripts or steps below)
  • No need to test
    • I checked and no code files have been changed.

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

Please refer to Release Notes Language Style Guide to write a quality release note.

None

Summary by CodeRabbit

  • Tests

    • Added extensive test coverage and test data for NATURAL JOIN with correlated subqueries, including multiple case variations, expected plans/results, and harness changes to preload and expose suite data. Sharding for the test run increased to exercise more parallel cases.
  • Bug Fixes

    • Improved column/field resolution so NATURAL JOINs involving correlated subqueries resolve correctly through additional join constructs.
  • Documentation

    • Updated planner test map descriptions to reflect NATURAL JOIN resolution through Apply.

@ti-chi-bot ti-chi-bot bot added the release-note-none Denotes a PR that doesn't merit a release note. label Mar 9, 2026
@pantheon-ai
Copy link

pantheon-ai bot commented Mar 9, 2026

@qw4990 I've received your pull request and will start the review. I'll conduct a thorough review covering code quality, potential issues, and implementation details.

⏳ This process typically takes 10-30 minutes depending on the complexity of the changes.

ℹ️ Learn more details on Pantheon AI.

@ti-chi-bot ti-chi-bot bot added size/S Denotes a PR that changes 10-29 lines, ignoring generated files. sig/planner SIG: Planner labels Mar 9, 2026
@tiprow
Copy link

tiprow bot commented Mar 9, 2026

Hi @qw4990. Thanks for your PR.

PRs from untrusted users cannot be marked as trusted with /ok-to-test in this repo meaning untrusted PR authors can never trigger tests themselves. Collaborators can still trigger tests on the PR using /test all.

I understand the commands that are listed here.

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.

@qw4990 qw4990 added AI-Correction Bugfix by AI and removed sig/planner SIG: Planner labels Mar 9, 2026
@coderabbitai
Copy link

coderabbitai bot commented Mar 9, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

Run ID: 68e1ce22-a9a3-41b0-9131-a0f6385c372c

📥 Commits

Reviewing files that changed from the base of the PR and between f5d8181 and dc0e297.

📒 Files selected for processing (3)
  • pkg/planner/core/casetest/correlated/correlated_test.go
  • pkg/planner/core/casetest/correlated/testdata/correlated_subquery_suite_out.json
  • pkg/planner/core/casetest/correlated/testdata/correlated_subquery_suite_xut.json
🚧 Files skipped from review as they are similar to previous changes (3)
  • pkg/planner/core/casetest/correlated/testdata/correlated_subquery_suite_out.json
  • pkg/planner/core/casetest/correlated/testdata/correlated_subquery_suite_xut.json
  • pkg/planner/core/casetest/correlated/correlated_test.go

📝 Walkthrough

Walkthrough

Adds LogicalApply traversal for NATURAL/USING name/column resolution, plus new correlated-subquery tests and testdata; updates test harness and BUILD to include testdata, deps, and increase test shard count.

Changes

Cohort / File(s) Summary
Planner field/column resolution
pkg/planner/core/expression_rewriter.go, pkg/planner/core/logical_plan_builder.go
Extend findFieldNameFromNaturalUsingJoin and findColFromNaturalUsingJoin to descend into LogicalApply by delegating lookup to its first child, enabling resolution through Apply nodes.
Correlated tests & harness
pkg/planner/core/casetest/correlated/correlated_test.go, pkg/planner/core/casetest/correlated/main_test.go, pkg/planner/core/casetest/correlated/BUILD.bazel
Add new test(s) exercising NATURAL/LEFT JOIN with correlated subqueries, introduce test-data registry and accessor, add data = glob(["testdata/**"]), increase shard_count 2→3, and add deps //pkg/testkit/testdata, //pkg/testkit/testmain.
Testdata (new suites)
pkg/planner/core/casetest/correlated/testdata/correlated_subquery_suite_in.json, pkg/planner/core/casetest/correlated/testdata/correlated_subquery_suite_out.json, pkg/planner/core/casetest/correlated/testdata/correlated_subquery_suite_xut.json
Add input/output/XUT JSON files defining the TestNaturalJoinWithCorrelatedSubquery suite (multiple cases covering natural/inner/left join variants) with expected plans and results.
Docs / mapping
.agents/skills/tidb-test-guidelines/references/planner-case-map.md
Expand correlated-tests description to include NATURAL JOIN resolution through Apply nodes.

Sequence Diagram(s)

(omitted)

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Possibly related PRs

Suggested reviewers

  • winoros
  • AilinKid
  • guo-shaoge

Poem

"🐇 I hopped through plans and tests tonight,
Applied my nose where names took flight.
Through Apply I peeked, found columns true,
Testdata stacked, the cases grew.
A rabbit's cheer — the join's in sight!"

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 14.29% 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 accurately and specifically describes the main change: fixing NATURAL JOIN column resolution when the join is wrapped in LogicalApply.
Description check ✅ Passed The description covers all required template sections with clear problem statement, solution explanation, and proper issue linking (#60602), though release-note could be more detailed.
Linked Issues check ✅ Passed The PR fully addresses issue #60602 by adding LogicalApply case handling to column resolution functions and comprehensive test coverage for NATURAL JOIN with correlated subqueries.
Out of Scope Changes check ✅ Passed All changes are directly scoped to fixing NATURAL JOIN column resolution through LogicalApply: code fixes, test additions, test data, and documentation updates are all aligned with issue #60602.

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

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

Warning

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 golangci-lint (2.5.0)

Command failed


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

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

@qw4990
Copy link
Contributor Author

qw4990 commented Mar 9, 2026

@pantheon-ai please review

@pantheon-ai
Copy link

pantheon-ai bot commented Mar 9, 2026

Review Complete

Findings: 0 issues
Posted: 0
Duplicates/Skipped: 0

ℹ️ Learn more details on Pantheon AI.

@hawkingrei
Copy link
Member

/ok-to-test

@ti-chi-bot ti-chi-bot bot added the ok-to-test Indicates a PR is ready to be tested. label Mar 9, 2026
@qw4990
Copy link
Contributor Author

qw4990 commented Mar 9, 2026

/retest

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

🧹 Nitpick comments (1)
pkg/planner/core/casetest/correlated/correlated_test.go (1)

82-88: Please cover the reported NATURAL LEFT JOIN shape too.

This regression locks the Apply-wrapped NATURAL JOIN path, but issue #60602 was triggered by NATURAL LEFT JOIN with a right-side qualified column. Swapping one assertion to NATURAL LEFT JOIN or adding a third case would pin the exact failing shape with almost no extra test cost.

🧪 Minimal test tweak
-	tk.MustQuery("select 0 from t t1 where exists (select a2.a from t a1 natural join t a2 where t1.a = (select min(t1.a)))").Check(
+	tk.MustQuery("select 0 from t t1 where exists (select a2.a from t a1 natural left join t a2 where t1.a = (select min(t1.a)))").Check(
 		testkit.Rows("0", "0"))
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@pkg/planner/core/casetest/correlated/correlated_test.go` around lines 82 -
88, Add a test covering the NATURAL LEFT JOIN shape: extend the existing
correlated_test.go cases that exercise NATURAL JOIN wrapped in an Apply by
adding (or replacing one of) the tk.MustQuery assertions to use "natural left
join" (e.g. mirror the two existing queries that use "natural join" but change
one to "natural left join" so the right-side qualified column path is
exercised); this will pin the regression triggered by NATURAL LEFT JOIN and
ensures findFieldNameFromNaturalUsingJoin's Apply-recursion is validated.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Nitpick comments:
In `@pkg/planner/core/casetest/correlated/correlated_test.go`:
- Around line 82-88: Add a test covering the NATURAL LEFT JOIN shape: extend the
existing correlated_test.go cases that exercise NATURAL JOIN wrapped in an Apply
by adding (or replacing one of) the tk.MustQuery assertions to use "natural left
join" (e.g. mirror the two existing queries that use "natural join" but change
one to "natural left join" so the right-side qualified column path is
exercised); this will pin the regression triggered by NATURAL LEFT JOIN and
ensures findFieldNameFromNaturalUsingJoin's Apply-recursion is validated.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

Run ID: 461bcdc7-ce0f-4194-8eb4-a5f1ab75c4ea

📥 Commits

Reviewing files that changed from the base of the PR and between 960e7c5 and c1ff220.

📒 Files selected for processing (4)
  • pkg/planner/core/casetest/correlated/BUILD.bazel
  • pkg/planner/core/casetest/correlated/correlated_test.go
  • pkg/planner/core/expression_rewriter.go
  • pkg/planner/core/logical_plan_builder.go

@qw4990
Copy link
Contributor Author

qw4990 commented Mar 9, 2026

/rebuild

@qw4990
Copy link
Contributor Author

qw4990 commented Mar 9, 2026

/test check-dev
/test mysql-test

@tiprow
Copy link

tiprow bot commented Mar 9, 2026

@qw4990: The specified target(s) for /test were not found.
The following commands are available to trigger required jobs:

/test fast_test_tiprow
/test tidb_parser_test

Use /test all to run all jobs.

Details

In response to this:

/test check-dev
/test mysql-test

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.

@qw4990
Copy link
Contributor Author

qw4990 commented Mar 9, 2026

/retest

Copy link

@pantheon-ai pantheon-ai bot left a comment

Choose a reason for hiding this comment

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

✅ Code looks good. No issues found.

@codecov
Copy link

codecov bot commented Mar 9, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 77.0581%. Comparing base (960e7c5) to head (dc0e297).
⚠️ Report is 10 commits behind head on master.

Additional details and impacted files
@@               Coverage Diff                @@
##             master     #66811        +/-   ##
================================================
- Coverage   77.6702%   77.0581%   -0.6122%     
================================================
  Files          2009       1930        -79     
  Lines        549988     539529     -10459     
================================================
- Hits         427177     415751     -11426     
- Misses       121102     123760      +2658     
+ Partials       1709         18      -1691     
Flag Coverage Δ
integration 41.1300% <33.3333%> (-7.0578%) ⬇️
unit 76.0240% <100.0000%> (-0.2267%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Components Coverage Δ
dumpling 56.7974% <ø> (ø)
parser ∅ <ø> (∅)
br 48.7188% <ø> (-12.2069%) ⬇️
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@qw4990
Copy link
Contributor Author

qw4990 commented Mar 9, 2026

/test unit-test

@tiprow
Copy link

tiprow bot commented Mar 9, 2026

@qw4990: The specified target(s) for /test were not found.
The following commands are available to trigger required jobs:

/test fast_test_tiprow
/test tidb_parser_test

Use /test all to run all jobs.

Details

In response to this:

/test unit-test

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.

@qw4990
Copy link
Contributor Author

qw4990 commented Mar 9, 2026

/rebuild

@qw4990
Copy link
Contributor Author

qw4990 commented Mar 9, 2026

/test mysql-test

@tiprow
Copy link

tiprow bot commented Mar 9, 2026

@qw4990: The specified target(s) for /test were not found.
The following commands are available to trigger required jobs:

/test fast_test_tiprow
/test tidb_parser_test

Use /test all to run all jobs.

Details

In response to this:

/test mysql-test

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.

@qw4990
Copy link
Contributor Author

qw4990 commented Mar 9, 2026

/test mysql-test

@tiprow
Copy link

tiprow bot commented Mar 9, 2026

@qw4990: The specified target(s) for /test were not found.
The following commands are available to trigger required jobs:

/test fast_test_tiprow
/test tidb_parser_test

Use /test all to run all jobs.

Details

In response to this:

/test mysql-test

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.

@hawkingrei
Copy link
Member

/retest

@ti-chi-bot ti-chi-bot bot added the needs-1-more-lgtm Indicates a PR needs 1 more LGTM. label Mar 9, 2026
@qw4990
Copy link
Contributor Author

qw4990 commented Mar 9, 2026

/test mysql-test

@tiprow
Copy link

tiprow bot commented Mar 9, 2026

@qw4990: The specified target(s) for /test were not found.
The following commands are available to trigger required jobs:

/test fast_test_tiprow
/test tidb_parser_test

Use /test all to run all jobs.

Details

In response to this:

/test mysql-test

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.

Comment on lines +74 to +89
func TestNaturalJoinWithCorrelatedSubquery(t *testing.T) {
store := testkit.CreateMockStore(t)
tk := testkit.NewTestKit(t, store)
tk.MustExec("use test")
tk.MustExec("drop table if exists t")
tk.MustExec("create table t (a int)")
tk.MustExec("insert into t values (1), (2)")

// NATURAL JOIN wraps the join inside a LogicalApply when there's a
// correlated scalar subquery; findFieldNameFromNaturalUsingJoin must
// recurse through the Apply to resolve the right-side qualified column.
tk.MustQuery("select 0 from t t1 where exists (select a2.a from t a1 natural join t a2 where t1.a = (select min(t1.a)))").Check(
testkit.Rows("0", "0"))
tk.MustQuery("select 0 from t t1 where exists (select a1.a from t a1 natural join t a2 where t1.a = (select min(t1.a)))").Check(
testkit.Rows("0", "0"))
}
Copy link
Member

Choose a reason for hiding this comment

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

Where should we put the test? @hawkingrei
From #66760, these tests themselves also introduce build costs.

Copy link
Member

Choose a reason for hiding this comment

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

There are only two tests in this directory, so the overhead should be manageable.

@winoros
Copy link
Member

winoros commented Mar 9, 2026

I'm fine with the change. We can merge it tomorrow if we don't know the best practice of the test.

@qw4990
Copy link
Contributor Author

qw4990 commented Mar 10, 2026

/test mysql-test

@tiprow
Copy link

tiprow bot commented Mar 10, 2026

@qw4990: The specified target(s) for /test were not found.
The following commands are available to trigger required jobs:

/test fast_test_tiprow
/test tidb_parser_test

Use /test all to run all jobs.

Details

In response to this:

/test mysql-test

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.

@qw4990
Copy link
Contributor Author

qw4990 commented Mar 10, 2026

/test mysql-test

@tiprow
Copy link

tiprow bot commented Mar 10, 2026

@qw4990: The specified target(s) for /test were not found.
The following commands are available to trigger required jobs:

/test fast_test_tiprow
/test tidb_parser_test

Use /test all to run all jobs.

Details

In response to this:

/test mysql-test

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.

@ti-chi-bot ti-chi-bot bot added lgtm and removed needs-1-more-lgtm Indicates a PR needs 1 more LGTM. labels Mar 10, 2026
@ti-chi-bot
Copy link

ti-chi-bot bot commented Mar 10, 2026

[LGTM Timeline notifier]

Timeline:

  • 2026-03-09 14:29:01.1043521 +0000 UTC m=+273972.616409771: ☑️ agreed by hawkingrei.
  • 2026-03-10 02:23:20.599415518 +0000 UTC m=+316832.111473179: ☑️ agreed by AilinKid.

@hawkingrei
Copy link
Member

/retest

@qw4990
Copy link
Contributor Author

qw4990 commented Mar 10, 2026

/test unit-test

@tiprow
Copy link

tiprow bot commented Mar 10, 2026

@qw4990: The specified target(s) for /test were not found.
The following commands are available to trigger required jobs:

/test fast_test_tiprow
/test tidb_parser_test

Use /test all to run all jobs.

Details

In response to this:

/test unit-test

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.

@hawkingrei
Copy link
Member

/retest

@ti-chi-bot
Copy link

ti-chi-bot bot commented Mar 10, 2026

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

Test name Commit Details Required Rerun command
idc-jenkins-ci-tidb/unit-test c1ff220 link unknown /test 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.

@hawkingrei
Copy link
Member

/retest

@ti-chi-bot ti-chi-bot bot added sig/planner SIG: Planner size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Mar 10, 2026
@ti-chi-bot
Copy link

ti-chi-bot bot commented Mar 10, 2026

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: AilinKid, guo-shaoge, hawkingrei

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

The pull request process is described here

Details Needs approval from an approver in each of these files:

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

@ti-chi-bot ti-chi-bot bot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Mar 10, 2026
@hawkingrei
Copy link
Member

I updated some test cases.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

AI-Correction Bugfix by AI approved lgtm ok-to-test Indicates a PR is ready to be tested. release-note-none Denotes a PR that doesn't merit a release note. sig/planner SIG: Planner size/L Denotes a PR that changes 100-499 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

sql return error:Unknown column 'a2.col_bigint' in 'field list'

5 participants