-
Notifications
You must be signed in to change notification settings - Fork 0
/
http_response.go
344 lines (323 loc) · 12 KB
/
http_response.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
package expr
import (
"fmt"
"strings"
"goa.design/goa/eval"
)
const (
StatusContinue = 100 // RFC 7231, 6.2.1
StatusSwitchingProtocols = 101 // RFC 7231, 6.2.2
StatusProcessing = 102 // RFC 2518, 10.1
StatusOK = 200 // RFC 7231, 6.3.1
StatusCreated = 201 // RFC 7231, 6.3.2
StatusAccepted = 202 // RFC 7231, 6.3.3
StatusNonAuthoritativeInfo = 203 // RFC 7231, 6.3.4
StatusNoContent = 204 // RFC 7231, 6.3.5
StatusResetContent = 205 // RFC 7231, 6.3.6
StatusPartialContent = 206 // RFC 7233, 4.1
StatusMultiStatus = 207 // RFC 4918, 11.1
StatusAlreadyReported = 208 // RFC 5842, 7.1
StatusIMUsed = 226 // RFC 3229, 10.4.1
StatusMultipleChoices = 300 // RFC 7231, 6.4.1
StatusMovedPermanently = 301 // RFC 7231, 6.4.2
StatusFound = 302 // RFC 7231, 6.4.3
StatusSeeOther = 303 // RFC 7231, 6.4.4
StatusNotModified = 304 // RFC 7232, 4.1
StatusUseProxy = 305 // RFC 7231, 6.4.5
StatusTemporaryRedirect = 307 // RFC 7231, 6.4.7
StatusPermanentRedirect = 308 // RFC 7538, 3
StatusBadRequest = 400 // RFC 7231, 6.5.1
StatusUnauthorized = 401 // RFC 7235, 3.1
StatusPaymentRequired = 402 // RFC 7231, 6.5.2
StatusForbidden = 403 // RFC 7231, 6.5.3
StatusNotFound = 404 // RFC 7231, 6.5.4
StatusMethodNotAllowed = 405 // RFC 7231, 6.5.5
StatusNotAcceptable = 406 // RFC 7231, 6.5.6
StatusProxyAuthRequired = 407 // RFC 7235, 3.2
StatusRequestTimeout = 408 // RFC 7231, 6.5.7
StatusConflict = 409 // RFC 7231, 6.5.8
StatusGone = 410 // RFC 7231, 6.5.9
StatusLengthRequired = 411 // RFC 7231, 6.5.10
StatusPreconditionFailed = 412 // RFC 7232, 4.2
StatusRequestEntityTooLarge = 413 // RFC 7231, 6.5.11
StatusRequestURITooLong = 414 // RFC 7231, 6.5.12
StatusUnsupportedMediaType = 415 // RFC 7231, 6.5.13
StatusRequestedRangeNotSatisfiable = 416 // RFC 7233, 4.4
StatusExpectationFailed = 417 // RFC 7231, 6.5.14
StatusTeapot = 418 // RFC 7168, 2.3.3
StatusUnprocessableEntity = 422 // RFC 4918, 11.2
StatusLocked = 423 // RFC 4918, 11.3
StatusFailedDependency = 424 // RFC 4918, 11.4
StatusUpgradeRequired = 426 // RFC 7231, 6.5.15
StatusPreconditionRequired = 428 // RFC 6585, 3
StatusTooManyRequests = 429 // RFC 6585, 4
StatusRequestHeaderFieldsTooLarge = 431 // RFC 6585, 5
StatusUnavailableForLegalReasons = 451 // RFC 7725, 3
StatusInternalServerError = 500 // RFC 7231, 6.6.1
StatusNotImplemented = 501 // RFC 7231, 6.6.2
StatusBadGateway = 502 // RFC 7231, 6.6.3
StatusServiceUnavailable = 503 // RFC 7231, 6.6.4
StatusGatewayTimeout = 504 // RFC 7231, 6.6.5
StatusHTTPVersionNotSupported = 505 // RFC 7231, 6.6.6
StatusVariantAlsoNegotiates = 506 // RFC 2295, 8.1
StatusInsufficientStorage = 507 // RFC 4918, 11.5
StatusLoopDetected = 508 // RFC 5842, 7.2
StatusNotExtended = 510 // RFC 2774, 7
StatusNetworkAuthenticationRequired = 511 // RFC 6585, 6
)
type (
// HTTPResponseExpr defines a HTTP response including its status code,
// headers and result type.
HTTPResponseExpr struct {
// HTTP status
StatusCode int
// Response description
Description string
// Headers describe the HTTP response headers.
Headers *MappedAttributeExpr
// Cookies describe the HTTP response cookies.
Cookies *MappedAttributeExpr
// Response body if any
Body *AttributeExpr
// Response Content-Type header value
ContentType string
// Tag the value a field of the result must have for this
// response to be used.
Tag [2]string
// Parent expression, one of EndpointExpr, ServiceExpr or
// RootExpr.
Parent eval.Expression
// Meta is a list of key/value pairs
Meta MetaExpr
}
)
// EvalName returns the generic definition name used in error messages.
func (r *HTTPResponseExpr) EvalName() string {
var suffix string
if r.Parent != nil {
suffix = fmt.Sprintf(" of %s", r.Parent.EvalName())
}
return "HTTP response" + suffix
}
// Prepare makes sure the response is initialized even if not done explicitly
// by
func (r *HTTPResponseExpr) Prepare() {
if r.Headers == nil {
r.Headers = NewEmptyMappedAttributeExpr()
}
if r.Cookies == nil {
r.Cookies = NewEmptyMappedAttributeExpr()
}
}
// Validate checks that the response definition is consistent: its status is set
// and the result type definition if any is valid.
func (r *HTTPResponseExpr) Validate(e *HTTPEndpointExpr) *eval.ValidationErrors {
verr := new(eval.ValidationErrors)
if r.StatusCode == 0 {
verr.Add(r, "HTTP response status not defined")
} else if !bodyAllowedForStatus(r.StatusCode) && !e.MethodExpr.IsStreaming() {
ep, ok := r.Parent.(*HTTPEndpointExpr)
if ok && httpResponseBody(ep, r).Type != Empty {
verr.Add(r, "Response body defined for status code %d which does not allow response body.", r.StatusCode)
}
}
// text/html and text/plain can only encode strings so make sure there isn't
// an explicit conflict with the content-type and response.
if (r.ContentType == "text/html" || r.ContentType == "text/plain") && !e.SkipRequestBodyEncodeDecode {
if e.MethodExpr.Result.Type != nil && e.MethodExpr.Result.Type != String && e.MethodExpr.Result.Type != Bytes && r.Body == nil {
verr.Add(r, fmt.Sprintf("Result type must be String or Bytes when ContentType is '%s'", r.ContentType))
}
if r.Body != nil && r.Body.Type != String && r.Body.Type != Bytes {
verr.Add(r, fmt.Sprintf("Result type must be String or Bytes when ContentType is '%s'", r.ContentType))
}
}
rt, isrt := e.MethodExpr.Result.Type.(*ResultTypeExpr)
resultAttributeType := func(name string) DataType {
if !IsObject(e.MethodExpr.Result.Type) {
return nil
}
if isrt {
if v, ok := e.MethodExpr.Result.Meta["view"]; ok {
v := rt.View(v[0])
if v == nil {
return nil
}
return v.AttributeExpr.Find(name).Type
}
for _, v := range rt.Views {
if !rt.ViewHasAttribute(v.Name, name) {
return nil
}
}
}
att := e.MethodExpr.Result.Find(name)
if att == nil || att.Type == nil {
// nil != nil
return nil
}
return att.Type
}
var inview string
if isrt {
inview = " all views of"
}
if !r.Headers.IsEmpty() {
verr.Merge(r.Headers.Validate("HTTP response headers", r))
if e.MethodExpr.Result.Type == Empty {
verr.Add(r, "response defines headers but result is empty")
} else if IsObject(e.MethodExpr.Result.Type) {
mobj := AsObject(r.Headers.Type)
for _, h := range *mobj {
t := resultAttributeType(h.Name)
if t == nil {
verr.Add(r, "header %q has no equivalent attribute in%s result type, use notation 'attribute_name:header_name' to identify corresponding result type attribute.", h.Name, inview)
}
if IsArray(t) {
if !IsPrimitive(AsArray(t).ElemType.Type) {
verr.Add(e, "attribute %q used in HTTP headers must be a primitive type or an array of primitive types.", h.Name)
}
} else if !IsPrimitive(t) {
verr.Add(e, "attribute %q used in HTTP headers must be a primitive type or an array of primitive types.", h.Name)
}
}
} else if len(*AsObject(r.Headers.Type)) > 1 {
verr.Add(r, "response defines more than one headers but result type is not an object")
} else if IsArray(e.MethodExpr.Result.Type) {
if !IsPrimitive(AsArray(e.MethodExpr.Result.Type).ElemType.Type) {
verr.Add(e, "Array result is mapped to an HTTP header but is not an array of primitive types.")
}
}
}
if !r.Cookies.IsEmpty() {
verr.Merge(r.Cookies.Validate("HTTP response cookies", r))
if e.MethodExpr.Result.Type == Empty {
verr.Add(r, "response defines cookies but result is empty")
} else if IsObject(e.MethodExpr.Result.Type) {
mobj := AsObject(r.Cookies.Type)
for _, c := range *mobj {
t := resultAttributeType(c.Name)
if t == nil {
verr.Add(r, "cookie %q has no equivalent attribute in%s result type, use notation 'attribute_name:cookie_name' to identify corresponding result type attribute.", c.Name, inview)
}
if !IsPrimitive(t) {
verr.Add(e, "attribute %q used in HTTP cookies must be a primitive type.", c.Name)
}
}
} else if len(*AsObject(r.Cookies.Type)) > 1 {
verr.Add(r, "response defines more than one cookies but result type is not an object")
} else if IsArray(e.MethodExpr.Result.Type) {
verr.Add(e, "Array result is mapped to an HTTP cookie.")
}
}
if r.Body != nil {
verr.Merge(r.Body.Validate("HTTP response body", r))
if e.SkipResponseBodyEncodeDecode {
verr.Add(r, "Cannot define a response body when endpoint uses SkipResponseBodyEncodeDecode.")
}
if att, ok := r.Body.Meta["origin:attribute"]; ok {
if resultAttributeType(att[0]) == nil {
verr.Add(r, "body %q has no equivalent attribute in%s result type", att[0], inview)
}
} else if bobj := AsObject(r.Body.Type); bobj != nil {
for _, n := range *bobj {
if resultAttributeType(n.Name) == nil {
verr.Add(r, "body %q has no equivalent attribute in%s result type", n.Name, inview)
}
}
}
} else if e.SkipResponseBodyEncodeDecode {
body := httpResponseBody(e, r)
if body.Type != Empty {
verr.Add(e, "HTTP endpoint response body must be empty when using SkipResponseBodyEncodeDecode. Make sure to define headers and cookies as needed.")
}
}
return verr
}
// Finalize sets the response result type from its type if the type is a result
// type and no result type is already specified.
func (r *HTTPResponseExpr) Finalize(a *HTTPEndpointExpr, svcAtt *AttributeExpr) {
r.Parent = a
if r.Body != nil {
bodyAtt := svcAtt
if o, ok := r.Body.Meta["origin:attribute"]; ok {
bodyAtt = svcAtt.Find(o[0])
}
bodyObj := AsObject(bodyAtt.Type)
if body := AsObject(r.Body.Type); body != nil {
for _, nat := range *body {
n := nat.Name
n = strings.Split(n, ":")[0]
var att, patt *AttributeExpr
var required bool
if bodyObj != nil {
att = bodyObj.Attribute(n)
required = bodyAtt.IsRequired(n)
} else {
att = bodyAtt
required = bodyAtt.Type != Empty
}
initAttrFromDesign(att, patt)
if required {
if r.Body.Validation == nil {
r.Body.Validation = &ValidationExpr{}
}
r.Body.Validation.AddRequired(n)
}
}
// Remember original name for example to generate friendlier OpenAPI specs.
if t, ok := r.Body.Type.(UserType); ok {
t.Attribute().AddMeta("name:original", t.Name())
}
// Wrap object with user type to simplify response rendering code.
r.Body.Type = &UserTypeExpr{
AttributeExpr: DupAtt(r.Body),
TypeName: fmt.Sprintf("%s%sResponseBody", a.Service.Name(), a.Name()),
}
}
if r.Body.Meta == nil {
r.Body.Meta = bodyAtt.Meta
}
}
// Set response content type if empty and if set in the result type
if r.ContentType == "" {
if rt, ok := svcAtt.Type.(*ResultTypeExpr); ok && rt.ContentType != "" {
r.ContentType = rt.ContentType
}
}
initAttr(r.Headers, svcAtt)
initAttr(r.Cookies, svcAtt)
}
// Dup creates a copy of the response expression.
func (r *HTTPResponseExpr) Dup() *HTTPResponseExpr {
res := HTTPResponseExpr{
StatusCode: r.StatusCode,
Description: r.Description,
ContentType: r.ContentType,
Parent: r.Parent,
Meta: r.Meta,
}
if r.Body != nil {
res.Body = DupAtt(r.Body)
}
if r.Headers != nil {
res.Headers = DupMappedAtt(r.Headers)
}
if r.Cookies != nil {
res.Cookies = DupMappedAtt(r.Cookies)
}
return &res
}
// bodyAllowedForStatus reports whether a given response status code
// permits a body. See RFC 2616, section 4.4.
// See https://golang.org/src/net/http/transfer.go
func bodyAllowedForStatus(status int) bool {
switch {
case status >= 100 && status <= 199:
return false
case status == 204:
return false
case status == 304:
return false
}
return true
}