1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334
|
// Copyright 2015 Canonical Ltd.
// Licensed under the LGPLv3, see LICENCE file for details.
package httprequest
import (
"bytes"
"encoding/json"
"fmt"
"io"
"io/ioutil"
"net/http"
"net/url"
"reflect"
"strings"
"golang.org/x/net/context"
"gopkg.in/errgo.v1"
)
// Doer is implemented by HTTP client packages
// to make an HTTP request. It is notably implemented
// by http.Client and httpbakery.Client.
type Doer interface {
Do(req *http.Request) (*http.Response, error)
}
// DoerWithContext is implemented by HTTP clients that can use a context
// with the HTTP request.
type DoerWithContext interface {
DoWithContext(ctx context.Context, req *http.Request) (*http.Response, error)
}
// Client represents a client that can invoke httprequest endpoints.
type Client struct {
// BaseURL holds the base URL to use when making
// HTTP requests.
BaseURL string
// Doer holds a value that will be used to actually
// make the HTTP request. If it is nil, http.DefaultClient
// will be used instead. If Doer implements DoerWithContext,
// DoWithContext will be used instead.
Doer Doer
// If a request returns an HTTP response that signifies an
// error, UnmarshalError is used to unmarshal the response into
// an appropriate error. See ErrorUnmarshaler for a convenient
// way to create an UnmarshalError function for a given type. If
// this is nil, DefaultErrorUnmarshaler will be used.
UnmarshalError func(resp *http.Response) error
}
// DefaultErrorUnmarshaler is the default error unmarshaler
// used by Client.
var DefaultErrorUnmarshaler = ErrorUnmarshaler(new(RemoteError))
// Call invokes the endpoint implied by the given params,
// which should be of the form accepted by the ArgT
// argument to a function passed to Handle, and
// unmarshals the response into the given response parameter,
// which should be a pointer to the response value.
//
// If params implements the HeaderSetter interface, its SetHeader method
// will be called to add additional headers to the HTTP request.
//
// If resp is nil, the response will be ignored if the
// request was successful.
//
// If resp is of type **http.Response, instead of unmarshaling
// into it, its element will be set to the returned HTTP
// response directly and the caller is responsible for
// closing its Body field.
//
// Any error that c.UnmarshalError or c.Doer returns will not
// have its cause masked.
//
// If the request returns a response with a status code signifying
// success, but the response could not be unmarshaled, a
// *DecodeResponseError will be returned holding the response. Note that if
// the request returns an error status code, the Client.UnmarshalError
// function is responsible for doing this if desired (the default error
// unmarshal functions do).
func (c *Client) Call(ctx context.Context, params, resp interface{}) error {
return c.CallURL(ctx, c.BaseURL, params, resp)
}
// CallURL is like Call except that the given URL is used instead of
// c.BaseURL.
func (c *Client) CallURL(ctx context.Context, url string, params, resp interface{}) error {
rt, err := getRequestType(reflect.TypeOf(params))
if err != nil {
return errgo.Mask(err)
}
if rt.method == "" {
return errgo.Newf("type %T has no httprequest.Route field", params)
}
reqURL, err := appendURL(url, rt.path)
if err != nil {
return errgo.Mask(err)
}
req, err := Marshal(reqURL.String(), rt.method, params)
if err != nil {
return errgo.Mask(err)
}
return c.Do(ctx, req, resp)
}
// Do sends the given request and unmarshals its JSON
// result into resp, which should be a pointer to the response value.
// If an error status is returned, the error will be unmarshaled
// as in Client.Call.
//
// If resp is nil, the response will be ignored if the response was
// successful.
//
// If resp is of type **http.Response, instead of unmarshaling
// into it, its element will be set to the returned HTTP
// response directly and the caller is responsible for
// closing its Body field.
//
// Any error that c.UnmarshalError or c.Doer returns will not
// have its cause masked.
//
// If req.URL does not have a host part it will be treated as relative to
// c.BaseURL. req.URL will be updated to the actual URL used.
//
// If the response cannot by unmarshaled, a *DecodeResponseError
// will be returned holding the response from the request.
// the entire response body.
func (c *Client) Do(ctx context.Context, req *http.Request, resp interface{}) error {
if req.URL.Host == "" {
var err error
req.URL, err = appendURL(c.BaseURL, req.URL.String())
if err != nil {
return errgo.Mask(err)
}
}
doer := c.Doer
if doer == nil {
doer = http.DefaultClient
}
var httpResp *http.Response
var err error
if ctxDoer, ok := doer.(DoerWithContext); ok {
httpResp, err = ctxDoer.DoWithContext(ctx, req)
} else {
httpResp, err = doer.Do(requestWithContext(req, ctx))
}
if err != nil {
return errgo.Mask(urlError(err, req), errgo.Any)
}
return c.unmarshalResponse(httpResp, resp)
}
// Get is a convenience method that uses c.Do to issue a GET request to
// the given URL. If the given URL does not have a host part then it will
// be treated as relative to c.BaseURL.
func (c *Client) Get(ctx context.Context, url string, resp interface{}) error {
req, err := http.NewRequest("GET", url, nil)
if err != nil {
return errgo.Notef(err, "cannot make request")
}
return c.Do(ctx, req, resp)
}
// unmarshalResponse unmarshals an HTTP response into the given value.
func (c *Client) unmarshalResponse(httpResp *http.Response, resp interface{}) error {
if 200 <= httpResp.StatusCode && httpResp.StatusCode < 300 {
if respPt, ok := resp.(**http.Response); ok {
*respPt = httpResp
return nil
}
defer httpResp.Body.Close()
if err := UnmarshalJSONResponse(httpResp, resp); err != nil {
return errgo.Mask(urlError(err, httpResp.Request), isDecodeResponseError)
}
return nil
}
defer httpResp.Body.Close()
errUnmarshaler := c.UnmarshalError
if errUnmarshaler == nil {
errUnmarshaler = DefaultErrorUnmarshaler
}
err := errUnmarshaler(httpResp)
if err == nil {
err = errgo.Newf("unexpected HTTP response status: %s", httpResp.Status)
}
return errgo.Mask(urlError(err, httpResp.Request), errgo.Any)
}
// ErrorUnmarshaler returns a function which will unmarshal error
// responses into new values of the same type as template. The argument
// must be a pointer. A new instance of it is created every time the
// returned function is called.
//
// If the error cannot by unmarshaled, the function will return an
// *HTTPResponseError holding the response from the request.
func ErrorUnmarshaler(template error) func(*http.Response) error {
t := reflect.TypeOf(template)
if t.Kind() != reflect.Ptr {
panic(errgo.Newf("cannot unmarshal errors into value of type %T", template))
}
t = t.Elem()
return func(resp *http.Response) error {
if 300 <= resp.StatusCode && resp.StatusCode < 400 {
// It's a redirection error.
loc, _ := resp.Location()
return newDecodeResponseError(resp, nil, fmt.Errorf("unexpected redirect (status %s) from %q to %q", resp.Status, resp.Request.URL, loc))
}
errv := reflect.New(t)
if err := UnmarshalJSONResponse(resp, errv.Interface()); err != nil {
return errgo.NoteMask(err, fmt.Sprintf("cannot unmarshal error response (status %s)", resp.Status), isDecodeResponseError)
}
return errv.Interface().(error)
}
}
// UnmarshalJSONResponse unmarshals the given HTTP response
// into x, which should be a pointer to the result to be
// unmarshaled into.
//
// If the response cannot be unmarshaled, an error of type
// *DecodeResponseError will be returned.
func UnmarshalJSONResponse(resp *http.Response, x interface{}) error {
if x == nil {
return nil
}
if !isJSONMediaType(resp.Header) {
fancyErr := newFancyDecodeError(resp.Header, resp.Body)
return newDecodeResponseError(resp, fancyErr.body, fancyErr)
}
// Read enough data that we can produce a plausible-looking
// possibly-truncated response body in the error.
var buf bytes.Buffer
n, err := io.Copy(&buf, io.LimitReader(resp.Body, int64(maxErrorBodySize)))
bodyData := buf.Bytes()
if err != nil {
return newDecodeResponseError(resp, bodyData, errgo.Notef(err, "error reading response body"))
}
if n < int64(maxErrorBodySize) {
// We've read all the data; unmarshal it.
if err := json.Unmarshal(bodyData, x); err != nil {
return newDecodeResponseError(resp, bodyData, err)
}
return nil
}
// The response is longer than maxErrorBodySize; stitch the read
// bytes together with the body so that we can still read
// bodies larger than maxErrorBodySize.
dec := json.NewDecoder(io.MultiReader(&buf, resp.Body))
// Try to read all the body so that we can reuse the
// connection, but don't try *too* hard. Note that the
// usual number of additional bytes is 1 (a single newline
// after the JSON).
defer io.Copy(ioutil.Discard, io.LimitReader(resp.Body, 8*1024))
if err := dec.Decode(x); err != nil {
return newDecodeResponseError(resp, bodyData, err)
}
return nil
}
// RemoteError holds the default type of a remote error
// used by Client when no custom error unmarshaler
// is set.
type RemoteError struct {
// Message holds the error message.
Message string
// Code may hold a code that classifies the error.
Code string `json:",omitempty"`
// Info holds any other information associated with the error.
Info *json.RawMessage `json:",omitempty"`
}
// Error implements the error interface.
func (e *RemoteError) Error() string {
if e.Message == "" {
return "httprequest: no error message found"
}
return e.Message
}
// appendURL returns the result of combining the
// given base URL and relative URL.
//
// The path of the relative URL will be appended
// to the base URL, separated by a slash (/) if
// needed.
//
// Any query parameters will be concatenated together.
//
// appendURL will return an error if relURLStr contains
// a host name.
func appendURL(baseURLStr, relURLStr string) (*url.URL, error) {
b, err := url.Parse(baseURLStr)
if err != nil {
return nil, errgo.Notef(err, "cannot parse %q", baseURLStr)
}
r, err := url.Parse(relURLStr)
if err != nil {
return nil, errgo.Notef(err, "cannot parse %q", relURLStr)
}
if r.Host != "" {
return nil, errgo.Newf("relative URL specifies a host")
}
if r.Path != "" {
b.Path = strings.TrimSuffix(b.Path, "/") + "/" + strings.TrimPrefix(r.Path, "/")
}
if r.RawQuery != "" {
if b.RawQuery != "" {
b.RawQuery += "&" + r.RawQuery
} else {
b.RawQuery = r.RawQuery
}
}
return b, nil
}
func urlError(err error, req *http.Request) error {
_, ok := errgo.Cause(err).(*url.Error)
if ok {
// The error is already sufficiently annotated.
return err
}
// Convert the method to mostly lower case to match net/http's behaviour
// so we don't get silly divergence of messages.
method := req.Method[:1] + strings.ToLower(req.Method[1:])
return errgo.NoteMask(err, fmt.Sprintf("%s %s", method, req.URL), errgo.Any)
}
|