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/MovePackage] Paginate by version #17697

Merged
merged 3 commits into from
Aug 19, 2024

Conversation

amnn
Copy link
Member

@amnn amnn commented May 13, 2024

Description

Introduce two new queries: Query.packageVersions and MovePackage.versions for iterating over all the different versions of a given package.

This kind of query is useful for understanding package history.

These were introduced as a separate query, instead of having a single query for iterating over packages that could optionally take a checkpoint bounds or version bounds because of how system packages interact with the packages table:

Because system packages are updated in-place, they only have one row in the packages table. This makes sense for paginating packages in bulk (e.g. by checkpoint) where the primary aim is to get a snapshot of the packages available at a certain point in time, but doesn't work for answering package version queries for system packages, and it prevents us from creating a combined query. A combined query would also allow someone to create a filter that bounds checkpoints and versions, but doesn't bound the package itself (or would require us to prevent that combination), which is complicated to implement efficiently and not particularly useful.

Test plan

New E2E tests:

sui$ cargo nextest run -p sui-graphql-e2e-tests \
  --features pg_integration                     \
  -- packages/versioning

& Testing against a read replica to make sure system package tests work well, and performance is reasonable.

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):
  • Indexer:
  • JSON-RPC:
  • GraphQL: Introduces Query.packageVersions and MovePackage.versions for paginating over the versions of a particular package.
  • CLI:
  • Rust SDK:

@amnn amnn requested review from manolisliolios and a team May 13, 2024 15:47
@amnn amnn self-assigned this May 13, 2024
Copy link

vercel bot commented May 13, 2024

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

Name Status Preview Comments Updated (UTC)
multisig-toolkit ✅ Ready (Inspect) Visit Preview 💬 Add feedback Aug 19, 2024 10:55am
sui-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Aug 19, 2024 10:55am
sui-kiosk ✅ Ready (Inspect) Visit Preview 💬 Add feedback Aug 19, 2024 10:55am
sui-typescript-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Aug 19, 2024 10:55am

Copy link
Contributor

@wlmyng wlmyng left a comment

Choose a reason for hiding this comment

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

reasoning for keeping this and paginate by checkpoint separate makes sense to me. also neat trick on the system package versioning by joining to objects_history table

@amnn amnn force-pushed the amnn/gql-pkg-cp-page branch from d1c9a77 to e7eb5e6 Compare May 14, 2024 11:15
@amnn amnn requested a review from ronny-mysten as a code owner May 14, 2024 11:15
@amnn amnn force-pushed the amnn/gql-pkg-v-page branch from 2a46ffd to 7bb6a1c Compare May 14, 2024 11:15
@amnn amnn force-pushed the amnn/gql-pkg-cp-page branch from e7eb5e6 to 948e083 Compare May 14, 2024 11:51
@amnn amnn force-pushed the amnn/gql-pkg-v-page branch from 7bb6a1c to befe3c4 Compare May 14, 2024 11:51
@amnn amnn force-pushed the amnn/gql-pkg-cp-page branch from 948e083 to eaecde5 Compare May 15, 2024 10:13
@amnn amnn force-pushed the amnn/gql-pkg-v-page branch from befe3c4 to 1505ac9 Compare May 15, 2024 10:13
@amnn amnn force-pushed the amnn/gql-pkg-v-page branch from 1505ac9 to 168a824 Compare August 15, 2024 19:38
@amnn amnn force-pushed the amnn/gql-pkg-cp-page branch from eaecde5 to 10222bd Compare August 15, 2024 19:38
@amnn amnn force-pushed the amnn/gql-pkg-cp-page branch from 10222bd to fd70156 Compare August 16, 2024 13:16
@amnn amnn force-pushed the amnn/gql-pkg-v-page branch from 168a824 to 8d5c7e8 Compare August 16, 2024 13:16
@amnn amnn force-pushed the amnn/gql-pkg-cp-page branch from fd70156 to 70899b2 Compare August 19, 2024 10:32
@amnn amnn force-pushed the amnn/gql-pkg-v-page branch from 8d5c7e8 to cfd89da Compare August 19, 2024 10:33
@amnn amnn force-pushed the amnn/gql-pkg-cp-page branch from 70899b2 to ff95daf Compare August 19, 2024 10:40
amnn added a commit that referenced this pull request Aug 19, 2024
## Description

Remove commands to generate examples, markdown and schema from the main
binary as we do not use them:

- Instead of generating examples, we have hand-crafted examples in our
docs. Removing this code also removes a test that forces regeneration of
a markdown file from these docs (which we also were not using).
- We also never used the output from the `generate-schema` sub-command,
because the schema was always available as a file, or via introspection
commands from the running service.
- Logic for gathering examples to test has been moved into the test
file, to avoid including test-only code in the main library.

## Test plan

CI

## Description 

Describe the changes or additions included in this PR.

## Test plan 

How did you test the new or updated feature?

## Stack

- #17543
- #17692 
- #17693 
- #17696 
- #17697 

---

## 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: 
- [x] GraphQL: The GraphQL binary no longer supports generating
examples, or exporting its own schema as these commands have been unused
for some time.
- [ ] CLI: 
- [ ] Rust SDK:
@amnn amnn requested a review from a team as a code owner August 19, 2024 10:41
amnn added a commit that referenced this pull request Aug 19, 2024
## Description

Remove commands to generate examples, markdown and schema from the main
binary as we do not use them:

- Instead of generating examples, we have hand-crafted examples in our
docs. Removing this code also removes a test that forces regeneration of
a markdown file from these docs (which we also were not using).
- We also never used the output from the `generate-schema` sub-command,
because the schema was always available as a file, or via introspection
commands from the running service.
- Logic for gathering examples to test has been moved into the test
file, to avoid including test-only code in the main library.

## Test plan

CI

## Description 

Describe the changes or additions included in this PR.

## Test plan 

How did you test the new or updated feature?

## Stack

- #17543
- #17692 
- #17693 
- #17696 
- #17697 

---

## 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: 
- [x] GraphQL: The GraphQL binary no longer supports generating
examples, or exporting its own schema as these commands have been unused
for some time.
- [ ] CLI: 
- [ ] Rust SDK:
@amnn amnn force-pushed the amnn/gql-pkg-v-page branch from 41373b3 to 6538bcd Compare August 19, 2024 10:49
## Description

Introduce two new queries: `Query.packageVersions` and
`MovePackage.versions` for iterating over all the different versions of
a given package.

This kind of query is useful for understanding package history.

These were introduced as a separate query, instead of having a single
query for iterating over packages that could optionally take a
checkpoint bounds or version bounds because of how system packages
interact with the `packages` table:

Because system packages are updated in-place, they only have one row in
the `packages` table. This makes sense for paginating packages in bulk
(e.g. by checkpoint) where the primary aim is to get a snapshot of the
packages available at a certain point in time, but doesn't work for
answering package version queries for system packages, and it prevents
us from creating a combined query. A combined query would also allow
someone to create a filter that bounds checkpoints and versions, but
doesn't bound the package itself (or would require us to prevent that
combination), which is complicated to implement efficiently and not
particularly useful.

## Test plan

New E2E tests:

```
sui$ cargo nextest run -p sui-graphql-e2e-tests \
  --features pg_integration                     \
  -- packages/versioning
```

& Testing against a read replica to make sure system package tests work
well, and performance is reasonable.

##  Stack

- #17686
- #17687
- #17688
- #17689
- #17691
- #17694
- #17695
- #17542
- #17690
- #17543
- #17692
- #17693
- #17696

---

## 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:
- [x] GraphQL: Introduces `Query.packageVersions` and
`MovePackage.versions` for paginating over the versions of a particular
package.
- [ ] CLI:
- [ ] Rust SDK:
amnn added 2 commits August 19, 2024 11:49
## Description

Remove commands to generate examples, markdown and schema from the main
binary as we do not use them:

- Instead of generating examples, we have hand-crafted examples in our
docs. Removing this code also removes a test that forces regeneration of
a markdown file from these docs (which we also were not using).
- We also never used the output from the `generate-schema` sub-command,
because the schema was always available as a file, or via introspection
commands from the running service.
- Logic for gathering examples to test has been moved into the test
file, to avoid including test-only code in the main library.

## Test plan

CI

## Description 

Describe the changes or additions included in this PR.

## Test plan 

How did you test the new or updated feature?

## Stack

- #17543
- #17692 
- #17693 
- #17696 
- #17697 

---

## 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: 
- [x] GraphQL: The GraphQL binary no longer supports generating
examples, or exporting its own schema as these commands have been unused
for some time.
- [ ] CLI: 
- [ ] Rust SDK:
## Description

Remove `draft_target_schema.graphql` and promote
`current_progress_schema.graphql` to be the canonical schema for the
service -- move it to the top-level of the `sui-graphql-rpc` crate to
make it easier to find. This is to avoid confusion about source of truth
for the GraphQL schema.

