mirumee / ariadne

Python library for implementing GraphQL servers using schema-first approach.

Home Page:https://ariadnegraphql.org

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

[federation] support new @composeDirective

dariuszkuc opened this issue · comments

Apollo Federation v2.1 introduced new @composeDirective directive that allows users to specify directives that should be preserved in the supergraph composition (by default composition strips out most directives from supergraph).

extend schema
  @link(
    url: "https://specs.apollo.dev/federation/v2.3",
    import: ["@composeDirective", "@extends", "@external", "@key", "@inaccessible", "@interfaceObject", "@override", "@provides", "@requires", "@shareable", "@tag"]
  )
  @link(url: "https://myspecs.dev/myCustomDirective/v1.0", import: ["@custom"])
  @composeDirective(name: "@custom")

// will be present in the supergraph definition
directive @custom on OBJECT

type Product @custom @key(fields: "id")
  id: ID!
  // other fields omitted for clarity
}

Additional resources:


New directive functionality can be tested using Apollo Federation Subgraph Compatibility NPX script (and Github Action). Example integration project is already provided in the subgraph compatibility testing repository.

Latest changes from #1060 added support for all new fed definitions.

Technically @composeDirective works - while it is not exposed in the _service { sdl }, users would be publishing to the studio the original schema that contains composed directive. _service { sdl } should only be used in development using local composition (and potentially obtaining a schema in code first libraries).

The reason why @composeDirective doesn't work in _service { sdl } query is due to stripping of all directives from schema which are done here. This logic was necessary for Federation v1 but should be skipped in Federation v2. Federation v2 does not require any filtering of the schema exposed in the _service { sdl } query (there is no need to extend query type either).