forked from caicloud/nirvana
-
Notifications
You must be signed in to change notification settings - Fork 0
/
builder.go
335 lines (305 loc) · 9.34 KB
/
builder.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
/*
Copyright 2017 Caicloud Authors
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
package service
import (
"context"
"net/http"
"strings"
"github.com/caicloud/nirvana/definition"
"github.com/caicloud/nirvana/log"
"github.com/caicloud/nirvana/service/router"
)
// Builder builds service.
type Builder interface {
// Logger returns logger of builder.
Logger() log.Logger
// SetLogger sets logger to server.
SetLogger(logger log.Logger)
// Modifier returns modifier of builder.
Modifier() DefinitionModifier
// SetModifier sets definition modifier.
SetModifier(m DefinitionModifier)
// Filters returns all request filters.
Filters() []Filter
// AddFilters add filters to filter requests.
AddFilter(filters ...Filter)
// AddDescriptors adds descriptors to router.
AddDescriptor(descriptors ...definition.Descriptor) error
// Middlewares returns all router middlewares.
Middlewares() map[string][]definition.Middleware
// Definitions returns all definitions. If a modifier exists, it will be executed.
Definitions() map[string][]definition.Definition
// Build builds a service to handle request.
Build() (Service, error)
}
type binding struct {
middlewares []definition.Middleware
definitions []definition.Definition
}
type builder struct {
bindings map[string]*binding
modifier DefinitionModifier
filters []Filter
logger log.Logger
}
// NewBuilder creates a service builder.
func NewBuilder() Builder {
return &builder{
bindings: make(map[string]*binding),
logger: &log.SilentLogger{},
}
}
// Filters returns all request filters.
func (b *builder) Filters() []Filter {
result := make([]Filter, len(b.filters))
copy(result, b.filters)
return result
}
// AddFilters add filters to filter requests.
func (b *builder) AddFilter(filters ...Filter) {
b.filters = append(b.filters, filters...)
}
// Logger returns logger of builder.
func (b *builder) Logger() log.Logger {
return b.logger
}
// SetLogger sets logger to builder.
func (b *builder) SetLogger(logger log.Logger) {
if logger != nil {
b.logger = logger
} else {
b.logger = &log.SilentLogger{}
}
}
// Modifier returns modifier of builder.
func (b *builder) Modifier() DefinitionModifier {
return b.modifier
}
// SetModifier sets definition modifier.
func (b *builder) SetModifier(m DefinitionModifier) {
b.modifier = m
}
// AddDescriptor adds descriptors to router.
func (b *builder) AddDescriptor(descriptors ...definition.Descriptor) error {
for _, descriptor := range descriptors {
b.addDescriptor("", nil, nil, descriptor)
}
return nil
}
func (b *builder) addDescriptor(prefix string, consumes []string, produces []string, descriptor definition.Descriptor) {
path := strings.Join([]string{prefix, strings.Trim(descriptor.Path, "/")}, "/")
if descriptor.Consumes != nil {
consumes = descriptor.Consumes
}
if descriptor.Produces != nil {
produces = descriptor.Produces
}
if len(descriptor.Middlewares) > 0 || len(descriptor.Definitions) > 0 {
bd, ok := b.bindings[path]
if !ok {
bd = &binding{}
b.bindings[path] = bd
}
if len(descriptor.Middlewares) > 0 {
bd.middlewares = append(bd.middlewares, descriptor.Middlewares...)
}
if len(descriptor.Definitions) > 0 {
for _, d := range descriptor.Definitions {
bd.definitions = append(bd.definitions, *b.copyDefinition(&d, consumes, produces))
}
}
}
for _, child := range descriptor.Children {
b.addDescriptor(strings.TrimRight(path, "/"), consumes, produces, child)
}
}
// copyDefinition creates a copy from original definition. Those fields with type interface{} only have shallow copies.
func (b *builder) copyDefinition(d *definition.Definition, consumes []string, produces []string) *definition.Definition {
newOne := &definition.Definition{
Method: d.Method,
Summary: d.Summary,
Function: d.Function,
Description: d.Description,
}
if len(d.Consumes) > 0 {
consumes = d.Consumes
}
newOne.Consumes = make([]string, len(consumes))
copy(newOne.Consumes, consumes)
if len(d.Produces) > 0 {
produces = d.Produces
}
newOne.Produces = make([]string, len(produces))
copy(newOne.Produces, produces)
if len(d.ErrorProduces) > 0 {
produces = d.ErrorProduces
}
newOne.ErrorProduces = make([]string, len(produces))
copy(newOne.ErrorProduces, produces)
newOne.Parameters = make([]definition.Parameter, len(d.Parameters))
for i, p := range d.Parameters {
newParameter := p
newParameter.Operators = make([]definition.Operator, len(p.Operators))
copy(newParameter.Operators, p.Operators)
newOne.Parameters[i] = newParameter
}
newOne.Results = make([]definition.Result, len(d.Results))
for i, r := range d.Results {
newResult := r
newResult.Operators = make([]definition.Operator, len(r.Operators))
copy(newResult.Operators, r.Operators)
newOne.Results[i] = newResult
}
newOne.Examples = make([]definition.Example, len(d.Examples))
copy(newOne.Examples, d.Examples)
return newOne
}
// Middlewares returns all router middlewares.
func (b *builder) Middlewares() map[string][]definition.Middleware {
result := make(map[string][]definition.Middleware)
for path, bd := range b.bindings {
if len(bd.middlewares) > 0 {
middlewares := make([]definition.Middleware, len(bd.middlewares))
copy(middlewares, bd.middlewares)
result[path] = middlewares
}
}
return result
}
// Definitions returns all definitions. If a modifier exists, it will be executed.
// All results are copied from original definitions. Modifications can not affect
// original data.
func (b *builder) Definitions() map[string][]definition.Definition {
result := make(map[string][]definition.Definition)
for path, bd := range b.bindings {
if len(bd.definitions) > 0 {
definitions := make([]definition.Definition, len(bd.definitions))
for i, d := range bd.definitions {
newCopy := b.copyDefinition(&d, nil, nil)
if b.modifier != nil {
b.modifier(newCopy)
}
definitions[i] = *newCopy
}
result[path] = definitions
}
}
return result
}
// Build builds a service to handle request.
func (b *builder) Build() (Service, error) {
if len(b.bindings) <= 0 {
return nil, noRouter.Error()
}
var root router.Router
for path, bd := range b.bindings {
b.logger.V(log.LevelDebug).Infof("Definitions: %d Middlewares: %d Path: %s",
len(bd.definitions), len(bd.middlewares), path)
top, leaf, err := router.Parse(path)
if err != nil {
b.logger.Errorf("Can't parse path: %s, %s", path, err.Error())
return nil, err
}
if len(bd.definitions) > 0 {
// RedirectTrailingSlash would redirect "/somepath/" to "/somepath". Any definition under "/somepath/"
// will never be executed.
if len(path) > 1 && strings.HasSuffix(path, "/") {
b.logger.Warningf("If RedirectTrailingSlash filter is enabled, following %d definition(s) would not be executed", len(bd.definitions))
}
inspector := newInspector(path, b.logger)
for _, d := range bd.definitions {
b.logger.V(log.LevelDebug).Infof(" Method: %s Consumes: %v Produces: %v",
d.Method, d.Consumes, d.Produces)
if b.modifier != nil {
b.modifier(&d)
}
if err := inspector.addDefinition(d); err != nil {
return nil, err
}
}
leaf.SetInspector(inspector)
}
for _, m := range bd.middlewares {
m := m
leaf.AddMiddleware(func(ctx context.Context, chain router.RoutingChain) error {
return m(ctx, chain)
})
}
if root == nil {
root = top
} else if root, err = root.Merge(top); err != nil {
return nil, err
}
}
s := &service{
root: root,
filters: b.filters,
logger: b.logger,
producers: AllProducers(),
}
return s, nil
}
// Service handles HTTP requests.
//
// Workflow:
// Service.ServeHTTP()
// ----------------------
// ↓ ↑
// |-----Filters------| ↑
// ↓ ↑
// |---Router Match---| ↑
// ↓ ↑
// |-------------Middlewares------------|
// ↓ ↑
// |-------------Executor---------------|
// ↓ ↑
// |-ParameterGenerators-|-DestinationHandlers-|
// ↓ ↑
// |------------User Function-----------|
type Service interface {
http.Handler
}
type service struct {
root router.Router
filters []Filter
logger log.Logger
producers []Producer
}
func (s *service) ServeHTTP(resp http.ResponseWriter, req *http.Request) {
for _, f := range s.filters {
if !f(resp, req) {
return
}
}
ctx := newHTTPContext(resp, req)
executor, err := s.root.Match(ctx, &ctx.container, req.URL.Path)
if err != nil {
if err := writeError(ctx, s.producers, err); err != nil {
s.logger.Error(err)
}
return
}
err = executor.Execute(ctx)
if err == nil && ctx.response.HeaderWritable() {
err = invalidService.Error()
}
if err != nil {
if ctx.response.HeaderWritable() {
if err := writeError(ctx, s.producers, err); err != nil {
s.logger.Error(err)
}
} else {
s.logger.Error(err)
}
}
}