-
-
Notifications
You must be signed in to change notification settings - Fork 670
fix: prevent enumerable undefined properties in InputType instances (complete fix for #475) #1789
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.
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
AviBueno
wants to merge
1
commit into
MichalLytek:master
Choose a base branch
from
AviBueno:fix/inputtype-enumerable-undefined-properties
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,168 @@ | ||
| import "reflect-metadata"; | ||
| import { type GraphQLSchema, graphql } from "graphql"; | ||
| import { Arg, Field, InputType, Query, Resolver, buildSchema } from "type-graphql"; | ||
| import { getMetadataStorage } from "@/metadata/getMetadataStorage"; | ||
|
|
||
| describe("InputType enumerable properties", () => { | ||
| let schema: GraphQLSchema; | ||
|
|
||
| beforeAll(async () => { | ||
| getMetadataStorage().clear(); | ||
|
|
||
| @InputType() | ||
| class SampleInput { | ||
| @Field() | ||
| requiredField!: string; | ||
|
|
||
| @Field({ nullable: true }) | ||
| optionalField?: string; | ||
|
|
||
| @Field({ nullable: true }) | ||
| anotherOptional?: number; | ||
| } | ||
|
|
||
| @InputType() | ||
| class NestedInput { | ||
| @Field({ nullable: true }) | ||
| optionalNested?: string; | ||
| } | ||
|
|
||
| @InputType() | ||
| class ParentInput { | ||
| @Field() | ||
| required!: string; | ||
|
|
||
| @Field(() => NestedInput, { nullable: true }) | ||
| nested?: NestedInput; | ||
| } | ||
|
|
||
| @Resolver() | ||
| class SampleResolver { | ||
| @Query(() => String) | ||
| testSimpleInput(@Arg("input") input: SampleInput): string { | ||
| return JSON.stringify({ | ||
| keys: Object.keys(input), | ||
| hasOptional: "optionalField" in input, | ||
| hasAnother: "anotherOptional" in input, | ||
| optionalValue: input.optionalField, | ||
| }); | ||
| } | ||
|
|
||
| @Query(() => String) | ||
| testNestedInput(@Arg("input") input: ParentInput): string { | ||
| return JSON.stringify({ | ||
| keys: Object.keys(input), | ||
| hasNested: "nested" in input, | ||
| }); | ||
| } | ||
| } | ||
|
|
||
| schema = await buildSchema({ | ||
| resolvers: [SampleResolver], | ||
| validate: false, | ||
| }); | ||
| }); | ||
|
|
||
| describe("optional fields not provided", () => { | ||
| it("should not create enumerable properties for undefined optional fields", async () => { | ||
| const query = ` | ||
| query { | ||
| testSimpleInput(input: { requiredField: "test" }) | ||
| } | ||
| `; | ||
|
|
||
| const result = await graphql({ schema, source: query }); | ||
|
|
||
| expect(result.errors).toBeUndefined(); | ||
| expect(result.data).toBeDefined(); | ||
|
|
||
| const data = JSON.parse(result.data!.testSimpleInput as string); | ||
|
|
||
| // Only requiredField should be in Object.keys() | ||
| expect(data.keys).toEqual(["requiredField"]); | ||
|
|
||
| // Optional fields should not be enumerable | ||
| expect(data.hasOptional).toBe(false); | ||
| expect(data.hasAnother).toBe(false); | ||
|
|
||
| // But should still be accessible (undefined) | ||
| expect(data.optionalValue).toBeUndefined(); | ||
| }); | ||
|
|
||
| it("should handle nested InputTypes correctly", async () => { | ||
| const query = ` | ||
| query { | ||
| testNestedInput(input: { required: "value" }) | ||
| } | ||
| `; | ||
|
|
||
| const result = await graphql({ schema, source: query }); | ||
|
|
||
| expect(result.errors).toBeUndefined(); | ||
| expect(result.data).toBeDefined(); | ||
|
|
||
| const data = JSON.parse(result.data!.testNestedInput as string); | ||
|
|
||
| // Only required field should be enumerable | ||
| expect(data.keys).toEqual(["required"]); | ||
|
|
||
| // Nested optional field should not be enumerable | ||
| expect(data.hasNested).toBe(false); | ||
| }); | ||
| }); | ||
|
|
||
| describe("optional fields provided", () => { | ||
| it("should include provided optional fields in Object.keys()", async () => { | ||
| const query = ` | ||
| query { | ||
| testSimpleInput(input: { requiredField: "test", optionalField: "provided" }) | ||
| } | ||
| `; | ||
|
|
||
| const result = await graphql({ schema, source: query }); | ||
|
|
||
| expect(result.errors).toBeUndefined(); | ||
| expect(result.data).toBeDefined(); | ||
|
|
||
| const data = JSON.parse(result.data!.testSimpleInput as string); | ||
|
|
||
| // Both provided fields should be in Object.keys() | ||
| expect(data.keys).toContain("requiredField"); | ||
| expect(data.keys).toContain("optionalField"); | ||
|
|
||
| // Provided field should be enumerable | ||
| expect(data.hasOptional).toBe(true); | ||
|
|
||
| // Non-provided field should not be enumerable | ||
| expect(data.hasAnother).toBe(false); | ||
|
|
||
| // Value should be set | ||
| expect(data.optionalValue).toBe("provided"); | ||
| }); | ||
|
|
||
| it("should handle explicitly null values correctly", async () => { | ||
| const query = ` | ||
| query { | ||
| testSimpleInput(input: { requiredField: "test", optionalField: null }) | ||
| } | ||
| `; | ||
|
|
||
| const result = await graphql({ schema, source: query }); | ||
|
|
||
| expect(result.errors).toBeUndefined(); | ||
| expect(result.data).toBeDefined(); | ||
|
|
||
| const data = JSON.parse(result.data!.testSimpleInput as string); | ||
|
|
||
| // Explicitly null field should be in Object.keys() | ||
| expect(data.keys).toContain("requiredField"); | ||
| expect(data.keys).toContain("optionalField"); | ||
|
|
||
| // Should be enumerable | ||
| expect(data.hasOptional).toBe(true); | ||
|
|
||
| // Value should be null (not undefined) | ||
| expect(data.optionalValue).toBeNull(); | ||
| }); | ||
| }); | ||
| }); |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.