X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/139200027a3192260b5ea7c2d0c93a8eb5f8eb7e..a12864a31d5569c74ed32157d5fe928a1c2563b7:/sdk/go/arvados/client.go

diff --git a/sdk/go/arvados/client.go b/sdk/go/arvados/client.go
index ee830c8c40..fc937494e5 100644
--- a/sdk/go/arvados/client.go
+++ b/sdk/go/arvados/client.go
@@ -6,9 +6,12 @@ import (
 	"fmt"
 	"io"
 	"io/ioutil"
+	"math"
 	"net/http"
 	"net/url"
 	"os"
+	"strings"
+	"time"
 )
 
 // A Client is an HTTP client with an API endpoint and a set of
@@ -19,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
@@ -31,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
@@ -38,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,
 	}
 }
 
@@ -73,7 +95,7 @@ func (c *Client) DoAndDecode(dst interface{}, req *http.Request) error {
 		return err
 	}
 	if resp.StatusCode != 200 {
-		return fmt.Errorf("request failed (%s): %s", req.URL, resp.Status)
+		return newTransactionError(req, resp, buf)
 	}
 	if dst == nil {
 		return nil
@@ -81,6 +103,57 @@ func (c *Client) DoAndDecode(dst interface{}, req *http.Request) error {
 	return json.Unmarshal(buf, dst)
 }
 
+// Convert an arbitrary struct to url.Values. For example,
+//
+//     Foo{Bar: []int{1,2,3}, Baz: "waz"}
+//
+// becomes
+//
+//     url.Values{`bar`:`{"a":[1,2,3]}`,`Baz`:`waz`}
+//
+// params itself is returned if it is already an url.Values.
+func anythingToValues(params interface{}) (url.Values, error) {
+	if v, ok := params.(url.Values); ok {
+		return v, nil
+	}
+	// TODO: Do this more efficiently, possibly using
+	// json.Decode/Encode, so the whole thing doesn't have to get
+	// encoded, decoded, and re-encoded.
+	j, err := json.Marshal(params)
+	if err != nil {
+		return nil, err
+	}
+	var generic map[string]interface{}
+	err = json.Unmarshal(j, &generic)
+	if err != nil {
+		return nil, err
+	}
+	urlValues := url.Values{}
+	for k, v := range generic {
+		if v, ok := v.(string); ok {
+			urlValues.Set(k, v)
+			continue
+		}
+		if v, ok := v.(float64); ok {
+			// Unmarshal decodes all numbers as float64,
+			// which can be written as 1.2345e4 in JSON,
+			// but this form is not accepted for ints in
+			// url params. If a number fits in an int64,
+			// encode it as int64 rather than float64.
+			if v, frac := math.Modf(v); frac == 0 && v <= math.MaxInt64 && v >= math.MinInt64 {
+				urlValues.Set(k, fmt.Sprintf("%d", int64(v)))
+				continue
+			}
+		}
+		j, err := json.Marshal(v)
+		if err != nil {
+			return nil, err
+		}
+		urlValues.Set(k, string(j))
+	}
+	return urlValues, nil
+}
+
 // RequestAndDecode performs an API request and unmarshals the
 // response (which must be JSON) into dst. Method and body arguments
 // are the same as for http.NewRequest(). The given path is added to
@@ -90,38 +163,9 @@ func (c *Client) DoAndDecode(dst interface{}, req *http.Request) error {
 // path must not contain a query string.
 func (c *Client) RequestAndDecode(dst interface{}, method, path string, body io.Reader, params interface{}) error {
 	urlString := c.apiURL(path)
-	var urlValues url.Values
-	if v, ok := params.(url.Values); ok {
-		urlValues = v
-	} else if params != nil {
-		// Convert an arbitrary struct to url.Values. For
-		// example, Foo{Bar: []int{1,2,3}, Baz: "waz"} becomes
-		// url.Values{`bar`:`{"a":[1,2,3]}`,`Baz`:`waz`}
-		//
-		// TODO: Do this more efficiently, possibly using
-		// json.Decode/Encode, so the whole thing doesn't have
-		// to get encoded, decoded, and re-encoded.
-		j, err := json.Marshal(params)
-		if err != nil {
-			return err
-		}
-		var generic map[string]interface{}
-		err = json.Unmarshal(j, &generic)
-		if err != nil {
-			return err
-		}
-		urlValues = url.Values{}
-		for k, v := range generic {
-			if v, ok := v.(string); ok {
-				urlValues.Set(k, v)
-				continue
-			}
-			j, err := json.Marshal(v)
-			if err != nil {
-				return err
-			}
-			urlValues.Set(k, string(j))
-		}
+	urlValues, err := anythingToValues(params)
+	if err != nil {
+		return err
 	}
 	if (method == "GET" || body != nil) && urlValues != nil {
 		// FIXME: what if params don't fit in URL
@@ -146,7 +190,7 @@ func (c *Client) httpClient() *http.Client {
 	case c.Insecure:
 		return InsecureHTTPClient
 	default:
-		return http.DefaultClient
+		return DefaultSecureClient
 	}
 }
 
@@ -156,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
 }