-
Notifications
You must be signed in to change notification settings - Fork 499
/
api_ratelimit_calc.go
71 lines (62 loc) · 2.2 KB
/
api_ratelimit_calc.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
/*
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
this work for additional information regarding copyright ownership.
The ASF licenses this file to You 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 helper
import (
"github.com/apache/incubator-devlake/errors"
"net/http"
"time"
)
// ApiRateLimitCalculator is A helper to calculate api rate limit dynamically, assuming api returning remaining/resettime information
type ApiRateLimitCalculator struct {
UserRateLimitPerHour int
GlobalRateLimitPerHour int
MaxRetry int
Method string
ApiPath string
DynamicRateLimit func(res *http.Response) (int, time.Duration, errors.Error)
}
// Calculate FIXME ...
func (c *ApiRateLimitCalculator) Calculate(apiClient *ApiClient) (int, time.Duration, errors.Error) {
// user specified rate limit has the highest priority
if c.UserRateLimitPerHour > 0 {
return c.UserRateLimitPerHour, 1 * time.Hour, nil
}
// plugin dynamical rate limit is medium priority
if c.DynamicRateLimit != nil {
method := c.Method
if method == "" {
method = http.MethodOptions
}
var err errors.Error
var res *http.Response
for i := 0; i < c.MaxRetry; i++ {
res, err = apiClient.Do(method, c.ApiPath, nil, nil, nil)
if err != nil {
continue
}
requests, duration, err := c.DynamicRateLimit(res)
if err != nil {
return requests, duration, err
}
if duration == 0 {
return c.GlobalRateLimitPerHour, 1 * time.Hour, nil
}
requests = int(float32(requests) * 0.95)
return requests, duration, err
}
}
// global default rate limit is the lowest
return c.GlobalRateLimitPerHour, 1 * time.Hour, nil
}