feat: structured GraphQL exception handling#2268
Open
zhaomoran wants to merge 1 commit into
Open
Conversation
21bc97f to
f72b2d3
Compare
Introduce GHGraphQLException and GHGraphQLError to provide structured access to GraphQL error responses, including type, path, locations, and extensions fields per the GraphQL spec. This enables callers to programmatically inspect errors rather than parsing exception messages. Modeled after octokit/graphql.js's GraphqlResponseError pattern.
88a6810 to
343ec1a
Compare
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
Add structured GraphQL error handling by introducing
GHGraphQLExceptionandGHGraphQLError, enabling callers to programmatically inspect GraphQL error responses instead of parsing exception messages.Key changes:
GHGraphQLErrorclass exposing all GraphQL spec fields:message,type,path,locations,extensionsGHGraphQLException(extendsGHIOException) thrown byRequester.fetchGraphQLon GraphQL errors, carrying the full error list, partial response data, and original query"Request failed due to following response errors:\n - <msg1>\n - <msg2>"GHGraphQLResponse.getDataUnchecked()for accessing partial data in partial-success scenarios@JsonIgnoreProperties(ignoreUnknown = true)Modeled after octokit/graphql.js's GraphqlResponseError pattern.
Relevant GraphQL spec reference: https://spec.graphql.org/October2021/#sec-Errors
This change is fully backward compatible —
GHGraphQLExceptionextendsGHIOExceptionwhich extendsIOException, so existingcatch (IOException)blocks continue to work. Callers can optionally catchGHGraphQLExceptionfor structured access.Before submitting a PR:
@linkJavaDoc entries to the relevant documentation on https://docs.github.com/en/rest .mvn -D enable-ci clean install site "-Dsurefire.argLine=--add-opens java.base/java.net=ALL-UNNAMED"locally. If this command doesn't succeed, your change will not pass CI.main. You will create your PR from that branch.When creating a PR: