indexer-alt: generalize GraphQLConfig #20460
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
## Description `GraphQLConfig` is a derive macro for deriving `Serialize`, `Deserialize`, and `Debug`, and introducing `#[serde(default = ...)]` annotations that rely on the fields of the type's `Default` implementation. This allows config types to rely on their `Default` implementation as a single source of truth for default values, and is used through-out `sui-graphql-rpc` to define its config types. This change generalizes it (renames it) so it can be used in the indexer as well. ## Test plan Build and test `sui-graphql-rpc`, `sui-mvr-graphql-rpc`: ``` sui$ cargo nextest run -p sui-graphql-rpc sui$ cargo nextest run -p sui-graphql-e2e-tests sui$ cargo nextest run -p sui-mvr-graphql-rpc ``` This is a behaviour preserving change for the moment.
## Description `DefaultConfig` previously automatically added derives for `Serialize`, `Deserialize`, and `Clone`, `Eq` and `PartialEq`, which was convenient for its use in `sui-graphql-rpc`, but it does not generalize well, because: - Currently, it requires that the traits are in scope, which somewhat defeats the point of not having to explicitly derive them, in the case of `Serialize`/`Deserialize`. - The logic to detect when a derive is already applied is fragile, because it works by name (so it wouldn't play nicely with fully-qualified or aliased derives). This change removes that support in favour of a simpler approach: - `DefaultConfig` adds derives for `serde::Serialize` and `serde::Deserialize`, using fully-qualified names. - Other derives need to be added explicitly. - The logic to only add a derive if it hasn't already been added has been removed. ## Test plan CI for existing use cases.
## Description Add support to `sui-default-config` to change the naming scheme of its fields (previously always used kebab-case). This allows pipelines to retain the names they were given in source code (which use underscores). ## Test plan Will be used and tested in a future PR.
amnn
requested review from
wlmyng,
stefan-mysten,
emmazzz and
suiwombat
as code owners
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎ |
amnn
temporarily deployed
to
sui-typescript-aws-kms-test-env
GitHub Actions
Inactive
This was referenced Nov 28, 2024
bmwill
approved these changes
Nov 28, 2024
amnn
temporarily deployed
to
sui-typescript-aws-kms-test-env
GitHub Actions
Inactive
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Take the
GraphQLConfigprocedural macro used by GraphQL and generalize it for use in other crates, asDefaultConfig. This macro simplifies defining a configuration to be read from a file, using serde's Serialze/Deserialize, and automatically using the type'sDefaultto supply the default values while deserializing as well.As part of generalizing, we dropped support for some features that don't work well in the more general setting:
Clone,Eq, etc) -- these can be added manually if needed.rename_all = "kebab-case", because for the Indexer's config, we will want some of them to be renamed as"snake_case". A check was added to see whether arename_allattribute has been supplied, and in that case, the macro does not add its own.Test plan
Build and test existing uses of the crate:
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.