1022 lines
25 KiB
Go
1022 lines
25 KiB
Go
package fiber
|
|
|
|
import (
|
|
"bytes"
|
|
"crypto/tls"
|
|
"encoding/json"
|
|
"encoding/xml"
|
|
"fmt"
|
|
"io"
|
|
"mime/multipart"
|
|
"os"
|
|
"path/filepath"
|
|
"strconv"
|
|
"sync"
|
|
"time"
|
|
|
|
"github.com/gofiber/fiber/v2/utils"
|
|
|
|
"github.com/valyala/fasthttp"
|
|
)
|
|
|
|
// Request represents HTTP request.
|
|
//
|
|
// It is forbidden copying Request instances. Create new instances
|
|
// and use CopyTo instead.
|
|
//
|
|
// Request instance MUST NOT be used from concurrently running goroutines.
|
|
// Copy from fasthttp
|
|
type Request = fasthttp.Request
|
|
|
|
// Response represents HTTP response.
|
|
//
|
|
// It is forbidden copying Response instances. Create new instances
|
|
// and use CopyTo instead.
|
|
//
|
|
// Response instance MUST NOT be used from concurrently running goroutines.
|
|
// Copy from fasthttp
|
|
type Response = fasthttp.Response
|
|
|
|
// Args represents query arguments.
|
|
//
|
|
// It is forbidden copying Args instances. Create new instances instead
|
|
// and use CopyTo().
|
|
//
|
|
// Args instance MUST NOT be used from concurrently running goroutines.
|
|
// Copy from fasthttp
|
|
type Args = fasthttp.Args
|
|
|
|
// RetryIfFunc signature of retry if function
|
|
// Request argument passed to RetryIfFunc, if there are any request errors.
|
|
// Copy from fasthttp
|
|
type RetryIfFunc = fasthttp.RetryIfFunc
|
|
|
|
var defaultClient Client
|
|
|
|
// Client implements http client.
|
|
//
|
|
// It is safe calling Client methods from concurrently running goroutines.
|
|
type Client struct {
|
|
mutex sync.RWMutex
|
|
// UserAgent is used in User-Agent request header.
|
|
UserAgent string
|
|
|
|
// NoDefaultUserAgentHeader when set to true, causes the default
|
|
// User-Agent header to be excluded from the Request.
|
|
NoDefaultUserAgentHeader bool
|
|
|
|
// When set by an external client of Fiber it will use the provided implementation of a
|
|
// JSONMarshal
|
|
//
|
|
// Allowing for flexibility in using another json library for encoding
|
|
JSONEncoder utils.JSONMarshal
|
|
|
|
// When set by an external client of Fiber it will use the provided implementation of a
|
|
// JSONUnmarshal
|
|
//
|
|
// Allowing for flexibility in using another json library for decoding
|
|
JSONDecoder utils.JSONUnmarshal
|
|
}
|
|
|
|
// Get returns an agent with http method GET.
|
|
func Get(url string) *Agent { return defaultClient.Get(url) }
|
|
|
|
// Get returns an agent with http method GET.
|
|
func (c *Client) Get(url string) *Agent {
|
|
return c.createAgent(MethodGet, url)
|
|
}
|
|
|
|
// Head returns an agent with http method HEAD.
|
|
func Head(url string) *Agent { return defaultClient.Head(url) }
|
|
|
|
// Head returns an agent with http method GET.
|
|
func (c *Client) Head(url string) *Agent {
|
|
return c.createAgent(MethodHead, url)
|
|
}
|
|
|
|
// Post sends POST request to the given URL.
|
|
func Post(url string) *Agent { return defaultClient.Post(url) }
|
|
|
|
// Post sends POST request to the given URL.
|
|
func (c *Client) Post(url string) *Agent {
|
|
return c.createAgent(MethodPost, url)
|
|
}
|
|
|
|
// Put sends PUT request to the given URL.
|
|
func Put(url string) *Agent { return defaultClient.Put(url) }
|
|
|
|
// Put sends PUT request to the given URL.
|
|
func (c *Client) Put(url string) *Agent {
|
|
return c.createAgent(MethodPut, url)
|
|
}
|
|
|
|
// Patch sends PATCH request to the given URL.
|
|
func Patch(url string) *Agent { return defaultClient.Patch(url) }
|
|
|
|
// Patch sends PATCH request to the given URL.
|
|
func (c *Client) Patch(url string) *Agent {
|
|
return c.createAgent(MethodPatch, url)
|
|
}
|
|
|
|
// Delete sends DELETE request to the given URL.
|
|
func Delete(url string) *Agent { return defaultClient.Delete(url) }
|
|
|
|
// Delete sends DELETE request to the given URL.
|
|
func (c *Client) Delete(url string) *Agent {
|
|
return c.createAgent(MethodDelete, url)
|
|
}
|
|
|
|
func (c *Client) createAgent(method, url string) *Agent {
|
|
a := AcquireAgent()
|
|
a.req.Header.SetMethod(method)
|
|
a.req.SetRequestURI(url)
|
|
|
|
c.mutex.RLock()
|
|
a.Name = c.UserAgent
|
|
a.NoDefaultUserAgentHeader = c.NoDefaultUserAgentHeader
|
|
a.jsonDecoder = c.JSONDecoder
|
|
a.jsonEncoder = c.JSONEncoder
|
|
if a.jsonDecoder == nil {
|
|
a.jsonDecoder = json.Unmarshal
|
|
}
|
|
c.mutex.RUnlock()
|
|
|
|
if err := a.Parse(); err != nil {
|
|
a.errs = append(a.errs, err)
|
|
}
|
|
|
|
return a
|
|
}
|
|
|
|
// Agent is an object storing all request data for client.
|
|
// Agent instance MUST NOT be used from concurrently running goroutines.
|
|
type Agent struct {
|
|
// Name is used in User-Agent request header.
|
|
Name string
|
|
|
|
// NoDefaultUserAgentHeader when set to true, causes the default
|
|
// User-Agent header to be excluded from the Request.
|
|
NoDefaultUserAgentHeader bool
|
|
|
|
// HostClient is an embedded fasthttp HostClient
|
|
*fasthttp.HostClient
|
|
|
|
req *Request
|
|
resp *Response
|
|
dest []byte
|
|
args *Args
|
|
timeout time.Duration
|
|
errs []error
|
|
formFiles []*FormFile
|
|
debugWriter io.Writer
|
|
mw multipartWriter
|
|
jsonEncoder utils.JSONMarshal
|
|
jsonDecoder utils.JSONUnmarshal
|
|
maxRedirectsCount int
|
|
boundary string
|
|
reuse bool
|
|
parsed bool
|
|
}
|
|
|
|
// Parse initializes URI and HostClient.
|
|
func (a *Agent) Parse() error {
|
|
if a.parsed {
|
|
return nil
|
|
}
|
|
a.parsed = true
|
|
|
|
uri := a.req.URI()
|
|
|
|
var isTLS bool
|
|
scheme := uri.Scheme()
|
|
if bytes.Equal(scheme, []byte(schemeHTTPS)) {
|
|
isTLS = true
|
|
} else if !bytes.Equal(scheme, []byte(schemeHTTP)) {
|
|
return fmt.Errorf("unsupported protocol %q. http and https are supported", scheme)
|
|
}
|
|
|
|
name := a.Name
|
|
if name == "" && !a.NoDefaultUserAgentHeader {
|
|
name = defaultUserAgent
|
|
}
|
|
|
|
a.HostClient = &fasthttp.HostClient{
|
|
Addr: fasthttp.AddMissingPort(string(uri.Host()), isTLS),
|
|
Name: name,
|
|
NoDefaultUserAgentHeader: a.NoDefaultUserAgentHeader,
|
|
IsTLS: isTLS,
|
|
}
|
|
|
|
return nil
|
|
}
|
|
|
|
/************************** Header Setting **************************/
|
|
|
|
// Set sets the given 'key: value' header.
|
|
//
|
|
// Use Add for setting multiple header values under the same key.
|
|
func (a *Agent) Set(k, v string) *Agent {
|
|
a.req.Header.Set(k, v)
|
|
|
|
return a
|
|
}
|
|
|
|
// SetBytesK sets the given 'key: value' header.
|
|
//
|
|
// Use AddBytesK for setting multiple header values under the same key.
|
|
func (a *Agent) SetBytesK(k []byte, v string) *Agent {
|
|
a.req.Header.SetBytesK(k, v)
|
|
|
|
return a
|
|
}
|
|
|
|
// SetBytesV sets the given 'key: value' header.
|
|
//
|
|
// Use AddBytesV for setting multiple header values under the same key.
|
|
func (a *Agent) SetBytesV(k string, v []byte) *Agent {
|
|
a.req.Header.SetBytesV(k, v)
|
|
|
|
return a
|
|
}
|
|
|
|
// SetBytesKV sets the given 'key: value' header.
|
|
//
|
|
// Use AddBytesKV for setting multiple header values under the same key.
|
|
func (a *Agent) SetBytesKV(k, v []byte) *Agent {
|
|
a.req.Header.SetBytesKV(k, v)
|
|
|
|
return a
|
|
}
|
|
|
|
// Add adds the given 'key: value' header.
|
|
//
|
|
// Multiple headers with the same key may be added with this function.
|
|
// Use Set for setting a single header for the given key.
|
|
func (a *Agent) Add(k, v string) *Agent {
|
|
a.req.Header.Add(k, v)
|
|
|
|
return a
|
|
}
|
|
|
|
// AddBytesK adds the given 'key: value' header.
|
|
//
|
|
// Multiple headers with the same key may be added with this function.
|
|
// Use SetBytesK for setting a single header for the given key.
|
|
func (a *Agent) AddBytesK(k []byte, v string) *Agent {
|
|
a.req.Header.AddBytesK(k, v)
|
|
|
|
return a
|
|
}
|
|
|
|
// AddBytesV adds the given 'key: value' header.
|
|
//
|
|
// Multiple headers with the same key may be added with this function.
|
|
// Use SetBytesV for setting a single header for the given key.
|
|
func (a *Agent) AddBytesV(k string, v []byte) *Agent {
|
|
a.req.Header.AddBytesV(k, v)
|
|
|
|
return a
|
|
}
|
|
|
|
// AddBytesKV adds the given 'key: value' header.
|
|
//
|
|
// Multiple headers with the same key may be added with this function.
|
|
// Use SetBytesKV for setting a single header for the given key.
|
|
func (a *Agent) AddBytesKV(k, v []byte) *Agent {
|
|
a.req.Header.AddBytesKV(k, v)
|
|
|
|
return a
|
|
}
|
|
|
|
// ConnectionClose sets 'Connection: close' header.
|
|
func (a *Agent) ConnectionClose() *Agent {
|
|
a.req.Header.SetConnectionClose()
|
|
|
|
return a
|
|
}
|
|
|
|
// UserAgent sets User-Agent header value.
|
|
func (a *Agent) UserAgent(userAgent string) *Agent {
|
|
a.req.Header.SetUserAgent(userAgent)
|
|
|
|
return a
|
|
}
|
|
|
|
// UserAgentBytes sets User-Agent header value.
|
|
func (a *Agent) UserAgentBytes(userAgent []byte) *Agent {
|
|
a.req.Header.SetUserAgentBytes(userAgent)
|
|
|
|
return a
|
|
}
|
|
|
|
// Cookie sets one 'key: value' cookie.
|
|
func (a *Agent) Cookie(key, value string) *Agent {
|
|
a.req.Header.SetCookie(key, value)
|
|
|
|
return a
|
|
}
|
|
|
|
// CookieBytesK sets one 'key: value' cookie.
|
|
func (a *Agent) CookieBytesK(key []byte, value string) *Agent {
|
|
a.req.Header.SetCookieBytesK(key, value)
|
|
|
|
return a
|
|
}
|
|
|
|
// CookieBytesKV sets one 'key: value' cookie.
|
|
func (a *Agent) CookieBytesKV(key, value []byte) *Agent {
|
|
a.req.Header.SetCookieBytesKV(key, value)
|
|
|
|
return a
|
|
}
|
|
|
|
// Cookies sets multiple 'key: value' cookies.
|
|
func (a *Agent) Cookies(kv ...string) *Agent {
|
|
for i := 1; i < len(kv); i += 2 {
|
|
a.req.Header.SetCookie(kv[i-1], kv[i])
|
|
}
|
|
|
|
return a
|
|
}
|
|
|
|
// CookiesBytesKV sets multiple 'key: value' cookies.
|
|
func (a *Agent) CookiesBytesKV(kv ...[]byte) *Agent {
|
|
for i := 1; i < len(kv); i += 2 {
|
|
a.req.Header.SetCookieBytesKV(kv[i-1], kv[i])
|
|
}
|
|
|
|
return a
|
|
}
|
|
|
|
// Referer sets Referer header value.
|
|
func (a *Agent) Referer(referer string) *Agent {
|
|
a.req.Header.SetReferer(referer)
|
|
|
|
return a
|
|
}
|
|
|
|
// RefererBytes sets Referer header value.
|
|
func (a *Agent) RefererBytes(referer []byte) *Agent {
|
|
a.req.Header.SetRefererBytes(referer)
|
|
|
|
return a
|
|
}
|
|
|
|
// ContentType sets Content-Type header value.
|
|
func (a *Agent) ContentType(contentType string) *Agent {
|
|
a.req.Header.SetContentType(contentType)
|
|
|
|
return a
|
|
}
|
|
|
|
// ContentTypeBytes sets Content-Type header value.
|
|
func (a *Agent) ContentTypeBytes(contentType []byte) *Agent {
|
|
a.req.Header.SetContentTypeBytes(contentType)
|
|
|
|
return a
|
|
}
|
|
|
|
/************************** End Header Setting **************************/
|
|
|
|
/************************** URI Setting **************************/
|
|
|
|
// Host sets host for the URI.
|
|
func (a *Agent) Host(host string) *Agent {
|
|
a.req.URI().SetHost(host)
|
|
|
|
return a
|
|
}
|
|
|
|
// HostBytes sets host for the URI.
|
|
func (a *Agent) HostBytes(host []byte) *Agent {
|
|
a.req.URI().SetHostBytes(host)
|
|
|
|
return a
|
|
}
|
|
|
|
// QueryString sets URI query string.
|
|
func (a *Agent) QueryString(queryString string) *Agent {
|
|
a.req.URI().SetQueryString(queryString)
|
|
|
|
return a
|
|
}
|
|
|
|
// QueryStringBytes sets URI query string.
|
|
func (a *Agent) QueryStringBytes(queryString []byte) *Agent {
|
|
a.req.URI().SetQueryStringBytes(queryString)
|
|
|
|
return a
|
|
}
|
|
|
|
// BasicAuth sets URI username and password.
|
|
func (a *Agent) BasicAuth(username, password string) *Agent {
|
|
a.req.URI().SetUsername(username)
|
|
a.req.URI().SetPassword(password)
|
|
|
|
return a
|
|
}
|
|
|
|
// BasicAuthBytes sets URI username and password.
|
|
func (a *Agent) BasicAuthBytes(username, password []byte) *Agent {
|
|
a.req.URI().SetUsernameBytes(username)
|
|
a.req.URI().SetPasswordBytes(password)
|
|
|
|
return a
|
|
}
|
|
|
|
/************************** End URI Setting **************************/
|
|
|
|
/************************** Request Setting **************************/
|
|
|
|
// BodyString sets request body.
|
|
func (a *Agent) BodyString(bodyString string) *Agent {
|
|
a.req.SetBodyString(bodyString)
|
|
|
|
return a
|
|
}
|
|
|
|
// Body sets request body.
|
|
func (a *Agent) Body(body []byte) *Agent {
|
|
a.req.SetBody(body)
|
|
|
|
return a
|
|
}
|
|
|
|
// BodyStream sets request body stream and, optionally body size.
|
|
//
|
|
// If bodySize is >= 0, then the bodyStream must provide exactly bodySize bytes
|
|
// before returning io.EOF.
|
|
//
|
|
// If bodySize < 0, then bodyStream is read until io.EOF.
|
|
//
|
|
// bodyStream.Close() is called after finishing reading all body data
|
|
// if it implements io.Closer.
|
|
//
|
|
// Note that GET and HEAD requests cannot have body.
|
|
func (a *Agent) BodyStream(bodyStream io.Reader, bodySize int) *Agent {
|
|
a.req.SetBodyStream(bodyStream, bodySize)
|
|
|
|
return a
|
|
}
|
|
|
|
// JSON sends a JSON request.
|
|
func (a *Agent) JSON(v interface{}, ctype ...string) *Agent {
|
|
if a.jsonEncoder == nil {
|
|
a.jsonEncoder = json.Marshal
|
|
}
|
|
|
|
if len(ctype) > 0 {
|
|
a.req.Header.SetContentType(ctype[0])
|
|
} else {
|
|
a.req.Header.SetContentType(MIMEApplicationJSON)
|
|
}
|
|
|
|
if body, err := a.jsonEncoder(v); err != nil {
|
|
a.errs = append(a.errs, err)
|
|
} else {
|
|
a.req.SetBody(body)
|
|
}
|
|
|
|
return a
|
|
}
|
|
|
|
// XML sends an XML request.
|
|
func (a *Agent) XML(v interface{}) *Agent {
|
|
a.req.Header.SetContentType(MIMEApplicationXML)
|
|
|
|
if body, err := xml.Marshal(v); err != nil {
|
|
a.errs = append(a.errs, err)
|
|
} else {
|
|
a.req.SetBody(body)
|
|
}
|
|
|
|
return a
|
|
}
|
|
|
|
// Form sends form request with body if args is non-nil.
|
|
//
|
|
// It is recommended obtaining args via AcquireArgs and release it
|
|
// manually in performance-critical code.
|
|
func (a *Agent) Form(args *Args) *Agent {
|
|
a.req.Header.SetContentType(MIMEApplicationForm)
|
|
|
|
if args != nil {
|
|
a.req.SetBody(args.QueryString())
|
|
}
|
|
|
|
return a
|
|
}
|
|
|
|
// FormFile represents multipart form file
|
|
type FormFile struct {
|
|
// Fieldname is form file's field name
|
|
Fieldname string
|
|
// Name is form file's name
|
|
Name string
|
|
// Content is form file's content
|
|
Content []byte
|
|
// autoRelease indicates if returns the object
|
|
// acquired via AcquireFormFile to the pool.
|
|
autoRelease bool
|
|
}
|
|
|
|
// FileData appends files for multipart form request.
|
|
//
|
|
// It is recommended obtaining formFile via AcquireFormFile and release it
|
|
// manually in performance-critical code.
|
|
func (a *Agent) FileData(formFiles ...*FormFile) *Agent {
|
|
a.formFiles = append(a.formFiles, formFiles...)
|
|
|
|
return a
|
|
}
|
|
|
|
// SendFile reads file and appends it to multipart form request.
|
|
func (a *Agent) SendFile(filename string, fieldname ...string) *Agent {
|
|
content, err := os.ReadFile(filepath.Clean(filename))
|
|
if err != nil {
|
|
a.errs = append(a.errs, err)
|
|
return a
|
|
}
|
|
|
|
ff := AcquireFormFile()
|
|
if len(fieldname) > 0 && fieldname[0] != "" {
|
|
ff.Fieldname = fieldname[0]
|
|
} else {
|
|
ff.Fieldname = "file" + strconv.Itoa(len(a.formFiles)+1)
|
|
}
|
|
ff.Name = filepath.Base(filename)
|
|
ff.Content = append(ff.Content, content...)
|
|
ff.autoRelease = true
|
|
|
|
a.formFiles = append(a.formFiles, ff)
|
|
|
|
return a
|
|
}
|
|
|
|
// SendFiles reads files and appends them to multipart form request.
|
|
//
|
|
// Examples:
|
|
//
|
|
// SendFile("/path/to/file1", "fieldname1", "/path/to/file2")
|
|
func (a *Agent) SendFiles(filenamesAndFieldnames ...string) *Agent {
|
|
pairs := len(filenamesAndFieldnames)
|
|
if pairs&1 == 1 {
|
|
filenamesAndFieldnames = append(filenamesAndFieldnames, "")
|
|
}
|
|
|
|
for i := 0; i < pairs; i += 2 {
|
|
a.SendFile(filenamesAndFieldnames[i], filenamesAndFieldnames[i+1])
|
|
}
|
|
|
|
return a
|
|
}
|
|
|
|
// Boundary sets boundary for multipart form request.
|
|
func (a *Agent) Boundary(boundary string) *Agent {
|
|
a.boundary = boundary
|
|
|
|
return a
|
|
}
|
|
|
|
// MultipartForm sends multipart form request with k-v and files.
|
|
//
|
|
// It is recommended obtaining args via AcquireArgs and release it
|
|
// manually in performance-critical code.
|
|
func (a *Agent) MultipartForm(args *Args) *Agent {
|
|
if a.mw == nil {
|
|
a.mw = multipart.NewWriter(a.req.BodyWriter())
|
|
}
|
|
|
|
if a.boundary != "" {
|
|
if err := a.mw.SetBoundary(a.boundary); err != nil {
|
|
a.errs = append(a.errs, err)
|
|
return a
|
|
}
|
|
}
|
|
|
|
a.req.Header.SetMultipartFormBoundary(a.mw.Boundary())
|
|
|
|
if args != nil {
|
|
args.VisitAll(func(key, value []byte) {
|
|
if err := a.mw.WriteField(utils.UnsafeString(key), utils.UnsafeString(value)); err != nil {
|
|
a.errs = append(a.errs, err)
|
|
}
|
|
})
|
|
}
|
|
|
|
for _, ff := range a.formFiles {
|
|
w, err := a.mw.CreateFormFile(ff.Fieldname, ff.Name)
|
|
if err != nil {
|
|
a.errs = append(a.errs, err)
|
|
continue
|
|
}
|
|
if _, err = w.Write(ff.Content); err != nil {
|
|
a.errs = append(a.errs, err)
|
|
}
|
|
}
|
|
|
|
if err := a.mw.Close(); err != nil {
|
|
a.errs = append(a.errs, err)
|
|
}
|
|
|
|
return a
|
|
}
|
|
|
|
/************************** End Request Setting **************************/
|
|
|
|
/************************** Agent Setting **************************/
|
|
|
|
// Debug mode enables logging request and response detail
|
|
func (a *Agent) Debug(w ...io.Writer) *Agent {
|
|
a.debugWriter = os.Stdout
|
|
if len(w) > 0 {
|
|
a.debugWriter = w[0]
|
|
}
|
|
|
|
return a
|
|
}
|
|
|
|
// Timeout sets request timeout duration.
|
|
func (a *Agent) Timeout(timeout time.Duration) *Agent {
|
|
a.timeout = timeout
|
|
|
|
return a
|
|
}
|
|
|
|
// Reuse enables the Agent instance to be used again after one request.
|
|
//
|
|
// If agent is reusable, then it should be released manually when it is no
|
|
// longer used.
|
|
func (a *Agent) Reuse() *Agent {
|
|
a.reuse = true
|
|
|
|
return a
|
|
}
|
|
|
|
// InsecureSkipVerify controls whether the Agent verifies the server
|
|
// certificate chain and host name.
|
|
func (a *Agent) InsecureSkipVerify() *Agent {
|
|
if a.HostClient.TLSConfig == nil {
|
|
a.HostClient.TLSConfig = &tls.Config{InsecureSkipVerify: true} //nolint:gosec // We explicitly let the user set insecure mode here
|
|
} else {
|
|
a.HostClient.TLSConfig.InsecureSkipVerify = true
|
|
}
|
|
|
|
return a
|
|
}
|
|
|
|
// TLSConfig sets tls config.
|
|
func (a *Agent) TLSConfig(config *tls.Config) *Agent {
|
|
a.HostClient.TLSConfig = config
|
|
|
|
return a
|
|
}
|
|
|
|
// MaxRedirectsCount sets max redirect count for GET and HEAD.
|
|
func (a *Agent) MaxRedirectsCount(count int) *Agent {
|
|
a.maxRedirectsCount = count
|
|
|
|
return a
|
|
}
|
|
|
|
// JSONEncoder sets custom json encoder.
|
|
func (a *Agent) JSONEncoder(jsonEncoder utils.JSONMarshal) *Agent {
|
|
a.jsonEncoder = jsonEncoder
|
|
|
|
return a
|
|
}
|
|
|
|
// JSONDecoder sets custom json decoder.
|
|
func (a *Agent) JSONDecoder(jsonDecoder utils.JSONUnmarshal) *Agent {
|
|
a.jsonDecoder = jsonDecoder
|
|
|
|
return a
|
|
}
|
|
|
|
// Request returns Agent request instance.
|
|
func (a *Agent) Request() *Request {
|
|
return a.req
|
|
}
|
|
|
|
// SetResponse sets custom response for the Agent instance.
|
|
//
|
|
// It is recommended obtaining custom response via AcquireResponse and release it
|
|
// manually in performance-critical code.
|
|
func (a *Agent) SetResponse(customResp *Response) *Agent {
|
|
a.resp = customResp
|
|
|
|
return a
|
|
}
|
|
|
|
// Dest sets custom dest.
|
|
//
|
|
// The contents of dest will be replaced by the response body, if the dest
|
|
// is too small a new slice will be allocated.
|
|
func (a *Agent) Dest(dest []byte) *Agent {
|
|
a.dest = dest
|
|
|
|
return a
|
|
}
|
|
|
|
// RetryIf controls whether a retry should be attempted after an error.
|
|
//
|
|
// By default, will use isIdempotent function from fasthttp
|
|
func (a *Agent) RetryIf(retryIf RetryIfFunc) *Agent {
|
|
a.HostClient.RetryIf = retryIf
|
|
return a
|
|
}
|
|
|
|
/************************** End Agent Setting **************************/
|
|
|
|
// Bytes returns the status code, bytes body and errors of url.
|
|
//
|
|
// it's not safe to use Agent after calling [Agent.Bytes]
|
|
func (a *Agent) Bytes() (int, []byte, []error) {
|
|
defer a.release()
|
|
return a.bytes()
|
|
}
|
|
|
|
func (a *Agent) bytes() (code int, body []byte, errs []error) { //nolint:nonamedreturns,revive // We want to overwrite the body in a deferred func. TODO: Check if we really need to do this. We eventually want to get rid of all named returns.
|
|
if errs = append(errs, a.errs...); len(errs) > 0 {
|
|
return code, body, errs
|
|
}
|
|
|
|
var (
|
|
req = a.req
|
|
resp *Response
|
|
nilResp bool
|
|
)
|
|
|
|
if a.resp == nil {
|
|
resp = AcquireResponse()
|
|
nilResp = true
|
|
} else {
|
|
resp = a.resp
|
|
}
|
|
|
|
defer func() {
|
|
if a.debugWriter != nil {
|
|
printDebugInfo(req, resp, a.debugWriter)
|
|
}
|
|
|
|
if len(errs) == 0 {
|
|
code = resp.StatusCode()
|
|
}
|
|
|
|
body = append(a.dest, resp.Body()...) //nolint:gocritic // We want to append to the returned slice here
|
|
|
|
if nilResp {
|
|
ReleaseResponse(resp)
|
|
}
|
|
}()
|
|
|
|
if a.timeout > 0 {
|
|
if err := a.HostClient.DoTimeout(req, resp, a.timeout); err != nil {
|
|
errs = append(errs, err)
|
|
return code, body, errs
|
|
}
|
|
} else if a.maxRedirectsCount > 0 && (string(req.Header.Method()) == MethodGet || string(req.Header.Method()) == MethodHead) {
|
|
if err := a.HostClient.DoRedirects(req, resp, a.maxRedirectsCount); err != nil {
|
|
errs = append(errs, err)
|
|
return code, body, errs
|
|
}
|
|
} else if err := a.HostClient.Do(req, resp); err != nil {
|
|
errs = append(errs, err)
|
|
}
|
|
|
|
return code, body, errs
|
|
}
|
|
|
|
func printDebugInfo(req *Request, resp *Response, w io.Writer) {
|
|
msg := fmt.Sprintf("Connected to %s(%s)\r\n\r\n", req.URI().Host(), resp.RemoteAddr())
|
|
_, _ = w.Write(utils.UnsafeBytes(msg)) //nolint:errcheck // This will never fail
|
|
_, _ = req.WriteTo(w) //nolint:errcheck // This will never fail
|
|
_, _ = resp.WriteTo(w) //nolint:errcheck // This will never fail
|
|
}
|
|
|
|
// String returns the status code, string body and errors of url.
|
|
//
|
|
// it's not safe to use Agent after calling [Agent.String]
|
|
func (a *Agent) String() (int, string, []error) {
|
|
defer a.release()
|
|
code, body, errs := a.bytes()
|
|
// TODO: There might be a data race here on body. Maybe use utils.CopyBytes on it?
|
|
|
|
return code, utils.UnsafeString(body), errs
|
|
}
|
|
|
|
// Struct returns the status code, bytes body and errors of URL.
|
|
// And bytes body will be unmarshalled to given v.
|
|
//
|
|
// it's not safe to use Agent after calling [Agent.Struct]
|
|
func (a *Agent) Struct(v interface{}) (int, []byte, []error) {
|
|
defer a.release()
|
|
|
|
code, body, errs := a.bytes()
|
|
if len(errs) > 0 {
|
|
return code, body, errs
|
|
}
|
|
|
|
// TODO: This should only be done once
|
|
if a.jsonDecoder == nil {
|
|
a.jsonDecoder = json.Unmarshal
|
|
}
|
|
|
|
if err := a.jsonDecoder(body, v); err != nil {
|
|
errs = append(errs, err)
|
|
}
|
|
|
|
return code, body, errs
|
|
}
|
|
|
|
func (a *Agent) release() {
|
|
if !a.reuse {
|
|
ReleaseAgent(a)
|
|
} else {
|
|
a.errs = a.errs[:0]
|
|
}
|
|
}
|
|
|
|
func (a *Agent) reset() {
|
|
a.HostClient = nil
|
|
a.req.Reset()
|
|
a.resp = nil
|
|
a.dest = nil
|
|
a.timeout = 0
|
|
a.args = nil
|
|
a.errs = a.errs[:0]
|
|
a.debugWriter = nil
|
|
a.mw = nil
|
|
a.reuse = false
|
|
a.parsed = false
|
|
a.maxRedirectsCount = 0
|
|
a.boundary = ""
|
|
a.Name = ""
|
|
a.NoDefaultUserAgentHeader = false
|
|
for i, ff := range a.formFiles {
|
|
if ff.autoRelease {
|
|
ReleaseFormFile(ff)
|
|
}
|
|
a.formFiles[i] = nil
|
|
}
|
|
a.formFiles = a.formFiles[:0]
|
|
}
|
|
|
|
var (
|
|
clientPool sync.Pool
|
|
agentPool = sync.Pool{
|
|
New: func() interface{} {
|
|
return &Agent{req: &Request{}}
|
|
},
|
|
}
|
|
responsePool sync.Pool
|
|
argsPool sync.Pool
|
|
formFilePool sync.Pool
|
|
)
|
|
|
|
// AcquireClient returns an empty Client instance from client pool.
|
|
//
|
|
// The returned Client instance may be passed to ReleaseClient when it is
|
|
// no longer needed. This allows Client recycling, reduces GC pressure
|
|
// and usually improves performance.
|
|
func AcquireClient() *Client {
|
|
v := clientPool.Get()
|
|
if v == nil {
|
|
return &Client{}
|
|
}
|
|
c, ok := v.(*Client)
|
|
if !ok {
|
|
panic(fmt.Errorf("failed to type-assert to *Client"))
|
|
}
|
|
return c
|
|
}
|
|
|
|
// ReleaseClient returns c acquired via AcquireClient to client pool.
|
|
//
|
|
// It is forbidden accessing req and/or it's members after returning
|
|
// it to client pool.
|
|
func ReleaseClient(c *Client) {
|
|
c.UserAgent = ""
|
|
c.NoDefaultUserAgentHeader = false
|
|
c.JSONEncoder = nil
|
|
c.JSONDecoder = nil
|
|
|
|
clientPool.Put(c)
|
|
}
|
|
|
|
// AcquireAgent returns an empty Agent instance from Agent pool.
|
|
//
|
|
// The returned Agent instance may be passed to ReleaseAgent when it is
|
|
// no longer needed. This allows Agent recycling, reduces GC pressure
|
|
// and usually improves performance.
|
|
func AcquireAgent() *Agent {
|
|
a, ok := agentPool.Get().(*Agent)
|
|
if !ok {
|
|
panic(fmt.Errorf("failed to type-assert to *Agent"))
|
|
}
|
|
return a
|
|
}
|
|
|
|
// ReleaseAgent returns an acquired via AcquireAgent to Agent pool.
|
|
//
|
|
// It is forbidden accessing req and/or it's members after returning
|
|
// it to Agent pool.
|
|
func ReleaseAgent(a *Agent) {
|
|
a.reset()
|
|
agentPool.Put(a)
|
|
}
|
|
|
|
// AcquireResponse returns an empty Response instance from response pool.
|
|
//
|
|
// The returned Response instance may be passed to ReleaseResponse when it is
|
|
// no longer needed. This allows Response recycling, reduces GC pressure
|
|
// and usually improves performance.
|
|
// Copy from fasthttp
|
|
func AcquireResponse() *Response {
|
|
v := responsePool.Get()
|
|
if v == nil {
|
|
return &Response{}
|
|
}
|
|
r, ok := v.(*Response)
|
|
if !ok {
|
|
panic(fmt.Errorf("failed to type-assert to *Response"))
|
|
}
|
|
return r
|
|
}
|
|
|
|
// ReleaseResponse return resp acquired via AcquireResponse to response pool.
|
|
//
|
|
// It is forbidden accessing resp and/or it's members after returning
|
|
// it to response pool.
|
|
// Copy from fasthttp
|
|
func ReleaseResponse(resp *Response) {
|
|
resp.Reset()
|
|
responsePool.Put(resp)
|
|
}
|
|
|
|
// AcquireArgs returns an empty Args object from the pool.
|
|
//
|
|
// The returned Args may be returned to the pool with ReleaseArgs
|
|
// when no longer needed. This allows reducing GC load.
|
|
// Copy from fasthttp
|
|
func AcquireArgs() *Args {
|
|
v := argsPool.Get()
|
|
if v == nil {
|
|
return &Args{}
|
|
}
|
|
a, ok := v.(*Args)
|
|
if !ok {
|
|
panic(fmt.Errorf("failed to type-assert to *Args"))
|
|
}
|
|
return a
|
|
}
|
|
|
|
// ReleaseArgs returns the object acquired via AcquireArgs to the pool.
|
|
//
|
|
// String not access the released Args object, otherwise data races may occur.
|
|
// Copy from fasthttp
|
|
func ReleaseArgs(a *Args) {
|
|
a.Reset()
|
|
argsPool.Put(a)
|
|
}
|
|
|
|
// AcquireFormFile returns an empty FormFile object from the pool.
|
|
//
|
|
// The returned FormFile may be returned to the pool with ReleaseFormFile
|
|
// when no longer needed. This allows reducing GC load.
|
|
func AcquireFormFile() *FormFile {
|
|
v := formFilePool.Get()
|
|
if v == nil {
|
|
return &FormFile{}
|
|
}
|
|
ff, ok := v.(*FormFile)
|
|
if !ok {
|
|
panic(fmt.Errorf("failed to type-assert to *FormFile"))
|
|
}
|
|
return ff
|
|
}
|
|
|
|
// ReleaseFormFile returns the object acquired via AcquireFormFile to the pool.
|
|
//
|
|
// String not access the released FormFile object, otherwise data races may occur.
|
|
func ReleaseFormFile(ff *FormFile) {
|
|
ff.Fieldname = ""
|
|
ff.Name = ""
|
|
ff.Content = ff.Content[:0]
|
|
ff.autoRelease = false
|
|
|
|
formFilePool.Put(ff)
|
|
}
|
|
|
|
const (
|
|
defaultUserAgent = "fiber"
|
|
)
|
|
|
|
type multipartWriter interface {
|
|
Boundary() string
|
|
SetBoundary(boundary string) error
|
|
CreateFormFile(fieldname, filename string) (io.Writer, error)
|
|
WriteField(fieldname, value string) error
|
|
Close() error
|
|
}
|