[graphql-alt] Update IAddressable return types for partial error support [2/n] by tpham-mysten · Pull Request #24681 · MystenLabs/sui

tpham-mysten · 2025-12-18T05:36:38Z

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

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

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:

vercel · 2025-12-18T05:36:43Z

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

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

2 Skipped Deployments

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

amnn · 2025-12-18T12:01:57Z

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

        before: Option<balance::Cursor>,
-    ) -> Result<Option<Connection<String, Balance>>, RpcError<balance::Error>> {
-        let pagination: &PaginationConfig = ctx.data()?;
+    ) -> Option<Result<Connection<String, Balance>, RpcError<balance::Error>>> {


This makes me wonder if it might be better to pull these functions out into a separate impl block that returns Result<Option<...>, ...> and then here we call that function and transpose the result.

Or I wonder if you could use your async { ... } trick here?

Yes I have applied the async pattern we discussed on other PR

tpham-mysten

Thanks for the review!

tpham-mysten · 2025-12-30T18:15:09Z

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

        before: Option<balance::Cursor>,
-    ) -> Result<Option<Connection<String, Balance>>, RpcError<balance::Error>> {
-        let pagination: &PaginationConfig = ctx.data()?;
+    ) -> Option<Result<Connection<String, Balance>, RpcError<balance::Error>>> {


Yes I have applied the async pattern we discussed on other PR

…ort [2/n]

…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:

…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:

tpham-mysten requested a review from a team as a code owner December 18, 2025 05:36

tpham-mysten requested review from amnn, emmazzz, evan-wall-mysten, henryachen, nickvikeras and wlmyng December 18, 2025 05:36

tpham-mysten temporarily deployed to sui-typescript-aws-kms-test-env December 18, 2025 05:36 — with GitHub Actions Inactive

amnn approved these changes Dec 18, 2025

View reviewed changes

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

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

tpham-mysten commented Dec 30, 2025

View reviewed changes

tpham-mysten added 2 commits December 30, 2025 14:18

[graphql-alt] Update IAddressable return types for partial error supp…

0c39e36

…ort [2/n]

apply new async block transpose pattern

236bdf2

tpham-mysten force-pushed the tpham-partial-error-iaddressable branch from c030c27 to 236bdf2 Compare December 30, 2025 19:19

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

vercel bot deployed to Preview – sui-docs December 30, 2025 19:21 View deployment

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

vercel bot deployed to Preview – sui-docs December 30, 2025 22:44 View deployment

tpham-mysten temporarily deployed to sui-typescript-aws-kms-test-env December 31, 2025 04:13 — with GitHub Actions Inactive

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

Migrate remaining fields

d6c8b65

tpham-mysten force-pushed the tpham-partial-error-iaddressable branch from 7309fb8 to d6c8b65 Compare December 31, 2025 04:19

tpham-mysten temporarily deployed to sui-typescript-aws-kms-test-env December 31, 2025 04:19 — with GitHub Actions Inactive

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

update new snapshot test

78f513d

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

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

tpham-mysten merged commit b079752 into main Dec 31, 2025
55 of 57 checks passed

tpham-mysten deleted the tpham-partial-error-iaddressable branch December 31, 2025 20:10

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[graphql-alt] Update IAddressable return types for partial error support [2/n]#24681

[graphql-alt] Update IAddressable return types for partial error support [2/n]#24681
tpham-mysten merged 5 commits intomainfrom
tpham-partial-error-iaddressable

tpham-mysten commented Dec 18, 2025 •

edited

Loading

Uh oh!

vercel bot commented Dec 18, 2025 •

edited

Loading

Uh oh!

amnn Dec 18, 2025

Uh oh!

amnn Dec 18, 2025

Uh oh!

tpham-mysten Dec 30, 2025

Uh oh!

tpham-mysten left a comment

Uh oh!

tpham-mysten Dec 30, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

tpham-mysten commented Dec 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Test plan

Stack

Release notes

Uh oh!

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

Uh oh!

Uh oh!

amnn Dec 18, 2025

Choose a reason for hiding this comment

Uh oh!

amnn Dec 18, 2025

Choose a reason for hiding this comment

Uh oh!

tpham-mysten Dec 30, 2025

Choose a reason for hiding this comment

Uh oh!

tpham-mysten left a comment

Choose a reason for hiding this comment

Uh oh!

tpham-mysten Dec 30, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

tpham-mysten commented Dec 18, 2025 •

edited

Loading

vercel bot commented Dec 18, 2025 •

edited

Loading