[sui-types] Update bounded visitor to take an environment variable override at startup #18175
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
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
3 Ignored Deployments
|
…erride at startup
tzakian
force-pushed
the
tzakian/bounded-visitor-env-override-runtime
branch
from
6669f4b
to
1db74a2
Compare
7 tasks
tx-tomcat
pushed a commit
to tx-tomcat/sui-network
that referenced
this pull request
Jul 29, 2024
…erride at startup (MystenLabs#18175) ## Description This adds the ability to start the Sui process (/indexers/fullnodes etc) with different `MAX_BOUNDs` for annotated values -- this is particularly useful for fullnodes and indexers. To use a different bound from the default, you simply set `MAX_ANNOTATED_VALUE_SIZE=N` in your environment before starting the process. Where `N` is the number of bytes "in addition" that you're willing to tolerate when creating the annotated value from the un-annotated value (i.e., on types, variant names, and field names). ## Test plan Added new test to make sure: 1. We respect this variable if set; and 2. Do not update the value if changed during runtime; --- ## 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: - [X] Nodes (Validators and Full nodes): Added `MAX_ANNOTATED_VALUE_SIZE` environment variable which can be used to override the `MAX_BOUND` for annotated values at startup (useful if encountering `"Deserialized value too large"` errors). If the `MAX_ANNOTATED_VALUE_SIZE` is not set, `MAX_BOUND` will default to the existing max bound of ~1MiB. - [X] Indexer: Added `MAX_ANNOTATED_VALUE_SIZE` environment variable which can be used to override the `MAX_BOUND` for annotated values at startup (useful if encountering `"Deserialized value too large"` errors). If the `MAX_ANNOTATED_VALUE_SIZE` is not set, `MAX_BOUND` will default to the existing max bound of ~1MiB. - [X] JSON-RPC: Added `MAX_ANNOTATED_VALUE_SIZE` environment variable which can be used to override the `MAX_BOUND` for annotated values at startup (useful if encountering `"Deserialized value too large"` errors). If the `MAX_ANNOTATED_VALUE_SIZE` is not set, `MAX_BOUND` will default to the existing max bound of ~1MiB. - [X] GraphQL: Added `MAX_ANNOTATED_VALUE_SIZE` environment variable which can be used to override the `MAX_BOUND` for annotated values at startup (useful if encountering `"Deserialized value too large"` errors). If the `MAX_ANNOTATED_VALUE_SIZE` is not set, `MAX_BOUND` will default to the existing max bound of ~1MiB. - [ ] CLI: - [ ] Rust SDK:
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
This adds the ability to start the Sui process (/indexers/fullnodes etc) with different
MAX_BOUNDsfor annotated values -- this is particularly useful for fullnodes and indexers.To use a different bound from the default, you simply set
MAX_ANNOTATED_VALUE_SIZE=Nin your environment before starting the process. WhereNis the number of bytes "in addition" that you're willing to tolerate when creating the annotated value from the un-annotated value (i.e., on types, variant names, and field names).Test plan
Added new test to make sure:
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.
MAX_ANNOTATED_VALUE_SIZEenvironment variable which can be used to override theMAX_BOUNDfor annotated values at startup (useful if encountering"Deserialized value too large"errors). If theMAX_ANNOTATED_VALUE_SIZEis not set,MAX_BOUNDwill default to the existing max bound of ~1MiB.MAX_ANNOTATED_VALUE_SIZEenvironment variable which can be used to override theMAX_BOUNDfor annotated values at startup (useful if encountering"Deserialized value too large"errors). If theMAX_ANNOTATED_VALUE_SIZEis not set,MAX_BOUNDwill default to the existing max bound of ~1MiB.MAX_ANNOTATED_VALUE_SIZEenvironment variable which can be used to override theMAX_BOUNDfor annotated values at startup (useful if encountering"Deserialized value too large"errors). If theMAX_ANNOTATED_VALUE_SIZEis not set,MAX_BOUNDwill default to the existing max bound of ~1MiB.MAX_ANNOTATED_VALUE_SIZEenvironment variable which can be used to override theMAX_BOUNDfor annotated values at startup (useful if encountering"Deserialized value too large"errors). If theMAX_ANNOTATED_VALUE_SIZEis not set,MAX_BOUNDwill default to the existing max bound of ~1MiB.