X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/29665e2d9a543bffb237d148c3484c03b03e30aa..3aaefcb3c76ff470b475d950398d01255e87712a:/sdk/go/arvadosclient/arvadosclient.go

diff --git a/sdk/go/arvadosclient/arvadosclient.go b/sdk/go/arvadosclient/arvadosclient.go
index 4cfda94581..d90c618f7a 100644
--- a/sdk/go/arvadosclient/arvadosclient.go
+++ b/sdk/go/arvadosclient/arvadosclient.go
@@ -1,3 +1,7 @@
+// Copyright (C) The Arvados Authors. All rights reserved.
+//
+// SPDX-License-Identifier: Apache-2.0
+
 /* Simple Arvados Go SDK for communicating with API server. */
 
 package arvadosclient
@@ -20,7 +24,7 @@ import (
 	"sync"
 	"time"
 
-	"git.curoverse.com/arvados.git/sdk/go/arvados"
+	"git.arvados.org/arvados.git/sdk/go/arvados"
 )
 
 type StringMatcher func(string) bool
@@ -46,7 +50,7 @@ var (
 	defaultHTTPClientMtx      sync.Mutex
 )
 
-// Indicates an error that was returned by the API server.
+// APIServerError contains an error that was returned by the API server.
 type APIServerError struct {
 	// Address of server returning error, of the form "host:port".
 	ServerAddress string
@@ -66,12 +70,11 @@ func (e APIServerError) Error() string {
 			e.HttpStatusCode,
 			e.HttpStatusMessage,
 			e.ServerAddress)
-	} else {
-		return fmt.Sprintf("arvados API server error: %d: %s returned by %s",
-			e.HttpStatusCode,
-			e.HttpStatusMessage,
-			e.ServerAddress)
 	}
+	return fmt.Sprintf("arvados API server error: %d: %s returned by %s",
+		e.HttpStatusCode,
+		e.HttpStatusMessage,
+		e.ServerAddress)
 }
 
 // StringBool tests whether s is suggestive of true. It returns true
@@ -81,10 +84,10 @@ func StringBool(s string) bool {
 	return s == "1" || s == "yes" || s == "true"
 }
 
-// Helper type so we don't have to write out 'map[string]interface{}' every time.
+// Dict is a helper type so we don't have to write out 'map[string]interface{}' every time.
 type Dict map[string]interface{}
 
-// Information about how to contact the Arvados server
+// ArvadosClient contains information about how to contact the Arvados server
 type ArvadosClient struct {
 	// https
 	Scheme string
@@ -118,6 +121,9 @@ type ArvadosClient struct {
 
 	// Number of retries
 	Retries int
+
+	// X-Request-Id for outgoing requests
+	RequestID string
 }
 
 var CertFiles = []string{
@@ -166,8 +172,11 @@ func New(c *arvados.Client) (*ArvadosClient, error) {
 		ApiServer:   c.APIHost,
 		ApiToken:    c.AuthToken,
 		ApiInsecure: c.Insecure,
-		Client: &http.Client{Transport: &http.Transport{
-			TLSClientConfig: MakeTLSConfig(c.Insecure)}},
+		Client: &http.Client{
+			Timeout: 5 * time.Minute,
+			Transport: &http.Transport{
+				TLSClientConfig: MakeTLSConfig(c.Insecure)},
+		},
 		External:          false,
 		Retries:           2,
 		KeepServiceURIs:   c.KeepServiceURIs,
@@ -201,7 +210,7 @@ func (c *ArvadosClient) CallRaw(method string, resourceType string, uuid string,
 		Scheme: scheme,
 		Host:   c.ApiServer}
 
-	if resourceType != API_DISCOVERY_RESOURCE {
+	if resourceType != ApiDiscoveryResource {
 		u.Path = "/arvados/v1"
 	}
 
@@ -262,6 +271,9 @@ func (c *ArvadosClient) CallRaw(method string, resourceType string, uuid string,
 
 		// Add api token header
 		req.Header.Add("Authorization", fmt.Sprintf("OAuth2 %s", c.ApiToken))
+		if c.RequestID != "" {
+			req.Header.Add("X-Request-Id", c.RequestID)
+		}
 		if c.External {
 			req.Header.Add("X-External-Client", "1")
 		}
@@ -366,7 +378,7 @@ func (c *ArvadosClient) Delete(resource string, uuid string, parameters Dict, ou
 	return c.Call("DELETE", resource, uuid, "", parameters, output)
 }
 
-// Modify attributes of a resource. See Call for argument descriptions.
+// Update 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)
 }
@@ -388,7 +400,7 @@ func (c *ArvadosClient) List(resource string, parameters Dict, output interface{
 	return c.Call("GET", resource, "", "", parameters, output)
 }
 
-const API_DISCOVERY_RESOURCE = "discovery/v1/apis/arvados/v1/rest"
+const ApiDiscoveryResource = "discovery/v1/apis/arvados/v1/rest"
 
 // Discovery returns the value of the given parameter in the discovery
 // document. Returns a non-nil error if the discovery document cannot
@@ -397,7 +409,7 @@ const API_DISCOVERY_RESOURCE = "discovery/v1/apis/arvados/v1/rest"
 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)
+		err = c.Call("GET", ApiDiscoveryResource, "", "", nil, &c.DiscoveryDoc)
 		if err != nil {
 			return nil, err
 		}
@@ -407,24 +419,23 @@ func (c *ArvadosClient) Discovery(parameter string) (value interface{}, err erro
 	value, found = c.DiscoveryDoc[parameter]
 	if found {
 		return value, nil
-	} else {
-		return value, ErrInvalidArgument
 	}
+	return value, ErrInvalidArgument
 }
 
-func (ac *ArvadosClient) httpClient() *http.Client {
-	if ac.Client != nil {
-		return ac.Client
+func (c *ArvadosClient) httpClient() *http.Client {
+	if c.Client != nil {
+		return c.Client
 	}
-	c := &defaultSecureHTTPClient
-	if ac.ApiInsecure {
-		c = &defaultInsecureHTTPClient
+	cl := &defaultSecureHTTPClient
+	if c.ApiInsecure {
+		cl = &defaultInsecureHTTPClient
 	}
-	if *c == nil {
+	if *cl == nil {
 		defaultHTTPClientMtx.Lock()
 		defer defaultHTTPClientMtx.Unlock()
-		*c = &http.Client{Transport: &http.Transport{
-			TLSClientConfig: MakeTLSConfig(ac.ApiInsecure)}}
+		*cl = &http.Client{Transport: &http.Transport{
+			TLSClientConfig: MakeTLSConfig(c.ApiInsecure)}}
 	}
-	return *c
+	return *cl
 }