pr feedback

pkg/flow/flow.go

@@ -214,12 +214,12 @@ func (c *Flow) LoadFile(file *File) error {
 }
 
 // ComponentInfos returns the component infos.
-func (c *Flow) ComponentInfos() []*ComponentField {
+func (c *Flow) ComponentInfos() []*ComponentInfo {
 	c.loadMut.RLock()
 	defer c.loadMut.RUnlock()
 
 	cns := c.loader.Components()
-	infos := make([]*ComponentField, len(cns))
+	infos := make([]*ComponentInfo, len(cns))
 	edges := c.loader.Graph().NonTransitiveEdges()
 	for i, com := range cns {
 		nn := newFromNode(com, edges)
@@ -235,7 +235,7 @@ func (c *Flow) Close() error {
 	return c.sched.Close()
 }
 
-func newFromNode(cn *controller.ComponentNode, edges []dag.Edge) *ComponentField {
+func newFromNode(cn *controller.ComponentNode, edges []dag.Edge) *ComponentInfo {
 	references := make([]string, 0)
 	referencedBy := make([]string, 0)
 	for _, e := range edges {
@@ -246,7 +246,7 @@ func newFromNode(cn *controller.ComponentNode, edges []dag.Edge) *ComponentField
 		}
 	}
 	h := cn.CurrentHealth()
-	ci := &ComponentField{
+	ci := &ComponentInfo{
 		Label: cn.Label(),
 		ID:    cn.NodeID(),
 		Field: encoding.Field{
@@ -264,15 +264,8 @@ func newFromNode(cn *controller.ComponentNode, edges []dag.Edge) *ComponentField
 	return ci
 }
 
-// Health contains information on the health of a component.
-type Health struct {
-	State      string    `json:"state"`
-	Message    string    `json:"message"`
-	UpdateTime time.Time `json:"updatedTime"`
-}
-
-// ComponentField represents a component in river.
-type ComponentField struct {
+// ComponentInfo represents a component in river.
+type ComponentInfo struct {
 	encoding.Field `json:",omitempty"`
 	ID             string           `json:"id,omitempty"`
 	Label          string           `json:"label,omitempty"`

pkg/flow/flow_http.go

@@ -97,7 +97,7 @@ func (c *Flow) configBytes(w io.Writer, debugInfo bool) (n int64, err error) {
 }
 
 // ComponentJSON returns the json representation of the flow component.
-func (c *Flow) ComponentJSON(w io.Writer, ci *ComponentField) error {
+func (c *Flow) ComponentJSON(w io.Writer, ci *ComponentInfo) error {
 	c.loadMut.RLock()
 	defer c.loadMut.RUnlock()
 
@@ -109,35 +109,35 @@ func (c *Flow) ComponentJSON(w io.Writer, ci *ComponentField) error {
 		}
 	}
 	if foundComponent == nil {
-		return fmt.Errorf("unable to find component named %s", ci.ID)
+		return fmt.Errorf("unable to find component named %q", ci.ID)
 	}
 
 	var err error
-	args, err := encoding.ConvertComponentChild(foundComponent.Arguments())
+	args, err := encoding.ConvertRiverBlock(foundComponent.Arguments())
 	if err != nil {
 		return err
 	}
 	if args != nil && !reflect.ValueOf(args).IsNil() {
 		ci.Arguments = args
 	}
 
-	exports, err := encoding.ConvertComponentChild(foundComponent.Exports())
+	exports, err := encoding.ConvertRiverBlock(foundComponent.Exports())
 	if err != nil {
 		return err
 	}
 	if exports != nil && !reflect.ValueOf(exports).IsNil() {
 		ci.Exports = exports
 	}
 
-	debugInfo, err := encoding.ConvertComponentChild(foundComponent.DebugInfo())
+	debugInfo, err := encoding.ConvertRiverBlock(foundComponent.DebugInfo())
 	if err != nil {
 		return err
 	}
 	if debugInfo != nil && !reflect.ValueOf(debugInfo).IsNil() {
 		ci.DebugInfo = debugInfo
 	}
 
-	bb, err := json.MarshalIndent(ci, "", "    ")
+	bb, err := json.Marshal(ci)
 	if err != nil {
 		return err
 	}

pkg/flow/internal/controller/component.go

@@ -173,7 +173,7 @@ func (cn *ComponentNode) ID() ComponentID { return cn.id }
 // Label returns the label for the block or "" if none was specified.
 func (cn *ComponentNode) Label() string { return cn.label }
 
-// NodeType returns the nodes type, ie `local.file.test` returns `local.file`.
+// NodeType returns the component's type, i.e. `local.file.test` returns `local.file`.
 func (cn *ComponentNode) NodeType() string { return cn.nodeType }
 
 // NodeID implements dag.Node and returns the unique ID for this node. The

pkg/river/encoding/json.go

@@ -13,13 +13,13 @@ import (
 const attr = "attr"
 const object = "object"
 
-// ConvertComponentChild is used to convertBase arguments, exports, health and debuginfo.
-func ConvertComponentChild(input interface{}) ([]interface{}, error) {
+// ConvertRiverBlock is used to convertBase arguments, exports, health and debuginfo.
+func ConvertRiverBlock(input interface{}) ([]interface{}, error) {
 	if input == nil {
 		return nil, nil
 	}
 	val := value.Encode(input)
-	fields := make([]interface{}, 0)
+	var fields []interface{}
 	rt := rivertags.Get(val.Reflect().Type())
 	for _, t := range rt {
 		fieldValue := val.Reflect().FieldByIndex(t.Index)
@@ -55,13 +55,10 @@ func ConvertComponentChild(input interface{}) ([]interface{}, error) {
 			}
 		}
 	}
-	if len(fields) == 0 {
-		return nil, nil
-	}
 	return fields, nil
 }
 
-func isValue(val value.Value) bool {
+func isFieldValue(val value.Value) bool {
 	switch val.Type() {
 	case value.TypeNull, value.TypeNumber, value.TypeString, value.TypeBool, value.TypeFunction, value.TypeCapsule:
 		return true
@@ -131,7 +128,7 @@ func isStruct(val value.Value) bool {
 }
 
 func convertRiverValue(val value.Value) (vf *ValueField, af *ArrayField, mf *MapField, sf *StructField, err error) {
-	if isValue(val) {
+	if isFieldValue(val) {
 		vf, err = convertValue(val)
 		return
 	} else if isArray(val) {

web/api/api.go

@@ -33,7 +33,7 @@ func (f *FlowAPI) RegisterRoutes(urlPrefix string, r *mux.Router) {
 func (f *FlowAPI) listComponentsHandler() http.HandlerFunc {
 	return func(w http.ResponseWriter, _ *http.Request) {
 		infos := f.flow.ComponentInfos()
-		bb, err := json.MarshalIndent(infos, "", "    ")
+		bb, err := json.Marshal(infos)
 		if err != nil {
 			http.Error(w, err.Error(), http.StatusInternalServerError)
 			return
@@ -65,7 +65,7 @@ func (f *FlowAPI) listComponentHandler() http.HandlerFunc {
 }
 
 // JSON returns the json representation of ComponentInfoDetailed.
-func (f *FlowAPI) JSON(c *flow.ComponentField) (bytes.Buffer, error) {
+func (f *FlowAPI) JSON(c *flow.ComponentInfo) (bytes.Buffer, error) {
 	var buf bytes.Buffer
 	err := f.flow.ComponentJSON(&buf, c)
 	if err != nil {