[SPARK-58204][SQL] Fix unprotected mutable state in RegExpReplace, RegExpExtractBase, StringTranslate, FormatNumber, and NamedLambdaVariable by marking them stateful#57353
Open
vinodkc wants to merge 1 commit into
Conversation
…gExpExtractBase, StringTranslate, FormatNumber, and NamedLambdaVariable by marking them stateful
HyukjinKwon
reviewed
Jul 19, 2026
HyukjinKwon
left a comment
Member
There was a problem hiding this comment.
0 blocking, 0 non-blocking, 0 nits.
Clean, well-targeted fix that follows the established stateful pattern and correctly handles the LeafExpression special case. No findings.
Verification
Traced the correctness of marking these five expressions stateful:
- No side effects beyond
freshCopyIfContainsStatefulExpression— a repo-wide sweep found no other behavioral consumer of the expression.statefulflag (subexpression elimination keys ondeterministic, notstateful), so there is no CSE / constant-folding / optimizer regression; every other.statefulhit is the streaming package name. NamedLambdaVariable(leaf) equivalence — with the newwithNewChildrenInternal, a fresh copy gets an independentAtomicReferencebut the sameexprId. Interpreted eval re-links body vars to the bound argument instances byexprId(functionsForEval), and codegen looks up lambda vars byexprId.id(getLambdaVar), so the split reference is re-unified at eval/codegen time — results are unchanged.exprIdpreservation is essential and correctly distinguishes this fromnewInstance(). Ordinary tree transforms don't reset the reference (leaf short-circuitswithNewChildren), onlyfreshCopydoes.- Fix completeness — swept every catalyst expression file for
@transient ... varmutable state: the five are the complete previously-unmarked set.StringRegexExpression(Like/RLike) uses an immutablelazy valcache and correctly stays unflagged;RegExpCount/RegExpSubStrareRuntimeReplaceabledelegating to the now-stateful extractors;RegExpInStrinherits fromRegExpExtractBase;RDG/Shufflewere already stateful. - Tests are meaningful — the
NamedLambdaVariabletest assertscopy.value ne lv.value, which is exactly the assertion that would fail without thewithNewChildrenInternaloverride, so it guards the leaf no-op the PR fixes.
HyukjinKwon
approved these changes
Jul 19, 2026
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
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 changes were proposed in this pull request?
Override
stateful: Boolean = trueon five Catalyst expressions that maintain mutable@transientstate but were not marked stateful:RegExpReplaceRegExpExtractBase(RegExpExtract,RegExpExtractAll)StringTranslateFormatNumberNamedLambdaVariableFor
NamedLambdaVariable, also overridewithNewChildrenInternalto reset theAtomicReferenceon copy while preservingexprId.LeafLike.withNewChildrenInternalreturnsthisby default, which would makefreshCopyIfContainsStatefulExpression()a no-op even with thestatefulflag set.Why are the changes needed?
freshCopyIfContainsStatefulExpression()only copies subtrees containing astateful = truenode. Without the override, these expressions are shared across projections. When two projections evaluate concurrently — e.g. viaConvertToLocalRelationon the driver or pipelined execution on executors — threads race on the shared@transientcache fields and silently corrupt results.Does this PR introduce any user-facing change?
No.
How was this patch tested?
Added one test per affected group in the existing suites (
HigherOrderFunctionsSuite,RegexpExpressionsSuite,StringExpressionsSuite), each assertingstateful == trueand thatfreshCopyIfContainsStatefulExpression()returns a distinct instance with independent state.Was this patch authored or co-authored using generative AI tooling?
No