Require immutable flag on entities #1994
Merged
Conversation
This file contains hidden or 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
🦋 Changeset detectedLatest commit: 37a8326 The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
Deploying graph-tooling with
|
| Latest commit: |
bc14daa
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://b309369a.graph-tooling.pages.dev |
| Branch Preview URL: | https://ion-require-immutable-flag-o.graph-tooling.pages.dev |
isum
force-pushed
the
ion/require-immutable-flag-on-entities
branch
from
37a8326 to
bc14daa
Compare
|
cosmos is no longer supported, we should consider removing those examples instead of updating them. |
YaroShkvorets
approved these changes
Apr 1, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
This PR adds a new validation for GraphQL schemas that requires all entities to be explicitly marked as immutable or mutable. This is the first step in transitioning subgraph developers to using immutable entities by default.
As a result, the codegen command will fail if there are any entities without an immutable flag. The error message also provides a hint on what to update and how.
In addition, if GraphQL schemas do not use immutable entities (all entities are mutable), the codegen command will print a warning suggesting that immutable entities should be considered and a link to best practices.
Finally, all example subgraphs have been updated with explicit immutable flags.
Todos