9437: gofmt
[arvados.git] / services / datamanager / keep / keep.go
index 08e54e6ced6079af651c4ca495fe474b9206e256..e7843ea02f8090133a4270465ba2330f579f3be5 100644 (file)
@@ -5,51 +5,56 @@ package keep
 import (
        "bufio"
        "encoding/json"
+       "errors"
        "flag"
        "fmt"
        "git.curoverse.com/arvados.git/sdk/go/arvadosclient"
        "git.curoverse.com/arvados.git/sdk/go/blockdigest"
        "git.curoverse.com/arvados.git/sdk/go/keepclient"
        "git.curoverse.com/arvados.git/sdk/go/logger"
-       "git.curoverse.com/arvados.git/services/datamanager/loggerutil"
        "io"
        "io/ioutil"
        "log"
        "net/http"
        "strconv"
        "strings"
-       "sync"
        "time"
 )
 
+// ServerAddress struct
 type ServerAddress struct {
-       SSL  bool   `json:service_ssl_flag`
-       Host string `json:"service_host"`
-       Port int    `json:"service_port"`
-       Uuid string `json:"uuid"`
+       SSL         bool   `json:"service_ssl_flag"`
+       Host        string `json:"service_host"`
+       Port        int    `json:"service_port"`
+       UUID        string `json:"uuid"`
+       ServiceType string `json:"service_type"`
 }
 
-// Info about a particular block returned by the server
+// BlockInfo is info about a particular block returned by the server
 type BlockInfo struct {
        Digest blockdigest.DigestWithSize
        Mtime  int64 // TODO(misha): Replace this with a timestamp.
 }
 
-// Info about a specified block given by a server
+// BlockServerInfo is info about a specified block given by a server
 type BlockServerInfo struct {
        ServerIndex int
        Mtime       int64 // TODO(misha): Replace this with a timestamp.
 }
 
+// ServerContents struct
 type ServerContents struct {
        BlockDigestToInfo map[blockdigest.DigestWithSize]BlockInfo
 }
 
+// ServerResponse struct
 type ServerResponse struct {
        Address  ServerAddress
        Contents ServerContents
+       Err      error
 }
 