Because the TS SDK references the schema at multiple GraphQL versions,
we will need to cherry-pick this change to release branches when it
lands.

## Test plan

CI

## Stack

- #17543
- #17692 
- #17693 
- #17696 
- #18287 

---

## 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: 
- [x] GraphQL: The schema file has been moved from
`crates/sui-graphql-rpc/schemas/current_progress_schema.graphql` to
`crates/sui-graphql-rpc/schema.graphql`.
- [ ] CLI: 
- [ ] Rust SDK:
@amnn amnn force-pushed the amnn/gql-pkg-v-page branch from 6538bcd to fb94724 Compare August 19, 2024 10:50
@amnn amnn merged commit 2865a36 into amnn/gql-obj-versions Aug 19, 2024
11 of 15 checks passed
amnn added a commit that referenced this pull request Aug 19, 2024
## Description

Introduce two new queries: `Query.packageVersions` and
`MovePackage.versions` for iterating over all the different versions of
a given package.

This kind of query is useful for understanding package history.

These were introduced as a separate query, instead of having a single
query for iterating over packages that could optionally take a
checkpoint bounds or version bounds because of how system packages
interact with the `packages` table:

Because system packages are updated in-place, they only have one row in
the `packages` table. This makes sense for paginating packages in bulk
(e.g. by checkpoint) where the primary aim is to get a snapshot of the
packages available at a certain point in time, but doesn't work for
answering package version queries for system packages, and it prevents
us from creating a combined query. A combined query would also allow
someone to create a filter that bounds checkpoints and versions, but
doesn't bound the package itself (or would require us to prevent that
combination), which is complicated to implement efficiently and not
particularly useful.

## Test plan

New E2E tests:

```
sui$ cargo nextest run -p sui-graphql-e2e-tests \
  --features pg_integration                     \
  -- packages/versioning
```

& Testing against a read replica to make sure system package tests work
well, and performance is reasonable.

##  Stack

- #17686
- #17687
- #17688
- #17689
- #17691
- #17694
- #17695
- #17542
- #17690
- #17543
- #17692
- #17693
- #17696

---

## 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:
- [x] GraphQL: Introduces `Query.packageVersions` and
`MovePackage.versions` for paginating over the versions of a particular
package.
- [ ] CLI:
- [ ] Rust SDK:
@amnn amnn deleted the amnn/gql-pkg-v-page branch August 19, 2024 10:50
amnn added a commit that referenced this pull request Aug 19, 2024
## Description

Remove commands to generate examples, markdown and schema from the main
binary as we do not use them:

- Instead of generating examples, we have hand-crafted examples in our
docs. Removing this code also removes a test that forces regeneration of
a markdown file from these docs (which we also were not using).
- We also never used the output from the `generate-schema` sub-command,
because the schema was always available as a file, or via introspection
commands from the running service.
- Logic for gathering examples to test has been moved into the test
file, to avoid including test-only code in the main library.

## Test plan

CI

## Description 

Describe the changes or additions included in this PR.

## Test plan 

How did you test the new or updated feature?

## Stack

- #17543
- #17692 
- #17693 
- #17696 
- #17697 

---

## 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: 
- [x] GraphQL: The GraphQL binary no longer supports generating
examples, or exporting its own schema as these commands have been unused
for some time.
- [ ] CLI: 
- [ ] Rust SDK:
amnn added a commit that referenced this pull request Aug 20, 2024
## Description

Introduce two new queries: `Query.packageVersions` and
`MovePackage.versions` for iterating over all the different versions of
a given package.

This kind of query is useful for understanding package history.

These were introduced as a separate query, instead of having a single
query for iterating over packages that could optionally take a
checkpoint bounds or version bounds because of how system packages
interact with the `packages` table:

Because system packages are updated in-place, they only have one row in
the `packages` table. This makes sense for paginating packages in bulk
(e.g. by checkpoint) where the primary aim is to get a snapshot of the
packages available at a certain point in time, but doesn't work for
answering package version queries for system packages, and it prevents
us from creating a combined query. A combined query would also allow
someone to create a filter that bounds checkpoints and versions, but
doesn't bound the package itself (or would require us to prevent that
combination), which is complicated to implement efficiently and not
particularly useful.

## Test plan

New E2E tests:

```
sui$ cargo nextest run -p sui-graphql-e2e-tests \
  --features pg_integration                     \
  -- packages/versioning
```

& Testing against a read replica to make sure system package tests work
well, and performance is reasonable.

##  Stack

