Skip to content
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

Jump to bottom

Interface object #2279

Merged
merged 4 commits into from
Dec 14, 2022
Merged

Interface object #2279

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
9bae09b
Implements @interfaceObject and @key on interfaces.
Oct 26, 2022
5e5d03e
Implements review feedback
Dec 8, 2022
3b5eee8
regen error doc
Dec 8, 2022
2fb8f7e
changelogs
Dec 14, 2022
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
6 changes: 3 additions & 3 deletions composition-js/src/__tests__/__snapshots__/compose.composeDirective.test.ts.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
exports[`composing custom core directives custom tag directive works when federation tag is renamed 1`] = `
"schema
@link(url: \\"https://specs.apollo.dev/link/v1.0\\")
@link(url: \\"https://specs.apollo.dev/join/v0.2\\", for: EXECUTION)
@link(url: \\"https://specs.apollo.dev/join/v0.3\\", for: EXECUTION)
@link(url: \\"https://specs.apollo.dev/tag/v0.2\\", as: \\"mytag\\")
@link(url: \\"https://custom.dev/tag/v1.0\\", import: [\\"@tag\\"])
{
Expand All @@ -14,9 +14,9 @@ directive @link(url: String, as: String, for: link__Purpose, import: [link__Impo

directive @join__graph(name: String!, url: String!) on ENUM_VALUE

directive @join__type(graph: join__Graph!, key: join__FieldSet, extension: Boolean! = false, resolvable: Boolean! = true) repeatable on OBJECT | INTERFACE | UNION | ENUM | INPUT_OBJECT | SCALAR
directive @join__type(graph: join__Graph!, key: join__FieldSet, extension: Boolean! = false, resolvable: Boolean! = true, isInterfaceObject: Boolean! = false) repeatable on OBJECT | INTERFACE | UNION | ENUM | INPUT_OBJECT | SCALAR

directive @join__field(graph: join__Graph!, requires: join__FieldSet, provides: join__FieldSet, type: String, external: Boolean, override: String, usedOverridden: Boolean) repeatable on FIELD_DEFINITION | INPUT_FIELD_DEFINITION
directive @join__field(graph: join__Graph, requires: join__FieldSet, provides: join__FieldSet, type: String, external: Boolean, override: String, usedOverridden: Boolean) repeatable on FIELD_DEFINITION | INPUT_FIELD_DEFINITION

directive @join__implements(graph: join__Graph!, interface: String!) repeatable on OBJECT | INTERFACE

Expand Down
248 changes: 242 additions & 6 deletions composition-js/src/__tests__/compose.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,18 +56,18 @@ describe('composition', () => {
expect(result.supergraphSdl).toMatchString(`
schema
@link(url: "https://specs.apollo.dev/link/v1.0")
@link(url: "https://specs.apollo.dev/join/v0.2", for: EXECUTION)
@link(url: "https://specs.apollo.dev/join/v0.3", for: EXECUTION)
{
query: Query
}

directive @join__field(graph: join__Graph!, requires: join__FieldSet, provides: join__FieldSet, type: String, external: Boolean, override: String, usedOverridden: Boolean) repeatable on FIELD_DEFINITION | INPUT_FIELD_DEFINITION
directive @join__field(graph: join__Graph, requires: join__FieldSet, provides: join__FieldSet, type: String, external: Boolean, override: String, usedOverridden: Boolean) repeatable on FIELD_DEFINITION | INPUT_FIELD_DEFINITION

directive @join__graph(name: String!, url: String!) on ENUM_VALUE

directive @join__implements(graph: join__Graph!, interface: String!) repeatable on OBJECT | INTERFACE

directive @join__type(graph: join__Graph!, key: join__FieldSet, extension: Boolean! = false, resolvable: Boolean! = true) repeatable on OBJECT | INTERFACE | UNION | ENUM | INPUT_OBJECT | SCALAR
directive @join__type(graph: join__Graph!, key: join__FieldSet, extension: Boolean! = false, resolvable: Boolean! = true, isInterfaceObject: Boolean! = false) repeatable on OBJECT | INTERFACE | UNION | ENUM | INPUT_OBJECT | SCALAR

directive @link(url: String, as: String, for: link__Purpose, import: [link__Import]) repeatable on SCHEMA

Expand Down Expand Up @@ -2135,18 +2135,18 @@ describe('composition', () => {
expect(printSchema(supergraph)).toMatchString(`
schema
@link(url: \"https://specs.apollo.dev/link/v1.0\")
@link(url: \"https://specs.apollo.dev/join/v0.2\", for: EXECUTION)
@link(url: \"https://specs.apollo.dev/join/v0.3\", for: EXECUTION)
{
query: Query
}

directive @join__field(graph: join__Graph!, requires: join__FieldSet, provides: join__FieldSet, type: String, external: Boolean, override: String, usedOverridden: Boolean) repeatable on FIELD_DEFINITION | INPUT_FIELD_DEFINITION
directive @join__field(graph: join__Graph, requires: join__FieldSet, provides: join__FieldSet, type: String, external: Boolean, override: String, usedOverridden: Boolean) repeatable on FIELD_DEFINITION | INPUT_FIELD_DEFINITION

directive @join__graph(name: String!, url: String!) on ENUM_VALUE

directive @join__implements(graph: join__Graph!, interface: String!) repeatable on OBJECT | INTERFACE

directive @join__type(graph: join__Graph!, key: join__FieldSet, extension: Boolean! = false, resolvable: Boolean! = true) repeatable on OBJECT | INTERFACE | UNION | ENUM | INPUT_OBJECT | SCALAR
directive @join__type(graph: join__Graph!, key: join__FieldSet, extension: Boolean! = false, resolvable: Boolean! = true, isInterfaceObject: Boolean! = false) repeatable on OBJECT | INTERFACE | UNION | ENUM | INPUT_OBJECT | SCALAR

directive @link(url: String, as: String, for: link__Purpose, import: [link__Import]) repeatable on SCHEMA

Expand Down Expand Up @@ -3260,4 +3260,240 @@ describe('composition', () => {
}
`);
});

