summary refs log tree commit diff
path: root/vendor/go.mau.fi/util/retryafter/retryafter.go
blob: 57ec814d87c4bf31ef5bcc02d7a947acf334487f (plain)
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
// Copyright (c) 2021 Dillon Dixon
// Copyright (c) 2023 Tulir Asokan
//
// This Source Code Form is subject to the terms of the Mozilla Public
// License, v. 2.0. If a copy of the MPL was not distributed with this
// file, You can obtain one at http://mozilla.org/MPL/2.0/.

// Package retryafter contains a utility function for parsing the Retry-After HTTP header.
package retryafter

import (
	"net/http"
	"strconv"
	"time"
)

var now = time.Now

// Parse parses the backoff time specified in the Retry-After header if present.
// See https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Retry-After.
//
// The second parameter is the fallback duration to use if the header is not present or invalid.
//
// Example:
//
//	time.Sleep(retryafter.Parse(resp.Header.Get("Retry-After"), 5*time.Second))
func Parse(retryAfter string, fallback time.Duration) time.Duration {
	if retryAfter == "" {
		return fallback
	} else if t, err := time.Parse(http.TimeFormat, retryAfter); err == nil {
		return t.Sub(now())
	} else if seconds, err := strconv.Atoi(retryAfter); err == nil {
		return time.Duration(seconds) * time.Second
	}

	return fallback
}

// Should returns true if the given status code indicates that the request should be retried.
//
//	if retryafter.Should(resp.StatusCode, true) {
//		time.Sleep(retryafter.Parse(resp.Header.Get("Retry-After"), 5*time.Second))
//	}
func Should(statusCode int, retryOnRateLimit bool) bool {
	switch statusCode {
	case http.StatusBadGateway, http.StatusServiceUnavailable, http.StatusGatewayTimeout:
		return true
	case http.StatusTooManyRequests:
		return retryOnRateLimit
	default:
		return false
	}
}