feat: dataconnect: DataConnectOperationException added to support partial errors #6794

dconeybe · 2025-03-21T21:27:20Z

This PR adds the DataConnectOperationException class, a subclass of the previously-existing DataConnectException class. This new DataConnectOperationException class is thrown by invocations of QueryRef.execute() and MutationRef.execute() in the case where a response is received from the backend, but the response indicates that the operation could not be executed to completion, including the case that the client SDK fails to decode the response to a higher-level object. Other kinds of errors, such as networking errors, will still be reported as they were previously.

Client code can catch DataConnectOperationException and check its response property to get details about any errors that occurred and any data that was received. If the data was able to be decoded, despite the errors, then it will be available. Also the "raw" data (a Map<String, Any?>) property will give access to the raw, undecoded data, if any was sent from the backend.

This feature is intended to support "partial errors", where an operation can partially succeed and partially fail, and the client application wants to take some special behavior in the case of a partial success.

For example, suppose this database schema and connector definition:

type Person @table {
  name: String!
}

# Notice how both "inserts" use the same ID; this means that one of them
# will necessarily fail because you can't have two rows with the same ID.
mutation InsertMultiplePeople($id: UUID!, $name1: String!, $name2: String!) {
  person1: person_insert(data: { id: $id, name: $name1 })
  person2: person_insert(data: { id: $id, name: $name2 })
}

Here is some code that handles the partial error that will occur if this mutation were to ever be executed:

import com.google.firebase.dataconnect.DataConnectOperationException
import com.google.firebase.dataconnect.DataConnectOperationFailureResponse
import com.google.firebase.dataconnect.DataConnectPathSegment
import com.myapp.myconnector.InsertTwoFoosWithSameIdMutation.Data

suspend fun demo(id: UUID, connector: DemoConnector): Data {
  val result = connector.insertTwoFoosWithSameId.runCatching { execute(id) }
  result.onSuccess {
    println("Weird... inserting _both_ entries with ID $id succeeded 🤷")
    return@demo it.data
  }

  val exception = result.exceptionOrNull()!!
  if (exception !is DataConnectOperationException) {
    throw exception
  }

  // Print warnings messages about which of "foo1" and "foo2" failed to
  // be inserted by the query. This information is gleaned from the list of
  // errors provided in the DataConnectOperationFailureResponse.
  val response: DataConnectOperationFailureResponse<*> = exception.response
  val errors = response.errors

  val error1 = errors.firstOrNull {
    it.path == listOf(DataConnectPathSegment.Field("person1"))
  }
  if (error1 == null) {
    println("Inserting 1st entry with ID $id succeeded")
  } else {
    println("Inserting 1st entry with ID $id failed: ${error1.message}")
  }

  val error2 = errors.firstOrNull 
    it.path == listOf(DataConnectPathSegment.Field("person2"))
  }
  if (error2 == null) {
    println("Inserting 2nd entry with ID $id succeeded")
  } else {
    println("Inserting 2nd entry with ID $id failed: ${error2.message}")
  }

  // If decoding the response was actually successful, then return
  // the decoded response.
  val data = response.data as? Data
  if (data != null) {
    return data
  }

  throw exception
}

…se DataConnectOperationException instead of DataConnectException

…deserialize()

github-actions · 2025-03-21T21:27:33Z

📝 PRs merging into main branch

Our main branch should always be in a releasable state. If you are working on a larger change, or if you don't want this change to see the light of the day just yet, consider using a feature branch first, and only merge into the main branch when the code complete and ready to be released.

github-actions · 2025-03-21T21:27:34Z

📝 PRs merging into main branch

Our main branch should always be in a releasable state. If you are working on a larger change, or if you don't want this change to see the light of the day just yet, consider using a feature branch first, and only merge into the main branch when the code complete and ready to be released.

google-oss-bot · 2025-03-21T21:36:35Z

Coverage Report ¹

Affected Products

`firebase-dataconnect`

Overall coverage changed from ? (75be716) to 14.80% (a0fc704) by ?.

60 individual files with coverage change

