Merge branch '10538-trash-delete' closes #10538

[arvados.git] / sdk / go / arvados / client.go

diff --git a/sdk/go/arvados/client.go b/sdk/go/arvados/client.go
index d6d610da91f9d48d90a5dc5d750adb9c681b47a6..fc937494e5a679728aea021dbe80a95231582d72 100644 (file)
--- a/sdk/go/arvados/client.go
+++ b/sdk/go/arvados/client.go
@@ -10,6 +10,8 @@ import (
        "net/http"
        "net/url"
        "os"
+       "strings"
+       "time"
 )
 
 // A Client is an HTTP client with an API endpoint and a set of
@@ -20,8 +22,8 @@ import (
 // of results using List APIs.
 type Client struct {
        // HTTP client used to make requests. If nil,
-       // http.DefaultClient or InsecureHTTPClient will be used.
-       Client *http.Client
+       // DefaultSecureClient or InsecureHTTPClient will be used.
+       Client *http.Client `json:"-"`
 
        // Hostname (or host:port) of Arvados API server.
        APIHost string
@@ -32,6 +34,15 @@ type Client struct {
        // Accept unverified certificates. This works only if the
        // Client field is nil: otherwise, it has no effect.
        Insecure bool
+
+       // Override keep service discovery with a list of base
+       // URIs. (Currently there are no Client methods for
+       // discovering keep services so this is just a convenience for
+       // callers who use a Client to initialize an
+       // arvadosclient.ArvadosClient.)
+       KeepServiceURIs []string `json:",omitempty"`
+
+       dd *DiscoveryDocument
 }
 
 // The default http.Client used by a Client with Insecure==true and
@@ -39,16 +50,26 @@ type Client struct {
 var InsecureHTTPClient = &http.Client{
        Transport: &http.Transport{
                TLSClientConfig: &tls.Config{
-                       InsecureSkipVerify: true}}}
+                       InsecureSkipVerify: true}},
+       Timeout: 5 * time.Minute}
+
+// The default http.Client used by a Client otherwise.
+var DefaultSecureClient = &http.Client{
+       Timeout: 5 * time.Minute}
 
 // NewClientFromEnv creates a new Client that uses the default HTTP
 // client with the API endpoint and credentials given by the
 // ARVADOS_API_* environment variables.
 func NewClientFromEnv() *Client {
+       var svcs []string
+       if s := os.Getenv("ARVADOS_KEEP_SERVICES"); s != "" {
+               svcs = strings.Split(s, " ")
+       }
        return &Client{
-               APIHost:   os.Getenv("ARVADOS_API_HOST"),
-               AuthToken: os.Getenv("ARVADOS_API_TOKEN"),
-               Insecure:  os.Getenv("ARVADOS_API_HOST_INSECURE") != "",
+               APIHost:         os.Getenv("ARVADOS_API_HOST"),
+               AuthToken:       os.Getenv("ARVADOS_API_TOKEN"),
+               Insecure:        os.Getenv("ARVADOS_API_HOST_INSECURE") != "",
+               KeepServiceURIs: svcs,
        }
 }
 
@@ -169,7 +190,7 @@ func (c *Client) httpClient() *http.Client {
        case c.Insecure:
                return InsecureHTTPClient
        default:
-               return http.DefaultClient
+               return DefaultSecureClient
        }
 }
 
@@ -179,14 +200,103 @@ func (c *Client) apiURL(path string) string {
 
 // DiscoveryDocument is the Arvados server's description of itself.
 type DiscoveryDocument struct {
-       DefaultCollectionReplication int   `json:"defaultCollectionReplication"`
-       BlobSignatureTTL             int64 `json:"blobSignatureTtl"`
+       BasePath                     string              `json:"basePath"`
+       DefaultCollectionReplication int                 `json:"defaultCollectionReplication"`
+       BlobSignatureTTL             int64               `json:"blobSignatureTtl"`
+       Schemas                      map[string]Schema   `json:"schemas"`
+       Resources                    map[string]Resource `json:"resources"`
+}
+
+type Resource struct {
+       Methods map[string]ResourceMethod `json:"methods"`
+}
+
+type ResourceMethod struct {
+       HTTPMethod string         `json:"httpMethod"`
+       Path       string         `json:"path"`
+       Response   MethodResponse `json:"response"`
+}
+
+type MethodResponse struct {
+       Ref string `json:"$ref"`
+}
+
+type Schema struct {
+       UUIDPrefix string `json:"uuidPrefix"`
 }
 
 // DiscoveryDocument returns a *DiscoveryDocument. The returned object
 // should not be modified: the same object may be returned by
 // subsequent calls.
 func (c *Client) DiscoveryDocument() (*DiscoveryDocument, error) {
+       if c.dd != nil {
+               return c.dd, nil
+       }
        var dd DiscoveryDocument
-       return &dd, c.RequestAndDecode(&dd, "GET", "discovery/v1/apis/arvados/v1/rest", nil, nil)
+       err := c.RequestAndDecode(&dd, "GET", "discovery/v1/apis/arvados/v1/rest", nil, nil)
+       if err != nil {
+               return nil, err
+       }
+       c.dd = &dd
+       return c.dd, nil
+}
+
+func (c *Client) modelForUUID(dd *DiscoveryDocument, uuid string) (string, error) {
+       if len(uuid) != 27 {
+               return "", fmt.Errorf("invalid UUID: %q", uuid)
+       }
+       infix := uuid[6:11]
+       var model string
+       for m, s := range dd.Schemas {
+               if s.UUIDPrefix == infix {
+                       model = m
+                       break
+               }
+       }
+       if model == "" {
+               return "", fmt.Errorf("unrecognized type portion %q in UUID %q", infix, uuid)
+       }
+       return model, nil
+}
+
+func (c *Client) KindForUUID(uuid string) (string, error) {
+       dd, err := c.DiscoveryDocument()
+       if err != nil {
+               return "", err
+       }
+       model, err := c.modelForUUID(dd, uuid)
+       if err != nil {
+               return "", err
+       }
+       return "arvados#" + strings.ToLower(model[:1]) + model[1:], nil
+}
+
+func (c *Client) PathForUUID(method, uuid string) (string, error) {
+       dd, err := c.DiscoveryDocument()
+       if err != nil {
+               return "", err
+       }
+       model, err := c.modelForUUID(dd, uuid)
+       if err != nil {
+               return "", err
+       }
+       var resource string
+       for r, rsc := range dd.Resources {
+               if rsc.Methods["get"].Response.Ref == model {
+                       resource = r
+                       break
+               }
+       }
+       if resource == "" {
+               return "", fmt.Errorf("no resource for model: %q", model)
+       }
+       m, ok := dd.Resources[resource].Methods[method]
+       if !ok {
+               return "", fmt.Errorf("no method %q for resource %q", method, resource)
+       }
+       path := dd.BasePath + strings.Replace(m.Path, "{uuid}", uuid, -1)
+       if path[0] == '/' {
+               path = path[1:]
+       }
+       return path, nil
 }