refactor(http): implement shared transport and clients (#1288)

* fix(http): flip to a shared transport and clients

* nice threads

* that is terrible

* fake uri for magnet

* lazy locking

* why bother with r's

* flip magic params to struct

* refactor(http-clients): use separate clients with shared transport

* refactor(http-clients): add missing license header

* refactor(http-clients): defer and fix errors

---------

Co-authored-by: ze0s <ze0s@riseup.net>
This commit is contained in:
Kyle Sanderson 2023-12-29 14:49:22 -08:00 committed by GitHub
parent 2a4fb7750b
commit 3234f0d919
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
48 changed files with 537 additions and 391 deletions

View file

@ -15,38 +15,53 @@ import (
"github.com/autobrr/autobrr/internal/domain"
"github.com/autobrr/autobrr/pkg/errors"
"github.com/autobrr/autobrr/pkg/sharedhttp"
"golang.org/x/time/rate"
)
const DefaultURL = "https://gazellegames.net/api.php"
var ErrUnauthorized = errors.New("unauthorized: bad credentials")
var ErrForbidden = errors.New("forbidden")
var ErrTooManyRequests = errors.New("too many requests: rate-limit reached")
type ApiClient interface {
GetTorrentByID(ctx context.Context, torrentID string) (*domain.TorrentBasic, error)
TestAPI(ctx context.Context) (bool, error)
UseURL(url string)
}
type Client struct {
Url string
url string
client *http.Client
Ratelimiter *rate.Limiter
rateLimiter *rate.Limiter
APIKey string
}
func NewClient(apiKey string) ApiClient {
type OptFunc func(*Client)
func WithUrl(url string) OptFunc {
return func(c *Client) {
c.url = url
}
}
func NewClient(apiKey string, opts ...OptFunc) ApiClient {
c := &Client{
Url: "https://gazellegames.net/api.php",
url: DefaultURL,
client: &http.Client{
Timeout: time.Second * 30,
Timeout: time.Second * 30,
Transport: sharedhttp.Transport,
},
Ratelimiter: rate.NewLimiter(rate.Every(5*time.Second), 1), // 5 request every 10 seconds
rateLimiter: rate.NewLimiter(rate.Every(5*time.Second), 1), // 5 request every 10 seconds
APIKey: apiKey,
}
return c
}
for _, opt := range opts {
opt(c)
}
func (c *Client) UseURL(url string) {
c.Url = url
return c
}
type Group struct {
@ -150,13 +165,13 @@ type Response struct {
func (c *Client) Do(req *http.Request) (*http.Response, error) {
ctx := context.Background()
err := c.Ratelimiter.Wait(ctx) // This is a blocking call. Honors the rate limit
err := c.rateLimiter.Wait(ctx) // This is a blocking call. Honors the rate limit
if err != nil {
return nil, errors.Wrap(err, "error waiting for ratelimiter")
}
resp, err := c.client.Do(req)
if err != nil {
return nil, errors.Wrap(err, "error making request")
return resp, errors.Wrap(err, "error making request")
}
return resp, nil
}
@ -172,15 +187,15 @@ func (c *Client) get(ctx context.Context, url string) (*http.Response, error) {
res, err := c.Do(req)
if err != nil {
return nil, errors.Wrap(err, "ggn client request error : %s", url)
return res, errors.Wrap(err, "ggn client request error : %s", url)
}
if res.StatusCode == http.StatusUnauthorized {
return nil, errors.New("unauthorized: bad credentials")
return res, ErrUnauthorized
} else if res.StatusCode == http.StatusForbidden {
return nil, nil
return res, ErrForbidden
} else if res.StatusCode == http.StatusTooManyRequests {
return nil, nil
return res, ErrTooManyRequests
}
return res, nil
@ -197,7 +212,7 @@ func (c *Client) GetTorrentByID(ctx context.Context, torrentID string) (*domain.
v.Add("id", torrentID)
params := v.Encode()
reqUrl := fmt.Sprintf("%s?%s&%s", c.Url, "request=torrent", params)
reqUrl := fmt.Sprintf("%s?%s&%s", c.url, "request=torrent", params)
resp, err := c.get(ctx, reqUrl)
if err != nil {
@ -231,7 +246,7 @@ func (c *Client) GetTorrentByID(ctx context.Context, torrentID string) (*domain.
// TestAPI try api access against torrents page
func (c *Client) TestAPI(ctx context.Context) (bool, error) {
resp, err := c.get(ctx, c.Url)
resp, err := c.get(ctx, c.url)
if err != nil {
return false, errors.Wrap(err, "error getting data")
}

View file

@ -1,6 +1,8 @@
// Copyright (c) 2021 - 2023, Ludvig Lundgren and the autobrr contributors.
// SPDX-License-Identifier: GPL-2.0-or-later
//go:build integration
package ggn
import (
@ -8,13 +10,12 @@ import (
"net/http"
"net/http/httptest"
"os"
"strings"
"testing"
"github.com/autobrr/autobrr/internal/domain"
"github.com/rs/zerolog"
"github.com/stretchr/testify/assert"
"github.com/autobrr/autobrr/internal/domain"
)
func Test_client_GetTorrentByID(t *testing.T) {
@ -32,18 +33,26 @@ func Test_client_GetTorrentByID(t *testing.T) {
return
}
if !strings.Contains(r.RequestURI, "422368") {
jsonPayload, _ := os.ReadFile("testdata/ggn_get_torrent_by_id_not_found.json")
id := r.URL.Query().Get("id")
var jsonPayload []byte
switch id {
case "422368":
jsonPayload, _ = os.ReadFile("testdata/ggn_get_torrent_by_id.json")
w.Header().Set("Content-Type", "application/json")
w.WriteHeader(http.StatusOK)
w.Write(jsonPayload)
return
break
case "100002":
jsonPayload, _ = os.ReadFile("testdata/ggn_get_torrent_by_id_not_found.json")
w.Header().Set("Content-Type", "application/json")
w.WriteHeader(http.StatusOK)
break
}
// read json response
jsonPayload, _ := os.ReadFile("testdata/ggn_get_torrent_by_id.json")
w.Header().Set("Content-Type", "application/json")
w.WriteHeader(http.StatusOK)
//jsonPayload, _ := os.ReadFile("testdata/ggn_get_torrent_by_id.json")
//w.Header().Set("Content-Type", "application/json")
//w.WriteHeader(http.StatusOK)
w.Write(jsonPayload)
}))
defer ts.Close()
@ -77,7 +86,7 @@ func Test_client_GetTorrentByID(t *testing.T) {
wantErr: false,
},
{
name: "get_by_id_2",
name: "get_by_invalid_id",
fields: fields{
Url: ts.URL,
APIKey: key,
@ -89,9 +98,7 @@ func Test_client_GetTorrentByID(t *testing.T) {
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
c := NewClient(tt.fields.APIKey)
c.UseURL(tt.fields.Url)
c := NewClient(tt.fields.APIKey, WithUrl(ts.URL))
got, err := c.GetTorrentByID(context.Background(), tt.args.torrentID)
if tt.wantErr && assert.Error(t, err) {