facebook / relay

Relay is a JavaScript framework for building data-driven React applications.
https://relay.dev
MIT License
18.27k stars 1.8k forks source link

Input fields with defaults shouldn't be required #4647

Closed obmarg closed 2 months ago

obmarg commented 3 months ago

I added a new non-null input field with a default to a schema I work on, and relay started throwing an error for that field:

[ERROR] Error: ✖︎ Missing required fields '["kind"]' of type 'AccessTokenCreateInput'

  app/routes/_dashboard/_personal-account/settings/-access-tokens/token-form.tsx:41:30
   40 │   ) {
   41 │     accessTokenCreate(input: { name: $name, accountId: $accountId }) {
      │                              ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
   42 │       ... on AccessTokenCreateSuccess {

This seems to go against the spec which says:

An input field is required if it has a non-null type and does not have a default value. Otherwise, the input object field is optional.

This PR updates the validation code to consider fields with default values as optional, in line with the spec.

I've added some tests for this, though I'm not familiar enough with relay to know whether I'm actually covering both of the cases I've fixed. Please let me know if there's improvements to be made.

facebook-github-bot commented 3 months ago

Hi @obmarg!

Thank you for your pull request and welcome to our community.

Action Required

In order to merge any pull request (code, docs, etc.), we require contributors to sign our Contributor License Agreement, and we don't seem to have one on file for you.

Process

In order for us to review and merge your suggested changes, please sign at https://code.facebook.com/cla. If you are contributing on behalf of someone else (eg your employer), the individual CLA may not be sufficient and your employer may need to sign the corporate CLA.

Once the CLA is signed, our tooling will perform checks and validations. Afterwards, the pull request will be tagged with CLA signed. The tagging process may take up to 1 hour after signing. Please give it that time before contacting us about it.

If you have received this in error or have any questions, please contact us at cla@meta.com. Thanks!

facebook-github-bot commented 3 months ago

Thank you for signing our Contributor License Agreement. We can now accept your code for this (and any) Meta Open Source project. Thanks!

captbaritone commented 2 months ago

Thanks!

facebook-github-bot commented 2 months ago

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

facebook-github-bot commented 2 months ago

@captbaritone merged this pull request in facebook/relay@0d7a3d04d7a9e252902ce5ffbf3809e9fab2a299.