- #17686
- #17687
- #17688
- #17689
- #17691
- #17694
- #17695
- #17542
- #17690
- #17543
- #17692
- #17693
- #17696

---

## 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:
- [x] GraphQL: Introduces `Query.packageVersions` and
`MovePackage.versions` for paginating over the versions of a particular
package.
- [ ] CLI:
- [ ] Rust SDK:
amnn added a commit that referenced this pull request Aug 20, 2024
## Description

Remove commands to generate examples, markdown and schema from the main
binary as we do not use them:

- Instead of generating examples, we have hand-crafted examples in our
docs. Removing this code also removes a test that forces regeneration of
a markdown file from these docs (which we also were not using).
- We also never used the output from the `generate-schema` sub-command,
because the schema was always available as a file, or via introspection
commands from the running service.
- Logic for gathering examples to test has been moved into the test
file, to avoid including test-only code in the main library.

## Test plan

CI

## Description 

Describe the changes or additions included in this PR.

## Test plan 

How did you test the new or updated feature?

## Stack

- #17543
- #17692 
- #17693 
- #17696 
- #17697 

---

## 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: 
- [x] GraphQL: The GraphQL binary no longer supports generating
examples, or exporting its own schema as these commands have been unused
for some time.
- [ ] CLI: 
- [ ] Rust SDK:
amnn added a commit that referenced this pull request Aug 20, 2024
## Description

Introduce two new queries: `Query.packageVersions` and
`MovePackage.versions` for iterating over all the different versions of
a given package.

This kind of query is useful for understanding package history.

These were introduced as a separate query, instead of having a single
query for iterating over packages that could optionally take a
checkpoint bounds or version bounds because of how system packages
interact with the `packages` table:

Because system packages are updated in-place, they only have one row in
the `packages` table. This makes sense for paginating packages in bulk
(e.g. by checkpoint) where the primary aim is to get a snapshot of the
packages available at a certain point in time, but doesn't work for
answering package version queries for system packages, and it prevents
us from creating a combined query. A combined query would also allow
someone to create a filter that bounds checkpoints and versions, but
doesn't bound the package itself (or would require us to prevent that
combination), which is complicated to implement efficiently and not
particularly useful.

## Test plan

New E2E tests:

```
sui$ cargo nextest run -p sui-graphql-e2e-tests \
  --features pg_integration                     \
  -- packages/versioning
```

& Testing against a read replica to make sure system package tests work
well, and performance is reasonable.

##  Stack

- #17686
- #17687
- #17688
- #17689
- #17691
- #17694
- #17695
- #17542
- #17690
- #17543
- #17692
- #17693
- #17696

---

## 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:
- [x] GraphQL: Introduces `Query.packageVersions` and
`MovePackage.versions` for paginating over the versions of a particular
package.
- [ ] CLI:
- [ ] Rust SDK:
amnn added a commit that referenced this pull request Aug 20, 2024
## Description

Remove commands to generate examples, markdown and schema from the main
binary as we do not use them:

- Instead of generating examples, we have hand-crafted examples in our
docs. Removing this code also removes a test that forces regeneration of
a markdown file from these docs (which we also were not using).
- We also never used the output from the `generate-schema` sub-command,
because the schema was always available as a file, or via introspection
commands from the running service.
- Logic for gathering examples to test has been moved into the test
file, to avoid including test-only code in the main library.

## Test plan

CI

## Description 

Describe the changes or additions included in this PR.

## Test plan 

How did you test the new or updated feature?

## Stack

- #17543
- #17692 
- #17693 
- #17696 
- #17697 

---

## 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: 
- [x] GraphQL: The GraphQL binary no longer supports generating
examples, or exporting its own schema as these commands have been unused
for some time.
- [ ] CLI: 
- [ ] Rust SDK:
tx-tomcat pushed a commit to tx-tomcat/sui-network that referenced this pull request Aug 27, 2024
## Description

Introduce two new queries: `Query.packageVersions` and
`MovePackage.versions` for iterating over all the different versions of
a given package.

This kind of query is useful for understanding package history.

These were introduced as a separate query, instead of having a single
query for iterating over packages that could optionally take a
checkpoint bounds or version bounds because of how system packages
interact with the `packages` table:

Because system packages are updated in-place, they only have one row in
the `packages` table. This makes sense for paginating packages in bulk
(e.g. by checkpoint) where the primary aim is to get a snapshot of the
packages available at a certain point in time, but doesn't work for
answering package version queries for system packages, and it prevents
us from creating a combined query. A combined query would also allow
someone to create a filter that bounds checkpoints and versions, but
doesn't bound the package itself (or would require us to prevent that
combination), which is complicated to implement efficiently and not
particularly useful.

