open-nomad/vendor/github.com/hashicorp/go-cleanhttp
Seth Hoenig 435c0d9fc8 deps: Switch to Go modules for dependency management
This PR switches the Nomad repository from using govendor to Go modules
for managing dependencies. Aspects of the Nomad workflow remain pretty
much the same. The usual Makefile targets should continue to work as
they always did. The API submodule simply defers to the parent Nomad
version on the repository, keeping the semantics of API versioning that
currently exists.
2020-06-02 14:30:36 -05:00
..
LICENSE Using godeps to build 2016-02-12 10:02:16 -08:00
README.md Using godeps to build 2016-02-12 10:02:16 -08:00
cleanhttp.go deps: Switch to Go modules for dependency management 2020-06-02 14:30:36 -05:00
doc.go Update go-cleanhttp 2016-02-17 16:59:20 -05:00
go.mod deps: Switch to Go modules for dependency management 2020-06-02 14:30:36 -05:00
handlers.go deps: Switch to Go modules for dependency management 2020-06-02 14:30:36 -05:00

README.md

cleanhttp

Functions for accessing "clean" Go http.Client values


The Go standard library contains a default http.Client called http.DefaultClient. It is a common idiom in Go code to start with http.DefaultClient and tweak it as necessary, and in fact, this is encouraged; from the http package documentation:

The Client's Transport typically has internal state (cached TCP connections), so Clients should be reused instead of created as needed. Clients are safe for concurrent use by multiple goroutines.

Unfortunately, this is a shared value, and it is not uncommon for libraries to assume that they are free to modify it at will. With enough dependencies, it can be very easy to encounter strange problems and race conditions due to manipulation of this shared value across libraries and goroutines (clients are safe for concurrent use, but writing values to the client struct itself is not protected).

Making things worse is the fact that a bare http.Client will use a default http.Transport called http.DefaultTransport, which is another global value that behaves the same way. So it is not simply enough to replace http.DefaultClient with &http.Client{}.

This repository provides some simple functions to get a "clean" http.Client -- one that uses the same default values as the Go standard library, but returns a client that does not share any state with other clients.