Skip to content

Preserve @external, @requires, and @provides metadata on @interfaceObject fields #340

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

Open
kamilkisiela wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Preserve @external, @requires, and @provides metadata on @interfaceObject fields #340

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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/friendly-fields-compose.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@theguild/federation-composition": patch
---

Preserve `@external`, `@requires`, and `@provides` metadata when composing fields contributed by `@interfaceObject` subgraphs.
287 changes: 287 additions & 0 deletions __tests__/interface-object-composition.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -198,6 +198,293 @@ testImplementations((api) => {
`);
});

test.each([
{
description: "a field with arguments",
priceField: "price(currency: String!): Int!",
requires: 'price(currency: "EUR")',
},
{
description: "a field without arguments",
priceField: "price: Int!",
requires: "price",
},
])(
"preserves @external on an @interfaceObject field ($description)",
({ priceField, requires }) => {
const result = api.composeServices([
{
name: "shop",
typeDefs: parse(/* GraphQL */ `
extend schema
@link(
url: "https://specs.apollo.dev/federation/v2.3"
import: ["@key", "@shareable"]
)

type Query {
things: [Node!]!
}

interface Node @key(fields: "id") {
id: ID!
${priceField}
}

type Cat implements Node @key(fields: "id") {
id: ID!
${priceField} @shareable
meow: String!
}

type Dog implements Node @key(fields: "id") {
id: ID!
${priceField} @shareable
bark: String!
}
`),
},
{
name: "pricing",
typeDefs: parse(/* GraphQL */ `
extend schema
@link(
url: "https://specs.apollo.dev/federation/v2.3"
import: ["@key", "@external", "@requires", "@interfaceObject"]
)

type Node @key(fields: "id") @interfaceObject {
id: ID!
${priceField} @external
eur: Int! @requires(fields: ${JSON.stringify(requires)})
}
`),
},
]);

assertCompositionSuccess(result);

expect(result.supergraphSdl).toContainGraphQL(/* GraphQL */ `
interface Node
@join__type(graph: PRICING, key: "id", isInterfaceObject: true)
@join__type(graph: SHOP, key: "id") {
id: ID!
${priceField}
@join__field(graph: PRICING, external: true)
@join__field(graph: SHOP)
eur: Int!
@join__field(graph: PRICING, requires: ${JSON.stringify(requires)})
}
`);
},
);

test("preserves @requires on a shared @interfaceObject field", () => {
const result = api.composeServices([
{
name: "shop",
typeDefs: parse(/* GraphQL */ `
extend schema
@link(
url: "https://specs.apollo.dev/federation/v2.3"
import: ["@key", "@shareable"]
)

type Query {
things: [Node!]!
}

interface Node @key(fields: "id") {
id: ID!
factor: Int!
price: Int!
}

type Cat implements Node @key(fields: "id") {
id: ID!
factor: Int!
price: Int! @shareable
meow: String!
}
`),
},
{
name: "pricing",
typeDefs: parse(/* GraphQL */ `
extend schema
@link(
url: "https://specs.apollo.dev/federation/v2.3"
import: [
"@key"
"@external"
"@requires"
"@interfaceObject"
"@shareable"
]
)

type Node @key(fields: "id") @interfaceObject {
id: ID!
factor: Int! @external
price: Int! @shareable @requires(fields: "factor")
}
`),
},
]);

assertCompositionSuccess(result);

expect(result.supergraphSdl).toContainGraphQL(/* GraphQL */ `
interface Node
@join__type(graph: PRICING, key: "id", isInterfaceObject: true)
@join__type(graph: SHOP, key: "id") {
id: ID!
factor: Int!
@join__field(graph: PRICING, external: true)
@join__field(graph: SHOP)
price: Int!
@join__field(graph: PRICING, requires: "factor")
@join__field(graph: SHOP)
}
`);
});

test("preserves @provides on an @interfaceObject field", () => {
const result = api.composeServices([
{
name: "shop",
typeDefs: parse(/* GraphQL */ `
extend schema
@link(
url: "https://specs.apollo.dev/federation/v2.3"
import: ["@key"]
)

type Query {
things: [Node!]!
}

interface Node @key(fields: "id") {
id: ID!
}

type Cat implements Node @key(fields: "id") {
id: ID!
}
`),
},
{
name: "pricing",
typeDefs: parse(/* GraphQL */ `
extend schema
@link(
url: "https://specs.apollo.dev/federation/v2.3"
import: [
"@key"
"@interfaceObject"
"@provides"
"@external"
]
)

type Node @key(fields: "id") @interfaceObject {
id: ID!
review: Review! @provides(fields: "score")
}

type Review {
score: Int! @external
}
`),
},
{
name: "reviews",
typeDefs: parse(/* GraphQL */ `
extend schema
@link(
url: "https://specs.apollo.dev/federation/v2.3"
import: ["@shareable"]
)

type Query {
review: Review
}

type Review {
score: Int! @shareable
}
`),
},
]);

assertCompositionSuccess(result);

expect(result.supergraphSdl).toContainGraphQL(/* GraphQL */ `
interface Node
@join__type(graph: PRICING, key: "id", isInterfaceObject: true)
@join__type(graph: SHOP, key: "id") {
id: ID!
review: Review! @join__field(graph: PRICING, provides: "score")
}
`);
});

test("preserves @external on a concrete entity field", () => {
const priceRequirement = JSON.stringify('price(currency: "EUR")');
const result = api.composeServices([
{
name: "shop",
typeDefs: parse(/* GraphQL */ `
extend schema
@link(
url: "https://specs.apollo.dev/federation/v2.3"
import: ["@key"]
)

type Query {
cat: Cat
}

type Cat @key(fields: "id") {
id: ID!
price(currency: String!): Int!
}
`),
},
{
name: "pricing",
typeDefs: parse(/* GraphQL */ `
extend schema
@link(
url: "https://specs.apollo.dev/federation/v2.3"
import: ["@key", "@external", "@requires"]
)

type Cat @key(fields: "id") {
id: ID!
price(currency: String!): Int! @external
eur: Int! @requires(fields: ${priceRequirement})
}
`),
},
]);

assertCompositionSuccess(result);

expect(result.supergraphSdl).toContainGraphQL(/* GraphQL */ `
type Cat
@join__type(graph: PRICING, key: "id")
@join__type(graph: SHOP, key: "id") {
id: ID!
price(currency: String!): Int!
@join__field(graph: PRICING, external: true)
@join__field(graph: SHOP)
eur: Int!
@join__field(graph: PRICING, requires: ${priceRequirement})
}
`);
});

test("link directive does not have to import @interfaceObject in all subgraphs", () => {
const result = api.composeServices([
{
Expand Down
10 changes: 9 additions & 1 deletion src/subgraph/state.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1709,7 +1709,11 @@ function objectTypeFactory(
},
setProvides(typeName: string, fieldName: string, provides: string) {
if (isInterfaceObject(typeName)) {
return;
return interfaceTypeBuilder.field.setProvides(
typeName,
fieldName,
provides,
);
}

getOrCreateObjectField(
Expand Down Expand Up @@ -2125,6 +2129,10 @@ function interfaceTypeFactory(state: SubgraphState) {
getOrCreateInterfaceField(state, typeName, fieldName).requires =
requires;
},
setProvides(typeName: string, fieldName: string, provides: string) {
getOrCreateInterfaceField(state, typeName, fieldName).provides =
provides;
},
setShareable(typeName: string, fieldName: string) {
getOrCreateInterfaceField(state, typeName, fieldName).shareable = true;
},
Expand Down
24 changes: 12 additions & 12 deletions src/supergraph/composition/interface-type.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -268,21 +268,21 @@ export function interfaceTypeBuilder(): TypeBuilder<
return createInterfaceTypeNode({
name: interfaceType.name,
fields: Array.from(interfaceType.fields.values()).map((field) => {
let nonEmptyJoinField = false;
const joinFields: JoinFieldAST[] = [];
const hasJoinFieldMetadata = Array.from(field.byGraph.values()).some(
(meta) =>
meta.type !== field.type ||
meta.override ||
meta.provides ||
meta.requires ||
meta.external,
);

if (field.byGraph.size !== interfaceType.byGraph.size) {
if (
field.byGraph.size !== interfaceType.byGraph.size ||
hasJoinFieldMetadata
) {
for (const [graphId, meta] of field.byGraph.entries()) {
if (
meta.type !== field.type ||
meta.override ||
meta.provides ||
meta.requires ||
meta.external
) {
nonEmptyJoinField = true;
}

joinFields.push({
graph: graphId,
type: meta.type === field.type ? undefined : meta.type,
Expand Down
Loading