DataConnectOperationException added

Author: dconeybe

firebase-dataconnect/api.txt

@@ -42,6 +42,47 @@ package com.google.firebase.dataconnect {
     ctor public DataConnectException(String message, Throwable? cause = null);
   }
 
+  public class DataConnectOperationException extends com.google.firebase.dataconnect.DataConnectException {
+    ctor public DataConnectOperationException(String message, Throwable? cause = null, com.google.firebase.dataconnect.DataConnectOperationFailureResponse<? extends java.lang.Object?> response);
+    method public final com.google.firebase.dataconnect.DataConnectOperationFailureResponse<? extends java.lang.Object?> getResponse();
+    property public final com.google.firebase.dataconnect.DataConnectOperationFailureResponse<? extends java.lang.Object?> response;
+  }
+
+  public interface DataConnectOperationFailureResponse<Data> {
+    method public Data? getData();
+    method public java.util.List<com.google.firebase.dataconnect.DataConnectOperationFailureResponse.ErrorInfo> getErrors();
+    method public java.util.Map<java.lang.String,java.lang.Object?>? getRawData();
+    method public String toString();
+    property public abstract Data? data;
+    property public abstract java.util.List<com.google.firebase.dataconnect.DataConnectOperationFailureResponse.ErrorInfo> errors;
+    property public abstract java.util.Map<java.lang.String,java.lang.Object?>? rawData;
+  }
+
+  public static interface DataConnectOperationFailureResponse.ErrorInfo {
+    method public boolean equals(Object? other);
+    method public String getMessage();
+    method public java.util.List<com.google.firebase.dataconnect.DataConnectOperationFailureResponse.ErrorInfo.PathSegment> getPath();
+    method public int hashCode();
+    method public String toString();
+    property public abstract String message;
+    property public abstract java.util.List<com.google.firebase.dataconnect.DataConnectOperationFailureResponse.ErrorInfo.PathSegment> path;
+  }
+
+  public static sealed interface DataConnectOperationFailureResponse.ErrorInfo.PathSegment {
+  }
+
+  @kotlin.jvm.JvmInline public static final value class DataConnectOperationFailureResponse.ErrorInfo.PathSegment.Field implements com.google.firebase.dataconnect.DataConnectOperationFailureResponse.ErrorInfo.PathSegment {
+    ctor public DataConnectOperationFailureResponse.ErrorInfo.PathSegment.Field(String field);
+    method public String getField();
+    property public final String field;
+  }
+
+  @kotlin.jvm.JvmInline public static final value class DataConnectOperationFailureResponse.ErrorInfo.PathSegment.ListIndex implements com.google.firebase.dataconnect.DataConnectOperationFailureResponse.ErrorInfo.PathSegment {
+    ctor public DataConnectOperationFailureResponse.ErrorInfo.PathSegment.ListIndex(int index);
+    method public int getIndex();
+    property public final int index;
+  }
+
   public final class DataConnectSettings {
     ctor public DataConnectSettings(String host = "firebasedataconnect.googleapis.com", boolean sslEnabled = true);
     method public String getHost();

firebase-dataconnect/firebase-dataconnect.gradle.kts

@@ -103,6 +103,7 @@ dependencies {
 
   compileOnly(libs.javax.annotation.jsr250)
   compileOnly(libs.kotlinx.datetime)
+  compileOnly(libs.kotlinx.serialization.json)
   implementation(libs.grpc.android)
   implementation(libs.grpc.kotlin.stub)
   implementation(libs.grpc.okhttp)

firebase-dataconnect/src/main/kotlin/com/google/firebase/dataconnect/DataConnectError.kt

@@ -0,0 +1,29 @@
+/*
+ * 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
+ *
+ *      http://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 com.google.firebase.dataconnect
+
+/**
+ * The exception thrown when an error occurs in the execution of a Firebase Data Connect operation
+ * (that is, a query or mutation). This exception means that a response was, indeed, received from
+ * the backend but either the response included one or more errors or the client could not
+ * successfully process the result (for example, decoding the response data failed).
+ */
+public open class DataConnectOperationException(
+  message: String,
+  cause: Throwable? = null,
+  public val response: DataConnectOperationFailureResponse<*>,
+) : DataConnectException(message, cause)

firebase-dataconnect/src/main/kotlin/com/google/firebase/dataconnect/DataConnectOperationException.kt

@@ -0,0 +1,155 @@
+/*
+ * 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
+ *
+ *      http://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 com.google.firebase.dataconnect
+
+// Googlers see go/dataconnect:sdk:partial-errors for design details.
+
+/** The data and errors provided by the backend in the response message. */
+public interface DataConnectOperationFailureResponse<Data> {
+
+  /**
+   * The raw, un-decoded data provided by the backend in the response message. Will be `null` if,
+   * and only if, the backend explicitly sent null for the data or if the data was not present in
+   * the response.
+   *
+   * Otherwise, the values in the map will be one of the following:
+   * * `null`
+   * * [String]
+   * * [Boolean]
+   * * [Double]
+   * * [List] containing any of the types in this list of types
+   * * [Map] with [String] keys and values of of the types in this list of types
+   *
+   * Consider using [toJson] to get a higher-level object.
+   */
+  public val rawData: Map<String, Any?>?
+
+  /**
+   * The list of errors provided by the backend in the response message; may be empty.
+   *
+   * See https://spec.graphql.org/draft/#sec-Errors for details.
+   */
+  public val errors: List<ErrorInfo>
+
+  /**
+   * The successfully-decoded [rawData], if any.
+   *
+   * Will be `null` if [rawData] is `null`, or if decoding the [rawData] failed.
+   */
+  public val data: Data?
+
+  /**
+   * Returns a string representation of this object, useful for debugging.
+   *
+   * The string representation is _not_ guaranteed to be stable and may change without notice at any
+   * time. Therefore, the only recommended usage of the returned string is debugging and/or logging.
+   * Namely, parsing the returned string or storing the returned string in non-volatile storage
+   * should generally be avoided in order to be robust in case that the string representation
+   * changes.
+   *
+   * @return a string representation of this object, which includes the class name and the values of
+   * all public properties.
+   */
+  override fun toString(): String
+
+  /**
+   * Information about the error, as provided in the response payload from the backend.
+   *
+   * See https://spec.graphql.org/draft/#sec-Errors for details.
+   */
+  public interface ErrorInfo {
+    /** The error's message. */
+    public val message: String
+
+    /** The path of the field in the response data to which this error relates. */
+    public val path: List<PathSegment>
+
+    /**
+     * Compares this object with another object for equality.
+     *
+     * @param other The object to compare to this for equality.
+     * @return true if, and only if, the other object is an instance of the same implementation of
+     * [ErrorInfo] whose public properties compare equal using the `==` operator to the
+     * corresponding properties of this object.
+     */
+    override fun equals(other: Any?): Boolean
+
+    /**
+     * Calculates and returns the hash code for this object.
+     *
+     * The hash code is _not_ guaranteed to be stable across application restarts.
+     *
+     * @return the hash code for this object, that incorporates the values of this object's public
+     * properties.
+     */
+    override fun hashCode(): Int
+
+    /**
+     * Returns a string representation of this object, useful for debugging.
+     *
+     * The string representation is _not_ guaranteed to be stable and may change without notice at
+     * any time. Therefore, the only recommended usage of the returned string is debugging and/or
+     * logging. Namely, parsing the returned string or storing the returned string in non-volatile
+     * storage should generally be avoided in order to be robust in case that the string
+     * representation changes.
+     *
+     * @return a string representation of this object, suitable for logging the error indicated by
+     * this object; it will include the path formatted into a human-readable string (if the path is
+     * not empty), and the message.
+     */
+    override fun toString(): String
+
+    /** The "segment" of a path to a field in the response data. */
+    public sealed interface PathSegment {
+
+      /** A named field in a path to a field in the response data. */
+      @JvmInline
+      public value class Field(public val field: String) : PathSegment {
+
+        /**
+         * Returns a string representation of this object, useful for debugging.
+         *
+         * The string representation is _not_ guaranteed to be stable and may change without notice
+         * at any time. Therefore, the only recommended usage of the returned string is debugging
+         * and/or logging. Namely, parsing the returned string or storing the returned string in
+         * non-volatile storage should generally be avoided in order to be robust in case that the
+         * string representation changes.
+         *
+         * @return returns simply [field].
+         */
+        override fun toString(): String = field
+      }
+
+      /** An index of a list in a path to a field in the response data. */
+      @JvmInline
+      public value class ListIndex(public val index: Int) : PathSegment {
+        /**
+         * Returns a string representation of this object, useful for debugging.
+         *
+         * The string representation is _not_ guaranteed to be stable and may change without notice
+         * at any time. Therefore, the only recommended usage of the returned string is debugging
+         * and/or logging. Namely, parsing the returned string or storing the returned string in
+         * non-volatile storage should generally be avoided in order to be robust in case that the
+         * string representation changes.
+         *
+         * @return returns simply the string representation of [index].
+         */
+        override fun toString(): String = index.toString()
+      }
+    }
+  }
+}

firebase-dataconnect/src/main/kotlin/com/google/firebase/dataconnect/DataConnectOperationFailureResponse.kt

@@ -22,7 +22,7 @@ import kotlinx.serialization.encoding.Decoder
 
 internal class DataConnectUntypedData(
   val data: Map<String, Any?>?,
-  val errors: List<DataConnectError>
+  val errors: List<DataConnectOperationFailureResponse.ErrorInfo>
 ) {
 
   override fun equals(other: Any?) =