Implement OpaqueValue, ErrorValue

PiperOrigin-RevId: 584658086

Author: l46kok

common/src/main/java/dev/cel/common/values/BUILD.bazel

@@ -14,12 +14,14 @@ CEL_VALUES_SOURCES = [
     "DoubleValue.java",
     "DurationValue.java",
     "EnumValue.java",
+    "ErrorValue.java",
     "ImmutableListValue.java",
     "ImmutableMapValue.java",
     "IntValue.java",
     "ListValue.java",
     "MapValue.java",
     "NullValue.java",
+    "OpaqueValue.java",
     "OptionalValue.java",
     "StringValue.java",
     "StructValue.java",
@@ -48,6 +50,7 @@ java_library(
         ":cel_byte_string",
         ":cel_value",
         "//:auto_value",
+        "//common/annotations",
         "//common/types:type_providers",
         "@maven//:com_google_errorprone_error_prone_annotations",
         "@maven//:com_google_guava_guava",

common/src/main/java/dev/cel/common/values/ErrorValue.java

@@ -0,0 +1,45 @@
+// Copyright 2023 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.auto.value.AutoValue;
+import dev.cel.common.annotations.Internal;
+
+/**
+ * CelErrorValue represent the intermediate error that occurs during evaluation in the form of Java
+ * exception. This is used to capture the error that occurs during a non-strict evaluation, which
+ * may or may not be propagated to the caller.
+ *
+ * <p>CEL Library Internals. Do Not Use.
+ */
+@AutoValue
+@AutoValue.CopyAnnotations
+@Internal
+@SuppressWarnings(
+    "Immutable") // Exception is technically not immutable as the stacktrace is malleable.
+public abstract class ErrorValue extends CelValue {
+
+  @Override
+  public abstract Exception value();
+
+  @Override
+  public boolean isZeroValue() {
+    return false;
+  }
+
+  public static ErrorValue create(Exception value) {
+    return new AutoValue_ErrorValue(value);
+  }
+}

common/src/main/java/dev/cel/common/values/OpaqueValue.java

@@ -0,0 +1,33 @@
+// Copyright 2023 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.auto.value.AutoValue;
+
+/** OpaqueValue is the value representation of OpaqueType. */
+@AutoValue
+@AutoValue.CopyAnnotations
+@SuppressWarnings("Immutable") // Java Object is mutable.
+public abstract class OpaqueValue extends CelValue {
+
+  @Override
+  public boolean isZeroValue() {
+    return false;
+  }
+
+  public static OpaqueValue create(Object value) {
+    return new AutoValue_OpaqueValue(value);
+  }
+}

common/src/test/java/dev/cel/common/values/ErrorValueTest.java

@@ -0,0 +1,39 @@
+// Copyright 2023 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.truth.Truth.assertThat;
+import static org.junit.Assert.assertThrows;
+
+import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.junit.runners.JUnit4;
+
+@RunWith(JUnit4.class)
+public class ErrorValueTest {
+  @Test
+  public void errorValue_construct() {
+    IllegalArgumentException exception = new IllegalArgumentException("test");
+    ErrorValue opaqueValue = ErrorValue.create(exception);
+
+    assertThat(opaqueValue.value()).isEqualTo(exception);
+    assertThat(opaqueValue.isZeroValue()).isFalse();
+  }
+
+  @Test
+  public void create_nullValue_throws() {
+    assertThrows(NullPointerException.class, () -> ErrorValue.create(null));
+  }
+}

common/src/test/java/dev/cel/common/values/OpaqueValueTest.java

@@ -0,0 +1,38 @@
+// Copyright 2023 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.truth.Truth.assertThat;
+import static org.junit.Assert.assertThrows;
+
+import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.junit.runners.JUnit4;
+
+@RunWith(JUnit4.class)
+public class OpaqueValueTest {
+  @Test
+  public void opaqueValue_construct() {
+    OpaqueValue opaqueValue = OpaqueValue.create("test");
+
+    assertThat(opaqueValue.value()).isEqualTo("test");
+    assertThat(opaqueValue.isZeroValue()).isFalse();
+  }
+
+  @Test
+  public void create_nullValue_throws() {
+    assertThrows(NullPointerException.class, () -> OpaqueValue.create(null));
+  }
+}