Filename	Base (`75be716`)	Merge (`a0fc704`)	Diff
AlphanumericStringUtil.kt	?	0.00%	?
AnyValue.kt	?	0.00%	?
AnyValueSerializer.kt	?	0.00%	?
Comparisons.kt	?	0.00%	?
ConnectorConfig.kt	?	33.33%	?
CoroutineExceptionHandler.kt	?	50.00%	?
DataConnectAppCheck.kt	?	71.43%	?
DataConnectAuth.kt	?	71.43%	?
DataConnectCredentialsTokenManager.kt	?	32.32%	?
DataConnectException.kt	?	0.00%	?
DataConnectGrpcClient.kt	?	0.00%	?
DataConnectGrpcMetadata.kt	?	65.82%	?
DataConnectGrpcRPCs.kt	?	0.00%	?
DataConnectOperationException.kt	?	0.00%	?
DataConnectOperationFailureResponse.kt	?	0.00%	?
DataConnectOperationFailureResponseImpl.kt	?	0.00%	?
DataConnectPathSegment.kt	?	0.00%	?
DataConnectSettings.kt	?	33.33%	?
DataConnectUntypedData.kt	?	0.00%	?
DataConnectUntypedVariables.kt	?	0.00%	?
ExperimentalFirebaseDataConnect.kt	?	0.00%	?
FirebaseDataConnect.kt	?	50.00%	?
FirebaseDataConnectFactory.kt	?	29.17%	?
FirebaseDataConnectImpl.kt	?	46.67%	?
FirebaseDataConnectRegistrar.kt	?	100.00%	?
GeneratedConnector.kt	?	0.00%	?
GeneratedMutation.kt	?	0.00%	?
GeneratedOperation.kt	?	0.00%	?
GeneratedQuery.kt	?	0.00%	?
Globals.kt	?	0.00%	?
JavaTimeLocalDateSerializer.kt	?	0.00%	?
KotlinxDatetimeLocalDateSerializer.kt	?	0.00%	?
LiveQueries.kt	?	0.00%	?
LiveQuery.kt	?	0.00%	?
LocalDate.kt	?	0.00%	?
LocalDateSerializer.kt	?	0.00%	?
Logger.kt	?	73.68%	?
LogLevel.kt	?	72.73%	?
MutationRef.kt	?	0.00%	?
MutationRefImpl.kt	?	12.36%	?
NullableReference.kt	?	40.00%	?
NullOutputStream.kt	?	0.00%	?
OperationRef.kt	?	0.00%	?
OperationRefImpl.kt	?	20.45%	?
OptionalVariable.kt	?	0.00%	?
ProtoStructDecoder.kt	?	0.00%	?
ProtoStructEncoder.kt	?	0.00%	?
ProtoUtil.kt	?	0.00%	?
QueryManager.kt	?	0.00%	?
QueryRef.kt	?	0.00%	?
QueryRefImpl.kt	?	14.08%	?
QuerySubscription.kt	?	0.00%	?
QuerySubscriptionImpl.kt	?	0.00%	?
QuerySubscriptionInternal.kt	?	0.00%	?
ReferenceCounted.kt	?	0.00%	?
RegisteredDataDeserialzer.kt	?	0.00%	?
SequencedReference.kt	?	0.00%	?
SuspendingLazy.kt	?	31.58%	?
TimestampSerializer.kt	?	0.00%	?
UUIDSerializer.kt	?	0.00%	?

Test Logs

Merge (a0fc704): https://github.com/firebase/firebase-android-sdk/actions/runs/14045186306

https://storage.googleapis.com/firebase-sdk-metric-reports/GHhmZyVInw.html

google-oss-bot · 2025-03-21T21:37:13Z

The public api surface has changed for the subproject firebase-dataconnect_api.txt:

Please update the api.txt files for the subprojects being affected by this change by running ./gradlew ${subproject}:generateApiTxtFile. Also perform a major/minor bump accordingly.

google-oss-bot · 2025-03-21T21:37:33Z

The public api surface has changed for the subproject firebase-dataconnect_api.txt:

Please update the api.txt files for the subprojects being affected by this change by running ./gradlew ${subproject}:generateApiTxtFile. Also perform a major/minor bump accordingly.

github-actions · 2025-03-21T21:39:11Z

Test Results

66 files + 2 66 suites +2 1m 16s ⏱️ +4s
552 tests +10 551 ✅ +10 1 💤 ±0 0 ❌ ±0
1 104 runs +20 1 102 ✅ +20 2 💤 ±0 0 ❌ ±0

Results for commit 3b00fb4. ± Comparison against base commit 75be716.

This pull request removes 40 and adds 50 tests. Note that renamed tests count towards both.

com.google.firebase.dataconnect.DataConnectErrorUnitTest ‑ equals() should return false for a different type
com.google.firebase.dataconnect.DataConnectErrorUnitTest ‑ equals() should return false for null
com.google.firebase.dataconnect.DataConnectErrorUnitTest ‑ equals() should return false when locations differ
com.google.firebase.dataconnect.DataConnectErrorUnitTest ‑ equals() should return false when message differs only in character case
com.google.firebase.dataconnect.DataConnectErrorUnitTest ‑ equals() should return false when only message differs
com.google.firebase.dataconnect.DataConnectErrorUnitTest ‑ equals() should return false when path differs
com.google.firebase.dataconnect.DataConnectErrorUnitTest ‑ equals() should return true for an equal instance
com.google.firebase.dataconnect.DataConnectErrorUnitTest ‑ equals() should return true for the exact same instance
com.google.firebase.dataconnect.DataConnectErrorUnitTest ‑ hashCode() should return a different value if locations is different
com.google.firebase.dataconnect.DataConnectErrorUnitTest ‑ hashCode() should return a different value if message is different
…

