Compound key support in federation #1011
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
Summary: Compound keys are not yet supported for federation in gqlgen. This diff adds support by modifying the federation plugin to handle a list of key fields on an entity rather than a single top-level key field. It will now look for "find<EntityName>By<KeyField1><KeyField2>..." in the resolver, rather than the original "Find<EntityName>By<KeyField>". The federation plugin does not yet support more complicated FieldSets in the key, such as nested selections. References: - Apollo federation spec: https://www.apollographql.com/docs/apollo-server/federation/federation-spec/ - Selection sets: https://graphql.github.io/graphql-spec/draft/#sec-Selection-Sets Will update https://phabricator.khanacademy.org/D59469 with multiple key changes. Test Plan: - Tested Go GQL services using both single- and multiple-key federated types (assignments and content-library in webapp/services) - Ran gqlgen on non-federated services in webapp to ensure regular generation still works (donations service) - WIP: creating unit tests; will submit as separate diff Reviewers: briangenisio, dhruv, csilvers, O4 go-vernors Reviewed By: dhruv, csilvers, O4 go-vernors Differential Revision: https://phabricator.khanacademy.org/D59569
Summary: The current federation test schema only has types with single keys (or no keys). Adding a type with multiple keys, including one non-String key, to test compound key federation code gen. Test Plan: - go test Reviewers: csilvers, miguel Differential Revision: https://phabricator.khanacademy.org/D60715
|
Nice, another incremental. Any thoughts @marwan-at-work ? |
|
Looks awesome! I'll clone the branch and give it a try as soon as I can. Feel free to merge in the mean time if it looks good to everyone 👍 |
cgxxv
pushed a commit
to cgxxv/gqlgen
that referenced
this pull request
Mar 25, 2022
Compound key support in federation
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.
Compound keys aren't currently supported in the federation plugin, but are allowed per the Apollo spec. This patch adds support by modifying the federation plugin to handle a list of key fields on an entity rather than a single top-level key field. It will now look for "findEntityNameByKeyField1AndKeyField2..." in the resolver, rather than the original "FindEntityNameByKeyField". The change does not support more complicated FieldSets in the key, such as nested selections.
We are using this internally with Go services that use compound keys in federation.
References:
I have: