Merge branch '18691-freeze-project'
[arvados.git] / lib / controller / router / response.go
index e3ec37a6ea842ac36e6b8d766cf91cf0210f05f9..42b34355935db015e72d7de3e8b7a6398ffc0680 100644 (file)
@@ -12,8 +12,8 @@ import (
        "strings"
        "time"
 
-       "git.curoverse.com/arvados.git/sdk/go/arvados"
-       "git.curoverse.com/arvados.git/sdk/go/httpserver"
+       "git.arvados.org/arvados.git/sdk/go/arvados"
+       "git.arvados.org/arvados.git/sdk/go/httpserver"
 )
 
 const rfc3339NanoFixed = "2006-01-02T15:04:05.000000000Z07:00"
@@ -26,11 +26,18 @@ type responseOptions struct {
 func (rtr *router) responseOptions(opts interface{}) (responseOptions, error) {
        var rOpts responseOptions
        switch opts := opts.(type) {
+       case *arvados.CreateOptions:
+               rOpts.Select = opts.Select
+       case *arvados.UpdateOptions:
+               rOpts.Select = opts.Select
        case *arvados.GetOptions:
                rOpts.Select = opts.Select
        case *arvados.ListOptions:
                rOpts.Select = opts.Select
                rOpts.Count = opts.Count
+       case *arvados.GroupContentsOptions:
+               rOpts.Select = opts.Select
+               rOpts.Count = opts.Count
        }
        return rOpts, nil
 }
@@ -45,9 +52,11 @@ func applySelectParam(selectParam []string, orig map[string]interface{}) map[str
                        selected[attr] = v
                }
        }
-       // Preserve "kind" even if not requested
-       if v, ok := orig["kind"]; ok {
-               selected["kind"] = v
+       // Some keys are always preserved, even if not requested
+       for _, k := range []string{"etag", "kind", "writable_by"} {
+               if v, ok := orig[k]; ok {
+                       selected[k] = v
+               }
        }
        return selected
 }
@@ -72,61 +81,48 @@ func (rtr *router) sendResponse(w http.ResponseWriter, req *http.Request, resp i
        if respKind != "" {
                tmp["kind"] = respKind
        }
+       if included, ok := tmp["included"]; ok && included == nil {
+               tmp["included"] = make([]interface{}, 0)
+       }
        defaultItemKind := ""
        if strings.HasSuffix(respKind, "List") {
                defaultItemKind = strings.TrimSuffix(respKind, "List")
        }
 
-       if items, ok := tmp["items"].([]interface{}); ok {
-               for i, item := range items {
-                       // Fill in "kind" by inspecting UUID/PDH if
-                       // possible; fall back on assuming each
-                       // Items[] entry in an "arvados#fooList"
-                       // response should have kind="arvados#foo".
-                       item, _ := item.(map[string]interface{})
-                       infix := ""
-                       if uuid, _ := item["uuid"].(string); len(uuid) == 27 {
-                               infix = uuid[6:11]
-                       }
-                       if k := kind(infixMap[infix]); k != "" {
-                               item["kind"] = k
-                       } else if pdh, _ := item["portable_data_hash"].(string); pdh != "" {
-                               item["kind"] = "arvados#collection"
-                       } else if defaultItemKind != "" {
-                               item["kind"] = defaultItemKind
+       if _, isListResponse := tmp["items"].([]interface{}); isListResponse {
+               items, _ := tmp["items"].([]interface{})
+               included, _ := tmp["included"].([]interface{})
+               for _, slice := range [][]interface{}{items, included} {
+                       for i, item := range slice {
+                               // Fill in "kind" by inspecting UUID/PDH if
+                               // possible; fall back on assuming each
+                               // Items[] entry in an "arvados#fooList"
+                               // response should have kind="arvados#foo".
+                               item, _ := item.(map[string]interface{})
+                               infix := ""
+                               if uuid, _ := item["uuid"].(string); len(uuid) == 27 {
+                                       infix = uuid[6:11]
+                               }
+                               if k := kind(infixMap[infix]); k != "" {
+                                       item["kind"] = k
+                               } else if pdh, _ := item["portable_data_hash"].(string); pdh != "" {
+                                       item["kind"] = "arvados#collection"
+                               } else if defaultItemKind != "" {
+                                       item["kind"] = defaultItemKind
+                               }
+                               item = applySelectParam(opts.Select, item)
+                               rtr.mungeItemFields(item)
+                               slice[i] = item
                        }
-                       items[i] = applySelectParam(opts.Select, item)
                }
                if opts.Count == "none" {
                        delete(tmp, "items_available")
                }
        } else {
                tmp = applySelectParam(opts.Select, tmp)
+               rtr.mungeItemFields(tmp)
        }
 
-       // Format non-nil timestamps as rfc3339NanoFixed (by default
-       // they will have been encoded to time.RFC3339Nano, which
-       // omits trailing zeroes).
-       for k, v := range tmp {
-               if !strings.HasSuffix(k, "_at") {
-                       continue
-               }
-               switch tv := v.(type) {
-               case *time.Time:
-                       if tv == nil {
-                               break
-                       }
-                       tmp[k] = tv.Format(rfc3339NanoFixed)
-               case time.Time:
-                       tmp[k] = tv.Format(rfc3339NanoFixed)
-               case string:
-                       t, err := time.Parse(time.RFC3339Nano, tv)
-                       if err != nil {
-                               break
-                       }
-                       tmp[k] = t.Format(rfc3339NanoFixed)
-               }
-       }
        w.Header().Set("Content-Type", "application/json")
        enc := json.NewEncoder(w)
        enc.SetEscapeHTML(false)
@@ -142,8 +138,22 @@ func (rtr *router) sendError(w http.ResponseWriter, err error) {
 }
 
 var infixMap = map[string]interface{}{
+       "gj3su": arvados.APIClientAuthorization{},
        "4zz18": arvados.Collection{},
+       "xvhdp": arvados.ContainerRequest{},
+       "dz642": arvados.Container{},
        "j7d0g": arvados.Group{},
+       "8i9sb": arvados.Job{},
+       "d1hrv": arvados.PipelineInstance{},
+       "p5p6p": arvados.PipelineTemplate{},
+       "j58dm": arvados.Specimen{},
+       "q1cn2": arvados.Trait{},
+       "7fd4e": arvados.Workflow{},
+}
+
+var specialKindTransforms = map[string]string{
+       "arvados.APIClientAuthorization":     "arvados#apiClientAuthorization",
+       "arvados.APIClientAuthorizationList": "arvados#apiClientAuthorizationList",
 }
 
 var mungeKind = regexp.MustCompile(`\..`)
@@ -153,8 +163,59 @@ func kind(resp interface{}) string {
        if !strings.HasPrefix(t, "arvados.") {
                return ""
        }
+       if k, ok := specialKindTransforms[t]; ok {
+               return k
+       }
        return mungeKind.ReplaceAllStringFunc(t, func(s string) string {
                // "arvados.CollectionList" => "arvados#collectionList"
                return "#" + strings.ToLower(s[1:])
        })
 }
+
+func (rtr *router) mungeItemFields(tmp map[string]interface{}) {
+       for k, v := range tmp {
+               if strings.HasSuffix(k, "_at") {
+                       // Format non-nil timestamps as
+                       // rfc3339NanoFixed (otherwise they would use
+                       // the default time encoding, which omits
+                       // trailing zeroes).
+                       switch tv := v.(type) {
+                       case *time.Time:
+                               if tv == nil || tv.IsZero() {
+                                       tmp[k] = nil
+                               } else {
+                                       tmp[k] = tv.Format(rfc3339NanoFixed)
+                               }
+                       case time.Time:
+                               if tv.IsZero() {
+                                       tmp[k] = nil
+                               } else {
+                                       tmp[k] = tv.Format(rfc3339NanoFixed)
+                               }
+                       case string:
+                               if tv == "" {
+                                       tmp[k] = nil
+                               } else if t, err := time.Parse(time.RFC3339Nano, tv); err != nil {
+                                       // pass through an invalid time value (?)
+                               } else if t.IsZero() {
+                                       tmp[k] = nil
+                               } else {
+                                       tmp[k] = t.Format(rfc3339NanoFixed)
+                               }
+                       }
+               }
+               // Arvados API spec says when these fields are empty
+               // they appear in responses as null, rather than a
+               // zero value.
+               switch k {
+               case "output_uuid", "output_name", "log_uuid", "description", "requesting_container_uuid", "container_uuid", "modified_by_client_uuid", "frozen_by_uuid":
+                       if v == "" {
+                               tmp[k] = nil
+                       }
+               case "container_count_max":
+                       if v == float64(0) {
+                               tmp[k] = nil
+                       }
+               }
+       }
+}