com.google.firebase.dataconnect.DataConnectPathSegmentFieldUnitTest ‑ constructor should set field property
com.google.firebase.dataconnect.DataConnectPathSegmentFieldUnitTest ‑ equals() should return false for a different type
com.google.firebase.dataconnect.DataConnectPathSegmentFieldUnitTest ‑ equals() should return false for null
com.google.firebase.dataconnect.DataConnectPathSegmentFieldUnitTest ‑ equals() should return false when field differs
com.google.firebase.dataconnect.DataConnectPathSegmentFieldUnitTest ‑ equals() should return true for an equal instance
com.google.firebase.dataconnect.DataConnectPathSegmentFieldUnitTest ‑ equals() should return true for the exact same instance
com.google.firebase.dataconnect.DataConnectPathSegmentFieldUnitTest ‑ hashCode() should return a different value if field is different
com.google.firebase.dataconnect.DataConnectPathSegmentFieldUnitTest ‑ hashCode() should return the same value each time it is invoked on a given object
com.google.firebase.dataconnect.DataConnectPathSegmentFieldUnitTest ‑ hashCode() should return the same value on equal objects
com.google.firebase.dataconnect.DataConnectPathSegmentFieldUnitTest ‑ toString() should return a string equal to the field property
…

♻️ This comment has been updated with latest results.

google-oss-bot · 2025-03-21T21:39:23Z

Size Report ¹

Affected Products

firebase-dataconnect
Type Base (75be716) Merge (a0fc704) Diff
aar 708 kB 712 kB +3.01 kB (+0.4%)
apk (release) 10.0 MB 10.0 MB +5.84 kB (+0.1%)

Test Logs

https://storage.googleapis.com/firebase-sdk-metric-reports/hl61Mc2kwl.html

firebase-dataconnect/api.txt

google-oss-bot · 2025-03-24T15:01:42Z

The public api surface has changed for the subproject firebase-dataconnect_api.txt:

Please update the api.txt files for the subprojects being affected by this change by running ./gradlew ${subproject}:generateApiTxtFile. Also perform a major/minor bump accordingly.

# Conflicts: # firebase-dataconnect/CHANGELOG.md

google-oss-bot · 2025-03-24T15:07:54Z

The public api surface has changed for the subproject firebase-dataconnect_api.txt:

Please update the api.txt files for the subprojects being affected by this change by running ./gradlew ${subproject}:generateApiTxtFile. Also perform a major/minor bump accordingly.

google-oss-bot · 2025-03-24T15:15:48Z

The public api surface has changed for the subproject firebase-dataconnect_api.txt:

Please update the api.txt files for the subprojects being affected by this change by running ./gradlew ${subproject}:generateApiTxtFile. Also perform a major/minor bump accordingly.

dconeybe · 2025-03-24T16:20:54Z

The public api surface has changed for the subproject firebase-dataconnect_api.txt:

Please update the api.txt files for the subprojects being affected by this change by running ./gradlew ${subproject}:generateApiTxtFile. Also perform a major/minor bump accordingly.

dconeybe · 2025-03-24T16:29:11Z

The public api surface has changed for the subproject firebase-dataconnect_api.txt:

Please update the api.txt files for the subprojects being affected by this change by running ./gradlew ${subproject}:generateApiTxtFile. Also perform a major/minor bump accordingly.

dconeybe · 2025-03-24T16:33:04Z

The public api surface has changed for the subproject firebase-dataconnect_api.txt:

Please update the api.txt files for the subprojects being affected by this change by running ./gradlew ${subproject}:generateApiTxtFile. Also perform a major/minor bump accordingly.

dconeybe · 2025-03-24T16:36:22Z

The public api surface has changed for the subproject firebase-dataconnect_api.txt:

Please update the api.txt files for the subprojects being affected by this change by running ./gradlew ${subproject}:generateApiTxtFile. Also perform a major/minor bump accordingly.

dconeybe · 2025-03-24T16:45:14Z

The public api surface has changed for the subproject firebase-dataconnect_api.txt:

Please update the api.txt files for the subprojects being affected by this change by running ./gradlew ${subproject}:generateApiTxtFile. Also perform a major/minor bump accordingly.

dconeybe · 2025-03-24T16:58:35Z

There are two failing GitHub Actions, both of which ave been identified as false positives:

