Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[GraphQL] Remove "Live" ObjectKind, rename "Historical" to "Indexed" #17313

Merged
merged 1 commit into from
Apr 24, 2024

Conversation

amnn
Copy link
Member

@amnn amnn commented Apr 24, 2024

Description

With the removal of direct accesses to the objects table, the nomenclature we use around object kinds ("not indexed", "live", "historical", "deleted or wrapped") is less relevant. In particular, we never use "live" and the name "historical" is confusing because even the latest version of the object may be considered "historical".

This PR removes the "live" kind, and renames "historical" to "indexed" to better reflect how the users of GraphQL perceive the kinds of objects, rather than how the data is stored in the indexer's tables.

Test plan

sui$ cargo nextest run -p sui-graphql-rpc
sui$ cargo nextest run -p sui-graphql-e2e-tests --features pg_integration

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):
  • Indexer:
  • JSON-RPC:
  • GraphQL: There is no longer a Live or Historical ObjectKind. Instead, there is a single Indexed kind representing any object that has been fetched from the index (as opposed to an object that we have information about but that hasn't been indexed yet, or an object that has been deleted or wrapped so is not available).
  • CLI:
  • Rust SDK:

## Description

With the removal of direct accesses to the `objects` table, the
nomenclature we use around object kinds ("not indexed", "live",
"historical", "deleted or wrapped") is less relevant. In particular,
we never use "live" and the name "historical" is confusing because
even the latest version of the object may be considered "historical".

This PR removes the "live" kind, and renames "historical" to "indexed"
to better reflect how the users of GraphQL perceive the kinds of
objects, rather than how the data is stored in the indexer's tables.

## Test plan

```
sui$ cargo nextest run -p sui-graphql-rpc
sui$ cargo nextest run -p sui-graphql-e2e-tests --features pg_integration
```
@amnn amnn requested a review from a team April 24, 2024 11:55
@amnn amnn self-assigned this Apr 24, 2024
Copy link

vercel bot commented Apr 24, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

3 Ignored Deployments
Name Status Preview Updated (UTC)
multisig-toolkit ⬜️ Ignored (Inspect) Apr 24, 2024 11:55am
sui-kiosk ⬜️ Ignored (Inspect) Apr 24, 2024 11:55am
sui-typescript-docs ⬜️ Ignored (Inspect) Apr 24, 2024 11:55am

@amnn
Copy link
Member Author

amnn commented Apr 24, 2024

Note that this PR is introducing a breaking change, so I will not be cherry-picking it.

Copy link
Contributor

@stefan-mysten stefan-mysten left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

@amnn amnn merged commit 74edad3 into main Apr 24, 2024
46 of 47 checks passed
@amnn amnn deleted the amnn/gql-indexed branch April 24, 2024 21:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants