sdk/go/arvados/client.go

   1 // Copyright (C) The Arvados Authors. All rights reserved.
   2 //
   3 // SPDX-License-Identifier: Apache-2.0
   4
   5 package arvados
   6
   7 import (
   8         "bytes"
   9         "context"
  10         "crypto/tls"
  11         "encoding/json"
  12         "fmt"
  13         "io"
  14         "io/ioutil"
  15         "log"
  16         "net/http"
  17         "net/url"
  18         "os"
  19         "regexp"
  20         "strings"
  21         "time"
  22
  23         "git.curoverse.com/arvados.git/sdk/go/httpserver"
  24 )
  25
  26 // A Client is an HTTP client with an API endpoint and a set of
  27 // Arvados credentials.
  28 //
  29 // It offers methods for accessing individual Arvados APIs, and
  30 // methods that implement common patterns like fetching multiple pages
  31 // of results using List APIs.
  32 type Client struct {
  33         // HTTP client used to make requests. If nil,
  34         // DefaultSecureClient or InsecureHTTPClient will be used.
  35         Client *http.Client `json:"-"`
  36
  37         // Protocol scheme: "http", "https", or "" (https)
  38         Scheme string
  39
  40         // Hostname (or host:port) of Arvados API server.
  41         APIHost string
  42
  43         // User authentication token.
  44         AuthToken string
  45
  46         // Accept unverified certificates. This works only if the
  47         // Client field is nil: otherwise, it has no effect.
  48         Insecure bool
  49
  50         // Override keep service discovery with a list of base
  51         // URIs. (Currently there are no Client methods for
  52         // discovering keep services so this is just a convenience for
  53         // callers who use a Client to initialize an
  54         // arvadosclient.ArvadosClient.)
  55         KeepServiceURIs []string `json:",omitempty"`
  56
  57         dd *DiscoveryDocument
  58
  59         ctx context.Context
  60 }
  61
  62 // The default http.Client used by a Client with Insecure==true and
  63 // Client==nil.
  64 var InsecureHTTPClient = &http.Client{
  65         Transport: &http.Transport{
  66                 TLSClientConfig: &tls.Config{
  67                         InsecureSkipVerify: true}},
  68         Timeout: 5 * time.Minute}
  69
  70 // The default http.Client used by a Client otherwise.
  71 var DefaultSecureClient = &http.Client{
  72         Timeout: 5 * time.Minute}
  73
  74 // NewClientFromConfig creates a new Client that uses the endpoints in
  75 // the given cluster.
  76 //
  77 // AuthToken is left empty for the caller to populate.
  78 func NewClientFromConfig(cluster *Cluster) (*Client, error) {
  79         ctrlURL := cluster.Services.Controller.ExternalURL
  80         if ctrlURL.Host == "" {
  81                 return nil, fmt.Errorf("no host in config Services.Controller.ExternalURL: %v", ctrlURL)
  82         }
  83         return &Client{
  84                 Scheme:   ctrlURL.Scheme,
  85                 APIHost:  ctrlURL.Host,
  86                 Insecure: cluster.TLS.Insecure,
  87         }, nil
  88 }
  89
  90 // NewClientFromEnv creates a new Client that uses the default HTTP
  91 // client with the API endpoint and credentials given by the
  92 // ARVADOS_API_* environment variables.
  93 func NewClientFromEnv() *Client {
  94         var svcs []string
  95         for _, s := range strings.Split(os.Getenv("ARVADOS_KEEP_SERVICES"), " ") {
  96                 if s == "" {
  97                         continue
  98                 } else if u, err := url.Parse(s); err != nil {
  99                         log.Printf("ARVADOS_KEEP_SERVICES: %q: %s", s, err)
 100                 } else if !u.IsAbs() {
 101                         log.Printf("ARVADOS_KEEP_SERVICES: %q: not an absolute URI", s)
 102                 } else {
 103                         svcs = append(svcs, s)
 104                 }
 105         }
 106         var insecure bool
 107         if s := strings.ToLower(os.Getenv("ARVADOS_API_HOST_INSECURE")); s == "1" || s == "yes" || s == "true" {
 108                 insecure = true
 109         }
 110         return &Client{
 111                 Scheme:          "https",
 112                 APIHost:         os.Getenv("ARVADOS_API_HOST"),
 113                 AuthToken:       os.Getenv("ARVADOS_API_TOKEN"),
 114                 Insecure:        insecure,
 115                 KeepServiceURIs: svcs,
 116         }
 117 }
 118
 119 var reqIDGen = httpserver.IDGenerator{Prefix: "req-"}
 120
 121 // Do adds Authorization and X-Request-Id headers and then calls
 122 // (*http.Client)Do().
 123 func (c *Client) Do(req *http.Request) (*http.Response, error) {
 124         if auth, _ := req.Context().Value(contextKeyAuthorization{}).(string); auth != "" {
 125                 req.Header.Add("Authorization", auth)
 126         } else if c.AuthToken != "" {
 127                 req.Header.Add("Authorization", "OAuth2 "+c.AuthToken)
 128         }
 129
 130         if req.Header.Get("X-Request-Id") == "" {
 131                 reqid, _ := req.Context().Value(contextKeyRequestID{}).(string)
 132                 if reqid == "" {
 133                         reqid, _ = c.context().Value(contextKeyRequestID{}).(string)
 134                 }
 135                 if reqid == "" {
 136                         reqid = reqIDGen.Next()
 137                 }
 138                 if req.Header == nil {
 139                         req.Header = http.Header{"X-Request-Id": {reqid}}
 140                 } else {
 141                         req.Header.Set("X-Request-Id", reqid)
 142                 }
 143         }
 144         return c.httpClient().Do(req)
 145 }
 146
 147 // DoAndDecode performs req and unmarshals the response (which must be
 148 // JSON) into dst. Use this instead of RequestAndDecode if you need
 149 // more control of the http.Request object.
 150 func (c *Client) DoAndDecode(dst interface{}, req *http.Request) error {
 151         resp, err := c.Do(req)
 152         if err != nil {
 153                 return err
 154         }
 155         defer resp.Body.Close()
 156         buf, err := ioutil.ReadAll(resp.Body)
 157         if err != nil {
 158                 return err
 159         }
 160         if resp.StatusCode != 200 {
 161                 return newTransactionError(req, resp, buf)
 162         }
 163         if dst == nil {
 164                 return nil
 165         }
 166         return json.Unmarshal(buf, dst)
 167 }
 168
 169 // Convert an arbitrary struct to url.Values. For example,
 170 //
 171 //     Foo{Bar: []int{1,2,3}, Baz: "waz"}
 172 //
 173 // becomes
 174 //
 175 //     url.Values{`bar`:`{"a":[1,2,3]}`,`Baz`:`waz`}
 176 //
 177 // params itself is returned if it is already an url.Values.
 178 func anythingToValues(params interface{}) (url.Values, error) {
 179         if v, ok := params.(url.Values); ok {
 180                 return v, nil
 181         }
 182         // TODO: Do this more efficiently, possibly using
 183         // json.Decode/Encode, so the whole thing doesn't have to get
 184         // encoded, decoded, and re-encoded.
 185         j, err := json.Marshal(params)
 186         if err != nil {
 187                 return nil, err
 188         }
 189         var generic map[string]interface{}
 190         dec := json.NewDecoder(bytes.NewBuffer(j))
 191         dec.UseNumber()
 192         err = dec.Decode(&generic)
 193         if err != nil {
 194                 return nil, err
 195         }
 196         urlValues := url.Values{}
 197         for k, v := range generic {
 198                 if v, ok := v.(string); ok {
 199                         urlValues.Set(k, v)
 200                         continue
 201                 }
 202                 if v, ok := v.(json.Number); ok {
 203                         urlValues.Set(k, v.String())
 204                         continue
 205                 }
 206                 if v, ok := v.(bool); ok {
 207                         if v {
 208                                 urlValues.Set(k, "true")
 209                         } else {
 210                                 // "foo=false", "foo=0", and "foo="
 211                                 // are all taken as true strings, so
 212                                 // don't send false values at all --
 213                                 // rely on the default being false.
 214                         }
 215                         continue
 216                 }
 217                 j, err := json.Marshal(v)
 218                 if err != nil {
 219                         return nil, err
 220                 }
 221                 if bytes.Equal(j, []byte("null")) {
 222                         // don't add it to urlValues at all
 223                         continue
 224                 }
 225                 urlValues.Set(k, string(j))
 226         }
 227         return urlValues, nil
 228 }
 229
 230 // RequestAndDecode performs an API request and unmarshals the
 231 // response (which must be JSON) into dst. Method and body arguments
 232 // are the same as for http.NewRequest(). The given path is added to
 233 // the server's scheme/host/port to form the request URL. The given
 234 // params are passed via POST form or query string.
 235 //
 236 // path must not contain a query string.
 237 func (c *Client) RequestAndDecode(dst interface{}, method, path string, body io.Reader, params interface{}) error {
 238         return c.RequestAndDecodeContext(c.context(), dst, method, path, body, params)
 239 }
 240
 241 func (c *Client) RequestAndDecodeContext(ctx context.Context, dst interface{}, method, path string, body io.Reader, params interface{}) error {
 242         if body, ok := body.(io.Closer); ok {
 243                 // Ensure body is closed even if we error out early
 244                 defer body.Close()
 245         }
 246         urlString := c.apiURL(path)
 247         urlValues, err := anythingToValues(params)
 248         if err != nil {
 249                 return err
 250         }
 251         if urlValues == nil {
 252                 // Nothing to send
 253         } else if method == "GET" || method == "HEAD" || body != nil {
 254                 // Must send params in query part of URL (FIXME: what
 255                 // if resulting URL is too long?)
 256                 u, err := url.Parse(urlString)
 257                 if err != nil {
 258                         return err
 259                 }
 260                 u.RawQuery = urlValues.Encode()
 261                 urlString = u.String()
 262         } else {
 263                 body = strings.NewReader(urlValues.Encode())
 264         }
 265         req, err := http.NewRequest(method, urlString, body)
 266         if err != nil {
 267                 return err
 268         }
 269         req = req.WithContext(ctx)
 270         req.Header.Set("Content-type", "application/x-www-form-urlencoded")
 271         return c.DoAndDecode(dst, req)
 272 }
 273
 274 type resource interface {
 275         resourceName() string
 276 }
 277
 278 // UpdateBody returns an io.Reader suitable for use as an http.Request
 279 // Body for a create or update API call.
 280 func (c *Client) UpdateBody(rsc resource) io.Reader {
 281         j, err := json.Marshal(rsc)
 282         if err != nil {
 283                 // Return a reader that returns errors.
 284                 r, w := io.Pipe()
 285                 w.CloseWithError(err)
 286                 return r
 287         }
 288         v := url.Values{rsc.resourceName(): {string(j)}}
 289         return bytes.NewBufferString(v.Encode())
 290 }
 291
 292 // WithRequestID returns a new shallow copy of c that sends the given
 293 // X-Request-Id value (instead of a new randomly generated one) with
 294 // each subsequent request that doesn't provide its own via context or
 295 // header.
 296 func (c *Client) WithRequestID(reqid string) *Client {
 297         cc := *c
 298         cc.ctx = ContextWithRequestID(cc.context(), reqid)
 299         return &cc
 300 }
 301
 302 func (c *Client) context() context.Context {
 303         if c.ctx == nil {
 304                 return context.Background()
 305         }
 306         return c.ctx
 307 }
 308
 309 func (c *Client) httpClient() *http.Client {
 310         switch {
 311         case c.Client != nil:
 312                 return c.Client
 313         case c.Insecure:
 314                 return InsecureHTTPClient
 315         default:
 316                 return DefaultSecureClient
 317         }
 318 }
 319
 320 func (c *Client) apiURL(path string) string {
 321         scheme := c.Scheme
 322         if scheme == "" {
 323                 scheme = "https"
 324         }
 325         return scheme + "://" + c.APIHost + "/" + path
 326 }
 327
 328 // DiscoveryDocument is the Arvados server's description of itself.
 329 type DiscoveryDocument struct {
 330         BasePath                     string              `json:"basePath"`
 331         DefaultCollectionReplication int                 `json:"defaultCollectionReplication"`
 332         BlobSignatureTTL             int64               `json:"blobSignatureTtl"`
 333         GitURL                       string              `json:"gitUrl"`
 334         Schemas                      map[string]Schema   `json:"schemas"`
 335         Resources                    map[string]Resource `json:"resources"`
 336 }
 337
 338 type Resource struct {
 339         Methods map[string]ResourceMethod `json:"methods"`
 340 }
 341
 342 type ResourceMethod struct {
 343         HTTPMethod string         `json:"httpMethod"`
 344         Path       string         `json:"path"`
 345         Response   MethodResponse `json:"response"`
 346 }
 347
 348 type MethodResponse struct {
 349         Ref string `json:"$ref"`
 350 }
 351
 352 type Schema struct {
 353         UUIDPrefix string `json:"uuidPrefix"`
 354 }
 355
 356 // DiscoveryDocument returns a *DiscoveryDocument. The returned object
 357 // should not be modified: the same object may be returned by
 358 // subsequent calls.
 359 func (c *Client) DiscoveryDocument() (*DiscoveryDocument, error) {
 360         if c.dd != nil {
 361                 return c.dd, nil
 362         }
 363         var dd DiscoveryDocument
 364         err := c.RequestAndDecode(&dd, "GET", "discovery/v1/apis/arvados/v1/rest", nil, nil)
 365         if err != nil {
 366                 return nil, err
 367         }
 368         c.dd = &dd
 369         return c.dd, nil
 370 }
 371
 372 var pdhRegexp = regexp.MustCompile(`^[0-9a-f]{32}\+\d+$`)
 373
 374 func (c *Client) modelForUUID(dd *DiscoveryDocument, uuid string) (string, error) {
 375         if pdhRegexp.MatchString(uuid) {
 376                 return "Collection", nil
 377         }
 378         if len(uuid) != 27 {
 379                 return "", fmt.Errorf("invalid UUID: %q", uuid)
 380         }
 381         infix := uuid[6:11]
 382         var model string
 383         for m, s := range dd.Schemas {
 384                 if s.UUIDPrefix == infix {
 385                         model = m
 386                         break
 387                 }
 388         }
 389         if model == "" {
 390                 return "", fmt.Errorf("unrecognized type portion %q in UUID %q", infix, uuid)
 391         }
 392         return model, nil
 393 }
 394
 395 func (c *Client) KindForUUID(uuid string) (string, error) {
 396         dd, err := c.DiscoveryDocument()
 397         if err != nil {
 398                 return "", err
 399         }
 400         model, err := c.modelForUUID(dd, uuid)
 401         if err != nil {
 402                 return "", err
 403         }
 404         return "arvados#" + strings.ToLower(model[:1]) + model[1:], nil
 405 }
 406
 407 func (c *Client) PathForUUID(method, uuid string) (string, error) {
 408         dd, err := c.DiscoveryDocument()
 409         if err != nil {
 410                 return "", err
 411         }
 412         model, err := c.modelForUUID(dd, uuid)
 413         if err != nil {
 414                 return "", err
 415         }
 416         var resource string
 417         for r, rsc := range dd.Resources {
 418                 if rsc.Methods["get"].Response.Ref == model {
 419                         resource = r
 420                         break
 421                 }
 422         }
 423         if resource == "" {
 424                 return "", fmt.Errorf("no resource for model: %q", model)
 425         }
 426         m, ok := dd.Resources[resource].Methods[method]
 427         if !ok {
 428                 return "", fmt.Errorf("no method %q for resource %q", method, resource)
 429         }
 430         path := dd.BasePath + strings.Replace(m.Path, "{uuid}", uuid, -1)
 431         if path[0] == '/' {
 432                 path = path[1:]
 433         }
 434         return path, nil
 435 }