Skip to content

Commit 96e2a12

Browse files
committed
[fix](fe) Replan expression-valued prepared statement parameters
### What problem does this PR solve? Related PR: #69805 Problem Summary: Non-UTF-8 prepared string parameters are bound as binary-to-string casts. Cached point queries and fully prepared Group Commit inserts require literal bindings and would throw ClassCastException for these expressions. Check the current bindings before entering either fast path, refresh cached point-query plans when bindings require evaluation, and clear inherited point-query flags before normal planning. Keep literal bindings eligible for existing fast paths. ### Release note Avoid prepared-statement execution failures when binary string parameters follow text parameters in point queries or Group Commit inserts. ### Check List (For Author) - Test: Unit Test / ExecuteCommandTest, MysqlParameterLiteralTest, MysqlConnectProcessorLongDataTest, PointQueryExecutorTest and GroupCommitPlannerTest via run-fe-ut.sh; FE Checkstyle - Behavior changed: Yes. Expression-valued parameters use normal planning and BE evaluation instead of literal-only prepared fast paths. - Does this need documentation: No
1 parent f4402db commit 96e2a12

2 files changed

Lines changed: 143 additions & 2 deletions

File tree

‎fe/fe-core/src/main/java/org/apache/doris/nereids/trees/plans/commands/ExecuteCommand.java‎

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@
2929
import org.apache.doris.nereids.trees.expressions.Expression;
3030
import org.apache.doris.nereids.trees.expressions.Placeholder;
3131
import org.apache.doris.nereids.trees.expressions.SubqueryExpr;
32+
import org.apache.doris.nereids.trees.expressions.literal.Literal;
3233
import org.apache.doris.nereids.trees.plans.PlaceholderId;
3334
import org.apache.doris.nereids.trees.plans.PlanType;
3435
import org.apache.doris.nereids.trees.plans.commands.insert.InsertIntoTableCommand;
@@ -148,8 +149,12 @@ public void run(ConnectContext ctx, StmtExecutor executor) throws Exception {
148149
LogicalPlanAdapter planAdapter = new LogicalPlanAdapter(logicalPlan, statementContext);
149150
executor.setStatementContext(statementContext);
150151
executor.setParsedStmt(planAdapter);
152+
// These fast paths serialize literals without expression evaluation. Non-UTF-8 string
153+
// parameters contain a binary-to-string Cast that must be evaluated by the normal plan.
154+
boolean hasLiteralBindings = statementContext.getIdToPlaceholderRealExpr().values().stream()
155+
.allMatch(Literal.class::isInstance);
151156
boolean hasShortCircuitContext = preparedStmtCtx.shortCircuitQueryContext.isPresent();
152-
boolean shortCircuitContextReusable = hasShortCircuitContext
157+
boolean shortCircuitContextReusable = hasLiteralBindings && hasShortCircuitContext
153158
&& preparedStmtCtx.shortCircuitQueryContext.get().isReusable(ctx);
154159
// Reuse the cached short-circuit plan only when table metadata is unchanged and the statement
155160
// has no nondeterministic functions. Otherwise fall back to the normal execution path below.
@@ -165,7 +170,7 @@ public void run(ConnectContext ctx, StmtExecutor executor) throws Exception {
165170
PointQueryExecutor.directExecuteShortCircuitQuery(executor, preparedStmtCtx, statementContext);
166171
return;
167172
}
168-
if (ctx.getSessionVariable().enableGroupCommitFullPrepare) {
173+
if (hasLiteralBindings && ctx.getSessionVariable().enableGroupCommitFullPrepare) {
169174
if (preparedStmtCtx.groupCommitPlanner.isPresent()) {
170175
OlapGroupCommitInsertExecutor.fastAnalyzeGroupCommit(ctx, prepareCommand);
171176
} else {
@@ -180,6 +185,8 @@ public void run(ConnectContext ctx, StmtExecutor executor) throws Exception {
180185
if (statementContext.isShortCircuitQuery() && hasShortCircuitContext && !shortCircuitContextReusable) {
181186
statementContext = refreshPreparedPlan(preparedStmtCtx, executor, prepareCommand, statementContext);
182187
} else {
188+
// A failed execution can leave the flag set without publishing a cached context.
189+
statementContext.setShortCircuitQuery(false);
183190
statementContext.setShortCircuitQueryContext(null);
184191
}
185192
// Drop the previously cached short-circuit context: either it was reusable and returned

‎fe/fe-core/src/test/java/org/apache/doris/nereids/trees/plans/commands/ExecuteCommandTest.java‎

Lines changed: 134 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@
2222
import org.apache.doris.analysis.TableScanParams;
2323
import org.apache.doris.catalog.Column;
2424
import org.apache.doris.catalog.DatabaseIf;
25+
import org.apache.doris.catalog.MysqlColType;
2526
import org.apache.doris.catalog.OlapTable;
2627
import org.apache.doris.catalog.PrimitiveType;
2728
import org.apache.doris.catalog.ScalarType;
@@ -31,23 +32,35 @@
3132
import org.apache.doris.datasource.mvcc.MvccTable;
3233
import org.apache.doris.nereids.StatementContext;
3334
import org.apache.doris.nereids.analyzer.UnboundRelation;
35+
import org.apache.doris.nereids.glue.LogicalPlanAdapter;
3436
import org.apache.doris.nereids.parser.NereidsParser;
37+
import org.apache.doris.nereids.trees.expressions.Cast;
38+
import org.apache.doris.nereids.trees.expressions.Expression;
39+
import org.apache.doris.nereids.trees.expressions.Placeholder;
3540
import org.apache.doris.nereids.trees.expressions.SubqueryExpr;
41+
import org.apache.doris.nereids.trees.expressions.literal.NullLiteral;
42+
import org.apache.doris.nereids.trees.expressions.literal.StringLiteral;
43+
import org.apache.doris.nereids.trees.expressions.literal.VarBinaryLiteral;
3644
import org.apache.doris.nereids.trees.plans.commands.merge.MergeIntoCommand;
3745
import org.apache.doris.nereids.trees.plans.logical.LogicalPlan;
46+
import org.apache.doris.nereids.types.StringType;
47+
import org.apache.doris.planner.GroupCommitPlanner;
3848
import org.apache.doris.planner.OlapScanNode;
3949
import org.apache.doris.planner.Planner;
4050
import org.apache.doris.qe.ConnectContext;
4151
import org.apache.doris.qe.OriginStatement;
52+
import org.apache.doris.qe.PointQueryExecutor;
4253
import org.apache.doris.qe.PreparedStatementContext;
4354
import org.apache.doris.qe.SessionVariable;
4455
import org.apache.doris.qe.ShortCircuitQueryContext;
4556
import org.apache.doris.qe.StmtExecutor;
4657
import org.apache.doris.thrift.TQueryOptions;
4758

4859
import com.google.common.collect.ImmutableMap;
60+
import org.junit.jupiter.api.AfterEach;
4961
import org.junit.jupiter.api.Assertions;
5062
import org.junit.jupiter.api.Test;
63+
import org.mockito.MockedStatic;
5164
import org.mockito.Mockito;
5265

5366
import java.util.ArrayList;
@@ -59,6 +72,127 @@
5972

6073
public class ExecuteCommandTest {
6174

75+
@AfterEach
76+
public void tearDown() {
77+
ConnectContext.remove();
78+
}
79+
80+
@Test
81+
public void testExpressionBindingRefreshesCachedPointQuery() throws Exception {
82+
ConnectContext context = new ConnectContext();
83+
PreparedStatementContext prepared = prepareParameterStatement(context, "select * from tbl where k = ?");
84+
StatementContext initialContext = prepared.getStatementContext();
85+
initialContext.setShortCircuitQuery(true);
86+
ShortCircuitQueryContext cached = Mockito.mock(ShortCircuitQueryContext.class);
87+
Mockito.when(cached.isReusable(context)).thenReturn(true);
88+
prepared.shortCircuitQueryContext = Optional.of(cached);
89+
StmtExecutor executor = parameterExecutor(context);
90+
91+
try (MockedStatic<PointQueryExecutor> pointQueries = Mockito.mockStatic(PointQueryExecutor.class)) {
92+
bindAndExecute(context, prepared, executor, new StringLiteral("ASCII"));
93+
pointQueries.verify(() -> PointQueryExecutor.directExecuteShortCircuitQuery(
94+
executor, prepared, prepared.getStatementContext()));
95+
96+
Expression binary = new Cast(new VarBinaryLiteral(new byte[] {(byte) 0xff}), StringType.INSTANCE);
97+
bindAndExecute(context, prepared, executor, binary);
98+
StatementContext refreshed = prepared.getStatementContext();
99+
Assertions.assertFalse(refreshed.isShortCircuitQuery());
100+
Assertions.assertNull(refreshed.getShortCircuitQueryContext());
101+
Assertions.assertTrue(prepared.shortCircuitQueryContext.isEmpty());
102+
Assertions.assertNotSame(initialContext, refreshed);
103+
Assertions.assertEquals(binary, refreshed.getIdToPlaceholderRealExpr().get(
104+
prepared.command.getPlaceholders().get(0).getPlaceholderId()));
105+
Assertions.assertEquals(MysqlColType.MYSQL_TYPE_VARSTRING,
106+
prepared.command.getPlaceholders().get(0).getMysqlColType());
107+
Mockito.verify(executor).execute();
108+
pointQueries.verifyNoMoreInteractions();
109+
110+
bindAndExecute(context, prepared, executor, new StringLiteral("ASCII again"));
111+
Mockito.verify(executor, Mockito.times(2)).execute();
112+
}
113+
}
114+
115+
@Test
116+
public void testExpressionBindingClearsUncachedPointQueryFlag() throws Exception {
117+
ConnectContext context = new ConnectContext();
118+
PreparedStatementContext prepared = prepareParameterStatement(context, "select * from tbl where k = ?");
119+
// A point-query execution can fail before publishing its cached context.
120+
prepared.getStatementContext().setShortCircuitQuery(true);
121+
StmtExecutor executor = parameterExecutor(context);
122+
123+
bindAndExecute(context, prepared, executor,
124+
new Cast(new VarBinaryLiteral(new byte[] {(byte) 0xff}), StringType.INSTANCE));
125+
126+
Assertions.assertFalse(prepared.getStatementContext().isShortCircuitQuery());
127+
Assertions.assertNull(prepared.getStatementContext().getShortCircuitQueryContext());
128+
Mockito.verify(executor).execute();
129+
}
130+
131+
@Test
132+
public void testExpressionBindingSkipsPreparedGroupCommit() throws Exception {
133+
ConnectContext context = new ConnectContext();
134+
context.getSessionVariable().groupCommit = "sync_mode";
135+
Assertions.assertTrue(context.getSessionVariable().enableGroupCommitFullPrepare);
136+
PreparedStatementContext prepared = prepareParameterStatement(context, "insert into test.tbl values (?)");
137+
// A previous literal execution has already populated the full-prepare cache.
138+
GroupCommitPlanner cached = Mockito.mock(GroupCommitPlanner.class);
139+
prepared.groupCommitPlanner = Optional.of(cached);
140+
StmtExecutor executor = parameterExecutor(context);
141+
try (MockedStatic<GroupCommitPlanner> groupCommit = Mockito.mockStatic(GroupCommitPlanner.class)) {
142+
bindAndExecute(context, prepared, executor, new StringLiteral("ASCII"));
143+
groupCommit.verify(() -> GroupCommitPlanner.executeGroupCommitInsert(
144+
context, prepared, prepared.getStatementContext()));
145+
groupCommit.clearInvocations();
146+
147+
Expression binary = new Cast(new VarBinaryLiteral(new byte[] {(byte) 0xff}), StringType.INSTANCE);
148+
bindAndExecute(context, prepared, executor, binary);
149+
Mockito.verify(executor).execute();
150+
Assertions.assertEquals(binary, prepared.getStatementContext().getIdToPlaceholderRealExpr().get(
151+
prepared.command.getPlaceholders().get(0).getPlaceholderId()));
152+
groupCommit.verifyNoInteractions();
153+
154+
bindAndExecute(context, prepared, executor, new NullLiteral());
155+
groupCommit.verify(() -> GroupCommitPlanner.executeGroupCommitInsert(
156+
context, prepared, prepared.getStatementContext()));
157+
Assertions.assertSame(cached, prepared.groupCommitPlanner.orElseThrow());
158+
}
159+
}
160+
161+
private PreparedStatementContext prepareParameterStatement(ConnectContext context, String sql) throws Exception {
162+
context.setThreadLocalInfo();
163+
LogicalPlanAdapter parsed = (LogicalPlanAdapter) new NereidsParser().parseSQL(sql).get(0);
164+
StatementContext statementContext = parsed.getStatementContext();
165+
statementContext.setConnectContext(context);
166+
List<Placeholder> placeholders = statementContext.getPlaceholders().stream()
167+
.map(placeholder -> placeholder.withNewMysqlColType(MysqlColType.MYSQL_TYPE_VARSTRING.getCode()))
168+
.toList();
169+
statementContext.setPlaceholders(placeholders);
170+
PrepareCommand command = new PrepareCommand("stmt", parsed.getLogicalPlan(), placeholders,
171+
new OriginStatement(sql, 0));
172+
PreparedStatementContext prepared = new PreparedStatementContext(command, context, statementContext, "stmt");
173+
context.setStatementContext(statementContext);
174+
context.addPreparedStatementContext("stmt", prepared);
175+
return prepared;
176+
}
177+
178+
private StmtExecutor parameterExecutor(ConnectContext context) {
179+
StmtExecutor executor = Mockito.mock(StmtExecutor.class);
180+
Mockito.when(executor.getContext()).thenReturn(context);
181+
Mockito.doAnswer(invocation -> {
182+
context.setStatementContext(invocation.getArgument(0));
183+
return null;
184+
}).when(executor).setStatementContext(Mockito.any(StatementContext.class));
185+
return executor;
186+
}
187+
188+
private void bindAndExecute(ConnectContext context, PreparedStatementContext prepared,
189+
StmtExecutor executor, Expression value) throws Exception {
190+
context.setGroupCommit(false);
191+
prepared.getStatementContext().getIdToPlaceholderRealExpr().put(
192+
prepared.command.getPlaceholders().get(0).getPlaceholderId(), value);
193+
new ExecuteCommand("stmt", prepared.command, prepared.getStatementContext()).run(context, executor);
194+
}
195+
62196
@Test
63197
public void testResolvedScanOptionsAreResetForEveryExecute() throws Exception {
64198
String sql = "select * from p@options('scan.mode'='latest')";

0 commit comments

Comments
 (0)