sdk/python/arvados/api.py

   1 # Copyright (C) The Arvados Authors. All rights reserved.
   2 #
   3 # SPDX-License-Identifier: Apache-2.0
   4 """Arvados API client
   5
   6 The code in this module builds Arvados API client objects you can use to submit
   7 Arvados API requests. This includes extending the underlying HTTP client with
   8 niceties such as caching, X-Request-Id header for tracking, and more. The main
   9 client constructors are `api` and `api_from_config`.
  10 """
  11
  12 from __future__ import absolute_import
  13 from future import standard_library
  14 standard_library.install_aliases()
  15 from builtins import range
  16 import collections
  17 import http.client
  18 import httplib2
  19 import json
  20 import logging
  21 import os
  22 import re
  23 import socket
  24 import ssl
  25 import sys
  26 import threading
  27 import time
  28 import types
  29
  30 import apiclient
  31 import apiclient.http
  32 from apiclient import discovery as apiclient_discovery
  33 from apiclient import errors as apiclient_errors
  34 from . import config
  35 from . import errors
  36 from . import retry
  37 from . import util
  38 from . import cache
  39 from .logging import GoogleHTTPClientFilter, log_handler
  40
  41 _logger = logging.getLogger('arvados.api')
  42 _googleapiclient_log_lock = threading.Lock()
  43
  44 MAX_IDLE_CONNECTION_DURATION = 30
  45
  46 # These constants supported our own retry logic that we've since removed in
  47 # favor of using googleapiclient's num_retries. They're kept here purely for
  48 # API compatibility, but set to 0 to indicate no retries happen.
  49 RETRY_DELAY_INITIAL = 0
  50 RETRY_DELAY_BACKOFF = 0
  51 RETRY_COUNT = 0
  52
  53 # An unused HTTP 5xx status code to request a retry internally.
  54 # See _intercept_http_request. This should not be user-visible.
  55 _RETRY_4XX_STATUS = 545
  56
  57 if sys.version_info >= (3,):
  58     httplib2.SSLHandshakeError = None
  59
  60 class OrderedJsonModel(apiclient.model.JsonModel):
  61     """Model class for JSON that preserves the contents' order.
  62
  63     API clients that care about preserving the order of fields in API
  64     server responses can use this model to do so, like this:
  65
  66         from arvados.api import OrderedJsonModel
  67         client = arvados.api('v1', ..., model=OrderedJsonModel())
  68     """
  69
  70     def deserialize(self, content):
  71         # This is a very slightly modified version of the parent class'
  72         # implementation.  Copyright (c) 2010 Google.
  73         content = content.decode('utf-8')
  74         body = json.loads(content, object_pairs_hook=collections.OrderedDict)
  75         if self._data_wrapper and isinstance(body, dict) and 'data' in body:
  76             body = body['data']
  77         return body
  78
  79
  80 _orig_retry_request = apiclient.http._retry_request
  81 def _retry_request(http, num_retries, *args, **kwargs):
  82     try:
  83         num_retries = max(num_retries, http.num_retries)
  84     except AttributeError:
  85         # `http` client object does not have a `num_retries` attribute.
  86         # It apparently hasn't gone through _patch_http_request, possibly
  87         # because this isn't an Arvados API client. Pass through to
  88         # avoid interfering with other Google API clients.
  89         return _orig_retry_request(http, num_retries, *args, **kwargs)
  90     response, body = _orig_retry_request(http, num_retries, *args, **kwargs)
  91     # If _intercept_http_request ran out of retries for a 4xx response,
  92     # restore the original status code.
  93     if response.status == _RETRY_4XX_STATUS:
  94         response.status = int(response['status'])
  95     return (response, body)
  96 apiclient.http._retry_request = _retry_request
  97
  98 def _intercept_http_request(self, uri, method="GET", headers={}, **kwargs):
  99     if not headers.get('X-Request-Id'):
 100         headers['X-Request-Id'] = self._request_id()
 101     try:
 102         if (self.max_request_size and
 103             kwargs.get('body') and
 104             self.max_request_size < len(kwargs['body'])):
 105             raise apiclient_errors.MediaUploadSizeError("Request size %i bytes exceeds published limit of %i bytes" % (len(kwargs['body']), self.max_request_size))
 106
 107         headers['Authorization'] = 'OAuth2 %s' % self.arvados_api_token
 108
 109         if (time.time() - self._last_request_time) > self._max_keepalive_idle:
 110             # High probability of failure due to connection atrophy. Make
 111             # sure this request [re]opens a new connection by closing and
 112             # forgetting all cached connections first.
 113             for conn in self.connections.values():
 114                 conn.close()
 115             self.connections.clear()
 116
 117         self._last_request_time = time.time()
 118         try:
 119             response, body = self.orig_http_request(uri, method, headers=headers, **kwargs)
 120         except ssl.SSLCertVerificationError as e:
 121             raise ssl.SSLCertVerificationError(e.args[0], "Could not connect to %s\n%s\nPossible causes: remote SSL/TLS certificate expired, or was issued by an untrusted certificate authority." % (uri, e)) from None
 122         # googleapiclient only retries 403, 429, and 5xx status codes.
 123         # If we got another 4xx status that we want to retry, convert it into
 124         # 5xx so googleapiclient handles it the way we want.
 125         if response.status in retry._HTTP_CAN_RETRY and response.status < 500:
 126             response.status = _RETRY_4XX_STATUS
 127         return (response, body)
 128     except Exception as e:
 129         # Prepend "[request_id] " to the error message, which we
 130         # assume is the first string argument passed to the exception
 131         # constructor.
 132         for i in range(len(e.args or ())):
 133             if type(e.args[i]) == type(""):
 134                 e.args = e.args[:i] + ("[{}] {}".format(headers['X-Request-Id'], e.args[i]),) + e.args[i+1:]
 135                 raise type(e)(*e.args)
 136         raise
 137
 138 def _patch_http_request(http, api_token, num_retries):
 139     http.arvados_api_token = api_token
 140     http.max_request_size = 0
 141     http.num_retries = num_retries
 142     http.orig_http_request = http.request
 143     http.request = types.MethodType(_intercept_http_request, http)
 144     http._last_request_time = 0
 145     http._max_keepalive_idle = MAX_IDLE_CONNECTION_DURATION
 146     http._request_id = util.new_request_id
 147     return http
 148
 149 def _close_connections(self):
 150     for conn in self._http.connections.values():
 151         conn.close()
 152
 153 # Monkey patch discovery._cast() so objects and arrays get serialized
 154 # with json.dumps() instead of str().
 155 _cast_orig = apiclient_discovery._cast
 156 def _cast_objects_too(value, schema_type):
 157     global _cast_orig
 158     if (type(value) != type('') and
 159         type(value) != type(b'') and
 160         (schema_type == 'object' or schema_type == 'array')):
 161         return json.dumps(value)
 162     else:
 163         return _cast_orig(value, schema_type)
 164 apiclient_discovery._cast = _cast_objects_too
 165
 166 # Convert apiclient's HttpErrors into our own API error subclass for better
 167 # error reporting.
 168 # Reassigning apiclient_errors.HttpError is not sufficient because most of the
 169 # apiclient submodules import the class into their own namespace.
 170 def _new_http_error(cls, *args, **kwargs):
 171     return super(apiclient_errors.HttpError, cls).__new__(
 172         errors.ApiError, *args, **kwargs)
 173 apiclient_errors.HttpError.__new__ = staticmethod(_new_http_error)
 174
 175 def http_cache(data_type):
 176     homedir = os.environ.get('HOME')
 177     if not homedir or len(homedir) == 0:
 178         return None
 179     path = homedir + '/.cache/arvados/' + data_type
 180     try:
 181         util.mkdir_dash_p(path)
 182     except OSError:
 183         return None
 184     return cache.SafeHTTPCache(path, max_age=60*60*24*2)
 185
 186 def api_client(
 187         version,
 188         discoveryServiceUrl,
 189         token,
 190         *,
 191         cache=True,
 192         http=None,
 193         insecure=False,
 194         num_retries=10,
 195         request_id=None,
 196         timeout=5*60,
 197         **kwargs,
 198 ):
 199     """Build an Arvados API client
 200
 201     This function returns a `googleapiclient.discovery.Resource` object
 202     constructed from the given arguments. This is a relatively low-level
 203     interface that requires all the necessary inputs as arguments. Most
 204     users will prefer to use `api` which can accept more flexible inputs.
 205
 206     Arguments:
 207
 208     version: str
 209     : A string naming the version of the Arvados API to use.
 210
 211     discoveryServiceUrl: str
 212     : The URL used to discover APIs passed directly to
 213       `googleapiclient.discovery.build`.
 214
 215     token: str
 216     : The authentication token to send with each API call.
 217
 218     Keyword-only arguments:
 219
 220     cache: bool
 221     : If true, loads the API discovery document from, or saves it to, a cache
 222       on disk (located at `~/.cache/arvados/discovery`).
 223
 224     http: httplib2.Http | None
 225     : The HTTP client object the API client object will use to make requests.
 226       If not provided, this function will build its own to use. Either way, the
 227       object will be patched as part of the build process.
 228
 229     insecure: bool
 230     : If true, ignore SSL certificate validation errors. Default `False`.
 231
 232     num_retries: int
 233     : The number of times to retry each API request if it encounters a
 234       temporary failure. Default 10.
 235
 236     request_id: str | None
 237     : Default `X-Request-Id` header value for outgoing requests that
 238       don't already provide one. If `None` or omitted, generate a random
 239       ID. When retrying failed requests, the same ID is used on all
 240       attempts.
 241
 242     timeout: int
 243     : A timeout value for HTTP requests in seconds. Default 300 (5 minutes).
 244
 245     Additional keyword arguments will be passed directly to
 246     `googleapiclient.discovery.build`.
 247     """
 248     if http is None:
 249         http = httplib2.Http(
 250             ca_certs=util.ca_certs_path(),
 251             cache=http_cache('discovery') if cache else None,
 252             disable_ssl_certificate_validation=bool(insecure),
 253         )
 254     if http.timeout is None:
 255         http.timeout = timeout
 256     http = _patch_http_request(http, token, num_retries)
 257
 258     # The first time a client is instantiated, temporarily route
 259     # googleapiclient.http retry logs if they're not already. These are
 260     # important because temporary problems fetching the discovery document
 261     # can cause clients to appear to hang early. This can be removed after
 262     # we have a more general story for handling googleapiclient logs (#20521).
 263     client_logger = logging.getLogger('googleapiclient.http')
 264     client_logger_preconfigured = (
 265         # "first time a client is instantiated" = thread that acquires this lock
 266         # It is never released.
 267         _googleapiclient_log_lock.acquire(blocking=False)
 268         and not client_logger.hasHandlers()
 269     )
 270     if not client_logger_preconfigured:
 271         client_level = client_logger.level
 272         client_filter = GoogleHTTPClientFilter()
 273         client_logger.addFilter(client_filter)
 274         client_logger.addHandler(log_handler)
 275         if logging.NOTSET < client_level < client_filter.retry_levelno:
 276             client_logger.setLevel(client_level)
 277         else:
 278             client_logger.setLevel(client_filter.retry_levelno)
 279     svc = apiclient_discovery.build(
 280         'arvados', version,
 281         cache_discovery=False,
 282         discoveryServiceUrl=discoveryServiceUrl,
 283         http=http,
 284         num_retries=num_retries,
 285         **kwargs,
 286     )
 287     if not client_logger_preconfigured:
 288         client_logger.removeHandler(log_handler)
 289         client_logger.removeFilter(client_filter)
 290         client_logger.setLevel(client_level)
 291     svc.api_token = token
 292     svc.insecure = insecure
 293     svc.request_id = request_id
 294     svc.config = lambda: util.get_config_once(svc)
 295     svc.vocabulary = lambda: util.get_vocabulary_once(svc)
 296     svc.close_connections = types.MethodType(_close_connections, svc)
 297     http.max_request_size = svc._rootDesc.get('maxRequestSize', 0)
 298     http.cache = None
 299     http._request_id = lambda: svc.request_id or util.new_request_id()
 300     return svc
 301
 302 def normalize_api_kwargs(
 303         version=None,
 304         discoveryServiceUrl=None,
 305         host=None,
 306         token=None,
 307         **kwargs,
 308 ):
 309     """Validate kwargs from `api` and build kwargs for `api_client`
 310
 311     This method takes high-level keyword arguments passed to the `api`
 312     constructor and normalizes them into a new dictionary that can be passed
 313     as keyword arguments to `api_client`. It raises `ValueError` if required
 314     arguments are missing or conflict.
 315
 316     Arguments:
 317
 318     version: str | None
 319     : A string naming the version of the Arvados API to use. If not specified,
 320       the code will log a warning and fall back to 'v1'.
 321
 322     discoveryServiceUrl: str | None
 323     : The URL used to discover APIs passed directly to
 324       `googleapiclient.discovery.build`. It is an error to pass both
 325       `discoveryServiceUrl` and `host`.
 326
 327     host: str | None
 328     : The hostname and optional port number of the Arvados API server. Used to
 329       build `discoveryServiceUrl`. It is an error to pass both
 330       `discoveryServiceUrl` and `host`.
 331
 332     token: str
 333     : The authentication token to send with each API call.
 334
 335     Additional keyword arguments will be included in the return value.
 336     """
 337     if discoveryServiceUrl and host:
 338         raise ValueError("both discoveryServiceUrl and host provided")
 339     elif discoveryServiceUrl:
 340         url_src = "discoveryServiceUrl"
 341     elif host:
 342         url_src = "host argument"
 343         discoveryServiceUrl = 'https://%s/discovery/v1/apis/{api}/{apiVersion}/rest' % (host,)
 344     elif token:
 345         # This specific error message gets priority for backwards compatibility.
 346         raise ValueError("token argument provided, but host missing.")
 347     else:
 348         raise ValueError("neither discoveryServiceUrl nor host provided")
 349     if not token:
 350         raise ValueError("%s provided, but token missing" % (url_src,))
 351     if not version:
 352         version = 'v1'
 353         _logger.info(
 354             "Using default API version. Call arvados.api(%r) instead.",
 355             version,
 356         )
 357     return {
 358         'discoveryServiceUrl': discoveryServiceUrl,
 359         'token': token,
 360         'version': version,
 361         **kwargs,
 362     }
 363
 364 def api_kwargs_from_config(version=None, apiconfig=None, **kwargs):
 365     """Build `api_client` keyword arguments from configuration
 366
 367     This function accepts a mapping with Arvados configuration settings like
 368     `ARVADOS_API_HOST` and converts them into a mapping of keyword arguments
 369     that can be passed to `api_client`. If `ARVADOS_API_HOST` or
 370     `ARVADOS_API_TOKEN` are not configured, it raises `ValueError`.
 371
 372     Arguments:
 373
 374     version: str | None
 375     : A string naming the version of the Arvados API to use. If not specified,
 376       the code will log a warning and fall back to 'v1'.
 377
 378     apiconfig: Mapping[str, str] | None
 379     : A mapping with entries for `ARVADOS_API_HOST`, `ARVADOS_API_TOKEN`, and
 380       optionally `ARVADOS_API_HOST_INSECURE`. If not provided, calls
 381       `arvados.config.settings` to get these parameters from user configuration.
 382
 383     Additional keyword arguments will be included in the return value.
 384     """
 385     if apiconfig is None:
 386         apiconfig = config.settings()
 387     missing = " and ".join(
 388         key
 389         for key in ['ARVADOS_API_HOST', 'ARVADOS_API_TOKEN']
 390         if key not in apiconfig
 391     )
 392     if missing:
 393         raise ValueError(
 394             "%s not set.\nPlease set in %s or export environment variable." %
 395             (missing, config.default_config_file),
 396         )
 397     return normalize_api_kwargs(
 398         version,
 399         None,
 400         apiconfig['ARVADOS_API_HOST'],
 401         apiconfig['ARVADOS_API_TOKEN'],
 402         insecure=config.flag_is_true('ARVADOS_API_HOST_INSECURE', apiconfig),
 403         **kwargs,
 404     )
 405
 406 def api(version=None, cache=True, host=None, token=None, insecure=False,
 407         request_id=None, timeout=5*60, *,
 408         discoveryServiceUrl=None, **kwargs):
 409     """Dynamically build an Arvados API client
 410
 411     This function provides a high-level "do what I mean" interface to build an
 412     Arvados API client object. You can call it with no arguments to build a
 413     client from user configuration; pass `host` and `token` arguments just
 414     like you would write in user configuration; or pass additional arguments
 415     for lower-level control over the client.
 416
 417     This function returns a `arvados.safeapi.ThreadSafeApiCache`, an
 418     API-compatible wrapper around `googleapiclient.discovery.Resource`. If
 419     you're handling concurrency yourself and/or your application is very
 420     performance-sensitive, consider calling `api_client` directly.
 421
 422     Arguments:
 423
 424     version: str | None
 425     : A string naming the version of the Arvados API to use. If not specified,
 426       the code will log a warning and fall back to 'v1'.
 427
 428     host: str | None
 429     : The hostname and optional port number of the Arvados API server.
 430
 431     token: str | None
 432     : The authentication token to send with each API call.
 433
 434     discoveryServiceUrl: str | None
 435     : The URL used to discover APIs passed directly to
 436       `googleapiclient.discovery.build`.
 437
 438     If `host`, `token`, and `discoveryServiceUrl` are all omitted, `host` and
 439     `token` will be loaded from the user's configuration. Otherwise, you must
 440     pass `token` and one of `host` or `discoveryServiceUrl`. It is an error to
 441     pass both `host` and `discoveryServiceUrl`.
 442
 443     Other arguments are passed directly to `api_client`. See that function's
 444     docstring for more information about their meaning.
 445     """
 446     kwargs.update(
 447         cache=cache,
 448         insecure=insecure,
 449         request_id=request_id,
 450         timeout=timeout,
 451     )
 452     if discoveryServiceUrl or host or token:
 453         kwargs.update(normalize_api_kwargs(version, discoveryServiceUrl, host, token))
 454     else:
 455         kwargs.update(api_kwargs_from_config(version))
 456     version = kwargs.pop('version')
 457     # We do the import here to avoid a circular import at the top level.
 458     from .safeapi import ThreadSafeApiCache
 459     return ThreadSafeApiCache({}, {}, kwargs, version)
 460
 461 def api_from_config(version=None, apiconfig=None, **kwargs):
 462     """Build an Arvados API client from a configuration mapping
 463
 464     This function builds an Arvados API client from a mapping with user
 465     configuration. It accepts that mapping as an argument, so you can use a
 466     configuration that's different from what the user has set up.
 467
 468     This function returns a `arvados.safeapi.ThreadSafeApiCache`, an
 469     API-compatible wrapper around `googleapiclient.discovery.Resource`. If
 470     you're handling concurrency yourself and/or your application is very
 471     performance-sensitive, consider calling `api_client` directly.
 472
 473     Arguments:
 474
 475     version: str | None
 476     : A string naming the version of the Arvados API to use. If not specified,
 477       the code will log a warning and fall back to 'v1'.
 478
 479     apiconfig: Mapping[str, str] | None
 480     : A mapping with entries for `ARVADOS_API_HOST`, `ARVADOS_API_TOKEN`, and
 481       optionally `ARVADOS_API_HOST_INSECURE`. If not provided, calls
 482       `arvados.config.settings` to get these parameters from user configuration.
 483
 484     Other arguments are passed directly to `api_client`. See that function's
 485     docstring for more information about their meaning.
 486     """
 487     return api(**api_kwargs_from_config(version, apiconfig, **kwargs))