Skip to content

Commit bdb6255

Browse files
l46kokcopybara-github
authored andcommitted
Document SelectOptimizer limitations and fail fast on json_name ASTs
PiperOrigin-RevId: 1022301470
1 parent 8bc8c35 commit bdb6255

2 files changed

Lines changed: 64 additions & 1 deletion

File tree

‎optimizer/src/main/java/dev/cel/optimizer/optimizers/SelectOptimizer.java‎

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -137,11 +137,16 @@
137137
*
138138
* <p>Dynamic or trailing indices and non-protobuf selects pass through untouched.
139139
*
140+
* <p><b>Optimizer Ordering:</b> Run {@code SelectOptimizer} last, after {@link
141+
* ConstantFoldingOptimizer}, {@link InliningOptimizer}, and {@link SubexpressionOptimizer}, which
142+
* operate on unoptimized {@code select} nodes.
143+
*
140144
* <p><b>Limitations:</b>
141145
*
142146
* <ul>
143147
* <li><b>Protobuf Extensions:</b> Extension fields are not rename-resilient; runtime lookup
144-
* resolves extensions by their fully qualified name rather than field number.
148+
* resolves extensions by their fully qualified name rather than field number, and {@code
149+
* CelLiteRuntime} does not support them.
145150
* <li><b>Dynamic & Unpacked Payloads:</b> When traversing values typed as {@code dyn}, unpacked
146151
* from {@code google.protobuf.Any}, or evaluated via classless wire payloads ({@code
147152
* RawProtoMessageLiteValue}), no cross-check between the embedded field number and field name
@@ -150,6 +155,11 @@
150155
* Any} field, whose packed type is only known at runtime. Fields selected past it ({@code
151156
* msg.any_field.foo}) are resolved by name, so they are not rename-resilient and {@code
152157
* CelLiteRuntime} needs the packed message's {@code CelLiteDescriptor}.
158+
* <li><b>Message Creation:</b> Message literals ({@code Msg{field: value}}) are resolved by field
159+
* name at runtime, so they are not rename-resilient. {@code CelLiteRuntime} only supports
160+
* empty literals ({@code Msg{}}), and requires the message's {@code CelLiteDescriptor}.
161+
* <li><b>JSON Field Names:</b> Selecting protobuf fields by {@code json_name} (e.g. {@code
162+
* CelOptions.enableJsonFieldNames(true)}) is unsupported and throws during optimization.
153163
* <li><b>Oneofs:</b> The lite runtime reads fields from the wire, so it reports every serialized
154164
* member of a oneof as present. Protobuf serializes at most one, unless an older-schema
155165
* binary merges or mutates the message, or the bytes are concatenated or altered by hand.
@@ -265,6 +275,10 @@ public OptimizationResult optimize(CelAbstractSyntaxTree ast, Cel cel) {
265275
checkNotNull(ast);
266276
checkNotNull(cel);
267277
checkArgument(ast.isChecked(), "AST must be type-checked.");
278+
if (ast.getSource().getExtensions().stream().anyMatch(e -> e.id().equals("json_name"))) {
279+
throw new UnsupportedOperationException(
280+
"Optimization of json_name field selection is unsupported.");
281+
}
268282

269283
CelMutableAst astToModify = CelMutableAst.fromCelAst(ast);
270284
CelNavigableMutableAst navAst = CelNavigableMutableAst.fromAst(astToModify);

‎optimizer/src/test/java/dev/cel/optimizer/optimizers/SelectOptimizerTest.java‎

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1399,6 +1399,31 @@ public void optimize_groupField_throwsUnsupportedOperationException(
13991399
assertThat(e).hasMessageThat().contains("Optimization of Group fields is unsupported");
14001400
}
14011401

1402+
@Test
1403+
public void optimize_jsonFieldNames_throwsUnsupportedOperationException(
1404+
@TestParameter({
1405+
"msg.singleInt64",
1406+
"has(msg.singleInt64)",
1407+
"msg.?singleInt64",
1408+
"msg.singleNestedMessage.bb"
1409+
})
1410+
String expression)
1411+
throws Exception {
1412+
Cel jsonCel =
1413+
cel.toCelBuilder()
1414+
.setOptions(CEL_OPTIONS.toBuilder().enableJsonFieldNames(true).build())
1415+
.build();
1416+
CelAbstractSyntaxTree ast = jsonCel.compile(expression).getAst();
1417+
SelectOptimizer optimizer = SelectOptimizer.newInstance();
1418+
1419+
UnsupportedOperationException e =
1420+
assertThrows(UnsupportedOperationException.class, () -> optimizer.optimize(ast, jsonCel));
1421+
1422+
assertThat(e)
1423+
.hasMessageThat()
1424+
.isEqualTo("Optimization of json_name field selection is unsupported.");
1425+
}
1426+
14021427
@Test
14031428
public void newInstance_fileDescriptorsVarargs_defaultOptions_success() throws Exception {
14041429
FileDescriptor fd = PROTO2_TEST_ALL_TYPES_DESCRIPTOR.getFile();
@@ -2093,6 +2118,30 @@ public void optimize_afterConstantFolding_preservesMacroCalls() throws Exception
20932118
+ " [2, \"single_int64\", 3]], -64) + 2)");
20942119
}
20952120

2121+
@Test
2122+
public void optimize_afterSubexpressionOptimizer_rewritesBlockAndBody() throws Exception {
2123+
CelOptimizer optimizer =
2124+
CelOptimizerFactory.standardCelOptimizerBuilder(cel)
2125+
.addAstOptimizers(
2126+
SubexpressionOptimizer.getInstance(),
2127+
SelectOptimizer.newInstance(
2128+
PROTO2_TEST_ALL_TYPES_DESCRIPTOR.getFile(),
2129+
NestedTestAllTypes.getDescriptor().getFile()))
2130+
.build();
2131+
CelAbstractSyntaxTree ast =
2132+
cel.compile("nested_msg.child.payload.single_int32 + nested_msg.child.payload.single_int64")
2133+
.getAst();
2134+
2135+
CelAbstractSyntaxTree optimizedAst = optimizer.optimize(ast);
2136+
2137+
assertThat(CEL_UNPARSER.unparse(optimizedAst))
2138+
.isEqualTo(
2139+
"cel.@block([cel.@attribute(nested_msg, [[1, \"child\", 11], [2, \"payload\", 11]],"
2140+
+ " cel.expr.conformance.proto2.TestAllTypes{})],"
2141+
+ " cel.@attribute(@index0, [[1, \"single_int32\", 5]], -32)"
2142+
+ " + cel.@attribute(@index0, [[2, \"single_int64\", 3]], -64))");
2143+
}
2144+
20962145
private static CelOptimizer newSelectOptimizer(Cel cel) {
20972146
return CelOptimizerFactory.standardCelOptimizerBuilder(cel)
20982147
.addAstOptimizers(

0 commit comments

Comments
 (0)