describe('@interfaceObject', () => {
it('composes valid @interfaceObject usages correctly', () => {
const subgraphA = {
typeDefs: gql`
type Query {
iFromA: I
}

interface I @key(fields: "id") {
id: ID!
x: Int
}

type A implements I @key(fields: "id") {
id: ID!
x: Int
w: Int
}

type B implements I @key(fields: "id") {
id: ID!
x: Int
z: Int
}
`,
name: 'subgraphA',
};

const subgraphB = {
typeDefs: gql`
type Query {
iFromB: I
}

type I @interfaceObject @key(fields: "id") {
id: ID!
y: Int
}
`,
name: 'subgraphB',
};

const result = composeAsFed2Subgraphs([subgraphA, subgraphB]);
assertCompositionSuccess(result);

const [_, api] = schemas(result);
expect(printSchema(api)).toMatchString(`
type A implements I {
id: ID!
x: Int
w: Int
y: Int
}

type B implements I {
id: ID!
x: Int
z: Int
y: Int
}

interface I {
id: ID!
x: Int
y: Int
}

type Query {
iFromA: I
iFromB: I
}
`);
});

it('errors if @interfaceObject is used with no corresponding interface', () => {
const subgraphA = {
typeDefs: gql`
type Query {
iFromA: I
}

type I @interfaceObject @key(fields: "id") {
id: ID!
x: Int
}
`,
name: 'subgraphA',
};

const subgraphB = {
typeDefs: gql`
type Query {
iFromB: I
}

type I @interfaceObject @key(fields: "id") {
id: ID!
y: Int
}
`,
name: 'subgraphB',
};

const result = composeAsFed2Subgraphs([subgraphA, subgraphB]);
expect(result.errors).toBeDefined();
expect(errors(result)).toStrictEqual([[
'INTERFACE_OBJECT_USAGE_ERROR',
'Type "I" is declared with @interfaceObject in all the subgraphs in which is is defined (it is defined in subgraphs "subgraphA" and "subgraphB" but should be defined as an interface in at least one subgraph)'
]]);
});

it('errors if @interfaceObject is missing in some subgraph', () => {
const subgraphA = {
typeDefs: gql`
type Query {
iFromA: I
}

interface I @key(fields: "id") {
id: ID!
x: Int
}

type A implements I @key(fields: "id") {
id: ID!
x: Int
}
`,
name: 'subgraphA',
};

const subgraphB = {
typeDefs: gql`
type Query {
iFromB: I
}

type I @interfaceObject @key(fields: "id") {
id: ID!
y: Int
}
`,
name: 'subgraphB',
};

const subgraphC = {
typeDefs: gql`
type Query {
iFromC: I
}

type I @key(fields: "id") {
id: ID!
z: Int
}
`,
name: 'subgraphC',
};

const result = composeAsFed2Subgraphs([subgraphA, subgraphB, subgraphC]);
expect(result.errors).toBeDefined();
// Note: the error is a bit of a mouthful, but it should be clear enough and making it more compact requires
// a bit more special code on the error generation side and it's not clear it's worth the trouble (since again,
// the error should point to the problem well enough).
expect(errors(result)).toStrictEqual([[
'TYPE_KIND_MISMATCH',
'Type "I" has mismatched kind: it is defined as Interface Type in subgraph "subgraphA" but Interface Object Type (Object Type with @interfaceObject) in subgraph "subgraphB" and Object Type in subgraph "subgraphC"',
]]);
});

it('errors if an interface has a @key but the subgraph do not know all implementations', () => {
const subgraphA = {
typeDefs: gql`
type Query {
iFromA: I
}

interface I @key(fields: "id") {
id: ID!
x: Int
}

type A implements I @key(fields: "id") {
id: ID!
x: Int
w: Int
}

type B implements I @key(fields: "id") {
id: ID!
x: Int
z: Int
}
`,
name: 'subgraphA',
};

const subgraphB = {
typeDefs: gql`
type Query {
iFromB: I
}

type I @interfaceObject @key(fields: "id") {
id: ID!
y: Int
}
`,
name: 'subgraphB',
};

const subgraphC = {
typeDefs: gql`
interface I {
id: ID!
x: Int
}

type C implements I @key(fields: "id") {
id: ID!
x: Int
w: Int
}
`,
name: 'subgraphC',
}

const result = composeAsFed2Subgraphs([subgraphA, subgraphB, subgraphC]);
expect(result.errors).toBeDefined();
expect(errors(result)).toStrictEqual([[
'INTERFACE_KEY_MISSING_IMPLEMENTATION_TYPE',
'[subgraphA] Interface type "I" has a resolvable key (@key(fields: "id")) in subgraph "subgraphA" but that subgraph is missing some of the supergraph implementation types of "I". Subgraph "subgraphA" should define type "C" (and have it implement "I").',
]]);
});
});
});
Loading