Skip to content

fix: check for external on parent type #167

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.

Sign up for GitHub

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

Merged
merged 3 commits into from
Sep 15, 2025
Merged

fix: check for external on parent type #167

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ff7cce2
fix: check for external on parent type
jdolle Jul 30, 2025
9054ef7
Add back original test cases
jdolle Jul 30, 2025
e2bbc47
Changeset
jdolle Sep 1, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/tiny-ways-add.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@theguild/federation-composition": patch
---

Respect @external on parent type
182 changes: 145 additions & 37 deletions __tests__/composition.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4026,6 +4026,63 @@ testImplementations((api) => {
`);
});

test("@external + @tag", () => {
const subgraphs = [
{
name: "a",
typeDefs: parse(/* GraphQL */ `
extend schema @link(url: "https://specs.apollo.dev/federation/${version}", import: ["@key", "@tag"])

type Product @key(fields: "id") {
id: ID! @tag(name: "public")
name: String! @tag(name: "public")
inStock: Int! @tag(name: "public")
}

type Query {
products: [Product] @tag(name: "public")
}
`),
},
{
name: "b",
typeDefs: parse(/* GraphQL */ `
extend schema
@link(
url: "https://specs.apollo.dev/federation/${version}"
import: ["@key", "@external", "@requires", "@tag"]
)

type Product @key(fields: "id") {
id: ID! @tag(name: "public")
inStock: Int! @external
isAvailable: String! @requires(fields: "inStock") @tag(name: "public")
}
`),
},
];

const result = composeServices(subgraphs);
expect(result.errors).toEqual(undefined);
assertCompositionSuccess(result);

expect(result.supergraphSdl).toContainGraphQL(/* GraphQL */ `
type Product
@join__type(graph: A, key: "id")
@join__type(graph: B, key: "id") {
id: ID! @tag(name: "public")
name: String! @join__field(graph: A) @tag(name: "public")
inStock: Int!
@join__field(graph: A)
@join__field(graph: B, external: true)
@tag(name: "public")
isAvailable: String!
@join__field(graph: B, requires: "inStock")
@tag(name: "public")
}
`);
});

test("@tag", () => {
const result = composeServices([
{
Expand Down Expand Up @@ -7224,6 +7281,75 @@ testImplementations((api) => {
});

test("external on non-key field of an entity type", () => {
/** "apollo" errors on this schema definition */
api.runIf("guild", () => {
let result = api.composeServices([
{
name: "a",
typeDefs: parse(/* GraphQL */ `
extend schema
@link(url: "https://specs.apollo.dev/link/v1.0")
@link(
url: "https://specs.apollo.dev/federation/v2.8"
import: ["@key", "@external", "@requires", "@tag"]
)

type User @key(fields: "id") {
id: ID! @tag(name: "public")
creditScore: Int @requires(fields: "ssn") @tag(name: "public")
}

extend type User @external {
ssn: String
}
`),
},
{
name: "b",
typeDefs: parse(/* GraphQL */ `
schema
@link(url: "https://specs.apollo.dev/link/v1.0")
@link(
url: "https://specs.apollo.dev/federation/v2.8"
import: ["@key", "@tag"]
) {
query: Query
}

type Query {
user: User @tag(name: "public")
}

type User @key(fields: "id") {
id: ID! @tag(name: "public")
ssn: String
}
`),
},
]);

expect(result.errors).toEqual(undefined);
assertCompositionSuccess(result);

expect(result.supergraphSdl).toContainGraphQL(/* GraphQL */ `
type Query @join__type(graph: A) @join__type(graph: B) {
user: User @join__field(graph: B) @tag(name: "public")
}

type User
@join__type(graph: A, key: "id")
@join__type(graph: B, key: "id") {
id: ID! @tag(name: "public")
creditScore: Int
@join__field(graph: A, requires: "ssn")
@tag(name: "public")
ssn: String
@join__field(external: true, graph: A)
@join__field(graph: B)
}
`);
});

let result = api.composeServices([
{
name: "foo",
Expand All @@ -7233,22 +7359,18 @@ testImplementations((api) => {
url: "https://specs.apollo.dev/federation/v2.3"
import: ["@key", "@external", "@provides", "@shareable"]
)

type Note @key(fields: "id") @shareable {
id: ID!
name: String @external
author: User @external
}

type User @key(fields: "id", resolvable: false) {
id: ID!
}

type PrivateNote @key(fields: "id") @shareable {
id: ID!
note: Note @provides(fields: "name author { id }")
}

type Query {
note: Note @shareable
privateNote: PrivateNote @shareable
Expand All @@ -7260,29 +7382,25 @@ testImplementations((api) => {
typeDefs: parse(/* GraphQL */ `
extend schema
@link(
url: "https://specs.apollo.dev/federation/v2.3"
import: ["@key", "@shareable"]
url: "https://specs.apollo.dev/federation/v2.3"
import: ["@key", "@shareable"]
)

type Note @key(fields: "id") @shareable {
id: ID!
name: String
author: User
}

type User @key(fields: "id") {
id: ID!
name: String
}

type PrivateNote @key(fields: "id") @shareable {
id: ID!
note: Note
id: ID!
name: String
}

type Query {
note: Note @shareable
privateNote: PrivateNote @shareable
type PrivateNote @key(fields: "id") @shareable {
id: ID!
note: Note
}
type Query {
note: Note @shareable
privateNote: PrivateNote @shareable
}
`),
},
Expand All @@ -7307,29 +7425,25 @@ testImplementations((api) => {
result = api.composeServices([
{
name: "foo",
typeDefs: parse(/* GraphQL */ `
typeDefs: parse(/* GraphQL */ `
extend schema
@link(
@link(
url: "https://specs.apollo.dev/federation/v2.3"
import: ["@key", "@external", "@provides", "@shareable"]
)

type Note @key(fields: "id") @shareable {
id: ID!
name: String @external
author: User @external
}

type User @key(fields: "id", resolvable: false) {
id: ID!
}

type PrivateNote @key(fields: "id") @shareable {
id: ID!
note: Note @provides(fields: "name author { id }")
}

type Query {
}
type Query {
note: Note @shareable
privateNote: PrivateNote @shareable
}
Expand All @@ -7343,23 +7457,19 @@ testImplementations((api) => {
url: "https://specs.apollo.dev/federation/v2.3"
import: ["@key", "@shareable"]
)

type Note @key(fields: "id") @shareable {
id: ID!
name: String
author: User
}

type User @key(fields: "id") {
}
type User @key(fields: "id") {
id: ID!
name: String
}

type PrivateNote @key(fields: "id") @shareable {
id: ID!
note: Note
}

type Query {
note: Note @shareable
privateNote: PrivateNote @shareable
Expand All @@ -7374,15 +7484,13 @@ testImplementations((api) => {
url: "https://specs.apollo.dev/federation/v2.3"
import: ["@key", "@external", "@provides", "@shareable"]
)

type Query {
hello: String
}

type Note @key(fields: "id") @shareable {
id: ID!
tag: String
}
}
`),
},
]);
Expand All @@ -7402,7 +7510,7 @@ testImplementations((api) => {
@join__field(external: true, graph: FOO)
@join__field(graph: BAR)
tag: String @join__field(graph: BAZ)
}
}
`);
});

Expand Down
10 changes: 7 additions & 3 deletions src/subgraph/helpers.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -331,9 +331,13 @@ export function visitFields({
}

if (!isTypename && (interceptNonExternalField || interceptExternalField)) {
const isExternal = selectionFieldDef.directives?.some((d) =>
context.isAvailableFederationDirective("external", d),
);
const isExternal =
selectionFieldDef.directives?.some((d) =>
context.isAvailableFederationDirective("external", d),
) ||
typeDefinition.directives?.some((d) =>
context.isAvailableFederationDirective("external", d),
);
const fieldName = selection.name.value;

// ignore if it's not a leaf
Expand Down