feat: allow deprecated on input fields and field arguments#2951
Open
amritatwal wants to merge 1 commit into
Open
feat: allow deprecated on input fields and field arguments#2951amritatwal wants to merge 1 commit into
amritatwal wants to merge 1 commit into
Conversation
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description
Allow @deprecated on input fields and field arguments.
Schema diff already modeled deprecation for output fields but input fields and field arguments did not get the same treatment. Those deprecations were easy to miss or only surfaced indirectly through directive-usage changes.
This PR adds first-class deprecation diffing for:
Input object fields — new INPUT_FIELD_DEPRECATION_* change types (added / removed / reason added, changed, removed), aligned with the existing field deprecation logic (including the default reason "No longer supported").
Field arguments — new FIELD_ARGUMENT_DEPRECATION_* change types with the same semantics.
isDeprecatednow accepts GraphQLArgument so argument deprecation is detected consistently. Input field and argument directive lists are compared the same way as output fields (alwayscompareDirectiveLists(..., || [])), avoiding gaps whenlastNode.directivesis missing on one side.Supporting updates: ChangeType / Changes map, simplifyChanges, compare-changes meta keys, patch “addition” classification, and core exports.
Fixes #2199
Type of change
How Has This Been Tested?
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
packages/core/__tests__/diff/input.test.ts(deprecation added/removed, reason churn, “added with reason” / dual changes on@deprecatedpath)packages/core/__tests__/diff/argument.test.ts(same scenarios for field arguments)pnpmcheck (TypeScript)pnpmtest / targeted vitest forpackages/coreandpackages/compare-changesTest Environment:
@graphql-inspector/corev24.11.0Checklist:
CONTRIBUTING doc and the
style guidelines of this project