Merge branch 'master' into origin-4823-python-sdk-writable-collection-api
[arvados.git] / sdk / go / keepclient / support.go
index dc521da5e29db0bedb6ab960963ff2869112a160..c24849e687a8d11cf2e5d2154fdd62d0e470ec83 100644 (file)
@@ -9,6 +9,7 @@ import (
        "io"
        "io/ioutil"
        "log"
+       "net"
        "net/http"
        "os"
        "strings"
@@ -27,11 +28,61 @@ func Md5String(s string) string {
        return fmt.Sprintf("%x", md5.Sum([]byte(s)))
 }
 
+// Set timeouts apply when connecting to keepproxy services (assumed to be over
+// the Internet).
+func (this *KeepClient) setClientSettingsProxy() {
+       if this.Client.Timeout == 0 {
+               // Maximum time to wait for a complete response
+               this.Client.Timeout = 300 * time.Second
+
+               // TCP and TLS connection settings
+               this.Client.Transport = &http.Transport{
+                       Dial: (&net.Dialer{
+                               // The maximum time to wait to set up
+                               // the initial TCP connection.
+                               Timeout: 30 * time.Second,
+
+                               // The TCP keep alive heartbeat
+                               // interval.
+                               KeepAlive: 120 * time.Second,
+                       }).Dial,
+
+                       TLSHandshakeTimeout: 10 * time.Second,
+               }
+       }
+
+}
+
+// Set timeouts apply when connecting to keepstore services directly (assumed
+// to be on the local network).
+func (this *KeepClient) setClientSettingsStore() {
+       if this.Client.Timeout == 0 {
+               // Maximum time to wait for a complete response
+               this.Client.Timeout = 20 * time.Second
+
+               // TCP and TLS connection timeouts
+               this.Client.Transport = &http.Transport{
+                       Dial: (&net.Dialer{
+                               // The maximum time to wait to set up
+                               // the initial TCP connection.
+                               Timeout: 2 * time.Second,
+
+                               // The TCP keep alive heartbeat
+                               // interval.
+                               KeepAlive: 180 * time.Second,
+                       }).Dial,
+
+                       TLSHandshakeTimeout: 4 * time.Second,
+               }
+       }
+}
+
 func (this *KeepClient) DiscoverKeepServers() error {
        if prx := os.Getenv("ARVADOS_KEEP_PROXY"); prx != "" {
                sr := map[string]string{"proxy": prx}
                this.SetServiceRoots(sr)
                this.Using_proxy = true
+               this.setClientSettingsProxy()
                return nil
        }
 
@@ -71,6 +122,12 @@ func (this *KeepClient) DiscoverKeepServers() error {
                }
        }
 
+       if this.Using_proxy {
+               this.setClientSettingsProxy()
+       } else {
+               this.setClientSettingsStore()
+       }
+
        this.SetServiceRoots(service_roots)
 
        return nil
@@ -85,20 +142,29 @@ type uploadStatus struct {
 }
 
 func (this KeepClient) uploadToKeepServer(host string, hash string, body io.ReadCloser,
-       upload_status chan<- uploadStatus, expectedLength int64, tag string) {
+       upload_status chan<- uploadStatus, expectedLength int64, requestId string) {
 
        var req *http.Request
        var err error
        var url = fmt.Sprintf("%s/%s", host, hash)
        if req, err = http.NewRequest("PUT", url, nil); err != nil {
-               log.Printf("[%v] Error creating request PUT %v error: %v", tag, url, err.Error())
+               log.Printf("[%v] Error creating request PUT %v error: %v", requestId, url, err.Error())
                upload_status <- uploadStatus{err, url, 0, 0, ""}
                body.Close()
                return
        }
 
+       req.ContentLength = expectedLength
        if expectedLength > 0 {
-               req.ContentLength = expectedLength
+               // http.Client.Do will close the body ReadCloser when it is
+               // done with it.
+               req.Body = body
+       } else {
+               // "For client requests, a value of 0 means unknown if Body is
+               // not nil."  In this case we do want the body to be empty, so
+               // don't set req.Body.  However, we still need to close the
+               // body ReadCloser.
+               body.Close()
        }
 
        req.Header.Add("Authorization", fmt.Sprintf("OAuth2 %s", this.Arvados.ApiToken))
@@ -108,11 +174,9 @@ func (this KeepClient) uploadToKeepServer(host string, hash string, body io.Read
                req.Header.Add(X_Keep_Desired_Replicas, fmt.Sprint(this.Want_replicas))
        }
 
-       req.Body = body
-
        var resp *http.Response
        if resp, err = this.Client.Do(req); err != nil {
-               log.Printf("[%v] Upload failed %v error: %v", tag, url, err.Error())
+               log.Printf("[%v] Upload failed %v error: %v", requestId, url, err.Error())
                upload_status <- uploadStatus{err, url, 0, 0, ""}
                return
        }
@@ -128,13 +192,13 @@ func (this KeepClient) uploadToKeepServer(host string, hash string, body io.Read
        respbody, err2 := ioutil.ReadAll(&io.LimitedReader{resp.Body, 4096})
        response := strings.TrimSpace(string(respbody))
        if err2 != nil && err2 != io.EOF {
-               log.Printf("[%v] Upload %v error: %v response: %v", tag, url, err2.Error(), response)
+               log.Printf("[%v] Upload %v error: %v response: %v", requestId, url, err2.Error(), response)
                upload_status <- uploadStatus{err2, url, resp.StatusCode, rep, response}
        } else if resp.StatusCode == http.StatusOK {
-               log.Printf("[%v] Upload %v success", tag, url)
+               log.Printf("[%v] Upload %v success", requestId, url)
                upload_status <- uploadStatus{nil, url, resp.StatusCode, rep, response}
        } else {
-               log.Printf("[%v] Upload %v error: %v response: %v", tag, url, resp.StatusCode, response)
+               log.Printf("[%v] Upload %v error: %v response: %v", requestId, url, resp.StatusCode, response)
                upload_status <- uploadStatus{errors.New(resp.Status), url, resp.StatusCode, rep, response}
        }
 }
@@ -146,7 +210,7 @@ func (this KeepClient) putReplicas(
 
        // Take the hash of locator and timestamp in order to identify this
        // specific transaction in log statements.
-       tag := fmt.Sprintf("%x", md5.Sum([]byte(locator+time.Now().String())))[0:8]
+       requestId := fmt.Sprintf("%x", md5.Sum([]byte(locator+time.Now().String())))[0:8]
 
        // Calculate the ordering for uploading to servers
        sv := NewRootSorter(this.ServiceRoots(), hash).GetSortedRoots()
@@ -168,8 +232,8 @@ func (this KeepClient) putReplicas(
                for active < remaining_replicas {
                        // Start some upload requests
                        if next_server < len(sv) {
-                               log.Printf("[%v] Begin upload %s to %s", tag, hash, sv[next_server])
-                               go this.uploadToKeepServer(sv[next_server], hash, tr.MakeStreamReader(), upload_status, expectedLength, tag)
+                               log.Printf("[%v] Begin upload %s to %s", requestId, hash, sv[next_server])
+                               go this.uploadToKeepServer(sv[next_server], hash, tr.MakeStreamReader(), upload_status, expectedLength, requestId)
                                next_server += 1
                                active += 1
                        } else {
@@ -181,11 +245,12 @@ func (this KeepClient) putReplicas(
                        }
                }
                log.Printf("[%v] Replicas remaining to write: %v active uploads: %v",
-                       tag, remaining_replicas, active)
+                       requestId, remaining_replicas, active)
 
                // Now wait for something to happen.
                status := <-upload_status
                active -= 1
+
                if status.statusCode == 200 {
                        // good news!
                        remaining_replicas -= status.replicas_stored