Method bareDoUntilFound

github/github.go:1280–1319

bareDoUntilFound has the exact same behavior as BareDo but only follows 301s, up to maxRedirects times. If it receives a 302, it will parse the Location header into a *url.URL and return that. This is useful for endpoints that return a 302 in successful cases but still might return 301s for permanen

(req *http.Request, maxRedirects int)

// This is useful for endpoints that return a 302 in successful cases but still might return 301s for
// permanent redirections.
func (c *Client) bareDoUntilFound(req *http.Request, maxRedirects int) (*url.URL, *Response, error) {
	response, err := c.bareDoIgnoreRedirects(req)
	if err != nil {
		var rerr *RedirectionError
		if errors.As(err, &rerr) {
			// If we receive a 302, transform potential relative locations into absolute and return it.
			if rerr.StatusCode == http.StatusFound {
				if rerr.Location == nil {
					return nil, nil, errInvalidLocation
				}
				newURL := c.baseURL.ResolveReference(rerr.Location)
				return newURL, response, nil
			}
			// If permanent redirect response is returned, follow it
			if maxRedirects > 0 && rerr.StatusCode == http.StatusMovedPermanently {
				if rerr.Location == nil {
					return nil, nil, errInvalidLocation
				}
				newURL := c.baseURL.ResolveReference(rerr.Location)
				// Refuse to follow a permanent redirect to a different host:
				// req.Clone preserves Authorization headers added by the auth
				// transport, so a cross-host target would leak credentials.
				if newURL.Host != c.baseURL.Host {
					return nil, response, fmt.Errorf("refusing to follow cross-host redirect from %q to %q", c.baseURL.Host, newURL.Host)
				}
				newRequest := req.Clone(req.Context())
				newRequest.URL = newURL
				return c.bareDoUntilFound(newRequest, maxRedirects-1)
			}
			// If we reached the maximum amount of redirections, return an error
			if maxRedirects <= 0 && rerr.StatusCode == http.StatusMovedPermanently {
				return nil, response, fmt.Errorf("reached the maximum amount of redirections: %w", err)
			}
			return nil, response, fmt.Errorf("unexpected redirection response: %w", err)
		}
	}

	// If we don't receive a redirection, forward the response and potential error
	return nil, response, err
}

// Do sends an API request and returns the API response. The API response is
// JSON decoded and stored in the value pointed to by v, or returned as an