+// ReadServers struct
 type ReadServers struct {
        ReadAllServers           bool
        KeepServerIndexToAddress []ServerAddress
@@ -59,69 +64,48 @@ type ReadServers struct {
        BlockReplicationCounts   map[int]int
 }
 
+// GetKeepServersParams struct
 type GetKeepServersParams struct {
        Client arvadosclient.ArvadosClient
        Logger *logger.Logger
        Limit  int
 }
 
-type KeepServiceList struct {
+// ServiceList consists of the addresses of all the available kee servers
+type ServiceList struct {
        ItemsAvailable int             `json:"items_available"`
        KeepServers    []ServerAddress `json:"items"`
 }
 
-var (
-       // Don't access the token directly, use getDataManagerToken() to
-       // make sure it's been read.
-       dataManagerToken             string
-       dataManagerTokenFile         string
-       dataManagerTokenFileReadOnce sync.Once
-)
+var serviceType string
 
 func init() {
-       flag.StringVar(&dataManagerTokenFile,
-               "data-manager-token-file",
-               "",
-               "File with the API token we should use to contact keep servers.")
+       flag.StringVar(&serviceType,
+               "service-type",
+               "disk",
+               "Operate only on keep_services with the specified service_type, ignoring all others.")
 }
 
+// String
 // TODO(misha): Change this to include the UUID as well.
 func (s ServerAddress) String() string {
        return s.URL()
 }
 
+// URL of the keep server
 func (s ServerAddress) URL() string {
        if s.SSL {
                return fmt.Sprintf("https://%s:%d", s.Host, s.Port)
-       } else {
-               return fmt.Sprintf("http://%s:%d", s.Host, s.Port)
        }
+       return fmt.Sprintf("http://%s:%d", s.Host, s.Port)
 }
 
-func GetDataManagerToken(arvLogger *logger.Logger) string {
-       readDataManagerToken := func() {
-               if dataManagerTokenFile == "" {
-                       flag.Usage()
-                       loggerutil.FatalWithMessage(arvLogger,
-                               "Data Manager Token needed, but data manager token file not specified.")
-               } else {
-                       rawRead, err := ioutil.ReadFile(dataManagerTokenFile)
-                       if err != nil {
-                               loggerutil.FatalWithMessage(arvLogger,
-                                       fmt.Sprintf("Unexpected error reading token file %s: %v",
-                                               dataManagerTokenFile,
-                                               err))
-                       }
-                       dataManagerToken = strings.TrimSpace(string(rawRead))
-               }
+// GetKeepServersAndSummarize gets keep servers from api
+func GetKeepServersAndSummarize(params GetKeepServersParams) (results ReadServers, err error) {
+       results, err = GetKeepServers(params)
+       if err != nil {
+               return
        }
-
-       dataManagerTokenFileReadOnce.Do(readDataManagerToken)
-       return dataManagerToken
-}
-
-func GetKeepServersAndSummarize(params GetKeepServersParams) (results ReadServers) {
-       results = GetKeepServers(params)
        log.Printf("Returned %d keep disks", len(results.ServerToContents))
 
        results.Summarize(params.Logger)
@@ -131,25 +115,33 @@ func GetKeepServersAndSummarize(params GetKeepServersParams) (results ReadServer
        return
 }
 
-func GetKeepServers(params GetKeepServersParams) (results ReadServers) {
-       if &params.Client == nil {
-               log.Fatalf("params.Client passed to GetKeepServers() should " +
-                       "contain a valid ArvadosClient, but instead it is nil.")
-       }
-
+// GetKeepServers from api server
+func GetKeepServers(params GetKeepServersParams) (results ReadServers, err error) {
        sdkParams := arvadosclient.Dict{
-               "filters": [][]string{[]string{"service_type", "=", "disk"}},
+               "filters": [][]string{{"service_type", "!=", "proxy"}},
        }
        if params.Limit > 0 {
                sdkParams["limit"] = params.Limit
        }
 
-       var sdkResponse KeepServiceList
-       err := params.Client.List("keep_services", sdkParams, &sdkResponse)
+       var sdkResponse ServiceList
+       err = params.Client.List("keep_services", sdkParams, &sdkResponse)
 
        if err != nil {
-               loggerutil.FatalWithMessage(params.Logger,
-                       fmt.Sprintf("Error requesting keep disks from API server: %v", err))
+               return
+       }
+
+       var keepServers []ServerAddress
+       for _, server := range sdkResponse.KeepServers {
+               if server.ServiceType == serviceType {
+                       keepServers = append(keepServers, server)
+               } else {
+                       log.Printf("Skipping keep_service %q because its service_type %q does not match -service-type=%q", server, server.ServiceType, serviceType)
+               }
+       }
+
+       if len(keepServers) == 0 {
+               return results, fmt.Errorf("Found no keepservices with the service type %v", serviceType)
        }
 
        if params.Logger != nil {
@@ -158,17 +150,17 @@ func GetKeepServers(params GetKeepServersParams) (results ReadServers) {
                        keepInfo["num_keep_servers_available"] = sdkResponse.ItemsAvailable
                        keepInfo["num_keep_servers_received"] = len(sdkResponse.KeepServers)
                        keepInfo["keep_servers"] = sdkResponse.KeepServers
+                       keepInfo["indexable_keep_servers"] = keepServers
                })
        }
 
        log.Printf("Received keep services list: %+v", sdkResponse)
 
        if len(sdkResponse.KeepServers) < sdkResponse.ItemsAvailable {
-               loggerutil.FatalWithMessage(params.Logger,
-                       fmt.Sprintf("Did not receive all available keep servers: %+v", sdkResponse))
+               return results, fmt.Errorf("Did not receive all available keep servers: %+v", sdkResponse)
        }
 
-       results.KeepServerIndexToAddress = sdkResponse.KeepServers
+       results.KeepServerIndexToAddress = keepServers
        results.KeepServerAddressToIndex = make(map[ServerAddress]int)
        for i, address := range results.KeepServerIndexToAddress {
                results.KeepServerAddressToIndex[address] = i
@@ -176,12 +168,9 @@ func GetKeepServers(params GetKeepServersParams) (results ReadServers) {
 
        log.Printf("Got Server Addresses: %v", results)
 
-       // This is safe for concurrent use
-       client := http.Client{}
-
        // Send off all the index requests concurrently
        responseChan := make(chan ServerResponse)
-       for _, keepServer := range sdkResponse.KeepServers {
+       for _, keepServer := range results.KeepServerIndexToAddress {
                // The above keepsServer variable is reused for each iteration, so
                // it would be shared across all goroutines. This would result in
                // us querying one server n times instead of n different servers
@@ -191,7 +180,7 @@ func GetKeepServers(params GetKeepServersParams) (results ReadServers) {
                go func(keepServer ServerAddress) {
                        responseChan <- GetServerContents(params.Logger,
                                keepServer,
-                               client)
+                               params.Client)
                }(keepServer)
        }
 
@@ -199,9 +188,15 @@ func GetKeepServers(params GetKeepServersParams) (results ReadServers) {
        results.BlockToServers = make(map[blockdigest.DigestWithSize][]BlockServerInfo)
 
        // Read all the responses
-       for i := range sdkResponse.KeepServers {
+       for i := range results.KeepServerIndexToAddress {
                _ = i // Here to prevent go from complaining.
                response := <-responseChan
+
+               // Check if there were any errors during GetServerContents
+               if response.Err != nil {
+                       return results, response.Err
+               }
+
                log.Printf("Received channel response from %v containing %d files",
                        response.Address,
                        len(response.Contents.BlockDigestToInfo))
@@ -217,28 +212,42 @@ func GetKeepServers(params GetKeepServersParams) (results ReadServers) {
        return
 }
 
+// GetServerContents of the keep server
 func GetServerContents(arvLogger *logger.Logger,
        keepServer ServerAddress,
-       client http.Client) (response ServerResponse) {
+       arv arvadosclient.ArvadosClient) (response ServerResponse) {
 
-       GetServerStatus(arvLogger, keepServer, client)
+       err := GetServerStatus(arvLogger, keepServer, arv)
+       if err != nil {
+               response.Err = err
+               return
+       }
 
-       req := CreateIndexRequest(arvLogger, keepServer)
-       resp, err := client.Do(req)
+       req, err := CreateIndexRequest(arvLogger, keepServer, arv)
        if err != nil {
-               loggerutil.FatalWithMessage(arvLogger,
-                       fmt.Sprintf("Error fetching %s: %v. Response was %+v",
-                               req.URL.String(),
-                               err,
-                               resp))
+               response.Err = err
+               return
        }
 
-       return ReadServerResponse(arvLogger, keepServer, resp)
+       resp, err := arv.Client.Do(req)
+       if err != nil {
+               response.Err = err
+               return
+       }
+
+       response, err = ReadServerResponse(arvLogger, keepServer, resp)
+       if err != nil {
+               response.Err = err
+               return
+       }
+
+       return
 }
 
+// GetServerStatus get keep server status by invoking /status.json
 func GetServerStatus(arvLogger *logger.Logger,
        keepServer ServerAddress,
-       client http.Client) {
+       arv arvadosclient.ArvadosClient) error {
        url := fmt.Sprintf("http://%s:%d/status.json",
                keepServer.Host,
                keepServer.Port)
@@ -252,19 +261,17 @@ func GetServerStatus(arvLogger *logger.Logger,
                        serverInfo["host"] = keepServer.Host
                        serverInfo["port"] = keepServer.Port
 
-                       keepInfo[keepServer.Uuid] = serverInfo
+                       keepInfo[keepServer.UUID] = serverInfo
                })
        }
 
-       resp, err := client.Get(url)
+       resp, err := arv.Client.Get(url)
        if err != nil {
-               loggerutil.FatalWithMessage(arvLogger,
-                       fmt.Sprintf("Error getting keep status from %s: %v", url, err))
+               return fmt.Errorf("Error getting keep status from %s: %v", url, err)
        } else if resp.StatusCode != 200 {
-               loggerutil.FatalWithMessage(arvLogger,
-                       fmt.Sprintf("Received error code %d in response to request "+
-                               "for %s status: %s",
-                               resp.StatusCode, url, resp.Status))
+               return fmt.Errorf("Received error code %d in response to request "+
+                       "for %s status: %s",
+                       resp.StatusCode, url, resp.Status)
        }
 
        var keepStatus map[string]interface{}
@@ -272,23 +279,26 @@ func GetServerStatus(arvLogger *logger.Logger,
        decoder.UseNumber()
        err = decoder.Decode(&keepStatus)
        if err != nil {
-               loggerutil.FatalWithMessage(arvLogger,
-                       fmt.Sprintf("Error decoding keep status from %s: %v", url, err))
+               return fmt.Errorf("Error decoding keep status from %s: %v", url, err)
        }
 
        if arvLogger != nil {
                now := time.Now()
                arvLogger.Update(func(p map[string]interface{}, e map[string]interface{}) {
                        keepInfo := logger.GetOrCreateMap(p, "keep_info")
-                       serverInfo := keepInfo[keepServer.Uuid].(map[string]interface{})
+                       serverInfo := keepInfo[keepServer.UUID].(map[string]interface{})
                        serverInfo["status_response_processed_at"] = now
                        serverInfo["status"] = keepStatus
                })
        }
+
+       return nil
 }
 
+// CreateIndexRequest to the keep server
 func CreateIndexRequest(arvLogger *logger.Logger,
-       keepServer ServerAddress) (req *http.Request) {
+       keepServer ServerAddress,
+       arv arvadosclient.ArvadosClient) (req *http.Request, err error) {
        url := fmt.Sprintf("http://%s:%d/index", keepServer.Host, keepServer.Port)
        log.Println("About to fetch keep server contents from " + url)
 
@@ -296,38 +306,35 @@ func CreateIndexRequest(arvLogger *logger.Logger,
                now := time.Now()
                arvLogger.Update(func(p map[string]interface{}, e map[string]interface{}) {
                        keepInfo := logger.GetOrCreateMap(p, "keep_info")
-                       serverInfo := keepInfo[keepServer.Uuid].(map[string]interface{})
+                       serverInfo := keepInfo[keepServer.UUID].(map[string]interface{})
                        serverInfo["index_request_sent_at"] = now
                })
        }
 
-       req, err := http.NewRequest("GET", url, nil)
+       req, err = http.NewRequest("GET", url, nil)
        if err != nil {
-               loggerutil.FatalWithMessage(arvLogger,
-                       fmt.Sprintf("Error building http request for %s: %v", url, err))
+               return req, fmt.Errorf("Error building http request for %s: %v", url, err)
        }
 
-       req.Header.Add("Authorization",
-               fmt.Sprintf("OAuth2 %s", GetDataManagerToken(arvLogger)))
-       return
+       req.Header.Add("Authorization", "OAuth2 "+arv.ApiToken)
+       return req, err
 }
 
+// ReadServerResponse reads reasponse from keep server
 func ReadServerResponse(arvLogger *logger.Logger,
        keepServer ServerAddress,
-       resp *http.Response) (response ServerResponse) {
+       resp *http.Response) (response ServerResponse, err error) {
 
        if resp.StatusCode != 200 {
-               loggerutil.FatalWithMessage(arvLogger,
-                       fmt.Sprintf("Received error code %d in response to request "+
-                               "for %s index: %s",
-                               resp.StatusCode, keepServer.String(), resp.Status))
+               return response, fmt.Errorf("Received error code %d in response to index request for %s: %s",
+                       resp.StatusCode, keepServer.String(), resp.Status)
        }
 
        if arvLogger != nil {
                now := time.Now()
                arvLogger.Update(func(p map[string]interface{}, e map[string]interface{}) {
                        keepInfo := logger.GetOrCreateMap(p, "keep_info")
-                       serverInfo := keepInfo[keepServer.Uuid].(map[string]interface{})
+                       serverInfo := keepInfo[keepServer.UUID].(map[string]interface{})
                        serverInfo["index_response_received_at"] = now
                })
        }
@@ -341,40 +348,35 @@ func ReadServerResponse(arvLogger *logger.Logger,
                numLines++
                line, err := reader.ReadString('\n')
                if err == io.EOF {
-                       loggerutil.FatalWithMessage(arvLogger,
-                               fmt.Sprintf("Index from %s truncated at line %d",
-                                       keepServer.String(), numLines))
+                       return response, fmt.Errorf("Index from %s truncated at line %d",
+                               keepServer.String(), numLines)
                } else if err != nil {
-                       loggerutil.FatalWithMessage(arvLogger,
-                               fmt.Sprintf("Error reading index response from %s at line %d: %v",
-                                       keepServer.String(), numLines, err))
+                       return response, fmt.Errorf("Error reading index response from %s at line %d: %v",
+                               keepServer.String(), numLines, err)
                }
                if line == "\n" {
                        if _, err := reader.Peek(1); err == nil {
                                extra, _ := reader.ReadString('\n')
-                               loggerutil.FatalWithMessage(arvLogger,
-                                       fmt.Sprintf("Index from %s had trailing data at line %d after EOF marker: %s",
-                                               keepServer.String(), numLines+1, extra))
+                               return response, fmt.Errorf("Index from %s had trailing data at line %d after EOF marker: %s",
+                                       keepServer.String(), numLines+1, extra)
                        } else if err != io.EOF {
-                               loggerutil.FatalWithMessage(arvLogger,
-                                       fmt.Sprintf("Index from %s had read error after EOF marker at line %d: %v",
-                                               keepServer.String(), numLines, err))
+                               return response, fmt.Errorf("Index from %s had read error after EOF marker at line %d: %v",
+                                       keepServer.String(), numLines, err)
                        }
                        numLines--
                        break
                }
                blockInfo, err := parseBlockInfoFromIndexLine(line)
                if err != nil {
-                       loggerutil.FatalWithMessage(arvLogger,
-                               fmt.Sprintf("Error parsing BlockInfo from index line "+
-                                       "received from %s: %v",
-                                       keepServer.String(),
-                                       err))
+                       return response, fmt.Errorf("Error parsing BlockInfo from index line "+
+                               "received from %s: %v",
+                               keepServer.String(),
+                               err)
                }
 
                if storedBlock, ok := response.Contents.BlockDigestToInfo[blockInfo.Digest]; ok {
                        // This server returned multiple lines containing the same block digest.
-                       numDuplicates += 1
+                       numDuplicates++
                        // Keep the block that's newer.
                        if storedBlock.Mtime < blockInfo.Mtime {
                                response.Contents.BlockDigestToInfo[blockInfo.Digest] = blockInfo
@@ -395,7 +397,7 @@ func ReadServerResponse(arvLogger *logger.Logger,
                now := time.Now()
                arvLogger.Update(func(p map[string]interface{}, e map[string]interface{}) {
                        keepInfo := logger.GetOrCreateMap(p, "keep_info")
-                       serverInfo := keepInfo[keepServer.Uuid].(map[string]interface{})
+                       serverInfo := keepInfo[keepServer.UUID].(map[string]interface{})
 
                        serverInfo["processing_finished_at"] = now
                        serverInfo["lines_received"] = numLines
@@ -411,19 +413,19 @@ func parseBlockInfoFromIndexLine(indexLine string) (blockInfo BlockInfo, err err
        tokens := strings.Fields(indexLine)
        if len(tokens) != 2 {
                err = fmt.Errorf("Expected 2 tokens per line but received a "+
-                       "line containing %v instead.",
+                       "line containing %#q instead.",
                        tokens)
        }
 
        var locator blockdigest.BlockLocator
        if locator, err = blockdigest.ParseBlockLocator(tokens[0]); err != nil {
-               err = fmt.Errorf("%v Received error while parsing line \"%s\"",
+               err = fmt.Errorf("%v Received error while parsing line \"%#q\"",
                        err, indexLine)
                return
        }
        if len(locator.Hints) > 0 {
                err = fmt.Errorf("Block locator in index line should not contain hints "+
-                       "but it does: %v",
+                       "but it does: %#q",
                        locator)
                return
        }
@@ -438,11 +440,12 @@ func parseBlockInfoFromIndexLine(indexLine string) (blockInfo BlockInfo, err err
        return
 }
 
+// Summarize results from keep server
 func (readServers *ReadServers) Summarize(arvLogger *logger.Logger) {
        readServers.BlockReplicationCounts = make(map[int]int)
        for _, infos := range readServers.BlockToServers {
                replication := len(infos)
-               readServers.BlockReplicationCounts[replication] += 1
+               readServers.BlockReplicationCounts[replication]++
        }
 
        if arvLogger != nil {
@@ -451,31 +454,45 @@ func (readServers *ReadServers) Summarize(arvLogger *logger.Logger) {
                        keepInfo["distinct_blocks_stored"] = len(readServers.BlockToServers)
                })
        }
-
 }
 
+// TrashRequest struct
 type TrashRequest struct {
        Locator    string `json:"locator"`
        BlockMtime int64  `json:"block_mtime"`
 }
 
+// TrashList is an array of TrashRequest objects
 type TrashList []TrashRequest
 
-func SendTrashLists(dataManagerToken string, kc *keepclient.KeepClient, spl map[string]TrashList) {
+// SendTrashLists to trash queue
+func SendTrashLists(arvLogger *logger.Logger, kc *keepclient.KeepClient, spl map[string]TrashList, dryRun bool) (errs []error) {
        count := 0
-       barrier := make(chan bool)
+       barrier := make(chan error)
 
        client := kc.Client
 
        for url, v := range spl {
-               count += 1
+               if arvLogger != nil {
+                       // We need a local variable because Update doesn't call our mutator func until later,
+                       // when our list variable might have been reused by the next loop iteration.
+                       url := url
+                       trashLen := len(v)
+                       arvLogger.Update(func(p map[string]interface{}, e map[string]interface{}) {
+                               trashListInfo := logger.GetOrCreateMap(p, "trash_list_len")
+                               trashListInfo[url] = trashLen
+                       })
+               }
+
+               if dryRun {
+                       log.Printf("dry run, not sending trash list to service %s with %d blocks", url, len(v))
+                       continue
+               }
+
+               count++
                log.Printf("Sending trash list to %v", url)
 
                go (func(url string, v TrashList) {
-                       defer (func() {
-                               barrier <- true
-                       })()
-
                        pipeReader, pipeWriter := io.Pipe()
                        go (func() {
                                enc := json.NewEncoder(pipeWriter)
@@ -486,16 +503,17 @@ func SendTrashLists(dataManagerToken string, kc *keepclient.KeepClient, spl map[
                        req, err := http.NewRequest("PUT", fmt.Sprintf("%s/trash", url), pipeReader)
                        if err != nil {
                                log.Printf("Error creating trash list request for %v error: %v", url, err.Error())
+                               barrier <- err
                                return
                        }
 
-                       // Add api token header
-                       req.Header.Add("Authorization", fmt.Sprintf("OAuth2 %s", dataManagerToken))
+                       req.Header.Add("Authorization", "OAuth2 "+kc.Arvados.ApiToken)
 
                        // Make the request
                        var resp *http.Response
                        if resp, err = client.Do(req); err != nil {
                                log.Printf("Error sending trash list to %v error: %v", url, err.Error())
+                               barrier <- err
                                return
                        }
 
@@ -503,11 +521,21 @@ func SendTrashLists(dataManagerToken string, kc *keepclient.KeepClient, spl map[
 
                        io.Copy(ioutil.Discard, resp.Body)
                        resp.Body.Close()
-               })(url, v)
 
+                       if resp.StatusCode != 200 {
+                               barrier <- errors.New(fmt.Sprintf("Got HTTP code %v", resp.StatusCode))
+                       } else {
+                               barrier <- nil
+                       }
+               })(url, v)
        }
 
-       for i := 0; i < count; i += 1 {
-               <-barrier
+       for i := 0; i < count; i++ {
+               b := <-barrier
+               if b != nil {
+                       errs = append(errs, b)
+               }
        }
+
+       return errs
 }