[graphql-alt] Update Object return type to Option to support partial error response [1/n] by tpham-mysten · Pull Request #24595 · MystenLabs/sui

tpham-mysten · 2025-12-10T22:06:43Z

Description

Add partial error support for GraphQL resolvers in sui-indexer-alt-graphql by changing return types from Result<Option<T>, E> to Option<Result<T, E>> for IObject interface fields.

Key Changes

Return Type Pattern Change:

Changed IObject interface field return types from Result<Option, RpcError> to Option<Result<T, RpcError>>
This enables async-graphql's partial error handling: when a field errors, the field becomes null and the error is recorded, but sibling fields still return data

Files Modified:

object.rs: Updated IObject interface declarations and Object resolvers (version, digest, objectAt, objectBcs, objectVersionsAfter, objectVersionsBefore, owner, previousTransaction, storageRebate, receivedTransactions)
move_object.rs: Updated MoveObject delegation methods with .ok()? pattern
move_package.rs: Updated MovePackage resolvers including packageVersionsAfter, packageVersionsBefore
coin_metadata.rs: Updated CoinMetadata delegation methods
dynamic_field.rs: Updated DynamicField delegation methods

Test plan

How did you test the new or updated feature?

cargo nextest run -p sui-indexer-alt-e2e-tests

Release notes

Check each box that your changes affect. If none of the boxes relate to your changes, release notes aren't required.

For each box you select, include information after the relevant heading that describes the impact of your changes that a user might notice and any actions they must take to implement updates.

Protocol:
Nodes (Validators and Full nodes):
gRPC:
JSON-RPC:
GraphQL: Partial error will be properly supported in GraphQL. Invalid fields will have error messages and valid fields will still be displayed normally
CLI:
Rust SDK:
Indexing Framework:

…error response

vercel · 2025-12-10T22:06:48Z

The latest updates on your projects. Learn more about Vercel for GitHub.

Project	Deployment	Preview	Comments	Updated (UTC)
sui-docs	Ready	Preview	Comment	Dec 12, 2025 3:31pm

2 Skipped Deployments

Project	Deployment	Preview	Comments	Updated (UTC)
multisig-toolkit	Ignored	Preview		Dec 12, 2025 3:31pm
sui-kiosk	Ignored	Preview		Dec 12, 2025 3:31pm

tpham-mysten · 2025-12-10T22:10:15Z

crates/sui-indexer-alt-graphql/src/api/types/coin_metadata.rs

