fix(federation): Prevent @tag and @inaccessible usages on fields marked @external #869
Conversation
trevor-scheer
force-pushed
the
trevor/fix-867
branch
from
f55eab7
to
295ac98
Compare
trevor-scheer
force-pushed
the
trevor/fix-866
branch
from
7b518fc
to
10a7b57
Compare
trevor-scheer
force-pushed
the
trevor/fix-867
branch
from
295ac98
to
492ae7b
Compare
trevor-scheer
changed the title
|
|
||
| | Code | Description | | ||
| |---|---| | ||
| | `TAG_USED_WITH_EXTERNAL` | Fields marked as `@external` cannot also have `@tag` usages. | |
There was a problem hiding this comment.
This seems fine for now, but I wonder if we should generalize this to other directives.
There was a problem hiding this comment.
@martijnwalraven @trevor-scheer should we add the same handling for@inaccessible here as well -- even if we don't generalize just yet?
There was a problem hiding this comment.
also how will we handle @tag and @inaccessible on value types referenced only from @external fields, like this example?
| @@ -39,7 +39,7 @@ export interface FederationField { | |||
| requires?: ReadonlyArray<SelectionNode>; | |||
| provides?: ReadonlyArray<SelectionNode>; | |||
| belongsToValueType?: boolean; | |||
| appliedDirectives?: DirectiveNode[] | |||
| otherKnownDirectives?: DirectiveNode[] | |||
There was a problem hiding this comment.
Note that these are directive usages / applications, not directive definitions. (The naming in graphql-js is confusing, but GraphQLDirective is a directive definition, while DirectiveNode is a usage.)
There was a problem hiding this comment.
Got it! Went through and clarified the naming a bit further - everything is either named usage or definition accordingly. A bit verbose but helpful I think.
trevor-scheer
force-pushed
the
trevor/fix-866
branch
from
10a7b57
to
89f7eda
Compare
Also rename 'appliedDirectives' to 'otherKnownDirectives'
This reverts most of the previous implementation in favor of a new composition error which prevents users from confusingly using both @tag and @external together. For now, @tag is expected to have implications with schema contracts and in the context of an external field, it's not well-defined what that would actually mean. We may revisit and relax this in the future, but for now have decided to just prevent the possible confusion.
trevor-scheer
force-pushed
the
trevor/fix-867
branch
from
a68ab81
to
884da2c
Compare
trevor-scheer
changed the title
|
Overridden by #880 |
This PR introduces new composition errors to prevent the usage of
@tagand@inaccessibleon a field that is marked@external. Since@tagis part of Studio's API, we're going to block this usage for now to prevent confusion. Similarly,@inaccessibleusage on@externaldoesn't really mean anything, so allowing it will probably lead to confusion as users may not know what to expect.This may be relaxed in the future in order to accommodate an actual semantic usage of the combination or possibly just a warning (warnings don't exist yet, but this could be a good candidate for one if we choose to go down that path).
This PR also handles the rename of
appliedDirectivesrecommended in feedback on #859.Fixes: #867