-
Notifications
You must be signed in to change notification settings - Fork 24
/
registry.go
210 lines (169 loc) · 4.68 KB
/
registry.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
package rate
import (
"context"
"fmt"
"sync"
"time"
"github.com/Conflux-Chain/confura/util/acl"
"github.com/Conflux-Chain/confura/util/rpc/handlers"
"github.com/Conflux-Chain/go-conflux-util/rate"
"github.com/Conflux-Chain/go-conflux-util/rate/http"
"github.com/pkg/errors"
"github.com/sirupsen/logrus"
)
const (
GCScheduleInterval = 5 * time.Minute
)
type SVipStatus = KeyInfo
// SVipStatusFromContext returns SVIP status from context
func SVipStatusFromContext(ctx context.Context) (*SVipStatus, bool) {
limitKey, ok := handlers.GetAccessTokenFromContext(ctx)
if !ok || len(limitKey) == 0 { // no limit key provided
return nil, false
}
reg, ok := ctx.Value(handlers.CtxKeyRateRegistry).(*Registry)
if !ok || reg == nil {
return nil, false
}
ki, ok := reg.kloader.Load(limitKey)
return ki, ok && ki != nil
}
type Registry struct {
*http.Registry
*aclRegistry
mu sync.Mutex
kloader *KeyLoader
// all available strategies
strategies map[string]*Strategy // strategy name => *Strategy
id2Strategies map[uint32]*Strategy // strategy id => *Strategy
}
func NewRegistry(kloader *KeyLoader, valFactory acl.ValidatorFactory) *Registry {
m := &Registry{
kloader: kloader,
aclRegistry: newAclRegistry(kloader, valFactory),
strategies: make(map[string]*Strategy),
id2Strategies: make(map[uint32]*Strategy),
}
m.Registry = http.NewRegistry(m)
go m.ScheduleGC(GCScheduleInterval)
return m
}
// implements `http.LimiterFactory`
func (r *Registry) GetGroupAndKey(
ctx context.Context,
resource string,
) (group, key string, err error) {
authId, ok := handlers.GetAuthIdFromContext(ctx)
if !ok {
// use default strategy if not authenticated
return r.genDefaultGroupAndKey(ctx, resource)
}
if vip, ok := handlers.VipStatusFromContext(ctx); ok {
// use vip strategy with corresponding tier
return r.genVipGroupAndKey(ctx, resource, authId, vip)
}
if ki, ok := r.kloader.Load(authId); ok && ki != nil {
// use strategy with corresponding key info
return r.genKeyInfoGroupAndKey(ctx, resource, authId, ki)
}
// use default strategy as fallback
return r.genDefaultGroupAndKey(ctx, resource)
}
func (r *Registry) Create(ctx context.Context, resource, group string) (rate.Limiter, error) {
r.mu.Lock()
defer r.mu.Unlock()
stg, ok := r.strategies[group]
if !ok {
return nil, errors.New("strategy not found")
}
opt, ok := stg.LimitOptions[resource]
if !ok {
return nil, errors.New("limit rule not found")
}
return r.createWithOption(opt)
}
func (r *Registry) genDefaultGroupAndKey(
ctx context.Context,
resource string,
) (group, key string, err error) {
r.mu.Lock()
defer r.mu.Unlock()
stg, ok := r.strategies[DefaultStrategy]
if !ok { // no default strategy
logrus.WithField("resource", resource).Info("Default strategy not configured")
return
}
if _, ok := stg.LimitOptions[resource]; !ok {
// limit rule not defined
return
}
ip, _ := handlers.GetIPAddressFromContext(ctx)
key = fmt.Sprintf("ip:%v", ip)
return stg.Name, key, nil
}
func (r *Registry) genVipGroupAndKey(
ctx context.Context,
resource, limitKey string,
vip *handlers.VipStatus,
) (group, key string, err error) {
r.mu.Lock()
defer r.mu.Unlock()
stg, ok := r.getVipStrategy(vip.Tier)
if !ok { // vip strategy not configured
logrus.WithFields(logrus.Fields{
"limitKey": limitKey,
"resource": resource,
"vip": vip,
}).Info("VIP strategy not found")
return
}
if _, ok := stg.LimitOptions[resource]; !ok {
// limit rule not defined
return
}
key = fmt.Sprintf("key:%v", limitKey)
return stg.Name, key, nil
}
func (r *Registry) genKeyInfoGroupAndKey(
ctx context.Context,
resource, limitKey string,
ki *KeyInfo,
) (group, key string, err error) {
r.mu.Lock()
defer r.mu.Unlock()
stg, ok := r.id2Strategies[ki.SID]
if !ok {
logrus.WithFields(logrus.Fields{
"limitKey": limitKey,
"resource": resource,
"keyInfo": ki,
}).Warn("Rate limit strategy not found")
return
}
if _, ok := stg.LimitOptions[resource]; !ok {
// limit rule not defined
return
}
group = stg.Name
switch ki.Type {
case LimitTypeByIp: // limit by key-based IP
ip, _ := handlers.GetIPAddressFromContext(ctx)
key = fmt.Sprintf("key:%v/ip:%v", limitKey, ip)
case LimitTypeByKey: // limit by key only
key = fmt.Sprintf("key:%v", limitKey)
default:
err = errors.New("invalid limit type")
}
return group, key, err
}
func (r *Registry) createWithOption(option interface{}) (l rate.Limiter, err error) {
switch opt := option.(type) {
case FixedWindowOption:
l = rate.NewFixedWindow(opt.Interval, opt.Quota)
case TokenBucketOption:
l = rate.NewTokenBucket(int(opt.Rate), opt.Burst)
default:
err = errors.New("invalid limit option")
}
return l, err
}