Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

@wundergraph/composition

Package Overview
Dependencies
Maintainers
2
Versions
75
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@wundergraph/composition

  • 0.28.4
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
18K
decreased by-37.47%
Maintainers
2
Weekly downloads
 
Created
Source

WunderGraph Composition

npm version

The WunderGraph composition library facilitates the federation of multiple subgraph schemas into a single federated GraphQL schema.

Prerequisites

Federating subgraphs

The federateSubgraphs function is responsible for producing a valid federated graph. Each subgraph will be normalized and validated before federation. This normalization process does not affect the upstream schema. The final federated graph will also be validated. The function must be provided with an array of at least one Subgraph object. An example federation of two simple subgraphs:

import { federateSubgraphs, Subgraph } from '@wundergraph/composition';
import { parse } from 'graphql';

const federationResult: FederationResult = federateSubgraphs([subgraphA, subgraphB]);

const subgraphA: Subgraph = {
  name: 'subgraph-a',
  url: 'http://localhost:4001',
  definitions: parse(`
    type User @key(fields: "id") {
      id: ID!
      name: String!
    }
  `),
};

const subgraphB: Subgraph = {
  name: 'subgraph-b',
  url: 'http://localhost:4002',
  definitions: parse(`
    type Query {
      users: [User!]!
    }
      
    type User @key(fields: "id") {
      id: ID!
      interests: [String!]!
    }
  `),
};

FederationResultContainer properties

The federateSubgraphs function returns a FederationResultContainer object. If federation was successful, the errors property will be undefined, and the federationResult object will be defined.

propertyDescriptiontype
errorsarray of composition errorsError[] | undefined
federationResultFederationResult object (see below)FederationResult | undefined

FederationResult properties

If federation was successful, FieldResultContainer will contain a defined federationResult property.

propertyDescriptiontype
argumentConfigurationsarray of router argument configurationsArgumentConfigurationData[]
federatedGraphASTan AST object representation of the federated graph sdlgraphql.DocumentNode
federatedGraphSchemaa schema object representation of the federated graph sdlgraphql.GraphQLSchema

Debugging

If normalization of any subgraph fails, or the federated graph itself is invalid, the AST and schema will not be produced (undefined properties). In these cases, the errors array will be defined and populated. An example of a simple debugging framework might be:

import { federateSubgraphs, Subgraph } from '@wundergraph.composition';
import { print, printSchema } from 'graphql';

const { errors, federationResult } = federateSubgraphs([subgraphA, subgraphB]);
if (errors) {
  for (const err of errors) {
    console.log(err.message);
  }
} else {
  // Both options to print the federated graph as a string are included for documentational purposes only
  console.log(print(federationResult!.federatedGraphAST)); // log the federated graph AST as a string
  console.log(printSchema(federationResult!.federatedGraphSchema)); // log the federated graph schema as a string
}

// subgraph definitions would be below [removed for brevity]

Errors

Errors can happen in three main stages:

  1. While validating the subgraph metadata, e.g., validating that each Subgraph object has a unique name.
  2. During the normalization process, which prepares the subgraph for federation. (if this stage fails, federation will not be attempted)
  3. During the federation process itself.

All errors will be appended to the FederationResultContainer.errors array. Often, the error message will suggest potential fixes. For instance:

Error: The following root path is unresolvable:
    Query.user.name
    This is because:
        The root type field "Query.user" is defined in the following subgraphs: "subgraph-b".
    However, "User.name" is only defined in the following subgraphs: "subgraph-c".
    Consequently, "User.name" cannot be resolved through the root type field "Query.user".
    Potential solutions:
        Convert "User" into an entity using a "@key" directive.
        Add the shareable root type field "Query.user" to the following subgraphs: "subgraph-c".
            For example (note that V1 fields are shareable by default and do not require a directive):
                type Query {
                    ...
                    user: User @shareable
                }

Subgraph object

The Subgraph object is the core of the WunderGraph composition library. The definitions property must be provided as a graphQL.DocumentNode type. This is easily achieved by passing string representation of the subgraph SDL to the graphql.js parse function. An example is shown below:

import { Subgraph } from '@wundergraph/composition'
import { parse } from 'graphql';

const subgraphA: Subgraph = {
  name: 'subgraph-a',
  url: 'http://localhost:4001',
  definitions: parse(`
    type Query {
      user: User!
    }

    type User {
      name: String!
    }
  `),
};

Subgraph Properties

propertyDescriptiontype
nameunique name of the subgraphstring
urlunique endpoint for the subgraphstring
definitionsan AST representation of the subgraph SDLgraphql.DocumentNode

FAQs

Package last updated on 28 Aug 2024

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc