import { describe, it } from 'mocha';
import type { GraphQLSchema } from '../../type/schema.js';
import { buildSchema } from '../../utilities/buildASTSchema.js';
import { OverlappingFieldsCanBeMergedRule } from '../rules/OverlappingFieldsCanBeMergedRule.js';
import {
expectValidationErrors,
expectValidationErrorsWithSchema,
} from './harness.js';
function expectErrors(queryStr: string) {
return expectValidationErrors(OverlappingFieldsCanBeMergedRule, queryStr);
}
function expectValid(queryStr: string) {
expectErrors(queryStr).toDeepEqual([]);
}
function expectErrorsWithSchema(schema: GraphQLSchema, queryStr: string) {
return expectValidationErrorsWithSchema(
schema,
OverlappingFieldsCanBeMergedRule,
queryStr,
);
}
function expectValidWithSchema(schema: GraphQLSchema, queryStr: string) {
expectErrorsWithSchema(schema, queryStr).toDeepEqual([]);
}
describe('Validate: Overlapping fields can be merged', () => {
it('unique fields', () => {
expectValid(`
fragment uniqueFields on Dog {
name
nickname
}
`);
});
it('identical fields', () => {
expectValid(`
fragment mergeIdenticalFields on Dog {
name
name
}
`);
});
it('identical fields with identical args', () => {
expectValid(`
fragment mergeIdenticalFieldsWithIdenticalArgs on Dog {
doesKnowCommand(dogCommand: SIT)
doesKnowCommand(dogCommand: SIT)
}
`);
});
it('identical fields with identical directives', () => {
expectValid(`
fragment mergeSameFieldsWithSameDirectives on Dog {
name @include(if: true)
name @include(if: true)
}
`);
});
it('different args with different aliases', () => {
expectValid(`
fragment differentArgsWithDifferentAliases on Dog {
knowsSit: doesKnowCommand(dogCommand: SIT)
knowsDown: doesKnowCommand(dogCommand: DOWN)
}
`);
});
it('different directives with different aliases', () => {
expectValid(`
fragment differentDirectivesWithDifferentAliases on Dog {
nameIfTrue: name @include(if: true)
nameIfFalse: name @include(if: false)
}
`);
});
it('different skip/include directives accepted', () => {
expectValid(`
fragment differentDirectivesWithDifferentAliases on Dog {
name @include(if: true)
name @include(if: false)
}
`);
});
it('Same stream directives supported', () => {
expectValid(`
fragment differentDirectivesWithDifferentAliases on Dog {
name @stream(label: "streamLabel", initialCount: 1)
name @stream(label: "streamLabel", initialCount: 1)
}
`);
});
it('different stream directive label', () => {
expectErrors(`
fragment conflictingArgs on Dog {
name @stream(label: "streamLabel", initialCount: 1)
name @stream(label: "anotherLabel", initialCount: 1)
}
`).toDeepEqual([
{
message:
'Fields "name" conflict because they have differing stream directives. Use different aliases on the fields to fetch both if this was intentional.',
locations: [
{ line: 3, column: 9 },
{ line: 4, column: 9 },
],
},
]);
});
it('different stream directive initialCount', () => {
expectErrors(`
fragment conflictingArgs on Dog {
name @stream(label: "streamLabel", initialCount: 1)
name @stream(label: "streamLabel", initialCount: 2)
}
`).toDeepEqual([
{
message:
'Fields "name" conflict because they have differing stream directives. Use different aliases on the fields to fetch both if this was intentional.',
locations: [
{ line: 3, column: 9 },
{ line: 4, column: 9 },
],
},
]);
});
it('different stream directive first missing args', () => {
expectErrors(`
fragment conflictingArgs on Dog {
name @stream
name @stream(label: "streamLabel", initialCount: 1)
}
`).toDeepEqual([
{
message:
'Fields "name" conflict because they have differing stream directives. Use different aliases on the fields to fetch both if this was intentional.',
locations: [
{ line: 3, column: 9 },
{ line: 4, column: 9 },
],
},
]);
});
it('different stream directive second missing args', () => {
expectErrors(`
fragment conflictingArgs on Dog {
name @stream(label: "streamLabel", initialCount: 1)
name @stream
}
`).toDeepEqual([
{
message:
'Fields "name" conflict because they have differing stream directives. Use different aliases on the fields to fetch both if this was intentional.',
locations: [
{ line: 3, column: 9 },
{ line: 4, column: 9 },
],
},
]);
});
it('different stream directive extra argument', () => {
expectErrors(`
fragment conflictingArgs on Dog {
name @stream(label: "streamLabel", initialCount: 1)
name @stream(label: "streamLabel", initialCount: 1, extraArg: true)
}
`).toDeepEqual([
{
message:
'Fields "name" conflict because they have differing stream directives. Use different aliases on the fields to fetch both if this was intentional.',
locations: [
{ line: 3, column: 9 },
{ line: 4, column: 9 },
],
},
]);
});
it('mix of stream and no stream', () => {
expectErrors(`
fragment conflictingArgs on Dog {
name @stream
name
}
`).toDeepEqual([
{
message:
'Fields "name" conflict because they have differing stream directives. Use different aliases on the fields to fetch both if this was intentional.',
locations: [
{ line: 3, column: 9 },
{ line: 4, column: 9 },
],
},
]);
});
it('different stream directive both missing args', () => {
expectValid(`
fragment conflictingArgs on Dog {
name @stream
name @stream
}
`);
});
it('Same aliases with different field targets', () => {
expectErrors(`
fragment sameAliasesWithDifferentFieldTargets on Dog {
fido: name
fido: nickname
}
`).toDeepEqual([
{
message:
'Fields "fido" conflict because "name" and "nickname" are different fields. Use different aliases on the fields to fetch both if this was intentional.',
locations: [
{ line: 3, column: 9 },
{ line: 4, column: 9 },
],
},
]);
});
it('Same aliases allowed on non-overlapping fields', () => {
expectValid(`
fragment sameAliasesWithDifferentFieldTargets on Pet {
... on Dog {
name
}
... on Cat {
name: nickname
}
}
`);
});
it('Alias masking direct field access', () => {
expectErrors(`
fragment aliasMaskingDirectFieldAccess on Dog {
name: nickname
name
}
`).toDeepEqual([
{
message:
'Fields "name" conflict because "nickname" and "name" are different fields. Use different aliases on the fields to fetch both if this was intentional.',
locations: [
{ line: 3, column: 9 },
{ line: 4, column: 9 },
],
},
]);
});
it('different args, second adds an argument', () => {
expectErrors(`
fragment conflictingArgs on Dog {
doesKnowCommand
doesKnowCommand(dogCommand: HEEL)
}
`).toDeepEqual([
{
message:
'Fields "doesKnowCommand" conflict because they have differing arguments. Use different aliases on the fields to fetch both if this was intentional.',
locations: [
{ line: 3, column: 9 },
{ line: 4, column: 9 },
],
},
]);
});
it('different args, second missing an argument', () => {
expectErrors(`
fragment conflictingArgs on Dog {
doesKnowCommand(dogCommand: SIT)
doesKnowCommand
}
`).toDeepEqual([
{
message:
'Fields "doesKnowCommand" conflict because they have differing arguments. Use different aliases on the fields to fetch both if this was intentional.',
locations: [
{ line: 3, column: 9 },
{ line: 4, column: 9 },
],
},
]);
});
it('conflicting arg values', () => {
expectErrors(`
fragment conflictingArgs on Dog {
doesKnowCommand(dogCommand: SIT)
doesKnowCommand(dogCommand: HEEL)
}
`).toDeepEqual([
{
message:
'Fields "doesKnowCommand" conflict because they have differing arguments. Use different aliases on the fields to fetch both if this was intentional.',
locations: [
{ line: 3, column: 9 },
{ line: 4, column: 9 },
],
},
]);
});
it('conflicting arg names', () => {
expectErrors(`
fragment conflictingArgs on Dog {
isAtLocation(x: 0)
isAtLocation(y: 0)
}
`).toDeepEqual([
{
message:
'Fields "isAtLocation" conflict because they have differing arguments. Use different aliases on the fields to fetch both if this was intentional.',
locations: [
{ line: 3, column: 9 },
{ line: 4, column: 9 },
],
},
]);
});
it('allows different args where no conflict is possible', () => {
expectValid(`
fragment conflictingArgs on Pet {
... on Dog {
name(surname: true)
}
... on Cat {
name
}
}
`);
});
it('allows different order of args', () => {
const schema = buildSchema(`
type Query {
someField(a: String, b: String): String
}
`);
expectValidWithSchema(
schema,
`
{
someField(a: null, b: null)
someField(b: null, a: null)
}
`,
);
});
it('allows different order of input object fields in arg values', () => {
const schema = buildSchema(`
input SomeInput {
a: String
b: String
}
type Query {
someField(arg: SomeInput): String
}
`);
expectValidWithSchema(
schema,
`
{
someField(arg: { a: null, b: null })
someField(arg: { b: null, a: null })
}
`,
);
});
it('encounters conflict in fragments', () => {
expectErrors(`
{
...A
...B
}
fragment A on Type {
x: a
}
fragment B on Type {
x: b
}
`).toDeepEqual([
{
message:
'Fields "x" conflict because "a" and "b" are different fields. Use different aliases on the fields to fetch both if this was intentional.',
locations: [
{ line: 7, column: 9 },
{ line: 10, column: 9 },
],
},
]);
});
it('reports each conflict once', () => {
expectErrors(`
{
f1 {
...A
...B
}
f2 {
...B
...A
}
f3 {
...A
...B
x: c
}
}
fragment A on Type {
x: a
}
fragment B on Type {
x: b
}
`).toDeepEqual([
{
message:
'Fields "x" conflict because "a" and "b" are different fields. Use different aliases on the fields to fetch both if this was intentional.',
locations: [
{ line: 18, column: 9 },
{ line: 21, column: 9 },
],
},
{
message:
'Fields "x" conflict because "c" and "a" are different fields. Use different aliases on the fields to fetch both if this was intentional.',
locations: [
{ line: 14, column: 11 },
{ line: 18, column: 9 },
],
},
{
message:
'Fields "x" conflict because "c" and "b" are different fields. Use different aliases on the fields to fetch both if this was intentional.',
locations: [
{ line: 14, column: 11 },
{ line: 21, column: 9 },
],
},
]);
});
it('deep conflict', () => {
expectErrors(`
{
field {
x: a
},
field {
x: b
}
}
`).toDeepEqual([
{
message:
'Fields "field" conflict because subfields "x" conflict because "a" and "b" are different fields. Use different aliases on the fields to fetch both if this was intentional.',
locations: [
{ line: 3, column: 9 },
{ line: 4, column: 11 },
{ line: 6, column: 9 },
{ line: 7, column: 11 },
],
},
]);
});
it('deep conflict with multiple issues', () => {
expectErrors(`
{
field {
x: a
y: c
},
field {
x: b
y: d
}
}
`).toDeepEqual([
{
message:
'Fields "field" conflict because subfields "x" conflict because "a" and "b" are different fields and subfields "y" conflict because "c" and "d" are different fields. Use different aliases on the fields to fetch both if this was intentional.',
locations: [
{ line: 3, column: 9 },
{ line: 4, column: 11 },
{ line: 5, column: 11 },
{ line: 7, column: 9 },
{ line: 8, column: 11 },
{ line: 9, column: 11 },
],
},
]);
});
it('very deep conflict', () => {
expectErrors(`
{
field {
deepField {
x: a
}
},
field {
deepField {
x: b
}
}
}
`).toDeepEqual([
{
message:
'Fields "field" conflict because subfields "deepField" conflict because subfields "x" conflict because "a" and "b" are different fields. Use different aliases on the fields to fetch both if this was intentional.',
locations: [
{ line: 3, column: 9 },
{ line: 4, column: 11 },
{ line: 5, column: 13 },
{ line: 8, column: 9 },
{ line: 9, column: 11 },
{ line: 10, column: 13 },
],
},
]);
});
it('reports deep conflict to nearest common ancestor', () => {
expectErrors(`
{
field {
deepField {
x: a
}
deepField {
x: b
}
},
field {
deepField {
y
}
}
}
`).toDeepEqual([
{
message:
'Fields "deepField" conflict because subfields "x" conflict because "a" and "b" are different fields. Use different aliases on the fields to fetch both if this was intentional.',
locations: [
{ line: 4, column: 11 },
{ line: 5, column: 13 },
{ line: 7, column: 11 },
{ line: 8, column: 13 },
],
},
]);
});
it('reports deep conflict to nearest common ancestor in fragments', () => {
expectErrors(`
{
field {
...F
}
field {
...F
}
}
fragment F on T {
deepField {
deeperField {
x: a
}
deeperField {
x: b
}
},
deepField {
deeperField {
y
}
}
}
`).toDeepEqual([
{
message:
'Fields "deeperField" conflict because subfields "x" conflict because "a" and "b" are different fields. Use different aliases on the fields to fetch both if this was intentional.',
locations: [
{ line: 12, column: 11 },
{ line: 13, column: 13 },
{ line: 15, column: 11 },
{ line: 16, column: 13 },
],
},
]);
});
it('reports deep conflict in nested fragments', () => {
expectErrors(`
{
field {
...F
}
field {
...I
}
}
fragment F on T {
x: a
...G
}
fragment G on T {
y: c
}
fragment I on T {
y: d
...J
}
fragment J on T {
x: b
}
`).toDeepEqual([
{
message:
'Fields "field" conflict because subfields "x" conflict because "a" and "b" are different fields and subfields "y" conflict because "c" and "d" are different fields. Use different aliases on the fields to fetch both if this was intentional.',
locations: [
{ line: 3, column: 9 },
{ line: 11, column: 9 },
{ line: 15, column: 9 },
{ line: 6, column: 9 },
{ line: 22, column: 9 },
{ line: 18, column: 9 },
],
},
]);
});
it('ignores unknown fragments', () => {
expectValid(`
{
field
...Unknown
...Known
}
fragment Known on T {
field
...OtherUnknown
}
`);
});
describe('return types must be unambiguous', () => {
const schema = buildSchema(`
interface SomeBox {
deepBox: SomeBox
unrelatedField: String
}
type StringBox implements SomeBox {
scalar: String
deepBox: StringBox
unrelatedField: String
listStringBox: [StringBox]
stringBox: StringBox
intBox: IntBox
}
type IntBox implements SomeBox {
scalar: Int
deepBox: IntBox
unrelatedField: String
listStringBox: [StringBox]
stringBox: StringBox
intBox: IntBox
}
interface NonNullStringBox1 {
scalar: String!
}
type NonNullStringBox1Impl implements SomeBox & NonNullStringBox1 {
scalar: String!
unrelatedField: String
deepBox: SomeBox
}
interface NonNullStringBox2 {
scalar: String!
}
type NonNullStringBox2Impl implements SomeBox & NonNullStringBox2 {
scalar: String!
unrelatedField: String
deepBox: SomeBox
}
type Connection {
edges: [Edge]
}
type Edge {
node: Node
}
type Node {
id: ID
name: String
}
type Query {
someBox: SomeBox
connection: Connection
}
`);
it('conflicting return types which potentially overlap', () => {
expectErrorsWithSchema(
schema,
`
{
someBox {
...on IntBox {
scalar
}
...on NonNullStringBox1 {
scalar
}
}
}
`,
).toDeepEqual([
{
message:
'Fields "scalar" conflict because they return conflicting types "Int" and "String!". Use different aliases on the fields to fetch both if this was intentional.',
locations: [
{ line: 5, column: 17 },
{ line: 8, column: 17 },
],
},
]);
});
it('compatible return shapes on different return types', () => {
expectValidWithSchema(
schema,
`
{
someBox {
... on SomeBox {
deepBox {
unrelatedField
}
}
... on StringBox {
deepBox {
unrelatedField
}
}
}
}
`,
);
});
it('disallows differing return types despite no overlap', () => {
expectErrorsWithSchema(
schema,
`
{
someBox {
... on IntBox {
scalar
}
... on StringBox {
scalar
}
}
}
`,
).toDeepEqual([
{
message:
'Fields "scalar" conflict because they return conflicting types "Int" and "String". Use different aliases on the fields to fetch both if this was intentional.',
locations: [
{ line: 5, column: 17 },
{ line: 8, column: 17 },
],
},
]);
});
it('reports correctly when a non-exclusive follows an exclusive', () => {
expectErrorsWithSchema(
schema,
`
{
someBox {
... on IntBox {
deepBox {
...X
}
}
}
someBox {
... on StringBox {
deepBox {
...Y
}
}
}
memoed: someBox {
... on IntBox {
deepBox {
...X
}
}
}
memoed: someBox {
... on StringBox {
deepBox {
...Y
}
}
}
other: someBox {
...X
}
other: someBox {
...Y
}
}
fragment X on SomeBox {
scalar
}
fragment Y on SomeBox {
scalar: unrelatedField
}
`,
).toDeepEqual([
{
message:
'Fields "other" conflict because subfields "scalar" conflict because "scalar" and "unrelatedField" are different fields. Use different aliases on the fields to fetch both if this was intentional.',
locations: [
{ line: 31, column: 13 },
{ line: 39, column: 13 },
{ line: 34, column: 13 },
{ line: 42, column: 13 },
],
},
]);
});
it('disallows differing return type nullability despite no overlap', () => {
expectErrorsWithSchema(
schema,
`
{
someBox {
... on NonNullStringBox1 {
scalar
}
... on StringBox {
scalar
}
}
}
`,
).toDeepEqual([
{
message:
'Fields "scalar" conflict because they return conflicting types "String!" and "String". Use different aliases on the fields to fetch both if this was intentional.',
locations: [
{ line: 5, column: 17 },
{ line: 8, column: 17 },
],
},
]);
});
it('disallows differing return type list despite no overlap', () => {
expectErrorsWithSchema(
schema,
`
{
someBox {
... on IntBox {
box: listStringBox {
scalar
}
}
... on StringBox {
box: stringBox {
scalar
}
}
}
}
`,
).toDeepEqual([
{
message:
'Fields "box" conflict because they return conflicting types "[StringBox]" and "StringBox". Use different aliases on the fields to fetch both if this was intentional.',
locations: [
{ line: 5, column: 17 },
{ line: 10, column: 17 },
],
},
]);
expectErrorsWithSchema(
schema,
`
{
someBox {
... on IntBox {
box: stringBox {
scalar
}
}
... on StringBox {
box: listStringBox {
scalar
}
}
}
}
`,
).toDeepEqual([
{
message:
'Fields "box" conflict because they return conflicting types "StringBox" and "[StringBox]". Use different aliases on the fields to fetch both if this was intentional.',
locations: [
{ line: 5, column: 17 },
{ line: 10, column: 17 },
],
},
]);
});
it('disallows differing subfields', () => {
expectErrorsWithSchema(
schema,
`
{
someBox {
... on IntBox {
box: stringBox {
val: scalar
val: unrelatedField
}
}
... on StringBox {
box: stringBox {
val: scalar
}
}
}
}
`,
).toDeepEqual([
{
message:
'Fields "val" conflict because "scalar" and "unrelatedField" are different fields. Use different aliases on the fields to fetch both if this was intentional.',
locations: [
{ line: 6, column: 19 },
{ line: 7, column: 19 },
],
},
]);
});
it('disallows differing deep return types despite no overlap', () => {
expectErrorsWithSchema(
schema,
`
{
someBox {
... on IntBox {
box: stringBox {
scalar
}
}
... on StringBox {
box: intBox {
scalar
}
}
}
}
`,
).toDeepEqual([
{
message:
'Fields "box" conflict because subfields "scalar" conflict because they return conflicting types "String" and "Int". Use different aliases on the fields to fetch both if this was intentional.',
locations: [
{ line: 5, column: 17 },
{ line: 6, column: 19 },
{ line: 10, column: 17 },
{ line: 11, column: 19 },
],
},
]);
});
it('allows non-conflicting overlapping types', () => {
expectValidWithSchema(
schema,
`
{
someBox {
... on IntBox {
scalar: unrelatedField
}
... on StringBox {
scalar
}
}
}
`,
);
});
it('same wrapped scalar return types', () => {
expectValidWithSchema(
schema,
`
{
someBox {
...on NonNullStringBox1 {
scalar
}
...on NonNullStringBox2 {
scalar
}
}
}
`,
);
});
it('allows inline fragments without type condition', () => {
expectValidWithSchema(
schema,
`
{
a
... {
a
}
}
`,
);
});
it('compares deep types including list', () => {
expectErrorsWithSchema(
schema,
`
{
connection {
...edgeID
edges {
node {
id: name
}
}
}
}
fragment edgeID on Connection {
edges {
node {
id
}
}
}
`,
).toDeepEqual([
{
message:
'Fields "edges" conflict because subfields "node" conflict because subfields "id" conflict because "name" and "id" are different fields. Use different aliases on the fields to fetch both if this was intentional.',
locations: [
{ line: 5, column: 15 },
{ line: 6, column: 17 },
{ line: 7, column: 19 },
{ line: 14, column: 13 },
{ line: 15, column: 15 },
{ line: 16, column: 17 },
],
},
]);
});
it('ignores unknown types', () => {
expectValidWithSchema(
schema,
`
{
someBox {
...on UnknownType {
scalar
}
...on NonNullStringBox2 {
scalar
}
}
}
`,
);
});
it('works for field names that are JS keywords', () => {
const schemaWithKeywords = buildSchema(`
type Foo {
constructor: String
}
type Query {
foo: Foo
}
`);
expectValidWithSchema(
schemaWithKeywords,
`
{
foo {
constructor
}
}
`,
);
});
});
it('does not infinite loop on recursive fragment', () => {
expectValid(`
{
...fragA
}
fragment fragA on Human { name, relatives { name, ...fragA } }
`);
});
it('does not infinite loop on immediately recursive fragment', () => {
expectValid(`
{
...fragA
}
fragment fragA on Human { name, ...fragA }
`);
});
it('does not infinite loop on recursive fragment with a field named after fragment', () => {
expectValid(`
{
...fragA
fragA
}
fragment fragA on Query { ...fragA }
`);
});
it('finds invalid cases even with field named after fragment', () => {
expectErrors(`
{
fragA
...fragA
}
fragment fragA on Type {
fragA: b
}
`).toDeepEqual([
{
message:
'Fields "fragA" conflict because "fragA" and "b" are different fields. Use different aliases on the fields to fetch both if this was intentional.',
locations: [
{ line: 3, column: 9 },
{ line: 8, column: 9 },
],
},
]);
});
it('does not infinite loop on transitively recursive fragment', () => {
expectValid(`
{
...fragA
fragB
}
fragment fragA on Human { name, ...fragB }
fragment fragB on Human { name, ...fragC }
fragment fragC on Human { name, ...fragA }
`);
});
it('finds invalid case even with immediately recursive fragment', () => {
expectErrors(`
fragment sameAliasesWithDifferentFieldTargets on Dog {
...sameAliasesWithDifferentFieldTargets
fido: name
fido: nickname
}
`).toDeepEqual([
{
message:
'Fields "fido" conflict because "name" and "nickname" are different fields. Use different aliases on the fields to fetch both if this was intentional.',
locations: [
{ line: 4, column: 9 },
{ line: 5, column: 9 },
],
},
]);
});
});