Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix __typename rebasing for interface objects #2886

Conversation

sachindshinde
Copy link
Contributor

We should never query __typename from a subgraph for an object type marked @interfaceObject, as the value we get back will always be wrong. Normally, we prevent this by not having a __typename edge in the federated query graph.

However, during the optimization where we try to reuse existing named fragments, we rebase them from the API schema onto the subgraph schemas. We usually ignore selections where this leads to invalidity (e.g. fields or types that don't exist in the subgraph schema), but the code doesn't currently view the __typename field being rebased onto an interface object as invalid. This has led to bugs where named fragments containing __typename accidentally cause it to be queried on interface objects in subgraph queries.

This PR changes Field.rebaseOn() such that __typename being rebased onto a parent type that is an interface object is considered invalid. Additionally, if the parent type is an abstract type, and that abstract type could possibly be an interface object type at runtime, then this is additionally considered invalid.

@sachindshinde sachindshinde requested a review from a team as a code owner December 8, 2023 19:38
Copy link

changeset-bot bot commented Dec 8, 2023

🦋 Changeset detected

Latest commit: bbaf0c2

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 7 packages
Name Type
@apollo/federation-internals Patch
@apollo/gateway Patch
@apollo/composition Patch
@apollo/query-planner Patch
@apollo/query-graphs Patch
@apollo/subgraph Patch
apollo-federation-integration-testsuite Patch

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

Copy link

netlify bot commented Dec 8, 2023

Deploy Preview for apollo-federation-docs canceled.

Name Link
🔨 Latest commit bbaf0c2
🔍 Latest deploy log https://app.netlify.com/sites/apollo-federation-docs/deploys/657374c88d626c0008eb952f

Copy link

codesandbox-ci bot commented Dec 8, 2023

This pull request is automatically built and testable in CodeSandbox.

To see build info of the built libraries, click here or the icon next to each commit SHA.

… being rebased onto a parent type whose runtime types contain at least one interface object
@sachindshinde sachindshinde force-pushed the sachin-gary-geoffroy/fix-typename-field-rebasing-for-interface-objects branch from fe2f19b to bbaf0c2 Compare December 8, 2023 19:55
Copy link
Contributor

@clenfest clenfest left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

@sachindshinde sachindshinde merged commit 74ca7dd into main Dec 8, 2023
18 checks passed
@sachindshinde sachindshinde deleted the sachin-gary-geoffroy/fix-typename-field-rebasing-for-interface-objects branch December 8, 2023 20:20
@github-actions github-actions bot mentioned this pull request Dec 8, 2023
dariuszkuc pushed a commit that referenced this pull request Dec 11, 2023
This PR was opened by the [Changesets
release](https:/changesets/action) GitHub action. When
you're ready to do a release, you can merge this and the packages will
be published to npm automatically. If you're not ready to do a release
yet, that's fine, whenever you add more changesets to main, this PR will
be updated.


# Releases
## @apollo/[email protected]

### Patch Changes

- Updated dependencies
\[[`7b5b836d15247c997712a47847f603aa5887312e`](7b5b836),
[`74ca7dd617927a20d79b824851f7651ef3c40a4e`](74ca7dd),
[`3f7392b84f8b626b248b59ce81f193d0f0272045`](3f7392b)]:
    -   @apollo/[email protected]
    -   @apollo/[email protected]

## @apollo/[email protected]

### Patch Changes

- Updated dependencies
\[[`7b5b836d15247c997712a47847f603aa5887312e`](7b5b836),
[`74ca7dd617927a20d79b824851f7651ef3c40a4e`](74ca7dd),
[`ffe67dfbdb77d15dde2ab6dee66dba05c7b5c037`](ffe67df)]:
    -   @apollo/[email protected]
    -   @apollo/[email protected]
    -   @apollo/[email protected]

## @apollo/[email protected]

### Patch Changes

- Avoid `>=` comparison for `FeatureVersion` objects
([#2883](#2883))

- Fix query planning bug where `__typename` on interface object types in
named fragments can cause query plan execution to fail.
([#2886](#2886))
([#2886](#2886))

## @apollo/[email protected]

### Patch Changes

- fix: handle directive conditions on fragments when building query
graphs ([#2875](#2875))

This fix addresses issues with handling fragments when they specify
directive conditions:

- when exploding the types we were not propagating directive conditions
- when processing fragment that specifies super type of an existing type
and also specifies directive condition, we were incorrectly preserving
the unnecessary type condition. This type condition was problematic as
it could be referencing types from supergraph that were not available in
the local schema. Instead, we now drop the redundant type condition and
only preserve the directives (if specified).

- Updated dependencies
\[[`7b5b836d15247c997712a47847f603aa5887312e`](7b5b836),
[`74ca7dd617927a20d79b824851f7651ef3c40a4e`](74ca7dd)]:
    -   @apollo/[email protected]

## @apollo/[email protected]

### Patch Changes

- Add a limit to the number of options for a selection. In some cases,
we will generate a lot of possible paths to access a field. There is a
process to remove redundant paths, but when the list is too large, that
process gets very expensive. To prevent that, we introduce an optional
limit that will reject the query if too many paths are generated
([#2880](#2880))

- Updated dependencies
\[[`7b5b836d15247c997712a47847f603aa5887312e`](7b5b836),
[`74ca7dd617927a20d79b824851f7651ef3c40a4e`](74ca7dd),
[`3f7392b84f8b626b248b59ce81f193d0f0272045`](3f7392b)]:
    -   @apollo/[email protected]
    -   @apollo/[email protected]

## @apollo/[email protected]

### Patch Changes

- Updated dependencies
\[[`7b5b836d15247c997712a47847f603aa5887312e`](7b5b836),
[`74ca7dd617927a20d79b824851f7651ef3c40a4e`](74ca7dd)]:
    -   @apollo/[email protected]

## [email protected]

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants