X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/bd583d21bb62894a5960b10bf81b375fe6336267..9e27ddfd2f2538ff2216d75c450aa72dd3bc1cf8:/sdk/go/arvadosclient/arvadosclient.go diff --git a/sdk/go/arvadosclient/arvadosclient.go b/sdk/go/arvadosclient/arvadosclient.go index e43162fac7..e3cbfcf13e 100644 --- a/sdk/go/arvadosclient/arvadosclient.go +++ b/sdk/go/arvadosclient/arvadosclient.go @@ -14,6 +14,9 @@ import ( "os" "regexp" "strings" + "time" + + "git.curoverse.com/arvados.git/sdk/go/arvados" ) type StringMatcher func(string) bool @@ -23,6 +26,15 @@ var PDHMatch StringMatcher = regexp.MustCompile(`^[0-9a-f]{32}\+\d+$`).MatchStri var MissingArvadosApiHost = errors.New("Missing required environment variable ARVADOS_API_HOST") var MissingArvadosApiToken = errors.New("Missing required environment variable ARVADOS_API_TOKEN") +var ErrInvalidArgument = errors.New("Invalid argument") + +// A common failure mode is to reuse a keepalive connection that has been +// terminated (in a way that we can't detect) for being idle too long. +// POST and DELETE are not safe to retry automatically, so we minimize +// such failures by always using a new or recently active socket. +var MaxIdleConnectionDuration = 30 * time.Second + +var RetryDelay = 2 * time.Second // Indicates an error that was returned by the API server. type APIServerError struct { @@ -57,6 +69,9 @@ type Dict map[string]interface{} // Information about how to contact the Arvados server type ArvadosClient struct { + // https + Scheme string + // Arvados API server, form "host:port" ApiServer string @@ -73,25 +88,69 @@ type ArvadosClient struct { // the client is outside the cluster. External bool + // Base URIs of Keep services, e.g., {"https://host1:8443", + // "https://host2:8443"}. If this is nil, Keep clients will + // use the arvados.v1.keep_services.accessible API to discover + // available services. + KeepServiceURIs []string + // Discovery document DiscoveryDoc Dict + + lastClosedIdlesAt time.Time + + // Number of retries + Retries int } -// Create a new ArvadosClient, initialized with standard Arvados environment -// variables ARVADOS_API_HOST, ARVADOS_API_TOKEN, and (optionally) -// ARVADOS_API_HOST_INSECURE. +// New returns an ArvadosClient using the given arvados.Client +// configuration. This is useful for callers who load arvados.Client +// fields from configuration files but still need to use the +// arvadosclient.ArvadosClient package. +func New(c *arvados.Client) (*ArvadosClient, error) { + return &ArvadosClient{ + Scheme: "https", + ApiServer: c.APIHost, + ApiToken: c.AuthToken, + ApiInsecure: c.Insecure, + Client: &http.Client{Transport: &http.Transport{ + TLSClientConfig: &tls.Config{InsecureSkipVerify: c.Insecure}}}, + External: false, + Retries: 2, + lastClosedIdlesAt: time.Now(), + }, nil +} + +// MakeArvadosClient creates a new ArvadosClient using the standard +// environment variables ARVADOS_API_HOST, ARVADOS_API_TOKEN, +// ARVADOS_API_HOST_INSECURE, ARVADOS_EXTERNAL_CLIENT, and +// ARVADOS_KEEP_SERVICES. func MakeArvadosClient() (ac ArvadosClient, err error) { var matchTrue = regexp.MustCompile("^(?i:1|yes|true)$") insecure := matchTrue.MatchString(os.Getenv("ARVADOS_API_HOST_INSECURE")) external := matchTrue.MatchString(os.Getenv("ARVADOS_EXTERNAL_CLIENT")) ac = ArvadosClient{ + Scheme: "https", ApiServer: os.Getenv("ARVADOS_API_HOST"), ApiToken: os.Getenv("ARVADOS_API_TOKEN"), ApiInsecure: insecure, Client: &http.Client{Transport: &http.Transport{ TLSClientConfig: &tls.Config{InsecureSkipVerify: insecure}}}, - External: external} + External: external, + Retries: 2} + + for _, s := range strings.Split(os.Getenv("ARVADOS_KEEP_SERVICES"), " ") { + if s == "" { + continue + } + if u, err := url.Parse(s); err != nil { + return ac, fmt.Errorf("ARVADOS_KEEP_SERVICES: %q: %s", s, err) + } else if !u.IsAbs() { + return ac, fmt.Errorf("ARVADOS_KEEP_SERVICES: %q: not an absolute URI", s) + } + ac.KeepServiceURIs = append(ac.KeepServiceURIs, s) + } if ac.ApiServer == "" { return ac, MissingArvadosApiHost @@ -100,16 +159,20 @@ func MakeArvadosClient() (ac ArvadosClient, err error) { return ac, MissingArvadosApiToken } + ac.lastClosedIdlesAt = time.Now() + return ac, err } // CallRaw is the same as Call() but returns a Reader that reads the // response body, instead of taking an output object. func (c ArvadosClient) CallRaw(method string, resourceType string, uuid string, action string, parameters Dict) (reader io.ReadCloser, err error) { - var req *http.Request - + scheme := c.Scheme + if scheme == "" { + scheme = "https" + } u := url.URL{ - Scheme: "https", + Scheme: scheme, Host: c.ApiServer} if resourceType != API_DISCOVERY_RESOURCE { @@ -139,36 +202,73 @@ func (c ArvadosClient) CallRaw(method string, resourceType string, uuid string, } } - if method == "GET" || method == "HEAD" { - u.RawQuery = vals.Encode() - if req, err = http.NewRequest(method, u.String(), nil); err != nil { - return nil, err - } - } else { - if req, err = http.NewRequest(method, u.String(), bytes.NewBufferString(vals.Encode())); err != nil { - return nil, err - } - req.Header.Add("Content-Type", "application/x-www-form-urlencoded") + retryable := false + switch method { + case "GET", "HEAD", "PUT", "OPTIONS", "DELETE": + retryable = true } - // Add api token header - req.Header.Add("Authorization", fmt.Sprintf("OAuth2 %s", c.ApiToken)) - if c.External { - req.Header.Add("X-External-Client", "1") + // Non-retryable methods such as POST are not safe to retry automatically, + // so we minimize such failures by always using a new or recently active socket + if !retryable { + if time.Since(c.lastClosedIdlesAt) > MaxIdleConnectionDuration { + c.lastClosedIdlesAt = time.Now() + c.Client.Transport.(*http.Transport).CloseIdleConnections() + } } // Make the request + var req *http.Request var resp *http.Response - if resp, err = c.Client.Do(req); err != nil { - return nil, err - } - if resp.StatusCode == http.StatusOK { - return resp.Body, nil + for attempt := 0; attempt <= c.Retries; attempt++ { + if method == "GET" || method == "HEAD" { + u.RawQuery = vals.Encode() + if req, err = http.NewRequest(method, u.String(), nil); err != nil { + return nil, err + } + } else { + if req, err = http.NewRequest(method, u.String(), bytes.NewBufferString(vals.Encode())); err != nil { + return nil, err + } + req.Header.Add("Content-Type", "application/x-www-form-urlencoded") + } + + // Add api token header + req.Header.Add("Authorization", fmt.Sprintf("OAuth2 %s", c.ApiToken)) + if c.External { + req.Header.Add("X-External-Client", "1") + } + + resp, err = c.Client.Do(req) + if err != nil { + if retryable { + time.Sleep(RetryDelay) + continue + } else { + return nil, err + } + } + + if resp.StatusCode == http.StatusOK { + return resp.Body, nil + } + + defer resp.Body.Close() + + switch resp.StatusCode { + case 408, 409, 422, 423, 500, 502, 503, 504: + time.Sleep(RetryDelay) + continue + default: + return nil, newAPIServerError(c.ApiServer, resp) + } } - defer resp.Body.Close() - return nil, newAPIServerError(c.ApiServer, resp) + if resp != nil { + return nil, newAPIServerError(c.ApiServer, resp) + } + return nil, err } func newAPIServerError(ServerAddress string, resp *http.Response) APIServerError { @@ -212,7 +312,7 @@ func newAPIServerError(ServerAddress string, resp *http.Response) APIServerError // Returns a non-nil error if an error occurs making the API call, the // API responds with a non-successful HTTP status, or an error occurs // parsing the response body. -func (c ArvadosClient) Call(method string, resourceType string, uuid string, action string, parameters Dict, output interface{}) error { +func (c ArvadosClient) Call(method, resourceType, uuid, action string, parameters Dict, output interface{}) error { reader, err := c.CallRaw(method, resourceType, uuid, action, parameters) if reader != nil { defer reader.Close() @@ -247,16 +347,12 @@ func (c ArvadosClient) Update(resourceType string, uuid string, parameters Dict, // Get a resource. See Call for argument descriptions. func (c ArvadosClient) Get(resourceType string, uuid string, parameters Dict, output interface{}) (err error) { - if uuid == "" { + if !UUIDMatch(uuid) && !(resourceType == "collections" && PDHMatch(uuid)) { // No object has uuid == "": there is no need to make // an API call. Furthermore, the HTTP request for such // an API call would be "GET /arvados/v1/type/", which // is liable to be misinterpreted as the List API. - return APIServerError{ - ServerAddress: c.ApiServer, - HttpStatusCode: http.StatusNotFound, - HttpStatusMessage: "Not Found", - } + return ErrInvalidArgument } return c.Call("GET", resourceType, uuid, "", parameters, output) } @@ -268,7 +364,10 @@ func (c ArvadosClient) List(resource string, parameters Dict, output interface{} const API_DISCOVERY_RESOURCE = "discovery/v1/apis/arvados/v1/rest" -// Discovery returns the value of the given parameter in the discovery document. +// Discovery returns the value of the given parameter in the discovery +// document. Returns a non-nil error if the discovery document cannot +// be retrieved/decoded. Returns ErrInvalidArgument if the requested +// parameter is not found in the discovery document. func (c *ArvadosClient) Discovery(parameter string) (value interface{}, err error) { if len(c.DiscoveryDoc) == 0 { c.DiscoveryDoc = make(Dict) @@ -283,6 +382,6 @@ func (c *ArvadosClient) Discovery(parameter string) (value interface{}, err erro if found { return value, nil } else { - return value, errors.New("Not found") + return value, ErrInvalidArgument } }