forked from easegress-io/easegress
-
Notifications
You must be signed in to change notification settings - Fork 0
/
pipeline.go
441 lines (371 loc) · 10.6 KB
/
pipeline.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
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
/*
* Copyright (c) 2017, MegaEase
* All rights reserved.
*
* 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
*
* https://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 pipeline provides the pipeline of Easegress.
package pipeline
import (
"fmt"
"strings"
"time"
"github.com/megaease/easegress/v2/pkg/api"
"github.com/megaease/easegress/v2/pkg/context"
"github.com/megaease/easegress/v2/pkg/filters"
"github.com/megaease/easegress/v2/pkg/resilience"
"github.com/megaease/easegress/v2/pkg/supervisor"
"github.com/megaease/easegress/v2/pkg/util/easemonitor"
"github.com/megaease/easegress/v2/pkg/util/fasttime"
"github.com/megaease/easegress/v2/pkg/util/stringtool"
)
const (
// Category is the category of Pipeline.
Category = supervisor.CategoryPipeline
// Kind is the kind of Pipeline.
Kind = "Pipeline"
// BuiltInFilterEnd is the name of the build-in end filter.
BuiltInFilterEnd = "END"
)
func init() {
supervisor.Register(&Pipeline{})
api.RegisterObject(&api.APIResource{
Category: Category,
Kind: Kind,
Name: strings.ToLower(Kind),
Aliases: []string{"pipelines", "pl"},
})
}
func isBuiltInFilter(name string) bool {
return name == BuiltInFilterEnd
}
type (
// Pipeline is Object Pipeline.
Pipeline struct {
superSpec *supervisor.Spec
spec *Spec
filters map[string]filters.Filter
flow []FlowNode
resilience map[string]resilience.Policy
}
// Spec describes the Pipeline.
Spec struct {
Flow []FlowNode `json:"flow,omitempty"`
Filters []map[string]interface{} `json:"filters" jsonschema:"required"`
Resilience []map[string]interface{} `json:"resilience,omitempty"`
Data map[string]interface{} `json:"data,omitempty"`
}
// FlowNode describes one node of the pipeline flow.
FlowNode struct {
FilterName string `json:"filter" jsonschema:"required,format=urlname"`
FilterAlias string `json:"alias,omitempty"`
Namespace string `json:"namespace,omitempty"`
JumpIf map[string]string `json:"jumpIf,omitempty"`
filter filters.Filter
}
// FilterStat records the statistics of a filter.
FilterStat struct {
Name string
Kind string
Result string
Duration time.Duration
}
// Status is the status of Pipeline.
Status struct {
Health string `json:"health"`
Filters map[string]interface{} `json:"filters"`
}
)
func (fn *FlowNode) filterAlias() string {
if fn.FilterAlias != "" {
return fn.FilterAlias
}
return fn.FilterName
}
// ValidateJumpIf validates whether the target of JumpIfs are valid or not.
func (s *Spec) ValidateJumpIf(specs map[string]filters.Spec) {
validTargets := map[string]int{BuiltInFilterEnd: 1}
for i := len(s.Flow) - 1; i >= 0; i-- {
node := &s.Flow[i]
if node.FilterName == BuiltInFilterEnd {
continue
}
spec := specs[node.FilterName]
if spec == nil {
panic(fmt.Errorf("filter %s not found", node.FilterName))
}
results := filters.GetKind(spec.Kind()).Results
for result, target := range node.JumpIf {
if result != "" && !stringtool.StrInSlice(result, results) {
msgFmt := "filter %s: result %s is not in %v"
panic(fmt.Errorf(msgFmt, node.FilterName, result, results))
}
if count := validTargets[target]; count == 0 {
msgFmt := "filter %s: target filter %s not found"
panic(fmt.Errorf(msgFmt, node.FilterName, target))
} else if count > 1 {
panic(fmt.Errorf("duplicated filter name/alias: %s", target))
}
}
validTargets[node.filterAlias()]++
}
}
// Validate validates Spec.
func (s *Spec) Validate() (err error) {
errPrefix := "filters"
defer func() {
if r := recover(); r != nil {
err = fmt.Errorf("%s: %s", errPrefix, r)
}
}()
specs := map[string]filters.Spec{}
// 1: validate filter spec
for _, f := range s.Filters {
// NOTE: Nil supervisor and pipeline are fine in spec validating phrase.
spec, err := filters.NewSpec(nil, "", f)
if err != nil {
panic(err)
}
name := spec.Name()
if isBuiltInFilter(name) {
panic(fmt.Errorf("can't use %s(built-in) for filter name", name))
}
if _, ok := specs[name]; ok {
panic(fmt.Errorf("duplicated filter name %s", name))
}
specs[name] = spec
}
// 2: validate flow
errPrefix = "flow"
s.ValidateJumpIf(specs)
// 3: validate resilience
for _, r := range s.Resilience {
_, err := resilience.NewPolicy(r)
if err != nil {
panic(err)
}
}
return nil
}
func (p *Pipeline) serializeStats(stats []FilterStat) string {
if len(stats) == 0 {
return "pipeline(" + p.superSpec.Name() + "): <empty>"
}
var sb strings.Builder
sb.WriteString("pipeline(")
sb.WriteString(p.superSpec.Name())
sb.WriteString("): ")
for i := range stats {
if i > 0 {
sb.WriteString("->")
}
stat := &stats[i]
sb.WriteString(stat.Name)
sb.WriteByte('(')
if stat.Result != "" {
sb.WriteString(stat.Result)
sb.WriteByte(',')
}
sb.WriteString(stat.Duration.String())
sb.WriteByte(')')
}
return sb.String()
}
// Category returns the category of Pipeline.
func (p *Pipeline) Category() supervisor.ObjectCategory {
return Category
}
// Kind returns the kind of Pipeline.
func (p *Pipeline) Kind() string {
return Kind
}
// DefaultSpec returns the default spec of Pipeline.
func (p *Pipeline) DefaultSpec() interface{} {
return &Spec{}
}
// Init initializes Pipeline.
func (p *Pipeline) Init(superSpec *supervisor.Spec, muxMapper context.MuxMapper) {
p.superSpec, p.spec = superSpec, superSpec.ObjectSpec().(*Spec)
p.reload(nil /*no previous generation*/)
}
// Inherit inherits previous generation of Pipeline.
func (p *Pipeline) Inherit(superSpec *supervisor.Spec, previousGeneration supervisor.Object, muxMapper context.MuxMapper) {
p.superSpec, p.spec = superSpec, superSpec.ObjectSpec().(*Spec)
p.reload(previousGeneration.(*Pipeline))
previousGeneration.Close()
}
func (p *Pipeline) reload(previousGeneration *Pipeline) {
p.filters = make(map[string]filters.Filter)
p.resilience = make(map[string]resilience.Policy)
super := p.superSpec.Super()
pipelineName := p.superSpec.Name()
// create resilience
for _, r := range p.spec.Resilience {
policy, err := resilience.NewPolicy(r)
if err != nil {
panic(err)
}
p.resilience[policy.Name()] = policy
}
// create a flow in case the pipeline spec does not define one.
flow := p.spec.Flow
if len(flow) == 0 {
flow = make([]FlowNode, 0, len(p.spec.Filters))
}
for _, rawSpec := range p.spec.Filters {
// build the filter spec.
spec, err := filters.NewSpec(super, pipelineName, rawSpec)
if err != nil {
panic(err)
}
// create filter instance.
filter := filters.Create(spec)
if filter == nil {
panic(fmt.Errorf("kind %s not found", spec.Kind()))
}
// init or inherit from previous instance.
var prev filters.Filter
if previousGeneration != nil {
prev = previousGeneration.getFilter(spec.Name())
}
if prev == nil {
filter.Init()
} else {
filter.Inherit(prev)
}
if r, ok := filter.(filters.Resiliencer); ok {
r.InjectResiliencePolicy(p.resilience)
}
// add the filter to pipeline, and if the pipeline does not define a
// flow, append it to the flow we just created.
p.filters[spec.Name()] = filter
if len(p.spec.Flow) == 0 {
flow = append(flow, FlowNode{FilterName: spec.Name()})
}
}
p.flow = flow
// bind filter instance to flow node.
for i := range flow {
node := &flow[i]
if node.FilterName != BuiltInFilterEnd {
node.filter = p.filters[node.FilterName]
}
}
}
func (p *Pipeline) getFilter(name string) filters.Filter {
return p.filters[name]
}
// HandleWithBeforeAfter handles the request, with additional flow defined by
// the before/after pipeline.
func (p *Pipeline) HandleWithBeforeAfter(ctx *context.Context, before, after *Pipeline) string {
if len(p.spec.Data) > 0 {
ctx.SetData("PIPELINE", p.spec.Data)
}
result, sawEnd := "", false
flowLen := len(p.flow)
if before != nil {
flowLen += len(before.flow)
}
if after != nil {
flowLen += len(after.flow)
}
stats := make([]FilterStat, 0, flowLen)
if before != nil {
result, stats, sawEnd = p.doHandle(ctx, before.flow, stats)
}
if !sawEnd {
result, stats, sawEnd = p.doHandle(ctx, p.flow, stats)
}
if !sawEnd && after != nil {
result, stats, _ = p.doHandle(ctx, after.flow, stats)
}
ctx.LazyAddTag(func() string {
return p.serializeStats(stats)
})
return result
}
// Handle is the handler to deal with the request.
func (p *Pipeline) Handle(ctx *context.Context) string {
if len(p.spec.Data) > 0 {
ctx.SetData("PIPELINE", p.spec.Data)
}
stats := make([]FilterStat, 0, len(p.flow))
result, stats, _ := p.doHandle(ctx, p.flow, stats)
ctx.LazyAddTag(func() string {
return p.serializeStats(stats)
})
return result
}
func (p *Pipeline) doHandle(ctx *context.Context, flow []FlowNode, stats []FilterStat) (string, []FilterStat, bool) {
result, next, sawEnd := "", "", false
for i := range flow {
node := &flow[i]
alias := node.filterAlias()
if next != "" && next != alias {
continue
}
if node.FilterName == BuiltInFilterEnd {
sawEnd = true
break
}
start := fasttime.Now()
ctx.UseNamespace(node.Namespace)
result = node.filter.Handle(ctx)
stats = append(stats, FilterStat{
Name: alias,
Kind: node.filter.Kind().Name,
Duration: fasttime.Since(start),
Result: result,
})
var ok bool
if next, ok = node.JumpIf[result]; result != "" && !ok {
next = BuiltInFilterEnd
}
if next == BuiltInFilterEnd {
sawEnd = true
break
}
}
return result, stats, sawEnd
}
// Status returns Status generated by Runtime.
func (p *Pipeline) Status() *supervisor.Status {
s := &Status{
Filters: make(map[string]interface{}),
}
for name, filter := range p.filters {
s.Filters[name] = filter.Status()
}
return &supervisor.Status{
ObjectStatus: s,
}
}
// Close closes Pipeline.
func (p *Pipeline) Close() {
for _, filter := range p.filters {
filter.Close()
}
}
// ToMetrics implements easemonitor.Metricer.
func (s *Status) ToMetrics(service string) []*easemonitor.Metrics {
var results []*easemonitor.Metrics
for name, status := range s.Filters {
metricer, ok := status.(easemonitor.Metricer)
if !ok {
continue
}
svc := service + "/" + name
results = append(results, metricer.ToMetrics(svc)...)
}
return results
}