fix: Adds support for defining Interface entities resolvers #262
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
Context: In Federation v2.3 there was added support for interfaces to be Entities. There are two ways to consume this new feature. 1. Extend an Interface Entity with the `@interfaceObject` directive, when the Entity is defined by a different subgraph. 2. Implement the Interface Entity with its implementing Type Entitites. There was previos work into getting the first part covered in this gem, but we were still lacking support for the 2nd part. This work address that. The main issue here is the fact that an `Union` in `GraphQL` can't be an `Interface` according to the [spec](https://spec.graphql.org/October2021/#sec-Unions.Type-Validation), but at the same time, according to the Apollo Federation [spec](https://www.apollographql.com/docs/federation/federated-types/interfaces), an interface can be an Entity, and an Entity is an Union. Therefore, we have to extend the validation (`assert_valid_union_member`) for the Entity union to allow `Interfaces` (more exactly `Modules`) as possible types.
In a previous Pull Request (Gusto#248) there was added support for underscoring the keys and while this covered the `Object` class, it didn't also cover the `Interface` module. This commit adds the same `underscore_reference_keys` method to the `Interface` module.
Every entity that implements an interface entity must include all `@keys` from the interface definition. Therefore, we add this extra validation to ensure that.
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.
Context
As part of the Federation v2.3 spec, the Apollo team added a new feature, to support defining and referencing Entities that are interfaces. You can read more about this here, and check the initial implementation here.
This feature consists of two parts:
@interfaceObjectdirective. This work was added in feat: adds support for the@interfaceObjectdirective #218Description
UnioninGraphQLcan't be anInterfaceaccording to the spec, but at the same time, according to the Apollo Federation spec, an interface can be an Entity, and an Entity is an Union. Therefore, we have to extend the validation (assert_valid_union_member) for the Entity union to allowInterfaces(more preciselyModules) as possible types.@keydirective. This is a requirement from the spec.underscore_reference_keyssupport to interfacesObjectclass, it didn't also cover theInterfacemodule. This commit adds the sameunderscore_reference_keysmethod to theInterfacemodule.Interface Entitiesfeature support.cc @nogates