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

Add extension fields to error objects thrown from findDeprecatedUsages #2160

Closed
wants to merge 10 commits into from

Conversation

samchungy
Copy link

@samchungy samchungy commented Aug 23, 2022

🚨 IMPORTANT: Please do not create a Pull Request without creating an issue first.

Any change needs to be discussed before proceeding. Failure to do so may result in the rejection of the pull request.

Description

Adds extra fields to the GraphQLError extensions objects for deprecation errors thrown from findDeprecatedUsages. This allows users to access the values in the error without needing to parse the error message. This also exports some types for users to use in their codebase as they will likely want to assert against them.

Fixes #2159

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

Screenshots/Sandbox (if appropriate/relevant):

Adding links to sandbox or providing screenshots can help us understand more about this PR and take action on it as
appropriate

How Has This Been Tested?

Unit Tests
Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also
list any relevant details for your test configuration

  • yarn test

Test Environment:

  • OS:
  • @graphql-inspector/...:
  • NodeJS: 16

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

Further comments

If this is a relatively large or complex change, kick off the discussion by explaining why you chose the solution you
did and what alternatives you considered, etc...

@vercel
Copy link

vercel bot commented Aug 23, 2022

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated
graphql-inspector ✅ Ready (Inspect) Visit Preview Aug 24, 2022 at 9:10AM (UTC)

@samchungy samchungy changed the title Add fields to extensions Add deprecation fields to error objects thrown from findDeprecatedUsages Aug 23, 2022
@samchungy samchungy changed the title Add deprecation fields to error objects thrown from findDeprecatedUsages Add extension fields to error objects thrown from findDeprecatedUsages Aug 23, 2022
)
);
}
}
},
EnumValue(node) {
const enumVal = typeInfo.getEnumValue();
Copy link
Author

Choose a reason for hiding this comment

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

This part hasn't changed. Just named the variables a little better for consistency with the above sections

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.

Surface deprecation fields in Error Objects for Validate
1 participant