[Feature] Tools: Schema Merge #1632
Conversation
| let ast = parser.parse(); | ||
| let doc = ast.document(); | ||
|
|
||
| for def in doc.definitions() { |
There was a problem hiding this comment.
Dumb question- does apollo-parser automatically aggregate multiple definitions together? Meaning, if I have:
type User @key(fields:"id") {
id: ID!
name: String!
} and
type User @key(fields:"id") {
id: ID!
username: String!
} Would I get a combo of both, an error, or one of them?
There was a problem hiding this comment.
A quick test suggests you will get both of them.
There was a problem hiding this comment.
Amazing, thanks for testing!
| impl Merge { | ||
| pub fn run(&self) -> RoverResult<RoverOutput> { | ||
| // find files by extension | ||
| let schemas = self.find_files_by_extensions(self.options.schemas.clone(), &["graphql", "gql"])?; |
There was a problem hiding this comment.
I think some folks also use .graphqls extension for schemas and .graphql for operations. Technically folks could define their schemas using any extension they want so unsure if there is a need to capture all of them (that being said .graphqls is somewhat common).
There was a problem hiding this comment.
good catch. might be worth allowing users to use a custom extension as a flag in that case
|
Maybe a basic question but this is just doing "dumb" schema merging, right? This doesn't do full Federation composition? Or maybe a better question, what is the intended user use case? For someone working one a single subgraph or client that has the type defs spread across multiple files and would be valid if they all just lived in on file? OR Trying to do a merging of multiple schema files into one valid subgraph file, while doing some type and directive composition? |
Thats correct, this just merges schema files. It's intentionally dumb - ie low-level file manipulation. But it reads and writes the schema files using apollo-rs parser/encoder.
Yes, the inputs should already be valid schema files - just split up into multiple files.
That could be something we add as an enhancement, maybe throw warnings about it but not prevent merging of the files. |
| Ok(result) | ||
| } | ||
|
|
||
| fn merge_schemas_into_one(&self, schemas: Vec<PathBuf>) -> RoverResult<String> { |
There was a problem hiding this comment.
not for this PR, but something to consider in the future is that we'd want to validate that all these files getting merged are semantically valid (with apollo-compiler). the compiler now has multi-file support, so you can just add them all to a compiler instance and validate.
This adds a
toolscommand for manipulating schema files.It also adds a
tools mergesubcommand to merge multiple.graphql/.gqlfiles together into a single file. (implemented with apollo-rs 🎉 )It outputs the merged schema as rover command result.
Example: