mirror of
https://github.com/ossf/scorecard.git
synced 2024-09-19 21:18:09 +03:00
81 lines
2.3 KiB
Go
81 lines
2.3 KiB
Go
// Copyright 2020 Security Scorecard 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 roundtripper
|
|
|
|
import (
|
|
"fmt"
|
|
"net/http"
|
|
"strconv"
|
|
"time"
|
|
|
|
"github.com/pkg/errors"
|
|
opencensusstats "go.opencensus.io/stats"
|
|
"go.opencensus.io/tag"
|
|
"go.uber.org/zap"
|
|
|
|
"github.com/ossf/scorecard/stats"
|
|
)
|
|
|
|
func MakeRateLimitedTransport(innerTransport http.RoundTripper, logger *zap.SugaredLogger) http.RoundTripper {
|
|
return &rateLimitTransport{
|
|
logger: logger,
|
|
innerTransport: innerTransport,
|
|
}
|
|
}
|
|
|
|
// rateLimitTransport is a rate-limit aware http.Transport for Github.
|
|
type rateLimitTransport struct {
|
|
logger *zap.SugaredLogger
|
|
innerTransport http.RoundTripper
|
|
}
|
|
|
|
// Roundtrip handles caching and ratelimiting of responses from GitHub.
|
|
func (gh *rateLimitTransport) RoundTrip(r *http.Request) (*http.Response, error) {
|
|
// Reaching here implies we couldn't reply using cache.
|
|
ctx, err := tag.New(r.Context(), tag.Upsert(stats.RequestTag, "actual"))
|
|
if err != nil {
|
|
return nil, fmt.Errorf("error during tag.New: %w", err)
|
|
}
|
|
defer opencensusstats.Record(ctx, stats.HTTPRequests.M(1))
|
|
|
|
r = r.WithContext(ctx)
|
|
resp, err := gh.innerTransport.RoundTrip(r)
|
|
if err != nil {
|
|
return nil, errors.Wrap(err, "error in round trip")
|
|
}
|
|
rateLimit := resp.Header.Get("X-RateLimit-Remaining")
|
|
remaining, err := strconv.Atoi(rateLimit)
|
|
if err != nil {
|
|
return resp, nil
|
|
}
|
|
|
|
if remaining <= 0 {
|
|
reset, err := strconv.Atoi(resp.Header.Get("X-RateLimit-Reset"))
|
|
if err != nil {
|
|
return resp, nil
|
|
}
|
|
|
|
duration := time.Until(time.Unix(int64(reset), 0))
|
|
gh.logger.Warnf("Rate limit exceeded. Waiting %s to retry...", duration)
|
|
|
|
// Retry
|
|
time.Sleep(duration)
|
|
gh.logger.Warnf("Rate limit exceeded. Retrying...")
|
|
return gh.RoundTrip(r)
|
|
}
|
|
|
|
return resp, nil
|
|
}
|