Repository navigation
fix(graphql-language-service): do not require non-null variables with default values in JSON schema - #4764
Open
khangb2306668 wants to merge 1 commit into
Conversation
… default values in JSON schema
🦋 Changeset detectedLatest commit: 8bc1c65 The changes in this PR will be included in the next version bump. This PR includes changesets to release 2 packages
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 |
|
|
Author
|
Hi team, I've opened this PR to resolve #4762 regarding non-null variables with default values in JSON schema. All unit tests pass locally. Could a maintainer please approve the CI workflow execution and take a look when you have a moment? Thanks! |
This branch has not been deployed
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.
Summary
Resolves #4762.
According to the GraphQL specification (§5.8.3 "Variable Values"), if an operation variable is omitted in the client's
variablesdictionary and has a default value, the execution algorithm automatically applies the default value. Previously,getVariablesJSONSchemamarked all non-null variables asrequiredin the generated JSON Schema becausecollectVariablesonly collected types and dropped variable default values, causing GraphiQL/Monaco variables editor to erroneously reportMissing property "intro".Changes
collectVariables.ts: AddedVariableInfo,VariableToInfo, andcollectVariableInfo()to retain variable AST information includingdefaultValue, while keepingcollectVariablesbackward-compatible.getVariablesJSONSchema.ts: Updated to check for default values and omit non-null variables with defaults fromjsonSchema.required. Also safely populates JSON Schemadefinition.defaultusingvalueFromAST.getOperationFacts.ts&packages/monaco-graphql/src/LanguageService.ts: ThreadedvariableInfotogetVariablesJSONSchema.collectVariables.test.ts&getVariablesJSONSchema.test.ts: Added unit tests verifying default value tracking, spec compliance for non-null variables with defaults, and legacy compatibility.graphql-language-service.How to verify
Run the unit test suites: