support/http: remove behind proxy option for muxes #2051
Merged
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.
PR Checklist
PR Structure
otherwise).
services/friendbot
, orall
ordoc
if the changes are broad or impact manypackages.
Thoroughness
This PR adds tests for the most critical parts of the new functionality or fixes.I've updated any docs (developer docs,.md
files, etc... affected by this change). Take a look in the
docs
folder for a given service,like this one.
Release planning
I've updated the relevant CHANGELOG (here for Horizon) ifneeded with deprecations, added features, breaking changes, and DB schema changes.
semver, or if it's mainly a patch change. The PR is targeted at the next
release branch if it's not a patch change.
What
Remove the ability to configure
support/http
muxes/routers with the behind proxy flag.Why
We use these mux functions in five places across four applications, but always with behind proxy as false. We never offer a way to configure it, it's always hardcoded. The middleware that behind proxy adds is the chi
RealIP
middleware, and even in Horizon we don't use it. It seems like something we added for a specific use case but never used. Removing it to make this code simpler.Known limitations
This is a non-breaking change for the applications in the repo because I'm updating all the callers to not pass the value, but this is a breaking change for anyone outside this repository who might be importing
github.com/stellar/go/support/http
. As I understand it the code that lives under thesupport
package is primarily intended for use by services within this repository and so the likelihood of this being a breaking change for anyone is small. According to GoDoc.org there are no importers ofsupport/http
who aren't a fork of this repository.We'd benefit from a formal backwards compatibility statement that classified each package and what its compatibility promise is. If we ever decide one I think we should keep the support package outside any compatibility promise.