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

fix: non-null field returning null sometimes triggers TypeError #209

Merged
merged 3 commits into from
Mar 15, 2024
Merged

fix: non-null field returning null sometimes triggers TypeError #209

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
a4b01d2
Add failing tests
bbnjmn Jun 20, 2023
a8c7bc4
fix
bbnjmn Jun 20, 2023
b72c763
fix lint issue
bbnjmn Jun 23, 2023
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
207 changes: 189 additions & 18 deletions src/__tests__/nonnull.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@ const syncError = new Error("sync");
const syncNonNullError = new Error("syncNonNull");
const promiseError = new Error("promise");
const promiseNonNullError = new Error("promiseNonNull");
const latePromiseError = new Error("latePromise");
const latePromiseNonNullError = new Error("latePromiseNonNull");

const throwingData = {
sync() {
Expand All @@ -34,6 +36,16 @@ const throwingData = {
throw promiseNonNullError;
});
},
latePromise() {
return new Promise((resolve, reject) =>
setTimeout(() => reject(latePromiseError), 0)
);
},
latePromiseNonNull() {
return new Promise((resolve, reject) =>
setTimeout(() => reject(latePromiseNonNullError), 0)
);
},
syncNest() {
return throwingData;
},
Expand Down Expand Up @@ -61,6 +73,12 @@ const nullingData = {
promiseNonNull() {
return Promise.resolve(null);
},
latePromise() {
return new Promise((resolve) => setTimeout(() => resolve(null), 0));
},
latePromiseNonNull() {
return new Promise((resolve) => setTimeout(() => resolve(null), 0));
},
syncNest() {
return nullingData;
},
Expand Down Expand Up @@ -88,6 +106,14 @@ const dataType: GraphQLObjectType = new GraphQLObjectType({
type: new GraphQLNonNull(GraphQLString),
resolve: (root: any) => root.promiseNonNull()
},
latePromise: {
type: GraphQLString,
resolve: (root: any) => root.latePromise()
},
latePromiseNonNull: {
type: new GraphQLNonNull(GraphQLString),
resolve: (root: any) => root.latePromiseNonNull()
},
syncNest: { type: dataType, resolve: (root: any) => root.syncNest() },
syncNonNullNest: {
type: new GraphQLNonNull(dataType),
Expand Down Expand Up @@ -275,29 +301,33 @@ describe("Execute: handles non-nullable types", () => {
syncNest {
sync
promise
syncNest { sync promise }
promiseNest { sync promise }
latePromise
syncNest { sync promise latePromise }
promiseNest { sync promise latePromise }
}
promiseNest {
sync
promise
syncNest { sync promise }
promiseNest { sync promise }
latePromise
syncNest { sync promise latePromise }
promiseNest { sync promise latePromise }
}
}
`;
const data = {
syncNest: {
sync: null,
promise: null,
syncNest: { sync: null, promise: null },
promiseNest: { sync: null, promise: null }
latePromise: null,
syncNest: { sync: null, promise: null, latePromise: null },
promiseNest: { sync: null, promise: null, latePromise: null }
},
promiseNest: {
sync: null,
promise: null,
syncNest: { sync: null, promise: null },
promiseNest: { sync: null, promise: null }
latePromise: null,
syncNest: { sync: null, promise: null, latePromise: null },
promiseNest: { sync: null, promise: null, latePromise: null }
}
};

Expand All @@ -319,7 +349,7 @@ describe("Execute: handles non-nullable types", () => {
{
message: syncError.message,
path: ["syncNest", "syncNest", "sync"],
locations: [{ line: 6, column: 22 }]
locations: [{ line: 7, column: 22 }]
},
{
message: promiseError.message,
Expand All @@ -329,47 +359,77 @@ describe("Execute: handles non-nullable types", () => {
{
message: promiseError.message,
path: ["syncNest", "syncNest", "promise"],
locations: [{ line: 6, column: 27 }]
locations: [{ line: 7, column: 27 }]
},
{
message: syncError.message,
path: ["syncNest", "promiseNest", "sync"],
locations: [{ line: 7, column: 25 }]
locations: [{ line: 8, column: 25 }]
},
{
message: syncError.message,
path: ["promiseNest", "sync"],
locations: [{ line: 10, column: 11 }]
locations: [{ line: 11, column: 11 }]
},
{
message: syncError.message,
path: ["promiseNest", "syncNest", "sync"],
locations: [{ line: 12, column: 22 }]
locations: [{ line: 14, column: 22 }]
},
{
message: promiseError.message,
path: ["syncNest", "promiseNest", "promise"],
locations: [{ line: 7, column: 30 }]
locations: [{ line: 8, column: 30 }]
},
{
message: promiseError.message,
path: ["promiseNest", "promise"],
locations: [{ line: 11, column: 11 }]
locations: [{ line: 12, column: 11 }]
},
{
message: promiseError.message,
path: ["promiseNest", "syncNest", "promise"],
locations: [{ line: 12, column: 27 }]
locations: [{ line: 14, column: 27 }]
},
{
message: syncError.message,
path: ["promiseNest", "promiseNest", "sync"],
locations: [{ line: 13, column: 25 }]
locations: [{ line: 15, column: 25 }]
},
{
message: promiseError.message,
path: ["promiseNest", "promiseNest", "promise"],
locations: [{ line: 13, column: 30 }]
locations: [{ line: 15, column: 30 }]
},
{
message: latePromiseError.message,
path: ["syncNest", "latePromise"],
locations: [{ line: 6, column: 11 }]
},
{
message: latePromiseError.message,
path: ["syncNest", "syncNest", "latePromise"],
locations: [{ line: 7, column: 35 }]
},
{
message: latePromiseError.message,
path: ["syncNest", "promiseNest", "latePromise"],
locations: [{ line: 8, column: 38 }]
},
{
message: latePromiseError.message,
path: ["promiseNest", "latePromise"],
locations: [{ line: 13, column: 11 }]
},
{
message: latePromiseError.message,
path: ["promiseNest", "syncNest", "latePromise"],
locations: [{ line: 14, column: 35 }]
},
{
message: latePromiseError.message,
locations: [{ line: 15, column: 38 }],
path: ["promiseNest", "promiseNest", "latePromise"]
}
]
});
Expand Down Expand Up @@ -773,4 +833,115 @@ describe("Execute: handles non-nullable types", () => {
});
});
});

describe("handles late resolution of non-null fields", () => {
const query = `
{
syncNest {
syncNest {
latePromiseNonNull
}
syncNonNull
}
anotherNest: syncNest {
syncNest {
syncNonNullNest {
syncNest {
syncNest {
latePromiseNonNull
}
}
promiseNonNull
}
}
}
}
`;

test("that nulls first nullable object after common ancestor when non-null sibling field of any ancestor returns null", async () => {
const result = await executeSyncAndAsync(query, nullingData);
expect(result).toMatchObject({
data: { syncNest: null, anotherNest: { syncNest: null } },
errors: [
{
message:
"Cannot return null for non-nullable field DataType.syncNonNull.",
locations: [{ line: 7, column: 11 }],
path: ["syncNest", "syncNonNull"]
},
{
message:
"Cannot return null for non-nullable field DataType.promiseNonNull.",
locations: [{ line: 17, column: 15 }],
path: [
"anotherNest",
"syncNest",
"syncNonNullNest",
"promiseNonNull"
]
},
{
message:
"Cannot return null for non-nullable field DataType.latePromiseNonNull.",
locations: [{ line: 5, column: 13 }],
path: ["syncNest", "syncNest", "latePromiseNonNull"]
},
{
message:
"Cannot return null for non-nullable field DataType.latePromiseNonNull.",
locations: [{ line: 14, column: 19 }],
path: [
"anotherNest",
"syncNest",
"syncNonNullNest",
"syncNest",
"syncNest",
"latePromiseNonNull"
]
}
]
});
});

test("that throws", async () => {
const result = await executeSyncAndAsync(query, throwingData);
expect(result).toMatchObject({
data: { syncNest: null, anotherNest: { syncNest: null } },
errors: [
{
message: syncNonNullError.message,
locations: [{ line: 7, column: 11 }],
path: ["syncNest", "syncNonNull"]
},
{
message: promiseNonNullError.message,
locations: [{ line: 17, column: 15 }],
path: [
"anotherNest",
"syncNest",
"syncNonNullNest",
"promiseNonNull"
]
},
{
message: latePromiseNonNullError.message,
locations: [{ line: 5, column: 13 }],
path: ["syncNest", "syncNest", "latePromiseNonNull"]
},
{
message: latePromiseNonNullError.message,
locations: [{ line: 14, column: 19 }],
path: [
"anotherNest",
"syncNest",
"syncNonNullNest",
"syncNest",
"syncNest",
"latePromiseNonNull"
]
}
]
});
});
});
});
4 changes: 4 additions & 0 deletions src/non-null.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,10 @@ function trimData(nullable: QueryMetadata): NullTrimmer {
*/
function removeBranch(tree: any, branch: Array<number | string>): void {
for (let i = 0; i < branch.length - 1; ++i) {
// if ancestor has already been removed, there's nothing to do
if (tree[branch[i]] === null) {
return;
}
tree = tree[branch[i]];
}
const toNull = branch[branch.length - 1];
Expand Down