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

[federation] support new @composeDirective #1031

Open
dariuszkuc opened this issue Feb 17, 2023 · 1 comment
Open

[federation] support new @composeDirective #1031

dariuszkuc opened this issue Feb 17, 2023 · 1 comment
Labels
help wanted Extra attention is needed

Comments

@dariuszkuc
Copy link

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.

@rafalp rafalp added the help wanted Extra attention is needed label Feb 24, 2023
@dariuszkuc
Copy link
Author

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).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

2 participants