Add enum merging RFC #53
Open
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
smyrick
reviewed
Oct 3, 2024
rfcs/enum-merging.md
Outdated
| - **Prevents Runtime Errors**: By ensuring that only recognized enum values are exposed, runtime errors are minimized. | ||
| - **Composition-Time Validation**: Differences in enum definitions are caught during schema composition. | ||
| - **Explicit Control**: Developers explicitly manage enum exposure, increasing schema clarity, with the hope that they will not return the inaccessible values until they are exposed. | ||
| - **Supports Evolvability**: A new enum value can be added by flagging it as `@inaccessible` in a subgraph which hides it from the gateway schema. The other subgraph can then expose it when ready. The flag can be removed once all subgraphs are updated. |
There was a problem hiding this comment.
If we have one subgraph, the first subgraph can add @inaccessible but then the other two can add the enum with out marking it as @inaccessible. That is by design of the current @inaccessible directive today with fields but should we make that more explicit with enums?
Maybe we should make it so everyone has to add @inaccessible? But then everyone has to also remove it to release and that is more work and time....
|
@PascalSenn @benjie I pulled up some usage stats on the 3000+ enums in our graph: |
|
Thanks for the stats @fotoetienne ! |
glen-84
reviewed
Oct 6, 2024
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.
No description provided.