Handle unknown fields in messagelite#683

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
copybara-service merged 1 commit into from
May 2, 2025
Merged

Handle unknown fields in messagelite #683

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
58 changes: 51 additions & 7 deletions common/src/main/java/dev/cel/common/values/ProtoLiteCelValueConverter.java
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -16,10 +16,13 @@

import static com.google.common.base.Preconditions.checkNotNull;

import com.google.auto.value.AutoValue;
import com.google.common.annotations.VisibleForTesting;
import com.google.common.base.Defaults;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableMap;
import com.google.common.collect.Multimap;
import com.google.common.collect.Multimaps;
import com.google.common.primitives.UnsignedLong;
import com.google.errorprone.annotations.Immutable;
import com.google.protobuf.ByteString;
Expand All@@ -41,6 +44,7 @@
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import java.util.TreeMap;

/**
* {@code ProtoLiteCelValueConverter} handles bidirectional conversion between native Java and
Expand DownExpand Up@@ -221,27 +225,33 @@ private ImmutableList<Object> readPackedRepeatedFields(
private Map.Entry<Object, Object> readSingleMapEntry(
CodedInputStream inputStream, FieldLiteDescriptor fieldDescriptor) throws IOException {
ImmutableMap<String, Object> singleMapEntry =
readAllFields(inputStream.readByteArray(), fieldDescriptor.getFieldProtoTypeName());
readAllFields(inputStream.readByteArray(), fieldDescriptor.getFieldProtoTypeName())
.values();
Object key = checkNotNull(singleMapEntry.get("key"));
Object value = checkNotNull(singleMapEntry.get("value"));

return new AbstractMap.SimpleEntry<>(key, value);
}

@VisibleForTesting
ImmutableMap<String, Object> readAllFields(byte[] bytes, String protoTypeName)
throws IOException {
// TODO: Handle unknown fields by collecting them into a separate map.
MessageFields readAllFields(byte[] bytes, String protoTypeName) throws IOException {
MessageLiteDescriptor messageDescriptor = descriptorPool.getDescriptorOrThrow(protoTypeName);
CodedInputStream inputStream = CodedInputStream.newInstance(bytes);

Multimap<Integer, Object> unknownFields =
Multimaps.newMultimap(new TreeMap<>(), ArrayList::new);
ImmutableMap.Builder<String, Object> fieldValues = ImmutableMap.builder();
Map<Integer, List<Object>> repeatedFieldValues = new LinkedHashMap<>();
Map<Integer, Map<Object, Object>> mapFieldValues = new LinkedHashMap<>();
for (int tag = inputStream.readTag(); tag != 0; tag = inputStream.readTag()) {
int tagWireType = WireFormat.getTagWireType(tag);
int fieldNumber = WireFormat.getTagFieldNumber(tag);
FieldLiteDescriptor fieldDescriptor = messageDescriptor.getByFieldNumberOrThrow(fieldNumber);
FieldLiteDescriptor fieldDescriptor =
messageDescriptor.findByFieldNumber(fieldNumber).orElse(null);
if (fieldDescriptor == null) {
unknownFields.put(fieldNumber, readUnknownField(tagWireType, inputStream));
continue;
}

Object payload;
switch (tagWireType) {
Expand DownExpand Up@@ -318,12 +328,32 @@ ImmutableMap<String, Object> readAllFields(byte[] bytes, String protoTypeName)

// Protobuf encoding follows a "last one wins" semantics. This means for duplicated fields,
// we accept the last value encountered.
return fieldValues.buildKeepingLast();
return MessageFields.create(fieldValues.buildKeepingLast(), unknownFields);
}

ImmutableMap<String, Object> readAllFields(MessageLite msg, String protoTypeName)
throws IOException {
return readAllFields(msg.toByteArray(), protoTypeName);
return readAllFields(msg.toByteArray(), protoTypeName).values();
}

private static Object readUnknownField(int tagWireType, CodedInputStream inputStream)
throws IOException {
switch (tagWireType) {
case WireFormat.WIRETYPE_VARINT:
return inputStream.readInt64();
case WireFormat.WIRETYPE_FIXED64:
return inputStream.readFixed64();
case WireFormat.WIRETYPE_LENGTH_DELIMITED:
return inputStream.readBytes();
case WireFormat.WIRETYPE_FIXED32:
return inputStream.readFixed32();
case WireFormat.WIRETYPE_START_GROUP:
case WireFormat.WIRETYPE_END_GROUP:
// TODO: Support groups
throw new UnsupportedOperationException("Groups are not supported");
default:
throw new IllegalArgumentException("Unknown wire type: " + tagWireType);
}
}

@Override
Expand All@@ -342,6 +372,20 @@ public CelValue fromProtoMessageToCelValue(String protoTypeName, MessageLite msg
return super.fromWellKnownProtoToCelValue(msg, wellKnownProto);
}

@AutoValue
@SuppressWarnings("AutoValueImmutableFields") // Unknowns are inaccessible to users.
abstract static class MessageFields {

abstract ImmutableMap<String, Object> values();

abstract Multimap<Integer, Object> unknowns();

static MessageFields create(
ImmutableMap<String, Object> fieldValues, Multimap<Integer, Object> unknownFields) {
return new AutoValue_ProtoLiteCelValueConverter_MessageFields(fieldValues, unknownFields);
}
}

private ProtoLiteCelValueConverter(CelLiteDescriptorPool celLiteDescriptorPool) {
this.descriptorPool = celLiteDescriptorPool;
}
Expand Down
216 changes: 216 additions & 0 deletions common/src/test/java/dev/cel/common/values/ProtoLiteCelValueConverterTest.java
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,9 +17,13 @@
import static com.google.common.truth.Truth.assertThat;
import static java.nio.charset.StandardCharsets.UTF_8;

import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableListMultimap;
import com.google.common.collect.ImmutableSet;
import com.google.common.collect.Multimap;
import com.google.protobuf.ByteString;
import com.google.protobuf.Duration;
import com.google.protobuf.ExtensionRegistryLite;
import com.google.protobuf.FloatValue;
import com.google.protobuf.Int32Value;
import com.google.protobuf.Int64Value;
Expand All@@ -32,9 +36,11 @@
import dev.cel.common.internal.CelLiteDescriptorPool;
import dev.cel.common.internal.DefaultLiteDescriptorPool;
import dev.cel.common.internal.WellKnownProto;
import dev.cel.common.values.ProtoLiteCelValueConverter.MessageFields;
import dev.cel.expr.conformance.proto3.TestAllTypes;
import dev.cel.expr.conformance.proto3.TestAllTypesProto3CelDescriptor;
import java.time.Instant;
import java.util.LinkedHashMap;
import org.junit.Test;
import org.junit.runner.RunWith;

Expand DownExpand Up@@ -107,4 +113,214 @@ public void fromProtoMessageToCelValue_withWellKnownProto_convertsToEquivalentCe

assertThat(convertedCelValue).isEqualTo(testCase.celValue);
}

/** Test cases for repeated_int64: 1L,2L,3L */
@SuppressWarnings("ImmutableEnumChecker") // Test only
private enum RepeatedFieldBytesTestCase {
PACKED(new byte[] {(byte) 0x82, 0x2, 0x3, 0x1, 0x2, 0x3}),
NON_PACKED(new byte[] {(byte) 0x80, 0x2, 0x1, (byte) 0x80, 0x2, 0x2, (byte) 0x80, 0x2, 0x3}),
// 1L is not packed, but 2L and 3L are
MIXED(new byte[] {(byte) 0x80, 0x2, 0x1, (byte) 0x82, 0x2, 0x2, 0x2, 0x3});

private final byte[] bytes;

RepeatedFieldBytesTestCase(byte[] bytes) {
this.bytes = bytes;
}
}

@Test
public void readAllFields_repeatedFields_packedBytesCombinations(
@TestParameter RepeatedFieldBytesTestCase testCase) throws Exception {
MessageFields fields =
PROTO_LITE_CEL_VALUE_CONVERTER.readAllFields(
testCase.bytes, "cel.expr.conformance.proto3.TestAllTypes");

assertThat(fields.values()).containsExactly("repeated_int64", ImmutableList.of(1L, 2L, 3L));
}

/**
* Unknown test with the following hypothetical fields:
*
* <pre>{@code
* message TestAllTypes {
* int64 single_int64_unknown = 2500;
* fixed32 single_fixed32_unknown = 2501;
* fixed64 single_fixed64_unknown = 2502;
* string single_string_unknown = 2503;
* repeated int64 repeated_int64_unknown = 2504;
* map<string, int64> map_string_int64_unknown = 2505;
* }
* }</pre>
*/
@SuppressWarnings("ImmutableEnumChecker") // Test only
private enum UnknownFieldsTestCase {
INT64(new byte[] {-96, -100, 1, 1}, "2500: 1", ImmutableListMultimap.of(2500, 1L)),
FIXED32(
new byte[] {-83, -100, 1, 2, 0, 0, 0},
"2501: 0x00000002",
ImmutableListMultimap.of(2501, 2)),
FIXED64(
new byte[] {-79, -100, 1, 3, 0, 0, 0, 0, 0, 0, 0},
"2502: 0x0000000000000003",
ImmutableListMultimap.of(2502, 3L)),
STRING(
new byte[] {-70, -100, 1, 11, 72, 101, 108, 108, 111, 32, 119, 111, 114, 108, 100},
"2503: \"Hello world\"",
ImmutableListMultimap.of(2503, ByteString.copyFromUtf8("Hello world"))),
REPEATED_INT64(
new byte[] {-62, -100, 1, 2, 4, 5},
"2504: \"\\004\\005\"",
ImmutableListMultimap.of(2504, ByteString.copyFrom(new byte[] {4, 5}))),
MAP_STRING_INT64(
new byte[] {
-54, -100, 1, 7, 10, 3, 102, 111, 111, 16, 4, -54, -100, 1, 7, 10, 3, 98, 97, 114, 16, 5
},
"2505: {\n"
+ " 1: \"foo\"\n"
+ " 2: 4\n"
+ "}\n"
+ "2505: {\n"
+ " 1: \"bar\"\n"
+ " 2: 5\n"
+ "}",
ImmutableListMultimap.of(
2505,
ByteString.copyFromUtf8("\n\003foo\020\004"),
2505,
ByteString.copyFromUtf8("\n\003bar\020\005")));

private final byte[] bytes;
private final String formattedOutput;
private final Multimap<Integer, Object> unknownMap;

UnknownFieldsTestCase(
byte[] bytes, String formattedOutput, Multimap<Integer, Object> unknownMap) {
this.bytes = bytes;
this.formattedOutput = formattedOutput;
this.unknownMap = unknownMap;
}
}

@Test
public void unknowns_repeatedEncodedBytes_allRecordsKeptWithKeysSorted() throws Exception {
// 2500: 2
// 2504: \"\\004\\005\""
// 2501: 0x00000002
// 2500: 1
byte[] bytes =
new byte[] {
-96, -100, 1, 2, // keep
-62, -100, 1, 2, 4, 5, // keep
-83, -100, 1, 2, 0, 0, 0, // keep
-96, -100, 1, 1 // keep
};

MessageFields messageFields =
PROTO_LITE_CEL_VALUE_CONVERTER.readAllFields(
bytes, "cel.expr.conformance.proto3.TestAllTypes");

assertThat(messageFields.values()).isEmpty();
assertThat(messageFields.unknowns())
.containsExactly(
2500, 2L, 2500, 1L, 2501, 2, 2504, ByteString.copyFrom(new byte[] {0x04, 0x05}))
.inOrder();
}

@Test
public void readAllFields_unknownFields(@TestParameter UnknownFieldsTestCase testCase)
throws Exception {
TestAllTypes parsedMsg =
TestAllTypes.parseFrom(testCase.bytes, ExtensionRegistryLite.getEmptyRegistry());

MessageFields messageFields =
PROTO_LITE_CEL_VALUE_CONVERTER.readAllFields(
testCase.bytes, "cel.expr.conformance.proto3.TestAllTypes");

assertThat(messageFields.values()).isEmpty();
assertThat(messageFields.unknowns()).containsExactlyEntriesIn(testCase.unknownMap).inOrder();
assertThat(parsedMsg.toString().trim()).isEqualTo(testCase.formattedOutput);
}

/**
* Tests the following message:
*
* <pre>{@code
* TestAllTypes.newBuilder()
* // Unknowns
* .setSingleInt64Unknown(1L)
* .setSingleFixed32Unknown(2)
* .setSingleFixed64Unknown(3L)
* .setSingleStringUnknown("Hello world")
* .addAllRepeatedInt64Unknown(ImmutableList.of(4L, 5L))
* .putMapStringInt64Unknown("foo", 4L)
* .putMapStringInt64Unknown("bar", 5L)
* // Known values
* .putMapBoolDouble(true, 1.5d)
* .putMapBoolDouble(false, 2.5d)
* .build();
* }</pre>
*/
@Test
@SuppressWarnings("unchecked")
public void readAllFields_unknownFieldsWithValues() throws Exception {
byte[] unknownMessageBytes = {
-70, 4, 11, 8, 1, 17, 0, 0, 0, 0, 0, 0, -8, 63, -70, 4, 11, 8, 0, 17, 0, 0, 0, 0, 0, 0, 4, 64,
-96, -100, 1, 1, -83, -100, 1, 2, 0, 0, 0, -79, -100, 1, 3, 0, 0, 0, 0, 0, 0, 0, -70, -100, 1,
11, 72, 101, 108, 108, 111, 32, 119, 111, 114, 108, 100, -62, -100, 1, 2, 4, 5, -54, -100, 1,
7, 10, 3, 102, 111, 111, 16, 4, -54, -100, 1, 7, 10, 3, 98, 97, 114, 16, 5
};
TestAllTypes parsedMsg =
TestAllTypes.parseFrom(unknownMessageBytes, ExtensionRegistryLite.getEmptyRegistry());

MessageFields fields =
PROTO_LITE_CEL_VALUE_CONVERTER.readAllFields(
unknownMessageBytes, "cel.expr.conformance.proto3.TestAllTypes");

assertThat(parsedMsg.toString())
.isEqualTo(
"map_bool_double {\n"
+ " key: false\n"
+ " value: 2.5\n"
+ "}\n"
+ "map_bool_double {\n"
+ " key: true\n"
+ " value: 1.5\n"
+ "}\n"
+ "2500: 1\n"
+ "2501: 0x00000002\n"
+ "2502: 0x0000000000000003\n"
+ "2503: \"Hello world\"\n"
+ "2504: \"\\004\\005\"\n"
+ "2505: {\n"
+ " 1: \"foo\"\n"
+ " 2: 4\n"
+ "}\n"
+ "2505: {\n"
+ " 1: \"bar\"\n"
+ " 2: 5\n"
+ "}\n");
assertThat(fields.values()).containsKey("map_bool_double");
LinkedHashMap<Boolean, Double> mapBoolDoubleValues =
(LinkedHashMap<Boolean, Double>) fields.values().get("map_bool_double");
assertThat(mapBoolDoubleValues).containsExactly(true, 1.5d, false, 2.5d).inOrder();
Multimap<Integer, Object> unknownValues = fields.unknowns();
assertThat(unknownValues)
.containsExactly(
2500,
1L,
2501,
2,
2502,
3L,
2503,
ByteString.copyFromUtf8("Hello world"),
2504,
ByteString.copyFrom(new byte[] {0x04, 0x05}),
2505,
ByteString.copyFromUtf8("\n\003foo\020\004"),
2505,
ByteString.copyFromUtf8("\n\003bar\020\005"))
.inOrder();
}
}
25 changes: 0 additions & 25 deletions common/src/test/java/dev/cel/common/values/ProtoMessageLiteValueTest.java
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -271,29 +271,4 @@ public void selectField_defaultValue(@TestParameter DefaultValueTestCase testCas
assertThat(selectedValue).isEqualTo(testCase.celValue);
assertThat(selectedValue.isZeroValue()).isTrue();
}

/** Test cases for repeated_int64: 1L,2L,3L */
@SuppressWarnings("ImmutableEnumChecker") // Test only
private enum RepeatedFieldBytesTestCase {
PACKED(new byte[] {(byte) 0x82, 0x2, 0x3, 0x1, 0x2, 0x3}),
NON_PACKED(new byte[] {(byte) 0x80, 0x2, 0x1, (byte) 0x80, 0x2, 0x2, (byte) 0x80, 0x2, 0x3}),
// 1L is not packed, but 2L and 3L are
MIXED(new byte[] {(byte) 0x80, 0x2, 0x1, (byte) 0x82, 0x2, 0x2, 0x2, 0x3});

private final byte[] bytes;

RepeatedFieldBytesTestCase(byte[] bytes) {
this.bytes = bytes;
}
}

@Test
public void readAllFields_repeatedFields_packedBytesCombinations(
@TestParameter RepeatedFieldBytesTestCase testCase) throws Exception {
ImmutableMap<String, Object> fields =
PROTO_LITE_CEL_VALUE_CONVERTER.readAllFields(
testCase.bytes, "cel.expr.conformance.proto3.TestAllTypes");

assertThat(fields).containsExactly("repeated_int64", ImmutableList.of(1L, 2L, 3L));
}
}
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
Handle unknown fields in messagelite#683

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

copybara-service
merged 1 commit into

from

May 2, 2025
 Merged


Handle unknown fields in messagelite
#683
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


58 changes: 51 additions & 7 deletions
common/src/main/java/dev/cel/common/values/ProtoLiteCelValueConverter.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -16,10 +16,13 @@

import static com.google.common.base.Preconditions.checkNotNull;

