Thanks to visit codestin.com
Credit goes to github.com

Skip to content

FIX(Graphql): Add support for input with default values #4540

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
Closed
wants to merge 2 commits into from
Closed

FIX(Graphql): Add support for input with default values #4540

wants to merge 2 commits into from

Conversation

@eMerzh
Copy link
Contributor

@eMerzh eMerzh commented Nov 30, 2023

Hello here 👋

We have a few inputs with default required fields that have default values like here :

input StoryPinInput {
  id: ID!
  isGlobal: Boolean! = false
}

but the TS generated for this look like

export type StoryPinInput = {
  id: string;
  isGlobal: boolean;
};

which is not ideal ...

so i marked the field as optional if it has a default :)

@eMerzh eMerzh changed the title Graphq: Add support for input with default values FIX(Graphql): Add support for input with default values Dec 13, 2023
@eMerzh
Copy link
Contributor Author

eMerzh commented Jan 8, 2024

@captbaritone sorry for the ping 🥹 .... is there a way to bump those PRs before they go down the black hole of 2nd page ?

if there's something we can do to help ? 🤷

@captbaritone
Copy link
Contributor

captbaritone commented Jan 8, 2024

Sorry for the delayed response. Can you add a fixture test here? https://github.com/facebook/relay/tree/main/compiler/crates/relay-typegen/tests/generate_typescript/fixtures I think the test schema has an example you can trigger here:

relay/packages/relay-test-utils-internal/testschema.graphql

Line 677 in 54586ec

nameWithDefaultArgs(capitalize: Boolean! = false): String

Maybe you could also ensure there'a fixture test that validates what we do for Flow in this case?

Info on updating fixture tests can be found here: https://github.com/facebook/relay/blob/main/.github/CONTRIBUTING.md#pull-requests

Defaults in GraphQL are confusing, but I believe we should should ensure this generates { isGlobal?: boolean } and not { isGlobal: boolean | null | undefined } since I believe with required arguments with defaults you are permitted to omit the argument but not pass an explicit null.

@eMerzh
Copy link
Contributor Author

eMerzh commented Jan 8, 2024

awesome! ❤️ .... i'll take a look at that

@eMerzh eMerzh force-pushed the add_input_default branch from 5dddec6 to 9e42fbc Compare January 8, 2024 22:54
@eMerzh
Copy link
Contributor Author

eMerzh commented Jan 8, 2024

here... i hope it's better now :)

tried to not add input but i prefer avoid touching too much other tests to add this

captbaritone
captbaritone requested changes Jan 8, 2024
View reviewed changes
compiler/crates/relay-typegen/tests/generate_typescript/fixtures/default-input.graphql
id
}
}
} No newline at end of file
Copy link
Contributor

@captbaritone captbaritone Jan 8, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would you mind adding this same fixture to the Flow tests?

https://github.com/facebook/relay/tree/main/compiler/crates/relay-typegen/tests/generate_flow/fixtures

Copy link
Contributor Author

@eMerzh eMerzh Jan 9, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

arg, my bad... here they are :)

captbaritone
captbaritone reviewed Jan 8, 2024
View reviewed changes
compiler/crates/relay-typegen/tests/generate_typescript/fixtures/default-input.expected
==================================== OUTPUT ===================================
export type FeedbackUnLikeInput = {
feedbackId?: string | null | undefined;
silent?: boolean;
Copy link
Contributor

@captbaritone captbaritone Jan 8, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nice!

@eMerzh eMerzh force-pushed the add_input_default branch from 9e42fbc to d3f7eba Compare January 9, 2024 07:02
@eMerzh eMerzh requested a review from captbaritone January 9, 2024 07:02
@facebook-github-bot
Copy link
Contributor

facebook-github-bot commented Jan 9, 2024

@captbaritone has imported this pull request. If you are a Meta employee, you can view this diff on Phabricator.

@facebook-github-bot
Copy link
Contributor

facebook-github-bot commented Jan 10, 2024

@captbaritone merged this pull request in 1a57f08.

@eMerzh
Copy link
Contributor Author

eMerzh commented Jan 10, 2024

awesome ❤️ thanks for the review

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@captbaritone captbaritone Awaiting requested review from captbaritone

Assignees

No one assigned

Labels

CLA Signed Merged

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@eMerzh @captbaritone @facebook-github-bot