Add an adapter for legacy runtime to consume CelValueProvider. Add in…

…terpreter test for CelValues. PiperOrigin-RevId: 563598718
google · Dec 2, 2023 · 39a99ef · 39a99ef
1 parent aa6875c
commit 39a99ef
Show file tree

Hide file tree

Showing 44 changed files with 1,411 additions and 180 deletions.
diff --git a/bundle/src/test/java/dev/cel/bundle/CelImplTest.java b/bundle/src/test/java/dev/cel/bundle/CelImplTest.java
@@ -526,6 +526,24 @@ public void program_withVars() throws Exception {
     assertThat(program.eval(ImmutableMap.of("variable", "hello"))).isEqualTo(true);
   }
 
+  @Test
+  public void program_withCelValue() throws Exception {
+    Cel cel =
+        standardCelBuilderWithMacros()
+            .setOptions(CelOptions.current().enableCelValue(true).build())
+            .addDeclarations(
+                Decl.newBuilder()
+                    .setName("variable")
+                    .setIdent(IdentDecl.newBuilder().setType(CelTypes.STRING))
+                    .build())
+            .setResultType(SimpleType.BOOL)
+            .build();
+
+    CelRuntime.Program program = cel.createProgram(cel.compile("variable == 'hello'").getAst());
+
+    assertThat(program.eval(ImmutableMap.of("variable", "hello"))).isEqualTo(true);
+  }
+
   @Test
   public void program_withProtoVars() throws Exception {
     Cel cel =
@@ -1285,6 +1303,26 @@ public void programAdvanceEvaluation_nestedSelect() throws Exception {
         .isEqualTo(CelUnknownSet.create(CelAttribute.fromQualifiedIdentifier("com.google.a")));
   }
 
+  @Test
+  public void programAdvanceEvaluation_nestedSelect_withCelValue() throws Exception {
+    Cel cel =
+        standardCelBuilderWithMacros()
+            .setOptions(
+                CelOptions.current().enableUnknownTracking(true).enableCelValue(true).build())
+            .addVar("com", MapType.create(SimpleType.STRING, SimpleType.DYN))
+            .addFunctionBindings()
+            .setResultType(SimpleType.BOOL)
+            .build();
+    CelRuntime.Program program = cel.createProgram(cel.compile("com.google.a || false").getAst());
+
+    assertThat(
+            program.advanceEvaluation(
+                UnknownContext.create(
+                    fromMap(ImmutableMap.of()),
+                    ImmutableList.of(CelAttributePattern.fromQualifiedIdentifier("com.google.a")))))
+        .isEqualTo(CelUnknownSet.create(CelAttribute.fromQualifiedIdentifier("com.google.a")));
+  }
+
   @Test
   public void programAdvanceEvaluation_argumentMergeErrorPriority() throws Exception {
     Cel cel =

diff --git a/common/src/main/java/dev/cel/common/CelOptions.java b/common/src/main/java/dev/cel/common/CelOptions.java
@@ -87,6 +87,8 @@ public abstract class CelOptions {
 
   public abstract boolean enableUnknownTracking();
 
+  public abstract boolean enableCelValue();
+
   public abstract int comprehensionMaxIterations();
 
   public abstract Builder toBuilder();
@@ -176,6 +178,7 @@ public static Builder newBuilder() {
         .errorOnDuplicateMapKeys(false)
         .resolveTypeDependencies(true)
         .enableUnknownTracking(false)
+        .enableCelValue(false)
         .comprehensionMaxIterations(-1);
   }
 
@@ -428,6 +431,15 @@ public abstract static class Builder {
      */
     public abstract Builder enableUnknownTracking(boolean value);
 
+    /**
+     * Enables the usage of {@code CelValue} for the runtime. It is a native value representation of
+     * CEL that wraps Java native objects, and comes with extended capabilities, such as allowing
+     * value constructs not understood by CEL (ex: POJOs).
+     *
+     * <p>Warning: This option is experimental.
+     */
+    public abstract Builder enableCelValue(boolean value);
+
     /**
      * Limit the total number of iterations permitted within comprehension loops.
      *

diff --git a/common/src/main/java/dev/cel/common/internal/BUILD.bazel b/common/src/main/java/dev/cel/common/internal/BUILD.bazel
@@ -181,6 +181,7 @@ java_library(
     ],
     deps = [
         "//common/annotations",
+        "@maven//:com_google_guava_guava",
         "@maven//:com_google_protobuf_protobuf_java",
     ],
 )

diff --git a/common/src/main/java/dev/cel/common/internal/DynamicProto.java b/common/src/main/java/dev/cel/common/internal/DynamicProto.java
@@ -46,6 +46,14 @@ public static DynamicProto create(ProtoMessageFactory protoMessageFactory) {
     this.protoMessageFactory = checkNotNull(protoMessageFactory);
   }
 
+  /**
+   * Gets the underlying message factory used to construct new protobuf messages upon unpacking an
+   * Any message.
+   */
+  public ProtoMessageFactory getProtoMessageFactory() {
+    return protoMessageFactory;
+  }
+
   /** Attempts to unpack an Any message. */
   public Optional<Message> maybeUnpackAny(Message msg) {
     try {

diff --git a/common/src/main/java/dev/cel/common/internal/ProtoAdapter.java b/common/src/main/java/dev/cel/common/internal/ProtoAdapter.java
@@ -16,7 +16,6 @@
 
 import static com.google.common.base.Preconditions.checkNotNull;
 import static com.google.common.collect.ImmutableMap.toImmutableMap;
-import static java.util.Arrays.stream;
 
 import dev.cel.expr.ExprValue;
 import com.google.common.collect.ImmutableList;
@@ -25,7 +24,7 @@
 import com.google.common.primitives.UnsignedInts;
 import com.google.common.primitives.UnsignedLong;
 import com.google.errorprone.annotations.CheckReturnValue;
-import javax.annotation.concurrent.ThreadSafe;
+import com.google.errorprone.annotations.Immutable;
 import com.google.protobuf.Any;
 import com.google.protobuf.BoolValue;
 import com.google.protobuf.ByteString;
@@ -60,7 +59,6 @@
 import java.util.List;
 import java.util.Map;
 import java.util.Optional;
-import java.util.function.Function;
 import org.jspecify.nullness.Nullable;
 
 /**
@@ -73,7 +71,7 @@
  *
  * <p>CEL Library Internals. Do Not Use.
  */
-@ThreadSafe
+@Immutable
 @CheckReturnValue
 @Internal
 public final class ProtoAdapter {
@@ -139,10 +137,6 @@ public final class ProtoAdapter {
   public static final BidiConverter<Number, Number> DOUBLE_CONVERTER =
       BidiConverter.of(Number::doubleValue, Number::floatValue);
 
-  private static final ImmutableMap<String, WellKnownProto> WELL_KNOWN_PROTOS =
-      stream(WellKnownProto.values())
-          .collect(toImmutableMap(WellKnownProto::typeName, Function.identity()));
-
   private final DynamicProto dynamicProto;
   private final boolean enableUnsignedLongs;
 
@@ -163,7 +157,8 @@ public Object adaptProtoToValue(MessageOrBuilder proto) {
     }
     // If the proto is not a well-known type, then the input Message is what's expected as the
     // output return value.
-    WellKnownProto wellKnownProto = WELL_KNOWN_PROTOS.get(typeName(proto.getDescriptorForType()));
+    WellKnownProto wellKnownProto =
+        WellKnownProto.getByDescriptorName(typeName(proto.getDescriptorForType()));
     if (wellKnownProto == null) {
       return proto;
     }
@@ -328,7 +323,7 @@ private BidiConverter fieldToValueConverter(FieldDescriptor fieldDescriptor) {
    * considered, such as a packing an {@code google.protobuf.StringValue} into a {@code Any} value.
    */
   public Optional<Message> adaptValueToProto(Object value, String protoTypeName) {
-    WellKnownProto wellKnownProto = WELL_KNOWN_PROTOS.get(protoTypeName);
+    WellKnownProto wellKnownProto = WellKnownProto.getByDescriptorName(protoTypeName);
     if (wellKnownProto == null) {
       if (value instanceof Message) {
         return Optional.of((Message) value);
@@ -644,7 +639,7 @@ private static boolean isWrapperType(FieldDescriptor fieldDescriptor) {
       return false;
     }
     String fieldTypeName = fieldDescriptor.getMessageType().getFullName();
-    WellKnownProto wellKnownProto = WELL_KNOWN_PROTOS.get(fieldTypeName);
+    WellKnownProto wellKnownProto = WellKnownProto.getByDescriptorName(fieldTypeName);
     return wellKnownProto != null && wellKnownProto.isWrapperType();
   }
 

diff --git a/common/src/main/java/dev/cel/common/internal/WellKnownProto.java b/common/src/main/java/dev/cel/common/internal/WellKnownProto.java
@@ -14,6 +14,10 @@
 
 package dev.cel.common.internal;
 
+import static com.google.common.collect.ImmutableMap.toImmutableMap;
+import static java.util.Arrays.stream;
+
+import com.google.common.collect.ImmutableMap;
 import com.google.protobuf.Any;
 import com.google.protobuf.BoolValue;
 import com.google.protobuf.BytesValue;
@@ -31,6 +35,7 @@
 import com.google.protobuf.UInt64Value;
 import com.google.protobuf.Value;
 import dev.cel.common.annotations.Internal;
+import java.util.function.Function;
 
 /**
  * WellKnownProto types used throughout CEL. These types are specially handled to ensure that
@@ -58,6 +63,14 @@ public enum WellKnownProto {
   private final Descriptor descriptor;
   private final boolean isWrapperType;
 
+  private static final ImmutableMap<String, WellKnownProto> WELL_KNOWN_PROTO_MAP;
+
+  static {
+    WELL_KNOWN_PROTO_MAP =
+        stream(WellKnownProto.values())
+            .collect(toImmutableMap(WellKnownProto::typeName, Function.identity()));
+  }
+
   WellKnownProto(Descriptor descriptor) {
     this(descriptor, /* isWrapperType= */ false);
   }
@@ -75,7 +88,11 @@ public String typeName() {
     return descriptor.getFullName();
   }
 
-  boolean isWrapperType() {
+  public boolean isWrapperType() {
     return isWrapperType;
   }
+
+  public static WellKnownProto getByDescriptorName(String name) {
+    return WELL_KNOWN_PROTO_MAP.get(name);
+  }
 }
diff --git a/common/src/main/java/dev/cel/common/types/TypeType.java b/common/src/main/java/dev/cel/common/types/TypeType.java
@@ -26,8 +26,6 @@
 @Immutable
 public abstract class TypeType extends CelType {
 
-  static final TypeType TYPE = create(SimpleType.DYN);
-
   @Override
   public CelKind kind() {
     return CelKind.TYPE;
@@ -38,6 +36,16 @@ public String name() {
     return "type";
   }
 
+  /** Retrieves the underlying type name of the type-kind held. */
+  public String containingTypeName() {
+    CelType containingType = type();
+    if (containingType.kind() == CelKind.DYN) {
+      return "type";
+    }
+
+    return containingType.name();
+  }
+
   @Override
   public abstract ImmutableList<CelType> parameters();
 

diff --git a/common/src/main/java/dev/cel/common/values/BUILD.bazel b/common/src/main/java/dev/cel/common/values/BUILD.bazel
@@ -24,6 +24,7 @@ CEL_VALUES_SOURCES = [
     "NullValue.java",
     "OpaqueValue.java",
     "OptionalValue.java",
+    "SelectableValue.java",
     "StringValue.java",
     "StructValue.java",
     "TimestampValue.java",
@@ -49,6 +50,20 @@ java_library(
     ],
 )
 
+java_library(
+    name = "cel_value_provider",
+    srcs = [
+        "CelValueProvider.java",
+    ],
+    tags = [
+    ],
+    deps = [
+        ":cel_value",
+        "@maven//:com_google_errorprone_error_prone_annotations",
+        "@maven//:com_google_guava_guava",
+    ],
+)
+
 java_library(
     name = "values",
     srcs = CEL_VALUES_SOURCES,
@@ -58,7 +73,9 @@ java_library(
         ":cel_byte_string",
         ":cel_value",
         "//:auto_value",
+        "//common:error_codes",
         "//common:options",
+        "//common:runtime_exception",
         "//common/annotations",
         "//common/types",
         "//common/types:type_providers",
@@ -104,3 +121,23 @@ java_library(
         "@maven//:org_jspecify_jspecify",
     ],
 )
+
+java_library(
+    name = "proto_message_value_provider",
+    srcs = ["ProtoMessageValueProvider.java"],
+    tags = [
+    ],
+    deps = [
+        ":cel_value",
+        ":cel_value_provider",
+        ":proto_message_value",
+        "//common:error_codes",
+        "//common:options",
+        "//common:runtime_exception",
+        "//common/annotations",
+        "//common/internal:dynamic_proto",
+        "//common/internal:proto_message_factory",
+        "@maven//:com_google_errorprone_error_prone_annotations",
+        "@maven//:com_google_protobuf_protobuf_java",
+    ],
+)