[API Information / api-information-check (pull_request)](https://github.com/firebase/firebase-android-sdk/actions/runs/14038742853/job/39303279776?pr=6794) is failing because the output of a gradle command happens to contain the string "error", which is being taken as an API change that needs to be accounted for; however, this is a false positive and the heuristic in [api_information.py](https://github.com/firebase/firebase-android-sdk/blob/c1ca0210b83f8d94eea14ee1ffe29a98aac154ca/ci/fireci/fireciplugins/api_information.py#L40) should be improved to detect api errors.
Metalava SemVer Check / semver-check (pull_request) is failing because it is erroneously not considering dropping the "beta" suffix of the version as a major version bump.

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

…reResponse.ErrorInfo.PathSegment moved to a top-level class

dconeybe added 6 commits March 20, 2025 20:49

DataConnectOperationException added

9b4331a

DataConnectGrpcClient.kt: re-write OperationResult.deserialize() to u…

77ce8df

…se DataConnectOperationException instead of DataConnectException

DataConnectGrpcClientUnitTest.kt: add unit tests for OperationResult.…

f51a55a

…deserialize()

OperationExecutionErrorsIntegrationTest.kt added

14d0c5b

Merge remote-tracking branch 'origin/main' into PartialErrors

b81e610

CHANGELOG.md: entry added

b09555b

dconeybe added main-merge-ack api: dataconnect labels Mar 21, 2025

dconeybe self-assigned this Mar 21, 2025

google-oss-bot added the size/XXL label Mar 21, 2025

CHANGELOG.md: update PR number in changelog entry

25fd751

dconeybe changed the title ~~dataconnect: DataConnectOperationException added to support partial errors~~ feat: dataconnect: DataConnectOperationException added to support partial errors Mar 21, 2025

dconeybe requested a review from aashishpatil-g March 21, 2025 21:36

aashishpatil-g reviewed Mar 21, 2025

View reviewed changes

firebase-dataconnect/api.txt Show resolved Hide resolved

dconeybe added 2 commits March 24, 2025 10:50

Merge remote-tracking branch 'origin/main' into PartialErrors

3165b90

Merge remote-tracking branch 'origin/main' into PartialErrors

9c02c16

Merge remote-tracking branch 'origin/main' into PartialErrors

2adcf59

# Conflicts: # firebase-dataconnect/CHANGELOG.md

aashishpatil-g reviewed Mar 24, 2025

View reviewed changes

...nnect/src/main/kotlin/com/google/firebase/dataconnect/DataConnectOperationFailureResponse.kt Outdated Show resolved Hide resolved

DataConnectPathSegment.kt created, which is DataConnectOperationFailu…

d036552

…reResponse.ErrorInfo.PathSegment moved to a top-level class

dconeybe force-pushed the dconeybe/dataconnect/PartialErrors branch from

feat: dataconnect: DataConnectOperationException added to support partial errors #6794

feat: dataconnect: DataConnectOperationException added to support partial errors #6794

Uh oh!

Conversation

dconeybe commented Mar 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented Mar 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

📝 PRs merging into main branch

Uh oh!

github-actions bot commented Mar 21, 2025

📝 PRs merging into main branch

Uh oh!

google-oss-bot commented Mar 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Coverage Report 1

Affected Products

firebase-dataconnect

Test Logs

Uh oh!

google-oss-bot commented Mar 21, 2025

Uh oh!

google-oss-bot commented Mar 21, 2025

Uh oh!

github-actions bot commented Mar 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Test Results

Uh oh!

google-oss-bot commented Mar 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Size Report 1

Affected Products

firebase-dataconnect

Test Logs

Uh oh!

Uh oh!

google-oss-bot commented Mar 24, 2025

Uh oh!

google-oss-bot commented Mar 24, 2025

Uh oh!

google-oss-bot commented Mar 24, 2025

Uh oh!

dconeybe commented Mar 24, 2025

Uh oh!

dconeybe commented Mar 24, 2025

Uh oh!

dconeybe commented Mar 24, 2025

Uh oh!

dconeybe commented Mar 24, 2025

Uh oh!

dconeybe commented Mar 24, 2025

Uh oh!

dconeybe commented Mar 24, 2025

Uh oh!

Uh oh!

dconeybe commented Mar 21, 2025 •

edited

Loading

github-actions bot commented Mar 21, 2025 •

edited

Loading

google-oss-bot commented Mar 21, 2025 •

edited

Loading

Coverage Report ¹

`firebase-dataconnect`

github-actions bot commented Mar 21, 2025 •

edited

Loading

google-oss-bot commented Mar 21, 2025 •

edited

Loading

Size Report ¹

`firebase-dataconnect`