-    pub(crate) async fn version(&self, ctx: &Context<'_>) -> Result<Option<UInt53>, RpcError> {
-        self.super_.version(ctx).await
+    pub(crate) async fn version(&self, ctx: &Context<'_>) -> Option<Result<UInt53, RpcError>> {
+        self.super_.version(ctx).await.ok()?


.ok() is needed because async-graphql's #[Object] macro wraps method returns in Result<_, async_graphql::Error>. When calling a parent's #[Object] method (e.g., self.super_.version(ctx)), the actual return type becomes Result<Option<Result<T, E>>, Error> instead of Option<Result<T, E>>. Using .ok()? discards the outer wrapper and propagates None if the call failed.

amnn

Looks good, it would be nice to use a pattern similar to let Some(...) = self.content(ctx) else { ... } which I've suggested, but that's the only main comment. Thanks @tpham-mysten !

crates/sui-indexer-alt-graphql/src/api/types/move_package.rs

crates/sui-indexer-alt-graphql/src/api/types/object.rs

tpham-mysten

Thanks for the review! I have updated to the pattern

let contents = match self.contents(ctx).await.transpose()? {
            Ok(contents) => contents,
            Err(e) => return Some(Err(e)),
 };

crates/sui-indexer-alt-graphql/src/api/types/move_package.rs

crates/sui-indexer-alt-graphql/src/api/types/object.rs

…t [5/n] (#24684) ## Description Add partial error support for GraphQL resolvers in sui-indexer-alt-graphql by changing return types from Result<Option<T>, E> to Option<Result<T, E>> for MoveModule and MovePackage types. ## Test plan How did you test the new or updated feature? ``` cargo nextest run -p sui-indexer-alt-e2e-tests ``` --- ## Stack: - #24595 - #24681 - #24682 - #24683 - #24684 ⬅️ ## Release notes Check each box that your changes affect. If none of the boxes relate to your changes, release notes aren't required. For each box you select, include information after the relevant heading that describes the impact of your changes that a user might notice and any actions they must take to implement updates. - [ ] Protocol: - [ ] Nodes (Validators and Full nodes): - [ ] gRPC: - [ ] JSON-RPC: - [x] GraphQL: Partial error will be properly supported in GraphQL. Invalid fields will have error messages and valid fields will still be displayed normally - [ ] CLI: - [ ] Rust SDK: - [ ] Indexing Framework:

…n] (#24683) ## Description Add partial error support for GraphQL resolvers in sui-indexer-alt-graphql by changing return types from Result<Option<T>, E> to Option<Result<T, E>> for Epoch, Checkpoint, and Validator types. ## Test plan How did you test the new or updated feature? ``` cargo nextest run -p sui-indexer-alt-e2e-tests ``` --- ## Stack - #24595 - #24681 - #24682 - #24683 ⬅️ - #24684 ## Release notes Check each box that your changes affect. If none of the boxes relate to your changes, release notes aren't required. For each box you select, include information after the relevant heading that describes the impact of your changes that a user might notice and any actions they must take to implement updates. - [ ] Protocol: - [ ] Nodes (Validators and Full nodes): - [ ] gRPC: - [ ] JSON-RPC: - [x] GraphQL: Partial error will be properly supported in GraphQL. Invalid fields will have error messages and valid fields will still be displayed normally - [ ] CLI: - [ ] Rust SDK: - [ ] Indexing Framework:

…rt [3/n] (#24682) ## Description Add partial error support for GraphQL resolvers in sui-indexer-alt-graphql by changing return types from Result<Option<T>, E> to Option<Result<T, E>> for Transaction-related types. ## Test plan How did you test the new or updated feature? ``` cargo nextest run -p sui-indexer-alt-e2e-tests ``` --- # Stack: - #24595 - #24681 - #24682 ⬅️ - #24683 - #24684 ## Release notes Check each box that your changes affect. If none of the boxes relate to your changes, release notes aren't required. For each box you select, include information after the relevant heading that describes the impact of your changes that a user might notice and any actions they must take to implement updates. - [ ] Protocol: - [ ] Nodes (Validators and Full nodes): - [ ] gRPC: - [ ] JSON-RPC: - [x] GraphQL: Partial error will be properly supported in GraphQL. Invalid fields will have error messages and valid fields will still be displayed normally - [ ] CLI: - [ ] Rust SDK: - [ ] Indexing Framework:

…ort [2/n] (#24681) ## Description Enable partial error support in sui-indexer-alt-graphql by changing GraphQL resolver return types from `Result<Option<T>, E>` to `Option<Result<T, E>>.` - Before: When a field returns an error, the entire parent object becomes null - After: When a field returns an error, only that specific field becomes null while sibling fields still return data Changes Pattern Migration Changed ~30 files to use the Option<Result<T, E>> pattern with two main approaches: 1. Async block with transpose: For complex async operations async fn field(&self) -> Option<Result<T, RpcError>> { async { ... Ok(Some(value)) }.await.transpose() } 2. Simple wrapping: For infallible cases async fn field(&self) -> Option<Result<T, RpcError>> { Some(Ok(value)) } Files Modified - Core types: object.rs, address.rs, move_type.rs, move_value.rs, dynamic_field.rs - Transaction types: transaction/mod.rs, transaction_effects.rs, gas_input.rs - Move types: move_module.rs, move_function.rs, move_datatype.rs, move_package.rs, move_object.rs - Epoch/Checkpoint: epoch.rs, checkpoint/mod.rs - Validator: validator.rs, validator_set.rs - Others: coin_metadata.rs, event/mod.rs, unchanged_consensus_object.rs, transaction_kind types ## Test plan How did you test the new or updated feature? ``` cargo nextest run -p sui-indexer-alt-e2e-tests ``` --- ## Stack - #24595 - #24681 - #24682 - #24683 - #24684 ## Release notes Check each box that your changes affect. If none of the boxes relate to your changes, release notes aren't required. For each box you select, include information after the relevant heading that describes the impact of your changes that a user might notice and any actions they must take to implement updates. - [ ] Protocol: - [ ] Nodes (Validators and Full nodes): - [ ] gRPC: - [ ] JSON-RPC: - [x] GraphQL: Partial error will be properly supported in GraphQL. Invalid fields will have error messages and valid fields will still be displayed normally - [ ] CLI: - [ ] Rust SDK: - [ ] Indexing Framework:

…port [6/n] (#25108) ## Description Updates ServiceConfig return types from Result<Option<T>, E> to Option<Result<T, E>> for partial error support. Files changed: - crates/sui-indexer-alt-graphql/src/api/types/service_config.rs ## Test plan ``` cargo nextest run -p sui-indexer-alt-e2e-tests ``` --- ## Stack - #24595 - #24681 - #24682 - #24683 - #24684 - #25108 ⬅️ ## Release notes Check each box that your changes affect. If none of the boxes relate to your changes, release notes aren't required. For each box you select, include information after the relevant heading that describes the impact of your changes that a user might notice and any actions they must take to implement updates. - [ ] Protocol: - [ ] Nodes (Validators and Full nodes): - [ ] gRPC: - [ ] JSON-RPC: - [x] GraphQL: Partial error will be properly supported in GraphQL. Invalid fields will have error messages and valid fields will still be displayed normally - [ ] CLI: - [ ] Rust SDK: - [ ] Indexing Framework:

… return types for partial error support [7/n] (#25109) ## Description Updates `IMoveObject` interface and its implementors (`MoveObject`, `CoinMetadata`, `DynamicField`) return types from `Result<Option<T>, E>` to `Option<Result<T, E>>` for partial error support. Files changed: - crates/sui-indexer-alt-graphql/src/api/types/move_object.rs - crates/sui-indexer-alt-graphql/src/api/types/coin_metadata.rs - crates/sui-indexer-alt-graphql/src/api/types/dynamic_field.rs ## Test plan How did you test the new or updated feature? ``` cargo nextest run -p sui-indexer-alt-e2e-tests ``` --- ## Stack - #24595 - #24681 - #24682 - #24683 - #24684 - #25108 - #25109 ⬅️ ## Release notes Check each box that your changes affect. If none of the boxes relate to your changes, release notes aren't required. For each box you select, include information after the relevant heading that describes the impact of your changes that a user might notice and any actions they must take to implement updates. - [ ] Protocol: - [ ] Nodes (Validators and Full nodes): - [ ] gRPC: - [ ] JSON-RPC: - [x] GraphQL: Partial error will be properly supported in GraphQL. Invalid fields will have error messages and valid fields will still be displayed normally - [ ] CLI: - [ ] Rust SDK: - [ ] Indexing Framework:

…n] (#25110) ## Description Updates `Query` return types from `Result<Option<T>, E>` to `Option<Result<T, E>>` for partial error support. Files changed: - crates/sui-indexer-alt-graphql/src/api/query.rs ## Test plan How did you test the new or updated feature? ``` cargo nextest run -p sui-indexer-alt-e2e-tests ``` --- - #24595 - #24681 - #24682 - #24683 - #24684 - #25108 - #25109 - #25110 ⬅️ ## Release notes Check each box that your changes affect. If none of the boxes relate to your changes, release notes aren't required. For each box you select, include information after the relevant heading that describes the impact of your changes that a user might notice and any actions they must take to implement updates. - [ ] Protocol: - [ ] Nodes (Validators and Full nodes): - [ ] gRPC: - [ ] JSON-RPC: - [x] GraphQL: Partial error will be properly supported in GraphQL. Invalid fields will have error messages and valid fields will still be displayed normally - [ ] CLI: - [ ] Rust SDK: - [ ] Indexing Framework:

[graphql-alt] Update Object return type to Option to support partial …

a4c9ae1

…error response

tpham-mysten requested a review from a team as a code owner December 10, 2025 22:06

tpham-mysten requested review from amnn, emmazzz, evan-wall-mysten, henryachen, nickvikeras and wlmyng December 10, 2025 22:06

tpham-mysten temporarily deployed to sui-typescript-aws-kms-test-env December 10, 2025 22:06 — with GitHub Actions Inactive

tpham-mysten commented Dec 10, 2025

View reviewed changes

amnn approved these changes Dec 11, 2025

View reviewed changes

crates/sui-indexer-alt-graphql/src/api/types/move_package.rs Show resolved Hide resolved

crates/sui-indexer-alt-graphql/src/api/types/object.rs Outdated Show resolved Hide resolved

crates/sui-indexer-alt-graphql/src/api/types/object.rs Outdated Show resolved Hide resolved

Update contents pattern

6035105

tpham-mysten temporarily deployed to sui-typescript-aws-kms-test-env December 12, 2025 15:30 — with GitHub Actions Inactive

vercel bot deployed to Preview – sui-docs December 12, 2025 15:31 View deployment

tpham-mysten commented Dec 12, 2025

View reviewed changes

crates/sui-indexer-alt-graphql/src/api/types/move_package.rs Show resolved Hide resolved

crates/sui-indexer-alt-graphql/src/api/types/object.rs Outdated Show resolved Hide resolved

crates/sui-indexer-alt-graphql/src/api/types/object.rs Outdated Show resolved Hide resolved

tpham-mysten merged commit 9e87d01 into main Dec 15, 2025
56 of 57 checks passed

tpham-mysten deleted the tpham-object-partial-error-graphql branch December 15, 2025 02:44

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[graphql-alt] Update Object return type to Option to support partial error response [1/n]#24595

[graphql-alt] Update Object return type to Option to support partial error response [1/n]#24595
tpham-mysten merged 2 commits intomainfrom
tpham-object-partial-error-graphql

tpham-mysten commented Dec 10, 2025

Uh oh!

vercel bot commented Dec 10, 2025 •

edited

Loading

Uh oh!

tpham-mysten Dec 10, 2025

Uh oh!

amnn left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

tpham-mysten left a comment •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

tpham-mysten commented Dec 10, 2025

Description

Test plan

Release notes

Uh oh!

vercel bot commented Dec 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

tpham-mysten Dec 10, 2025

Choose a reason for hiding this comment

Uh oh!

amnn left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

tpham-mysten left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

vercel bot commented Dec 10, 2025 •

edited

Loading

tpham-mysten left a comment •

edited

Loading