Improve GraphQL error handling by mapping all DataApiBuilderException types to appropriate HTTP status codes #2692
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
…LResultSerializer Co-authored-by: Aniruddh25 <[email protected]>
Copilot
AI
changed the title
Copilot finished work on behalf of
Aniruddh25
May 19, 2025 20:07
|
/azp run |
|
Azure Pipelines will not run the associated pipelines, because the pull request was updated after the run command was issued. Review the pull request again and issue a new run command. |
JerryNixon
approved these changes
Sep 4, 2025
| /// </summary> | ||
| public class DabGraphQLResultSerializer : DefaultHttpResultSerializer | ||
| { | ||
| public override HttpStatusCode GetStatusCode(IExecutionResult result) | ||
| { | ||
| if (result is IQueryResult queryResult && queryResult.Errors?.Count > 0) | ||
| { | ||
| if (queryResult.Errors.Any(error => error.Code == DataApiBuilderException.SubStatusCodes.DatabaseInputError.ToString())) | ||
| // Check if any of the errors are from DataApiBuilderException by looking at error.Code | ||
| foreach (var error in queryResult.Errors) |
There was a problem hiding this comment.
This is a really good idea.
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.
What's changed
This PR enhances the
DabGraphQLResultSerializerclass to properly map all types ofDataApiBuilderException.SubStatusCodesto their appropriate HTTP status codes in GraphQL responses.Previously, the serializer only handled one specific error type (
DatabaseInputError) and would returnBadRequest(400) status code for it, while defaulting to server error (500) for all other exceptions.Now, the serializer has been updated to:
This implementation ensures that GraphQL responses have the appropriate HTTP status codes that match the nature of the error, which improves API consistency and allows clients to better handle different error types.
The class documentation has also been updated to clearly explain the purpose and behavior of the serializer.
Fixes #2691.
Warning
Firewall rules blocked me from connecting to one or more addresses
I tried to connect to the following addresses, but was blocked by firewall rules:
cdn.fwupd.orgcrl3.digicert.comdotnet build src/Azure.DataApiBuilder.sln(dns block)crl4.digicert.comdotnet build src/Azure.DataApiBuilder.sln(dns block)dc.services.visualstudio.comocsp.digicert.comdotnet build src/Azure.DataApiBuilder.sln(dns block)s.symcb.comdotnet build src/Azure.DataApiBuilder.sln(dns block)s.symcd.comdotnet build src/Azure.DataApiBuilder.sln(dns block)testts-crl.ws.symantec.comdotnet build src/Azure.DataApiBuilder.sln(dns block)ts-ocsp.ws.symantec.comdotnet build src/Azure.DataApiBuilder.sln(dns block)www.microsoft.comdotnet build src/Azure.DataApiBuilder.sln(dns block)If you need me to access, download, or install something from one of these locations, you can either:
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.