-
Notifications
You must be signed in to change notification settings - Fork 5
/
basis_resolving.go
392 lines (335 loc) · 10.8 KB
/
basis_resolving.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
package oas
import (
"fmt"
"net/http"
)
// Resolver resolves operation id from the request.
type Resolver interface {
Resolve(req *http.Request) (string, bool)
}
// NewResolvingBasis returns a new resolving basis.
func NewResolvingBasis(name string, doc *Document) *ResolvingBasis {
b := &ResolvingBasis{
adapter: mustGetAdapter(name),
doc: doc,
strict: true,
}
b.initCache()
return b
}
// A ResolvingBasis provides fundamental oas middleware, which resolve operation
// context from the request using the Resolver.
type ResolvingBasis struct {
adapter Adapter
doc *Document
// internals
cache map[string]operationInfo
// common options for derived middlewares
strict bool
}
func (b *ResolvingBasis) initCache() {
b.cache = make(map[string]operationInfo)
// _ is method
for _, pathOps := range b.doc.Analyzer.Operations() {
// _ is path
for _, operation := range pathOps {
key := operation.ID
value := operationInfo{
operation: operation,
params: b.doc.Analyzer.ParametersFor(operation.ID),
consumes: b.doc.Analyzer.ConsumesFor(operation),
produces: b.doc.Analyzer.ProducesFor(operation),
}
b.cache[key] = value
}
}
}
// OperationRouter returns a new OperationRouter based on the underlying
// adapter. This router is already configured to use basis oas document and
// OperationContext middleware.
func (b *ResolvingBasis) OperationRouter(meta interface{}) OperationRouter {
return b.adapter.
OperationRouter(meta).
WithDocument(b.doc).
WithMiddleware(b.OperationContext())
}
// OperationContext returns a middleware that adds OpenAPI operation context to
// the request.
func (b *ResolvingBasis) OperationContext() Middleware {
return func(next http.Handler) http.Handler {
return &resolvingOperationContext{
oc: &operationContext{
next: next,
},
resolver: b.adapter.Resolver(b.doc),
cache: b.cache,
strict: b.strict,
}
}
}
// resolvingOperationContext is a middleware that resolves operation context
// from the request and adds operation info to the request context.
type resolvingOperationContext struct {
oc *operationContext
resolver Resolver
cache map[string]operationInfo
strict bool
}
func (mw *resolvingOperationContext) ServeHTTP(w http.ResponseWriter, req *http.Request) {
id, ok := mw.resolver.Resolve(req)
if !ok {
if mw.strict {
panic("operation context middleware: cannot resolve operation id from the request")
}
mw.oc.ServeHTTP(w, req, operationInfo{}, false)
return
}
oi, ok := mw.cache[id]
if !ok {
if mw.strict {
panic(fmt.Sprintf("operation context middleware: cannot find operation info by the operation id %q", id))
}
mw.oc.ServeHTTP(w, req, operationInfo{}, false)
return
}
mw.oc.ServeHTTP(w, req, oi, true)
}
// PathParamsContext returns a middleware that provides path parameters
// as request context values. With this middleware, handlers can call
// GetPathParam(req, "foo") to get typed value of path parameter "foo".
func (b *ResolvingBasis) PathParamsContext() Middleware {
ex := b.adapter.PathParamExtractor()
return func(next http.Handler) http.Handler {
return &resolvingPathParamExtractor{
next: &pathParamExtractor{
next: next,
extractor: ex,
},
strict: b.strict,
}
}
}
// resolvingPathParamExtractor is a middleware that resolves operation context
// from the request and enables path parameter extractor middleware.
type resolvingPathParamExtractor struct {
next *pathParamExtractor
// strict enforces validation. If false, then validation is not
// applied to requests without operation context.
strict bool
}
func (mw *resolvingPathParamExtractor) ServeHTTP(w http.ResponseWriter, req *http.Request) {
oi, ok := getOperationInfo(req)
if !ok {
if mw.strict {
panic("path params context middleware: cannot find operation info in the request context")
}
mw.next.ServeHTTP(w, req, nil, false)
return
}
mw.next.ServeHTTP(w, req, oi.params, true)
}
// QueryValidator returns a middleware that validates request query parameters.
func (b *ResolvingBasis) QueryValidator(opts ...MiddlewareOption) Middleware {
options := parseMiddlewareOptions(opts...)
if options.problemHandler == nil {
options.problemHandler = newProblemHandlerErrorResponder()
}
return func(next http.Handler) http.Handler {
return &resolvingQueryValidator{
qv: &queryValidator{
next: next,
problemHandler: options.problemHandler,
continueOnProblem: options.continueOnProblem,
},
strict: b.strict,
}
}
}
// resolvingQueryValidator is a middleware that resolves operation context
// from the request and validates request query.
type resolvingQueryValidator struct {
qv *queryValidator
// strict enforces validation. If false, then validation is not
// applied to requests without operation context.
strict bool
}
func (mw *resolvingQueryValidator) ServeHTTP(w http.ResponseWriter, req *http.Request) {
oi, ok := getOperationInfo(req)
if !ok {
if mw.strict {
panic("query validator middleware: cannot find operation info in the request context")
}
mw.qv.ServeHTTP(w, req, nil, false)
return
}
mw.qv.ServeHTTP(w, req, oi.params, true)
}
// RequestContentTypeValidator returns a middleware that validates
// Content-Type header of the request.
//
// In case of validation error, this middleware will respond with
// either 406 or 415.
func (b *ResolvingBasis) RequestContentTypeValidator(opts ...MiddlewareOption) Middleware {
return func(next http.Handler) http.Handler {
return &resolvingRequestContentTypeValidator{
rctv: &requestContentTypeValidator{
next: next,
},
strict: b.strict,
}
}
}
type resolvingRequestContentTypeValidator struct {
rctv *requestContentTypeValidator
// strict enforces validation. If false, then validation is not
// applied to requests without operation context.
strict bool
}
func (mw *resolvingRequestContentTypeValidator) ServeHTTP(w http.ResponseWriter, req *http.Request) {
oi, ok := getOperationInfo(req)
if !ok {
if mw.strict {
panic("request content type validator middleware: cannot find operation info in the request context")
}
mw.rctv.ServeHTTP(w, req, nil, nil, false)
return
}
mw.rctv.ServeHTTP(w, req, oi.consumes, oi.produces, true)
}
// RequestBodyValidator returns a middleware that validates request body.
func (b *ResolvingBasis) RequestBodyValidator(opts ...MiddlewareOption) Middleware {
options := parseMiddlewareOptions(opts...)
if options.problemHandler == nil {
options.problemHandler = newProblemHandlerErrorResponder()
}
return func(next http.Handler) http.Handler {
return &resolvingRequestBodyValidator{
rbv: &requestBodyValidator{
next: next,
jsonSelectors: options.jsonSelectors,
problemHandler: options.problemHandler,
continueOnProblem: options.continueOnProblem,
},
strict: b.strict,
}
}
}
type resolvingRequestBodyValidator struct {
rbv *requestBodyValidator
// strict enforces validation. If false, then validation is not
// applied to requests without operation context.
strict bool
}
func (mw *resolvingRequestBodyValidator) ServeHTTP(w http.ResponseWriter, req *http.Request) {
oi, ok := getOperationInfo(req)
if !ok {
if mw.strict {
panic("request body validator middleware: cannot find operation info in the request context")
}
mw.rbv.ServeHTTP(w, req, nil, false)
return
}
mw.rbv.ServeHTTP(w, req, oi.params, true)
}
// ResponseContentTypeValidator returns a middleware that validates
// Content-Type header of the response.
func (b *ResolvingBasis) ResponseContentTypeValidator(opts ...MiddlewareOption) Middleware {
options := parseMiddlewareOptions(opts...)
if options.problemHandler == nil {
options.problemHandler = newProblemHandlerWarnLogger("response")
}
return func(next http.Handler) http.Handler {
return &resolvingResponseContentTypeValidator{
rctv: &responseContentTypeValidator{
next: next,
problemHandler: options.problemHandler,
},
strict: b.strict,
}
}
}
type resolvingResponseContentTypeValidator struct {
rctv *responseContentTypeValidator
// strict enforces validation. If false, then validation is not
// applied to requests without operation context.
strict bool
}
func (mw *resolvingResponseContentTypeValidator) ServeHTTP(w http.ResponseWriter, req *http.Request) {
oi, ok := getOperationInfo(req)
if !ok {
if mw.strict {
panic("response content type validator middleware: cannot find operation info in the request context")
}
mw.rctv.ServeHTTP(w, req, nil, false)
return
}
mw.rctv.ServeHTTP(w, req, oi.produces, true)
}
// ResponseBodyValidator returns a middleware that validates response body.
func (b *ResolvingBasis) ResponseBodyValidator(opts ...MiddlewareOption) Middleware {
options := parseMiddlewareOptions(opts...)
if options.problemHandler == nil {
options.problemHandler = newProblemHandlerWarnLogger("response")
}
return func(next http.Handler) http.Handler {
return &resolvingResponseBodyValidator{
rbv: &responseBodyValidator{
next: next,
jsonSelectors: options.jsonSelectors,
problemHandler: options.problemHandler,
},
strict: b.strict,
}
}
}
type resolvingResponseBodyValidator struct {
rbv *responseBodyValidator
// strict enforces validation. If false, then validation is not
// applied to requests without operation context.
strict bool
}
func (mw *resolvingResponseBodyValidator) ServeHTTP(w http.ResponseWriter, req *http.Request) {
oi, ok := getOperationInfo(req)
if !ok {
if mw.strict {
panic("response body validator middleware: cannot find operation info in the request context")
}
mw.rbv.ServeHTTP(w, req, nil, false)
return
}
mw.rbv.ServeHTTP(w, req, oi.operation.Responses, true)
}
// ContextualMiddleware represents a middleware that works based on request
// operation context.
type ContextualMiddleware interface {
ServeHTTP(w http.ResponseWriter, req *http.Request, op *Operation, ok bool)
}
// ContextualMiddleware returns a middleware that can work based on request
// operation context which will be resolved by the basis.
func (b *ResolvingBasis) ContextualMiddleware(m ContextualMiddleware) Middleware {
return func(next http.Handler) http.Handler {
return &resolvingContextualMiddleware{
next: m,
strict: b.strict,
}
}
}
// resolvingContextualMiddleware is a contextual middleware that resolves
// operation context from the request.
type resolvingContextualMiddleware struct {
next ContextualMiddleware
// strict enforces validation. If false, then validation is not
// applied to requests without operation context.
strict bool
}
func (mw *resolvingContextualMiddleware) ServeHTTP(w http.ResponseWriter, req *http.Request) {
oi, ok := getOperationInfo(req)
if !ok {
if mw.strict {
panic("contextual middleware: cannot find operation info in the request context")
}
mw.next.ServeHTTP(w, req, nil, false)
return
}
mw.next.ServeHTTP(w, req, wrapOperation(oi.operation), true)
}