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

Implicitly upgrade federation version to the max required by any used directive #2929

Merged
merged 10 commits into from
Feb 5, 2024

Conversation

tninesling
Copy link
Contributor

Overview

The recent addition of SourceSpecDefinition surfaced a case where a subgraph with a @link to federation < 2.7 and a @link to the source spec (which requires federation >= 2.7) results in an unexpected error during composition. Validation for this case was introduced in #2914, raising a composition error when the versions are mismatched.

Since the existing behavior will implicitly upgrade to a later minor version of federation when two subgraphs are mismatched, it makes sense to do the same with feature requirements.

Example

Subgraph A has a @link to fed version 2.5
Subgraph B has a @link to fed version 2.7
Subgraph C has a @link to fed version 2.5 and a separate @link to the source spec

Previous behavior:

  1. Composing Subgraph A and Subgraph B silently upgrades to fed version 2.7
  2. Composing Subgraph A and Subgraph C results in a composition error

New behavior:

  1. Composing Subgraph A and Subgraph B silently upgrades to fed version 2.7
  2. Composing Subgraph A and Subgraph C upgrades to fed version 2.7 and raises a hint explaining why

@tninesling tninesling requested a review from a team as a code owner February 2, 2024 22:03
@apollo-cla
Copy link

@tninesling: Thank you for submitting a pull request! Before we can merge it, you'll need to sign the Apollo Contributor License Agreement here: https://contribute.apollographql.com/

Copy link

changeset-bot bot commented Feb 2, 2024

🦋 Changeset detected

Latest commit: d831c00

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

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

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 Feb 2, 2024

Deploy Preview for apollo-federation-docs canceled.

Name Link
🔨 Latest commit d831c00
🔍 Latest deploy log https://app.netlify.com/sites/apollo-federation-docs/deploys/65c11635884ae900086b3cfb

Copy link

codesandbox-ci bot commented Feb 2, 2024

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.

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, make sure you squash.

@tninesling tninesling merged commit 33b937b into main Feb 5, 2024
19 checks passed
@tninesling tninesling deleted the taylor/implicit-upgrades branch February 5, 2024 18:08
@github-actions github-actions bot mentioned this pull request Feb 5, 2024
tninesling added a commit that referenced this pull request Feb 5, 2024
This change updates the changeset log from
#2929 to indicate patch
version bumps instead of minor version bumps.
clenfest pushed a commit that referenced this pull request Mar 21, 2024
This PR was opened by the [Changesets
release](https://github.com/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/composition@2.7.2

### Patch Changes

- When a linked directive requires a federation version higher than the
linked federation spec, upgrade to the implied version and issue a hint
([#2929](#2929))

- Stop emitting "inconsistent value type" hints against definitions
where the type is marked `@external` or all fields are marked
`@external`.
([#2951](#2951))

- Introduce a new composition hint pertaining specifically to
progressive `@override` usage (when a `label` argument is present).
([#2922](#2922))

- Updated dependencies
\[[`33b937b18d3c7ca6af14b904696b536399e597d1`](33b937b),
[`09cd3e55e810ee513127b7440f5b11af7540c9b0`](09cd3e5),
[`d7189a86c27891af408d3d0184db6133d3342967`](d7189a8)]:
    -   @apollo/federation-internals@2.7.2
    -   @apollo/query-graphs@2.7.2

## @apollo/gateway@2.7.2

### Patch Changes

- Remove out-of-band reporting in the gateway and provide a warning for
users who have the endpoint configured.
([#2946](#2946))

- Updated dependencies
\[[`33b937b18d3c7ca6af14b904696b536399e597d1`](33b937b),
[`09cd3e55e810ee513127b7440f5b11af7540c9b0`](09cd3e5),
[`d7189a86c27891af408d3d0184db6133d3342967`](d7189a8),
[`33506bef6d755c58400081824167711c1747ee40`](33506be),
[`1f72f2a361a83ebaaf15ae052f5ca9a93fc18bfc`](1f72f2a)]:
    -   @apollo/composition@2.7.2
    -   @apollo/federation-internals@2.7.2
    -   @apollo/query-planner@2.7.2

## @apollo/federation-internals@2.7.2

### Patch Changes

- When a linked directive requires a federation version higher than the
linked federation spec, upgrade to the implied version and issue a hint
([#2929](#2929))

- When auto-upgrading a subgraph (i.e. one that does not explicitly
@link the federation spec) do not go past v2.4. This is so that
subgraphs will not inadvertently require the latest join spec (which
cause the router or gateway not to start if running an older version).
([#2933](#2933))

- Add new `generateQueryFragments` option to query planner config
([#2958](#2958))

If enabled, the query planner will extract inline fragments into
fragment definitions before sending queries to subgraphs. This can
significantly reduce the size of the query sent to subgraphs, but may
increase the time it takes to plan the query.

## @apollo/query-graphs@2.7.2

### Patch Changes

- Updated dependencies
\[[`33b937b18d3c7ca6af14b904696b536399e597d1`](33b937b),
[`09cd3e55e810ee513127b7440f5b11af7540c9b0`](09cd3e5),
[`d7189a86c27891af408d3d0184db6133d3342967`](d7189a8)]:
    -   @apollo/federation-internals@2.7.2

## @apollo/query-planner@2.7.2

### Patch Changes

- When auto-upgrading a subgraph (i.e. one that does not explicitly
@link the federation spec) do not go past v2.4. This is so that
subgraphs will not inadvertently require the latest join spec (which
cause the router or gateway not to start if running an older version).
([#2933](#2933))

- Add new `generateQueryFragments` option to query planner config
([#2958](#2958))

If enabled, the query planner will extract inline fragments into
fragment definitions before sending queries to subgraphs. This can
significantly reduce the size of the query sent to subgraphs, but may
increase the time it takes to plan the query.

- Updated dependencies
\[[`33b937b18d3c7ca6af14b904696b536399e597d1`](33b937b),
[`09cd3e55e810ee513127b7440f5b11af7540c9b0`](09cd3e5),
[`d7189a86c27891af408d3d0184db6133d3342967`](d7189a8)]:
    -   @apollo/federation-internals@2.7.2
    -   @apollo/query-graphs@2.7.2

## @apollo/subgraph@2.7.2

### Patch Changes

- Updated dependencies
\[[`33b937b18d3c7ca6af14b904696b536399e597d1`](33b937b),
[`09cd3e55e810ee513127b7440f5b11af7540c9b0`](09cd3e5),
[`d7189a86c27891af408d3d0184db6133d3342967`](d7189a8)]:
    -   @apollo/federation-internals@2.7.2

## apollo-federation-integration-testsuite@2.7.2

### Patch Changes

- Add new `generateQueryFragments` option to query planner config
([#2958](#2958))

If enabled, the query planner will extract inline fragments into
fragment definitions before sending queries to subgraphs. This can
significantly reduce the size of the query sent to subgraphs, but may
increase the time it takes to plan the query.

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
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants