Skip to content

Add BaseProtoMessageValueProvider to decouple full/lite protobuf value providers #674

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.

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
merged 1 commit into from
Apr 29, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
63 changes: 58 additions & 5 deletions common/src/main/java/dev/cel/common/values/BUILD.bazel
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,32 @@ cel_android_library(
],
)

java_library(
name = "combined_cel_value_provider",
srcs = ["CombinedCelValueProvider.java"],
tags = [
],
deps = [
"//common/values:cel_value",
"//common/values:cel_value_provider",
"@maven//:com_google_errorprone_error_prone_annotations",
"@maven//:com_google_guava_guava",
],
)

cel_android_library(
name = "combined_cel_value_provider_android",
srcs = ["CombinedCelValueProvider.java"],
tags = [
],
deps = [
":cel_value_android",
"//common/values:cel_value_provider_android",
"@maven//:com_google_errorprone_error_prone_annotations",
"@maven_android//:com_google_guava_guava",
],
)

java_library(
name = "values",
srcs = CEL_VALUES_SOURCES,
Expand Down Expand Up @@ -207,14 +233,13 @@ java_library(
tags = [
],
deps = [
":base_proto_message_value_provider",
":cel_value",
":cel_value_provider",
":proto_message_value",
"//common:error_codes",
"//common:runtime_exception",
"//common/annotations",
"//common/internal:dynamic_proto",
"//common/internal:proto_message_factory",
"//common/values:base_proto_cel_value_converter",
"@maven//:com_google_errorprone_error_prone_annotations",
"@maven//:com_google_protobuf_protobuf_java",
],
Expand Down Expand Up @@ -280,11 +305,12 @@ java_library(
tags = [
],
deps = [
":base_proto_message_value_provider",
":cel_value",
":cel_value_provider",
":proto_message_lite_value",
"//common/internal:cel_lite_descriptor_pool",
"//common/internal:default_lite_descriptor_pool",
"//common/values:base_proto_cel_value_converter",
"//protobuf:cel_lite_descriptor",
"@maven//:com_google_errorprone_error_prone_annotations",
"@maven//:com_google_guava_guava",
Expand All @@ -298,14 +324,41 @@ cel_android_library(
tags = [
],
deps = [
":base_proto_message_value_provider_android",
":cel_value_android",
":cel_value_provider_android",
":proto_message_lite_value_android",
"//common/internal:cel_lite_descriptor_pool_android",
"//common/internal:default_lite_descriptor_pool_android",
"//common/values:base_proto_cel_value_converter_android",
"//protobuf:cel_lite_descriptor",
"@maven//:com_google_errorprone_error_prone_annotations",
"@maven_android//:com_google_guava_guava",
"@maven_android//:com_google_protobuf_protobuf_javalite",
],
)

java_library(
name = "base_proto_message_value_provider",
srcs = ["BaseProtoMessageValueProvider.java"],
tags = [
],
deps = [
"//common/annotations",
"//common/values:base_proto_cel_value_converter",
"//common/values:cel_value_provider",
"@maven//:com_google_errorprone_error_prone_annotations",
],
)

cel_android_library(
name = "base_proto_message_value_provider_android",
srcs = ["BaseProtoMessageValueProvider.java"],
tags = [
],
deps = [
"//common/annotations",
"//common/values:base_proto_cel_value_converter_android",
"//common/values:cel_value_provider_android",
"@maven//:com_google_errorprone_error_prone_annotations",
],
)
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
// Copyright 2025 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// https://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package dev.cel.common.values;

import com.google.errorprone.annotations.Immutable;
import dev.cel.common.annotations.Internal;

/**
* {@code BaseProtoMessageValueProvider} is a common parent to {@code ProtoMessageValueProvider} and
* {@code ProtoMessageLiteValueProvider}.
*
* <p>CEL-Java internals. Do not use. Use one of the inherited variants mentioned above.
*/
@Internal
@Immutable
public abstract class BaseProtoMessageValueProvider implements CelValueProvider {

public abstract BaseProtoCelValueConverter protoCelValueConverter();
}
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@
import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableMap;
import com.google.common.primitives.UnsignedLong;
import com.google.errorprone.annotations.Immutable;
import dev.cel.common.annotations.Internal;
import java.util.Map;
import java.util.Map.Entry;
Expand All @@ -31,6 +32,7 @@
*/
@SuppressWarnings("unchecked") // Unchecked cast of generics due to type-erasure (ex: MapValue).
@Internal
@Immutable
abstract class CelValueConverter {

/** Adapts a {@link CelValue} to a plain old Java Object. */
Expand Down
30 changes: 0 additions & 30 deletions common/src/main/java/dev/cel/common/values/CelValueProvider.java
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,6 @@

package dev.cel.common.values;

import com.google.common.base.Preconditions;
import com.google.common.collect.ImmutableList;
import com.google.errorprone.annotations.Immutable;
import java.util.Map;
import java.util.Optional;
Expand All @@ -31,32 +29,4 @@ public interface CelValueProvider {
* special cases such as wrappers where its primitive is returned.
*/
Optional<CelValue> newValue(String structType, Map<String, Object> fields);

/**
* The {@link CombinedCelValueProvider} takes one or more {@link CelValueProvider} instances and
* attempts to create a {@link CelValue} instance for a given struct type name by calling each
* value provider in the order that they are provided to the constructor.
*/
@Immutable
final class CombinedCelValueProvider implements CelValueProvider {
private final ImmutableList<CelValueProvider> celValueProviders;

public CombinedCelValueProvider(CelValueProvider first, CelValueProvider second) {
Preconditions.checkNotNull(first);
Preconditions.checkNotNull(second);
celValueProviders = ImmutableList.of(first, second);
}

@Override
public Optional<CelValue> newValue(String structType, Map<String, Object> fields) {
for (CelValueProvider provider : celValueProviders) {
Optional<CelValue> newValue = provider.newValue(structType, fields);
if (newValue.isPresent()) {
return newValue;
}
}

return Optional.empty();
}
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
// Copyright 2025 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// https://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package dev.cel.common.values;

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

import com.google.common.collect.ImmutableList;
import com.google.errorprone.annotations.Immutable;
import java.util.Map;
import java.util.Optional;

/**
* The {@link CombinedCelValueProvider} takes one or more {@link CelValueProvider} instances and
* attempts to create a {@link CelValue} instance for a given struct type name by calling each value
* provider in the order that they are provided to the constructor.
*/
@Immutable
public final class CombinedCelValueProvider implements CelValueProvider {
private final ImmutableList<CelValueProvider> celValueProviders;

/** Combines the provided first and second {@link CelValueProvider}. */
public static CombinedCelValueProvider combine(CelValueProvider... providers) {
checkArgument(providers.length >= 2, "You must provide two or more providers");
return new CombinedCelValueProvider(ImmutableList.copyOf(providers));
}

@Override
public Optional<CelValue> newValue(String structType, Map<String, Object> fields) {
for (CelValueProvider provider : celValueProviders) {
Optional<CelValue> newValue = provider.newValue(structType, fields);
if (newValue.isPresent()) {
return newValue;
}
}

return Optional.empty();
}

/** Returns the underlying {@link CelValueProvider}s in order. */
public ImmutableList<CelValueProvider> valueProviders() {
return celValueProviders;
}

private CombinedCelValueProvider(ImmutableList<CelValueProvider> providers) {
celValueProviders = checkNotNull(providers);
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -30,11 +30,12 @@
* fully qualified name and its fields to populate.
*/
@Immutable
public class ProtoMessageLiteValueProvider implements CelValueProvider {
public class ProtoMessageLiteValueProvider extends BaseProtoMessageValueProvider {
private final CelLiteDescriptorPool descriptorPool;
private final ProtoLiteCelValueConverter protoLiteCelValueConverter;

public ProtoLiteCelValueConverter getProtoLiteCelValueConverter() {
@Override
public BaseProtoCelValueConverter protoCelValueConverter() {
return protoLiteCelValueConverter;
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,6 @@
import com.google.protobuf.Descriptors.Descriptor;
import com.google.protobuf.Descriptors.FieldDescriptor;
import com.google.protobuf.Message;
import dev.cel.common.CelErrorCode;
import dev.cel.common.CelRuntimeException;
import dev.cel.common.annotations.Internal;
import dev.cel.common.internal.DynamicProto;
import dev.cel.common.internal.ProtoAdapter;
Expand All @@ -35,19 +33,23 @@
*/
@Immutable
@Internal
public class ProtoMessageValueProvider implements CelValueProvider {
public class ProtoMessageValueProvider extends BaseProtoMessageValueProvider {
private final ProtoAdapter protoAdapter;
private final ProtoMessageFactory protoMessageFactory;
private final ProtoCelValueConverter protoCelValueConverter;

public ProtoCelValueConverter getProtoCelValueConverter() {
@Override
public BaseProtoCelValueConverter protoCelValueConverter() {
return protoCelValueConverter;
}

@Override
public Optional<CelValue> newValue(String structType, Map<String, Object> fields) {
Message.Builder builder = protoMessageFactory.newBuilder(structType).orElse(null);
if (builder == null) {
return Optional.empty();
}
try {
Message.Builder builder = getMessageBuilderOrThrow(structType);
Descriptor descriptor = builder.getDescriptorForType();
for (Map.Entry<String, Object> entry : fields.entrySet()) {
FieldDescriptor fieldDescriptor = findField(descriptor, entry.getKey());
Expand All @@ -63,17 +65,6 @@ public Optional<CelValue> newValue(String structType, Map<String, Object> fields
}
}

private Message.Builder getMessageBuilderOrThrow(String messageName) {
return protoMessageFactory
.newBuilder(messageName)
.orElseThrow(
() ->
new CelRuntimeException(
new IllegalArgumentException(
String.format("cannot resolve '%s' as a message", messageName)),
CelErrorCode.ATTRIBUTE_NOT_FOUND));
}

private FieldDescriptor findField(Descriptor descriptor, String fieldName) {
FieldDescriptor fieldDescriptor = descriptor.findFieldByName(fieldName);
if (fieldDescriptor != null) {
Expand Down
1 change: 1 addition & 0 deletions common/src/test/java/dev/cel/common/values/BUILD.bazel
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ java_library(
"//common/values:cel_byte_string",
"//common/values:cel_value",
"//common/values:cel_value_provider",
"//common/values:combined_cel_value_provider",
"//common/values:proto_message_lite_value",
"//common/values:proto_message_lite_value_provider",
"//common/values:proto_message_value",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,6 @@ public void newValue_emptyFields_success() {

@Test
public void getProtoLiteCelValueConverter() {
assertThat(VALUE_PROVIDER.getProtoLiteCelValueConverter()).isNotNull();
assertThat(VALUE_PROVIDER.protoCelValueConverter()).isNotNull();
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -22,14 +22,12 @@
import com.google.common.primitives.UnsignedLong;
import com.google.testing.junit.testparameterinjector.TestParameterInjector;
import dev.cel.common.CelDescriptorUtil;
import dev.cel.common.CelRuntimeException;
import dev.cel.common.internal.CelDescriptorPool;
import dev.cel.common.internal.DefaultDescriptorPool;
import dev.cel.common.internal.DefaultMessageFactory;
import dev.cel.common.internal.DynamicProto;
import dev.cel.common.internal.ProtoMessageFactory;
import dev.cel.common.internal.ProtoTimeUtils;
import dev.cel.common.values.CelValueProvider.CombinedCelValueProvider;
import dev.cel.expr.conformance.proto2.TestAllTypes;
import dev.cel.expr.conformance.proto2.TestAllTypesExtensions;
import java.time.Duration;
Expand Down Expand Up @@ -206,18 +204,11 @@ public void newValue_createProtoMessage_extensionFieldsPopulated() {
}

@Test
public void newValue_invalidMessageName_throws() {
public void newValue_invalidMessageName_returnsEmpty() {
ProtoMessageValueProvider protoMessageValueProvider =
ProtoMessageValueProvider.newInstance(DYNAMIC_PROTO);

CelRuntimeException e =
assertThrows(
CelRuntimeException.class,
() -> protoMessageValueProvider.newValue("bogus", ImmutableMap.of()));

assertThat(e)
.hasMessageThat()
.isEqualTo("java.lang.IllegalArgumentException: cannot resolve 'bogus' as a message");
assertThat(protoMessageValueProvider.newValue("bogus", ImmutableMap.of())).isEmpty();
}

@Test
Expand Down Expand Up @@ -245,7 +236,7 @@ public void newValue_onCombinedProvider() {
ProtoMessageValueProvider protoMessageValueProvider =
ProtoMessageValueProvider.newInstance(DYNAMIC_PROTO);
CelValueProvider combinedProvider =
new CombinedCelValueProvider(celValueProvider, protoMessageValueProvider);
CombinedCelValueProvider.combine(celValueProvider, protoMessageValueProvider);

ProtoMessageValue protoMessageValue =
(ProtoMessageValue)
Expand Down
Loading
Loading