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.

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

Fix/required variables in query hook #620

Merged

Conversation

tomaskukk
Copy link
Contributor

@tomaskukk tomaskukk commented Feb 6, 2024

Description

Currently when a query has required variables, the passing of variables object isn't enforced in query hook args. This can cause runtime errors as if one doesn't specify the variables object at all, the types all are happy.

This PR introduces a proposed fix to ensure that variables need to be passed in args, when there are some required variables in the query. Similar has been done already for the component generation, but looks like this wasn't taken into account then.

Related dotansimha/graphql-code-generator#2870

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)

How Has This Been Tested?

There are new test cases ensuring that variables added as a required field instead of optional, when some of the query variables are required.

I ran the tests locally and saw that they passed.

Test Environment:

  • OS: macOS
  • @graphql-codegen/typescript-react-apollo: 4.2.0
  • NodeJS: v18.19.0

Checklist:

  • I have followed the
    CONTRIBUTING doc and the
    style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules

Copy link

changeset-bot bot commented Feb 6, 2024

🦋 Changeset detected

Latest commit: 1177546

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
@graphql-codegen/typescript-react-apollo Minor

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@saihaj saihaj merged commit 3e2c8de into dotansimha:main Feb 8, 2024
14 checks passed
@github-actions github-actions bot mentioned this pull request Feb 8, 2024
@saihaj
Copy link
Collaborator

saihaj commented Feb 8, 2024

Thank you! Published @graphql-codegen/typescript-react-apollo@4.3.0

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants