[hotfix][docs] Document node digests and golden-file traps in the planner AGENTS.md - #29240
Draft
MartijnVisser wants to merge 1 commit into
Draft
MartijnVisser wants to merge 1 commit into
MartijnVisser wants to merge 1 commit into
Conversation
…nner AGENTS.md - Calcite equivalence and SubplanReuser identify a physical node by its explainTerms digest - A plan test case missing from the reference .xml records the current plan as the golden - Restore-test compiled plans are inputs whose description strings drift after a digest change - Put -am back after switching branches or worktrees Generated-by: Claude Code (Claude Fable 5.1)
Open
1 task
Collaborator
snuyanzin
reviewed
Sep 19, 2026
| Then: | ||
| 1. Register in `FlinkStreamRuleSets.scala` and/or `FlinkBatchRuleSets.scala` | ||
| 2. Plan tests with XML golden files — when the test fails, copy the framework's generated log file over the reference `.xml` (cases are ordered alphabetically by method name) | ||
| 2. Plan tests with XML golden files. When a test fails, copy the generated `<Class>_actual.xml` over the reference `.xml` (cases are ordered alphabetically by method name). A case missing from the reference also fails and the current plan is written to that file, or straight into the reference when it is empty. For a bug fix, write the expected case by hand, or the golden records the bug. `explain/**/*.out` files are plain string goldens; `ExplainTest` regenerates its own under `PLAN_TEST_FORCE_OVERWRITE`, the others are edited by hand. |
Contributor
There was a problem hiding this comment.
about xml sounds like super complicated approach...
after FLINK-38609
the approach for xml
- drop
xml - run all the tests from the specific class (it will fail however it will create a renewed
xml) - run again to double check it is green now
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What is the purpose of the change
AGENTS.mdthe traps that cost time on FLINK-36808 ([FLINK-36808][table-planner] Include pushed-down source abilities in the lookup join digest #29200)Brief change log
.outgoldens-amback after switching branches or worktreesVerifying this change
This change is a trivial rework / code cleanup without any test coverage.
Does this pull request potentially affect one of the following parts:
@Public(Evolving): noDocumentation
Was generative AI tooling used to co-author this PR?
Generated-by: Claude Code (Claude Fable 5.1)