-
Notifications
You must be signed in to change notification settings - Fork 0
/
client.go
669 lines (605 loc) · 19.2 KB
/
client.go
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
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
package http3
import (
"bytes"
"compress/gzip"
"compress/zlib"
"context"
"errors"
"fmt"
"io"
"mime/multipart"
"net/http"
"net/textproto"
"net/url"
"reflect"
"strconv"
"strings"
"time"
"github.com/andybalholm/brotli"
"github.com/dop251/goja"
"github.com/klauspost/compress/zstd"
"go.k6.io/k6/js/common"
k6http "go.k6.io/k6/js/modules/k6/http"
"go.k6.io/k6/lib"
"go.k6.io/k6/lib/netext/httpext"
"go.k6.io/k6/lib/types"
"gopkg.in/guregu/null.v3"
)
// ErrHTTPForbiddenInInitContext is used when a http requests was made in the init context
var ErrHTTPForbiddenInInitContext = common.NewInitContextError("Making http requests in the init context is not supported")
// ErrBatchForbiddenInInitContext is used when batch was made in the init context
var ErrBatchForbiddenInInitContext = common.NewInitContextError("Using batch in the init context is not supported")
type Client struct {
moduleInstance *ModuleInstance
responseCallback func(int) bool
client *http.Client
}
// Request makes an http request of the provided `method` and returns a corresponding response by
// taking goja.Values as arguments
func (c *Client) Request(method string, url goja.Value, args ...goja.Value) (*Response, error) {
state := c.moduleInstance.vu.State()
if state == nil {
return nil, ErrHTTPForbiddenInInitContext
}
body, params := splitRequestArgs(args)
req, err := c.parseRequest(method, url, body, params)
if err != nil {
return c.handleParseRequestError(err)
}
resp, err := c.makeRequest(c.moduleInstance.vu.Context(), state, req)
if err != nil {
return nil, err
}
c.processResponse(resp, req.ResponseType)
return c.responseFromHTTPext(resp), nil
}
// processResponse stores the body as an ArrayBuffer if indicated by
// respType. This is done here instead of in httpext.readResponseBody to avoid
// a reverse dependency on js/common or goja.
func (c *Client) processResponse(resp *httpext.Response, respType httpext.ResponseType) {
if respType == httpext.ResponseTypeBinary && resp.Body != nil {
resp.Body = c.moduleInstance.vu.Runtime().NewArrayBuffer(resp.Body.([]byte))
}
}
func (c *Client) responseFromHTTPext(resp *httpext.Response) *Response {
return &Response{Response: resp, client: c}
}
func (c *Client) makeRequest(ctx context.Context, state *lib.State, preq *httpext.ParsedHTTPRequest) (*httpext.Response, error) {
respReq := &httpext.Request{
Method: preq.Req.Method,
URL: preq.Req.URL.String(),
Cookies: stdCookiesToHTTPRequestCookies(preq.Req.Cookies()),
Headers: preq.Req.Header,
}
if preq.Body != nil {
// TODO: maybe hide this behind of flag in order for this to not happen for big post/puts?
// should we set this after the compression? what will be the point ?
respReq.Body = preq.Body.String()
if len(preq.Compressions) > 0 {
compressedBody, contentEncoding, err := compressBody(preq.Compressions, io.NopCloser(preq.Body))
if err != nil {
return nil, err
}
preq.Body = compressedBody
currentContentEncoding := preq.Req.Header.Get("Content-Encoding")
if currentContentEncoding == "" {
preq.Req.Header.Set("Content-Encoding", contentEncoding)
} else if currentContentEncoding != contentEncoding {
state.Logger.Warningf(
"There's a mismatch between the desired `compression` the manually set `Content-Encoding` header "+
"in the %s request for '%s', the custom header has precedence and won't be overwritten. "+
"This may result in invalid data being sent to the server.", preq.Req.Method, preq.Req.URL,
)
}
}
preq.Req.ContentLength = int64(preq.Body.Len()) // This will make Go set the content-length header
preq.Req.GetBody = func() (io.ReadCloser, error) {
// using `Bytes()` should reuse the same buffer and as such help with the memory usage. We
// should not be writing to it any way so there shouldn't be way to corrupt it (?)
return io.NopCloser(bytes.NewBuffer(preq.Body.Bytes())), nil
}
// as per the documentation using GetBody still requires setting the Body.
preq.Req.Body, _ = preq.Req.GetBody()
}
if contentLengthHeader := preq.Req.Header.Get("Content-Length"); contentLengthHeader != "" {
// The content-length header was set by the user, delete it (since Go
// will set it automatically) and warn if there were differences
preq.Req.Header.Del("Content-Length")
length, err := strconv.Atoi(contentLengthHeader)
if err != nil || preq.Req.ContentLength != int64(length) {
state.Logger.Warnf(
"The specified Content-Length header %q in the %s request for %s "+
"doesn't match the actual request body length of %d, so it will be ignored!",
contentLengthHeader, preq.Req.Method, preq.Req.URL, preq.Req.ContentLength,
)
}
}
resp, err := c.client.Do(preq.Req)
body, err := readResponseBody(c.moduleInstance.vu.State(), preq.ResponseType, resp, err)
if err != nil {
return nil, err
}
httpresp := httpext.NewResponse()
httpresp.Request = respReq
httpresp.Body = body
httpresp.URL = resp.Request.URL.String()
httpresp.Status = resp.StatusCode
httpresp.StatusText = resp.Status
httpresp.Proto = resp.Proto
httpresp.Headers = make(map[string]string, len(resp.Header))
for k, vs := range resp.Header {
httpresp.Headers[k] = strings.Join(vs, ", ")
}
resCookies := resp.Cookies()
httpresp.Cookies = make(map[string][]*httpext.HTTPCookie, len(resCookies))
for _, c := range resCookies {
httpresp.Cookies[c.Name] = append(httpresp.Cookies[c.Name], &httpext.HTTPCookie{
Name: c.Name,
Value: c.Value,
Domain: c.Domain,
Path: c.Path,
HTTPOnly: c.HttpOnly,
Secure: c.Secure,
MaxAge: c.MaxAge,
Expires: c.Expires.UnixNano() / 1000000,
})
}
return httpresp, nil
}
// Matches non-compliant io.Closer implementations (e.g. zstd.Decoder)
type ncloser interface {
Close()
}
type readCloser struct {
io.Reader
}
// Close readers with differing Close() implementations
func (r readCloser) Close() error {
var err error
switch v := r.Reader.(type) {
case io.Closer:
err = v.Close()
case ncloser:
v.Close()
}
return err
}
func readResponseBody(
state *lib.State,
respType httpext.ResponseType,
resp *http.Response,
respErr error,
) (interface{}, error) {
if resp == nil || respErr != nil {
return nil, respErr
}
if respType == httpext.ResponseTypeNone {
_, err := io.Copy(io.Discard, resp.Body)
_ = resp.Body.Close()
if err != nil {
respErr = err
}
return nil, respErr
}
rc := &readCloser{resp.Body}
// Ensure that the entire response body is read and closed, e.g. in case of decoding errors
defer func(respBody io.ReadCloser) {
_, _ = io.Copy(io.Discard, respBody)
_ = respBody.Close()
}(resp.Body)
if (resp.StatusCode >= 100 && resp.StatusCode <= 199) || // 1xx
resp.StatusCode == http.StatusNoContent || resp.StatusCode == http.StatusNotModified {
// for all three of this status code there is always no content
// https://www.rfc-editor.org/rfc/rfc9110.html#section-6.4.1-8
// this also prevents trying to read
return nil, nil //nolint:nilnil
}
contentEncodings := strings.Split(resp.Header.Get("Content-Encoding"), ",")
// Transparently decompress the body if it's has a content-encoding we
// support. If not, simply return it as it is.
for i := len(contentEncodings) - 1; i >= 0; i-- {
contentEncoding := strings.TrimSpace(contentEncodings[i])
if compression, err := httpext.CompressionTypeString(contentEncoding); err == nil {
var decoder io.Reader
var err error
switch compression {
case httpext.CompressionTypeDeflate:
decoder, err = zlib.NewReader(rc)
case httpext.CompressionTypeGzip:
decoder, err = gzip.NewReader(rc)
case httpext.CompressionTypeZstd:
decoder, err = zstd.NewReader(rc)
case httpext.CompressionTypeBr:
decoder = brotli.NewReader(rc)
default:
// We have not implemented a compression ... :(
err = fmt.Errorf(
"unsupported compression type %s - this is a bug in k6, please report it",
compression,
)
}
if err != nil {
return nil, err
}
rc = &readCloser{decoder}
}
}
buf := state.BufferPool.Get()
defer state.BufferPool.Put(buf)
_, err := io.Copy(buf, rc.Reader)
if err != nil {
respErr = err
}
err = rc.Close()
if err != nil && respErr == nil { // Don't overwrite previous errors
respErr = err
}
var result interface{}
// Binary or string
switch respType {
case httpext.ResponseTypeText:
result = buf.String()
case httpext.ResponseTypeBinary:
// Copy the data to a new slice before we return the buffer to the pool,
// because buf.Bytes() points to the underlying buffer byte slice.
// The ArrayBuffer wrapping will be done in the js/modules/k6/http
// package to avoid a reverse dependency, since it depends on goja.
binData := make([]byte, buf.Len())
copy(binData, buf.Bytes())
result = binData
default:
respErr = fmt.Errorf("unknown responseType %s", respType)
}
return result, respErr
}
func splitRequestArgs(args []goja.Value) (body interface{}, params goja.Value) {
if len(args) > 0 {
body = args[0].Export()
}
if len(args) > 1 {
params = args[1]
}
return body, params
}
func (c *Client) handleParseRequestError(err error) (*Response, error) {
state := c.moduleInstance.vu.State()
if state.Options.Throw.Bool {
return nil, err
}
state.Logger.WithField("error", err).Warn("Request Failed")
r := httpext.NewResponse()
r.Error = err.Error()
var k6e httpext.K6Error
if errors.As(err, &k6e) {
r.ErrorCode = int(k6e.Code)
}
return &Response{Response: r, client: c}, nil
}
// TODO: break this function up
//
//nolint:gocyclo, cyclop, funlen, gocognit
func (c *Client) parseRequest(
method string, reqURL, body interface{}, params goja.Value,
) (*httpext.ParsedHTTPRequest, error) {
rt := c.moduleInstance.vu.Runtime()
state := c.moduleInstance.vu.State()
if state == nil {
return nil, ErrHTTPForbiddenInInitContext
}
if urlJSValue, ok := reqURL.(goja.Value); ok {
reqURL = urlJSValue.Export()
}
u, err := httpext.ToURL(reqURL)
if err != nil {
return nil, err
}
result := &httpext.ParsedHTTPRequest{
URL: &u,
Req: &http.Request{
Method: method,
URL: u.GetURL(),
Header: make(http.Header),
},
Timeout: 60 * time.Second,
Throw: state.Options.Throw.Bool,
Redirects: state.Options.MaxRedirects,
Cookies: make(map[string]*httpext.HTTPRequestCookie),
ResponseCallback: c.responseCallback,
TagsAndMeta: c.moduleInstance.vu.State().Tags.GetCurrentValues(),
}
if state.Options.DiscardResponseBodies.Bool {
result.ResponseType = httpext.ResponseTypeNone
} else {
result.ResponseType = httpext.ResponseTypeText
}
formatFormVal := func(v interface{}) string {
// TODO: handle/warn about unsupported/nested values
return fmt.Sprintf("%v", v)
}
handleObjectBody := func(data map[string]interface{}) error {
if !requestContainsFile(data) {
bodyQuery := make(url.Values, len(data))
for k, v := range data {
if arr, ok := v.([]interface{}); ok {
for _, el := range arr {
bodyQuery.Add(k, formatFormVal(el))
}
continue
}
bodyQuery.Set(k, formatFormVal(v))
}
result.Body = bytes.NewBufferString(bodyQuery.Encode())
result.Req.Header.Set("Content-Type", "application/x-www-form-urlencoded")
return nil
}
// handling multipart request
result.Body = &bytes.Buffer{}
mpw := multipart.NewWriter(result.Body)
// For parameters of type common.FileData, created with open(file, "b"),
// we write the file boundary to the body buffer.
// Otherwise parameters are treated as standard form field.
for k, v := range data {
switch ve := v.(type) {
case FileData:
// writing our own part to handle receiving
// different content-type than the default application/octet-stream
h := make(textproto.MIMEHeader)
escapedFilename := escapeQuotes(ve.Filename)
h.Set("Content-Disposition",
fmt.Sprintf(`form-data; name="%s"; filename="%s"`,
k, escapedFilename))
h.Set("Content-Type", ve.ContentType)
// this writer will be closed either by the next part or
// the call to mpw.Close()
fw, err := mpw.CreatePart(h)
if err != nil {
return err
}
if _, err := fw.Write(ve.Data); err != nil {
return err
}
default:
fw, err := mpw.CreateFormField(k)
if err != nil {
return err
}
if _, err := fw.Write([]byte(formatFormVal(v))); err != nil {
return err
}
}
}
if err := mpw.Close(); err != nil {
return err
}
result.Req.Header.Set("Content-Type", mpw.FormDataContentType())
return nil
}
if body != nil {
switch data := body.(type) {
case map[string]goja.Value:
// TODO: fix forms submission and serialization in k6/html before fixing this..
newData := map[string]interface{}{}
for k, v := range data {
newData[k] = v.Export()
}
if err := handleObjectBody(newData); err != nil {
return nil, err
}
case goja.ArrayBuffer:
result.Body = bytes.NewBuffer(data.Bytes())
case map[string]interface{}:
if err := handleObjectBody(data); err != nil {
return nil, err
}
case string:
result.Body = bytes.NewBufferString(data)
case []byte:
result.Body = bytes.NewBuffer(data)
default:
return nil, fmt.Errorf("unknown request body type %T", body)
}
}
result.Req.Header.Set("User-Agent", state.Options.UserAgent.String)
if state.CookieJar != nil {
result.ActiveJar = state.CookieJar
}
// TODO: ditch goja.Value, reflections and Object and use a simple go map and type assertions?
if params != nil && !goja.IsUndefined(params) && !goja.IsNull(params) {
params := params.ToObject(rt)
for _, k := range params.Keys() {
switch k {
case "cookies":
cookiesV := params.Get(k)
if goja.IsUndefined(cookiesV) || goja.IsNull(cookiesV) {
continue
}
cookies := cookiesV.ToObject(rt)
if cookies == nil {
continue
}
for _, key := range cookies.Keys() {
cookieV := cookies.Get(key)
if goja.IsUndefined(cookieV) || goja.IsNull(cookieV) {
continue
}
switch cookieV.ExportType() {
case reflect.TypeOf(map[string]interface{}{}):
result.Cookies[key] = &httpext.HTTPRequestCookie{Name: key, Value: "", Replace: false}
cookie := cookieV.ToObject(rt)
for _, attr := range cookie.Keys() {
switch strings.ToLower(attr) {
case "replace":
result.Cookies[key].Replace = cookie.Get(attr).ToBoolean()
case "value":
result.Cookies[key].Value = cookie.Get(attr).String()
}
}
default:
result.Cookies[key] = &httpext.HTTPRequestCookie{Name: key, Value: cookieV.String(), Replace: false}
}
}
case "headers":
headersV := params.Get(k)
if goja.IsUndefined(headersV) || goja.IsNull(headersV) {
continue
}
headers := headersV.ToObject(rt)
if headers == nil {
continue
}
for _, key := range headers.Keys() {
str := headers.Get(key).String()
if strings.ToLower(key) == "host" {
result.Req.Host = str
}
result.Req.Header.Set(key, str)
}
case "jar":
jarV := params.Get(k)
if goja.IsUndefined(jarV) || goja.IsNull(jarV) {
continue
}
switch v := jarV.Export().(type) {
case *k6http.CookieJar:
result.ActiveJar = v.Jar
}
case "compression":
algosString := strings.TrimSpace(params.Get(k).ToString().String())
if algosString == "" {
continue
}
algos := strings.Split(algosString, ",")
var err error
result.Compressions = make([]httpext.CompressionType, len(algos))
for index, algo := range algos {
algo = strings.TrimSpace(algo)
result.Compressions[index], err = httpext.CompressionTypeString(algo)
if err != nil {
return nil, fmt.Errorf("unknown compression algorithm %s, supported algorithms are %s",
algo, httpext.CompressionTypeValues())
}
}
case "redirects":
result.Redirects = null.IntFrom(params.Get(k).ToInteger())
case "tags":
if err := common.ApplyCustomUserTags(rt, &result.TagsAndMeta, params.Get(k)); err != nil {
return nil, fmt.Errorf("invalid HTTP request metric tags: %w", err)
}
case "auth":
result.Auth = params.Get(k).String()
case "timeout":
t, err := types.GetDurationValue(params.Get(k).Export())
if err != nil {
return nil, fmt.Errorf("invalid timeout value: %w", err)
}
result.Timeout = t
case "throw":
result.Throw = params.Get(k).ToBoolean()
case "responseType":
responseType, err := httpext.ResponseTypeString(params.Get(k).String())
if err != nil {
return nil, err
}
result.ResponseType = responseType
case "responseCallback":
v := params.Get(k).Export()
if v == nil {
result.ResponseCallback = nil
} else if c, ok := v.(*expectedStatuses); ok {
result.ResponseCallback = c.match
} else {
return nil, fmt.Errorf("unsupported responseCallback")
}
}
}
}
if result.ActiveJar != nil {
httpext.SetRequestCookies(result.Req, result.ActiveJar, result.Cookies)
}
return result, nil
}
func requestContainsFile(data map[string]interface{}) bool {
for _, v := range data {
switch v.(type) {
case FileData:
return true
}
}
return false
}
// FileData represents a binary file requiring multipart request encoding
type FileData struct {
Data []byte
Filename string
ContentType string
}
var quoteEscaper = strings.NewReplacer("\\", "\\\\", `"`, "\\\"")
func escapeQuotes(s string) string {
return quoteEscaper.Replace(s)
}
// expectedStatuses is specifically totally unexported so it can't be used for anything else but
// SetResponseCallback and nothing can be done from the js side to modify it or make an instance of
// it except using ExpectedStatuses
type expectedStatuses struct {
minmax [][2]int
exact []int
}
func (e expectedStatuses) match(status int) bool {
for _, v := range e.exact {
if v == status {
return true
}
}
for _, v := range e.minmax {
if v[0] <= status && status <= v[1] {
return true
}
}
return false
}
func stdCookiesToHTTPRequestCookies(cookies []*http.Cookie) map[string][]*httpext.HTTPRequestCookie {
result := make(map[string][]*httpext.HTTPRequestCookie, len(cookies))
for _, cookie := range cookies {
result[cookie.Name] = append(result[cookie.Name],
&httpext.HTTPRequestCookie{Name: cookie.Name, Value: cookie.Value})
}
return result
}
func compressBody(algos []httpext.CompressionType, body io.ReadCloser) (*bytes.Buffer, string, error) {
var contentEncoding string
var prevBuf io.Reader = body
var buf *bytes.Buffer
for _, compressionType := range algos {
if buf != nil {
prevBuf = buf
}
buf = new(bytes.Buffer)
if contentEncoding != "" {
contentEncoding += ", "
}
contentEncoding += compressionType.String()
var w io.WriteCloser
switch compressionType {
case httpext.CompressionTypeGzip:
w = gzip.NewWriter(buf)
case httpext.CompressionTypeDeflate:
w = zlib.NewWriter(buf)
case httpext.CompressionTypeZstd:
w, _ = zstd.NewWriter(buf)
case httpext.CompressionTypeBr:
w = brotli.NewWriter(buf)
default:
return nil, "", fmt.Errorf("unknown compressionType %s", compressionType)
}
// we don't close in defer because zlib will write it's checksum again if it closes twice :(
_, err := io.Copy(w, prevBuf)
if err != nil {
_ = w.Close()
return nil, "", err
}
if err = w.Close(); err != nil {
return nil, "", err
}
}
return buf, contentEncoding, body.Close()
}