File: client.go

package info (click to toggle)
golang-github-cue-lang-cue 0.12.0.-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 19,072 kB
  • sloc: sh: 57; makefile: 17
file content (204 lines) | stat: -rw-r--r-- 5,078 bytes parent folder | download
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
package httplog

import (
	"bytes"
	"context"
	"io"
	"maps"
	"net/http"
	"net/url"
	"slices"
	"strings"
	"sync/atomic"
	"unicode/utf8"
)

// DefaultMaxBodySize holds the maximum body size to include in
// logged requests when [TransportConfig.MaxBodySize] is <=0.
const DefaultMaxBodySize = 1024

// TransportConfig holds configuration for [Transport].
type TransportConfig struct {
	// Logger is used to log the requests. If it is nil,
	// the zero [SlogLogger] will be used.
	Logger Logger

	// Transport is used as the underlying transport for
	// making HTTP requests. If it is nil,
	// [http.DefaultTransport] will be used.
	Transport http.RoundTripper

	// IncludeAllQueryParams causes all URL query parameters to be included
	// rather than redacted using [RedactedURL].
	IncludeAllQueryParams bool

	// MaxBodySize holds the maximum size of body data to include
	// in the logged data. When a body is larger than this, only this
	// amount of body will be included, and the "BodyTruncated"
	// field will be set to true to indicate that this happened.
	//
	// If this is <=0, DefaultMaxBodySize will be used.
	// Use [RedactRequestBody] or [RedactResponseBody]
	// to cause body data to be omitted entirely.
	MaxBodySize int
}

// Transport returns an [http.RoundTripper] implementation that
// logs HTTP requests. If cfg0 is nil, it's equivalent to a pointer
// to a zero-valued [TransportConfig].
func Transport(cfg0 *TransportConfig) http.RoundTripper {
	var cfg TransportConfig
	if cfg0 != nil {
		cfg = *cfg0
	}
	if cfg.Logger == nil {
		cfg.Logger = SlogLogger{}
	}
	if cfg.Transport == nil {
		cfg.Transport = http.DefaultTransport
	}
	if cfg.MaxBodySize <= 0 {
		cfg.MaxBodySize = DefaultMaxBodySize
	}
	return &loggingTransport{
		cfg: cfg,
	}
}

type loggingTransport struct {
	cfg TransportConfig
}

var seq atomic.Int64

func (t *loggingTransport) RoundTrip(req *http.Request) (*http.Response, error) {
	ctx := req.Context()
	id := seq.Add(1)
	var reqURL string
	if t.cfg.IncludeAllQueryParams {
		reqURL = req.URL.String()
	} else {
		reqURL = RedactedURL(ctx, req.URL).String()
	}
	t.cfg.Logger.Log(ctx, KindClientSendRequest, fromHTTPRequest(ctx, id, reqURL, req, true, t.cfg.MaxBodySize))
	resp, err := t.cfg.Transport.RoundTrip(req)
	if err != nil {
		t.cfg.Logger.Log(ctx, KindClientRecvResponse, &Response{
			ID:     id,
			Method: req.Method,
			URL:    reqURL,
			Error:  err.Error(),
		})
		return nil, err
	}
	logResp := &Response{
		ID:         id,
		Method:     req.Method,
		URL:        reqURL,
		Header:     resp.Header,
		StatusCode: resp.StatusCode,
	}
	resp.Body = logResp.BodyData.init(ctx, resp.Body, true, false, t.cfg.MaxBodySize)
	t.cfg.Logger.Log(ctx, KindClientRecvResponse, logResp)
	return resp, nil
}

func fromHTTPRequest(ctx context.Context, id int64, reqURL string, req *http.Request, closeBody bool, maxBodySize int) *Request {
	logReq := &Request{
		ID:            id,
		URL:           reqURL,
		Method:        req.Method,
		Header:        redactAuthorization(req.Header),
		ContentLength: req.ContentLength,
	}
	req.Body = logReq.BodyData.init(ctx, req.Body, closeBody, true, maxBodySize)

	return logReq
}

func redactAuthorization(h http.Header) http.Header {
	auths, ok := h["Authorization"]
	if !ok {
		return h
	}
	h = maps.Clone(h) // shallow copy
	auths = slices.Clone(auths)
	for i, auth := range auths {
		if kind, _, ok := strings.Cut(auth, " "); ok && (kind == "Basic" || kind == "Bearer") {
			auths[i] = kind + " REDACTED"
		} else {
			auths[i] = "REDACTED"
		}
	}
	h["Authorization"] = auths
	return h
}

// init initializes body to contain information about the body data read from r.
// It returns a replacement reader to use instead of r.
func (body *BodyData) init(ctx context.Context, r io.ReadCloser, needClose, isRequest bool, maxBodySize int) io.ReadCloser {
	if r == nil {
		return nil
	}
	if reason := shouldRedactBody(ctx, isRequest); reason != "" {
		body.BodyRedactedBecause = reason
		return r
	}
	data, err := io.ReadAll(io.LimitReader(r, int64(maxBodySize+1)))
	if len(data) > maxBodySize {
		body.BodyTruncated = true
		r = struct {
			io.Reader
			io.Closer
		}{
			Reader: io.MultiReader(
				bytes.NewReader(data),
				r,
			),
			Closer: r,
		}
		data = data[:maxBodySize]
	} else {
		if err != nil {
			body.BodyTruncated = true
		}
		if needClose {
			r.Close()
		}
		r = io.NopCloser(bytes.NewReader(data))
	}
	if utf8.Valid(data) {
		body.Body = string(data)
	} else {
		body.Body64 = data
	}
	return r
}

// RedactedURL returns u with query parameters redacted according
// to [ContextWithAllowedURLQueryParams].
// If there is no allow function associated with the context,
// all query parameters will be redacted.
func RedactedURL(ctx context.Context, u *url.URL) *url.URL {
	if u.RawQuery == "" {
		return u
	}
	qs := u.Query()
	allow := queryParamChecker(ctx)
	changed := false
	for k, v := range qs {
		if allow(k) {
			continue
		}
		changed = true
		for i := range v {
			v[i] = "REDACTED"
		}
	}
	if !changed {
		return u
	}
	r := *u
	r.RawQuery = qs.Encode()
	return &r
}