fix: make registry-upgrade more tolerant of problems #1715
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
registry-upgrade currently panics if you pass it a registry that references a type that dopesn't exist. The thinking here was that _ideally_ we validate schemas before we even parse them, so that we can give the users a good error message. And then hopefully our code doesn't do anything to make the registry invalid between validation and passing it to registry-upgrade. This was wishful thinking - I'm not sure we _do_ validate the schema, and parser-sdl (and probably the connectors) are also perfectly capable of generating bad registries. This updates registry-upgrade to be more tolerant of these kinds of problems: 1. Where possible it'll just skip any fields with missing types. We could raise these as errors to the user, but I think they're _usually_ a sign of a bug elsewhere - either we're generating invalid registries, or we're not catching invalid schemas. So I kind of think a best effort approach to getting _something_ deployed is appropriate. 2. If the user doesn't provide a root `Query` type there's no graceful way to handle that - so for that case I've updated the crate to return an error.
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.
registry-upgrade currently panics if you pass it a registry that references a type that dopesn't exist. The thinking here was that ideally we validate schemas before we even parse them, so that we can give the users a good error message. And then hopefully our code doesn't do anything to make the registry invalid between validation and passing it to registry-upgrade.
This was wishful thinking - I'm not sure we do validate the schema, and parser-sdl (and probably the connectors) are also perfectly capable of generating bad registries.
This updates registry-upgrade to be more tolerant of these kinds of problems:
Querytype there's no graceful way to handle that - so for that case I've updated the crate to return an error.