# Description
This moves our `internal/{log/util/xslices}` packages out of the gotosocial repo and internal our external `code.superseriousbusiness.org/gopkg` repo. But it maintains an `internal/gtslog` subpkg for initialization of our logging configuration and syslog specifics (which aren't included in the external repo).
## Checklist
- [x] I/we have read the [GoToSocial contribution guidelines](https://codeberg.org/superseriousbusiness/gotosocial/src/branch/main/CONTRIBUTING.md).
- [x] I/we have not used so-called 'AI' to create the proposed changes.
- [x] I/we have discussed the proposed changes already, either in an issue on the repository, or in the Matrix chat.
- [x] I/we have performed a self-review of added code.
- [x] I/we have written code that is legible and maintainable by others.
- [x] I/we have commented the added code, particularly in hard-to-understand areas.
- [ ] I/we have made any necessary changes to documentation.
- [ ] I/we have added tests that cover new code.
- [x] I/we have run tests and they pass locally with the changes.
- [x] I/we have run `go fmt ./...` and `golangci-lint run`.
Reviewed-on: https://codeberg.org/superseriousbusiness/gotosocial/pulls/4610
Co-authored-by: kim <grufwub@gmail.com>
Co-committed-by: kim <grufwub@gmail.com>
86 lines
2.2 KiB
Go
86 lines
2.2 KiB
Go
// GoToSocial
|
|
// Copyright (C) GoToSocial Authors admin@gotosocial.org
|
|
// SPDX-License-Identifier: AGPL-3.0-or-later
|
|
//
|
|
// This program is free software: you can redistribute it and/or modify
|
|
// it under the terms of the GNU Affero General Public License as published by
|
|
// the Free Software Foundation, either version 3 of the License, or
|
|
// (at your option) any later version.
|
|
//
|
|
// This program is distributed in the hope that it will be useful,
|
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
// GNU Affero General Public License for more details.
|
|
//
|
|
// You should have received a copy of the GNU Affero General Public License
|
|
// along with this program. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
package httpclient
|
|
|
|
import (
|
|
"net/http"
|
|
"strconv"
|
|
"time"
|
|
|
|
"code.superseriousbusiness.org/gopkg/log"
|
|
)
|
|
|
|
const (
|
|
// starting backoff duration.
|
|
baseBackoff = 2 * time.Second
|
|
)
|
|
|
|
// Request wraps an HTTP request
|
|
// to add our own retry / backoff.
|
|
type Request struct {
|
|
|
|
// Current backoff dur.
|
|
backoff time.Duration
|
|
|
|
// Delivery attempts.
|
|
attempts uint
|
|
|
|
// log fields.
|
|
log.Entry
|
|
|
|
// underlying request.
|
|
*http.Request
|
|
}
|
|
|
|
// WrapRequest wraps an existing http.Request within
|
|
// our own httpclient.Request with retry / backoff tracking.
|
|
func WrapRequest(r *http.Request) *Request {
|
|
rr := new(Request)
|
|
rr.Request = r
|
|
entry := log.WithContext(r.Context())
|
|
entry = entry.WithField("method", r.Method)
|
|
entry = entry.WithField("url", r.URL.String())
|
|
if r.Body != nil {
|
|
// Only add content-type header if a request body exists.
|
|
entry = entry.WithField("contentType", r.Header.Get("Content-Type"))
|
|
}
|
|
entry = entry.WithField("attempt", uintPtr{&rr.attempts})
|
|
rr.Entry = entry
|
|
return rr
|
|
}
|
|
|
|
// GetBackOff returns the currently set backoff duration,
|
|
// (using a default according to no. attempts if needed).
|
|
func (r *Request) BackOff() time.Duration {
|
|
if r.backoff <= 0 {
|
|
// No backoff dur found, set our predefined
|
|
// backoff according to a multiplier of 2^n.
|
|
r.backoff = baseBackoff * 1 << (r.attempts + 1)
|
|
}
|
|
return r.backoff
|
|
}
|
|
|
|
type uintPtr struct{ u *uint }
|
|
|
|
func (f uintPtr) String() string {
|
|
if f.u == nil {
|
|
return "<nil>"
|
|
}
|
|
return strconv.FormatUint(uint64(*f.u), 10)
|
|
}
|