Allow known FeatureDefinition subclasses to define custom subgraph schema validation rules
#2910
Conversation
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 comment was marked as resolved.
This comment was marked as resolved.
|
This pull request is automatically built and testable in CodeSandbox. To see build info of the built libraries, click here or the icon next to each commit SHA. |
benjamn
commented
Jan 16, 2024
clenfest
reviewed
Jan 17, 2024
internals-js/src/specs/sourceSpec.ts
Outdated
|
|
||
| if (sourceAPIInSchema) { | ||
| sourceAPIInSchema.applications().forEach(application => { | ||
| const { name, ...rest } = application.arguments(); |
There was a problem hiding this comment.
Is there a reason you're doing this as opposed to const { name, http }?
There was a problem hiding this comment.
Just trying to be agnostic to eventually having more than just http in KNOWN_SOURCE_PROTOCOLS.
There was a problem hiding this comment.
It's just style, so I'm not going to hold up the release for it, but imo it's a little cleaner to say
const { api, http, grpc, sql } = application.arguments();
if (http) {
assert(apiNameToProtocol.get(api) === 'http', ...);
} else if (grpc) {
assert(apiNameToProtocol.get(api) === 'grpc', ...);
...
}
…a per directive basis
benjamn
force-pushed
the
benjamn/validate-@source-directives
branch
from
f9d1d1b
to
5ffb16f
Compare
clenfest
reviewed
Jan 19, 2024
clenfest
reviewed
Jan 19, 2024
clenfest
approved these changes
Jan 19, 2024
trevor-scheer
pushed a commit
that referenced
this pull request
Jan 20, 2024
This PR was opened by the [Changesets release](https://github.com/changesets/action) GitHub action. When you're ready to do a release, you can merge this and the packages will be published to npm automatically. If you're not ready to do a release yet, that's fine, whenever you add more changesets to next, this PR will be updated. # Releases ## @apollo/composition@2.7.0 ### Minor Changes - Implement progressive `@override` functionality ([#2911](#2911)) The progressive `@override` feature brings a new argument to the `@override` directive: `label: String`. When a label is added to an `@override` application, the override becomes conditional, depending on parameters provided to the query planner (a set of which labels should be overridden). Note that this feature will be supported in router for enterprise users only. Out-of-the-box, the router will support a percentage-based use case for progressive `@override`. For example: ```graphql type Query { hello: String @OverRide(from: "original", label: "percent(5)") } ``` The above example will override the root `hello` field from the "original" subgraph 5% of the time. More complex use cases will be supported by the router via the use of coprocessors/rhai to resolve arbitrary labels to true/false values (i.e. via a feature flag service). - Support `@join__directive(graphs, name, args)` directives ([#2894](#2894)) ### Patch Changes - Allow known `FeatureDefinition` subclasses to define custom subgraph schema validation rules ([#2910](#2910)) - Updated dependencies \[[`6ae42942b13dccd246ccc994faa2cb36cd62cb3c`](6ae4294), [`66833fb8d04c9376f6ed476fed6b1ca237f477b7`](66833fb), [`931f87c6766c7439936df706727cbdc0cd6bcfd8`](931f87c)]: - @apollo/query-graphs@2.7.0 - @apollo/federation-internals@2.7.0 ## @apollo/gateway@2.7.0 ### Minor Changes - Implement progressive `@override` functionality ([#2911](#2911)) The progressive `@override` feature brings a new argument to the `@override` directive: `label: String`. When a label is added to an `@override` application, the override becomes conditional, depending on parameters provided to the query planner (a set of which labels should be overridden). Note that this feature will be supported in router for enterprise users only. Out-of-the-box, the router will support a percentage-based use case for progressive `@override`. For example: ```graphql type Query { hello: String @OverRide(from: "original", label: "percent(5)") } ``` The above example will override the root `hello` field from the "original" subgraph 5% of the time. More complex use cases will be supported by the router via the use of coprocessors/rhai to resolve arbitrary labels to true/false values (i.e. via a feature flag service). ### Patch Changes - Updated dependencies \[[`6ae42942b13dccd246ccc994faa2cb36cd62cb3c`](6ae4294), [`66833fb8d04c9376f6ed476fed6b1ca237f477b7`](66833fb), [`931f87c6766c7439936df706727cbdc0cd6bcfd8`](931f87c)]: - @apollo/query-planner@2.7.0 - @apollo/composition@2.7.0 - @apollo/federation-internals@2.7.0 ## @apollo/federation-internals@2.7.0 ### Minor Changes - Implement progressive `@override` functionality ([#2911](#2911)) The progressive `@override` feature brings a new argument to the `@override` directive: `label: String`. When a label is added to an `@override` application, the override becomes conditional, depending on parameters provided to the query planner (a set of which labels should be overridden). Note that this feature will be supported in router for enterprise users only. Out-of-the-box, the router will support a percentage-based use case for progressive `@override`. For example: ```graphql type Query { hello: String @OverRide(from: "original", label: "percent(5)") } ``` The above example will override the root `hello` field from the "original" subgraph 5% of the time. More complex use cases will be supported by the router via the use of coprocessors/rhai to resolve arbitrary labels to true/false values (i.e. via a feature flag service). - Allow known `FeatureDefinition` subclasses to define custom subgraph schema validation rules ([#2910](#2910)) - Support `@join__directive(graphs, name, args)` directives ([#2894](#2894)) ## @apollo/query-graphs@2.7.0 ### Minor Changes - Implement progressive `@override` functionality ([#2911](#2911)) The progressive `@override` feature brings a new argument to the `@override` directive: `label: String`. When a label is added to an `@override` application, the override becomes conditional, depending on parameters provided to the query planner (a set of which labels should be overridden). Note that this feature will be supported in router for enterprise users only. Out-of-the-box, the router will support a percentage-based use case for progressive `@override`. For example: ```graphql type Query { hello: String @OverRide(from: "original", label: "percent(5)") } ``` The above example will override the root `hello` field from the "original" subgraph 5% of the time. More complex use cases will be supported by the router via the use of coprocessors/rhai to resolve arbitrary labels to true/false values (i.e. via a feature flag service). ### Patch Changes - Updated dependencies \[[`6ae42942b13dccd246ccc994faa2cb36cd62cb3c`](6ae4294), [`66833fb8d04c9376f6ed476fed6b1ca237f477b7`](66833fb), [`931f87c6766c7439936df706727cbdc0cd6bcfd8`](931f87c)]: - @apollo/federation-internals@2.7.0 ## @apollo/query-planner@2.7.0 ### Minor Changes - Implement progressive `@override` functionality ([#2911](#2911)) The progressive `@override` feature brings a new argument to the `@override` directive: `label: String`. When a label is added to an `@override` application, the override becomes conditional, depending on parameters provided to the query planner (a set of which labels should be overridden). Note that this feature will be supported in router for enterprise users only. Out-of-the-box, the router will support a percentage-based use case for progressive `@override`. For example: ```graphql type Query { hello: String @OverRide(from: "original", label: "percent(5)") } ``` The above example will override the root `hello` field from the "original" subgraph 5% of the time. More complex use cases will be supported by the router via the use of coprocessors/rhai to resolve arbitrary labels to true/false values (i.e. via a feature flag service). ### Patch Changes - Updated dependencies \[[`6ae42942b13dccd246ccc994faa2cb36cd62cb3c`](6ae4294), [`66833fb8d04c9376f6ed476fed6b1ca237f477b7`](66833fb), [`931f87c6766c7439936df706727cbdc0cd6bcfd8`](931f87c)]: - @apollo/query-graphs@2.7.0 - @apollo/federation-internals@2.7.0 ## @apollo/subgraph@2.7.0 ### Minor Changes - Implement progressive `@override` functionality ([#2911](#2911)) The progressive `@override` feature brings a new argument to the `@override` directive: `label: String`. When a label is added to an `@override` application, the override becomes conditional, depending on parameters provided to the query planner (a set of which labels should be overridden). Note that this feature will be supported in router for enterprise users only. Out-of-the-box, the router will support a percentage-based use case for progressive `@override`. For example: ```graphql type Query { hello: String @OverRide(from: "original", label: "percent(5)") } ``` The above example will override the root `hello` field from the "original" subgraph 5% of the time. More complex use cases will be supported by the router via the use of coprocessors/rhai to resolve arbitrary labels to true/false values (i.e. via a feature flag service). ### Patch Changes - Updated dependencies \[[`6ae42942b13dccd246ccc994faa2cb36cd62cb3c`](6ae4294), [`66833fb8d04c9376f6ed476fed6b1ca237f477b7`](66833fb), [`931f87c6766c7439936df706727cbdc0cd6bcfd8`](931f87c)]: - @apollo/federation-internals@2.7.0 ## apollo-federation-integration-testsuite@2.7.0 Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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 are a number of
// TODOcomments left in this implementation, but this PR demonstrates a basic framework for allowing knownFeatureDefinitionsubclasses, likeSourceSpecDefinition, to define their own subgraph validation rules, by overriding thevalidateSubgraphSchema(schema: Schema): GraphQLError[]method.It's the responsibility of
validateSubgraphSchemato determine if its validation rules are applicable to a given schema, ideally returning an empty array quickly if the feature in question is not used in the schema.In order for
validateKnownFeaturesto work, a givenFeatureDefinitionsubclass needs to have been registered withregisterKnownFeature.I'll keep working on the
TODOs and the tests.