X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/e736def390001e01ff6887acbb3c6f08366f6a91..59b22379a693d1fc15b4b77e58e47bac89e62660:/sdk/go/arvadosclient/arvadosclient.go diff --git a/sdk/go/arvadosclient/arvadosclient.go b/sdk/go/arvadosclient/arvadosclient.go index 9bdf54c569..1bc6f80f2c 100644 --- a/sdk/go/arvadosclient/arvadosclient.go +++ b/sdk/go/arvadosclient/arvadosclient.go @@ -14,6 +14,7 @@ import ( "os" "regexp" "strings" + "time" ) type StringMatcher func(string) bool @@ -23,6 +24,10 @@ 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") + +// Before a POST or DELERE request, close any connections that were idle for this long +var MaxIdleConnectionDuration = 30 * time.Second // Indicates an error that was returned by the API server. type APIServerError struct { @@ -75,6 +80,8 @@ type ArvadosClient struct { // Discovery document DiscoveryDoc Dict + + lastClosedIdlesAt time.Time } // Create a new ArvadosClient, initialized with standard Arvados environment @@ -100,33 +107,26 @@ func MakeArvadosClient() (ac ArvadosClient, err error) { return ac, MissingArvadosApiToken } + ac.lastClosedIdlesAt = time.Now() + return ac, err } -// Low-level access to a resource. -// -// method - HTTP method, one of GET, HEAD, PUT, POST or DELETE -// resource - the arvados resource to act on -// uuid - the uuid of the specific item to access (may be empty) -// action - sub-action to take on the resource or uuid (may be empty) -// parameters - method parameters -// -// return -// reader - the body reader, or nil if there was an error -// err - error accessing the resource, or nil if no error -func (this ArvadosClient) CallRaw(method string, resource string, uuid string, action string, parameters Dict) (reader io.ReadCloser, err error) { +// 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 u := url.URL{ Scheme: "https", - Host: this.ApiServer} + Host: c.ApiServer} - if resource != API_DISCOVERY_RESOURCE { + if resourceType != API_DISCOVERY_RESOURCE { u.Path = "/arvados/v1" } - if resource != "" { - u.Path = u.Path + "/" + resource + if resourceType != "" { + u.Path = u.Path + "/" + resourceType } if uuid != "" { u.Path = u.Path + "/" + uuid @@ -161,14 +161,22 @@ func (this ArvadosClient) CallRaw(method string, resource string, uuid string, a } // Add api token header - req.Header.Add("Authorization", fmt.Sprintf("OAuth2 %s", this.ApiToken)) - if this.External { + req.Header.Add("Authorization", fmt.Sprintf("OAuth2 %s", c.ApiToken)) + if c.External { req.Header.Add("X-External-Client", "1") } + // Before a POST or DELETE, close any idle connections + if method == "POST" || method == "DELETE" { + if time.Since(c.lastClosedIdlesAt) > MaxIdleConnectionDuration { + c.lastClosedIdlesAt = time.Now() + c.Client.Transport.(*http.Transport).CloseIdleConnections() + } + } + // Make the request var resp *http.Response - if resp, err = this.Client.Do(req); err != nil { + if resp, err = c.Client.Do(req); err != nil { return nil, err } @@ -177,7 +185,7 @@ func (this ArvadosClient) CallRaw(method string, resource string, uuid string, a } defer resp.Body.Close() - return nil, newAPIServerError(this.ApiServer, resp) + return nil, newAPIServerError(c.ApiServer, resp) } func newAPIServerError(ServerAddress string, resp *http.Response) APIServerError { @@ -209,19 +217,20 @@ func newAPIServerError(ServerAddress string, resp *http.Response) APIServerError return ase } -// Access to a resource. +// Call an API endpoint and parse the JSON response into an object. +// +// method - HTTP method: GET, HEAD, PUT, POST, PATCH or DELETE. +// resourceType - the type of arvados resource to act on (e.g., "collections", "pipeline_instances"). +// uuid - the uuid of the specific item to access. May be empty. +// action - API method name (e.g., "lock"). This is often empty if implied by method and uuid. +// parameters - method parameters. +// output - a map or annotated struct which is a legal target for encoding/json/Decoder. // -// method - HTTP method, one of GET, HEAD, PUT, POST or DELETE -// resource - the arvados resource to act on -// uuid - the uuid of the specific item to access (may be empty) -// action - sub-action to take on the resource or uuid (may be empty) -// parameters - method parameters -// output - a map or annotated struct which is a legal target for encoding/json/Decoder -// return -// err - error accessing the resource, or nil if no error -func (this ArvadosClient) Call(method string, resource string, uuid string, action string, parameters Dict, output interface{}) (err error) { - var reader io.ReadCloser - reader, err = this.CallRaw(method, resource, uuid, action, parameters) +// 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 { + reader, err := c.CallRaw(method, resourceType, uuid, action, parameters) if reader != nil { defer reader.Close() } @@ -238,84 +247,58 @@ func (this ArvadosClient) Call(method string, resource string, uuid string, acti return nil } -// Create a new instance of a resource. -// -// resource - the arvados resource on which to create an item -// parameters - method parameters -// output - a map or annotated struct which is a legal target for encoding/json/Decoder -// return -// err - error accessing the resource, or nil if no error -func (this ArvadosClient) Create(resource string, parameters Dict, output interface{}) (err error) { - return this.Call("POST", resource, "", "", parameters, output) +// Create a new resource. See Call for argument descriptions. +func (c ArvadosClient) Create(resourceType string, parameters Dict, output interface{}) error { + return c.Call("POST", resourceType, "", "", parameters, output) } -// Delete an instance of a resource. -// -// resource - the arvados resource on which to delete an item -// uuid - the item to delete -// parameters - method parameters -// output - a map or annotated struct which is a legal target for encoding/json/Decoder -// return -// err - error accessing the resource, or nil if no error -func (this ArvadosClient) Delete(resource string, uuid string, parameters Dict, output interface{}) (err error) { - return this.Call("DELETE", resource, uuid, "", parameters, output) +// Delete a resource. See Call for argument descriptions. +func (c ArvadosClient) Delete(resource string, uuid string, parameters Dict, output interface{}) (err error) { + return c.Call("DELETE", resource, uuid, "", parameters, output) } -// Update fields of an instance of a resource. -// -// resource - the arvados resource on which to update the item -// uuid - the item to update -// parameters - method parameters -// output - a map or annotated struct which is a legal target for encoding/json/Decoder -// return -// err - error accessing the resource, or nil if no error -func (this ArvadosClient) Update(resource string, uuid string, parameters Dict, output interface{}) (err error) { - return this.Call("PUT", resource, uuid, "", parameters, output) +// Modify attributes of a resource. See Call for argument descriptions. +func (c ArvadosClient) Update(resourceType string, uuid string, parameters Dict, output interface{}) (err error) { + return c.Call("PUT", resourceType, uuid, "", parameters, output) } -// Get a resource. -func (c ArvadosClient) Get(resource string, uuid string, parameters Dict, output interface{}) (err error) { - if uuid == "" { - // There's no endpoint for that because GET /type/ is - // the List API. If there were an endpoint, the - // response would be 404: no object has uuid == "". - return APIServerError{ - ServerAddress: c.ApiServer, - HttpStatusCode: 404, - HttpStatusMessage: "Not Found", - } +// Get a resource. See Call for argument descriptions. +func (c ArvadosClient) Get(resourceType string, uuid string, parameters Dict, output interface{}) (err error) { + 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 ErrInvalidArgument } - return c.Call("GET", resource, uuid, "", parameters, output) + return c.Call("GET", resourceType, uuid, "", parameters, output) } -// List the instances of a resource -// -// resource - the arvados resource on which to list -// parameters - method parameters -// output - a map or annotated struct which is a legal target for encoding/json/Decoder -// return -// err - error accessing the resource, or nil if no error -func (this ArvadosClient) List(resource string, parameters Dict, output interface{}) (err error) { - return this.Call("GET", resource, "", "", parameters, output) +// List resources of a given type. See Call for argument descriptions. +func (c ArvadosClient) List(resource string, parameters Dict, output interface{}) (err error) { + return c.Call("GET", resource, "", "", parameters, output) } const API_DISCOVERY_RESOURCE = "discovery/v1/apis/arvados/v1/rest" -// Discovery returns the value of the given parameter in the discovery document. -func (this *ArvadosClient) Discovery(parameter string) (value interface{}, err error) { - if len(this.DiscoveryDoc) == 0 { - this.DiscoveryDoc = make(Dict) - err = this.Call("GET", API_DISCOVERY_RESOURCE, "", "", nil, &this.DiscoveryDoc) +// 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) + err = c.Call("GET", API_DISCOVERY_RESOURCE, "", "", nil, &c.DiscoveryDoc) if err != nil { return nil, err } } var found bool - value, found = this.DiscoveryDoc[parameter] + value, found = c.DiscoveryDoc[parameter] if found { return value, nil } else { - return value, errors.New("Not found") + return value, ErrInvalidArgument } }