## Test plan

New E2E tests:

```
sui$ cargo nextest run -p sui-graphql-e2e-tests \
  --features pg_integration                     \
  -- packages/versioning
```

& Testing against a read replica to make sure system package tests work
well, and performance is reasonable.

##  Stack

- MystenLabs#17686
- MystenLabs#17687
- MystenLabs#17688
- MystenLabs#17689
- MystenLabs#17691
- MystenLabs#17694
- MystenLabs#17695
- MystenLabs#17542
- MystenLabs#17690
- MystenLabs#17543
- MystenLabs#17692
- MystenLabs#17693
- MystenLabs#17696

---

## 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:
- [x] GraphQL: Introduces `Query.packageVersions` and
`MovePackage.versions` for paginating over the versions of a particular
package.
- [ ] CLI:
- [ ] Rust SDK:
tx-tomcat pushed a commit to tx-tomcat/sui-network that referenced this pull request Aug 27, 2024
## Description

Remove commands to generate examples, markdown and schema from the main
binary as we do not use them:

- Instead of generating examples, we have hand-crafted examples in our
docs. Removing this code also removes a test that forces regeneration of
a markdown file from these docs (which we also were not using).
- We also never used the output from the `generate-schema` sub-command,
because the schema was always available as a file, or via introspection
commands from the running service.
- Logic for gathering examples to test has been moved into the test
file, to avoid including test-only code in the main library.

## Test plan

CI

## Description 

Describe the changes or additions included in this PR.

## Test plan 

How did you test the new or updated feature?

## Stack

- MystenLabs#17543
- MystenLabs#17692 
- MystenLabs#17693 
- MystenLabs#17696 
- MystenLabs#17697 

---

## 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: 
- [x] GraphQL: The GraphQL binary no longer supports generating
examples, or exporting its own schema as these commands have been unused
for some time.
- [ ] CLI: 
- [ ] Rust SDK:
suiwombat pushed a commit that referenced this pull request Sep 16, 2024
## Description

Introduce two new queries: `Query.packageVersions` and
`MovePackage.versions` for iterating over all the different versions of
a given package.

This kind of query is useful for understanding package history.

These were introduced as a separate query, instead of having a single
query for iterating over packages that could optionally take a
checkpoint bounds or version bounds because of how system packages
interact with the `packages` table:

Because system packages are updated in-place, they only have one row in
the `packages` table. This makes sense for paginating packages in bulk
(e.g. by checkpoint) where the primary aim is to get a snapshot of the
packages available at a certain point in time, but doesn't work for
answering package version queries for system packages, and it prevents
us from creating a combined query. A combined query would also allow
someone to create a filter that bounds checkpoints and versions, but
doesn't bound the package itself (or would require us to prevent that
combination), which is complicated to implement efficiently and not
particularly useful.

## Test plan

New E2E tests:

```
sui$ cargo nextest run -p sui-graphql-e2e-tests \
  --features pg_integration                     \
  -- packages/versioning
```

& Testing against a read replica to make sure system package tests work
well, and performance is reasonable.

##  Stack

- #17686
- #17687
- #17688
- #17689
- #17691
- #17694
- #17695
- #17542
- #17690
- #17543
- #17692
- #17693
- #17696

---

## 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:
- [x] GraphQL: Introduces `Query.packageVersions` and
`MovePackage.versions` for paginating over the versions of a particular
package.
- [ ] CLI:
- [ ] Rust SDK:
suiwombat pushed a commit that referenced this pull request Sep 16, 2024
## Description

Remove commands to generate examples, markdown and schema from the main
binary as we do not use them:

- Instead of generating examples, we have hand-crafted examples in our
docs. Removing this code also removes a test that forces regeneration of
a markdown file from these docs (which we also were not using).
- We also never used the output from the `generate-schema` sub-command,
because the schema was always available as a file, or via introspection
commands from the running service.
- Logic for gathering examples to test has been moved into the test
file, to avoid including test-only code in the main library.

## Test plan

CI

## Description 

Describe the changes or additions included in this PR.

## Test plan 

How did you test the new or updated feature?

## Stack

- #17543
- #17692 
- #17693 
- #17696 
- #17697 

---

## 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: 
- [x] GraphQL: The GraphQL binary no longer supports generating
examples, or exporting its own schema as these commands have been unused
for some time.
- [ ] CLI: 
- [ ] Rust SDK:
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