spring-cloud/spring-cloud-gateway

ProxyExchange discards all incoming request headers when making a request with a body.

Open

#2,559 opened on Mar 16, 2022

View on GitHub
 (3 comments) (2 reactions) (0 assignees)Java (4,284 stars) (3,204 forks)batch import
bughelp wanted

Description

Affects: spring-cloud-gateway-webflux:3.1.1

Setup Define an MVC RestController that accepts a ProxyExchange as an argument to a request handler method, and use the ProxyExchange object to issue a POST request (or any request that contains a body) to an upstream service, using a body created (or manipulated) in the request handler method.

Expected Behaviour The ProxyExchange forwards the original request headers, minus filtered sensitive headers, and Content related headers in the upstream request.

Observed Behaviour The ProxyExchange discards all original incoming headers, appending only the X-Forwarded-For and X-Forwarded-Proto headers. This behaviour is in contrast to the behaviour observed when using a ProxyExchange object to make requests to upstream services that do not contain bodies (GET, OPTIONS, etc).

Contributor guide

Tech stack
java
Domain
backendapi
Issue type
bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
JavaSpring Framework basics
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
Examine the ProxyExchange class implementation in spring cloud gateway core (likely in the `org.springframework.cloud.gateway.support` package). Investigate how headers are handled differently for requests with and without a body. The issue mentions that when there is a body, only X Forwarded For and X Forwarded Proto are appended, discarding original headers. Look for methods like `headers()` or `exchange()` in ProxyExchange and related classes. Check if there are any tests for this behavior and consider adding a unit test that reproduces the bug.
ProxyExchange discards all incoming request headers when making a request with a body. · spring-cloud/spring-cloud-gateway#2559 | Good First Issue