federation-2-readiness's Introduction

Federation 2 Readiness

Check your federated schema for backward-compatibility with Federation 2 and audit query plans.

The code in this repository is experimental and has been provided for reference purposes only. Community feedback is welcome but this project may not be supported in the same way that repositories in the official Apollo GraphQL GitHub organization are. If you need help you can file an issue on this repository, contact Apollo to talk to an expert, or create a ticket directly in Apollo Studio.

Usage

Basic Usage

Requires a user API key (created in Personal Settings), not a graph API key.

export APOLLO_KEY=<your apollo api key>
npx github:@apollosolutions/federation-2-readiness
# follow prompts to select a graph, a variant, and a time window for operations

Example output:

? Select Graph mygraph
🎉 Composed successfully
? Audit Operations in the Last Day
-----------------------------------
✅ Operations audited: 9
🏆 Operations that match: 9

Generate Query Plan Reports

export APOLLO_KEY=<your apollo api key>
npx github:@apollosolutions/federation-2-readiness --out results
# follow prompts to select a graph, a variant, a time window for operations

Example report in results/MyOperation-a1b2c3.md:

MyOperation a1b2c3
==================
https://studio.apollographql.com/graph/mygraph/operations?query=a1b2c3&queryName=MyOperation&variant=current

💣 Query plans differ

Diff
----
- Expected
+ Received

  QueryPlan {
    Sequence {
      Fetch(service: "products") {
        {
          product(id: $productId) {
            __typename
            id
            dimensions {
              size
+             weight
            }
          }
        }
      },
      Flatten(path: "product") {
        Fetch(service: "shipping") {
          {
            ... on Product {
              __typename
              id
              dimensions {
                size
+               weight
              }
            }
          } =>
          {
            ... on Product {
              shippingCost {
                value
              }
            }
          }
        },
      },
    },
  }

Resolve Composition Errors

If you encounter a composition error, you can run the audit against local subgraph files. The process is:

Generate a local supergraph config.
Download subgraph SDL files and point the supergraph config to use them.
Run the audit command using the local supergraph config instead of Studio.

npx github:@apollosolutions/federation-2-readiness config init --out supergraph.yaml
# follow prompts to select the graph and variant

npx github:@apollosolutions/federation-2-readiness config extract --config supergraph.yaml --out subgraphs
# follow prompts to select the subgraphs to extract to local files

npx github:@apollosolutions/federation-2-readiness --config supergraph.yaml

Known Limitations

Published only as source code to Github. Not available on NPM.
The versions of Fed 1 and Fed 2 composition may not match what's running in Apollo Studio or Rover.
Known query plan serialization differences include:
- List arguments being serialized as "" in Federation 1 and [""] in Federation 2.

federation-2-readiness's People

Contributors

Stargazers

Watchers