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

add additional runtime errors for pre-coercion OneOf errors #4195

Open
wants to merge 10 commits into
base: main
Choose a base branch
from
Open

add additional runtime errors for pre-coercion OneOf errors #4195

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
136cde0
add runtime errors for pre-coercion OneOf errors
yaacovCR Sep 18, 2024
70e5c4f
only return a single error per value
yaacovCR Sep 18, 2024
5feb200
combine number of fields and nullability into uniform error message
yaacovCR Sep 18, 2024
d4d1bcb
don't capitalize "Type"
yaacovCR Sep 20, 2024
d6fe83b
fix extra word/capitalization with Within
yaacovCR Sep 20, 2024
20f8734
fix indentation
yaacovCR Sep 21, 2024
15a67e8
move final oneOf tests into variables-test.ts
yaacovCR Sep 21, 2024
d9342ba
add non-normative note
yaacovCR Sep 21, 2024
f2a6e9d
add less than one value case
yaacovCR Sep 21, 2024
cdd0b55
Apply suggestions from code review
benjie Oct 17, 2024
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
346 changes: 342 additions & 4 deletions src/execution/__tests__/oneof-test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,12 @@ function executeQuery(
rootValue: unknown,
variableValues?: { [variable: string]: unknown },
): ExecutionResult | Promise<ExecutionResult> {
return execute({ schema, document: parse(query), rootValue, variableValues });
return execute({
schema,
document: parse(query, { experimentalFragmentArguments: true }),
rootValue,
variableValues,
});
}

describe('Execute: Handles OneOf Input Objects', () => {
Expand Down Expand Up @@ -152,13 +157,13 @@ describe('Execute: Handles OneOf Input Objects', () => {
{
locations: [{ column: 16, line: 2 }],
message:
'Variable "$input" got invalid value { a: "abc", b: 123 }; Exactly one key must be specified for OneOf type "TestInputObject".',
'Variable "$input" got invalid value { a: "abc", b: 123 }; Within OneOf Input Object Type "TestInputObject", exactly one field must be specified, and the value for that field must be non-null.',
yaacovCR marked this conversation as resolved.
Show resolved Hide resolved
},
],
});
});

it('rejects a variable with multiple nullable keys', () => {
it('rejects a variable with multiple keys, some set to null', () => {
const query = `
query ($input: TestInputObject!) {
test(input: $input) {
Expand All @@ -176,7 +181,340 @@ describe('Execute: Handles OneOf Input Objects', () => {
{
locations: [{ column: 16, line: 2 }],
message:
'Variable "$input" got invalid value { a: "abc", b: null }; Exactly one key must be specified for OneOf type "TestInputObject".',
'Variable "$input" got invalid value { a: "abc", b: null }; Within OneOf Input Object Type "TestInputObject", exactly one field must be specified, and the value for that field must be non-null.',
},
],
});
});

it('rejects a variable with multiple null keys', () => {
const query = `
query ($input: TestInputObject!) {
test(input: $input) {
a
b
}
}
`;
const result = executeQuery(query, rootValue, {
input: { a: null, b: null },
});

expectJSON(result).toDeepEqual({
errors: [
{
locations: [{ column: 16, line: 2 }],
message:
'Variable "$input" got invalid value { a: null, b: null }; Within OneOf Input Object Type "TestInputObject", exactly one field must be specified, and the value for that field must be non-null.',
},
],
});
});

it('accepts a valid variable for field', () => {
const query = `
query ($a: String!) {
test(input: { a: $a }) {
a
b
}
}
`;
const result = executeQuery(query, rootValue, { a: 'abc' });

expectJSON(result).toDeepEqual({
data: {
test: {
a: 'abc',
b: null,
},
},
});
});

it('rejects multiple variables for fields', () => {
const query = `
query ($a: String!, $b: Int!) {
test(input: { a: $a, b: $b }) {
a
b
}
}
`;
const result = executeQuery(query, rootValue, { a: 'abc', b: 123 });

expectJSON(result).toDeepEqual({
data: {
test: null,
},
errors: [
{
// A nullable variable in a oneOf field position would be caught at validation-time
// hence the vague error message here.
message:
'Argument "input" of type "TestInputObject!" has invalid value { a: $a, b: $b }.',
yaacovCR marked this conversation as resolved.
Show resolved Hide resolved
locations: [{ line: 3, column: 23 }],
path: ['test'],
},
],
});
});

it('rejects variable for field explicitly set to undefined', () => {
const query = `
query ($a: String) {
test(input: { a: $a }) {
a
b
}
}
`;
const result = executeQuery(query, rootValue, { a: undefined });

expectJSON(result).toDeepEqual({
data: {
test: null,
},
errors: [
{
// A nullable variable in a oneOf field position would be caught at validation-time
// hence the vague error message here.
message:
'Argument "input" of type "TestInputObject!" has invalid value { a: $a }.',
locations: [{ line: 3, column: 23 }],
path: ['test'],
},
],
});
});

it('rejects nulled variable for field', () => {
const query = `
query ($a: String) {
test(input: { a: $a }) {
a
b
}
}
`;
const result = executeQuery(query, rootValue, { a: null });

expectJSON(result).toDeepEqual({
data: {
test: null,
},
errors: [
{
// A nullable variable in a oneOf field position would be caught at validation-time
// hence the vague error message here.
message:
'Argument "input" of type "TestInputObject!" has invalid value { a: $a }.',
locations: [{ line: 3, column: 23 }],
path: ['test'],
},
],
});
});

it('rejects missing variable for field', () => {
const query = `
query ($a: String) {
test(input: { a: $a }) {
a
b
}
}
`;
const result = executeQuery(query, rootValue);

expectJSON(result).toDeepEqual({
data: {
test: null,
},
errors: [
{
// A nullable variable in a oneOf field position would be caught at validation-time
// hence the vague error message here.
message:
'Argument "input" of type "TestInputObject!" has invalid value { a: $a }.',
locations: [{ line: 3, column: 23 }],
path: ['test'],
},
],
});
});

it('rejects missing second variable for field', () => {
const query = `
query ($a: String, $b: String) {
test(input: { a: $a, b: $b }) {
a
b
}
}
`;
const result = executeQuery(query, rootValue, { a: '123' });

expectJSON(result).toDeepEqual({
data: {
test: null,
},
errors: [
{
// A nullable variable in a oneOf field position would be caught at validation-time
// hence the vague error message here.
message:
'Argument "input" of type "TestInputObject!" has invalid value { a: $a, b: $b }.',
locations: [{ line: 3, column: 23 }],
path: ['test'],
},
],
yaacovCR marked this conversation as resolved.
Show resolved Hide resolved
});
});

it('accepts a valid fragment variable for field', () => {
const query = `
query {
...TestFragment(a: "abc")
}
fragment TestFragment($a: String) on Query {
test(input: { a: $a }) {
a
b
}
}
`;
const result = executeQuery(query, rootValue, { a: 'abc' });

expectJSON(result).toDeepEqual({
data: {
test: {
a: 'abc',
b: null,
},
},
});
});

it('rejects multiple fragment variables for fields', () => {
const query = `
query {
...TestFragment(a: "abc", b: 123)
}
fragment TestFragment($a: String, $b: Int) on Query {
test(input: { a: $a, b: $b }) {
a
b
}
}
`;
const result = executeQuery(query, rootValue, { a: 'abc', b: 123 });

expectJSON(result).toDeepEqual({
data: {
test: null,
},
errors: [
{
// A nullable variable in a oneOf field position would be caught at validation-time
// hence the vague error message here.
message:
'Argument "input" of type "TestInputObject!" has invalid value { a: $a, b: $b }.',
locations: [{ line: 6, column: 23 }],
path: ['test'],
},
],
});
});

it('rejects nulled fragment variable for field', () => {
const query = `
query {
...TestFragment(a: null)
}
fragment TestFragment($a: String) on Query {
test(input: { a: $a }) {
a
b
}
}
`;
const result = executeQuery(query, rootValue, { a: null });

expectJSON(result).toDeepEqual({
data: {
test: null,
},
errors: [
{
// A nullable variable in a oneOf field position would be caught at validation-time
// hence the vague error message here.
message:
'Argument "input" of type "TestInputObject!" has invalid value { a: $a }.',
locations: [{ line: 6, column: 23 }],
path: ['test'],
},
],
});
});

it('rejects missing fragment variable for field', () => {
const query = `
query {
...TestFragment
}
fragment TestFragment($a: String) on Query {
test(input: { a: $a }) {
a
b
}
}
`;
const result = executeQuery(query, rootValue);

expectJSON(result).toDeepEqual({
data: {
test: null,
},
errors: [
{
// A nullable variable in a oneOf field position would be caught at validation-time
// hence the vague error message here.
message:
'Argument "input" of type "TestInputObject!" has invalid value { a: $a }.',
locations: [{ line: 6, column: 23 }],
path: ['test'],
},
],
});
});

it('rejects missing second fragment variable for field', () => {
const query = `
query {
...TestFragment(a: "123")
}
fragment TestFragment($a: String, $b: string) on Query {
test(input: { a: $a, b: $b }) {
a
b
}
}
`;
const result = executeQuery(query, rootValue, { a: '123' });

expectJSON(result).toDeepEqual({
data: {
test: null,
},
errors: [
{
// A nullable variable in a oneOf field position would be caught at validation-time
// hence the vague error message here.
message:
'Argument "input" of type "TestInputObject!" has invalid value { a: $a, b: $b }.',
locations: [{ line: 6, column: 23 }],
path: ['test'],
},
],
});
Expand Down
Loading
Loading