[new rule] validate subgraph according federation 2 #2049
+362
−34
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,30 @@ | ||
| // Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html | ||
|
|
||
| exports[`federation-subgraph > invalid > should validate subgraph 1`] = ` | ||
| #### ⌨️ Code | ||
|
|
||
| 1 | type Query { | ||
| 2 | t: T | ||
| 3 | } | ||
| 4 | | ||
| 5 | type T @key(fields: "f") { | ||
| 6 | f(x: Int): Int | ||
| 7 | } | ||
|
|
||
| #### ❌ Error | ||
|
|
||
| > 1 | type Query { | ||
| | ^^^^^^^^^^^^^^^^^^^^ | ||
| > 2 | t: T | ||
| | ^^^^^^^^^^^^^^ | ||
| > 3 | } | ||
| | ^^^^^^^^^^^^^^ | ||
| > 4 | | ||
| | ^^^^^^^^^^^^^^ | ||
| > 5 | type T @key(fields: "f") { | ||
| | ^^^^^^^^^^^^^^ | ||
| > 6 | f(x: Int): Int | ||
| | ^^^^^^^^^^^^^^ | ||
| > 7 | } | ||
| | ^^^^^^^^^^ On type "T", for @key(fields: "f"): field T.f cannot be included because it has arguments (fields with argument are not allowed in @key) | ||
| `; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,22 @@ | ||
| import { rule } from '../src/rules/federation-subgraph'; | ||
| import { ruleTester } from './test-utils'; | ||
|
|
||
| ruleTester.run('federation-subgraph', rule, { | ||
| valid: [], | ||
| invalid: [ | ||
| { | ||
| // https://github.com/apollographql/federation/blob/4ffe723395b4a054807b4f58181f166d76b57160/internals-js/src/__tests__/subgraphValidation.test.ts#L9 | ||
| name: 'should validate subgraph', | ||
| code: /* GraphQL */ ` | ||
| type Query { | ||
| t: T | ||
| } | ||
|
|
||
| type T @key(fields: "f") { | ||
| f(x: Int): Int | ||
| } | ||
| `, | ||
| errors: 1, | ||
| }, | ||
| ], | ||
| }); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,62 @@ | ||
| import { | ||
| asFed2SubgraphDocument, | ||
| buildSchemaFromAST, | ||
| FederationBlueprint, | ||
| Subgraph, | ||
| } from '@apollo/federation-internals'; | ||
| import { GraphQLESLintRule } from '../types.js'; | ||
|
|
||
| const RULE_ID = 'federation-subgraph'; | ||
|
There was a problem hiding this comment. any suggestions to rule name? There was a problem hiding this comment.
|
||
|
|
||
| export const rule: GraphQLESLintRule = { | ||
| meta: { | ||
| type: 'problem', | ||
| docs: { | ||
| category: 'Schema', | ||
| description: 'Enforce subgraph to be valid according Federation 2 spec.', | ||
| url: `https://the-guild.dev/graphql/eslint/rules/${RULE_ID}`, | ||
| // examples: [ | ||
| // { | ||
| // title: 'Incorrect', | ||
| // code: /* GraphQL */ ``, | ||
| // }, | ||
| // { | ||
| // title: 'Correct', | ||
| // code: /* GraphQL */ ``, | ||
| // }, | ||
| // ], | ||
| }, | ||
| schema: [], | ||
| }, | ||
| create(context) { | ||
| return { | ||
| Document(node) { | ||
| // https://github.com/apollographql/federation/blob/4ffe723395b4a054807b4f58181f166d76b57160/internals-js/src/__tests__/testUtils.ts#L16C45-L16C67 | ||
| const doc = asFed2SubgraphDocument(node.rawNode()); | ||
|
|
||
| const withRootTypeRenaming = true; | ||
| const buildOptions = { | ||
| blueprint: new FederationBlueprint(withRootTypeRenaming), | ||
| validate: false, | ||
| }; | ||
|
|
||
| // https://github.com/apollographql/federation/blob/4ffe723395b4a054807b4f58181f166d76b57160/internals-js/src/federation.ts#L1329 | ||
| const subgraphSchema = buildSchemaFromAST(doc, buildOptions); | ||
|
|
||
| const name = 'graphql-eslint-subgraph'; | ||
|
|
||
| const subgraph = new Subgraph(name, `http://${name}`, subgraphSchema); | ||
|
|
||
| try { | ||
| subgraph.validate(); | ||
| } catch (error) { | ||
| context.report({ | ||
| node, | ||
| // Remove `[graphql-eslint-subgraph] ` suffix in error message | ||
| message: (error as Error).message.slice(name.length + '[] '.length), | ||
| }); | ||
| } | ||
| }, | ||
| }; | ||
| }, | ||
| }; | ||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think people should explicitly install this dependency if they want to validate federation schema, there is no need to add to dependencies