-
Notifications
You must be signed in to change notification settings - Fork 1
/
request.go
312 lines (266 loc) · 8.92 KB
/
request.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
package request
import (
"bytes"
"context"
"encoding/json"
"fmt"
"io/ioutil"
"net/http"
"net/url"
"sync"
"time"
"github.com/gorilla/mux"
log "github.com/sirupsen/logrus"
)
const (
// DefaultBodySize - стандартное ограничение в 1мб для вывода body запроса в logger
DefaultBodySize = 1 << 20
)
type (
metricTotalRequests func(path, method string)
metricDurationResponse func(path, method string, status int, dur time.Duration)
)
var (
logger *log.Logger
callbackRequest metricTotalRequests
callbackResponse metricDurationResponse
metricsWithMethods bool
// Настройки для вывода body в логах
logBody = true
bodyLimit = DefaultBodySize
)
// Request - структура для работы с запросом
type Request struct {
w http.ResponseWriter
r *http.Request
beginTime time.Time
body []byte
route string
ctx *Context
}
// New - функция создает новый запрос
//noinspection GoUnusedExportedFunction
func New(w http.ResponseWriter, r *http.Request) (request *Request) {
if callbackRequest == nil {
callbackRequest = dummyCallbackRequest
}
if callbackResponse == nil {
callbackResponse = dummyCallbackResponse
}
request = &Request{
w: w,
r: r,
beginTime: time.Now(),
}
var err error
if r.Body != nil {
defer r.Body.Close()
if request.body, err = ioutil.ReadAll(r.Body); err != nil {
request.Log().Errorf("Unable to read request body: %s", err)
} else {
r.Body = ioutil.NopCloser(bytes.NewReader(request.body))
}
}
muxRoute := mux.CurrentRoute(r)
if muxRoute != nil {
request.route, _ = muxRoute.GetPathTemplate()
}
// context
request.ctx = NewContext(r.Context())
go callbackRequest(request.route, request.r.Method)
request.Log().Debug("Request")
return
}
// GetURL возвращает URL запроса
func (r *Request) GetURL() *url.URL {
return r.r.URL
}
var initializer sync.Once
// Setup - функция устанавливает логгер и коллбэки
//noinspection ALL
func Setup(
l *log.Logger,
showBodyInLogger bool,
bodyMaxSizeInLogger int,
req metricTotalRequests,
resp metricDurationResponse,
) error {
// мы определеям ошибку по умолчанию
var err error = errInitializedAlready
initializer.Do(func() {
logger = l
logBody = showBodyInLogger
bodyLimit = bodyMaxSizeInLogger
callbackRequest = req
callbackResponse = resp
// зануляем ошибку
err = nil
})
return err
}
// ShowMethodsInMetrics - включает или отключает показ методов в метриках
//noinspection GoUnusedExportedFunction
func ShowMethodsInMetrics(enabled bool) {
metricsWithMethods = enabled
}
// Log - функция возвращает обогащенный logger для запроса
func (r *Request) Log() *log.Entry {
if logger == nil {
logger = log.New()
}
entry := logger.
WithField("method", r.r.Method).
WithField("host", r.r.Host).
WithField("proto", r.r.Proto).
WithField("remote_addr", r.r.RemoteAddr).
WithField("request_uri", r.r.RequestURI).
WithField("route", r.route).
WithField("duration", time.Now().Sub(r.beginTime))
if logBody && r.body != nil && len(r.body) > 0 && len(r.body) < bodyLimit {
entry = entry.WithField("request_body", string(r.body))
}
if reqID := r.ctx.RequestID(); reqID != "" {
entry = entry.WithField("request_id", reqID)
}
if user := r.ctx.SessionUsername(); user != "" {
entry = entry.WithField("username", user)
}
if token := r.ctx.SessionToken(); token != "" {
entry = entry.WithField("token", token)
}
if query := r.Query().Encode(); query != "" {
entry = entry.WithField("query_args", query)
}
if formData := r.r.Form.Encode(); formData != "" {
entry = entry.WithField("form_data", formData)
}
return entry
}
// FinishOK функция завершает запрос удачно с кодом 200
func (r *Request) FinishOK(msg string, args ...interface{}) {
r.Log().
WithField("status", http.StatusOK).
Infof("Response: %s", fmt.Sprintf(msg, args...))
r.finish(http.StatusOK, msg, args...)
}
// FinishBadRequest функция завершает запрос неудачно с кодом 400
func (r *Request) FinishBadRequest(msg string, args ...interface{}) {
r.Log().
WithField("status", http.StatusBadRequest).
Warnf("Response: %s", fmt.Sprintf(msg, args...))
r.finish(http.StatusBadRequest, msg, args...)
}
// FinishError функция завершает запрос неудачно с кодом 500
func (r *Request) FinishError(msg string, args ...interface{}) {
r.Log().
WithField("status", http.StatusInternalServerError).
Errorf("Response: %s", fmt.Sprintf(msg, args...))
r.finish(http.StatusInternalServerError, msg, args...)
}
// FinishOKJSON функция завершает запрос с кодом 200 и объектом для JSON
func (r *Request) FinishOKJSON(i interface{}) {
r.FinishJSON(http.StatusOK, i)
}
// FinishJSON функция завершает запрос с произвольным кодом и объектом для JSON
func (r *Request) FinishJSON(code int, i interface{}) {
data, err := json.Marshal(i)
if err != nil {
r.Log().Errorf("Unable to marshal response data: %s", err)
r.FinishError("Unable to marshal response data: %s", err)
return
}
if r.w.Header().Get("Content-Type") == "" {
r.w.Header().Set("Content-Type", "application/json")
}
r.w.WriteHeader(code)
if _, err := r.w.Write(data); err != nil {
r.Log().Warnf("Unable to write data: %s", err)
return
}
ll := r.Log().
WithField("status", code)
if logBody && len(data) < bodyLimit {
ll = ll.WithField("response_body", string(data))
}
if code < 300 {
ll.Info("Response")
} else if code >= 300 && code < 500 {
ll.Warn("Response")
} else {
ll.Error("Response")
}
go callbackResponse(r.route, r.r.Method, code, time.Since(r.beginTime))
}
// Finish функция завершает запрос с введенным кодом
func (r *Request) Finish(code int, msg string, args ...interface{}) {
r.Log().
WithField("status", code).
Infof("Response: %s", fmt.Sprintf(msg, args...))
r.finish(code, msg, args...)
}
// FinishNoContent функция завершает запрос с кодом 204
func (r *Request) FinishNoContent() {
r.Log().
WithField("status", http.StatusNoContent).
Infof("Response no content")
r.w.WriteHeader(http.StatusNoContent)
go callbackResponse(r.route, r.r.Method, http.StatusNoContent, time.Since(r.beginTime))
}
// FinishFile - функция завершает запрос с указанным кодом,
// передавая данные байты, как файл filename с указанным contentType
func (r *Request) FinishFile(code int, filename, contentType string, data []byte) {
r.w.Header().Add("Content-Disposition", fmt.Sprintf("attachment; filename=%s", filename))
r.w.Header().Add("Content-Type", contentType)
r.w.WriteHeader(code)
if _, err := r.w.Write(data); err != nil {
r.Log().Warnf("Unable to write data as file: %s", err)
return
}
ll := r.Log().
WithField("status", code)
ll.Infof("Response")
go callbackResponse(r.route, r.r.Method, code, time.Since(r.beginTime))
}
// GetVar функция возвращает переменную пути по имени
func (r *Request) GetVar(name string) string {
return mux.Vars(r.r)[name]
}
// GetBody - функция извлекает
func (r *Request) GetBody() []byte {
return r.body
}
// Query - функция возвращает query-параметры
func (r *Request) Query() url.Values {
return r.r.URL.Query()
}
// QueryValue - функция возвращает по имени аргумент запроса
func (r *Request) QueryValue(name string) Value {
return Value(r.Query().Get(name))
}
// VarsValue - функция возвращает по имени переменную пути
func (r *Request) VarsValue(name string) Value {
return Value(r.GetVar(name))
}
func (r *Request) finish(code int, msg string, args ...interface{}) {
r.w.WriteHeader(code)
buf := bytes.NewBufferString(fmt.Sprintf(msg, args...))
r.w.Write(buf.Bytes())
go callbackResponse(r.route, r.r.Method, code, time.Since(r.beginTime))
}
func dummyCallbackRequest(_, _ string) {
}
func dummyCallbackResponse(_, _ string, _ int, _ time.Duration) {
}
// Context - функция возвращает контекст запроса
func (r *Request) Context() *Context {
return r.ctx
}
// SetContext - фукция устанавливает контекст запроса
func (r *Request) SetContext(ctx context.Context) {
r.ctx = NewContext(ctx)
}
// FinishRedirect - функция завершает вызов запроса указанным редиректом
func (r *Request) FinishRedirect(code int, redirect string) {
http.Redirect(r.w, r.r, redirect, code)
go callbackResponse(r.route, r.r.Method, code, time.Since(r.beginTime))
}