Update ProxyResponse documentation to reference IForwarderErrorFeature #2854
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
Co-authored-by: MihaZupan <[email protected]>
Copilot
AI
changed the title
MihaZupan
reviewed
May 20, 2025
Co-authored-by: MihaZupan <[email protected]>
MihaZupan
added
the
Type: Documentation
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.
Issue Description
When users encounter a
nullResponseTransformContext.ProxyResponsein a response transform, they currently don't have clear guidance on how to get more information about the error that occurred.Changes
This PR adds documentation to the
ResponseTransformContext.ProxyResponseproperty explaining how to access error details when the response is null:Yarp.ReverseProxy.Forwardernamespace to properly referenceIForwarderErrorFeatureHttpContext.Features.Get<IForwarderErrorFeature>()or usingHttpContextFeaturesExtensions.GetForwarderErrorFeature(HttpContext)to get details about the errorBefore Change:
After Change:
This documentation improvement helps users discover how to access error information when handling null responses in response transforms.
Fixes #2562.
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:
dc.services.visualstudio.com/home/REDACTED/work/yarp/yarp/.dotnet/dotnet msbuild /m /nologo /clp:Summary /v:minimal /nr:true /warnaserror /p:TreatWarningsAsErrors=true /p:ContinuousIntegrationBuild=false /home/REDACTED/work/yarp/yarp/artifacts/toolset/restore.proj /t:__WriteToolsetLocation /clp:ErrorsOnly;NoSummary /p:__ToolsetLocationOutputFile=/home/REDACTED/work/yarp/yarp/artifacts/toolset/10.0.0-beta.25268.1.txt(dns block)pkgs.dev.azure.com/home/REDACTED/work/yarp/yarp/.dotnet/dotnet msbuild /m /nologo /clp:Summary /v:minimal /nr:true /warnaserror /p:TreatWarningsAsErrors=true /p:ContinuousIntegrationBuild=false /home/REDACTED/work/yarp/yarp/artifacts/toolset/restore.proj /t:__WriteToolsetLocation /clp:ErrorsOnly;NoSummary /p:__ToolsetLocationOutputFile=/home/REDACTED/work/yarp/yarp/artifacts/toolset/10.0.0-beta.25268.1.txt(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.