import com.google.auto.value.AutoValue;
import com.google.common.annotations.VisibleForTesting;
import com.google.common.base.Defaults;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableMap;
import com.google.common.collect.Multimap;
import com.google.common.collect.Multimaps;
import com.google.common.primitives.UnsignedLong;
import com.google.errorprone.annotations.Immutable;
import com.google.protobuf.ByteString;
Expand All@@ -41,6 +44,7 @@
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import java.util.TreeMap;

/**
 * {@code ProtoLiteCelValueConverter} handles bidirectional conversion between native Java and
Expand DownExpand Up@@ -221,27 +225,33 @@ private ImmutableList<Object> readPackedRepeatedFields(
 private Map.Entry<Object, Object> readSingleMapEntry(
 CodedInputStream inputStream, FieldLiteDescriptor fieldDescriptor) throws IOException {
 ImmutableMap<String, Object> singleMapEntry =
 readAllFields(inputStream.readByteArray(), fieldDescriptor.getFieldProtoTypeName());
 readAllFields(inputStream.readByteArray(), fieldDescriptor.getFieldProtoTypeName())
 .values();
 Object key = checkNotNull(singleMapEntry.get("key"));
 Object value = checkNotNull(singleMapEntry.get("value"));

 return new AbstractMap.SimpleEntry<>(key, value);
 }

 @VisibleForTesting
 ImmutableMap<String, Object> readAllFields(byte[] bytes, String protoTypeName)
 throws IOException {
 // TODO: Handle unknown fields by collecting them into a separate map.
 MessageFields readAllFields(byte[] bytes, String protoTypeName) throws IOException {
 MessageLiteDescriptor messageDescriptor = descriptorPool.getDescriptorOrThrow(protoTypeName);
 CodedInputStream inputStream = CodedInputStream.newInstance(bytes);

 Multimap<Integer, Object> unknownFields =
 Multimaps.newMultimap(new TreeMap<>(), ArrayList::new);
 ImmutableMap.Builder<String, Object> fieldValues = ImmutableMap.builder();
 Map<Integer, List<Object>> repeatedFieldValues = new LinkedHashMap<>();
 Map<Integer, Map<Object, Object>> mapFieldValues = new LinkedHashMap<>();
 for (int tag = inputStream.readTag(); tag != 0; tag = inputStream.readTag()) {
 int tagWireType = WireFormat.getTagWireType(tag);
 int fieldNumber = WireFormat.getTagFieldNumber(tag);
 FieldLiteDescriptor fieldDescriptor = messageDescriptor.getByFieldNumberOrThrow(fieldNumber);
 FieldLiteDescriptor fieldDescriptor =
 messageDescriptor.findByFieldNumber(fieldNumber).orElse(null);
 if (fieldDescriptor == null) {
 unknownFields.put(fieldNumber, readUnknownField(tagWireType, inputStream));
 continue;
 }

 Object payload;
 switch (tagWireType) {
Expand DownExpand Up@@ -318,12 +328,32 @@ ImmutableMap<String, Object> readAllFields(byte[] bytes, String protoTypeName)

 // Protobuf encoding follows a "last one wins" semantics. This means for duplicated fields,
 // we accept the last value encountered.
 return fieldValues.buildKeepingLast();
 return MessageFields.create(fieldValues.buildKeepingLast(), unknownFields);
 }

 ImmutableMap<String, Object> readAllFields(MessageLite msg, String protoTypeName)
 throws IOException {
 return readAllFields(msg.toByteArray(), protoTypeName);
 return readAllFields(msg.toByteArray(), protoTypeName).values();
 }

 private static Object readUnknownField(int tagWireType, CodedInputStream inputStream)
 throws IOException {
 switch (tagWireType) {
 case WireFormat.WIRETYPE_VARINT:
 return inputStream.readInt64();
 case WireFormat.WIRETYPE_FIXED64:
 return inputStream.readFixed64();
 case WireFormat.WIRETYPE_LENGTH_DELIMITED:
 return inputStream.readBytes();
 case WireFormat.WIRETYPE_FIXED32:
 return inputStream.readFixed32();
 case WireFormat.WIRETYPE_START_GROUP:
 case WireFormat.WIRETYPE_END_GROUP:
 // TODO: Support groups
 throw new UnsupportedOperationException("Groups are not supported");
 default:
 throw new IllegalArgumentException("Unknown wire type: " + tagWireType);
 }
 }

 @Override
Expand All@@ -342,6 +372,20 @@ public CelValue fromProtoMessageToCelValue(String protoTypeName, MessageLite msg
 return super.fromWellKnownProtoToCelValue(msg, wellKnownProto);
 }

 @AutoValue
 @SuppressWarnings("AutoValueImmutableFields") // Unknowns are inaccessible to users.
 abstract static class MessageFields {

 abstract ImmutableMap<String, Object> values();

 abstract Multimap<Integer, Object> unknowns();

 static MessageFields create(
 ImmutableMap<String, Object> fieldValues, Multimap<Integer, Object> unknownFields) {
 return new AutoValue_ProtoLiteCelValueConverter_MessageFields(fieldValues, unknownFields);
 }
 }

 private ProtoLiteCelValueConverter(CelLiteDescriptorPool celLiteDescriptorPool) {
 this.descriptorPool = celLiteDescriptorPool;
 }
Expand Down

216 changes: 216 additions & 0 deletions
common/src/test/java/dev/cel/common/values/ProtoLiteCelValueConverterTest.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,9 +17,13 @@
import static com.google.common.truth.Truth.assertThat;
import static java.nio.charset.StandardCharsets.UTF_8;

import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableListMultimap;
import com.google.common.collect.ImmutableSet;
import com.google.common.collect.Multimap;
import com.google.protobuf.ByteString;
import com.google.protobuf.Duration;
import com.google.protobuf.ExtensionRegistryLite;
import com.google.protobuf.FloatValue;
import com.google.protobuf.Int32Value;
import com.google.protobuf.Int64Value;
Expand All@@ -32,9 +36,11 @@
import dev.cel.common.internal.CelLiteDescriptorPool;
import dev.cel.common.internal.DefaultLiteDescriptorPool;
import dev.cel.common.internal.WellKnownProto;
import dev.cel.common.values.ProtoLiteCelValueConverter.MessageFields;
import dev.cel.expr.conformance.proto3.TestAllTypes;
import dev.cel.expr.conformance.proto3.TestAllTypesProto3CelDescriptor;
import java.time.Instant;
import java.util.LinkedHashMap;
import org.junit.Test;
import org.junit.runner.RunWith;

Expand DownExpand Up@@ -107,4 +113,214 @@ public void fromProtoMessageToCelValue_withWellKnownProto_convertsToEquivalentCe

 assertThat(convertedCelValue).isEqualTo(testCase.celValue);
 }

 /** Test cases for repeated_int64: 1L,2L,3L */
 @SuppressWarnings("ImmutableEnumChecker") // Test only
 private enum RepeatedFieldBytesTestCase {
 PACKED(new byte[] {(byte) 0x82, 0x2, 0x3, 0x1, 0x2, 0x3}),
 NON_PACKED(new byte[] {(byte) 0x80, 0x2, 0x1, (byte) 0x80, 0x2, 0x2, (byte) 0x80, 0x2, 0x3}),
 // 1L is not packed, but 2L and 3L are
 MIXED(new byte[] {(byte) 0x80, 0x2, 0x1, (byte) 0x82, 0x2, 0x2, 0x2, 0x3});

 private final byte[] bytes;

 RepeatedFieldBytesTestCase(byte[] bytes) {
 this.bytes = bytes;
 }
 }

 @Test
 public void readAllFields_repeatedFields_packedBytesCombinations(
 @TestParameter RepeatedFieldBytesTestCase testCase) throws Exception {
 MessageFields fields =
 PROTO_LITE_CEL_VALUE_CONVERTER.readAllFields(
 testCase.bytes, "cel.expr.conformance.proto3.TestAllTypes");

 assertThat(fields.values()).containsExactly("repeated_int64", ImmutableList.of(1L, 2L, 3L));
 }

 /**
 * Unknown test with the following hypothetical fields:
 *
 * <pre>{@code
 * message TestAllTypes {
 * int64 single_int64_unknown = 2500;
 * fixed32 single_fixed32_unknown = 2501;
 * fixed64 single_fixed64_unknown = 2502;
 * string single_string_unknown = 2503;
 * repeated int64 repeated_int64_unknown = 2504;
 * map<string, int64> map_string_int64_unknown = 2505;
 * }
 * }</pre>
 */
 @SuppressWarnings("ImmutableEnumChecker") // Test only
 private enum UnknownFieldsTestCase {
 INT64(new byte[] {-96, -100, 1, 1}, "2500: 1", ImmutableListMultimap.of(2500, 1L)),
 FIXED32(
 new byte[] {-83, -100, 1, 2, 0, 0, 0},
 "2501: 0x00000002",
 ImmutableListMultimap.of(2501, 2)),
 FIXED64(
 new byte[] {-79, -100, 1, 3, 0, 0, 0, 0, 0, 0, 0},
 "2502: 0x0000000000000003",
 ImmutableListMultimap.of(2502, 3L)),
 STRING(
 new byte[] {-70, -100, 1, 11, 72, 101, 108, 108, 111, 32, 119, 111, 114, 108, 100},
 "2503: \"Hello world\"",
 ImmutableListMultimap.of(2503, ByteString.copyFromUtf8("Hello world"))),
 REPEATED_INT64(
 new byte[] {-62, -100, 1, 2, 4, 5},
 "2504: \"\\004\\005\"",
 ImmutableListMultimap.of(2504, ByteString.copyFrom(new byte[] {4, 5}))),
 MAP_STRING_INT64(
 new byte[] {
 -54, -100, 1, 7, 10, 3, 102, 111, 111, 16, 4, -54, -100, 1, 7, 10, 3, 98, 97, 114, 16, 5
 },
 "2505: {\n"
 + " 1: \"foo\"\n"
 + " 2: 4\n"
 + "}\n"
 + "2505: {\n"
 + " 1: \"bar\"\n"
 + " 2: 5\n"
 + "}",
 ImmutableListMultimap.of(
 2505,
 ByteString.copyFromUtf8("\n\003foo\020\004"),
 2505,
 ByteString.copyFromUtf8("\n\003bar\020\005")));

 private final byte[] bytes;
 private final String formattedOutput;
 private final Multimap<Integer, Object> unknownMap;

 UnknownFieldsTestCase(
 byte[] bytes, String formattedOutput, Multimap<Integer, Object> unknownMap) {
 this.bytes = bytes;
 this.formattedOutput = formattedOutput;
 this.unknownMap = unknownMap;
 }
 }

 @Test
 public void unknowns_repeatedEncodedBytes_allRecordsKeptWithKeysSorted() throws Exception {
 // 2500: 2
 // 2504: \"\\004\\005\""
 // 2501: 0x00000002
 // 2500: 1
 byte[] bytes =
 new byte[] {
 -96, -100, 1, 2, // keep
 -62, -100, 1, 2, 4, 5, // keep
 -83, -100, 1, 2, 0, 0, 0, // keep
 -96, -100, 1, 1 // keep
 };

 MessageFields messageFields =
 PROTO_LITE_CEL_VALUE_CONVERTER.readAllFields(
 bytes, "cel.expr.conformance.proto3.TestAllTypes");

 assertThat(messageFields.values()).isEmpty();
 assertThat(messageFields.unknowns())
 .containsExactly(
 2500, 2L, 2500, 1L, 2501, 2, 2504, ByteString.copyFrom(new byte[] {0x04, 0x05}))
 .inOrder();
 }

 @Test
 public void readAllFields_unknownFields(@TestParameter UnknownFieldsTestCase testCase)
 throws Exception {
 TestAllTypes parsedMsg =
 TestAllTypes.parseFrom(testCase.bytes, ExtensionRegistryLite.getEmptyRegistry());

 MessageFields messageFields =
 PROTO_LITE_CEL_VALUE_CONVERTER.readAllFields(
 testCase.bytes, "cel.expr.conformance.proto3.TestAllTypes");

 assertThat(messageFields.values()).isEmpty();
 assertThat(messageFields.unknowns()).containsExactlyEntriesIn(testCase.unknownMap).inOrder();
 assertThat(parsedMsg.toString().trim()).isEqualTo(testCase.formattedOutput);
 }

 /**
 * Tests the following message:
 *
 * <pre>{@code
 * TestAllTypes.newBuilder()
 * // Unknowns
 * .setSingleInt64Unknown(1L)
 * .setSingleFixed32Unknown(2)
 * .setSingleFixed64Unknown(3L)
 * .setSingleStringUnknown("Hello world")
 * .addAllRepeatedInt64Unknown(ImmutableList.of(4L, 5L))
 * .putMapStringInt64Unknown("foo", 4L)
 * .putMapStringInt64Unknown("bar", 5L)
 * // Known values
 * .putMapBoolDouble(true, 1.5d)
 * .putMapBoolDouble(false, 2.5d)
 * .build();
 * }</pre>
 */
 @Test
 @SuppressWarnings("unchecked")
 public void readAllFields_unknownFieldsWithValues() throws Exception {
 byte[] unknownMessageBytes = {
 -70, 4, 11, 8, 1, 17, 0, 0, 0, 0, 0, 0, -8, 63, -70, 4, 11, 8, 0, 17, 0, 0, 0, 0, 0, 0, 4, 64,
 -96, -100, 1, 1, -83, -100, 1, 2, 0, 0, 0, -79, -100, 1, 3, 0, 0, 0, 0, 0, 0, 0, -70, -100, 1,
 11, 72, 101, 108, 108, 111, 32, 119, 111, 114, 108, 100, -62, -100, 1, 2, 4, 5, -54, -100, 1,
 7, 10, 3, 102, 111, 111, 16, 4, -54, -100, 1, 7, 10, 3, 98, 97, 114, 16, 5
 };
 TestAllTypes parsedMsg =
 TestAllTypes.parseFrom(unknownMessageBytes, ExtensionRegistryLite.getEmptyRegistry());

 MessageFields fields =
 PROTO_LITE_CEL_VALUE_CONVERTER.readAllFields(
 unknownMessageBytes, "cel.expr.conformance.proto3.TestAllTypes");

 assertThat(parsedMsg.toString())
 .isEqualTo(
 "map_bool_double {\n"
 + " key: false\n"
 + " value: 2.5\n"
 + "}\n"
 + "map_bool_double {\n"
 + " key: true\n"
 + " value: 1.5\n"
 + "}\n"
 + "2500: 1\n"
 + "2501: 0x00000002\n"
 + "2502: 0x0000000000000003\n"
 + "2503: \"Hello world\"\n"
 + "2504: \"\\004\\005\"\n"
 + "2505: {\n"
 + " 1: \"foo\"\n"
 + " 2: 4\n"
 + "}\n"
 + "2505: {\n"
 + " 1: \"bar\"\n"
 + " 2: 5\n"
 + "}\n");
 assertThat(fields.values()).containsKey("map_bool_double");
 LinkedHashMap<Boolean, Double> mapBoolDoubleValues =
 (LinkedHashMap<Boolean, Double>) fields.values().get("map_bool_double");
 assertThat(mapBoolDoubleValues).containsExactly(true, 1.5d, false, 2.5d).inOrder();
 Multimap<Integer, Object> unknownValues = fields.unknowns();
 assertThat(unknownValues)
 .containsExactly(
 2500,
 1L,
 2501,
 2,
 2502,
 3L,
 2503,
 ByteString.copyFromUtf8("Hello world"),
 2504,
 ByteString.copyFrom(new byte[] {0x04, 0x05}),
 2505,
 ByteString.copyFromUtf8("\n\003foo\020\004"),
 2505,
 ByteString.copyFromUtf8("\n\003bar\020\005"))
 .inOrder();
 }
}

25 changes: 0 additions & 25 deletions
common/src/test/java/dev/cel/common/values/ProtoMessageLiteValueTest.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -271,29 +271,4 @@ public void selectField_defaultValue(@TestParameter DefaultValueTestCase testCas
 assertThat(selectedValue).isEqualTo(testCase.celValue);
 assertThat(selectedValue.isZeroValue()).isTrue();
 }

 /** Test cases for repeated_int64: 1L,2L,3L */
 @SuppressWarnings("ImmutableEnumChecker") // Test only
 private enum RepeatedFieldBytesTestCase {
 PACKED(new byte[] {(byte) 0x82, 0x2, 0x3, 0x1, 0x2, 0x3}),
 NON_PACKED(new byte[] {(byte) 0x80, 0x2, 0x1, (byte) 0x80, 0x2, 0x2, (byte) 0x80, 0x2, 0x3}),
 // 1L is not packed, but 2L and 3L are
 MIXED(new byte[] {(byte) 0x80, 0x2, 0x1, (byte) 0x82, 0x2, 0x2, 0x2, 0x3});

 private final byte[] bytes;

 RepeatedFieldBytesTestCase(byte[] bytes) {
 this.bytes = bytes;
 }
 }

 @Test
 public void readAllFields_repeatedFields_packedBytesCombinations(
 @TestParameter RepeatedFieldBytesTestCase testCase) throws Exception {
 ImmutableMap<String, Object> fields =
 PROTO_LITE_CEL_VALUE_CONVERTER.readAllFields(
 testCase.bytes, "cel.expr.conformance.proto3.TestAllTypes");

 assertThat(fields).containsExactly("repeated_int64", ImmutableList.of(1L, 2L, 3L));
 }
}
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Handle unknown fields in messagelite#683

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

copybara-service
merged 1 commit into

from

May 2, 2025
 Merged


Handle unknown fields in messagelite
#683
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


58 changes: 51 additions & 7 deletions
common/src/main/java/dev/cel/common/values/ProtoLiteCelValueConverter.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -16,10 +16,13 @@

import static com.google.common.base.Preconditions.checkNotNull;

import com.google.auto.value.AutoValue;
import com.google.common.annotations.VisibleForTesting;
import com.google.common.base.Defaults;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableMap;
import com.google.common.collect.Multimap;
import com.google.common.collect.Multimaps;
import com.google.common.primitives.UnsignedLong;
import com.google.errorprone.annotations.Immutable;
import com.google.protobuf.ByteString;
Expand All@@ -41,6 +44,7 @@
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import java.util.TreeMap;

/**
 * {@code ProtoLiteCelValueConverter} handles bidirectional conversion between native Java and
Expand DownExpand Up@@ -221,27 +225,33 @@ private ImmutableList<Object> readPackedRepeatedFields(
 private Map.Entry<Object, Object> readSingleMapEntry(
 CodedInputStream inputStream, FieldLiteDescriptor fieldDescriptor) throws IOException {
 ImmutableMap<String, Object> singleMapEntry =
 readAllFields(inputStream.readByteArray(), fieldDescriptor.getFieldProtoTypeName());
 readAllFields(inputStream.readByteArray(), fieldDescriptor.getFieldProtoTypeName())
 .values();
 Object key = checkNotNull(singleMapEntry.get("key"));
 Object value = checkNotNull(singleMapEntry.get("value"));

 return new AbstractMap.SimpleEntry<>(key, value);
 }

 @VisibleForTesting
 ImmutableMap<String, Object> readAllFields(byte[] bytes, String protoTypeName)
 throws IOException {
 // TODO: Handle unknown fields by collecting them into a separate map.
 MessageFields readAllFields(byte[] bytes, String protoTypeName) throws IOException {
 MessageLiteDescriptor messageDescriptor = descriptorPool.getDescriptorOrThrow(protoTypeName);
 CodedInputStream inputStream = CodedInputStream.newInstance(bytes);

 Multimap<Integer, Object> unknownFields =
 Multimaps.newMultimap(new TreeMap<>(), ArrayList::new);
 ImmutableMap.Builder<String, Object> fieldValues = ImmutableMap.builder();
 Map<Integer, List<Object>> repeatedFieldValues = new LinkedHashMap<>();
 Map<Integer, Map<Object, Object>> mapFieldValues = new LinkedHashMap<>();
 for (int tag = inputStream.readTag(); tag != 0; tag = inputStream.readTag()) {
 int tagWireType = WireFormat.getTagWireType(tag);
 int fieldNumber = WireFormat.getTagFieldNumber(tag);
 FieldLiteDescriptor fieldDescriptor = messageDescriptor.getByFieldNumberOrThrow(fieldNumber);
 FieldLiteDescriptor fieldDescriptor =
 messageDescriptor.findByFieldNumber(fieldNumber).orElse(null);
 if (fieldDescriptor == null) {
 unknownFields.put(fieldNumber, readUnknownField(tagWireType, inputStream));
 continue;
 }

 Object payload;
 switch (tagWireType) {
Expand DownExpand Up@@ -318,12 +328,32 @@ ImmutableMap<String, Object> readAllFields(byte[] bytes, String protoTypeName)

 // Protobuf encoding follows a "last one wins" semantics. This means for duplicated fields,
 // we accept the last value encountered.
 return fieldValues.buildKeepingLast();
 return MessageFields.create(fieldValues.buildKeepingLast(), unknownFields);
 }

 ImmutableMap<String, Object> readAllFields(MessageLite msg, String protoTypeName)
 throws IOException {
 return readAllFields(msg.toByteArray(), protoTypeName);
 return readAllFields(msg.toByteArray(), protoTypeName).values();
 }

 private static Object readUnknownField(int tagWireType, CodedInputStream inputStream)
 throws IOException {
 switch (tagWireType) {
 case WireFormat.WIRETYPE_VARINT:
 return inputStream.readInt64();
 case WireFormat.WIRETYPE_FIXED64:
 return inputStream.readFixed64();
 case WireFormat.WIRETYPE_LENGTH_DELIMITED:
 return inputStream.readBytes();
 case WireFormat.WIRETYPE_FIXED32:
 return inputStream.readFixed32();
 case WireFormat.WIRETYPE_START_GROUP:
 case WireFormat.WIRETYPE_END_GROUP:
 // TODO: Support groups
 throw new UnsupportedOperationException("Groups are not supported");
 default:
 throw new IllegalArgumentException("Unknown wire type: " + tagWireType);
 }
 }

 @Override
Expand All@@ -342,6 +372,20 @@ public CelValue fromProtoMessageToCelValue(String protoTypeName, MessageLite msg
 return super.fromWellKnownProtoToCelValue(msg, wellKnownProto);
 }

 @AutoValue
 @SuppressWarnings("AutoValueImmutableFields") // Unknowns are inaccessible to users.
 abstract static class MessageFields {

 abstract ImmutableMap<String, Object> values();

 abstract Multimap<Integer, Object> unknowns();

 static MessageFields create(
 ImmutableMap<String, Object> fieldValues, Multimap<Integer, Object> unknownFields) {
 return new AutoValue_ProtoLiteCelValueConverter_MessageFields(fieldValues, unknownFields);
 }
 }

 private ProtoLiteCelValueConverter(CelLiteDescriptorPool celLiteDescriptorPool) {
 this.descriptorPool = celLiteDescriptorPool;
 }
Expand Down

216 changes: 216 additions & 0 deletions
common/src/test/java/dev/cel/common/values/ProtoLiteCelValueConverterTest.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,9 +17,13 @@
import static com.google.common.truth.Truth.assertThat;
import static java.nio.charset.StandardCharsets.UTF_8;

import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableListMultimap;
import com.google.common.collect.ImmutableSet;
import com.google.common.collect.Multimap;
import com.google.protobuf.ByteString;
import com.google.protobuf.Duration;
import com.google.protobuf.ExtensionRegistryLite;
import com.google.protobuf.FloatValue;
import com.google.protobuf.Int32Value;
import com.google.protobuf.Int64Value;
Expand All@@ -32,9 +36,11 @@
import dev.cel.common.internal.CelLiteDescriptorPool;
import dev.cel.common.internal.DefaultLiteDescriptorPool;
import dev.cel.common.internal.WellKnownProto;
import dev.cel.common.values.ProtoLiteCelValueConverter.MessageFields;
import dev.cel.expr.conformance.proto3.TestAllTypes;
import dev.cel.expr.conformance.proto3.TestAllTypesProto3CelDescriptor;
import java.time.Instant;
import java.util.LinkedHashMap;
import org.junit.Test;
import org.junit.runner.RunWith;

Expand DownExpand Up@@ -107,4 +113,214 @@ public void fromProtoMessageToCelValue_withWellKnownProto_convertsToEquivalentCe

 assertThat(convertedCelValue).isEqualTo(testCase.celValue);
 }

 /** Test cases for repeated_int64: 1L,2L,3L */
 @SuppressWarnings("ImmutableEnumChecker") // Test only
 private enum RepeatedFieldBytesTestCase {
 PACKED(new byte[] {(byte) 0x82, 0x2, 0x3, 0x1, 0x2, 0x3}),
 NON_PACKED(new byte[] {(byte) 0x80, 0x2, 0x1, (byte) 0x80, 0x2, 0x2, (byte) 0x80, 0x2, 0x3}),
 // 1L is not packed, but 2L and 3L are
 MIXED(new byte[] {(byte) 0x80, 0x2, 0x1, (byte) 0x82, 0x2, 0x2, 0x2, 0x3});

 private final byte[] bytes;

 RepeatedFieldBytesTestCase(byte[] bytes) {
 this.bytes = bytes;
 }
 }

 @Test
 public void readAllFields_repeatedFields_packedBytesCombinations(
 @TestParameter RepeatedFieldBytesTestCase testCase) throws Exception {
 MessageFields fields =
 PROTO_LITE_CEL_VALUE_CONVERTER.readAllFields(
 testCase.bytes, "cel.expr.conformance.proto3.TestAllTypes");

 assertThat(fields.values()).containsExactly("repeated_int64", ImmutableList.of(1L, 2L, 3L));
 }

 /**
 * Unknown test with the following hypothetical fields:
 *
 * <pre>{@code
 * message TestAllTypes {
 * int64 single_int64_unknown = 2500;
 * fixed32 single_fixed32_unknown = 2501;
 * fixed64 single_fixed64_unknown = 2502;
 * string single_string_unknown = 2503;
 * repeated int64 repeated_int64_unknown = 2504;
 * map<string, int64> map_string_int64_unknown = 2505;
 * }
 * }</pre>
 */
 @SuppressWarnings("ImmutableEnumChecker") // Test only
 private enum UnknownFieldsTestCase {
 INT64(new byte[] {-96, -100, 1, 1}, "2500: 1", ImmutableListMultimap.of(2500, 1L)),
 FIXED32(
 new byte[] {-83, -100, 1, 2, 0, 0, 0},
 "2501: 0x00000002",
 ImmutableListMultimap.of(2501, 2)),
 FIXED64(
 new byte[] {-79, -100, 1, 3, 0, 0, 0, 0, 0, 0, 0},
 "2502: 0x0000000000000003",
 ImmutableListMultimap.of(2502, 3L)),
 STRING(
 new byte[] {-70, -100, 1, 11, 72, 101, 108, 108, 111, 32, 119, 111, 114, 108, 100},
 "2503: \"Hello world\"",
 ImmutableListMultimap.of(2503, ByteString.copyFromUtf8("Hello world"))),
 REPEATED_INT64(
 new byte[] {-62, -100, 1, 2, 4, 5},
 "2504: \"\\004\\005\"",
 ImmutableListMultimap.of(2504, ByteString.copyFrom(new byte[] {4, 5}))),
 MAP_STRING_INT64(
 new byte[] {
 -54, -100, 1, 7, 10, 3, 102, 111, 111, 16, 4, -54, -100, 1, 7, 10, 3, 98, 97, 114, 16, 5
 },
 "2505: {\n"
 + " 1: \"foo\"\n"
 + " 2: 4\n"
 + "}\n"
 + "2505: {\n"
 + " 1: \"bar\"\n"
 + " 2: 5\n"
 + "}",
 ImmutableListMultimap.of(
 2505,
 ByteString.copyFromUtf8("\n\003foo\020\004"),
 2505,
 ByteString.copyFromUtf8("\n\003bar\020\005")));

 private final byte[] bytes;
 private final String formattedOutput;
 private final Multimap<Integer, Object> unknownMap;

 UnknownFieldsTestCase(
 byte[] bytes, String formattedOutput, Multimap<Integer, Object> unknownMap) {
 this.bytes = bytes;
 this.formattedOutput = formattedOutput;
 this.unknownMap = unknownMap;
 }
 }

 @Test
 public void unknowns_repeatedEncodedBytes_allRecordsKeptWithKeysSorted() throws Exception {
 // 2500: 2
 // 2504: \"\\004\\005\""
 // 2501: 0x00000002
 // 2500: 1
 byte[] bytes =
 new byte[] {
 -96, -100, 1, 2, // keep
 -62, -100, 1, 2, 4, 5, // keep
 -83, -100, 1, 2, 0, 0, 0, // keep
 -96, -100, 1, 1 // keep
 };

 MessageFields messageFields =
 PROTO_LITE_CEL_VALUE_CONVERTER.readAllFields(
 bytes, "cel.expr.conformance.proto3.TestAllTypes");

 assertThat(messageFields.values()).isEmpty();
 assertThat(messageFields.unknowns())
 .containsExactly(
 2500, 2L, 2500, 1L, 2501, 2, 2504, ByteString.copyFrom(new byte[] {0x04, 0x05}))
 .inOrder();
 }

 @Test
 public void readAllFields_unknownFields(@TestParameter UnknownFieldsTestCase testCase)
 throws Exception {
 TestAllTypes parsedMsg =
 TestAllTypes.parseFrom(testCase.bytes, ExtensionRegistryLite.getEmptyRegistry());

 MessageFields messageFields =
 PROTO_LITE_CEL_VALUE_CONVERTER.readAllFields(
 testCase.bytes, "cel.expr.conformance.proto3.TestAllTypes");

 assertThat(messageFields.values()).isEmpty();
 assertThat(messageFields.unknowns()).containsExactlyEntriesIn(testCase.unknownMap).inOrder();
 assertThat(parsedMsg.toString().trim()).isEqualTo(testCase.formattedOutput);
 }

 /**
 * Tests the following message:
 *
 * <pre>{@code
 * TestAllTypes.newBuilder()
 * // Unknowns
 * .setSingleInt64Unknown(1L)
 * .setSingleFixed32Unknown(2)
 * .setSingleFixed64Unknown(3L)
 * .setSingleStringUnknown("Hello world")
 * .addAllRepeatedInt64Unknown(ImmutableList.of(4L, 5L))
 * .putMapStringInt64Unknown("foo", 4L)
 * .putMapStringInt64Unknown("bar", 5L)
 * // Known values
 * .putMapBoolDouble(true, 1.5d)
 * .putMapBoolDouble(false, 2.5d)
 * .build();
 * }</pre>
 */
 @Test
 @SuppressWarnings("unchecked")
 public void readAllFields_unknownFieldsWithValues() throws Exception {
 byte[] unknownMessageBytes = {
 -70, 4, 11, 8, 1, 17, 0, 0, 0, 0, 0, 0, -8, 63, -70, 4, 11, 8, 0, 17, 0, 0, 0, 0, 0, 0, 4, 64,
 -96, -100, 1, 1, -83, -100, 1, 2, 0, 0, 0, -79, -100, 1, 3, 0, 0, 0, 0, 0, 0, 0, -70, -100, 1,
 11, 72, 101, 108, 108, 111, 32, 119, 111, 114, 108, 100, -62, -100, 1, 2, 4, 5, -54, -100, 1,
 7, 10, 3, 102, 111, 111, 16, 4, -54, -100, 1, 7, 10, 3, 98, 97, 114, 16, 5
 };
 TestAllTypes parsedMsg =
 TestAllTypes.parseFrom(unknownMessageBytes, ExtensionRegistryLite.getEmptyRegistry());

 MessageFields fields =
 PROTO_LITE_CEL_VALUE_CONVERTER.readAllFields(
 unknownMessageBytes, "cel.expr.conformance.proto3.TestAllTypes");

 assertThat(parsedMsg.toString())
 .isEqualTo(
 "map_bool_double {\n"
 + " key: false\n"
 + " value: 2.5\n"
 + "}\n"
 + "map_bool_double {\n"
 + " key: true\n"
 + " value: 1.5\n"
 + "}\n"
 + "2500: 1\n"
 + "2501: 0x00000002\n"
 + "2502: 0x0000000000000003\n"
 + "2503: \"Hello world\"\n"
 + "2504: \"\\004\\005\"\n"
 + "2505: {\n"
 + " 1: \"foo\"\n"
 + " 2: 4\n"
 + "}\n"
 + "2505: {\n"
 + " 1: \"bar\"\n"
 + " 2: 5\n"
 + "}\n");
 assertThat(fields.values()).containsKey("map_bool_double");
 LinkedHashMap<Boolean, Double> mapBoolDoubleValues =
 (LinkedHashMap<Boolean, Double>) fields.values().get("map_bool_double");
 assertThat(mapBoolDoubleValues).containsExactly(true, 1.5d, false, 2.5d).inOrder();
 Multimap<Integer, Object> unknownValues = fields.unknowns();
 assertThat(unknownValues)
 .containsExactly(
 2500,
 1L,
 2501,
 2,
 2502,
 3L,
 2503,
 ByteString.copyFromUtf8("Hello world"),
 2504,
 ByteString.copyFrom(new byte[] {0x04, 0x05}),
 2505,
 ByteString.copyFromUtf8("\n\003foo\020\004"),
 2505,
 ByteString.copyFromUtf8("\n\003bar\020\005"))
 .inOrder();
 }
}

25 changes: 0 additions & 25 deletions
common/src/test/java/dev/cel/common/values/ProtoMessageLiteValueTest.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -271,29 +271,4 @@ public void selectField_defaultValue(@TestParameter DefaultValueTestCase testCas
 assertThat(selectedValue).isEqualTo(testCase.celValue);
 assertThat(selectedValue.isZeroValue()).isTrue();
 }

 /** Test cases for repeated_int64: 1L,2L,3L */
 @SuppressWarnings("ImmutableEnumChecker") // Test only
 private enum RepeatedFieldBytesTestCase {
 PACKED(new byte[] {(byte) 0x82, 0x2, 0x3, 0x1, 0x2, 0x3}),
 NON_PACKED(new byte[] {(byte) 0x80, 0x2, 0x1, (byte) 0x80, 0x2, 0x2, (byte) 0x80, 0x2, 0x3}),
 // 1L is not packed, but 2L and 3L are
 MIXED(new byte[] {(byte) 0x80, 0x2, 0x1, (byte) 0x82, 0x2, 0x2, 0x2, 0x3});

 private final byte[] bytes;

 RepeatedFieldBytesTestCase(byte[] bytes) {
 this.bytes = bytes;
 }
 }

 @Test
 public void readAllFields_repeatedFields_packedBytesCombinations(
 @TestParameter RepeatedFieldBytesTestCase testCase) throws Exception {
 ImmutableMap<String, Object> fields =
 PROTO_LITE_CEL_VALUE_CONVERTER.readAllFields(
 testCase.bytes, "cel.expr.conformance.proto3.TestAllTypes");

 assertThat(fields).containsExactly("repeated_int64", ImmutableList.of(1L, 2L, 3L));
 }
}
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Handle unknown fields in messagelite#683

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

copybara-service
merged 1 commit into

from

May 2, 2025
 Merged


Handle unknown fields in messagelite
#683
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


58 changes: 51 additions & 7 deletions
common/src/main/java/dev/cel/common/values/ProtoLiteCelValueConverter.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -16,10 +16,13 @@

import static com.google.common.base.Preconditions.checkNotNull;

import com.google.auto.value.AutoValue;
import com.google.common.annotations.VisibleForTesting;
import com.google.common.base.Defaults;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableMap;
import com.google.common.collect.Multimap;
import com.google.common.collect.Multimaps;
import com.google.common.primitives.UnsignedLong;
import com.google.errorprone.annotations.Immutable;
import com.google.protobuf.ByteString;
Expand All@@ -41,6 +44,7 @@
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import java.util.TreeMap;

/**
 * {@code ProtoLiteCelValueConverter} handles bidirectional conversion between native Java and
Expand DownExpand Up@@ -221,27 +225,33 @@ private ImmutableList<Object> readPackedRepeatedFields(
 private Map.Entry<Object, Object> readSingleMapEntry(
 CodedInputStream inputStream, FieldLiteDescriptor fieldDescriptor) throws IOException {
 ImmutableMap<String, Object> singleMapEntry =
 readAllFields(inputStream.readByteArray(), fieldDescriptor.getFieldProtoTypeName());
 readAllFields(inputStream.readByteArray(), fieldDescriptor.getFieldProtoTypeName())
 .values();
 Object key = checkNotNull(singleMapEntry.get("key"));
 Object value = checkNotNull(singleMapEntry.get("value"));

 return new AbstractMap.SimpleEntry<>(key, value);
 }

 @VisibleForTesting
 ImmutableMap<String, Object> readAllFields(byte[] bytes, String protoTypeName)
 throws IOException {
 // TODO: Handle unknown fields by collecting them into a separate map.
 MessageFields readAllFields(byte[] bytes, String protoTypeName) throws IOException {
 MessageLiteDescriptor messageDescriptor = descriptorPool.getDescriptorOrThrow(protoTypeName);
 CodedInputStream inputStream = CodedInputStream.newInstance(bytes);

 Multimap<Integer, Object> unknownFields =
 Multimaps.newMultimap(new TreeMap<>(), ArrayList::new);
 ImmutableMap.Builder<String, Object> fieldValues = ImmutableMap.builder();
 Map<Integer, List<Object>> repeatedFieldValues = new LinkedHashMap<>();
 Map<Integer, Map<Object, Object>> mapFieldValues = new LinkedHashMap<>();
 for (int tag = inputStream.readTag(); tag != 0; tag = inputStream.readTag()) {
 int tagWireType = WireFormat.getTagWireType(tag);
 int fieldNumber = WireFormat.getTagFieldNumber(tag);
 FieldLiteDescriptor fieldDescriptor = messageDescriptor.getByFieldNumberOrThrow(fieldNumber);
 FieldLiteDescriptor fieldDescriptor =
 messageDescriptor.findByFieldNumber(fieldNumber).orElse(null);
 if (fieldDescriptor == null) {
 unknownFields.put(fieldNumber, readUnknownField(tagWireType, inputStream));
 continue;
 }

 Object payload;
 switch (tagWireType) {
Expand DownExpand Up@@ -318,12 +328,32 @@ ImmutableMap<String, Object> readAllFields(byte[] bytes, String protoTypeName)

 // Protobuf encoding follows a "last one wins" semantics. This means for duplicated fields,
 // we accept the last value encountered.
 return fieldValues.buildKeepingLast();
 return MessageFields.create(fieldValues.buildKeepingLast(), unknownFields);
 }

 ImmutableMap<String, Object> readAllFields(MessageLite msg, String protoTypeName)
 throws IOException {
 return readAllFields(msg.toByteArray(), protoTypeName);
 return readAllFields(msg.toByteArray(), protoTypeName).values();
 }

 private static Object readUnknownField(int tagWireType, CodedInputStream inputStream)
 throws IOException {
 switch (tagWireType) {
 case WireFormat.WIRETYPE_VARINT:
 return inputStream.readInt64();
 case WireFormat.WIRETYPE_FIXED64:
 return inputStream.readFixed64();
 case WireFormat.WIRETYPE_LENGTH_DELIMITED:
 return inputStream.readBytes();
 case WireFormat.WIRETYPE_FIXED32:
 return inputStream.readFixed32();
 case WireFormat.WIRETYPE_START_GROUP:
 case WireFormat.WIRETYPE_END_GROUP:
 // TODO: Support groups
 throw new UnsupportedOperationException("Groups are not supported");
 default:
 throw new IllegalArgumentException("Unknown wire type: " + tagWireType);
 }
 }

 @Override
Expand All@@ -342,6 +372,20 @@ public CelValue fromProtoMessageToCelValue(String protoTypeName, MessageLite msg
 return super.fromWellKnownProtoToCelValue(msg, wellKnownProto);
 }

 @AutoValue
 @SuppressWarnings("AutoValueImmutableFields") // Unknowns are inaccessible to users.
 abstract static class MessageFields {

 abstract ImmutableMap<String, Object> values();

 abstract Multimap<Integer, Object> unknowns();

 static MessageFields create(
 ImmutableMap<String, Object> fieldValues, Multimap<Integer, Object> unknownFields) {
 return new AutoValue_ProtoLiteCelValueConverter_MessageFields(fieldValues, unknownFields);
 }
 }

 private ProtoLiteCelValueConverter(CelLiteDescriptorPool celLiteDescriptorPool) {
 this.descriptorPool = celLiteDescriptorPool;
 }
Expand Down

216 changes: 216 additions & 0 deletions
common/src/test/java/dev/cel/common/values/ProtoLiteCelValueConverterTest.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,9 +17,13 @@
import static com.google.common.truth.Truth.assertThat;
import static java.nio.charset.StandardCharsets.UTF_8;

import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableListMultimap;
import com.google.common.collect.ImmutableSet;
import com.google.common.collect.Multimap;
import com.google.protobuf.ByteString;
import com.google.protobuf.Duration;
import com.google.protobuf.ExtensionRegistryLite;
import com.google.protobuf.FloatValue;
import com.google.protobuf.Int32Value;
import com.google.protobuf.Int64Value;
Expand All@@ -32,9 +36,11 @@
import dev.cel.common.internal.CelLiteDescriptorPool;
import dev.cel.common.internal.DefaultLiteDescriptorPool;
import dev.cel.common.internal.WellKnownProto;
import dev.cel.common.values.ProtoLiteCelValueConverter.MessageFields;
import dev.cel.expr.conformance.proto3.TestAllTypes;
import dev.cel.expr.conformance.proto3.TestAllTypesProto3CelDescriptor;
import java.time.Instant;
import java.util.LinkedHashMap;
import org.junit.Test;
import org.junit.runner.RunWith;

Expand DownExpand Up@@ -107,4 +113,214 @@ public void fromProtoMessageToCelValue_withWellKnownProto_convertsToEquivalentCe

 assertThat(convertedCelValue).isEqualTo(testCase.celValue);
 }

 /** Test cases for repeated_int64: 1L,2L,3L */
 @SuppressWarnings("ImmutableEnumChecker") // Test only
 private enum RepeatedFieldBytesTestCase {
 PACKED(new byte[] {(byte) 0x82, 0x2, 0x3, 0x1, 0x2, 0x3}),
 NON_PACKED(new byte[] {(byte) 0x80, 0x2, 0x1, (byte) 0x80, 0x2, 0x2, (byte) 0x80, 0x2, 0x3}),
 // 1L is not packed, but 2L and 3L are
 MIXED(new byte[] {(byte) 0x80, 0x2, 0x1, (byte) 0x82, 0x2, 0x2, 0x2, 0x3});

 private final byte[] bytes;

 RepeatedFieldBytesTestCase(byte[] bytes) {
 this.bytes = bytes;
 }
 }

 @Test
 public void readAllFields_repeatedFields_packedBytesCombinations(
 @TestParameter RepeatedFieldBytesTestCase testCase) throws Exception {
 MessageFields fields =
 PROTO_LITE_CEL_VALUE_CONVERTER.readAllFields(
 testCase.bytes, "cel.expr.conformance.proto3.TestAllTypes");

 assertThat(fields.values()).containsExactly("repeated_int64", ImmutableList.of(1L, 2L, 3L));
 }

 /**
 * Unknown test with the following hypothetical fields:
 *
 * <pre>{@code
 * message TestAllTypes {
 * int64 single_int64_unknown = 2500;
 * fixed32 single_fixed32_unknown = 2501;
 * fixed64 single_fixed64_unknown = 2502;
 * string single_string_unknown = 2503;
 * repeated int64 repeated_int64_unknown = 2504;
 * map<string, int64> map_string_int64_unknown = 2505;
 * }
 * }</pre>
 */
 @SuppressWarnings("ImmutableEnumChecker") // Test only
 private enum UnknownFieldsTestCase {
 INT64(new byte[] {-96, -100, 1, 1}, "2500: 1", ImmutableListMultimap.of(2500, 1L)),
 FIXED32(
 new byte[] {-83, -100, 1, 2, 0, 0, 0},
 "2501: 0x00000002",
 ImmutableListMultimap.of(2501, 2)),
 FIXED64(
 new byte[] {-79, -100, 1, 3, 0, 0, 0, 0, 0, 0, 0},
 "2502: 0x0000000000000003",
 ImmutableListMultimap.of(2502, 3L)),
 STRING(
 new byte[] {-70, -100, 1, 11, 72, 101, 108, 108, 111, 32, 119, 111, 114, 108, 100},
 "2503: \"Hello world\"",
 ImmutableListMultimap.of(2503, ByteString.copyFromUtf8("Hello world"))),
 REPEATED_INT64(
 new byte[] {-62, -100, 1, 2, 4, 5},
 "2504: \"\\004\\005\"",
 ImmutableListMultimap.of(2504, ByteString.copyFrom(new byte[] {4, 5}))),
 MAP_STRING_INT64(
 new byte[] {
 -54, -100, 1, 7, 10, 3, 102, 111, 111, 16, 4, -54, -100, 1, 7, 10, 3, 98, 97, 114, 16, 5
 },
 "2505: {\n"
 + " 1: \"foo\"\n"
 + " 2: 4\n"
 + "}\n"
 + "2505: {\n"
 + " 1: \"bar\"\n"
 + " 2: 5\n"
 + "}",
 ImmutableListMultimap.of(
 2505,
 ByteString.copyFromUtf8("\n\003foo\020\004"),
 2505,
 ByteString.copyFromUtf8("\n\003bar\020\005")));

 private final byte[] bytes;
 private final String formattedOutput;
 private final Multimap<Integer, Object> unknownMap;

 UnknownFieldsTestCase(
 byte[] bytes, String formattedOutput, Multimap<Integer, Object> unknownMap) {
 this.bytes = bytes;
 this.formattedOutput = formattedOutput;
 this.unknownMap = unknownMap;
 }
 }

 @Test
 public void unknowns_repeatedEncodedBytes_allRecordsKeptWithKeysSorted() throws Exception {
 // 2500: 2
 // 2504: \"\\004\\005\""
 // 2501: 0x00000002
 // 2500: 1
 byte[] bytes =
 new byte[] {
 -96, -100, 1, 2, // keep
 -62, -100, 1, 2, 4, 5, // keep
 -83, -100, 1, 2, 0, 0, 0, // keep
 -96, -100, 1, 1 // keep
 };

 MessageFields messageFields =
 PROTO_LITE_CEL_VALUE_CONVERTER.readAllFields(
 bytes, "cel.expr.conformance.proto3.TestAllTypes");

 assertThat(messageFields.values()).isEmpty();
 assertThat(messageFields.unknowns())
 .containsExactly(
 2500, 2L, 2500, 1L, 2501, 2, 2504, ByteString.copyFrom(new byte[] {0x04, 0x05}))
 .inOrder();
 }

 @Test
 public void readAllFields_unknownFields(@TestParameter UnknownFieldsTestCase testCase)
 throws Exception {
 TestAllTypes parsedMsg =
 TestAllTypes.parseFrom(testCase.bytes, ExtensionRegistryLite.getEmptyRegistry());

 MessageFields messageFields =
 PROTO_LITE_CEL_VALUE_CONVERTER.readAllFields(
 testCase.bytes, "cel.expr.conformance.proto3.TestAllTypes");

 assertThat(messageFields.values()).isEmpty();
 assertThat(messageFields.unknowns()).containsExactlyEntriesIn(testCase.unknownMap).inOrder();
 assertThat(parsedMsg.toString().trim()).isEqualTo(testCase.formattedOutput);
 }

 /**
 * Tests the following message:
 *
 * <pre>{@code
 * TestAllTypes.newBuilder()
 * // Unknowns
 * .setSingleInt64Unknown(1L)
 * .setSingleFixed32Unknown(2)
 * .setSingleFixed64Unknown(3L)
 * .setSingleStringUnknown("Hello world")
 * .addAllRepeatedInt64Unknown(ImmutableList.of(4L, 5L))
 * .putMapStringInt64Unknown("foo", 4L)
 * .putMapStringInt64Unknown("bar", 5L)
 * // Known values
 * .putMapBoolDouble(true, 1.5d)
 * .putMapBoolDouble(false, 2.5d)
 * .build();
 * }</pre>
 */
 @Test
 @SuppressWarnings("unchecked")
 public void readAllFields_unknownFieldsWithValues() throws Exception {
 byte[] unknownMessageBytes = {
 -70, 4, 11, 8, 1, 17, 0, 0, 0, 0, 0, 0, -8, 63, -70, 4, 11, 8, 0, 17, 0, 0, 0, 0, 0, 0, 4, 64,
 -96, -100, 1, 1, -83, -100, 1, 2, 0, 0, 0, -79, -100, 1, 3, 0, 0, 0, 0, 0, 0, 0, -70, -100, 1,
 11, 72, 101, 108, 108, 111, 32, 119, 111, 114, 108, 100, -62, -100, 1, 2, 4, 5, -54, -100, 1,
 7, 10, 3, 102, 111, 111, 16, 4, -54, -100, 1, 7, 10, 3, 98, 97, 114, 16, 5
 };
 TestAllTypes parsedMsg =
 TestAllTypes.parseFrom(unknownMessageBytes, ExtensionRegistryLite.getEmptyRegistry());

 MessageFields fields =
 PROTO_LITE_CEL_VALUE_CONVERTER.readAllFields(
 unknownMessageBytes, "cel.expr.conformance.proto3.TestAllTypes");

 assertThat(parsedMsg.toString())
 .isEqualTo(
 "map_bool_double {\n"
 + " key: false\n"
 + " value: 2.5\n"
 + "}\n"
 + "map_bool_double {\n"
 + " key: true\n"
 + " value: 1.5\n"
 + "}\n"
 + "2500: 1\n"
 + "2501: 0x00000002\n"
 + "2502: 0x0000000000000003\n"
 + "2503: \"Hello world\"\n"
 + "2504: \"\\004\\005\"\n"
 + "2505: {\n"
 + " 1: \"foo\"\n"
 + " 2: 4\n"
 + "}\n"
 + "2505: {\n"
 + " 1: \"bar\"\n"
 + " 2: 5\n"
 + "}\n");
 assertThat(fields.values()).containsKey("map_bool_double");
 LinkedHashMap<Boolean, Double> mapBoolDoubleValues =
 (LinkedHashMap<Boolean, Double>) fields.values().get("map_bool_double");
 assertThat(mapBoolDoubleValues).containsExactly(true, 1.5d, false, 2.5d).inOrder();
 Multimap<Integer, Object> unknownValues = fields.unknowns();
 assertThat(unknownValues)
 .containsExactly(
 2500,
 1L,
 2501,
 2,
 2502,
 3L,
 2503,
 ByteString.copyFromUtf8("Hello world"),
 2504,
 ByteString.copyFrom(new byte[] {0x04, 0x05}),
 2505,
 ByteString.copyFromUtf8("\n\003foo\020\004"),
 2505,
 ByteString.copyFromUtf8("\n\003bar\020\005"))
 .inOrder();
 }
}

25 changes: 0 additions & 25 deletions
common/src/test/java/dev/cel/common/values/ProtoMessageLiteValueTest.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -271,29 +271,4 @@ public void selectField_defaultValue(@TestParameter DefaultValueTestCase testCas
 assertThat(selectedValue).isEqualTo(testCase.celValue);
 assertThat(selectedValue.isZeroValue()).isTrue();
 }

 /** Test cases for repeated_int64: 1L,2L,3L */
 @SuppressWarnings("ImmutableEnumChecker") // Test only
 private enum RepeatedFieldBytesTestCase {
 PACKED(new byte[] {(byte) 0x82, 0x2, 0x3, 0x1, 0x2, 0x3}),
 NON_PACKED(new byte[] {(byte) 0x80, 0x2, 0x1, (byte) 0x80, 0x2, 0x2, (byte) 0x80, 0x2, 0x3}),
 // 1L is not packed, but 2L and 3L are
 MIXED(new byte[] {(byte) 0x80, 0x2, 0x1, (byte) 0x82, 0x2, 0x2, 0x2, 0x3});

 private final byte[] bytes;

 RepeatedFieldBytesTestCase(byte[] bytes) {
 this.bytes = bytes;
 }
 }

 @Test
 public void readAllFields_repeatedFields_packedBytesCombinations(
 @TestParameter RepeatedFieldBytesTestCase testCase) throws Exception {
 ImmutableMap<String, Object> fields =
 PROTO_LITE_CEL_VALUE_CONVERTER.readAllFields(
 testCase.bytes, "cel.expr.conformance.proto3.TestAllTypes");

 assertThat(fields).containsExactly("repeated_int64", ImmutableList.of(1L, 2L, 3L));
 }
}
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
Handle unknown fields in messagelite#683

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

copybara-service
merged 1 commit into

from

May 2, 2025
 Merged


Handle unknown fields in messagelite
#683
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


58 changes: 51 additions & 7 deletions
common/src/main/java/dev/cel/common/values/ProtoLiteCelValueConverter.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -16,10 +16,13 @@

import static com.google.common.base.Preconditions.checkNotNull;

import com.google.auto.value.AutoValue;
import com.google.common.annotations.VisibleForTesting;
import com.google.common.base.Defaults;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableMap;
import com.google.common.collect.Multimap;
import com.google.common.collect.Multimaps;
import com.google.common.primitives.UnsignedLong;
import com.google.errorprone.annotations.Immutable;
import com.google.protobuf.ByteString;
Expand All@@ -41,6 +44,7 @@
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import java.util.TreeMap;

/**
 * {@code ProtoLiteCelValueConverter} handles bidirectional conversion between native Java and
Expand DownExpand Up@@ -221,27 +225,33 @@ private ImmutableList<Object> readPackedRepeatedFields(
 private Map.Entry<Object, Object> readSingleMapEntry(
 CodedInputStream inputStream, FieldLiteDescriptor fieldDescriptor) throws IOException {
 ImmutableMap<String, Object> singleMapEntry =
 readAllFields(inputStream.readByteArray(), fieldDescriptor.getFieldProtoTypeName());
 readAllFields(inputStream.readByteArray(), fieldDescriptor.getFieldProtoTypeName())
 .values();
 Object key = checkNotNull(singleMapEntry.get("key"));
 Object value = checkNotNull(singleMapEntry.get("value"));

 return new AbstractMap.SimpleEntry<>(key, value);
 }

 @VisibleForTesting
 ImmutableMap<String, Object> readAllFields(byte[] bytes, String protoTypeName)
 throws IOException {
 // TODO: Handle unknown fields by collecting them into a separate map.
 MessageFields readAllFields(byte[] bytes, String protoTypeName) throws IOException {
 MessageLiteDescriptor messageDescriptor = descriptorPool.getDescriptorOrThrow(protoTypeName);
 CodedInputStream inputStream = CodedInputStream.newInstance(bytes);

 Multimap<Integer, Object> unknownFields =
 Multimaps.newMultimap(new TreeMap<>(), ArrayList::new);
 ImmutableMap.Builder<String, Object> fieldValues = ImmutableMap.builder();
 Map<Integer, List<Object>> repeatedFieldValues = new LinkedHashMap<>();
 Map<Integer, Map<Object, Object>> mapFieldValues = new LinkedHashMap<>();
 for (int tag = inputStream.readTag(); tag != 0; tag = inputStream.readTag()) {
 int tagWireType = WireFormat.getTagWireType(tag);
 int fieldNumber = WireFormat.getTagFieldNumber(tag);
 FieldLiteDescriptor fieldDescriptor = messageDescriptor.getByFieldNumberOrThrow(fieldNumber);
 FieldLiteDescriptor fieldDescriptor =
 messageDescriptor.findByFieldNumber(fieldNumber).orElse(null);
 if (fieldDescriptor == null) {
 unknownFields.put(fieldNumber, readUnknownField(tagWireType, inputStream));
 continue;
 }

 Object payload;
 switch (tagWireType) {
Expand DownExpand Up@@ -318,12 +328,32 @@ ImmutableMap<String, Object> readAllFields(byte[] bytes, String protoTypeName)

 // Protobuf encoding follows a "last one wins" semantics. This means for duplicated fields,
 // we accept the last value encountered.
 return fieldValues.buildKeepingLast();
 return MessageFields.create(fieldValues.buildKeepingLast(), unknownFields);
 }

 ImmutableMap<String, Object> readAllFields(MessageLite msg, String protoTypeName)
 throws IOException {
 return readAllFields(msg.toByteArray(), protoTypeName);
 return readAllFields(msg.toByteArray(), protoTypeName).values();
 }

 private static Object readUnknownField(int tagWireType, CodedInputStream inputStream)
 throws IOException {
 switch (tagWireType) {
 case WireFormat.WIRETYPE_VARINT:
 return inputStream.readInt64();
 case WireFormat.WIRETYPE_FIXED64:
 return inputStream.readFixed64();
 case WireFormat.WIRETYPE_LENGTH_DELIMITED:
 return inputStream.readBytes();
 case WireFormat.WIRETYPE_FIXED32:
 return inputStream.readFixed32();
 case WireFormat.WIRETYPE_START_GROUP:
 case WireFormat.WIRETYPE_END_GROUP:
 // TODO: Support groups
 throw new UnsupportedOperationException("Groups are not supported");
 default:
 throw new IllegalArgumentException("Unknown wire type: " + tagWireType);
 }
 }

 @Override
Expand All@@ -342,6 +372,20 @@ public CelValue fromProtoMessageToCelValue(String protoTypeName, MessageLite msg
 return super.fromWellKnownProtoToCelValue(msg, wellKnownProto);
 }

 @AutoValue
 @SuppressWarnings("AutoValueImmutableFields") // Unknowns are inaccessible to users.
 abstract static class MessageFields {

 abstract ImmutableMap<String, Object> values();

 abstract Multimap<Integer, Object> unknowns();

 static MessageFields create(
 ImmutableMap<String, Object> fieldValues, Multimap<Integer, Object> unknownFields) {
 return new AutoValue_ProtoLiteCelValueConverter_MessageFields(fieldValues, unknownFields);
 }
 }

 private ProtoLiteCelValueConverter(CelLiteDescriptorPool celLiteDescriptorPool) {
 this.descriptorPool = celLiteDescriptorPool;
 }
Expand Down

216 changes: 216 additions & 0 deletions
common/src/test/java/dev/cel/common/values/ProtoLiteCelValueConverterTest.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,9 +17,13 @@
import static com.google.common.truth.Truth.assertThat;
import static java.nio.charset.StandardCharsets.UTF_8;

import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableListMultimap;
import com.google.common.collect.ImmutableSet;
import com.google.common.collect.Multimap;
import com.google.protobuf.ByteString;
import com.google.protobuf.Duration;
import com.google.protobuf.ExtensionRegistryLite;
import com.google.protobuf.FloatValue;
import com.google.protobuf.Int32Value;
import com.google.protobuf.Int64Value;
Expand All@@ -32,9 +36,11 @@
import dev.cel.common.internal.CelLiteDescriptorPool;
import dev.cel.common.internal.DefaultLiteDescriptorPool;
import dev.cel.common.internal.WellKnownProto;
import dev.cel.common.values.ProtoLiteCelValueConverter.MessageFields;
import dev.cel.expr.conformance.proto3.TestAllTypes;
import dev.cel.expr.conformance.proto3.TestAllTypesProto3CelDescriptor;
import java.time.Instant;
import java.util.LinkedHashMap;
import org.junit.Test;
import org.junit.runner.RunWith;

Expand DownExpand Up@@ -107,4 +113,214 @@ public void fromProtoMessageToCelValue_withWellKnownProto_convertsToEquivalentCe

 assertThat(convertedCelValue).isEqualTo(testCase.celValue);
 }

 /** Test cases for repeated_int64: 1L,2L,3L */
 @SuppressWarnings("ImmutableEnumChecker") // Test only
 private enum RepeatedFieldBytesTestCase {
 PACKED(new byte[] {(byte) 0x82, 0x2, 0x3, 0x1, 0x2, 0x3}),
 NON_PACKED(new byte[] {(byte) 0x80, 0x2, 0x1, (byte) 0x80, 0x2, 0x2, (byte) 0x80, 0x2, 0x3}),
 // 1L is not packed, but 2L and 3L are
 MIXED(new byte[] {(byte) 0x80, 0x2, 0x1, (byte) 0x82, 0x2, 0x2, 0x2, 0x3});

 private final byte[] bytes;

 RepeatedFieldBytesTestCase(byte[] bytes) {
 this.bytes = bytes;
 }
 }

 @Test
 public void readAllFields_repeatedFields_packedBytesCombinations(
 @TestParameter RepeatedFieldBytesTestCase testCase) throws Exception {
 MessageFields fields =
 PROTO_LITE_CEL_VALUE_CONVERTER.readAllFields(
 testCase.bytes, "cel.expr.conformance.proto3.TestAllTypes");

 assertThat(fields.values()).containsExactly("repeated_int64", ImmutableList.of(1L, 2L, 3L));
 }

 /**
 * Unknown test with the following hypothetical fields:
 *
 * <pre>{@code
 * message TestAllTypes {
 * int64 single_int64_unknown = 2500;
 * fixed32 single_fixed32_unknown = 2501;
 * fixed64 single_fixed64_unknown = 2502;
 * string single_string_unknown = 2503;
 * repeated int64 repeated_int64_unknown = 2504;
 * map<string, int64> map_string_int64_unknown = 2505;
 * }
 * }</pre>
 */
 @SuppressWarnings("ImmutableEnumChecker") // Test only
 private enum UnknownFieldsTestCase {
 INT64(new byte[] {-96, -100, 1, 1}, "2500: 1", ImmutableListMultimap.of(2500, 1L)),
 FIXED32(
 new byte[] {-83, -100, 1, 2, 0, 0, 0},
 "2501: 0x00000002",
 ImmutableListMultimap.of(2501, 2)),
 FIXED64(
 new byte[] {-79, -100, 1, 3, 0, 0, 0, 0, 0, 0, 0},
 "2502: 0x0000000000000003",
 ImmutableListMultimap.of(2502, 3L)),
 STRING(
 new byte[] {-70, -100, 1, 11, 72, 101, 108, 108, 111, 32, 119, 111, 114, 108, 100},
 "2503: \"Hello world\"",
 ImmutableListMultimap.of(2503, ByteString.copyFromUtf8("Hello world"))),
 REPEATED_INT64(
 new byte[] {-62, -100, 1, 2, 4, 5},
 "2504: \"\\004\\005\"",
 ImmutableListMultimap.of(2504, ByteString.copyFrom(new byte[] {4, 5}))),
 MAP_STRING_INT64(
 new byte[] {
 -54, -100, 1, 7, 10, 3, 102, 111, 111, 16, 4, -54, -100, 1, 7, 10, 3, 98, 97, 114, 16, 5
 },
 "2505: {\n"
 + " 1: \"foo\"\n"
 + " 2: 4\n"
 + "}\n"
 + "2505: {\n"
 + " 1: \"bar\"\n"
 + " 2: 5\n"
 + "}",
 ImmutableListMultimap.of(
 2505,
 ByteString.copyFromUtf8("\n\003foo\020\004"),
 2505,
 ByteString.copyFromUtf8("\n\003bar\020\005")));

 private final byte[] bytes;
 private final String formattedOutput;
 private final Multimap<Integer, Object> unknownMap;

 UnknownFieldsTestCase(
 byte[] bytes, String formattedOutput, Multimap<Integer, Object> unknownMap) {
 this.bytes = bytes;
 this.formattedOutput = formattedOutput;
 this.unknownMap = unknownMap;
 }
 }

 @Test
 public void unknowns_repeatedEncodedBytes_allRecordsKeptWithKeysSorted() throws Exception {
 // 2500: 2
 // 2504: \"\\004\\005\""
 // 2501: 0x00000002
 // 2500: 1
 byte[] bytes =
 new byte[] {
 -96, -100, 1, 2, // keep
 -62, -100, 1, 2, 4, 5, // keep
 -83, -100, 1, 2, 0, 0, 0, // keep
 -96, -100, 1, 1 // keep
 };

 MessageFields messageFields =
 PROTO_LITE_CEL_VALUE_CONVERTER.readAllFields(
 bytes, "cel.expr.conformance.proto3.TestAllTypes");

 assertThat(messageFields.values()).isEmpty();
 assertThat(messageFields.unknowns())
 .containsExactly(
 2500, 2L, 2500, 1L, 2501, 2, 2504, ByteString.copyFrom(new byte[] {0x04, 0x05}))
 .inOrder();
 }

 @Test
 public void readAllFields_unknownFields(@TestParameter UnknownFieldsTestCase testCase)
 throws Exception {
 TestAllTypes parsedMsg =
 TestAllTypes.parseFrom(testCase.bytes, ExtensionRegistryLite.getEmptyRegistry());

 MessageFields messageFields =
 PROTO_LITE_CEL_VALUE_CONVERTER.readAllFields(
 testCase.bytes, "cel.expr.conformance.proto3.TestAllTypes");

 assertThat(messageFields.values()).isEmpty();
 assertThat(messageFields.unknowns()).containsExactlyEntriesIn(testCase.unknownMap).inOrder();
 assertThat(parsedMsg.toString().trim()).isEqualTo(testCase.formattedOutput);
 }

 /**
 * Tests the following message:
 *
 * <pre>{@code
 * TestAllTypes.newBuilder()
 * // Unknowns
 * .setSingleInt64Unknown(1L)
 * .setSingleFixed32Unknown(2)
 * .setSingleFixed64Unknown(3L)
 * .setSingleStringUnknown("Hello world")
 * .addAllRepeatedInt64Unknown(ImmutableList.of(4L, 5L))
 * .putMapStringInt64Unknown("foo", 4L)
 * .putMapStringInt64Unknown("bar", 5L)
 * // Known values
 * .putMapBoolDouble(true, 1.5d)
 * .putMapBoolDouble(false, 2.5d)
 * .build();
 * }</pre>
 */
 @Test
 @SuppressWarnings("unchecked")
 public void readAllFields_unknownFieldsWithValues() throws Exception {
 byte[] unknownMessageBytes = {
 -70, 4, 11, 8, 1, 17, 0, 0, 0, 0, 0, 0, -8, 63, -70, 4, 11, 8, 0, 17, 0, 0, 0, 0, 0, 0, 4, 64,
 -96, -100, 1, 1, -83, -100, 1, 2, 0, 0, 0, -79, -100, 1, 3, 0, 0, 0, 0, 0, 0, 0, -70, -100, 1,
 11, 72, 101, 108, 108, 111, 32, 119, 111, 114, 108, 100, -62, -100, 1, 2, 4, 5, -54, -100, 1,
 7, 10, 3, 102, 111, 111, 16, 4, -54, -100, 1, 7, 10, 3, 98, 97, 114, 16, 5
 };
 TestAllTypes parsedMsg =
 TestAllTypes.parseFrom(unknownMessageBytes, ExtensionRegistryLite.getEmptyRegistry());

 MessageFields fields =
 PROTO_LITE_CEL_VALUE_CONVERTER.readAllFields(
 unknownMessageBytes, "cel.expr.conformance.proto3.TestAllTypes");

 assertThat(parsedMsg.toString())
 .isEqualTo(
 "map_bool_double {\n"
 + " key: false\n"
 + " value: 2.5\n"
 + "}\n"
 + "map_bool_double {\n"
 + " key: true\n"
 + " value: 1.5\n"
 + "}\n"
 + "2500: 1\n"
 + "2501: 0x00000002\n"
 + "2502: 0x0000000000000003\n"
 + "2503: \"Hello world\"\n"
 + "2504: \"\\004\\005\"\n"
 + "2505: {\n"
 + " 1: \"foo\"\n"
 + " 2: 4\n"
 + "}\n"
 + "2505: {\n"
 + " 1: \"bar\"\n"
 + " 2: 5\n"
 + "}\n");
 assertThat(fields.values()).containsKey("map_bool_double");
 LinkedHashMap<Boolean, Double> mapBoolDoubleValues =
 (LinkedHashMap<Boolean, Double>) fields.values().get("map_bool_double");
 assertThat(mapBoolDoubleValues).containsExactly(true, 1.5d, false, 2.5d).inOrder();
 Multimap<Integer, Object> unknownValues = fields.unknowns();
 assertThat(unknownValues)
 .containsExactly(
 2500,
 1L,
 2501,
 2,
 2502,
 3L,
 2503,
 ByteString.copyFromUtf8("Hello world"),
 2504,
 ByteString.copyFrom(new byte[] {0x04, 0x05}),
 2505,
 ByteString.copyFromUtf8("\n\003foo\020\004"),
 2505,
 ByteString.copyFromUtf8("\n\003bar\020\005"))
 .inOrder();
 }
}

25 changes: 0 additions & 25 deletions
common/src/test/java/dev/cel/common/values/ProtoMessageLiteValueTest.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -271,29 +271,4 @@ public void selectField_defaultValue(@TestParameter DefaultValueTestCase testCas
 assertThat(selectedValue).isEqualTo(testCase.celValue);
 assertThat(selectedValue.isZeroValue()).isTrue();
 }

 /** Test cases for repeated_int64: 1L,2L,3L */
 @SuppressWarnings("ImmutableEnumChecker") // Test only
 private enum RepeatedFieldBytesTestCase {
 PACKED(new byte[] {(byte) 0x82, 0x2, 0x3, 0x1, 0x2, 0x3}),
 NON_PACKED(new byte[] {(byte) 0x80, 0x2, 0x1, (byte) 0x80, 0x2, 0x2, (byte) 0x80, 0x2, 0x3}),
 // 1L is not packed, but 2L and 3L are
 MIXED(new byte[] {(byte) 0x80, 0x2, 0x1, (byte) 0x82, 0x2, 0x2, 0x2, 0x3});

 private final byte[] bytes;

 RepeatedFieldBytesTestCase(byte[] bytes) {
 this.bytes = bytes;
 }
 }

 @Test
 public void readAllFields_repeatedFields_packedBytesCombinations(
 @TestParameter RepeatedFieldBytesTestCase testCase) throws Exception {
 ImmutableMap<String, Object> fields =
 PROTO_LITE_CEL_VALUE_CONVERTER.readAllFields(
 testCase.bytes, "cel.expr.conformance.proto3.TestAllTypes");

 assertThat(fields).containsExactly("repeated_int64", ImmutableList.of(1L, 2L, 3L));
 }
}
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Handle unknown fields in messagelite#683

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

copybara-service
merged 1 commit into

from

May 2, 2025
 Merged


Handle unknown fields in messagelite
#683
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


58 changes: 51 additions & 7 deletions
common/src/main/java/dev/cel/common/values/ProtoLiteCelValueConverter.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -16,10 +16,13 @@

import static com.google.common.base.Preconditions.checkNotNull;

import com.google.auto.value.AutoValue;
import com.google.common.annotations.VisibleForTesting;
import com.google.common.base.Defaults;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableMap;
import com.google.common.collect.Multimap;
import com.google.common.collect.Multimaps;
import com.google.common.primitives.UnsignedLong;
import com.google.errorprone.annotations.Immutable;
import com.google.protobuf.ByteString;
Expand All@@ -41,6 +44,7 @@
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import java.util.TreeMap;

/**
 * {@code ProtoLiteCelValueConverter} handles bidirectional conversion between native Java and
Expand DownExpand Up@@ -221,27 +225,33 @@ private ImmutableList<Object> readPackedRepeatedFields(
 private Map.Entry<Object, Object> readSingleMapEntry(
 CodedInputStream inputStream, FieldLiteDescriptor fieldDescriptor) throws IOException {
 ImmutableMap<String, Object> singleMapEntry =
 readAllFields(inputStream.readByteArray(), fieldDescriptor.getFieldProtoTypeName());
 readAllFields(inputStream.readByteArray(), fieldDescriptor.getFieldProtoTypeName())
 .values();
 Object key = checkNotNull(singleMapEntry.get("key"));
 Object value = checkNotNull(singleMapEntry.get("value"));

 return new AbstractMap.SimpleEntry<>(key, value);
 }

 @VisibleForTesting
 ImmutableMap<String, Object> readAllFields(byte[] bytes, String protoTypeName)
 throws IOException {
 // TODO: Handle unknown fields by collecting them into a separate map.
 MessageFields readAllFields(byte[] bytes, String protoTypeName) throws IOException {
 MessageLiteDescriptor messageDescriptor = descriptorPool.getDescriptorOrThrow(protoTypeName);
 CodedInputStream inputStream = CodedInputStream.newInstance(bytes);

 Multimap<Integer, Object> unknownFields =
 Multimaps.newMultimap(new TreeMap<>(), ArrayList::new);
 ImmutableMap.Builder<String, Object> fieldValues = ImmutableMap.builder();
 Map<Integer, List<Object>> repeatedFieldValues = new LinkedHashMap<>();
 Map<Integer, Map<Object, Object>> mapFieldValues = new LinkedHashMap<>();
 for (int tag = inputStream.readTag(); tag != 0; tag = inputStream.readTag()) {
 int tagWireType = WireFormat.getTagWireType(tag);
 int fieldNumber = WireFormat.getTagFieldNumber(tag);
 FieldLiteDescriptor fieldDescriptor = messageDescriptor.getByFieldNumberOrThrow(fieldNumber);
 FieldLiteDescriptor fieldDescriptor =
 messageDescriptor.findByFieldNumber(fieldNumber).orElse(null);
 if (fieldDescriptor == null) {
 unknownFields.put(fieldNumber, readUnknownField(tagWireType, inputStream));
 continue;
 }

 Object payload;
 switch (tagWireType) {
Expand DownExpand Up@@ -318,12 +328,32 @@ ImmutableMap<String, Object> readAllFields(byte[] bytes, String protoTypeName)

 // Protobuf encoding follows a "last one wins" semantics. This means for duplicated fields,
 // we accept the last value encountered.
 return fieldValues.buildKeepingLast();
 return MessageFields.create(fieldValues.buildKeepingLast(), unknownFields);
 }

 ImmutableMap<String, Object> readAllFields(MessageLite msg, String protoTypeName)
 throws IOException {
 return readAllFields(msg.toByteArray(), protoTypeName);
 return readAllFields(msg.toByteArray(), protoTypeName).values();
 }

 private static Object readUnknownField(int tagWireType, CodedInputStream inputStream)
 throws IOException {
 switch (tagWireType) {
 case WireFormat.WIRETYPE_VARINT:
 return inputStream.readInt64();
 case WireFormat.WIRETYPE_FIXED64:
 return inputStream.readFixed64();
 case WireFormat.WIRETYPE_LENGTH_DELIMITED:
 return inputStream.readBytes();
 case WireFormat.WIRETYPE_FIXED32:
 return inputStream.readFixed32();
 case WireFormat.WIRETYPE_START_GROUP:
 case WireFormat.WIRETYPE_END_GROUP:
 // TODO: Support groups
 throw new UnsupportedOperationException("Groups are not supported");
 default:
 throw new IllegalArgumentException("Unknown wire type: " + tagWireType);
 }
 }

 @Override
Expand All@@ -342,6 +372,20 @@ public CelValue fromProtoMessageToCelValue(String protoTypeName, MessageLite msg
 return super.fromWellKnownProtoToCelValue(msg, wellKnownProto);
 }

 @AutoValue
 @SuppressWarnings("AutoValueImmutableFields") // Unknowns are inaccessible to users.
 abstract static class MessageFields {

 abstract ImmutableMap<String, Object> values();

 abstract Multimap<Integer, Object> unknowns();

 static MessageFields create(
 ImmutableMap<String, Object> fieldValues, Multimap<Integer, Object> unknownFields) {
 return new AutoValue_ProtoLiteCelValueConverter_MessageFields(fieldValues, unknownFields);
 }
 }

 private ProtoLiteCelValueConverter(CelLiteDescriptorPool celLiteDescriptorPool) {
 this.descriptorPool = celLiteDescriptorPool;
 }
Expand Down

216 changes: 216 additions & 0 deletions
common/src/test/java/dev/cel/common/values/ProtoLiteCelValueConverterTest.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,9 +17,13 @@
import static com.google.common.truth.Truth.assertThat;
import static java.nio.charset.StandardCharsets.UTF_8;

import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableListMultimap;
import com.google.common.collect.ImmutableSet;
import com.google.common.collect.Multimap;
import com.google.protobuf.ByteString;
import com.google.protobuf.Duration;
import com.google.protobuf.ExtensionRegistryLite;
import com.google.protobuf.FloatValue;
import com.google.protobuf.Int32Value;
import com.google.protobuf.Int64Value;
Expand All@@ -32,9 +36,11 @@
import dev.cel.common.internal.CelLiteDescriptorPool;
import dev.cel.common.internal.DefaultLiteDescriptorPool;
import dev.cel.common.internal.WellKnownProto;
import dev.cel.common.values.ProtoLiteCelValueConverter.MessageFields;
import dev.cel.expr.conformance.proto3.TestAllTypes;
import dev.cel.expr.conformance.proto3.TestAllTypesProto3CelDescriptor;
import java.time.Instant;
import java.util.LinkedHashMap;
import org.junit.Test;
import org.junit.runner.RunWith;

Expand DownExpand Up@@ -107,4 +113,214 @@ public void fromProtoMessageToCelValue_withWellKnownProto_convertsToEquivalentCe

 assertThat(convertedCelValue).isEqualTo(testCase.celValue);
 }

 /** Test cases for repeated_int64: 1L,2L,3L */
 @SuppressWarnings("ImmutableEnumChecker") // Test only
 private enum RepeatedFieldBytesTestCase {
 PACKED(new byte[] {(byte) 0x82, 0x2, 0x3, 0x1, 0x2, 0x3}),
 NON_PACKED(new byte[] {(byte) 0x80, 0x2, 0x1, (byte) 0x80, 0x2, 0x2, (byte) 0x80, 0x2, 0x3}),
 // 1L is not packed, but 2L and 3L are
 MIXED(new byte[] {(byte) 0x80, 0x2, 0x1, (byte) 0x82, 0x2, 0x2, 0x2, 0x3});

 private final byte[] bytes;

 RepeatedFieldBytesTestCase(byte[] bytes) {
 this.bytes = bytes;
 }
 }

 @Test
 public void readAllFields_repeatedFields_packedBytesCombinations(
 @TestParameter RepeatedFieldBytesTestCase testCase) throws Exception {
 MessageFields fields =
 PROTO_LITE_CEL_VALUE_CONVERTER.readAllFields(
 testCase.bytes, "cel.expr.conformance.proto3.TestAllTypes");

 assertThat(fields.values()).containsExactly("repeated_int64", ImmutableList.of(1L, 2L, 3L));
 }

 /**
 * Unknown test with the following hypothetical fields:
 *
 * <pre>{@code
 * message TestAllTypes {
 * int64 single_int64_unknown = 2500;
 * fixed32 single_fixed32_unknown = 2501;
 * fixed64 single_fixed64_unknown = 2502;
 * string single_string_unknown = 2503;
 * repeated int64 repeated_int64_unknown = 2504;
 * map<string, int64> map_string_int64_unknown = 2505;
 * }
 * }</pre>
 */
 @SuppressWarnings("ImmutableEnumChecker") // Test only
 private enum UnknownFieldsTestCase {
 INT64(new byte[] {-96, -100, 1, 1}, "2500: 1", ImmutableListMultimap.of(2500, 1L)),
 FIXED32(
 new byte[] {-83, -100, 1, 2, 0, 0, 0},
 "2501: 0x00000002",
 ImmutableListMultimap.of(2501, 2)),
 FIXED64(
 new byte[] {-79, -100, 1, 3, 0, 0, 0, 0, 0, 0, 0},
 "2502: 0x0000000000000003",
 ImmutableListMultimap.of(2502, 3L)),
 STRING(
 new byte[] {-70, -100, 1, 11, 72, 101, 108, 108, 111, 32, 119, 111, 114, 108, 100},
 "2503: \"Hello world\"",
 ImmutableListMultimap.of(2503, ByteString.copyFromUtf8("Hello world"))),
 REPEATED_INT64(
 new byte[] {-62, -100, 1, 2, 4, 5},
 "2504: \"\\004\\005\"",
 ImmutableListMultimap.of(2504, ByteString.copyFrom(new byte[] {4, 5}))),
 MAP_STRING_INT64(
 new byte[] {
 -54, -100, 1, 7, 10, 3, 102, 111, 111, 16, 4, -54, -100, 1, 7, 10, 3, 98, 97, 114, 16, 5
 },
 "2505: {\n"
 + " 1: \"foo\"\n"
 + " 2: 4\n"
 + "}\n"
 + "2505: {\n"
 + " 1: \"bar\"\n"
 + " 2: 5\n"
 + "}",
 ImmutableListMultimap.of(
 2505,
 ByteString.copyFromUtf8("\n\003foo\020\004"),
 2505,
 ByteString.copyFromUtf8("\n\003bar\020\005")));

 private final byte[] bytes;
 private final String formattedOutput;
 private final Multimap<Integer, Object> unknownMap;

 UnknownFieldsTestCase(
 byte[] bytes, String formattedOutput, Multimap<Integer, Object> unknownMap) {
 this.bytes = bytes;
 this.formattedOutput = formattedOutput;
 this.unknownMap = unknownMap;
 }
 }

 @Test
 public void unknowns_repeatedEncodedBytes_allRecordsKeptWithKeysSorted() throws Exception {
 // 2500: 2
 // 2504: \"\\004\\005\""
 // 2501: 0x00000002
 // 2500: 1
 byte[] bytes =
 new byte[] {
 -96, -100, 1, 2, // keep
 -62, -100, 1, 2, 4, 5, // keep
 -83, -100, 1, 2, 0, 0, 0, // keep
 -96, -100, 1, 1 // keep
 };

 MessageFields messageFields =
 PROTO_LITE_CEL_VALUE_CONVERTER.readAllFields(
 bytes, "cel.expr.conformance.proto3.TestAllTypes");

 assertThat(messageFields.values()).isEmpty();
 assertThat(messageFields.unknowns())
 .containsExactly(
 2500, 2L, 2500, 1L, 2501, 2, 2504, ByteString.copyFrom(new byte[] {0x04, 0x05}))
 .inOrder();
 }

 @Test
 public void readAllFields_unknownFields(@TestParameter UnknownFieldsTestCase testCase)
 throws Exception {
 TestAllTypes parsedMsg =
 TestAllTypes.parseFrom(testCase.bytes, ExtensionRegistryLite.getEmptyRegistry());

 MessageFields messageFields =
 PROTO_LITE_CEL_VALUE_CONVERTER.readAllFields(
 testCase.bytes, "cel.expr.conformance.proto3.TestAllTypes");

 assertThat(messageFields.values()).isEmpty();
 assertThat(messageFields.unknowns()).containsExactlyEntriesIn(testCase.unknownMap).inOrder();
 assertThat(parsedMsg.toString().trim()).isEqualTo(testCase.formattedOutput);
 }

 /**
 * Tests the following message:
 *
 * <pre>{@code
 * TestAllTypes.newBuilder()
 * // Unknowns
 * .setSingleInt64Unknown(1L)
 * .setSingleFixed32Unknown(2)
 * .setSingleFixed64Unknown(3L)
 * .setSingleStringUnknown("Hello world")
 * .addAllRepeatedInt64Unknown(ImmutableList.of(4L, 5L))
 * .putMapStringInt64Unknown("foo", 4L)
 * .putMapStringInt64Unknown("bar", 5L)
 * // Known values
 * .putMapBoolDouble(true, 1.5d)
 * .putMapBoolDouble(false, 2.5d)
 * .build();
 * }</pre>
 */
 @Test
 @SuppressWarnings("unchecked")
 public void readAllFields_unknownFieldsWithValues() throws Exception {
 byte[] unknownMessageBytes = {
 -70, 4, 11, 8, 1, 17, 0, 0, 0, 0, 0, 0, -8, 63, -70, 4, 11, 8, 0, 17, 0, 0, 0, 0, 0, 0, 4, 64,
 -96, -100, 1, 1, -83, -100, 1, 2, 0, 0, 0, -79, -100, 1, 3, 0, 0, 0, 0, 0, 0, 0, -70, -100, 1,
 11, 72, 101, 108, 108, 111, 32, 119, 111, 114, 108, 100, -62, -100, 1, 2, 4, 5, -54, -100, 1,
 7, 10, 3, 102, 111, 111, 16, 4, -54, -100, 1, 7, 10, 3, 98, 97, 114, 16, 5
 };
 TestAllTypes parsedMsg =
 TestAllTypes.parseFrom(unknownMessageBytes, ExtensionRegistryLite.getEmptyRegistry());

 MessageFields fields =
 PROTO_LITE_CEL_VALUE_CONVERTER.readAllFields(
 unknownMessageBytes, "cel.expr.conformance.proto3.TestAllTypes");

 assertThat(parsedMsg.toString())
 .isEqualTo(
 "map_bool_double {\n"
 + " key: false\n"
 + " value: 2.5\n"
 + "}\n"
 + "map_bool_double {\n"
 + " key: true\n"
 + " value: 1.5\n"
 + "}\n"
 + "2500: 1\n"
 + "2501: 0x00000002\n"
 + "2502: 0x0000000000000003\n"
 + "2503: \"Hello world\"\n"
 + "2504: \"\\004\\005\"\n"
 + "2505: {\n"
 + " 1: \"foo\"\n"
 + " 2: 4\n"
 + "}\n"
 + "2505: {\n"
 + " 1: \"bar\"\n"
 + " 2: 5\n"
 + "}\n");
 assertThat(fields.values()).containsKey("map_bool_double");
 LinkedHashMap<Boolean, Double> mapBoolDoubleValues =
 (LinkedHashMap<Boolean, Double>) fields.values().get("map_bool_double");
 assertThat(mapBoolDoubleValues).containsExactly(true, 1.5d, false, 2.5d).inOrder();
 Multimap<Integer, Object> unknownValues = fields.unknowns();
 assertThat(unknownValues)
 .containsExactly(
 2500,
 1L,
 2501,
 2,
 2502,
 3L,
 2503,
 ByteString.copyFromUtf8("Hello world"),
 2504,
 ByteString.copyFrom(new byte[] {0x04, 0x05}),
 2505,
 ByteString.copyFromUtf8("\n\003foo\020\004"),
 2505,
 ByteString.copyFromUtf8("\n\003bar\020\005"))
 .inOrder();
 }
}

25 changes: 0 additions & 25 deletions
common/src/test/java/dev/cel/common/values/ProtoMessageLiteValueTest.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -271,29 +271,4 @@ public void selectField_defaultValue(@TestParameter DefaultValueTestCase testCas
 assertThat(selectedValue).isEqualTo(testCase.celValue);
 assertThat(selectedValue.isZeroValue()).isTrue();
 }

 /** Test cases for repeated_int64: 1L,2L,3L */
 @SuppressWarnings("ImmutableEnumChecker") // Test only
 private enum RepeatedFieldBytesTestCase {
 PACKED(new byte[] {(byte) 0x82, 0x2, 0x3, 0x1, 0x2, 0x3}),
 NON_PACKED(new byte[] {(byte) 0x80, 0x2, 0x1, (byte) 0x80, 0x2, 0x2, (byte) 0x80, 0x2, 0x3}),
 // 1L is not packed, but 2L and 3L are
 MIXED(new byte[] {(byte) 0x80, 0x2, 0x1, (byte) 0x82, 0x2, 0x2, 0x2, 0x3});

 private final byte[] bytes;

 RepeatedFieldBytesTestCase(byte[] bytes) {
 this.bytes = bytes;
 }
 }

 @Test
 public void readAllFields_repeatedFields_packedBytesCombinations(
 @TestParameter RepeatedFieldBytesTestCase testCase) throws Exception {
 ImmutableMap<String, Object> fields =
 PROTO_LITE_CEL_VALUE_CONVERTER.readAllFields(
 testCase.bytes, "cel.expr.conformance.proto3.TestAllTypes");

 assertThat(fields).containsExactly("repeated_int64", ImmutableList.of(1L, 2L, 3L));
 }
}
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Handle unknown fields in messagelite#683

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

copybara-service
merged 1 commit into

from

May 2, 2025
 Merged


Handle unknown fields in messagelite
#683
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


58 changes: 51 additions & 7 deletions
common/src/main/java/dev/cel/common/values/ProtoLiteCelValueConverter.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -16,10 +16,13 @@

import static com.google.common.base.Preconditions.checkNotNull;

import com.google.auto.value.AutoValue;
import com.google.common.annotations.VisibleForTesting;
import com.google.common.base.Defaults;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableMap;
import com.google.common.collect.Multimap;
import com.google.common.collect.Multimaps;
import com.google.common.primitives.UnsignedLong;
import com.google.errorprone.annotations.Immutable;
import com.google.protobuf.ByteString;
Expand All@@ -41,6 +44,7 @@
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import java.util.TreeMap;

/**
 * {@code ProtoLiteCelValueConverter} handles bidirectional conversion between native Java and
Expand DownExpand Up@@ -221,27 +225,33 @@ private ImmutableList<Object> readPackedRepeatedFields(
 private Map.Entry<Object, Object> readSingleMapEntry(
 CodedInputStream inputStream, FieldLiteDescriptor fieldDescriptor) throws IOException {
 ImmutableMap<String, Object> singleMapEntry =
 readAllFields(inputStream.readByteArray(), fieldDescriptor.getFieldProtoTypeName());
 readAllFields(inputStream.readByteArray(), fieldDescriptor.getFieldProtoTypeName())
 .values();
 Object key = checkNotNull(singleMapEntry.get("key"));
 Object value = checkNotNull(singleMapEntry.get("value"));

 return new AbstractMap.SimpleEntry<>(key, value);
 }

 @VisibleForTesting
 ImmutableMap<String, Object> readAllFields(byte[] bytes, String protoTypeName)
 throws IOException {
 // TODO: Handle unknown fields by collecting them into a separate map.
 MessageFields readAllFields(byte[] bytes, String protoTypeName) throws IOException {
 MessageLiteDescriptor messageDescriptor = descriptorPool.getDescriptorOrThrow(protoTypeName);
 CodedInputStream inputStream = CodedInputStream.newInstance(bytes);

 Multimap<Integer, Object> unknownFields =
 Multimaps.newMultimap(new TreeMap<>(), ArrayList::new);
 ImmutableMap.Builder<String, Object> fieldValues = ImmutableMap.builder();
 Map<Integer, List<Object>> repeatedFieldValues = new LinkedHashMap<>();
 Map<Integer, Map<Object, Object>> mapFieldValues = new LinkedHashMap<>();
 for (int tag = inputStream.readTag(); tag != 0; tag = inputStream.readTag()) {
 int tagWireType = WireFormat.getTagWireType(tag);
 int fieldNumber = WireFormat.getTagFieldNumber(tag);
 FieldLiteDescriptor fieldDescriptor = messageDescriptor.getByFieldNumberOrThrow(fieldNumber);
 FieldLiteDescriptor fieldDescriptor =
 messageDescriptor.findByFieldNumber(fieldNumber).orElse(null);
 if (fieldDescriptor == null) {
 unknownFields.put(fieldNumber, readUnknownField(tagWireType, inputStream));
 continue;
 }

 Object payload;
 switch (tagWireType) {
Expand DownExpand Up@@ -318,12 +328,32 @@ ImmutableMap<String, Object> readAllFields(byte[] bytes, String protoTypeName)

 // Protobuf encoding follows a "last one wins" semantics. This means for duplicated fields,
 // we accept the last value encountered.
 return fieldValues.buildKeepingLast();
 return MessageFields.create(fieldValues.buildKeepingLast(), unknownFields);
 }

 ImmutableMap<String, Object> readAllFields(MessageLite msg, String protoTypeName)
 throws IOException {
 return readAllFields(msg.toByteArray(), protoTypeName);
 return readAllFields(msg.toByteArray(), protoTypeName).values();
 }

 private static Object readUnknownField(int tagWireType, CodedInputStream inputStream)
 throws IOException {
 switch (tagWireType) {
 case WireFormat.WIRETYPE_VARINT:
 return inputStream.readInt64();
 case WireFormat.WIRETYPE_FIXED64:
 return inputStream.readFixed64();
 case WireFormat.WIRETYPE_LENGTH_DELIMITED:
 return inputStream.readBytes();
 case WireFormat.WIRETYPE_FIXED32:
 return inputStream.readFixed32();
 case WireFormat.WIRETYPE_START_GROUP:
 case WireFormat.WIRETYPE_END_GROUP:
 // TODO: Support groups
 throw new UnsupportedOperationException("Groups are not supported");
 default:
 throw new IllegalArgumentException("Unknown wire type: " + tagWireType);
 }
 }

 @Override
Expand All@@ -342,6 +372,20 @@ public CelValue fromProtoMessageToCelValue(String protoTypeName, MessageLite msg
 return super.fromWellKnownProtoToCelValue(msg, wellKnownProto);
 }

 @AutoValue
 @SuppressWarnings("AutoValueImmutableFields") // Unknowns are inaccessible to users.
 abstract static class MessageFields {

 abstract ImmutableMap<String, Object> values();

 abstract Multimap<Integer, Object> unknowns();

 static MessageFields create(
 ImmutableMap<String, Object> fieldValues, Multimap<Integer, Object> unknownFields) {
 return new AutoValue_ProtoLiteCelValueConverter_MessageFields(fieldValues, unknownFields);
 }
 }

 private ProtoLiteCelValueConverter(CelLiteDescriptorPool celLiteDescriptorPool) {
 this.descriptorPool = celLiteDescriptorPool;
 }
Expand Down

216 changes: 216 additions & 0 deletions
common/src/test/java/dev/cel/common/values/ProtoLiteCelValueConverterTest.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,9 +17,13 @@
import static com.google.common.truth.Truth.assertThat;
import static java.nio.charset.StandardCharsets.UTF_8;

import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableListMultimap;
import com.google.common.collect.ImmutableSet;
import com.google.common.collect.Multimap;
import com.google.protobuf.ByteString;
import com.google.protobuf.Duration;
import com.google.protobuf.ExtensionRegistryLite;
import com.google.protobuf.FloatValue;
import com.google.protobuf.Int32Value;
import com.google.protobuf.Int64Value;
Expand All@@ -32,9 +36,11 @@
import dev.cel.common.internal.CelLiteDescriptorPool;
import dev.cel.common.internal.DefaultLiteDescriptorPool;
import dev.cel.common.internal.WellKnownProto;
import dev.cel.common.values.ProtoLiteCelValueConverter.MessageFields;
import dev.cel.expr.conformance.proto3.TestAllTypes;
import dev.cel.expr.conformance.proto3.TestAllTypesProto3CelDescriptor;
import java.time.Instant;
import java.util.LinkedHashMap;
import org.junit.Test;
import org.junit.runner.RunWith;

Expand DownExpand Up@@ -107,4 +113,214 @@ public void fromProtoMessageToCelValue_withWellKnownProto_convertsToEquivalentCe

 assertThat(convertedCelValue).isEqualTo(testCase.celValue);
 }

 /** Test cases for repeated_int64: 1L,2L,3L */
 @SuppressWarnings("ImmutableEnumChecker") // Test only
 private enum RepeatedFieldBytesTestCase {
 PACKED(new byte[] {(byte) 0x82, 0x2, 0x3, 0x1, 0x2, 0x3}),
 NON_PACKED(new byte[] {(byte) 0x80, 0x2, 0x1, (byte) 0x80, 0x2, 0x2, (byte) 0x80, 0x2, 0x3}),
 // 1L is not packed, but 2L and 3L are
 MIXED(new byte[] {(byte) 0x80, 0x2, 0x1, (byte) 0x82, 0x2, 0x2, 0x2, 0x3});

 private final byte[] bytes;

 RepeatedFieldBytesTestCase(byte[] bytes) {
 this.bytes = bytes;
 }
 }

 @Test
 public void readAllFields_repeatedFields_packedBytesCombinations(
 @TestParameter RepeatedFieldBytesTestCase testCase) throws Exception {
 MessageFields fields =
 PROTO_LITE_CEL_VALUE_CONVERTER.readAllFields(
 testCase.bytes, "cel.expr.conformance.proto3.TestAllTypes");

 assertThat(fields.values()).containsExactly("repeated_int64", ImmutableList.of(1L, 2L, 3L));
 }

 /**
 * Unknown test with the following hypothetical fields:
 *
 * <pre>{@code
 * message TestAllTypes {
 * int64 single_int64_unknown = 2500;
 * fixed32 single_fixed32_unknown = 2501;
 * fixed64 single_fixed64_unknown = 2502;
 * string single_string_unknown = 2503;
 * repeated int64 repeated_int64_unknown = 2504;
 * map<string, int64> map_string_int64_unknown = 2505;
 * }
 * }</pre>
 */
 @SuppressWarnings("ImmutableEnumChecker") // Test only
 private enum UnknownFieldsTestCase {
 INT64(new byte[] {-96, -100, 1, 1}, "2500: 1", ImmutableListMultimap.of(2500, 1L)),
 FIXED32(
 new byte[] {-83, -100, 1, 2, 0, 0, 0},
 "2501: 0x00000002",
 ImmutableListMultimap.of(2501, 2)),
 FIXED64(
 new byte[] {-79, -100, 1, 3, 0, 0, 0, 0, 0, 0, 0},
 "2502: 0x0000000000000003",
 ImmutableListMultimap.of(2502, 3L)),
 STRING(
 new byte[] {-70, -100, 1, 11, 72, 101, 108, 108, 111, 32, 119, 111, 114, 108, 100},
 "2503: \"Hello world\"",
 ImmutableListMultimap.of(2503, ByteString.copyFromUtf8("Hello world"))),
 REPEATED_INT64(
 new byte[] {-62, -100, 1, 2, 4, 5},
 "2504: \"\\004\\005\"",
 ImmutableListMultimap.of(2504, ByteString.copyFrom(new byte[] {4, 5}))),
 MAP_STRING_INT64(
 new byte[] {
 -54, -100, 1, 7, 10, 3, 102, 111, 111, 16, 4, -54, -100, 1, 7, 10, 3, 98, 97, 114, 16, 5
 },
 "2505: {\n"
 + " 1: \"foo\"\n"
 + " 2: 4\n"
 + "}\n"
 + "2505: {\n"
 + " 1: \"bar\"\n"
 + " 2: 5\n"
 + "}",
 ImmutableListMultimap.of(
 2505,
 ByteString.copyFromUtf8("\n\003foo\020\004"),
 2505,
 ByteString.copyFromUtf8("\n\003bar\020\005")));

 private final byte[] bytes;
 private final String formattedOutput;
 private final Multimap<Integer, Object> unknownMap;

 UnknownFieldsTestCase(
 byte[] bytes, String formattedOutput, Multimap<Integer, Object> unknownMap) {
 this.bytes = bytes;
 this.formattedOutput = formattedOutput;
 this.unknownMap = unknownMap;
 }
 }

 @Test
 public void unknowns_repeatedEncodedBytes_allRecordsKeptWithKeysSorted() throws Exception {
 // 2500: 2
 // 2504: \"\\004\\005\""
 // 2501: 0x00000002
 // 2500: 1
 byte[] bytes =
 new byte[] {
 -96, -100, 1, 2, // keep
 -62, -100, 1, 2, 4, 5, // keep
 -83, -100, 1, 2, 0, 0, 0, // keep
 -96, -100, 1, 1 // keep
 };

 MessageFields messageFields =
 PROTO_LITE_CEL_VALUE_CONVERTER.readAllFields(
 bytes, "cel.expr.conformance.proto3.TestAllTypes");

 assertThat(messageFields.values()).isEmpty();
 assertThat(messageFields.unknowns())
 .containsExactly(
 2500, 2L, 2500, 1L, 2501, 2, 2504, ByteString.copyFrom(new byte[] {0x04, 0x05}))
 .inOrder();
 }

 @Test
 public void readAllFields_unknownFields(@TestParameter UnknownFieldsTestCase testCase)
 throws Exception {
 TestAllTypes parsedMsg =
 TestAllTypes.parseFrom(testCase.bytes, ExtensionRegistryLite.getEmptyRegistry());

 MessageFields messageFields =
 PROTO_LITE_CEL_VALUE_CONVERTER.readAllFields(
 testCase.bytes, "cel.expr.conformance.proto3.TestAllTypes");

 assertThat(messageFields.values()).isEmpty();
 assertThat(messageFields.unknowns()).containsExactlyEntriesIn(testCase.unknownMap).inOrder();
 assertThat(parsedMsg.toString().trim()).isEqualTo(testCase.formattedOutput);
 }

 /**
 * Tests the following message:
 *
 * <pre>{@code
 * TestAllTypes.newBuilder()
 * // Unknowns
 * .setSingleInt64Unknown(1L)
 * .setSingleFixed32Unknown(2)
 * .setSingleFixed64Unknown(3L)
 * .setSingleStringUnknown("Hello world")
 * .addAllRepeatedInt64Unknown(ImmutableList.of(4L, 5L))
 * .putMapStringInt64Unknown("foo", 4L)
 * .putMapStringInt64Unknown("bar", 5L)
 * // Known values
 * .putMapBoolDouble(true, 1.5d)
 * .putMapBoolDouble(false, 2.5d)
 * .build();
 * }</pre>
 */
 @Test
 @SuppressWarnings("unchecked")
 public void readAllFields_unknownFieldsWithValues() throws Exception {
 byte[] unknownMessageBytes = {
 -70, 4, 11, 8, 1, 17, 0, 0, 0, 0, 0, 0, -8, 63, -70, 4, 11, 8, 0, 17, 0, 0, 0, 0, 0, 0, 4, 64,
 -96, -100, 1, 1, -83, -100, 1, 2, 0, 0, 0, -79, -100, 1, 3, 0, 0, 0, 0, 0, 0, 0, -70, -100, 1,
 11, 72, 101, 108, 108, 111, 32, 119, 111, 114, 108, 100, -62, -100, 1, 2, 4, 5, -54, -100, 1,
 7, 10, 3, 102, 111, 111, 16, 4, -54, -100, 1, 7, 10, 3, 98, 97, 114, 16, 5
 };
 TestAllTypes parsedMsg =
 TestAllTypes.parseFrom(unknownMessageBytes, ExtensionRegistryLite.getEmptyRegistry());

 MessageFields fields =
 PROTO_LITE_CEL_VALUE_CONVERTER.readAllFields(
 unknownMessageBytes, "cel.expr.conformance.proto3.TestAllTypes");

 assertThat(parsedMsg.toString())
 .isEqualTo(
 "map_bool_double {\n"
 + " key: false\n"
 + " value: 2.5\n"
 + "}\n"
 + "map_bool_double {\n"
 + " key: true\n"
 + " value: 1.5\n"
 + "}\n"
 + "2500: 1\n"
 + "2501: 0x00000002\n"
 + "2502: 0x0000000000000003\n"
 + "2503: \"Hello world\"\n"
 + "2504: \"\\004\\005\"\n"
 + "2505: {\n"
 + " 1: \"foo\"\n"
 + " 2: 4\n"
 + "}\n"
 + "2505: {\n"
 + " 1: \"bar\"\n"
 + " 2: 5\n"
 + "}\n");
 assertThat(fields.values()).containsKey("map_bool_double");
 LinkedHashMap<Boolean, Double> mapBoolDoubleValues =
 (LinkedHashMap<Boolean, Double>) fields.values().get("map_bool_double");
 assertThat(mapBoolDoubleValues).containsExactly(true, 1.5d, false, 2.5d).inOrder();
 Multimap<Integer, Object> unknownValues = fields.unknowns();
 assertThat(unknownValues)
 .containsExactly(
 2500,
 1L,
 2501,
 2,
 2502,
 3L,
 2503,
 ByteString.copyFromUtf8("Hello world"),
 2504,
 ByteString.copyFrom(new byte[] {0x04, 0x05}),
 2505,
 ByteString.copyFromUtf8("\n\003foo\020\004"),
 2505,
 ByteString.copyFromUtf8("\n\003bar\020\005"))
 .inOrder();
 }
}

25 changes: 0 additions & 25 deletions
common/src/test/java/dev/cel/common/values/ProtoMessageLiteValueTest.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -271,29 +271,4 @@ public void selectField_defaultValue(@TestParameter DefaultValueTestCase testCas
 assertThat(selectedValue).isEqualTo(testCase.celValue);
 assertThat(selectedValue.isZeroValue()).isTrue();
 }

 /** Test cases for repeated_int64: 1L,2L,3L */
 @SuppressWarnings("ImmutableEnumChecker") // Test only
 private enum RepeatedFieldBytesTestCase {
 PACKED(new byte[] {(byte) 0x82, 0x2, 0x3, 0x1, 0x2, 0x3}),
 NON_PACKED(new byte[] {(byte) 0x80, 0x2, 0x1, (byte) 0x80, 0x2, 0x2, (byte) 0x80, 0x2, 0x3}),
 // 1L is not packed, but 2L and 3L are
 MIXED(new byte[] {(byte) 0x80, 0x2, 0x1, (byte) 0x82, 0x2, 0x2, 0x2, 0x3});

 private final byte[] bytes;

 RepeatedFieldBytesTestCase(byte[] bytes) {
 this.bytes = bytes;
 }
 }

 @Test
 public void readAllFields_repeatedFields_packedBytesCombinations(
 @TestParameter RepeatedFieldBytesTestCase testCase) throws Exception {
 ImmutableMap<String, Object> fields =
 PROTO_LITE_CEL_VALUE_CONVERTER.readAllFields(
 testCase.bytes, "cel.expr.conformance.proto3.TestAllTypes");

 assertThat(fields).containsExactly("repeated_int64", ImmutableList.of(1L, 2L, 3L));
 }
}
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
Handle unknown fields in messagelite#683

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

copybara-service
merged 1 commit into

from

May 2, 2025
 Merged


Handle unknown fields in messagelite
#683
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


58 changes: 51 additions & 7 deletions
common/src/main/java/dev/cel/common/values/ProtoLiteCelValueConverter.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -16,10 +16,13 @@

import static com.google.common.base.Preconditions.checkNotNull;

import com.google.auto.value.AutoValue;
import com.google.common.annotations.VisibleForTesting;
import com.google.common.base.Defaults;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableMap;
import com.google.common.collect.Multimap;
import com.google.common.collect.Multimaps;
import com.google.common.primitives.UnsignedLong;
import com.google.errorprone.annotations.Immutable;
import com.google.protobuf.ByteString;
Expand All@@ -41,6 +44,7 @@
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import java.util.TreeMap;

/**
 * {@code ProtoLiteCelValueConverter} handles bidirectional conversion between native Java and
Expand DownExpand Up@@ -221,27 +225,33 @@ private ImmutableList<Object> readPackedRepeatedFields(
 private Map.Entry<Object, Object> readSingleMapEntry(
 CodedInputStream inputStream, FieldLiteDescriptor fieldDescriptor) throws IOException {
 ImmutableMap<String, Object> singleMapEntry =
 readAllFields(inputStream.readByteArray(), fieldDescriptor.getFieldProtoTypeName());
 readAllFields(inputStream.readByteArray(), fieldDescriptor.getFieldProtoTypeName())
 .values();
 Object key = checkNotNull(singleMapEntry.get("key"));
 Object value = checkNotNull(singleMapEntry.get("value"));

 return new AbstractMap.SimpleEntry<>(key, value);
 }

 @VisibleForTesting
 ImmutableMap<String, Object> readAllFields(byte[] bytes, String protoTypeName)
 throws IOException {
 // TODO: Handle unknown fields by collecting them into a separate map.
 MessageFields readAllFields(byte[] bytes, String protoTypeName) throws IOException {
 MessageLiteDescriptor messageDescriptor = descriptorPool.getDescriptorOrThrow(protoTypeName);
 CodedInputStream inputStream = CodedInputStream.newInstance(bytes);

 Multimap<Integer, Object> unknownFields =
 Multimaps.newMultimap(new TreeMap<>(), ArrayList::new);
 ImmutableMap.Builder<String, Object> fieldValues = ImmutableMap.builder();
 Map<Integer, List<Object>> repeatedFieldValues = new LinkedHashMap<>();
 Map<Integer, Map<Object, Object>> mapFieldValues = new LinkedHashMap<>();
 for (int tag = inputStream.readTag(); tag != 0; tag = inputStream.readTag()) {
 int tagWireType = WireFormat.getTagWireType(tag);
 int fieldNumber = WireFormat.getTagFieldNumber(tag);
 FieldLiteDescriptor fieldDescriptor = messageDescriptor.getByFieldNumberOrThrow(fieldNumber);
 FieldLiteDescriptor fieldDescriptor =
 messageDescriptor.findByFieldNumber(fieldNumber).orElse(null);
 if (fieldDescriptor == null) {
 unknownFields.put(fieldNumber, readUnknownField(tagWireType, inputStream));
 continue;
 }

 Object payload;
 switch (tagWireType) {
Expand DownExpand Up@@ -318,12 +328,32 @@ ImmutableMap<String, Object> readAllFields(byte[] bytes, String protoTypeName)

 // Protobuf encoding follows a "last one wins" semantics. This means for duplicated fields,
 // we accept the last value encountered.
 return fieldValues.buildKeepingLast();
 return MessageFields.create(fieldValues.buildKeepingLast(), unknownFields);
 }

 ImmutableMap<String, Object> readAllFields(MessageLite msg, String protoTypeName)
 throws IOException {
 return readAllFields(msg.toByteArray(), protoTypeName);
 return readAllFields(msg.toByteArray(), protoTypeName).values();
 }

 private static Object readUnknownField(int tagWireType, CodedInputStream inputStream)
 throws IOException {
 switch (tagWireType) {
 case WireFormat.WIRETYPE_VARINT:
 return inputStream.readInt64();
 case WireFormat.WIRETYPE_FIXED64:
 return inputStream.readFixed64();
 case WireFormat.WIRETYPE_LENGTH_DELIMITED:
 return inputStream.readBytes();
 case WireFormat.WIRETYPE_FIXED32:
 return inputStream.readFixed32();
 case WireFormat.WIRETYPE_START_GROUP:
 case WireFormat.WIRETYPE_END_GROUP:
 // TODO: Support groups
 throw new UnsupportedOperationException("Groups are not supported");
 default:
 throw new IllegalArgumentException("Unknown wire type: " + tagWireType);
 }
 }

 @Override
Expand All@@ -342,6 +372,20 @@ public CelValue fromProtoMessageToCelValue(String protoTypeName, MessageLite msg
 return super.fromWellKnownProtoToCelValue(msg, wellKnownProto);
 }

 @AutoValue
 @SuppressWarnings("AutoValueImmutableFields") // Unknowns are inaccessible to users.
 abstract static class MessageFields {

 abstract ImmutableMap<String, Object> values();

 abstract Multimap<Integer, Object> unknowns();

 static MessageFields create(
 ImmutableMap<String, Object> fieldValues, Multimap<Integer, Object> unknownFields) {
 return new AutoValue_ProtoLiteCelValueConverter_MessageFields(fieldValues, unknownFields);
 }
 }

 private ProtoLiteCelValueConverter(CelLiteDescriptorPool celLiteDescriptorPool) {
 this.descriptorPool = celLiteDescriptorPool;
 }
Expand Down

216 changes: 216 additions & 0 deletions
common/src/test/java/dev/cel/common/values/ProtoLiteCelValueConverterTest.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,9 +17,13 @@
import static com.google.common.truth.Truth.assertThat;
import static java.nio.charset.StandardCharsets.UTF_8;

import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableListMultimap;
import com.google.common.collect.ImmutableSet;
import com.google.common.collect.Multimap;
import com.google.protobuf.ByteString;
import com.google.protobuf.Duration;
import com.google.protobuf.ExtensionRegistryLite;
import com.google.protobuf.FloatValue;
import com.google.protobuf.Int32Value;
import com.google.protobuf.Int64Value;
Expand All@@ -32,9 +36,11 @@
import dev.cel.common.internal.CelLiteDescriptorPool;
import dev.cel.common.internal.DefaultLiteDescriptorPool;
import dev.cel.common.internal.WellKnownProto;
import dev.cel.common.values.ProtoLiteCelValueConverter.MessageFields;
import dev.cel.expr.conformance.proto3.TestAllTypes;
import dev.cel.expr.conformance.proto3.TestAllTypesProto3CelDescriptor;
import java.time.Instant;
import java.util.LinkedHashMap;
import org.junit.Test;
import org.junit.runner.RunWith;

Expand DownExpand Up@@ -107,4 +113,214 @@ public void fromProtoMessageToCelValue_withWellKnownProto_convertsToEquivalentCe

 assertThat(convertedCelValue).isEqualTo(testCase.celValue);
 }

 /** Test cases for repeated_int64: 1L,2L,3L */
 @SuppressWarnings("ImmutableEnumChecker") // Test only
 private enum RepeatedFieldBytesTestCase {
 PACKED(new byte[] {(byte) 0x82, 0x2, 0x3, 0x1, 0x2, 0x3}),
 NON_PACKED(new byte[] {(byte) 0x80, 0x2, 0x1, (byte) 0x80, 0x2, 0x2, (byte) 0x80, 0x2, 0x3}),
 // 1L is not packed, but 2L and 3L are
 MIXED(new byte[] {(byte) 0x80, 0x2, 0x1, (byte) 0x82, 0x2, 0x2, 0x2, 0x3});

 private final byte[] bytes;

 RepeatedFieldBytesTestCase(byte[] bytes) {
 this.bytes = bytes;
 }
 }

 @Test
 public void readAllFields_repeatedFields_packedBytesCombinations(
 @TestParameter RepeatedFieldBytesTestCase testCase) throws Exception {
 MessageFields fields =
 PROTO_LITE_CEL_VALUE_CONVERTER.readAllFields(
 testCase.bytes, "cel.expr.conformance.proto3.TestAllTypes");

 assertThat(fields.values()).containsExactly("repeated_int64", ImmutableList.of(1L, 2L, 3L));
 }

 /**
 * Unknown test with the following hypothetical fields:
 *
 * <pre>{@code
 * message TestAllTypes {
 * int64 single_int64_unknown = 2500;
 * fixed32 single_fixed32_unknown = 2501;
 * fixed64 single_fixed64_unknown = 2502;
 * string single_string_unknown = 2503;
 * repeated int64 repeated_int64_unknown = 2504;
 * map<string, int64> map_string_int64_unknown = 2505;
 * }
 * }</pre>
 */
 @SuppressWarnings("ImmutableEnumChecker") // Test only
 private enum UnknownFieldsTestCase {
 INT64(new byte[] {-96, -100, 1, 1}, "2500: 1", ImmutableListMultimap.of(2500, 1L)),
 FIXED32(
 new byte[] {-83, -100, 1, 2, 0, 0, 0},
 "2501: 0x00000002",
 ImmutableListMultimap.of(2501, 2)),
 FIXED64(
 new byte[] {-79, -100, 1, 3, 0, 0, 0, 0, 0, 0, 0},
 "2502: 0x0000000000000003",
 ImmutableListMultimap.of(2502, 3L)),
 STRING(
 new byte[] {-70, -100, 1, 11, 72, 101, 108, 108, 111, 32, 119, 111, 114, 108, 100},
 "2503: \"Hello world\"",
 ImmutableListMultimap.of(2503, ByteString.copyFromUtf8("Hello world"))),
 REPEATED_INT64(
 new byte[] {-62, -100, 1, 2, 4, 5},
 "2504: \"\\004\\005\"",
 ImmutableListMultimap.of(2504, ByteString.copyFrom(new byte[] {4, 5}))),
 MAP_STRING_INT64(
 new byte[] {
 -54, -100, 1, 7, 10, 3, 102, 111, 111, 16, 4, -54, -100, 1, 7, 10, 3, 98, 97, 114, 16, 5
 },
 "2505: {\n"
 + " 1: \"foo\"\n"
 + " 2: 4\n"
 + "}\n"
 + "2505: {\n"
 + " 1: \"bar\"\n"
 + " 2: 5\n"
 + "}",
 ImmutableListMultimap.of(
 2505,
 ByteString.copyFromUtf8("\n\003foo\020\004"),
 2505,
 ByteString.copyFromUtf8("\n\003bar\020\005")));

 private final byte[] bytes;
 private final String formattedOutput;
 private final Multimap<Integer, Object> unknownMap;

 UnknownFieldsTestCase(
 byte[] bytes, String formattedOutput, Multimap<Integer, Object> unknownMap) {
 this.bytes = bytes;
 this.formattedOutput = formattedOutput;
 this.unknownMap = unknownMap;
 }
 }

 @Test
 public void unknowns_repeatedEncodedBytes_allRecordsKeptWithKeysSorted() throws Exception {
 // 2500: 2
 // 2504: \"\\004\\005\""
 // 2501: 0x00000002
 // 2500: 1
 byte[] bytes =
 new byte[] {
 -96, -100, 1, 2, // keep
 -62, -100, 1, 2, 4, 5, // keep
 -83, -100, 1, 2, 0, 0, 0, // keep
 -96, -100, 1, 1 // keep
 };

 MessageFields messageFields =
 PROTO_LITE_CEL_VALUE_CONVERTER.readAllFields(
 bytes, "cel.expr.conformance.proto3.TestAllTypes");

 assertThat(messageFields.values()).isEmpty();
 assertThat(messageFields.unknowns())
 .containsExactly(
 2500, 2L, 2500, 1L, 2501, 2, 2504, ByteString.copyFrom(new byte[] {0x04, 0x05}))
 .inOrder();
 }

 @Test
 public void readAllFields_unknownFields(@TestParameter UnknownFieldsTestCase testCase)
 throws Exception {
 TestAllTypes parsedMsg =
 TestAllTypes.parseFrom(testCase.bytes, ExtensionRegistryLite.getEmptyRegistry());

 MessageFields messageFields =
 PROTO_LITE_CEL_VALUE_CONVERTER.readAllFields(
 testCase.bytes, "cel.expr.conformance.proto3.TestAllTypes");

 assertThat(messageFields.values()).isEmpty();
 assertThat(messageFields.unknowns()).containsExactlyEntriesIn(testCase.unknownMap).inOrder();
 assertThat(parsedMsg.toString().trim()).isEqualTo(testCase.formattedOutput);
 }

 /**
 * Tests the following message:
 *
 * <pre>{@code
 * TestAllTypes.newBuilder()
 * // Unknowns
 * .setSingleInt64Unknown(1L)
 * .setSingleFixed32Unknown(2)
 * .setSingleFixed64Unknown(3L)
 * .setSingleStringUnknown("Hello world")
 * .addAllRepeatedInt64Unknown(ImmutableList.of(4L, 5L))
 * .putMapStringInt64Unknown("foo", 4L)
 * .putMapStringInt64Unknown("bar", 5L)
 * // Known values
 * .putMapBoolDouble(true, 1.5d)
 * .putMapBoolDouble(false, 2.5d)
 * .build();
 * }</pre>
 */
 @Test
 @SuppressWarnings("unchecked")
 public void readAllFields_unknownFieldsWithValues() throws Exception {
 byte[] unknownMessageBytes = {
 -70, 4, 11, 8, 1, 17, 0, 0, 0, 0, 0, 0, -8, 63, -70, 4, 11, 8, 0, 17, 0, 0, 0, 0, 0, 0, 4, 64,
 -96, -100, 1, 1, -83, -100, 1, 2, 0, 0, 0, -79, -100, 1, 3, 0, 0, 0, 0, 0, 0, 0, -70, -100, 1,
 11, 72, 101, 108, 108, 111, 32, 119, 111, 114, 108, 100, -62, -100, 1, 2, 4, 5, -54, -100, 1,
 7, 10, 3, 102, 111, 111, 16, 4, -54, -100, 1, 7, 10, 3, 98, 97, 114, 16, 5
 };
 TestAllTypes parsedMsg =
 TestAllTypes.parseFrom(unknownMessageBytes, ExtensionRegistryLite.getEmptyRegistry());

 MessageFields fields =
 PROTO_LITE_CEL_VALUE_CONVERTER.readAllFields(
 unknownMessageBytes, "cel.expr.conformance.proto3.TestAllTypes");

 assertThat(parsedMsg.toString())
 .isEqualTo(
 "map_bool_double {\n"
 + " key: false\n"
 + " value: 2.5\n"
 + "}\n"
 + "map_bool_double {\n"
 + " key: true\n"
 + " value: 1.5\n"
 + "}\n"
 + "2500: 1\n"
 + "2501: 0x00000002\n"
 + "2502: 0x0000000000000003\n"
 + "2503: \"Hello world\"\n"
 + "2504: \"\\004\\005\"\n"
 + "2505: {\n"
 + " 1: \"foo\"\n"
 + " 2: 4\n"
 + "}\n"
 + "2505: {\n"
 + " 1: \"bar\"\n"
 + " 2: 5\n"
 + "}\n");
 assertThat(fields.values()).containsKey("map_bool_double");
 LinkedHashMap<Boolean, Double> mapBoolDoubleValues =
 (LinkedHashMap<Boolean, Double>) fields.values().get("map_bool_double");
 assertThat(mapBoolDoubleValues).containsExactly(true, 1.5d, false, 2.5d).inOrder();
 Multimap<Integer, Object> unknownValues = fields.unknowns();
 assertThat(unknownValues)
 .containsExactly(
 2500,
 1L,
 2501,
 2,
 2502,
 3L,
 2503,
 ByteString.copyFromUtf8("Hello world"),
 2504,
 ByteString.copyFrom(new byte[] {0x04, 0x05}),
 2505,
 ByteString.copyFromUtf8("\n\003foo\020\004"),
 2505,
 ByteString.copyFromUtf8("\n\003bar\020\005"))
 .inOrder();
 }
}

25 changes: 0 additions & 25 deletions
common/src/test/java/dev/cel/common/values/ProtoMessageLiteValueTest.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -271,29 +271,4 @@ public void selectField_defaultValue(@TestParameter DefaultValueTestCase testCas
 assertThat(selectedValue).isEqualTo(testCase.celValue);
 assertThat(selectedValue.isZeroValue()).isTrue();
 }

 /** Test cases for repeated_int64: 1L,2L,3L */
 @SuppressWarnings("ImmutableEnumChecker") // Test only
 private enum RepeatedFieldBytesTestCase {
 PACKED(new byte[] {(byte) 0x82, 0x2, 0x3, 0x1, 0x2, 0x3}),
 NON_PACKED(new byte[] {(byte) 0x80, 0x2, 0x1, (byte) 0x80, 0x2, 0x2, (byte) 0x80, 0x2, 0x3}),
 // 1L is not packed, but 2L and 3L are
 MIXED(new byte[] {(byte) 0x80, 0x2, 0x1, (byte) 0x82, 0x2, 0x2, 0x2, 0x3});

 private final byte[] bytes;

 RepeatedFieldBytesTestCase(byte[] bytes) {
 this.bytes = bytes;
 }
 }

 @Test
 public void readAllFields_repeatedFields_packedBytesCombinations(
 @TestParameter RepeatedFieldBytesTestCase testCase) throws Exception {
 ImmutableMap<String, Object> fields =
 PROTO_LITE_CEL_VALUE_CONVERTER.readAllFields(
 testCase.bytes, "cel.expr.conformance.proto3.TestAllTypes");

 assertThat(fields).containsExactly("repeated_int64", ImmutableList.of(1L, 2L, 3L));
 }
}
Loading